WIP: Statemachine

.github/workflows/main.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        toolchain:
+          - 1.43
+          - nightly
+        os:
+          - ubuntu-latest
+          - macOS-latest
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v2
+      - name: Install Rust ${{ matrix.toolchain }} toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ matrix.toolchain }}
+          override: true
+          profile: minimal
+      - name: Build on Rust ${{ matrix.toolchain }}
+        run: cargo build --verbose --color always
+      - name: Test on Rust ${{ matrix.toolchain }}
+        run: cargo test --verbose --color always --all-features
+      - name: Functional tests
+        if: matrix.os == 'ubuntu-latest' && matrix.toolchain == 'nightly'
+        run: ./contrib/ci-functional-tests.sh
+        env:
+          RUST_BACKTRACE: 1
+
+  rustfmt_check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions-rs/toolchain@v1
+        with:
+            toolchain: stable
+            components: rustfmt
+            override: true
+      - run: cargo fmt -- --check

.gitignore

@@ -1 +1,2 @@
-/target
+target/
+__pycache__

Cargo.toml

@@ -6,7 +6,7 @@ edition = "2018"
 
 [dependencies]
 revault_tx = { version = "0.3.0", features = ["use-serde"] }
-revault_net = { version = "0.1.0", branch = "update_tx" }
+revault_net = "0.1.0"
 
 # Don't reinvent the wheel
 dirs = "3.0"
@@ -31,4 +31,7 @@ rusqlite = { version = "0.25.3", features = ["bundled", "unlock_notify"] }
 
 # We want to have a backtrace on panic, and the stdlib doesn't have a programmatic
 # interface yet to work with our custom panic hook.
-backtrace = "0.3.60"
+backtrace = "0.3"
+
+[dev-dependencies]
+fastrand = "1.4.0"

contrib/ci-functional-tests.sh

@@ -0,0 +1,22 @@
+set -xe
+
+# Do the linter check early for quicker feedback
+pip install black
+black --check tests/
+
+# Build the miradord binary
+cargo build --release
+
+# Download the bitcoind binary
+BITCOIND_VERSION="22.0"
+DIR_NAME="bitcoin-$BITCOIND_VERSION"
+ARCHIVE_NAME="$DIR_NAME.tar.gz"
+curl https://bitcoincore.org/bin/bitcoin-core-$BITCOIND_VERSION/bitcoin-$BITCOIND_VERSION-x86_64-linux-gnu.tar.gz -o $ARCHIVE_NAME
+tar -xzf $ARCHIVE_NAME
+sudo mv $DIR_NAME/bin/bitcoind /usr/local/bin/
+
+# Run the functional tests
+python3 -m venv venv
+. venv/bin/activate
+pip install -r tests/requirements.txt
+VERBOSE=1 LOG_LEVEL=debug TIMEOUT=60 pytest -n2 -vvv --log-cli-level=DEBUG tests/

contrib/coverage.sh

@@ -0,0 +1,23 @@
+# Assumes:
+#  - you have a postgres DB set up with credentials revault:revault
+#  - you have functional tests dependencies installed (likely you are in a venv)
+
+set -ex
+
+if [ -z "$JOBS" ]; then JOBS=1; fi
+
+if ! command -v grcov &>/dev/null; then
+    cargo install grcov
+fi
+
+cargo clean
+
+rm -f "revaultd_coverage_*.profraw"
+LLVM_PROFILE_FILE="miradord_coverage_%m.profraw" RUSTFLAGS="-Zinstrument-coverage" RUSTDOCFLAGS="$RUSTFLAGS -Z unstable-options --persist-doctests target/debug/doctestbins" cargo +nightly build --all-features
+LLVM_PROFILE_FILE="miradord_coverage_%m.profraw" RUSTFLAGS="-Zinstrument-coverage" RUSTDOCFLAGS="$RUSTFLAGS -Z unstable-options --persist-doctests target/debug/doctestbins" cargo +nightly test --all-features --jobs $JOBS
+pytest -n $JOBS
+
+grcov . --binary-path ./target/debug/ -t html --branch --ignore-not-existing --llvm -o ./target/grcov/
+firefox target/grcov/index.html
+
+set +ex