README.md

#Seatest

A simple unit testing framework for C based on the xUnit style of unit testing. Ideal for Test Driven Development ( TDD ). Designed to be portable.

If you are new to TDD / Unit Testing, you may wish to jump straight to Getting Started.

If you have experience with other xUnit type frameworks, you may wish to read through the general technical overview of SeaTest?

Features

• xUnit style asserts
• Fixtures
• Setup / Teardown
• Global Setup / Teardown
• Ability to selectively run Tests / Fixtures
• Testing framework contained in one .h and one .c
• Easily extensible for custom asserts
• No memory allocation used!
• Simple Syntax with no CRUFT
• Cross platform

Asserts

• assert_true
• assert_false
• assert_int_equal
• assert_ulong_equal
• assert_string_equal
• assert_n_array_equal
• assert_bit_set
• assert_bit_not_set
• assert_bit_mask_matches
• assert_fail
• assert_float_equal
• assert_double_equal
• assert_string_contains
• assert_string_doesnt_contain
• assert_string_starts_with
• assert_string_ends_with

Seatest Hello World

#include "seatest.h"
//
// create a test...
//
void test_hello_world()
{
        char *s = "hello world!";
        assert_string_equal("hello world!", s);
        assert_string_contains("hello", s);
        assert_string_doesnt_contain("goodbye", s);
        assert_string_ends_with("!", s);
        assert_string_starts_with("hell", s);
}

//
// put the test into a fixture...
//
void test_fixture_hello( void )
{
        test_fixture_start();      
        run_test(test_hello_world);   
        test_fixture_end();       
}

//
// put the fixture into a suite...
//
void all_tests( void )
{
        test_fixture_hello();   
}

//
// run the suite!
//
int main( int argc, char** argv )
{
        return run_tests(all_tests);
}

Fixtures

In many xUnit style testing frameworks, tests and testfixtures are automatically discovered. So all you do is write your test, or fixture, and they are automatically run. Which is great! You never forget to include a test. However in C, there is no language mechanism to do this. (Some of the C unit testing frameworks make use of something like python to find the tests automatically)

So Seatest requires you to explicitly register all your tests and fixtures. If you are in the habit of "red green refactor", this limitation shouldn't be too much of a problem. The main reason for this is that the framework needs to be easily used in embedded environments / compilers / IDEs. The current prime target being PICs and the MPLAB IDE. So things are kept to pretty vanilla C code.

SeaTest? was built to support embedded development using a dual compiler approach. This approach involves developing the bulk of the code / tests in a Rich C development environment, like Visual Studio, and then cross compiling with the more limited embedded C compiler to check the unit tests also run on the target device.

One of the big factors was to make sure seatest didn't use any dynamic memory allocation (like malloc, etc). Or store a big list of tests in some sturcture. All the test fixtures and tests are created through the structure of the code itself. Making it simple, quick, and very straightforward.

The general approach to fixtures generally looks like the following :-

void my_test_fixture()
{
        test_fixture_start();   
        fixture_setup(my_test_setup);
        fixture_teardown(my_test_teardown);

        run_test(test_one);
        run_test(test_two);
        
        test_fixture_end();
}

Getting Started

Note, this section is currently getting built up and might seem a bit incomplete at times . It needs building into a full tutorial and a description on how to do embedded C unit testing

1. Download the source code

2. include "seatest.c" and "seatest.h" in your project, make sure the .h is in a directory your compiler will find when including headers.

3. create a function called something like "alltests" which will combine all your test suites together

4. In your main create the test runner

5. Create a test suite

6. Create tests

7. Run

Abort test on first test failure

Normally Seatest will run all asserts in a test no matter whether they pass or fail. If you want the test to abort on the first failure then set the #define ABORT_TEST_IF_ASSERT_FAIL.