mirror of
https://github.com/bisq-network/bisq.git
synced 2025-01-19 05:44:05 +01:00
Refactor, include section about running on mainnet
This commit is contained in:
parent
ec65c010f7
commit
514e7b74ce
@ -1,10 +1,32 @@
|
||||
# Build and Run API Test Harness
|
||||
# Build and Run API
|
||||
|
||||
## Linux & OSX
|
||||
The Java based API runs on Linux and OSX.
|
||||
|
||||
## Mainnet
|
||||
|
||||
To build from the source, clone the github repository found at `https://github.com/bisq-network/bisq`,
|
||||
and build with gradle:
|
||||
|
||||
$ ./gradlew clean build
|
||||
|
||||
To skip tests:
|
||||
|
||||
$ ./gradlew clean build -x test
|
||||
|
||||
To run the Bisq daemon:
|
||||
|
||||
$ ./bisq-daemon --apiPassword=<api-password> --apiPort=<api-port(default=9998)> --appDataDir=$APPDIR`
|
||||
|
||||
_Note: $APPDIR is empty or otherwise contains a Bisq wallet created by the daemon or the UI._
|
||||
|
||||
_Note: Never run the API daemon and Bisq UI on the same host, or you will corrupt your wallet. It will be possible
|
||||
with specific command line options, i.e., unique appDatadir and ports, but this scenario has not been tested yet._
|
||||
|
||||
## Test Harness
|
||||
|
||||
The API test harness uses the GNU Bourne-Again SHell `bash`, and is not supported on Windows.
|
||||
|
||||
## Predefined DAO / Regtest Setup
|
||||
### Predefined DAO / Regtest Setup
|
||||
|
||||
The API test harness depends on the contents of https://github.com/bisq-network/bisq/raw/master/docs/dao-setup.zip.
|
||||
The files contained in dao-setup.zip include a bitcoin-core wallet, a regtest genesis tx and chain of 111 blocks, plus
|
||||
@ -13,7 +35,7 @@ equivalent of 2.5 BTC in BSQ distributed among Bob & Alice's BSQ wallets.
|
||||
|
||||
See https://github.com/bisq-network/bisq/blob/master/docs/dao-setup.md for details.
|
||||
|
||||
## Install DAO / Regtest Setup Files
|
||||
### Install DAO / Regtest Setup Files
|
||||
|
||||
Bisq's gradle build file defines a task for downloading dao-setup.zip and extracting its contents to the
|
||||
`apitest/src/main/resources` folder, and the test harness will install a fresh set of data files to the
|
||||
@ -29,7 +51,7 @@ Or by running a single task:
|
||||
|
||||
The `:apitest:installDaoSetup` task does not need to be run again until after the next time you run the gradle `clean` task.
|
||||
|
||||
## Run API Tests
|
||||
### Run API Tests
|
||||
|
||||
The API test harness supports narrow & broad functional and full end to end test cases requiring
|
||||
long setup and teardown times -- for example, to start a bitcoind instance, seednode, arbnode, plus Bob & Alice
|
||||
@ -57,12 +79,12 @@ To run test cases from Intellij, add two JVM arguments to your JUnit launchers:
|
||||
The `-Dlogback.configurationFile` property will prevent `logback` from printing warnings about multiple `logback.xml`
|
||||
files it will find in Bisq jars `cli.jar`, `daemon.jar`, and `seednode.jar`.
|
||||
|
||||
## Gradle Test Reports
|
||||
### Gradle Test Reports
|
||||
|
||||
To see detailed test results, logs, and full stack traces for test failures, open
|
||||
`apitest/build/reports/tests/test/index.html` in a browser.
|
||||
|
||||
## See also
|
||||
### See also
|
||||
|
||||
- [test-categories.md](test-categories.md)
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user