greg/nix-bitcoin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: add run-tests.sh to examples

Browse Source
This commit is contained in:
Erik Arvstedt 2020-09-27 12:43:32 +02:00
parent 5a565dff66
commit c9251e72a1
No known key found for this signature in database
GPG Key ID: 33312B944DD97846
2 changed files with 27 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -24,11 +24,11 @@ The goal is to make it easy to deploy a reasonably secure Bitcoin node with a us
It should allow managing bitcoin (the currency) effectively and providing public infrastructure. It should allow managing bitcoin (the currency) effectively and providing public infrastructure.
It should be a reproducible and extensible platform for applications building on Bitcoin. It should be a reproducible and extensible platform for applications building on Bitcoin.
Example Examples
--- ---
The easiest way to try out nix-bitcoin is to use one of the provided examples. The easiest way to try out nix-bitcoin is to use one of the provided examples.
``` ```bash
git clone https://github.com/fort-nix/nix-bitcoin git clone https://github.com/fort-nix/nix-bitcoin
cd nix-bitcoin/examples/ cd nix-bitcoin/examples/
nix-shell nix-shell
@ -48,6 +48,28 @@ shut down immediately. They leave no traces (outside of `/nix/store`) on the hos
NixOps can be used to deploy to various other backends like cloud providers.\ NixOps can be used to deploy to various other backends like cloud providers.\
Requires: [Nix](https://nixos.org/nix/), [VirtualBox](https://www.virtualbox.org) Requires: [Nix](https://nixos.org/nix/), [VirtualBox](https://www.virtualbox.org)
#### Tests
The internal test suite is also useful for exploring features.
The following `run-tests.sh` commands leave no traces (outside of `/nix/store`) on
the host system.
```bash
git clone https://github.com/fort-nix/nix-bitcoin
cd nix-bitcoin/test
# Run a Python test shell inside a VM node
./run-tests.sh debug
print(succeed("systemctl status bitcoind"))
# Run a node in a container. Requires systemd and root privileges.
./run-tests.sh container
c systemctl status bitcoind
# Explore a single feature
./run-tests.sh --scenario electrs container
```
See [`run-tests.sh`](test/run-tests.sh) for a complete documentation.
Available modules Available modules
--- ---
By default the `configuration.nix` provides: By default the `configuration.nix` provides:

3
test/run-tests.sh
View File

@ -13,6 +13,9 @@
# When <scenario> is undefined, the test is run with an adhoc scenario # When <scenario> is undefined, the test is run with an adhoc scenario
# where services.<scenario> is enabled. # where services.<scenario> is enabled.
# #
# Example:
# ./run-tests.sh -s electrs
#
# Run test and link results to avoid garbage collection # Run test and link results to avoid garbage collection
# ./run-tests.sh [--scenario <scenario>] --out-link-prefix /tmp/nix-bitcoin-test build # ./run-tests.sh [--scenario <scenario>] --out-link-prefix /tmp/nix-bitcoin-test build
# #