2.5.3 Test Convention

Summary

Having a common convention is the key to great, readable code. Here at Team FloppyDisk, we do just that, here is a list of testing conventions and important tips and tricks to help the testing process. Please note that, it would be wise to read the section 2.5.1 Test Script before writing tests, as it will give a better understanding of how the test suite works.

Test Writing Conventions

• Place all unit tests within SoftEng-306-Project1/se306Project1/test/
• Place all acceptance build tests within SoftEng-306-Project1/
• Tests will have a file name of "Test_[EntityName]_[FunctionName].py" e.g. Test_Robot_goto
• Class name within Test File will have the same name as the file
• Class will inherit from unittest.TestCase and TestModule
• Each test function within the class will have the format of "test_[Description]"

Important Notes

• Each test file runs on a single stage, so be aware that within a file... each function will build off it's predecessor. Don't have things that will assume you're on a clean slate every function all, because you're not. A good example of what I mean is Test_Robot_face_direction.py I've used 4 tests within that file, but they are all independent. For example, if you use a move forward and assume it's always from the start position, that might be a mistake because you may have run another test within the same file that changes it's current location.

How To Run A Test

• Initial Setup :

  1. add "export PYTHONPATH=$PYTHONPATH:~/SoftEng-306-Project-1" to your .bashrc file
  2. rosmake your s306Project1 folder

• Run Tests:

  1. Open terminal at project root (~/SoftEng-306-Project1/), use command "python test.py" (use "-v" for more descriptive output)

Template For Code

• Starting from scratch can sometimes be daunting, I'd recommend using another test and use it as a template. It would be best to use a template similar to what you're writing for. They all have a similar theme, as is documented in the convention, but using similar code will definitely speed up the testing progress.