About

This is a simple C / C++ unit testing framework with no non-standard deps. You can use it in your EECS projects, assuming of course that doing so does not violate the code use, or honor code restrictions, by which you MUST abide.

Basic Usage

First, clone the framework into your project folder:

git clone https://github.com/michiganhackers/unit-test-framework.git

If you want to have a folder specifically for tests, run mkdir tests on the root level of your project and add a test file:

#include "../unit-test-framework/unit_test_framework.h"

int main(int argc, char const *argv[])
{
  // Describe the suite of tests to be run.
    start_suite("Start test suite:");
    
  // Run some tests.
    if( assertEqual(1, 1) )
	    test_passed("1 is equal to 1!");
    else
	    test_failed("1 is not equal to one.");
    
  // End the suite
    end_suite();
    return 0;
}

Compile at the project's root folder:

g++ tests/test.cpp -o test unit-test-framework/unit_test_framework.c

Run your test suite:

./test

That's it!

Advanced Usage

Maybe you want this to be a little more like JUnit in Java, or you just like organizing a test into its own function, and sharing setup and takedown functions between tests.

1. Write your before/setup function. By default, a setup function that does nothing is used.

   void setup(void) {
     // Do some setup here, probably set some global variables
   }
   

2. Write an after/takedown function. By default, a takedown function that does nothing is used.

   void takedown(void) {
     // Get everything back to a clean slate
   }
   

3. Register the callbacks

   setBeforeFunc(before);
   setAfterFunc(after);
   

4. Write some test function

   void test1() {
       // Set some variables using global variables set during setup()
       if( assertEqual(something, something_from_setup) )
           test_passed("Yay!");
       else
           test_failed("Boo!");
   }
   

5. Run the test

   runTest(test1, "Test 1");
   

Now execution of test1() is wrapped inbetween calls to setup() and takedown().

Contributors

We (I) would love to get feedback on this, either via issue submissions, or via pull-requests. If you submit a pull-request, be sure to add your name to this list.

• Max Seiden [email protected]
• Ryan Gonzalez [email protected]
• David Adrian [email protected]
• Thomas Lovett [email protected]

License

Copyright (C) 2012 Max Seiden [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.