42PyChecker

We're actively looking for contributors !

Shoot me an email at <[email protected]> or on slack (42Born2Code) jlasne !

Uses

The script is designed as a reminder:

• author file terminated by a Line Feed
• count and files name
• code's standard
• required and forbidden functions
• macro definitions
• static variables & functions declarations
• makefile rules

Extra tests may also be performed:

• memory leaks detection
• speed test comparison
• Unit Tests

Complete unit tests are handled through external frameworks whose sources are automatically downloaded, configured and updated in background when you run the script:

• moulitest, developed by @yyang42 and other contributors
• libftest, developed by @jtoty
• libft-unit-test, developed by @alelievr
• fillit_checker, developed by @anisg
• Maintest, developed by @QuentinPerez and other contributors

Install & launch

This script requires python 3.6 or above to work.

rm -rf $HOME/.brew && brew update && export PATH=$HOME/.brew/bin:$PATH && brew update && brew install python3 && cd && git clone https://github.com/Seluj78/42PyChecker.git --recursive && cd 42PyChecker

non-interactive mode

The non-interactive mode enables you to launch a test suite without any prompt. You must specify the two options --project and --path. Here is an example of use with the project libft:

python3 ~/42PyChecker/42PyChecker.py --project=libft --path=/Users/admin/Projects/libft/ --no-gui

options

--project + $PROJECT

Required for non-interactive mode.
Specify the name of the project you want to test.
e.g.: python3 ./42PyChecker.py --project=libft.
Must be one of the following values: 42commandements, libft or other.

--path + $PATH

Required for non-interactive mode.
This option has no effect when used without the option --project.
Specify the absolute path of directory of your project.
e.g.: python3 ./42PyChecker.py --project=libft --path=/Users/admin/Projects/libft/.

--no-author, --no-norm, --no-makefile, --no-forbidden-functions, --no-static, --no-moulitest, --no-maintest, --no-libftest, --no-extra --no-required, --no-libft-unit-test, --no-fillit-checker, --no-bonus

Disable a specific test.

--no-tests

This will disable all testing suites but run the other tests.

--do-benchmark

Enables speed benchmark for libft

--show-c and --show-w

These options will display respectively the License and the Warranty.

official team and credits

42PyChecker is an open source project distributed under licence GNU-3.0.

Originally developed by Jules Lasne @seluj78 <[email protected]>

Huge thanks to the original author and main inspiration, Jean Michel Gigault @jgigault and his incredible 42FileChecker

contribute

If you want to be part of the project, to fix and to improve 42PyChecker, please follow the guide lines Contributing to 42PyChecker, or if you want your own unit testing framework to be integrated in the 42PyChecker, just let me know at [email protected].