nix-bitcoin/test
Jonas Nick 7736468466
Merge fort-nix/nix-bitcoin#597: Integrate trustedcoin clightning plugin
a3c654768c docs: trustedcoin: add info about possible problems (Otto Sabart)
67f2eb2feb trustedcoin: explicitly use the HTTPS_PROXY for external connections (Otto Sabart)
4942130abe tests: add tests for trustedcoin clightning plugin (Otto Sabart)
8c00c26fa1 trustedcoin: update to v0.6.1 (Otto Sabart)
5b5e76931d trustedcoin: fix shellcheck (Otto Sabart)
3d26f72b7f clightning-plugins: add trustedcoin (neverupdate)
c747ddbf32 readme: reference trustedcoin source (neverupdate)
35fc3a2b44 trustedcoin: add module (neverupdate)
3197338d81 trustedcoin: add pkg (neverupdate)

Pull request description:

ACKs for top commit:
  jonasnick:
    ACK a3c654768c

Tree-SHA512: 81075d051c500b533ac979530645ccb596c57cf93cf695419eda9f13575863b1cece0cb9a423fc669d96b97a19ba6a49012a1abef310f904df99b90762c5c943
2023-04-17 11:21:48 +00:00
..
ci tests: define tests via flake 2022-11-03 23:08:06 +01:00
lib test: support run, debug commands in basic NixOS tests 2023-02-02 10:51:41 +01:00
nixos-search update nixpkgs 2023-04-16 12:39:01 +00:00
clightning-replication.nix tests/clightning-replication: reuse pkgs instance 2023-02-02 10:51:41 +01:00
README.md docs: move test docs from examples/README to test/README 2023-01-15 20:28:48 +01:00
run-tests.sh add presets/wireguard.nix 2023-03-11 20:10:54 +01:00
shellcheck.sh tests: add shellcheckServices 2022-09-12 21:00:00 +02:00
tests.nix tests: add tests for trustedcoin clightning plugin 2023-04-11 21:00:00 +02:00
tests.py tests: add tests for trustedcoin clightning plugin 2023-04-11 21:00:00 +02:00
wireguard-lndconnect.nix add presets/wireguard.nix 2023-03-11 20:10:54 +01:00

The run-tests.sh command is most convenient and versatile way to run tests.
It leave no traces (outside of /nix/store) on the host system.

run-tests.sh requires Nix >= 2.10.

Summary

./run-tests.sh [--scenario|-s <scenario>] [build|vm|debug|container]

See the top of run-tests.sh for a complete documentation.
Test scenarios are defined in tests.nix and tests.py.

Tutorial

Running tests

# Run the basic set of tests. These tests are also run on the GitHub CI server.
./run-tests.sh

# Run the test for scenario `regtest`.
# The test is run via the Nix build system. Successful runs are cached.
./run-tests.sh -s regtest build
./run-tests.sh -s regtest # Shorthand, equivalent

# To test a single service, use its name as a scenario.
./run-tests.sh -s clightning

# When no scenario is specified, scenario `default` is used.
./run-tests.sh build

Debugging

# Start a shell is inside a test VM. No tests are executed.
./run-tests.sh -s bitcoind vm
systemctl status bitcoind

# Run a Python NixOS test shell inside a VM.
# See https://nixos.org/manual/nixos/stable/#ssec-machine-objects for available commands.
./run-tests.sh debug
print(succeed("systemctl status bitcoind"))
run_test("bitcoind")

# Start a shell in a container node. Requires systemd and root privileges.
./run-tests.sh container

# In the container shell: Run command in container (with prefix `c`)
c systemctl status bitcoind

# Explore a single feature
./run-tests.sh -s electrs container

# Run a command in a container.
# The container is deleted afterwards.
./run-tests.sh -s clightning container --run c lightning-cli getinfo

# Define a custom scenario
./run-tests.sh --scenario '{
  services.clightning.enable = true;
  nix-bitcoin.nodeinfo.enable = true;
}' container --run c nodeinfo

Running tests with Flakes

Tests can also be accessed via the nix-bitcoin flake:

# Build test
nix build --no-link ..#tests.default

# Run a node in a VM. No tests are executed.
nix run ..#tests.default.vm

# Run a Python test shell inside a VM node
nix run ..#tests.default.run -- --debug

# Run a node in a container. Requires extra-container, systemd and root privileges
nix run ..#tests.default.container
nix run ..#tests.default.containerLegacy # For NixOS with `system.stateVersion` <22.05

# Run a command in a container
nix run ..#tests.default.container -- --run c nodeinfo
nix run ..#tests.default.containerLegacy -- --run c nodeinfo # For NixOS with `system.stateVersion` <22.05