autotestreg 0.3.0

Automatically test your functions to see if you have changed their behavior by mistake!

AutoTest!Reg

Automatically test your functions to see if you have changed their behavior by mistake!


View Demo · Report Bug

About The Project

Have you ever spent hours reworking someone else's code, trying not to break anything, only to realize at the last moment that something doesn't work anymore, but not knowing at which step you introduced the bug? So frustrating!

AutoTest!Reg allows you to automatically track the code you are working on and not introduce any regression, without writing a single test!

Getting Started

Using AutoTest!Reg requires no effort at all!

Install AutoTest!Reg with pip :

pip install autotestreg

Import AutoTest!Reg into your tests, adding this line:

import autotestreg

To follow a function my_func, this code is all you need:

from autotestreg import autotest_func

@autotest_func
def my_func():
    ...

To track an entire module mypackage, with all the functions and methods it contains:

from autotestreg import autotest_module
import mypackage

autotest_module(mypackage)

In your tests, juste use your functions to trigger Autotest!Reg smart regresion testing.

Results

If no regression was introduced when you modified the code, your tests will pass.
Otherwise, AutoTest!Reg will give you the function whose behavior was changed.

AutotestError: Output changed in mypackage.file1/function1, for input x=1
@@ -3 +3 @@
-old+new

The true power of Autotest!

The real power of Autotest! lies here: you are not forced to write tons of code to explicitly call all of your functions. If you have a main function that recursively calls all sub-functions in the module, Autotest!reg will still track and check all sub-functions for regressions!

# before, you needed to explicitely call all functions that neeeded tests and assert their results
assert fonc1(...) == { ... }
obj = Object2(...)
assert obj2.method1(...) == ...

# now, just call your main function, after registering your module
from autotestreg import autotest_module
import mypackage

autotest_module(mypackage)
mypackage.main()

Use in python notebooks

You can use AutoTest!Reg for functions defined in a python notebooks. Just add the import and the autotest_func decorators in your notebook cells.

Advanced usage

You can use AutoTest!Reg as a pre-commit hook:

1. Create some test files using autotestreg (e.g. some_tests.py)

• This file must contain at the top from autotestreg import set_interactive and set_interactive(False)

2. Modify the pre-commit hook script: touch .git/hooks/pre-commit
3. Add this inside:

#!/bin/sh
# Dont forget to activate your env if needed.
python some_tests.py

4. Make the pre-commit file executable: chmod +x .git/hooks/pre-commit

(back to top)

Contributing

(Section in english)
I want to add a lot of functionnalities to this project, but I don't have much time to work on it. Contributions are welcome!

To install in dev mode, use pip install -e .

(back to top)

How to contribute

Contributing is an awesome way to learn, inspire, and help others. Any contributions you make are greatly appreciated, even if it's just about styling and best practices.

If you have a suggestion that would make this project better, please fork the repo and create a pull request.
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/YourAmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Authors

This library was created by Nicolas MICAUX.
You might also be interested by foolproof