Bleeding edge Unit Testing - Githubissues

emmebrusa / TSDZ2-Smart-EBike-1

TSDZ2 Open Source Firmware adapted to VLCD5-VLCD6-XH18 displays

GNU General Public License v3.0

144 stars 34 forks source link

Bleeding edge Unit Testing #109

Open dzid26 opened 4 months ago

dzid26 commented 4 months ago

Python bindings to the c code - pytest testing

https://youtu.be/zW_HyDTPjO0?t=161

allows testing static functions
allows using advanced testing libraries, such as hypothesis or numpy
function mocking
Extra warnings from gcc
tests coverage of the c-code
easy to use, automatic IDE's integrations
provides easy testcase debugging, (but hard c-code debugging)
- if there is e.g. div by 0, the tests will crash and will say just that

What's included:

python bindings auto-generation (automatic parsing and .cdef definition creation !) and module compilation
python setup, (just run pip install .)
readme instructions, (just run pytest)
example tests (parameterized tests, comparison with floating point, functions mocking)
CI:
- gcc warnings as errors
- test reports display + coverage % of the c-code.
- Experimental PR bot (if tests fail).
- HTML coverage report artifact

Minor code fixes:

(details in the commit message df8b31d)

typedef enum fix - allow gcc compilation
explicit (uint8_t) castings warnings fix
explicit pointer type struct_configuration_variables casting
explicit operator << ordering in BATTERY_VOLTAGE_SHUTDOWN_10_BIT - (I made sure this doesn't change calculated value)
changed few defaults in config.h to prevent dead code warnings

dzid26 commented 3 months ago

@emmebrusa any concerns ? The remaining PR's don't carry any functional changes to the end user.

emmebrusa commented 3 months ago

I didn't go into detail about what this means for the user, when I saw "File changed 30" and "File changed 20" I stopped. I'm on vacation ...