IO Tester

The goal of this software is to take files as parameter that contains lists of inputs and expected outputs and to tell the user if the tests succeed, failed or crashed.

⚠️ Requirements

IO Tester works on MacOS, Ubuntu, Fedora, ArchLinux

To build the project you will need cmake with a version upper or equal to 3.17

pip install cmake

💻 Installation

1. Clone this repository
2. Go to the IO-TESTER folder
3. Execute the following command :
   sudo make install (the binary will be installed at usr/local/bin)

⭐ Don't forget to put a star if you like the project!

📒 Manual

USAGE:
        IO_Tester test.io [OPTIONS]

DESCRIPTION:
        test.io         file that contains functional tests

OPTIONS:
        -h --help       display this help menu
        -v --version    display the actual version
        -c --changelog  display the changelog
        -u --update     update this software (sudo)
        --details       display the output difference in the shell
        --diff          display the output difference in Visual Studio Code

RETURN VALUE:
        0               if all tests succeed
        1               if one or more tests failed or crashed
        84              if IO_Tester failed to load a test file

✍️ Usage

Test files must follow this pattern:

[Test Name] command
expected output
[END]

Here we want to test a program that takes parameters and prints them in the standard output. We will also test some system commands
Let's create a test file:

# test.io

# set the default timeout of the tests to 1 sec:

@default timeout 1

[Simple Print] python3 printer test
test

[END]

[Multiple Prints] python3 printer Hello World !
Hello
World
!

[END]

[Oooops] python3 printer I am bad
You
are
bad

[END]

[Power] whoami
root

[END]

# disable stdout and stderr catch for this test:

@stdout false
@stderr false

[ZZZzzz] sleep 5
[END]

Then execute IO_Tester with files that contains the tests as arguments:
You can add --diff to display the difference between the real, and the expected output in Visual Studio Code when a test fails:

You can add the number of maximum failed tests to display after --details or --diff.
You can also run multiple test files at once:

IO_Tester test1.io test2.io test3.io --diff 1

💬 Test Parameters

You can change the value of a parameter for the next test:

@stdout  <bool>  (default: true)
@stderr  <bool>  (default: true)
@return  <int>   (default: 0)
@timeout <float> (default: 3.0)

You can also change the default value of a parameter:

@default parameter value

💡 Build Tips

If you want to uninstall IO Tester:
make uninstall

If you just want to get the binary without installing:
make

If you want to remove all objects files:
make clean

If you want to remove all objects files and the binary:
make fclean

👤 Contributors

• Martin Olivier
• Benjamin Reigner
• Alexandre Chetrit
• Coline Seguret