narmock 0.1.6

A minimal mocking utility for C projects.

🎣 narmock

A minimal mocking utility for C projects.

🚧 Work in progress 🚧

Narmock identifies the mocks being used in your tests and generates easy-to-use implementations with a slick API.

#include <time.h>

#include "__mocks__.h"
#include "narwhal.h"

TEST(example)
{
    MOCK(time)->mock_return(42);
    ASSERT_EQ(time(NULL), 42);
}

Most of the examples in this README are tests written with Narwhal but Narmock can be used with other test frameworks and anywhere in regular source code.

Installation

The package can be installed with pip.

$ pip install narmock

Getting started

The command-line utility provides three essential commands that should make it possible to integrate Narmock in any kind of build system.

$ narmock --help
usage: narmock [-h] (-g <file> | -d <file> | -f) [-p <string>] [<file>]

A minimal mocking utility for C projects.

positional arguments:
  <file>       expanded code or generated mocks

optional arguments:
  -h, --help   show this help message and exit
  -g <file>    generate mocks
  -d <file>    extract declarations
  -f           output linker flags
  -p <string>  getter prefix

TODO

Contributing

Contributions are welcome. Feel free to open issues and suggest improvements. This project uses poetry so you'll need to install it first if you want to be able to work with the project locally.

$ curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python

You should now be able to install the required dependencies.

$ poetry install

The code follows the black code style.

$ poetry run black narmock

You can run the tests with poetry run make -C tests. The test suite is built with Narwhal.

$ poetry run make -C tests

---

License - MIT