Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

Commit f527c5a

Browse files
committed
[CO-325] Adjust wallet-new's README as per feedback
1 parent f5fa3ee commit f527c5a

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

wallet-new/README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,33 @@ $ stack test cardano-sl-wallet-new
154154
Wallet integration tests can be run using this command (from the project *root* directory):
155155

156156
```
157-
$ nix-build release.nix -A tests.walletIntegration --arg useStackBinaries true
157+
$ nix-build -A walletIntegrationTests --arg useStackBinaries true
158158
```
159159

160+
> **NOTE**:
161+
> `nix-build -A walletIntegrationTests` (with or without `useStackBinaries`) runs a
162+
> local demo cluster, either via stack or nix by default on your local machine
163+
> that is fully usable by daedalus/curl etc... and requires port 8090 and
164+
> ports 3001-3004 and 3101 to be available. This cluster has four core nodes, 1
165+
> relay, and a single wallet and has full x509 CA cert enabled. It then
166+
> pre-loads some genesis poor keys for testing and runs the wal-integr-test
167+
> haskell program, which connects to the running cluster. When it completes, it
168+
> terminates the demo cluster and wallet. This will fail if ports aren't
169+
> available to bind (although cardano-node will happily run without crashing,
170+
> it just will be broken), you try running two of these at once, etc...
171+
>
172+
> This is differentiated from `nix-build -A tests.walletIntegration` which **DOES
173+
> NOT** support `useStackBinaries` and builds/runs the entire cluster in a sandbox
174+
> isolated from the rest of the system (assuming nix sandboxing is enabled).
175+
> This is how hydra runs the tests and why hydra is capable or running more
176+
> than one cluster at the same time. This will use any binaries cached by hydra
177+
> if you have the IOHK binary cache enabled, or will build everything cleanly
178+
> in nix if the binaries aren't available in the local nix store. One other
179+
> thing to note is that tests.walletIntegration will only run once and will
180+
> cache the results (unless of a failure). If you have a need to rerun the
181+
> test, you can pass the `--check` flag to force the test to run again. `--check`
182+
> is used to confirm that results from one test match the results again.
183+
160184
## Developing
161185

162186
We have a [`Makefile`](./Makefile) with some helpful commands for development.

0 commit comments

Comments
 (0)