mirror of
https://github.com/oceanprotocol-archive/squid-js.git
synced 2024-02-02 15:31:51 +01:00
fixed component versions, document local testing
This commit is contained in:
parent
34308e867f
commit
8e92d8bc82
@ -5,9 +5,7 @@ node_js:
|
|||||||
services:
|
services:
|
||||||
- docker
|
- docker
|
||||||
|
|
||||||
cache:
|
cache: npm
|
||||||
directories:
|
|
||||||
- node_modules
|
|
||||||
|
|
||||||
matrix:
|
matrix:
|
||||||
fast_finish: true
|
fast_finish: true
|
||||||
@ -25,7 +23,7 @@ before_script:
|
|||||||
- export BRIZO_VERSION=v0.3.10
|
- export BRIZO_VERSION=v0.3.10
|
||||||
- export KEEPER_VERSION=v0.9.7
|
- export KEEPER_VERSION=v0.9.7
|
||||||
- export KEEPER_OWNER_ROLE_ADDRESS="0xe2DD09d719Da89e5a3D0F2549c7E24566e947260"
|
- export KEEPER_OWNER_ROLE_ADDRESS="0xe2DD09d719Da89e5a3D0F2549c7E24566e947260"
|
||||||
- bash -x start_ocean.sh --latest --no-pleuston --local-spree-node 2>&1 > start_ocean.log &
|
- bash -x start_ocean.sh --no-pleuston --local-spree-node 2>&1 > start_ocean.log &
|
||||||
- cd ..
|
- cd ..
|
||||||
|
|
||||||
script:
|
script:
|
||||||
|
71
README.md
71
README.md
@ -22,9 +22,11 @@
|
|||||||
- [Examples](#examples)
|
- [Examples](#examples)
|
||||||
- [Documentation](#documentation)
|
- [Documentation](#documentation)
|
||||||
- [Development](#development)
|
- [Development](#development)
|
||||||
- [Testing](#testing)
|
- [Testing](#testing)
|
||||||
- [Production build](#production-build)
|
- [Unit Tests](#unit-tests)
|
||||||
- [npm releases](#npm-releases)
|
- [Integration Tests](#integration-tests)
|
||||||
|
- [Production build](#production-build)
|
||||||
|
- [Releases](#releases)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
---
|
---
|
||||||
@ -93,40 +95,75 @@ npm i
|
|||||||
npm start
|
npm start
|
||||||
```
|
```
|
||||||
|
|
||||||
### Testing
|
## Testing
|
||||||
|
|
||||||
To start unit tests you need to:
|
### Unit Tests
|
||||||
|
|
||||||
|
For unit tests, running [`ganache-cli`](https://github.com/trufflesuite/ganache-cli) is required before starting the tests:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
ganache-cli &
|
npm i -g ganache-cli
|
||||||
npm run test
|
ganache-cli
|
||||||
```
|
```
|
||||||
|
|
||||||
or to watch for changes
|
To start unit tests, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm test
|
||||||
|
```
|
||||||
|
|
||||||
|
or to watch for changes:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
ganache-cli &
|
|
||||||
npm run test:watch
|
npm run test:watch
|
||||||
```
|
```
|
||||||
|
|
||||||
to create code coverage
|
to create code coverage information:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
ganache-cli &
|
|
||||||
npm run test:cover
|
npm run test:cover
|
||||||
```
|
```
|
||||||
|
|
||||||
This will start a watcher for changes of the code.
|
### Integration Tests
|
||||||
|
|
||||||
`ganache-cli` can be installed following [this instructions](https://github.com/trufflesuite/ganache-cli#installation).
|
Besides a running `ganache-cli` instance, a locally running Ocean network is required. To do so before running the tests, use [Barge](https://github.com/oceanprotocol/barge):
|
||||||
|
|
||||||
### Production build
|
```bash
|
||||||
|
git clone https://github.com/oceanprotocol/barge
|
||||||
|
cd barge
|
||||||
|
|
||||||
|
./start_ocean.sh --latest --no-pleuston --local-spree-node
|
||||||
|
```
|
||||||
|
|
||||||
|
In another terminal window, run this script and export the seed phrase:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# copies the contract artifacts once the local Ocean network is up and running
|
||||||
|
./scripts/wait_for_migration_and_extract_keeper_artifacts.sh
|
||||||
|
|
||||||
|
# export Spree accounts seed phrase
|
||||||
|
export SEED_WORDS="taxi music thumb unique chat sand crew more leg another off lamp"
|
||||||
|
```
|
||||||
|
|
||||||
|
Once everything is up, run the integration tests:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run integration
|
||||||
|
```
|
||||||
|
|
||||||
|
to generate code coverage information during test, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run integration:cover
|
||||||
|
```
|
||||||
|
|
||||||
|
## Production build
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run build
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
### npm releases
|
## Releases
|
||||||
|
|
||||||
For a new **patch release**, execute on the machine where you're logged into your npm account:
|
For a new **patch release**, execute on the machine where you're logged into your npm account:
|
||||||
|
|
||||||
@ -138,8 +175,8 @@ git tag with the latest version and `git push`
|
|||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
```
|
```text
|
||||||
Copyright 2018 Ocean Protocol Foundation Ltd.
|
Copyright 2019 Ocean Protocol Foundation Ltd.
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
|
669
package-lock.json
generated
669
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user