Merge #241: Replaced mutagen with cargo-mutants

43b48a5 Replaced mutagen with cargo-mutants (HrushikeshAnandSarangi)

Pull request description:

  Replaced mutagen with cargo-mutants #238 
  Overview: 
  - removed all dependencies of `mutagen`.
  - Integrated `cargo mutants` and a workflow for raising issues weekly for top 10 mutations found.
  Please let me know if any additional changes are required.


ACKs for top commit:
  tcharding:
    ACK 43b48a5
  apoelstra:
    ACK 43b48a5; successfully ran local tests


Tree-SHA512: 832c71cfc8b1831f57bb21ac583055604507b1b4825d988a6bcf707c09cd1cea3ad21d8a96a5f25e5657d4a8d03bfdc8250cf4c16c44a9a1dca3bd756f2cf521

Author: apoelstra

.cargo/mutants.toml

@@ -0,0 +1,7 @@
+additional_cargo_args = ["--all-features"]
+examine_globs = ["src/**/*.rs"]
+exclude_globs = []
+exclude_re = [
+    #benchmarks
+    "benches::",
+]

.github/workflows/cron-weekly-cargo-mutants.yml

@@ -0,0 +1,52 @@
+name: Weekly cargo-mutants
+on:
+  schedule:
+    - cron: "0 0 * * 0" # runs weekly on Sunday at 00:00
+  workflow_dispatch: # allows manual triggering
+permissions: {}
+jobs:
+  cargo-mutants:
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+      issues: write
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+      - uses: taiki-e/install-action@81ee1d48d9194cdcab880cbdc7d36e87d39874cb # v2.62.45
+        with:
+          tool: cargo-mutants
+      - name: Generate Cargo.lock
+        run: cargo generate-lockfile
+      - run: cargo mutants --in-place --no-shuffle
+      - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        if: always()
+        with:
+          name: mutants.out
+          path: mutants.out
+      - name: Check for new mutants
+        if: always()
+        run: |
+          if [ -s mutants.out/missed.txt ]; then
+            echo "New missed mutants found"
+            MUTANTS_VERSION=$(cargo mutants --version)
+            gh issue create \
+            --title "New Mutants Found" \
+            --body "$(cat <<EOF
+          Displaying up to the first 10 mutants:
+          \`\`\`
+          $(head -n 10 mutants.out/missed.txt)
+          \`\`\`
+          Running cargo mutants version: ${MUTANTS_VERSION}
+          For the complete list, please check the [mutants.out artifact](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}).
+          EOF
+          )"
+            echo "create_issue=true" >> $GITHUB_ENV
+          else
+            echo "No new mutants found"
+            echo "create_issue=false" >> $GITHUB_ENV
+          fi
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      

.gitignore

@@ -1,6 +1,8 @@
 **/target
 *.o
 /Cargo.lock
+**/mutants.out
+**/mutants.out.old
 
 /embedded/no-allocator/Cargo.lock
 /embedded/no-allocator/.cargo

Cargo.toml

@@ -16,8 +16,5 @@ default = ["std"]
 std = ["alloc"]
 alloc = []
 
-[target.'cfg(mutate)'.dev-dependencies]
-mutagen = { git = "https://github.com/llogiq/mutagen" }
-
 [lints.rust]
-unexpected_cfgs = { level = "deny", check-cfg = [ 'cfg(bench)', 'cfg(kani)', 'cfg(mutate)' ] }
+unexpected_cfgs = { level = "deny", check-cfg = [ 'cfg(bench)', 'cfg(kani)' ] }

src/primitives/gf32.rs

@@ -15,9 +15,6 @@
 use core::convert::{Infallible, TryFrom};
 use core::{fmt, num};
 
-#[cfg(all(test, mutate))]
-use mutagen::mutate;
-
 use super::{Bech32Field, Field};
 use crate::error::write_err;