/myfs-test

📋 Functional tests for the FUSE-based file system MyFS

Primary LanguageTypeScriptMIT LicenseMIT

📋 myfs-test

Functional tests for the FUSE-based file system MyFS

🛠️ Development

These instructions will get you a copy of this project up and running on your local machine for development and testing purposes.

📋 Prerequisites

Software

  • Node.js - JavaScript run-time environment

Environment Variables

  • MYFS_BIN_MKFS - Path to the mkfs executable
  • MYFS_BIN_MOUNT - Path to the mount executable

VS Code Extensions

This project is intended to be used with Visual Studio Code and the following extensions are recommended:

  • ESLint - Integrates ESLint JavaScript into VS Code
  • TSLint - TSLint support for Visual Studio Code

🚀 Getting Started

⚠️ The MyFS binaries are not built automatically before running the tests. So if the sources of MyFS have changed or haven't been built at all, make sure you run the build before running the tests. Otherwise the old binaries will be tested or the tests will fail altogether.

Running the Tests with the Terminal

Run the following command in the directory containing the package.json file:

npm test

Running the Tests with VS Code

This project includes task definitions for Visual Studio Code. Just open the folder containing the package.json file in VS Code and then run the task Run tests.

🐞 Debugging with VS Code

  1. Set a breakpoint in a file inside the src folder
  2. Go to src/spec and open the .spec file you want to run
  3. Run the debugger (by default F5)

🧰 Built With

  • AVA - Futuristic test runner for Node.js
  • TypeScript - Typed superset of JavaScript that compiles to plain JavaScript
  • Tmp - A simple temporary file and directory creator for node.js
  • umount - Unmount a device in UNIX
  • execa - Process execution for humans
  • pkg-dir - Find the root directory of a Node.js project or npm package

👨‍💻 Authors

📃 License

This project is licensed under the MIT License - see the LICENSE file for details.