Test Driven Developement
Starting from today:
-
Based on the requirements of each task, you should always write the documentation (module(s) + function(s)) and tests first, before you actually code anything
-
The intranet checks for Python projects won’t be released before their first deadline, in order for you to focus more on TDD and think about all possible cases
-
We strongly encourage you to work together on test cases, so that you don’t miss any edge case. But not in the implementation of them!
-
Don’t trust the user, always think about all possible edge cases
- doctest- Test interactive python examples
- doctets - Testing through documentation
- unit tests in python
- unittest module
- Interactive and non-interactive tests
By the end of this session, you should be able to explain to anyone the following concepts without the help of Google.
- What’s an interactive test
- Why tests are important
- How to write Docstrings to create tests
- How to write documentation for each module and function
- What are the basic option flags to create tests
- How to find edge cases
Each module, class, and method must contain docstring as comments see example
- Allowed editors:
vi,vim,emacs - All your files will be interpreted/compiled on Ubuntu 20.04 LTS using python3 (version 3.8.5)
- All your files should end with a new line
- The first line of all your files should be exactly #!/usr/bin/python3
- Your code should use the pycodestyle (version 2.8.*)
- All your files must be executable
- The length of your files will be tested using
wc - All your modules should have a documentation (
python3 -c 'print(__import__("my_module").__doc__)') - All your classes should have a documentation (
python3 -c 'print(__import__("my_module").MyClass.__doc__)') - All your functions (inside and outside a class) should have a documentation (
python3 -c 'print(__import__("my_module").my_function.__doc__)'andpython3 -c 'print(__import__("my_module").MyClass.my_function.__doc__)') - A documentation is not a simple word, it’s a real sentence explaining what’s the purpose of the module, class or method (the length of it will be verified)
- All your files should end with a new line
- All your test files should be inside a folder
tests - All your test files should be text files (extension:
.txt) - All your tests should be executed by using this command:
python3 -m doctest ./tests/*- All your modules should have a documentation (python3 -c 'print(import("my_module").doc)')
- All your functions should have a documentation (
python3 -c 'print(__import__("my_module").my_function.__doc__)') - A documentation is not a simple word, it’s a real sentence explaining what’s the purpose of the module, class or method (the length of it will be verified)