zmievsa / cadwyn

Production-ready community-driven modern Stripe-like API versioning in FastAPI
https://docs.cadwyn.dev/
MIT License
186 stars 24 forks source link

Analyze the quality of test names and structure #165

Open zmievsa opened 3 months ago

zmievsa commented 3 months ago

Currently, Cadwyn uses the following test naming convention:

test__{WHAT_WE_TEST}__{IN_WHAT_CONTEXT}__should_{THE_EXPECTED_RESULT}. Note that we do not follow this style in test_routing and note that we do not write the expected result if it is obvious.

We need an expert to validate where Cadwyn could utilize this style more effectively in its tests. So we need a review of a few testing modules with a few concrete recommendations at the end of the review.

@tikon93 is the author of the style of naming above so he is the perfect candidate.