mini-kep/guidelines

Guidelines for testing and developement

guidelines's Issues

format for test comments

Imagine there is a class CalendarHelper with shift_ahead(days).

When doing commented test (either for learning purposes, or the test is difficult to debug/refactor)
we should have following comments in test class of method:

class Test_CalendarHelper():

     def  test_shift_ahead_on_positive_int_returns_date_instance(self):
         # method under test:  shift_ahead(days) 
         # context or arguments: positive integer
         # expected result or behaviour:  returns datetime.date instance

         # test setup
         days = 1
         # call
         dt = CalendarHelper.shift_ahead(days)
         # check
         assert isinstance(dt, datetime.date) 

         # suggested extensions:
         #    - randomise *days*
         #    - add a test on actual value of method result
         #    - parametrise days-result pairs

add test naming examples

Here: https://github.com/mini-kep/guidelines/blob/master/testing.md#test-naming