merge.yml

name: Check before merge

on:
  # tests must run for a PR to be valid and pass merge queue muster
  # on main, we want to know that all commits are passing at a glance, any deviation should help bisecting errors
  # the merge run checks should show on master and enable this clear test/passing history
  merge_group:
    branches: [main, alpha*, beta*, rc*]
  pull_request:
    branches: ["*"]

env:
  CARGO_INCREMENTAL: 0 # bookkeeping for incremental builds has overhead, not useful in CI.
  WINSW_URL: https://github.com/winsw/winsw/releases/download/v3.0.0-alpha.11/WinSW-x64.exe

jobs:
  cargo-udeps:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    name: Unused dependency check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@nightly # Needs nightly to distinguish between deps of different versions
        with:
          # we need rustfmt here while we have a build step
          components: rustfmt

      - name: Install cargo-udeps
        run: cargo install cargo-udeps --locked

      - name: Run cargo-udeps
        run: cargo +nightly udeps --all-targets
        # ignore the error cause by the latest nightly changes.
        # should be fixed by https://github.com/dalek-cryptography/curve25519-dalek/pull/619
        continue-on-error: true

  lint:
    runs-on: ubuntu-latest
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: wagoid/commitlint-github-action@5ce82f5d814d4010519d15f0552aec4f17a1e1fe

  checks:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    name: various checks
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt, clippy

      - uses: Swatinem/rust-cache@v2

      - name: Check formatting
        run: cargo fmt --all -- --check

      - shell: bash
        run: cargo clippy --all-targets --all-features -- -Dwarnings

      - name: Check documentation
        # Deny certain `rustdoc` lints that are unwanted.
        # See https://doc.rust-lang.org/rustdoc/lints.html for lints that are 'warning' by default.
        run: RUSTDOCFLAGS="--deny=warnings" cargo doc --no-deps

      - name: Check local-discovery is not a default feature
        shell: bash
        run: if [[ ! $(cargo metadata --no-deps --format-version 1 | jq -r '.packages[].features.default[]? | select(. == "local-discovery")') ]]; then echo "local-discovery is not a default feature in any package."; else echo "local-discovery is a default feature in at least one package." && exit 1; fi

      # In a cargo workspace, feature unification can occur, allowing a crate to be built successfully even if it
      # doesn't explicitly specify a feature it uses, provided another crate in the workspace enables that feature.
      # To detect such cases, we must build each crate using `--package` flag, building all packages at once does not work.
      - name: Check the whole workspace can build
        shell: bash
        run: |
          for package in $(cargo metadata --no-deps --format-version=1 | jq -r '.packages[].name'); do
            cargo build -p "$package"
          done

  unit:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    name: Unit Tests
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - uses: Swatinem/rust-cache@v2

      - name: Run CLI tests
        timeout-minutes: 25
        run: cargo test --release --package sn_cli -- --skip test_acc_packet_

        # We do not run client `--tests` here as they can require a network
      - name: Run client tests
        timeout-minutes: 25
        run: |
          cargo test --release --package sn_client --lib
          cargo test --release --package sn_client --doc

      - name: Run network tests
        timeout-minutes: 25
        run: cargo test --release --package sn_networking

      - name: Run protocol tests
        timeout-minutes: 25
        run: cargo test --release --package sn_protocol

      - name: Run transfers tests
        timeout-minutes: 25
        run: cargo test --release --package sn_transfers

      - name: Run register tests
        timeout-minutes: 25
        run: cargo test --release --package sn_registers
        env:
          # this will speed up PR merge flows, while giving us a modicum
          # of proptesting
          # we do many more runs on the nightly run
          PROPTEST_CASES: 50

  node-manager-unit-tests:
    name: node manager unit tests
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2

      - name: cargo cache registry, index and build
        uses: actions/cache@v4.0.1
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-cargo-cache-${{ hashFiles('**/Cargo.lock') }}
      - shell: bash
        run: cargo test --lib --package sn-node-manager

  node-manager-e2e-tests:
    name: node manager e2e tests
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - { os: ubuntu-latest, elevated: sudo env PATH="$PATH" }
          - { os: macos-latest, elevated: sudo }
          - { os: windows-latest }
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2

      - shell: bash
        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
        run: |
          ${{ matrix.elevated }} rustup default stable
          ${{ matrix.elevated }} cargo test --package sn-node-manager --release --test e2e -- --nocapture

      # Powershell step runs as admin by default.
      - name: run integration test in powershell
        if: matrix.os == 'windows-latest'
        shell: pwsh
        run: |
          curl -L -o WinSW.exe $env:WINSW_URL

          New-Item -ItemType Directory -Force -Path "$env:GITHUB_WORKSPACE\bin"
          Move-Item -Path WinSW.exe -Destination "$env:GITHUB_WORKSPACE\bin"
          $env:PATH += ";$env:GITHUB_WORKSPACE\bin"

          cargo test --release --package sn-node-manager --test e2e -- --nocapture

  # Each upgrade test needs its own VM, otherwise they will interfere with each other.
  node-manager-upgrade-tests:
    name: node manager upgrade tests
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - {
              os: ubuntu-latest,
              elevated: sudo env PATH="$PATH",
              test: upgrade_to_latest_version,
            }
          - {
              os: ubuntu-latest,
              elevated: sudo env PATH="$PATH",
              test: force_upgrade_when_two_binaries_have_the_same_version,
            }
          - {
              os: ubuntu-latest,
              elevated: sudo env PATH="$PATH",
              test: force_downgrade_to_a_previous_version,
            }
          - {
              os: ubuntu-latest,
              elevated: sudo env PATH="$PATH",
              test: upgrade_from_older_version_to_specific_version,
            }
          - {
              os: macos-latest,
              elevated: sudo,
              test: upgrade_to_latest_version,
            }
          - {
              os: macos-latest,
              elevated: sudo,
              test: force_upgrade_when_two_binaries_have_the_same_version,
            }
          - {
              os: macos-latest,
              elevated: sudo,
              test: force_downgrade_to_a_previous_version,
            }
          - {
              os: macos-latest,
              elevated: sudo,
              test: upgrade_from_older_version_to_specific_version,
            }
          - { os: windows-latest, test: upgrade_to_latest_version }
          - {
              os: windows-latest,
              test: force_upgrade_when_two_binaries_have_the_same_version,
            }
          - { os: windows-latest, test: force_downgrade_to_a_previous_version }
          - {
              os: windows-latest,
              test: upgrade_from_older_version_to_specific_version,
            }
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2

      - shell: bash
        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
        run: |
          ${{ matrix.elevated }} rustup default stable
          ${{ matrix.elevated }} cargo test --package sn-node-manager --release \
            --test upgrades ${{ matrix.test }} -- --nocapture

      # Powershell step runs as admin by default.
      - name: run integration test in powershell
        if: matrix.os == 'windows-latest'
        shell: pwsh
        run: |
          curl -L -o WinSW.exe $env:WINSW_URL

          New-Item -ItemType Directory -Force -Path "$env:GITHUB_WORKSPACE\bin"
          Move-Item -Path WinSW.exe -Destination "$env:GITHUB_WORKSPACE\bin"
          $env:PATH += ";$env:GITHUB_WORKSPACE\bin"

          cargo test --package sn-node-manager --release `
            --test upgrades ${{ matrix.test }} -- --nocapture

  # Each daemon test needs its own VM, otherwise they will interfere with each other.
  node-manager-daemon-tests:
    name: node manager daemon tests
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - {
              os: ubuntu-latest,
              elevated: sudo env PATH="$PATH",
              test: restart_node,
            }
          # todo: enable once url/version has been implemented for Daemon subcmd.
          # - {
          #     os: macos-latest,
          #     elevated: sudo,
          #     test: restart_node,
          #   }
          # - {
          #     os: windows-latest,
          #     test: restart_node,
          #   }
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2

      - name: run integration test
        shell: bash
        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
        run: |
          ${{ matrix.elevated }} rustup default stable
          ${{ matrix.elevated }} cargo test --package sn-node-manager --release \
            --test daemon ${{ matrix.test }} -- --nocapture

      # Powershell step runs as admin by default.
      - name: run integration test in powershell
        if: matrix.os == 'windows-latest'
        shell: pwsh
        run: |
          curl -L -o WinSW.exe $env:WINSW_URL

          New-Item -ItemType Directory -Force -Path "$env:GITHUB_WORKSPACE\bin"
          Move-Item -Path WinSW.exe -Destination "$env:GITHUB_WORKSPACE\bin"
          $env:PATH += ";$env:GITHUB_WORKSPACE\bin"

          cargo test --package sn-node-manager --release `
            --test daemon ${{ matrix.test }} -- --nocapture

  e2e:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    name: E2E tests
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        include:
          - os: ubuntu-latest
            safe_path: /home/runner/.local/share/safe
          - os: windows-latest
            safe_path: C:\\Users\\runneradmin\\AppData\\Roaming\\safe
          - os: macos-latest
            safe_path: /Users/runner/Library/Application Support/safe
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2

      - name: Build binaries
        run: cargo build --release --bin safenode --bin safe --bin faucet
        timeout-minutes: 30

      - name: Start a local network
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: start
          interval: 2000
          node-path: target/release/safenode
          faucet-path: target/release/faucet
          platform: ${{ matrix.os }}
          build: true

      - name: Check SAFE_PEERS was set
        shell: bash
        run: |
          if [[ -z "$SAFE_PEERS" ]]; then
            echo "The SAFE_PEERS variable has not been set"
            exit 1
          else
            echo "SAFE_PEERS has been set to $SAFE_PEERS"
          fi

      # only these unit tests require a network, the rest are run above
      - name: Run sn_client --tests
        run: cargo test --package sn_client --release --tests
        env:
          SN_LOG: "all"
          # only set the target dir for windows to bypass the linker issue.
          # happens if we build the node manager via testnet action
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 15

      - name: Create and fund a wallet to pay for files storage
        run: |
          cargo run --bin faucet --release -- --log-output-dest=data-dir send 1000000 $(cargo run --bin safe --release -- --log-output-dest=data-dir wallet address | tail -n 1) | tail -n 1 > transfer_hex
          cargo run --bin safe --release -- --log-output-dest=data-dir wallet receive --file transfer_hex
        env:
          SN_LOG: "all"
        timeout-minutes: 5

      - name: Start a client to upload cost estimate
        run: cargo run --bin safe --release -- --log-output-dest=data-dir files estimate "./resources"
        env:
          SN_LOG: "all"
        timeout-minutes: 15

      - name: Start a client to upload files
        run: cargo run --bin safe --release -- --log-output-dest=data-dir files upload "./resources" --retry-strategy quick
        env:
          SN_LOG: "all"
        timeout-minutes: 15

      - name: Start a client to download files
        run: cargo run --bin safe --release -- --log-output-dest=data-dir files download --retry-strategy quick
        env:
          SN_LOG: "all"
        timeout-minutes: 2

      # Client FoldersApi tests against local network
      - name: Client FoldersApi tests against local network
        run: cargo test --release --package sn_client --test folders_api
        env:
          SN_LOG: "all"
        timeout-minutes: 10

      # CLI Acc-Packet files and folders tests against local network
      - name: CLI Acc-Packet files and folders tests
        run: cargo test --release -p sn_cli test_acc_packet -- --nocapture
        env:
          SN_LOG: "all"
        timeout-minutes: 10

      - name: Start a client to create a register writable by the owner only
        run: cargo run --bin safe --release -- --log-output-dest=data-dir register create -n baobao
        env:
          SN_LOG: "all"
        timeout-minutes: 10

      - name: Start a client to get a register writable by the owner only
        run: cargo run --bin safe --release -- --log-output-dest=data-dir register get -n baobao
        env:
          SN_LOG: "all"
        timeout-minutes: 2

      - name: Start a client to edit a register writable by the owner only
        run: cargo run --bin safe --release -- --log-output-dest=data-dir register edit -n baobao wood
        env:
          SN_LOG: "all"
        timeout-minutes: 10
      #
      # Next two steps are same with a slight difference in the way they write to the output file (GITHUB_OUTPUT vs ENV:GITHUB_OUTPUT)
      #
      - name: Start a client to create a register writable by anyone
        id: register-address
        if: matrix.os != 'windows-latest'
        run: echo "$(cargo run --bin safe --release -- --log-output-dest=data-dir register create -n trycatch -p | rg REGISTER_ADDRESS )" >> $GITHUB_OUTPUT
        env:
          SN_LOG: "all"
        timeout-minutes: 10

      - name: Start a client to create a register writable by anyone
        id: register-address-windows
        if: matrix.os == 'windows-latest'
        run: echo "$(cargo run --bin safe --release -- --log-output-dest=data-dir register create -n trycatch -p | rg REGISTER_ADDRESS )" >> $ENV:GITHUB_OUTPUT
        env:
          SN_LOG: "all"
        timeout-minutes: 10

      - name: Start a client to get a register writable by anyone (current client is the owner)
        run: cargo run --bin safe --release -- --log-output-dest=data-dir register get -n trycatch
        env:
          SN_LOG: "all"
        timeout-minutes: 2

      - name: Start a client to edit a register writable by anyone (current client is the owner)
        run: cargo run --bin safe --release -- --log-output-dest=data-dir register edit -n trycatch wood
        env:
          SN_LOG: "all"
        timeout-minutes: 10

      - name: Delete client subdir to generate new client
        shell: bash
        run: rm -rf ${{ matrix.safe_path }}/client
      #
      # Next four steps are same with a slight difference in the which output step they read from
      #
      - name: Start a client to get a register writable by anyone (new client is not the owner)
        if: matrix.os != 'windows-latest'
        run: cargo run --bin safe --release -- --log-output-dest=data-dir register get ${{ steps.register-address.outputs.REGISTER_ADDRESS }}
        env:
          SN_LOG: "all"
        timeout-minutes: 2

      - name: Start a client to edit a register writable by anyone (new client is not the owner)
        if: matrix.os != 'windows-latest'
        run: cargo run --bin safe --release -- --log-output-dest=data-dir register edit ${{ steps.register-address.outputs.REGISTER_ADDRESS }} water
        env:
          SN_LOG: "all"
        timeout-minutes: 10

      - name: Start a client to get a register writable by anyone (new client is not the owner)
        if: matrix.os == 'windows-latest'
        run: cargo run --bin safe --release -- --log-output-dest=data-dir register get ${{ steps.register-address-windows.outputs.REGISTER_ADDRESS }}
        env:
          SN_LOG: "all"
        timeout-minutes: 2

      - name: Start a client to edit a register writable by anyone (new client is not the owner)
        if: matrix.os == 'windows-latest'
        run: cargo run --bin safe --release -- --log-output-dest=data-dir register edit ${{ steps.register-address-windows.outputs.REGISTER_ADDRESS }} water
        env:
          SN_LOG: "all"
        timeout-minutes: 10

      - name: Stop the local network and upload logs
        if: always()
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: stop
          log_file_prefix: safe_test_logs_e2e
          platform: ${{ matrix.os }}

  gossipsub:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    name: Gossipsub E2E tests
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2

      - name: Build binaries
        run: cargo build --release --bin safenode --bin faucet
        timeout-minutes: 30

      - name: Build gossipsub testing executable
        run: cargo test --release -p sn_node --features=local-discovery --test msgs_over_gossipsub --no-run
        env:
          # only set the target dir for windows to bypass the linker issue.
          # happens if we build the node manager via testnet action
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 30

      - name: Start a local network
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: start
          interval: 2000
          node-path: target/release/safenode
          faucet-path: target/release/faucet
          platform: ${{ matrix.os }}
          build: true

      - name: Gossipsub - nodes to subscribe to topics, and publish messages
        run: cargo test --release -p sn_node --features local-discovery --test msgs_over_gossipsub -- --nocapture
        env:
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 20

      - name: Stop the local network and upload logs
        if: always()
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: stop
          log_file_prefix: safe_test_logs_gossipsub_e2e
          platform: ${{ matrix.os }}

  spend_test:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    name: spend tests against network
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - uses: Swatinem/rust-cache@v2

      - name: Build binaries
        run: cargo build --release --features=local-discovery --bin safenode --bin faucet
        timeout-minutes: 30

      - name: Build testing executable
        run: cargo test --release -p sn_node --features=local-discovery --test sequential_transfers --test storage_payments --no-run
        env:
          # only set the target dir for windows to bypass the linker issue.
          # happens if we build the node manager via testnet action
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 30

      - name: Start a local network
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: start
          interval: 2000
          node-path: target/release/safenode
          faucet-path: target/release/faucet
          platform: ${{ matrix.os }}
          build: true

      - name: Check SAFE_PEERS was set
        shell: bash
        run: |
          if [[ -z "$SAFE_PEERS" ]]; then
            echo "The SAFE_PEERS variable has not been set"
            exit 1
          else
            echo "SAFE_PEERS has been set to $SAFE_PEERS"
          fi

      - name: execute the spend tests
        run: cargo test --release -p sn_node --features="local-discovery" --test sequential_transfers -- --nocapture --test-threads=1
        env:
          SN_LOG: "all"
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 25

      - name: execute the storage payment tests
        run: cargo test --release -p sn_node --features="local-discovery" --test storage_payments -- --nocapture --test-threads=1
        env:
          SN_LOG: "all"
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 25

      - name: Stop the local network and upload logs
        if: always()
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: stop
          log_file_prefix: safe_test_logs_spend
          platform: ${{ matrix.os }}

  royalty_reward_test:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    name: royalty_reward tests against network
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - uses: Swatinem/rust-cache@v2

      - name: Build binaries
        run: cargo build --release --features=local-discovery,royalties-by-gossip --bin safenode --bin faucet
        timeout-minutes: 30

      - name: Build testing executable
        run: cargo test --release -p sn_node --features=local-discovery,royalties-by-gossip --test nodes_rewards --no-run
        env:
          # only set the target dir for windows to bypass the linker issue.
          # happens if we build the node manager via testnet action
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 30

      - name: Start a local network
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: start
          interval: 2000
          node-path: target/release/safenode
          faucet-path: target/release/faucet
          platform: ${{ matrix.os }}
          build: true

      - name: Check SAFE_PEERS was set
        shell: bash
        run: |
          if [[ -z "$SAFE_PEERS" ]]; then
            echo "The SAFE_PEERS variable has not been set"
            exit 1
          else
            echo "SAFE_PEERS has been set to $SAFE_PEERS"
          fi

      # This should be first to avoid slow reward acceptance etc
      - name: execute the nodes rewards tests
        run: cargo test --release -p sn_node --features=local-discovery,royalties-by-gossip --test nodes_rewards -- --nocapture --test-threads=1
        env:
          SN_LOG: "all"
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 25

      - name: Stop the local network and upload logs
        if: always()
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: stop
          log_file_prefix: safe_test_logs_royalty_reward
          platform: ${{ matrix.os }}

  token_distribution_test:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    name: token distribution test
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - uses: Swatinem/rust-cache@v2

      - name: Build binaries
        run: cargo build --release --features=local-discovery,distribution --bin safenode --bin faucet
        timeout-minutes: 30

      - name: Build testing executable
        run: cargo test --release --features=local-discovery,distribution --no-run
        env:
          # only set the target dir for windows to bypass the linker issue.
          # happens if we build the node manager via testnet action
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 30

      - name: Start a local network
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: start
          interval: 2000
          node-path: target/release/safenode
          faucet-path: target/release/faucet
          platform: ${{ matrix.os }}
          build: true

      - name: Check SAFE_PEERS was set
        shell: bash
        run: |
          if [[ -z "$SAFE_PEERS" ]]; then
            echo "The SAFE_PEERS variable has not been set"
            exit 1
          else
            echo "SAFE_PEERS has been set to $SAFE_PEERS"
          fi

      - name: execute token_distribution tests
        run: cargo test --release --features=local-discovery,distribution token_distribution -- --nocapture --test-threads=1
        env:
          SN_LOG: "all"
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 25

      - name: Stop the local network and upload logs
        if: always()
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: stop
          log_file_prefix: safe_test_logs_token_distribution
          platform: ${{ matrix.os }}

  churn:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    name: Network churning tests
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        include:
          - os: ubuntu-latest
            node_data_path: /home/runner/.local/share/safe/node
            safe_path: /home/runner/.local/share/safe
          - os: windows-latest
            node_data_path: C:\\Users\\runneradmin\\AppData\\Roaming\\safe\\node
            safe_path: C:\\Users\\runneradmin\\AppData\\Roaming\\safe
          - os: macos-latest
            node_data_path: /Users/runner/Library/Application Support/safe/node
            safe_path: /Users/runner/Library/Application Support/safe
    steps:
      - uses: actions/checkout@v4

      - uses: dtolnay/rust-toolchain@stable

      - uses: Swatinem/rust-cache@v2

      - name: Build binaries
        run: cargo build --release --features local-discovery --bin safenode --bin faucet
        timeout-minutes: 30

      - name: Build churn tests
        run: cargo test --release -p sn_node --features=local-discovery --test data_with_churn --no-run
        env:
          # only set the target dir for windows to bypass the linker issue.
          # happens if we build the node manager via testnet action
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 30

      - name: Start a local network
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: start
          interval: 2000
          node-path: target/release/safenode
          faucet-path: target/release/faucet
          platform: ${{ matrix.os }}
          build: true

      - name: Check SAFE_PEERS was set
        shell: bash
        run: |
          if [[ -z "$SAFE_PEERS" ]]; then
            echo "The SAFE_PEERS variable has not been set"
            exit 1
          else
            echo "SAFE_PEERS has been set to $SAFE_PEERS"
          fi

      - name: Chunks data integrity during nodes churn
        run: cargo test --release -p sn_node --features="local-discovery" --test data_with_churn -- --nocapture
        env:
          TEST_DURATION_MINS: 5
          TEST_TOTAL_CHURN_CYCLES: 15
          SN_LOG: "all"
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 30

      - name: Stop the local network and upload logs
        if: always()
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: stop
          log_file_prefix: safe_test_logs_churn
          platform: ${{ matrix.os }}

      - name: Verify restart of nodes using rg
        shell: bash
        timeout-minutes: 1
        # get the counts, then the specific line, and then the digit count only
        # then check we have an expected level of restarts
        # TODO: make this use an env var, or relate to testnet size
        run: |
          restart_count=$(rg "Node is restarting in" "${{ matrix.node_data_path }}" -c --stats | \
            rg "(\d+) matches" | rg "\d+" -o)
          echo "Restart $restart_count nodes"
          peer_removed=$(rg "PeerRemovedFromRoutingTable" "${{ matrix.node_data_path }}" -c --stats | \
            rg "(\d+) matches" | rg "\d+" -o)
          echo "PeerRemovedFromRoutingTable $peer_removed times"
          if [ $peer_removed -lt $restart_count ]; then
            echo "PeerRemovedFromRoutingTable times of: $peer_removed is less than the restart count of: $restart_count"
            exit 1
          fi
          node_count=$(ls "${{ matrix.node_data_path }}" | wc -l)
          echo "Node dir count is $node_count"

        # TODO: reenable this once the testnet dir creation is tidied up to avoid a large count here
        # if [ $restart_count -lt $node_count ]; then
        #   echo "Restart count of: $restart_count is less than the node count of: $node_count"
        #   exit 1
        # fi

      - name: Verify data replication using rg
        shell: bash
        timeout-minutes: 1
        # get the counts, then the specific line, and then the digit count only
        # then check we have an expected level of replication
        # TODO: make this use an env var, or relate to testnet size
        run: |
          fetching_attempt_count=$(rg "FetchingKeysForReplication" "${{ matrix.node_data_path }}" -c --stats | \
            rg "(\d+) matches" | rg "\d+" -o)
          echo "Carried out $fetching_attempt_count fetching attempts"
          node_count=$(ls "${{ matrix.node_data_path }}" | wc -l)
          if [ $fetching_attempt_count -lt $node_count ]; then
            echo "Replication fetching attempts of: $fetching_attempt_count is less than the node count of: $node_count"
            exit 1
          fi

      # Only error out after uploading the logs
      - name: Don't log raw data
        if: matrix.os != 'windows-latest' # causes error
        shell: bash
        timeout-minutes: 10
        run: |
          if ! rg '^' "${{ matrix.safe_path }}"/*/*/logs | awk 'length($0) > 15000 { print; exit 1 }'
          then
            echo "We are logging an extremely large data"
            exit 1
          fi

  verify_data_location_routing_table:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    name: Verify data location and Routing Table
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        include:
          - os: ubuntu-latest
            node_data_path: /home/runner/.local/share/safe/node
            safe_path: /home/runner/.local/share/safe
          - os: windows-latest
            node_data_path: C:\\Users\\runneradmin\\AppData\\Roaming\\safe\\node
            safe_path: C:\\Users\\runneradmin\\AppData\\Roaming\\safe
          - os: macos-latest
            node_data_path: /Users/runner/Library/Application Support/safe/node
            safe_path: /Users/runner/Library/Application Support/safe
    steps:
      - uses: actions/checkout@v4

      - uses: dtolnay/rust-toolchain@stable

      - uses: Swatinem/rust-cache@v2

      - name: Build binaries
        run: cargo build --release --features local-discovery --bin safenode --bin faucet
        timeout-minutes: 30

      - name: Build data location and routing table tests
        run: cargo test --release -p sn_node --features=local-discovery --test verify_data_location --test verify_routing_table --no-run
        env:
          # only set the target dir for windows to bypass the linker issue.
          # happens if we build the node manager via testnet action
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 30

      - name: Start a local network
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: start
          interval: 2000
          node-path: target/release/safenode
          faucet-path: target/release/faucet
          platform: ${{ matrix.os }}
          build: true

      - name: Check SAFE_PEERS was set
        shell: bash
        run: |
          if [[ -z "$SAFE_PEERS" ]]; then
            echo "The SAFE_PEERS variable has not been set"
            exit 1
          else
            echo "SAFE_PEERS has been set to $SAFE_PEERS"
          fi

      - name: Verify the routing tables of the nodes
        run: cargo test --release -p sn_node --features="local-discovery" --test verify_routing_table -- --nocapture
        env:
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 5

      - name: Verify the location of the data on the network
        run: cargo test --release -p sn_node --features="local-discovery" --test verify_data_location -- --nocapture
        env:
          CHURN_COUNT: 6
          SN_LOG: "all"
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 25

      - name: Verify the routing tables of the nodes
        run: cargo test --release -p sn_node --features="local-discovery" --test verify_routing_table -- --nocapture
        env:
          CARGO_TARGET_DIR: ${{ matrix.os == 'windows-latest' && './test-target' || '.' }}
        timeout-minutes: 5

      - name: Stop the local network and upload logs
        if: always()
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: stop
          log_file_prefix: safe_test_logs_data_location
          platform: ${{ matrix.os }}

      - name: Verify restart of nodes using rg
        shell: bash
        timeout-minutes: 1
        # get the counts, then the specific line, and then the digit count only
        # then check we have an expected level of restarts
        # TODO: make this use an env var, or relate to testnet size
        run: |
          restart_count=$(rg "Node is restarting in" "${{ matrix.node_data_path }}" -c --stats | \
            rg "(\d+) matches" | rg "\d+" -o)
          echo "Restart $restart_count nodes"
          peer_removed=$(rg "PeerRemovedFromRoutingTable" "${{ matrix.node_data_path }}" -c --stats | \
            rg "(\d+) matches" | rg "\d+" -o)
          echo "PeerRemovedFromRoutingTable $peer_removed times"
          if [ $peer_removed -lt $restart_count ]; then
            echo "PeerRemovedFromRoutingTable times of: $peer_removed is less than the restart count of: $restart_count"
            exit 1
          fi
          node_count=$(ls "${{ matrix.node_data_path }}" | wc -l)
          echo "Node dir count is $node_count"

      # Only error out after uploading the logs
      - name: Don't log raw data
        if: matrix.os != 'windows-latest' # causes error
        shell: bash
        timeout-minutes: 10
        run: |
          if ! rg '^' "${{ matrix.safe_path }}"/*/*/logs | awk 'length($0) > 15000 { print; exit 1 }'
          then
            echo "We are logging an extremely large data"
            exit 1
          fi

  large_file_upload_test:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    name: Large file upload
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2

      - name: install ripgrep
        shell: bash
        run: sudo apt-get install -y ripgrep

      - name: Check the available space
        run: |
          df
          echo "Home dir:"
          du -sh /home/runner/
          echo "Home subdirs:"
          du -sh /home/runner/*/
          echo "PWD:"
          du -sh .
          echo "PWD subdirs:"
          du -sh */

      - name: Download material, 1.6G
        shell: bash
        run: |
          wget https://releases.ubuntu.com/16.04/ubuntu-16.04.7-desktop-amd64.iso
          ls -l

      - name: Build binaries
        run: cargo build --release --bin safenode --bin safe --bin faucet
        timeout-minutes: 30

      - name: Start a local network
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: start
          interval: 2000
          node-path: target/release/safenode
          faucet-path: target/release/faucet
          platform: ubuntu-latest
          build: true

      # The test currently fails because the GH runner runs out of disk space. So we clear out the target dir here.
      # Might be related to additional deps used in the codebase.
      - name: Move built binaries and clear out target dir
        shell: bash
        run: |
          mv target/release/faucet ~/faucet
          mv target/release/safe ~/safe
          rm -rf target

      - name: Check SAFE_PEERS was set
        shell: bash
        run: |
          if [[ -z "$SAFE_PEERS" ]]; then
            echo "The SAFE_PEERS variable has not been set"
            exit 1
          else
            echo "SAFE_PEERS has been set to $SAFE_PEERS"
          fi

      - name: Check the available space post download
        run: |
          df
          echo "Home dir:"
          du -sh /home/runner/
          echo "Home subdirs:"
          du -sh /home/runner/*/
          echo "PWD:"
          du -sh .
          echo "PWD subdirs:"
          du -sh */

      - name: Create and fund a wallet to pay for files storage
        run: |
          ~/faucet --log-output-dest=data-dir send 100000000 $(~/safe --log-output-dest=data-dir wallet address | tail -n 1) | tail -n 1 > transfer_hex
          ~/safe --log-output-dest=data-dir wallet receive --file transfer_hex
        env:
          SN_LOG: "all"
        timeout-minutes: 5

      - name: Start a client to upload
        run: ~/safe --log-output-dest=data-dir files upload "ubuntu-16.04.7-desktop-amd64.iso" --retry-strategy quick
        env:
          SN_LOG: "all"
        timeout-minutes: 30

      - name: Stop the local network and upload logs
        if: always()
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: stop
          platform: ubuntu-latest
          log_file_prefix: safe_test_logs_large_file_upload
          build: true

      - name: Check the home dir leftover space
        run: |
          df
          du -sh /home/runner/

      - name: Confirm the cash_notes files
        run: |
          pwd
          ls $CLIENT_DATA_PATH/ -l
          ls $CLIENT_DATA_PATH/wallet -l
          ls $CLIENT_DATA_PATH/wallet/cash_notes -l
          ls $CLIENT_DATA_PATH/logs -l
        env:
          CLIENT_DATA_PATH: /home/runner/.local/share/safe/client
        timeout-minutes: 10

  replication_bench_with_heavy_upload:
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    name: Replication bench with heavy upload
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      - uses: Swatinem/rust-cache@v2

      - name: install ripgrep
        shell: bash
        run: sudo apt-get install -y ripgrep

      - name: Download materials to create two 300MB test_files to be uploaded by client
        shell: bash
        run: |
          mkdir test_data_1
          cd test_data_1
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/Qi930/safe-qiWithListeners-x86_64.tar.gz
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/Qi930/safenode-qiWithListeners-x86_64.tar.gz
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/Qi930/safenode_rpc_client-qiWithListeners-x86_64.tar.gz
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/QiSubdivisionBranch/faucet-qilesssubs-x86_64.tar.gz
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/QiSubdivisionBranch/safe-qilesssubs-x86_64.tar.gz
          ls -l
          cd ..
          tar -cvzf test_data_1.tar.gz test_data_1
          mkdir test_data_2
          cd test_data_2
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/QiSubdivisionBranch/safenode-qilesssubs-x86_64.tar.gz
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/QiSubdivisionBranch/safenode_rpc_client-qilesssubs-x86_64.tar.gz
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/RemoveArtificalReplPush/faucet-DebugMem-x86_64.tar.gz
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/RemoveArtificalReplPush/safe-DebugMem-x86_64.tar.gz
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/RemoveArtificalReplPush/safenode-DebugMem-x86_64.tar.gz
          ls -l
          cd ..
          tar -cvzf test_data_2.tar.gz test_data_2
          ls -l
          mkdir test_data_3
          cd test_data_3
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/RemoveArtificalReplPush/safenode_rpc_client-DebugMem-x86_64.tar.gz
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/RemoveArtificalReplPush2/faucet-DebugMem-x86_64.tar.gz
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/RemoveArtificalReplPush2/safe-DebugMem-x86_64.tar.gz
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/RemoveArtificalReplPush2/safenode-DebugMem-x86_64.tar.gz
          wget https://sn-node.s3.eu-west-2.amazonaws.com/joshuef/RemoveArtificalReplPush2/safenode_rpc_client-DebugMem-x86_64.tar.gz
          ls -l
          cd ..
          tar -cvzf test_data_3.tar.gz test_data_3
          ls -l
          df

      - name: Build binaries
        run: cargo build --release --bin safenode --bin safe --bin faucet
        timeout-minutes: 30

      - name: Start a local network
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: start
          interval: 2000
          node-path: target/release/safenode
          faucet-path: target/release/faucet
          platform: ubuntu-latest
          build: true

      - name: Check SAFE_PEERS was set
        shell: bash
        run: |
          if [[ -z "$SAFE_PEERS" ]]; then
            echo "The SAFE_PEERS variable has not been set"
            exit 1
          else
            echo "SAFE_PEERS has been set to $SAFE_PEERS"
          fi

      - name: Create and fund a wallet to pay for files storage
        run: |
          cargo run --bin faucet --release -- --log-output-dest=data-dir send 100000000 $(cargo run --bin safe --release -- --log-output-dest=data-dir wallet address | tail -n 1) | tail -n 1 > transfer_hex
          cargo run --bin safe --release -- --log-output-dest=data-dir wallet receive --file transfer_hex
        env:
          SN_LOG: "all"
        timeout-minutes: 5

      - name: Start a client to upload first file
        run: cargo run --bin safe --release -- --log-output-dest=data-dir files upload "./test_data_1.tar.gz" --retry-strategy quick
        env:
          SN_LOG: "all"
        timeout-minutes: 5

      - name: Ensure no leftover cash_notes and payment files
        run: |
          expected_cash_notes_files="1"
          expected_payment_files="0"
          pwd
          ls $CLIENT_DATA_PATH/ -l
          ls $CLIENT_DATA_PATH/wallet -l
          ls $CLIENT_DATA_PATH/wallet/cash_notes -l
          cash_note_files=$(ls $CLIENT_DATA_PATH/wallet/cash_notes | wc -l)
          echo "Find $cash_note_files cash_note files"
          if [ $expected_cash_notes_files -lt $cash_note_files ]; then
            echo "Got too many cash_note files leftover: $cash_note_files"
            exit 1
          fi
          ls $CLIENT_DATA_PATH/wallet/payments -l
          payment_files=$(ls $CLIENT_DATA_PATH/wallet/payments | wc -l)
          if [ $expected_payment_files -lt $payment_files ]; then
            echo "Got too many payment files leftover: $payment_files"
            exit 1
          fi
        env:
          CLIENT_DATA_PATH: /home/runner/.local/share/safe/client
        timeout-minutes: 10

      - name: Wait for certain period
        run: sleep 300
        timeout-minutes: 6

      - name: Use same client to upload second file
        run: cargo run --bin safe --release -- --log-output-dest=data-dir files upload "./test_data_2.tar.gz" --retry-strategy quick
        env:
          SN_LOG: "all"
        timeout-minutes: 10

      - name: Ensure no leftover cash_notes and payment files
        run: |
          expected_cash_notes_files="1"
          expected_payment_files="0"
          pwd
          ls $CLIENT_DATA_PATH/ -l
          ls $CLIENT_DATA_PATH/wallet -l
          ls $CLIENT_DATA_PATH/wallet/cash_notes -l
          cash_note_files=$(find $CLIENT_DATA_PATH/wallet/cash_notes -type f | wc -l)
          if (( $(echo "$cash_note_files > $expected_cash_notes_files" | bc -l) )); then
            echo "Got too many cash_note files leftover: $cash_note_files"
            exit 1
          fi
          ls $CLIENT_DATA_PATH/wallet/payments -l
          payment_files=$(find $CLIENT_DATA_PATH/wallet/payments -type f | wc -l)
          if (( $(echo "$payment_files > $expected_payment_files" | bc -l) )); then
            echo "Got too many payment files leftover: $payment_files"
            exit 1
          fi
        env:
          CLIENT_DATA_PATH: /home/runner/.local/share/safe/client
        timeout-minutes: 10

      - name: Wait for certain period
        run: sleep 300
        timeout-minutes: 6

      # Start a different client to avoid local wallet slow down with more payments handled.
      - name: Start a different client
        run: |
          pwd
          mv $CLIENT_DATA_PATH $SAFE_DATA_PATH/client_first
          ls -l $SAFE_DATA_PATH
          ls -l $SAFE_DATA_PATH/client_first
          mkdir $SAFE_DATA_PATH/client
          ls -l $SAFE_DATA_PATH
          mv $SAFE_DATA_PATH/client_first/logs $CLIENT_DATA_PATH/logs
          ls -l $CLIENT_DATA_PATH
          cargo run --bin faucet --release -- --log-output-dest=data-dir send 100000000 $(cargo run --bin safe --release -- --log-output-dest=data-dir wallet address | tail -n 1) | tail -n 1 > transfer_hex
          cargo run --bin safe --release -- --log-output-dest=data-dir wallet receive --file transfer_hex
        env:
          SN_LOG: "all"
          SAFE_DATA_PATH: /home/runner/.local/share/safe
          CLIENT_DATA_PATH: /home/runner/.local/share/safe/client
        timeout-minutes: 25

      - name: Use second client to upload third file
        run: cargo run --bin safe --release -- --log-output-dest=data-dir files upload "./test_data_3.tar.gz" --retry-strategy quick
        env:
          SN_LOG: "all"
        timeout-minutes: 10

      - name: Ensure no leftover cash_notes and payment files
        run: |
          expected_cash_notes_files="1"
          expected_payment_files="0"
          pwd
          ls $CLIENT_DATA_PATH/ -l
          ls $CLIENT_DATA_PATH/wallet -l
          ls $CLIENT_DATA_PATH/wallet/cash_notes -l
          cash_note_files=$(ls $CLIENT_DATA_PATH/wallet/cash_notes | wc -l)
          echo "Find $cash_note_files cash_note files"
          if [ $expected_cash_notes_files -lt $cash_note_files ]; then
            echo "Got too many cash_note files leftover: $cash_note_files"
            exit 1
          fi
          ls $CLIENT_DATA_PATH/wallet/payments -l
          payment_files=$(ls $CLIENT_DATA_PATH/wallet/payments | wc -l)
          if [ $expected_payment_files -lt $payment_files ]; then
            echo "Got too many payment files leftover: $payment_files"
            exit 1
          fi
        env:
          CLIENT_DATA_PATH: /home/runner/.local/share/safe/client
        timeout-minutes: 10

      - name: Stop the local network and upload logs
        if: always()
        uses: maidsafe/sn-local-testnet-action@main
        with:
          action: stop
          log_file_prefix: safe_test_logs_heavy_replicate_bench
          platform: ubuntu-latest