This repository is part of the Fabric project. Please consult Fabric's CONTRIBUTING documentation as the basis on how to contribute to this repository.
The following check-list is for code contributors to make sure their changesets are compliant to the coding standards and avoid time wasted in rejected changesets:
Check the coding styles, run the following command and make sure no ESLint violations are present:
gulp
Run the full unit test bucket and make sure 100% are passing. You can also run each test individually to isolate any failures:
gulp test
The gulp test command above also generates code coverage reports. Your new code should be accompanied with unit tests that provide 100% line coverage, and functional tests that establish the correct operation of your code delivery.
The Fabric-SDK-Node repository contains unit and functional (e2e) tests to ensure correct code functionality and guard against regressions. The published packages are tested in an additional repository (Fabric-Test), which tests the interoperability of the Fabric-SDK-Node packages with all other Hyperledger Fabric repositories.
Unit tests for each package are held locally under a package/test directory that mirrors the package/lib directory. Tests within these directories are written in Mocha, and may be run locally within the package via the npm test command at the package level. We make use of the following dependancies within the unit tests:
- Sinon for test spies, stubs and mocks
- Rewire for greater control of the component under test
- Istanbul for code coverage reports
It is expected that new code deliveries come with unit tests that:
- are isolated - all unit tests should be capable of being run indiviually as well as in the suite(s)
- are meaningful - all unit tests should test the code intention, and validate with assertions
- test golden path and failure path
- provide 100% line coverage
Functional tests are held at the repository level under the ~/test/integration directory and target a Fabric network that has been created based upon information within the ~/test/fixtures directory.
The functional tests are currently written in Tape, with the intention of testing the Fabric-SDK-Node packages from a user perspective against a live Hyperledger Fabric Network.
This work is licensed under a Creative Commons Attribution 4.0 International License.
s
