Marvinette Documentation

---

1. Clone the repository
2. Move it to your $HOME folder (or a directory where you wouldn't want to move the repository)
3. Inside the repository, execute the following command:

php MarvinetteInstall.php

Warning If installation fails, try installation using sudo

1. (Only For Windows) Add the path of the marvinette folder to your PATH environment variable

Warning: Once you executed the command, you must not move the Marvinette folder. If you do, you'll have to execute the install command again

---

1. Before anything else, you must create your project's configuration file for Marvinette. To do so:
   • go to your project's directory
   • execute the following command:

marvinette --create-project

• You will be prompt to enter several values.
• You can modify your configuration file using the following command (avoid changing the file yourself):

marvinette --mod-project

1. You can now create your first functional test!
   • execute the command:

marvinette --add-test

• You will be prompt to enter different values.
• In your test's folder, some files will be empty: you'll have to fill them yourself (expectedStdout/Stderr, standard input, stdout/stderrFilter). If a file is empty, for example expectedStdout, the standard output of the program will be compared with the file's content. If you don't want to, simply delete the file.

Your tests are ready to be executed!

• To execute one test, execute the command:

marvinette --execute-test

You will be asked to choose which test to execute

• To execute all your tests, execute the command:

marvinette --execute-tests

---

Use the framework using the following command-line instructions:

marvinette [option]

  option:
    --create-project: Create a main configuration file, required to make tests
    --create-sample-project: Create a sample configuration file. The values will be changed by the user.
    --del-project, --delete-project: Delete configuration file and existing tests
    --mod-project: Modify the project\'s info.

    --add-test, --create-test: Create a functional test
    --create-sample-test: Create a sample test file. The values will be changed by the user.
    --mod-test: Modify a functional test
    --del-test, --delete-test: Delete a functional test

    --execute-test,--exec-test : Execute a test
    --execute-tests, --exec-all  : Execute all tests

    -h, --help: display this usage

---

The framework's configuration file, Marvinette.json, holds the following information:

• name: The name of the project
• binary name: the name of the binary/script to execute
• binary path: the path to the binary/script
• interpreter: the interpreter of the script (for example: python3 for a python script, or nothing for binary executables)
• tests folder: the path to the tests' folder

If you do not want to use the command-line interface to configure your project, use the --create-sample-project. It will create a sample configuration file and you change the values by yourself

Upon test creation, several files are generated in the testFolder/testName folder:

• A config.json file, holding the following values:
  • commandLineArguments: holds the arguments which will be passed to the program.
  • interpreterArguments: holds the arguments which will be passed to the program's interpreter. The arguments will be read only if an interpreter is set in the Marvinette.json file.
  • expectedReturnCode: the returned code expected from the program's execution (if the field's value is not a number, the comparison will be scrapped).
  • stdoutFilter: the standard output the command will be piped onto.
  • stderrFilter: the error output the command will be piped onto.
  • emptyEnv: if true, the test command will be executed within an empty environment.
  • setup: this command will be executed before the program is launched.
  • teardown: this command will be executed after the program is launched.

Any of the fields can be null. If that's the case, the described action will not be executed.

• stdinput: if the file exists, the content of the file will be standard input to the program.
• expectedStdout: if the file exists, the (filtered) standard output will be compared to the file's content. If there is no such file, no comparison will be done.
• expectedStderr: if the file exists, the (filtered) error output will be compared to the file's content. If there is no such file, no comparison will be done.

If a setup, stdout/stderrFilter or teardown command doesn't return 0, the test will fail.

Upon creation, feel free to change the files' content by yourself. Be careful not to leave any useless line breaks of trailing spaces

---

You can use Marvinette on an Unix-based OS or on Windows!

Also, you'll need PHP >= 7.4. No other library needed (the vendor folder and composer configuration file are used for Marvinette's unit tests)

---