https://github.com/wesbillman/emu

Simple EMbedded Unit testing
https://github.com/wesbillman/emu

Last synced: 29 days ago
JSON representation

Simple EMbedded Unit testing

• Host: GitHub
• URL: https://github.com/wesbillman/emu
• Owner: wesbillman
• Created: 2010-11-14T23:56:15.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2012-06-19T21:43:42.000Z (over 12 years ago)
• Last Synced: 2024-10-31T10:43:50.637Z (3 months ago)
• Language: C
• Homepage: wesbillman.github.com/emu
• Size: 113 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Welcome to EMU

EMU is a simple EMbedded Unit testing framework

## Quickstart

1. Create a new .c file for your tests (see `emu_test.c` for an example)

2. Include `emu.h` in your file

```C

#include "emu.h"

```

3. Override the follow defines to suit your environment

```C

//emu overrides

#define emu_malloc(size)		        malloc(size)

#define	emu_free(ptr)			        free(ptr)

#define emu_memset(ptr, value, size)	memset(ptr, value, size)

#define	emu_printf(...)			        printf(__VA_ARGS__)

```

4. Modify the size defines to suit your needs

```c

#define MAX_TESTS_IN_SUITE		32

#define MAX_SUITES_IN_REPO		32

#define MAX_SUITE_NAME_LENGTH	32  

```

5. Add a suite

```c

emu_suite* suite = emu_suite_add("suite_a", setup, teardown);

```

6. Add some tests

```c

emu_test* test = emu_test_add(suite, "passing_test", passing_test);

emu_test_add(suite, "failing_test", failing_test);

```     

7. Run the suite

```c

emu_suite_run(suite);    

```

8. Display the results

```c

emu_display_summary();

emu_display_details();

```

## Test Macros

Available Macros

```c

#define emu_fail(message)

#define emu_pass(message)

#define emu_fail_if(test)

#define emu_fail_unless(test)

```

These will pass

```c

emu_pass("this should pass");

emu_fail_if(0 != 0);

emu_fail_unless(0 == 0);

```

These will fail

```c

emu_fail("this should fail");

emu_fail_if(1 == 1);

emu_fail_unless(0 == 1);

```

## Results

Use `emu_display_summary()` to display a brief summary

```c

emu run summary

---------------

.....FFFFF

```

Use `emu_display_details()` to display more detailed information

```c

emu run details

---------------

suite: suite_a

  num_tests: 2

 num_failed: 0

suite_a tests

--

test passing_test

  assertions: 5 (5 passed, 0 failed)

test failing_test

  assertions: 5 (0 passed, 5 failed)

test passing_test

  assertions: 5 (5 passed, 0 failed)

```