Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 3.39 KB

TEST.md

File metadata and controls

69 lines (44 loc) · 3.39 KB
Raw

Test Procedures

This page outlines the procedures to test changes to the nodebuilder repository.

Table of Contents

Automated Validation

After opening a pull request, GitHub Actions will begin running a series of automated checks. After merging, the same CI checks will be run on the commit to master.

You can view the status of these CI tests on GitHub.com under the Checks tab of your PR or under the Actions tab of the repository. If any of these checks fail, review the relevant logs, research the error, and/or and manually reproduce it on your local environment.

Documentation changes must have the six verification checks passing. (No need to wait for the runtime checks.) All changes affecting code must have all of the 'Run nodebuilder' runtime checks passing.

  • ShellCheck check the bash shell scripts, including:

    • typical beginner's syntax issues that cause a shell to give cryptic error messages
    • typical intermediate level semantic problems that cause a shell to behave strangely and counter-intuitively.
    • subtle caveats, corner cases and pitfalls that may cause an advanced user's otherwise working script to fail under future circumstances.

  • actionlint checks the GitHub Actions .yaml workflow file. We like that it enforces ShellCheck inside workflows.

  • dockerfilelint checks analyzes the Dockerfiles for common traps and mistakes. We use it to enforce best practices.

  • shfmt formats shell programs. shfmt's default shell formatting was chosen to be consistent, common, and predictable. We use it to enforce standardization.

  • markdown-link-check extracts links from markdown texts and checks whether each link is alive (200 OK) or dead.

  • PySpelling which will check for typos in the markdown files. If you see any false-positives during the CI check, add the words to our whitelist

After passing those six checks, GitHub Actions will then:

  • Run nodebuilder on Ubuntu 22 (latest)
  • Run nodebuilder on Ubuntu 20
  • Run nodebuilder on macOS 14 (arm64)
  • Run nodebuilder on macOS 13 (x86_64)
  • Run nodebuilder in a Fedora Docker container
  • Run nodebuilder in a Manjaro Docker container
  • Run nodebuilder in an Ubuntu Docker container

Manual Testing

During the review period, open pull requests should be manually tested to ensure:

  1. The change actually fixes the issue
  2. The change doesn't cause unintentional bugs

Major Code Changes

For major changes to the code or for Bitcoin Core version upgrades, perform a full test on a fresh install of:

  • Ubuntu Desktop LTS running on bare metal
  • Debian 12 running on a Proxmox virtual machine

Minor Code Changes

For minor changes, each pull request should be tested on Ubuntu Desktop.

Run the following command after updating the test_branch_name:

test_branch_name=""
cd "${HOME}"/
[ -d "${HOME}"/nodebuilder/ ] && rm -rf "${HOME}"/nodebuilder/
git clone https://github.com/bitcoin-tools/nodebuilder.git -b "${test_branch_name}"
"${HOME}"/nodebuilder/nodebuilder