https://github.com/prdktntwcklr/atmega-tdd-example

Test-driven development (TDD) and CI/CD example for the ATmega.
https://github.com/prdktntwcklr/atmega-tdd-example

atmega avr c cicd cmake embedded fff tdd unity

Last synced: 11 days ago
JSON representation

Test-driven development (TDD) and CI/CD example for the ATmega.

• Host: GitHub
• URL: https://github.com/prdktntwcklr/atmega-tdd-example
• Owner: prdktntwcklr
• License: mit
• Created: 2022-09-18T05:58:22.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-15T07:57:22.000Z (5 months ago)
• Last Synced: 2024-11-14T09:40:31.584Z (2 months ago)
• Topics: atmega, avr, c, cicd, cmake, embedded, fff, tdd, unity
• Language: C
• Homepage:
• Size: 1.15 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ATmega TDD Example

![Build](https://github.com/prdktntwcklr/atmega-tdd-example/workflows/build/badge.svg)

This project demonstrates the use of unit testing and test-driven development

(TDD) when writing bare-metal code for an ATmega series microcontroller. This

project uses the [ThrowTheSwitch/Unity](https://github.com/ThrowTheSwitch/Unity)

unit testing framework together with [meekrosoft/fff](https://github.com/meekrosoft/fff)

for mocking support in order to minimize the reliance on external dependencies

such as `Ruby`.

In this example, the unit tests are run exclusively on the developer's machine

(the "host") instead of on the microcontroller itself (the "target"). To

streamline this process among developers, the project uses a Docker environment

described below (see [running unit tests](#running-unit-tests)).

## Required Hardware

1. Breadboard

2. Microcontroller (ATmega168A, 28-PDIP Package)

3. LED

4. Current-limiting resistor

5. Programmer (e.g. Pololu USB AVR Programmer v2.1)

6. Some jumper wires

Details on how to connect these components can be found in

```Docs/schematic.pdf```.

## Running unit tests

This project uses a Dockerized environment from within which the unit tests can

be executed. This saves developers from having to set up the development

environment themselves on their local workstations.

First, make sure that you have [Docker](https://www.docker.com/get-started/)

installed and running on your machine. Next, install and activate the

[Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)

extension for [Visual Studio Code](https://code.visualstudio.com/).

Opening the workspace in Visual Studio Code should then prompt you with a

textbox that allows you to reopen the project in a Docker container with all

required packages already installed. To invoke all unit tests, simply run:

```bash

./unit-tests.sh

```

This should show that all tests passing:

![All unit tests ran successfully.](Docs/run-unit-tests.jpg)

## Further reading

- Grenning, J. W. (2011): *Test-Driven Development for Embedded C.* Raleigh, NC:

Pragmatic Programmers.