New clippy script (#2400)

* claude.ai

* aaa

* ps1

* set -e

* nightly

* nightly default

* components?

.github/workflows/windows-tester-prepare/action.yml

@@ -6,7 +6,9 @@ runs:
     - uses: actions-rs/toolchain@v1
       with:
         profile: minimal
-        toolchain: stable
+        toolchain: nightly
+        components: llvm-tools, clippy, rustfmt
+        default: true
     - uses: actions/checkout@v3
     - uses: Swatinem/rust-cache@v2
     - name: Build docs

Cargo.toml

@@ -23,6 +23,7 @@ default-members = [
     "libafl_derive",
     "libafl_targets",
 ]
+
 exclude = [
     "bindings",
     "fuzzers",
@@ -32,6 +33,7 @@ exclude = [
     "utils/desyscall",
     "utils/multi_machine_generator",
     "scripts",
+    # additional crates
     "libafl_concolic/symcc_runtime",
     "libafl_concolic/symcc_libafl",
     "libafl_frida",

scripts/clippy.ps1

@@ -1,14 +1,83 @@
-cargo clippy --all --all-features --exclude libafl_qemu --no-deps --tests --benches --examples -- `
+# Clippy Runner Script for PowerShell (Windows)
-   -D clippy::all `
+
-   -D clippy::pedantic `
+$ErrorActionPreference = "Stop"  # This is similar to set -e in Bash
-   -W clippy::similar_names `
+$ScriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
-   -A clippy::type_repetition_in_bounds `
+Set-Location (Split-Path -Parent $ScriptDir)
-   -A clippy::missing-errors-doc `
+
-   -A clippy::cast-possible-truncation `
+# Function to run Clippy on a single directory
-   -A clippy::used-underscore-binding `
+function Run-Clippy {
-   -A clippy::ptr-as-ptr `
+    param (
-   -A clippy::missing-panics-doc `
+        [string]$dir
-   -A clippy::missing-docs-in-private-items `
+    )
-   -A clippy::unseparated-literal-suffix `
+    Write-Host "Running Clippy on $dir"
-   -A clippy::module-name-repetitions `
+    Push-Location $dir
-   -A clippy::unreadable-literal
+    
+    try {
+        $env:RUST_BACKTRACE = "full"
+        cargo +nightly clippy --all --all-features --no-deps --tests --examples --benches -- -Z macro-backtrace `
+            -D clippy::all `
+            -D clippy::pedantic `
+            -W clippy::similar_names `
+            -A clippy::type_repetition_in_bounds `
+            -A clippy::missing-errors-doc `
+            -A clippy::cast-possible-truncation `
+            -A clippy::used-underscore-binding `
+            -A clippy::ptr-as-ptr `
+            -A clippy::missing-panics-doc `
+            -A clippy::missing-docs-in-private-items `
+            -A clippy::unseparated-literal-suffix `
+            -A clippy::module-name-repetitions `
+            -A clippy::unreadable-literal
+    }
+    finally {
+        Pop-Location
+    }
+}
+
+# Define projects for Windows
+$AllProjects = @(
+    "libafl_frida",
+    "libafl_libfuzzer",
+    "libafl_nyx",
+    "libafl_tinyinst"
+)
+
+# Check if arguments were provided
+if ($args.Count -eq 0) {
+    # No arguments provided, run on all projects
+    $Projects = $AllProjects
+}
+else {
+    # Arguments provided, split the input string into an array
+    $Projects = $args[0] -split ','
+}
+
+# First run it on all
+$env:RUST_BACKTRACE = "full"
+cargo +nightly clippy --all --all-features --no-deps --tests --examples --benches -- -Z macro-backtrace `
+    -D clippy::all `
+    -D clippy::pedantic `
+    -W clippy::similar_names `
+    -A clippy::type_repetition_in_bounds `
+    -A clippy::missing-errors-doc `
+    -A clippy::cast-possible-truncation `
+    -A clippy::used-underscore-binding `
+    -A clippy::ptr-as-ptr `
+    -A clippy::missing-panics-doc `
+    -A clippy::missing-docs-in-private-items `
+    -A clippy::unseparated-literal-suffix `
+    -A clippy::module-name-repetitions `
+    -A clippy::unreadable-literal
+
+# Loop through each project and run Clippy
+foreach ($project in $Projects) {
+    $project = $project.Trim()
+    if (Test-Path $project -PathType Container) {
+        Run-Clippy $project
+    }
+    else {
+        Write-Host "Warning: Directory $project does not exist. Skipping."
+    }
+}
+
+Write-Host "Clippy run completed for all specified projects."

scripts/clippy.sh

@@ -1,9 +1,57 @@
 #!/bin/bash
-SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" &>/dev/null && pwd)"
 cd "$SCRIPT_DIR/.." || exit 1
 
 set -e
+# Function to run Clippy on a single directory
+run_clippy() {
+   local dir="$1"
+   echo "Running Clippy on $dir"
+   pushd "$dir" || return 1
 
+   RUST_BACKTRACE=full cargo +nightly clippy --all --all-features --no-deps --tests --examples --benches -- -Z macro-backtrace \
+      -D clippy::all \
+      -D clippy::pedantic \
+      -W clippy::similar_names \
+      -A clippy::type_repetition_in_bounds \
+      -A clippy::missing-errors-doc \
+      -A clippy::cast-possible-truncation \
+      -A clippy::used-underscore-binding \
+      -A clippy::ptr-as-ptr \
+      -A clippy::missing-panics-doc \
+      -A clippy::missing-docs-in-private-items \
+      -A clippy::unseparated-literal-suffix \
+      -A clippy::module-name-repetitions \
+      -A clippy::unreadable-literal
+
+   popd || return 1
+}
+
+# Define projects based on the operating system
+if [[ "$OSTYPE" == "linux-gnu"* ]]; then
+   ALL_PROJECTS=(
+      "libafl_concolic/symcc_runtime"
+      "libafl_concolic/symcc_libafl"
+      "libafl_frida"
+      "libafl_libfuzzer"
+      "libafl_nyx"
+      "libafl_qemu"
+      "libafl_tinyinst"
+      "libafl_qemu/libafl_qemu_build"
+      "libafl_qemu/libafl_qemu_sys"
+   )
+fi
+
+if [ "$#" -eq 0 ]; then
+   # No arguments provided, run on all projects
+   PROJECTS=("${ALL_PROJECTS[@]}")
+else
+   # Arguments provided, split the input string into an array
+   IFS=',' read -ra PROJECTS <<<"$1"
+fi
+
+# First run it on all
 RUST_BACKTRACE=full cargo +nightly clippy --all --all-features --no-deps --tests --examples --benches -- -Z macro-backtrace \
    -D clippy::all \
    -D clippy::pedantic \
@@ -19,20 +67,16 @@ RUST_BACKTRACE=full cargo +nightly clippy --all --all-features --no-deps --tests
    -A clippy::module-name-repetitions \
    -A clippy::unreadable-literal
 
-if [[ "$OSTYPE" == "linux-gnu"* ]]; then
+
-  cd libafl_libfuzzer_runtime
+# Loop through each project and run Clippy
-  RUST_BACKTRACE=full cargo +nightly clippy --all --all-features --no-deps --tests --examples --benches -- -Z macro-backtrace \
+for project in "${PROJECTS[@]}"; do
-     -D clippy::all \
+   # Trim leading and trailing whitespace
-     -D clippy::pedantic \
+   project=$(echo "$project" | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
-     -W clippy::similar_names \
+   if [ -d "$project" ]; then
-     -A clippy::type_repetition_in_bounds \
+      run_clippy "$project"
-     -A clippy::missing-errors-doc \
+   else
-     -A clippy::cast-possible-truncation \
+      echo "Warning: Directory $project does not exist. Skipping."
-     -A clippy::used-underscore-binding \
+   fi
-     -A clippy::ptr-as-ptr \
+done
-     -A clippy::missing-panics-doc \
+
-     -A clippy::missing-docs-in-private-items \
+echo "Clippy run completed for all specified projects."
-     -A clippy::unseparated-literal-suffix \
-     -A clippy::module-name-repetitions \
-     -A clippy::unreadable-literal
-fi