Unity integration for CI

[ir-os]

We need to implement an interface for Unity to integration our CI structure.

Basically :

• Unity files (source and headers) should be located at a suitable place in IROS file system.
• Unity needs Ruby to run TestRunner Creation scripts. Ruby support should be guaranteed in actual environments (e.g. Ubuntu)
• We need to call TestRunner creation scripts. Make files should be updated to run this scripts.
  • Add a new command for testing (like test : make test)
• makefile should be updated to compile and link
  • to be tested module
  • Auto generated TestRunner Module

Please use following Unity Documentation to implement above features : https://github.com/ThrowTheSwitch/Unity/archive/master.zip It also contains all required files and scripts, and also examples.

[ahmetalncak]

Following instructions can be used to integrate Unity to IR-OS project after basis build system is created.

Pre-requesties

If we decide on to generate test runner functions automatically from module's test file, first tool that we need is a script language (Ruby is chosen by Unity's creators and already performed this operation). So let's get started with Ruby.

• Install all Ruby (2.3.0) packages (for Ubuntu follow the instructions: https://gorails.com/setup/ubuntu )

How-to Generate Test Runner Functions

• A test file can be named whatever else,
• In a test file you should include Unity's header file (e.g. unity.h) and the related module's header file,
• Implement following functions in the test file:
  • void setUp(void);
  • void tearDown(void);
• A test function have to be named with one of the following prefixes;
  • test,
  • spec.
• And the test function must have void function signature;
  • e.g. void testVerifyThatUnityIsAwesomeAndWillMakeYourLifeEasier(void);
• Than just call the following command to create test runner file;
  • ruby generate_test_runner.rb <name_of_test_file> <name_of_tes_runner_file>
  • <name_of_test_file> (must): your module's test file name that includes test functions
  • <name_of_test_runner_file> (optional): call the output test runner file or simply pass it than script will add _Runner post-fix to your test file name. e.g. <name_of_test_file>_Runner.c

Final Words

So far so good. Here is a list that shows what the changes will be performed on MakeFile;

• [ ] Make sure Ruby installed
• [ ] Include Unity's header files and compile unity.c
• [ ] Specify the test files for the modules such as;
• [ ] Specify the test runner functions which are generated automatically e.g. TEST_POST = _Runner TEST_RUNNERS = ($SOURCE_0)($TEST_POST) ($SOURCE_1)($TEST_POST)
• [ ] Call Ruby script to generate test runners; e.g ruby generate_test_runner.rb ($SOURCE_0).c ruby generate_test_runner.rb ($SOURCE_1).c
• [ ] Compile the all test runner files,
• [ ] And run all the test runners.

[ir-os]

Thanks @ahmetalncak Great explanation. I will follow your instructions during Unity integration.