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 commits are compliant and avoid time wasted in rejected pull requests:
Check the coding styles, run the following command and make sure no ESLint violations are present:
npm run lint
Run the full test bucket and make sure 100% are passing. You can also run each test individually to isolate any failures:
The Fabric-SDK-Node repository contains unit, integration and scenario 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 with the corresponding npm task: npm run unitTest:<packageName>. We make use of the following dependencies within the unit tests:
- Sinon for test spies, stubs and mocks
- Rewire for greater control of the component under test
- Nyc 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 individually 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
We are working towards 100% code coverage. As you add new functionality and unit tests, please increase the coverage limits in the nyc section of the top level package.json.
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.
The coverage reports are generated as html files in the coverage directory. The npm tasks unitTest:all, tapeIntegration, test:cucumber and test:ts-cucumber will print out a text coverage summary table. Therefore four coverage tables are printed during a CI run, each with different coverage limits set. The global nyc configuration for coverage is defined in the nyc block in the top-level package.json. Specific coverage configuration for each package is defined in package/package.json. 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.
This work is licensed under a Creative Commons Attribution 4.0 International License.
s
