Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/legovaer/jsonnunit
🚦 a BDD assertion style unit testing framework for JSONNET through an 'expect' interface
https://github.com/legovaer/jsonnunit
assertion bdd jsonnet jsonnunit oclif tdd testing
Last synced: 10 days ago
JSON representation
🚦 a BDD assertion style unit testing framework for JSONNET through an 'expect' interface
- Host: GitHub
- URL: https://github.com/legovaer/jsonnunit
- Owner: legovaer
- License: mit
- Created: 2021-03-04T08:32:23.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-18T23:14:05.000Z (about 3 years ago)
- Last Synced: 2024-12-15T10:36:40.631Z (11 days ago)
- Topics: assertion, bdd, jsonnet, jsonnunit, oclif, tdd, testing
- Language: JavaScript
- Homepage:
- Size: 1.13 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
a BDD assertion style unit testing framework for JSONNET through an 'expect' interface
[](https://npmjs.org/package/jsonnunit)
[](https://codecov.io/gh/ScaleCity/jsonnunit)
[](https://app.fossa.com/projects/git%2Bgithub.com%2FScaleCity%2Fjsonnunit?ref=badge_shield)
[](https://circleci.com/gh/ScaleCity/jsonnunit)
* [🗒 Description](#-description)
* [🚀 Getting Started](#-getting-started)
* [✨ Features](#-features)
* [📌 Requirements](#-requirements)
* [Usage](#usage)
* [Commands](#commands)
# 🗒 Description
JSONNUNIT is a BDD assertion style unit testing framework for
[JSONNET](https://jsonnet.org/) through an 'expect' interface. Basically you
chain together natural language assertions which makes testing much easier by
giving you lots of assertions you can run against your code. This framework is
based on [Mocha](https://mochajs.org/): a simple, flexible, fun javascript test
framework for node.js & the browser.
# 🚀 Getting Started
The Getting Started tutorial is a step-by-step guide to introduce you to JSONNUNIT.
If you haven't developed any unit tests before, this tutorial is a great place to get started.
# ✨ Features
* **Sjsonnet support** - [Sjsonnet](https://github.com/databricks/sjsonnet) is a JVM implementation of the Jsonnet configuration language which speeds up the process of rendering large jsonnet structures.
* **Based on MochaJS** - We didn't re-invent the wheel but reflected one of the best tools currently available for unit testing NodeJS apps. This framework is based on [Mocha](https://mochajs.org/): a simple, flexible, fun javascript test framework for node.js & the browser.
* **Based on Chai** - We also took a lot of functionality from the [Chai Assertion Library](https://www.chaijs.com/). Chai is a BDD / TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework. Implementing this functionality allows you to write human-readable unit tests for your jsonnet structures.
# 📌 Requirements
JSONNUNIT is written in [NodeJS](https://www.npmjs.com/package/node) and requires Node 8.5+.
# Usage
```sh-session
$ npm install -g jsonnunit
$ jsonnunit COMMAND
running command...
$ jsonnunit (-v|--version|version)
jsonnunit/1.4.0 darwin-x64 node-v15.11.0
$ jsonnunit --help [COMMAND]
USAGE
$ jsonnunit COMMAND
...
```
# Commands
* [`jsonnunit help [COMMAND]`](#jsonnunit-help-command)
* [`jsonnunit update [CHANNEL]`](#jsonnunit-update-channel)
## `jsonnunit help [COMMAND]`
display help for jsonnunit
```
USAGE
$ jsonnunit help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_
## `jsonnunit update [CHANNEL]`
update the jsonnunit CLI
```
USAGE
$ jsonnunit update [CHANNEL]
```
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v1.3.10/src/commands/update.ts)_
## Contributing
Thank you very much considerting to contribute!
Please make sure you follow our Code Of Conduct and we also strongly recommend
reading our Contributing Guide.
## Contributors
Please see the full
[Contributors Graph](https://github.com/scalecity/jsonnunit/graphs/contributors)
for our list of contributors.
### Core Contributors
Feel free to reach out to any of the core contributors with your questions or
concerns. We will do our best to respond in a timely manner.
[](https://github.com/legovaer)
### License
[](https://app.fossa.com/projects/git%2Bgithub.com%2FScaleCity%2Fjsonnunit?ref=badge_large)