Also allow to increase take, add tests

.github/workflows/check-rust.yml

@@ -1,34 +1,21 @@
-name: Rust build, benchmarks, and tests
+name: CI
 
 concurrency:
   group: ci-${{ github.ref }}
   cancel-in-progress: true
 
-##
+
 on:
-  ##
-  # Run automatically for any push that changes Rust file(s)
+  ## Run automatically for all PRs against main, regardless of what the changes are
+  ## to be safe and so we can more easily force re-run the CI when github is being
+  ## weird by using a blank commit
   push:
-    branches:
-      - main
-      - $default-branch
-
-    paths:
-      - "**.rs"
-      - "**/Cargo.toml"
-      - "**/Cargo.lock"
+    branches: [main, development, staging]
 
   ##
   # Run automatically for PRs against default/main branch if Rust files change
   pull_request:
-    branches:
-      - main
-      - $default-branch
-
-    paths:
-      - "**.rs"
-      - "**/Cargo.toml"
-      - "**/Cargo.lock"
+    branches: [main, development, staging]
 
   ## Allow running workflow manually from the Actions tab
   workflow_dispatch:
@@ -38,83 +25,309 @@ on:
         required: false
         default: ""
 
-##
 env:
   CARGO_TERM_COLOR: always
   VERBOSE: ${{ github.events.input.verbose }}
 
-##
-#
 jobs:
-  check:
-    name: Tests targeting ${{ matrix.rust-target }} for OS ${{ matrix.os }}
+  # runs cargo fmt
+  cargo-fmt:
+    name: cargo fmt
     runs-on: SubtensorCI
-
-    ##
-    # Define multiple targets for builds and tests
     strategy:
       matrix:
         rust-branch:
-          - nightly-2023-01-18
-
+          - nightly-2024-03-05
         rust-target:
           - x86_64-unknown-linux-gnu
           # - x86_64-apple-darwin
+        os:
+          - ubuntu-latest
+          # - macos-latest
+        include:
+          - os: ubuntu-latest
+          # - os: macos-latest
+    env:
+      RELEASE_NAME: development
+      # RUSTFLAGS: -A warnings
+      RUSTV: ${{ matrix.rust-branch }}
+      RUST_BACKTRACE: full
+      RUST_BIN_DIR: target/${{ matrix.rust-target }}
+      SKIP_WASM_BUILD: 1
+      TARGET: ${{ matrix.rust-target }}
+    steps:
+      - name: Check-out repository under $GITHUB_WORKSPACE
+        uses: actions/checkout@v2
 
+      - name: Install dependencies
+        run: sudo apt-get update && sudo apt-get install -y build-essential
+
+      - name: Install Rust ${{ matrix.rust-branch }}
+        uses: actions-rs/toolchain@v1.0.6
+        with:
+          toolchain: ${{ matrix.rust-branch }}
+          components: rustfmt
+          profile: minimal
+
+      - name: cargo fmt
+        run: cargo fmt --check --all
+
+  # runs cargo check --workspace
+  cargo-check:
+    name: cargo check
+    runs-on: SubtensorCI
+    strategy:
+      matrix:
+        rust-branch:
+          - nightly-2024-03-05
+        rust-target:
+          - x86_64-unknown-linux-gnu
+          # - x86_64-apple-darwin
         os:
           - ubuntu-latest
           # - macos-latest
+        include:
+          - os: ubuntu-latest
+          # - os: macos-latest
+    env:
+      RELEASE_NAME: development
+      # RUSTFLAGS: -A warnings
+      RUSTV: ${{ matrix.rust-branch }}
+      RUST_BACKTRACE: full
+      RUST_BIN_DIR: target/${{ matrix.rust-target }}
+      SKIP_WASM_BUILD: 1
+      TARGET: ${{ matrix.rust-target }}
+    steps:
+      - name: Check-out repository under $GITHUB_WORKSPACE
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update &&
+          sudo apt-get install -y clang curl libssl-dev llvm libudev-dev protobuf-compiler
+
+      - name: Install Rust ${{ matrix.rust-branch }}
+        uses: actions-rs/toolchain@v1.0.6
+        with:
+          toolchain: ${{ matrix.rust-branch }}
+          components: rustfmt, clippy
+          profile: minimal
 
+      - name: Utilize Shared Rust Cache
+        uses: Swatinem/rust-cache@v2.2.1
+        with:
+          key: ${{ matrix.os }}-${{ env.RUST_BIN_DIR }}
+
+      - name: cargo check --workspace
+        run: cargo check --workspace
+
+  # runs cargo test --workspace
+  cargo-test:
+    name: cargo test
+    runs-on: SubtensorCI
+    strategy:
+      matrix:
+        rust-branch:
+          - nightly-2024-03-05
+        rust-target:
+          - x86_64-unknown-linux-gnu
+          # - x86_64-apple-darwin
+        os:
+          - ubuntu-latest
+          # - macos-latest
         include:
           - os: ubuntu-latest
           # - os: macos-latest
+    env:
+      RELEASE_NAME: development
+      # RUSTFLAGS: -A warnings
+      RUSTV: ${{ matrix.rust-branch }}
+      RUST_BACKTRACE: full
+      RUST_BIN_DIR: target/${{ matrix.rust-target }}
+      SKIP_WASM_BUILD: 1
+      TARGET: ${{ matrix.rust-target }}
+    steps:
+      - name: Check-out repository under $GITHUB_WORKSPACE
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update &&
+          sudo apt-get install -y clang curl libssl-dev llvm libudev-dev protobuf-compiler
+
+      - name: Install Rust ${{ matrix.rust-branch }}
+        uses: actions-rs/toolchain@v1.0.6
+        with:
+          toolchain: ${{ matrix.rust-branch }}
+          components: rustfmt, clippy
+          profile: minimal
+
+      - name: Utilize Rust shared cached
+        uses: Swatinem/rust-cache@v2.2.1
+        with:
+          key: ${{ matrix.os }}-${{ env.RUST_BIN_DIR }}
 
-    ##
+      - name: cargo test --workspace
+        run: cargo test --workspace
+
+  # runs cargo test --workspace --features=runtime-benchmarks
+  cargo-test-benchmarks:
+    name: cargo test w/benchmarks
+    runs-on: SubtensorCI
+    strategy:
+      matrix:
+        rust-branch:
+          - nightly-2024-03-05
+        rust-target:
+          - x86_64-unknown-linux-gnu
+          # - x86_64-apple-darwin
+        os:
+          - ubuntu-latest
+          # - macos-latest
+        include:
+          - os: ubuntu-latest
+          # - os: macos-latest
     env:
       RELEASE_NAME: development
-      RUSTFLAGS: -A warnings
+      # RUSTFLAGS: -A warnings
       RUSTV: ${{ matrix.rust-branch }}
       RUST_BACKTRACE: full
       RUST_BIN_DIR: target/${{ matrix.rust-target }}
       SKIP_WASM_BUILD: 1
       TARGET: ${{ matrix.rust-target }}
+    steps:
+      - name: Check-out repository under $GITHUB_WORKSPACE
+        uses: actions/checkout@v2
 
-    ##
+      - name: Install dependencies
+        run: |
+          sudo apt-get update &&
+          sudo apt-get install -y clang curl libssl-dev llvm libudev-dev protobuf-compiler
+
+      - name: Install Rust ${{ matrix.rust-branch }}
+        uses: actions-rs/toolchain@v1.0.6
+        with:
+          toolchain: ${{ matrix.rust-branch }}
+          components: rustfmt, clippy
+          profile: minimal
+
+      - name: Utilize Rust shared cached
+        uses: Swatinem/rust-cache@v2.2.1
+        with:
+          key: ${{ matrix.os }}-${{ env.RUST_BIN_DIR }}
+
+      - name: cargo test --workspace --features=runtime-benchmarks
+        run: cargo test --workspace --features=runtime-benchmarks
+
+  # runs cargo clippy
+  clippy:
+    name: cargo clippy
+    runs-on: SubtensorCI
+    strategy:
+      matrix:
+        rust-branch:
+          - nightly-2024-03-05
+        rust-target:
+          - x86_64-unknown-linux-gnu
+          # - x86_64-apple-darwin
+        os:
+          - ubuntu-latest
+          # - macos-latest
+        include:
+          - os: ubuntu-latest
+          # - os: macos-latest
+    env:
+      RELEASE_NAME: development
+      # RUSTFLAGS: -A warnings
+      RUSTV: ${{ matrix.rust-branch }}
+      RUST_BACKTRACE: full
+      RUST_BIN_DIR: target/${{ matrix.rust-target }}
+      SKIP_WASM_BUILD: 1
+      TARGET: ${{ matrix.rust-target }}
     steps:
       - name: Check-out repository under $GITHUB_WORKSPACE
         uses: actions/checkout@v2
 
       - name: Install dependencies
         run: |
           sudo apt-get update &&
-          sudo apt-get install -y git clang curl libssl-dev llvm libudev-dev protobuf-compiler
+          sudo apt-get install -y clang curl libssl-dev llvm libudev-dev protobuf-compiler
 
       - name: Install Rust ${{ matrix.rust-branch }}
         uses: actions-rs/toolchain@v1.0.6
         with:
           toolchain: ${{ matrix.rust-branch }}
+          components: rustfmt, clippy
           profile: minimal
 
       - name: Utilize Rust shared cached
         uses: Swatinem/rust-cache@v2.2.1
         with:
           key: ${{ matrix.os }}-${{ env.RUST_BIN_DIR }}
 
-      - name: cargo fmt
-        run: cargo fmt --check
+      - name: cargo clippy
+        run: |
+          cargo clippy -- -D clippy::panic \
+                          -D clippy::todo \
+                          -D clippy::unimplemented
+# -D clippy::indexing_slicing \
+# -D clippy::unwrap_used \
 
-      ## TODO: maybe use `if` conditions in tests to target `--package <name>`
-      - name: cargo test
-        # timeout-minutes: 30
-        run: cargo test --workspace
+  # ensures cargo fix has no trivial changes that can be applied
+  cargo-fix:
+    name: cargo fix
+    runs-on: SubtensorCI
+    strategy:
+      matrix:
+        rust-branch:
+          - nightly-2024-03-05
+        rust-target:
+          - x86_64-unknown-linux-gnu
+          # - x86_64-apple-darwin
+        os:
+          - ubuntu-latest
+          # - macos-latest
+        include:
+          - os: ubuntu-latest
+          # - os: macos-latest
+    env:
+      RELEASE_NAME: development
+      # RUSTFLAGS: -A warnings
+      RUSTV: ${{ matrix.rust-branch }}
+      RUST_BACKTRACE: full
+      RUST_BIN_DIR: target/${{ matrix.rust-target }}
+      SKIP_WASM_BUILD: 1
+      TARGET: ${{ matrix.rust-target }}
+    steps:
+      - name: Check-out repository under $GITHUB_WORKSPACE
+        uses: actions/checkout@v2
 
-      - name: Run benchmarks
-        # timeout-minutes: 30
+      - name: Install dependencies
         run: |
-          pushd node &&
-          cargo build --features=runtime-benchmarks --release
+          sudo apt-get update &&
+          sudo apt-get install -y clang curl libssl-dev llvm libudev-dev protobuf-compiler
 
-      - name: Build executable
-        # timeout-minutes: 30
-        run: cargo build --release
+      - name: Install Rust ${{ matrix.rust-branch }}
+        uses: actions-rs/toolchain@v1.0.6
+        with:
+          toolchain: ${{ matrix.rust-branch }}
+          components: rustfmt, clippy
+          profile: minimal
+
+      - name: Utilize Rust shared cached
+        uses: Swatinem/rust-cache@v2.2.1
+        with:
+          key: ${{ matrix.os }}-${{ env.RUST_BIN_DIR }}
+
+      - name: cargo fix --workspace
+        run: |
+          # Run cargo fix on the project
+          cargo fix --workspace
 
+          # Check for local git changes
+          if ! git diff --exit-code; then
+              echo "There are local changes after running 'cargo fix --workspace' ❌"
+              exit 1
+          else
+              echo "No changes detected after running 'cargo fix --workspace' ✅"
+          fi

.gitignore

@@ -34,4 +34,7 @@ specs/*.json
 *.orig
 
 # VSCode configuration
-.vscode
+.vscode
+
+alice.log
+bob.log