Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update functional test documentation #529

Merged
merged 2 commits into from
Dec 9, 2024
Merged

Update functional test documentation #529

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b697ff8
Update functional test documentation
AaronFeickert Dec 9, 2024
bc73b2f
Review fixes
AaronFeickert Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions functional-tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ Most tests depend upon `bitcoind` being available. The tests here execute
this binary and then, perform various tests.

```bash
# for MacOS
# for macOS
brew install bitcoin
```

Note that in macOS, you may need to specifically add a firewall rule to allow incoming local `bitcoind` connections.

```bash
# for Linux (x86_64)
curl -fsSLO --proto "=https" --tlsv1.2 https://bitcoincore.org/bin/bitcoin-core-28.0/bitcoin-28.0-x86_64-linux-gnu.tar.gz
Expand All @@ -35,7 +37,7 @@ bitcoind --version

We use Poetry for managing the test dependencies.

First, install the `poetry`:
First, install `poetry`:

```bash
# install via apt
Expand All @@ -48,22 +50,32 @@ pipx install poetry
brew install poetry
```

Check, that the `poetry` is installed:
Check, that `poetry` is installed:

```bash
poetry --version
```

Finally, install all test dependencies by running:
Finally, install all test dependencies (without installing the root package):

```bash
poetry install
poetry install --no-root
```

## Running tests

You can run all tests:

```bash
./run_test.sh
```

Or, you can run a specific test:

```bash
./run_test.sh fn_bridge_deposit_happy
```

## Running prover tasks

```bash
Expand Down
Loading