https://github.com/sappo/cucumber-c
Cucumber implementation for C
https://github.com/sappo/cucumber-c
bdd cucumber test
Last synced: 3 months ago
JSON representation
Cucumber implementation for C
- Host: GitHub
- URL: https://github.com/sappo/cucumber-c
- Owner: sappo
- License: mpl-2.0
- Created: 2020-04-04T14:10:48.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-11-12T10:34:07.000Z (over 3 years ago)
- Last Synced: 2025-01-12T10:28:43.583Z (5 months ago)
- Topics: bdd, cucumber, test
- Language: C
- Homepage:
- Size: 117 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
[](https://gitter.im/cucumber/cucumber-c?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://github.com/zeromq/dafka/blob/master/LICENSE)
# Cucumber-C
[](https://travis-ci.org/zeromq/dafka)
Cucumber-C allows Cucumber to support step definitions written in C.
* [Cucumber Website](https://cucumber.io)
## Overview
### Scope and Goals
Cucumber-C has these goals:
* To enbale C developers with a library to write Gherkin style BDD tests.
* To provide a clean API that let's the user(s) focus on writing step definitions.
* To integrate with [zproject](https://github.com/zeromq/zproject).
### Ownership and License
The contributors are listed in AUTHORS. This project uses the MPL v2 license, see LICENSE.
Cucumber-C uses the [C4.1 (Collective Code Construction Contract)](https://rfc.zeromq.org/spec:22) process for contributions.
Cucumber-C uses the [CLASS (C Language Style for Scalabilty)](https://rfc.zeromq.org/spec:21) guide for code style.
To report an issue, use the [Cucumber-C issue tracker](https://github.com/sappo/cucumber-c/issues) at github.com.
## Getting started
You can define your step definitions as follows:
```C
#define CZMQ_BUILD_DRAFT_API
#include
struct _my_state_t {
int filler;
};
typedef struct _my_state_t my_state_t;
my_state_t *
my_state_new (bool verbose)
{
return (my_state_t *) zmalloc (sizeof (my_state_t));
}
void
my_state_destroy (my_state_t **self_p)
{
assert (self_p);
if (*self_p) {
my_state_t *self = *self_p;
// Free class properties
self->filler = 0;
// Free object itself
free (self);
*self_p = NULL;
}
}
void
given_a_topic (cucumber_step_def_t *self, void *state_p) {
const char *text, *topic;
FETCH_PARAMS(&text, &topic)
my_state_t *state = (my_state_t *) state_p;
state->filler = 1;
}
void
when_message_is_sent (cucumber_step_def_t *self, void *state_p) {
const char *text, *topic;
FETCH_PARAMS(&text, &topic)
my_state_t *state = (my_state_t *) state_p;
state->filler = 2;
}
STEP_DEFS(protocol, my_state_new, my_state_destroy) {
GIVEN("a dafka (\\w+) subscribed to topic '(\\w+)'",
given_a_topic)
WHEN("a (\\w+) message with sequence larger 0 is sent on topic '(\\w+)'",
when_message_is_sent)
}
STEP_RUNNER(protocol, my_state_new, my_state_destroy)
```
Now compile and run your step definitions
gcc my_step_defs.c -o my_step_defs -l cucumber -l czmq -l zmq
./my_step_defs
To run your feature file use the cucumber_runner:
cucumber_runner my_usecase.feature
## Under the Hood
### Hints to Contributors
Cucumber-C is a nice, neat library, and you may not immediately appreciate why. Read the CLASS style guide please, and write your code to make it indistinguishable from the rest of the code in the library. That is the only real criteria for good style: it's invisible.
Don't include system headers in source files. The right place for these is cucumber_prelude.h. If you need to check against configured libraries and/or headers, include platform.h in the source before including cuc.h.
Do read your code after you write it and ask, "Can I make this simpler?" We do use a nice minimalist and yet readable style. Learn it, adopt it, use it.
Before opening a pull request read our [contribution guidelines](https://github.com/sappo/cucumber-c/blob/master/CONTRIBUTING.md). Thanks!
### Code Generation
We generate scripts for build systems like autotools, cmake and others as well as class skeletons, class headers, the selftest runner and more using zproject. Generated files will have a header and footer telling you that this file was generated. To re-generate those files it is recommended to use the latest `zeromqorg/zproject` docker image.
#### Docker
* Clone [libzmq](https://github.com/zeromq/libzmq) into the same directory as cucumber-c.
* Clone [czmq](https://github.com/zeromq/czqm) into the same directory as cucumber-c.
Next always download the latest image:
```sh
# Make sure
docker pull zeromqorg/zproject:latest
```
Then run the following command:
```sh
# Shell and Powershell
docker run -v ${PWD}/..:/workspace -e BUILD_DIR=/workspace/cucumber-c zeromqorg/zproject
# Windows CMD
docker run -v %cd%/..:/workspace -e BUILD_DIR=/workspace/cucumber-c zeromqorg/zproject
```
#### Linux and MacOS
* Install [GSL](https://github.com/zeromq/gsl) and [zproject](https://github.com/zeromq/zproject)
* Clone [libzmq](https://github.com/zeromq/libzmq) into the same directory as cucumber-c
* Clone [czmq](https://github.com/zeromq/czmq) into the same directory as cucumber-c
Then run the following command:
gsl project.xml