Skip to content

Commit

Permalink
docs: changes to BUILD.md and CONTRIBUTING.md hyperledger-cacti#1792
Browse files Browse the repository at this point in the history
fixes: hyperledger-cacti#1792

Signed-off-by: ruzell22 <ruzell.vince.aquino@accenture.com>
  • Loading branch information
ruzell22 authored and petermetz committed Feb 4, 2022
1 parent 5680cbf commit c231b3f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
12 changes: 9 additions & 3 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,17 @@ The `npm run watch` script in action:
* Windows Only
* WSL2 or any virtual machine running Ubuntu 20.04 LTS
* Git
* NodeJS 16, npm 7 (we recommend using the Node Version Manager (nvm) if available for your OS)
* NodeJS v16.13.1, npm v8.1.2 (we recommend using the Node Version Manager (nvm) if available for your OS)
```
nvm install 16.13.1
nvm use 16.13.1
```
* Yarn
* `npm run install-yarn` (from within the project directory)
* Docker Engine
* Docker Compose
* OpenJDK (Corda support Java 8 JDK but do not currently support Java 9 or higher)
* `sudo apt install openjdk-8-jdk-headless`
* Clone the repository
Expand Down Expand Up @@ -126,11 +132,11 @@ At this point you should have all packages built for development.
You can start making your changes (use your own fork and a feature branch)
or just run existing tests and debug them to see how things fit together.

For example you can *run a ledger contract deployment test* via the
For example you can *run a ledger single status endpoint test* via the
REST API with this command:

```sh
npx tap --ts --timeout=600 packages/cactus-test-plugin-ledger-connector-quorum/src/test/typescript/integration/plugin-ledger-connector-quorum/deploy-contract/deploy-contract-via-web-service.test.ts
npx tap --ts --timeout=600 packages/cactus-test-plugin-htlc-eth-besu/src/test/typescript/integration/plugin-htlc-eth-besu/get-single-status-endpoint.test.ts
```

*You can also start the API server* and verify more complex scenarios with an
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -358,13 +358,13 @@ for both them separately anyway:
- An integration test:
```sh
npx tap --ts --timeout=600 packages/cactus-test-plugin-consortium-manual/src/test/typescript/integration/plugin-consortium-manual/security-isolation-via-api-server-ports.ts
npx tap --ts --timeout=600 packages/cactus-test-plugin-consortium-manual/src/test/typescript/integration/plugin-consortium-manual/get-consortium-jws-endpoint.test.ts
```
- A unit test:
```sh
npx tap --ts --timeout=600 packages/cactus-common/src/test/typescript/unit/objects/get-all-method-names.test.ts
npx jest packages/cactus-common/src/test/typescript/unit/objects/get-all-method-names.test.ts
```
#### Running all test cases (unit+integration)
Expand Down

0 comments on commit c231b3f

Please sign in to comment.