https://github.com/ectalite/pico-unit

Simple and lightweight Test-Framework for Raspberry Pi Pico
https://github.com/ectalite/pico-unit

Last synced: 19 days ago
JSON representation

Simple and lightweight Test-Framework for Raspberry Pi Pico

• Host: GitHub
• URL: https://github.com/ectalite/pico-unit
• Owner: Ectalite
• License: mit
• Created: 2024-04-25T08:51:24.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-07-11T12:10:36.000Z (6 months ago)
• Last Synced: 2024-07-11T13:42:26.075Z (6 months ago)
• Language: C
• Size: 660 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pico-Unit

Simple and lightweight Test-Framework for Raspberry Pi Pico

![Example](./images/picoUnit.png)

## Install

Pico Unit can be cloned from GitHub through this link:

![Static Badge](https://img.shields.io/badge/Clone-me-brightgreen?link=https%3A%2F%2Fgithub.com%2FEctalite%2FPico-Unit)

The `pico-unit.h` header-file must then be included.

## Usage

The usage of Pico Unit is straightforward :

### 1. Create Tests

Use the `TEST_FUNCTION(())` Macro to create a test and use the `ASSERT(, )` C-Macro to verify a test condition.

> [!NOTE]

> This example compares 42 with the amount given in parameter.

``` {.c .copy}

TEST_FUNCTION(test1(size_t amount),

    //Calculate something

    ASSERT(amount == 42, "Amount is not 42");

)

```

### 2. Create a test family

Use `DEFINE_FAMILY(())` to create a test family with multiple tests that will be called.

> [!NOTE]

> This examples calls the test `test1` declared in previous example and gives the variable 'amount' as parameter.

``` {.c .copy}

DEFINE_FAMILY(meineTestFamilie(size_t amount),

    TEST(test1, amount);

)

```

### 3. Start testing a test family

Use `TEST_FAMILY(())` to call a test family.

> [!NOTE]

> This example calls the test-family `meineTestFamilie` and gives 100 as parameter

``` {.c .copy}

int main() {

    START_TEST;

    TEST_FAMILY(meineTestFamilie(100));

    STOP_TEST;

}

```