@beinformed/citra

Citra framework

• Citra framework
  • About
  • Built with
  • Getting started

About

For easy integration with Be Informed modular UI services, Be Informed has developed the Citra (Continuous Integration Test Regression Assert) framework, providing functions and assert syntax.

Citra is an API testing framework designed to perform end to end tests on JSON REST endpoints. It can be used to test application behavior of web application components using Modular UI services. The Citra library offers a BDD testing style and fully exploits Javascript promises - the resulting tests are simple, clear and expressive. Citra is built on Node.js and the Javascript test frameworks Chakram, Mocha and Chai.

The Citra functionality is provided in separate namespaces (e.g. auth, config, logger, util). Please refer to the provided documentation for more information.

Built with

• Mocha - Mocha is a testing library for Node.js, created to be a simple, extensible, and fast testing suite. It’s used for unit and integration testing, and it’s a great candidate for BDD.
• Chakram-BeInformed - Chakram is a REST API testing framework offering a BDD testing style and fully exploiting promises.
• Chai.js - Chai is a BDD / TDD assertion library for node and the browser that can be delightfully paired with any Javascript testing framework.
• Chai-Things.js - Chai Things adds support to Chai for assertions on array elements.
• Node.js - Node.js is an open-source, cross-platform JavaScript run-time environment that executes JavaScript code outside of a browser.
• Citra - The Citra (Continuous Integration Test Regression Assert) node module of Be Informed provides functions and assert syntax for easier testing of UI services of the model driven application. Citra extends Chai.js, adding HTTP specific assertions.
• Chai-Subset - Adds a containsSubset object properties matcher to Chai for asserting on subsets of results.
• Chai-DateTime - Matchers for chai to help with common date comparison assertions against JavaScript Date objects.

Getting started

More information about getting started with Citra can be found on our Getting started with testing application behavior page.