tracking clang-tidy warnings (#17)

* tracking clang-tidy warnings

* attempting to update artifacts on PR

* testing CI artifact creation

* added selective artifacts to ci compile step

* extending conditional for artifacts

* added build modifier for CI step

Author: lmapii

.github/workflows/ci.yml

@@ -44,6 +44,9 @@ jobs:
     name: Compile ${{ matrix.tuple.build }}
     needs: [rustfmt, clippy]
     runs-on: ${{ matrix.tuple.os }}
+    env:
+      TARGET_DIR: ./target
+      RUST_BACKTRACE: 1 # Emit backtraces on panics.
     strategy:
       fail-fast: false
       matrix:
@@ -59,28 +62,30 @@ jobs:
         # alternatively matrix could be shared and specified via .json
         # see https://github.community/t/how-to-share-matrix-between-jobs/128595/8
         # ---
-          - { build: 'linux-x86_64-pinned',   os: 'ubuntu-22.04',   target: 'x86_64-unknown-linux-gnu',      cross: false, rust: 1.68.2 }
-          - { build: 'windows-x86_64-pinned', os: 'windows-2019',   target: 'x86_64-pc-windows-msvc',        cross: false, rust: 1.68.2 }
-          - { build: 'macos-x86_64-pinned',   os: 'macos-latest',   target: 'x86_64-apple-darwin',           cross: false, rust: 1.68.2 }
-          - { build: 'linux-x86_64',          os: 'ubuntu-latest',  target: 'x86_64-unknown-linux-gnu',      cross: false, rust: stable }
-          - { build: 'linux-i686',            os: 'ubuntu-latest',  target: 'i686-unknown-linux-gnu',        cross: true,  rust: stable }
-          - { build: 'linux-arm',             os: 'ubuntu-latest',  target: 'aarch64-unknown-linux-gnu',     cross: true,  rust: stable } # aarch64
-        # - { build: 'ubuntu-armv7',          os: 'ubuntu-latest',  target: 'armv7-unknown-linux-gnueabihf', cross: true,  rust: stable } # armv7
-        # - { build: 'ubuntu-armv6',          os: 'ubuntu-latest',  target: 'arm-unknown-linux-gnueabihf',   cross: true,  rust: stable } # armv6
-          - { build: 'macos-x86_64',          os: 'macos-latest',   target: 'x86_64-apple-darwin',           cross: false, rust: stable }
-        # - { build: 'macos-arm',             os: 'macos-latest',   target: 'aarch64-apple-darwin',          cross: true,  rust: stable } # arm (tier 2, not in cross)
-          - { build: 'windows-x86_64-msvc',   os: 'windows-latest', target: 'x86_64-pc-windows-msvc',        cross: false, rust: stable }
-          - { build: 'windows-i686-msvc',     os: 'windows-latest', target: 'i686-pc-windows-msvc',          cross: false, rust: stable }
-          - { build: 'windows-x86_64-mingw',  os: 'windows-latest', target: 'x86_64-pc-windows-gnu',         cross: false, rust: stable }
-        # - { build: 'windows-i686-mingw',    os: 'windows-latest', target: 'i686-pc-windows-gnu',           cross: false, rust: stable }
+          - { build: 'linux-x86_64-pinned',   os: 'ubuntu-22.04',   target: 'x86_64-unknown-linux-gnu',      cross: false, rust: 1.68.2, archive: true  }
+          - { build: 'windows-x86_64-pinned', os: 'windows-2019',   target: 'x86_64-pc-windows-msvc',        cross: false, rust: 1.68.2, archive: true  }
+          - { build: 'macos-x86_64-pinned',   os: 'macos-latest',   target: 'x86_64-apple-darwin',           cross: false, rust: 1.68.2, archive: true  }
+          - { build: 'linux-x86_64',          os: 'ubuntu-latest',  target: 'x86_64-unknown-linux-gnu',      cross: false, rust: stable, archive: false }
+          - { build: 'linux-i686',            os: 'ubuntu-latest',  target: 'i686-unknown-linux-gnu',        cross: true,  rust: stable, archive: false }
+          - { build: 'linux-arm',             os: 'ubuntu-latest',  target: 'aarch64-unknown-linux-gnu',     cross: true,  rust: stable, archive: false } # aarch64
+        # - { build: 'ubuntu-armv7',          os: 'ubuntu-latest',  target: 'armv7-unknown-linux-gnueabihf', cross: true,  rust: stable, archive: false } # armv7
+        # - { build: 'ubuntu-armv6',          os: 'ubuntu-latest',  target: 'arm-unknown-linux-gnueabihf',   cross: true,  rust: stable, archive: false } # armv6
+          - { build: 'macos-x86_64',          os: 'macos-latest',   target: 'x86_64-apple-darwin',           cross: false, rust: stable, archive: false }
+        # - { build: 'macos-arm',             os: 'macos-latest',   target: 'aarch64-apple-darwin',          cross: true,  rust: stable, archive: false } # arm (tier 2, not in cross)
+          - { build: 'windows-x86_64-msvc',   os: 'windows-latest', target: 'x86_64-pc-windows-msvc',        cross: false, rust: stable, archive: false }
+          - { build: 'windows-i686-msvc',     os: 'windows-latest', target: 'i686-pc-windows-msvc',          cross: false, rust: stable, archive: false }
+          - { build: 'windows-x86_64-mingw',  os: 'windows-latest', target: 'x86_64-pc-windows-gnu',         cross: false, rust: stable, archive: false }
+        # - { build: 'windows-i686-mingw',    os: 'windows-latest', target: 'i686-pc-windows-gnu',           cross: false, rust: stable, archive: false }
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
       # Rustup update can fail on windows since it tries to replace its binary. This is not really
       # needed anyhow. https://github.com/rust-lang/rustup/issues/3029
+
       - name: Disable rustup self-update
         shell: bash
         run: rustup set auto-self-update disable
+
       - name: Install toolchain
         uses: actions-rs/toolchain@v1
         with:
@@ -90,6 +95,7 @@ jobs:
           toolchain: ${{ matrix.tuple.rust }}
           override: true
           target: ${{ matrix.tuple.target }}
+
       - name: Check
         uses: actions-rs/cargo@v1
         with:
@@ -98,6 +104,43 @@ jobs:
           args: --verbose --target=${{ matrix.tuple.target }}
           use-cross: ${{ matrix.tuple.cross }}
 
+      - name: Build artifact
+        uses: actions-rs/cargo@v1
+        if: matrix.tuple.archive != false && github.event_name == 'pull_request'
+        with:
+          command: build
+          args: --release --target=${{ matrix.tuple.target }}
+          use-cross: ${{ matrix.tuple.cross }}
+        env:
+          CI_PKG_VERSION_PRE_RELEASE: --alpha
+          CI_PKG_VERSION_BUILD: ${{ github.run_number }}
+
+      - name: Archive
+        if: matrix.tuple.archive != false && github.event_name == 'pull_request'
+        shell: bash
+        run: |
+          staging="run-clang-tidy-build-${{github.run_number}}-${{ matrix.tuple.target }}"
+          mkdir -p "$staging"
+
+          cp {readme.md,LICENSE} "$staging/"
+
+          if [ "${{ matrix.tuple.os }}" = "windows-latest" ]; then
+            cp "target/${{ matrix.tuple.target }}/release/run-clang-tidy.exe" "$staging/"
+            7z a "$staging.zip" "$staging"
+            echo "ASSET=$staging.zip" >> $GITHUB_ENV
+          else
+            cp "target/${{ matrix.tuple.target }}/release/run-clang-tidy" "$staging/"
+            tar czf "$staging.tar.gz" "$staging"
+            echo "ASSET=$staging.tar.gz" >> $GITHUB_ENV
+          fi
+
+      - name: Archive artifacts
+        uses: actions/upload-artifact@v3
+        if: matrix.tuple.archive != false && github.event_name == 'pull_request'
+        with:
+          name: dist-${{github.run_number}}-${{ matrix.tuple.target }}
+          path: ${{ env.ASSET }}
+
   tests:
     name: Test ${{ matrix.os }}
     needs: [compile]
@@ -144,6 +187,6 @@ jobs:
           toolchain: ${{ matrix.toolchain }}
           override: true
 
-      - name: Test
+      - name: Run tests
         # using only one test thread to avoid race conditions on temporary files
         run: cargo test --verbose --no-fail-fast -- --test-threads 1

.gitignore

@@ -15,4 +15,5 @@ _notes.md
 artifacts
 docker
 
-_bld
+_bld
+.cargo/config.toml

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "run-clang-tidy"
-version = "0.1.8"
+version = "0.2.0"
 authors = ["Martin Lampacher <lmapii@gmail.com>"]
 description = """
 Cross platform CLI wrapper for executing clang-tidy based paths or globs specified

Cargo.toml

@@ -0,0 +1,24 @@
+fn main() {
+    let pre_release = if let Ok(pre_release) = std::env::var("CI_PKG_VERSION_PRE_RELEASE") {
+        "-".to_owned() + &pre_release
+    } else {
+        "".to_owned()
+    };
+
+    let build = if let Ok(build) = std::env::var("CI_PKG_VERSION_BUILD") {
+        "+".to_owned() + &build
+    } else {
+        "".to_owned()
+    };
+
+    // If we set CARGO_PKG_VERSION this way, then it will override the default value, which is
+    // taken from the `version` in Cargo.toml or from an override in .cargo/config.toml
+    let version_override = format!("{}{}{}", env!("CARGO_PKG_VERSION"), pre_release, build);
+    if !version_override.is_empty() {
+        println!("cargo:rustc-env=CARGO_PKG_VERSION={}", version_override);
+    }
+
+    println!("cargo:rerun-if-env-changed=CI_PKG_VERSION_PRE_RELEASE");
+    println!("cargo:rerun-if-env-changed=CI_PKG_VERSION_BUILD");
+    println!("cargo:rerun-if-changed=.cargo/config.toml");
+}

build.rs

@@ -41,6 +41,7 @@ Execute `run-clang-tidy --help` for more details, or `run-clang-tidy schema` for
   - [Speeding up the execution](#speeding-up-the-execution)
   - [Specifying an alternative tidy file and command](#specifying-an-alternative-tidy-file-and-command)
   - [Specifying an alternative build root](#specifying-an-alternative-build-root)
+  - [Suppressing warnings](#suppressing-warnings)
 - [Use-cases](#use-cases)
 - [Pitfalls](#pitfalls)
   - [Multiple `.clang-tidy` files](#multiple-clang-tidy-files)
@@ -300,6 +301,12 @@ The [build root](#the-build-root-and-compile_commandsjson) containing the compil
 
 Therefore the command-line option `--build-root` allows to specify the build directory when invoking this script, overriding, e.g., a default directory specified in the configuration `.json` file.
 
+## Suppressing warnings
+
+By default, warnings issued by `clang-tidy` are output on each run, unless the command-line option `--suppress-warnings` is used.
+
+> **Remark:** `clang-tidy` warnings do not affect the return code of `run-clang-tidy`, regardless of whether or not they are part of the output. Use your `.clang-tidy` file to transform warnings into errors in case the execution should fail, e.g., by specifying `WarningsAsErrors`.
+
 # Use-cases
 
 Due to the nature of this tool, i.e., the underlying `clang` tools, the use-cases are very similar when executing `clang-format`, for which a [dedicated wrapper](https://github.com/lmapii/run-clang-format) exists. Please refer to the matching section in the documentation of [`run-clang-format`](https://github.com/lmapii/run-clang-format#use-cases).

readme.md

@@ -4,7 +4,7 @@ mod handlers;
 mod logging;
 pub mod utils;
 
-use clap::{arg, crate_authors, crate_description, crate_name, crate_version};
+use clap::{arg, crate_authors, crate_description, crate_name, crate_version, Arg};
 #[allow(unused_imports)]
 use color_eyre::{eyre::eyre, eyre::WrapErr, Help};
 use schemars::{schema_for, JsonSchema};
@@ -69,6 +69,8 @@ pub struct Data {
     /// Command-line parameter for the number of jobs to use for executing clang-tidy
     /// If `None` then all available jobs should be used, else the specified number of jobs.
     pub jobs: Option<u8>,
+    /// Command-line option to suppress warnings issued by clang-tidy.
+    pub ignore_warn: bool,
 }
 
 pub struct Builder {
@@ -132,6 +134,12 @@ impl Builder {
                 arg!(-q --quiet "Suppress all output except for errors; overrides -v")
                     .action(clap::ArgAction::SetTrue),
             )
+            .arg(
+                Arg::new("suppress-warnings")
+                    .long("suppress-warnings")
+                    .action(clap::ArgAction::SetTrue)
+                    .help("Suppress warnings; overrides -v"),
+            )
             .subcommand_negates_reqs(true)
             .subcommand(
                 clap::Command::new("schema")
@@ -212,6 +220,7 @@ impl Builder {
             build_root,
             command,
             jobs,
+            ignore_warn: self.matches.get_flag("suppress-warnings"),
         })
     }
 

src/cli/mod.rs

@@ -7,6 +7,19 @@ struct Version {
     patch: u8,
 }
 
+#[derive(Debug)]
+pub enum RunResult {
+    Ok,
+    Err(String),
+    Warn(String),
+}
+
+impl From<&io::Error> for RunResult {
+    fn from(value: &io::Error) -> Self {
+        RunResult::Err(value.to_string())
+    }
+}
+
 impl FromStr for Version {
     type Err = String;
 
@@ -91,29 +104,28 @@ impl Runner {
         Ok(())
     }
 
-    fn run(mut cmd: process::Command) -> Result<(), io::Error> {
-        let output = cmd.output()?;
+    fn run(mut cmd: process::Command, ignore_warn: bool) -> RunResult {
+        let output = cmd.output();
+        if let Err(err) = &output {
+            return err.into();
+        }
+        let output = output.unwrap();
 
-        if let Err(err) = Runner::eval_status(output.status) {
-            let stderr = String::from_utf8_lossy(&output.stderr);
-            let stdout = String::from_utf8_lossy(&output.stdout);
+        let stderr = String::from_utf8_lossy(&output.stderr);
+        let stdout = String::from_utf8_lossy(&output.stdout);
 
+        if let Err(err) = Runner::eval_status(output.status) {
             if stderr.len() != 0 {
-                // log::error!("{}", stderr);
-                // log::info!("{}", stdout);
-
-                return Err(io::Error::new(
-                    io::ErrorKind::Other,
-                    format!("{err}\n---\n{stderr}---\n{stdout}"),
-                    // format!("{}\n---\n{}", err, stdout),
-                ));
+                return RunResult::Err(format!("{err}\n---\n{stderr}---\n{stdout}"));
             }
-            return Err(err);
+            return (&err).into();
+        } else if !ignore_warn && !stderr.is_empty() {
+            return RunResult::Warn(format!("warnings encountered\n---\n{stderr}---\n{stdout}"));
         }
-        Ok(())
+        RunResult::Ok
     }
 
-    pub fn run_tidy<P, Q>(&self, file: P, build_root: Q, fix: bool) -> Result<(), io::Error>
+    pub fn run_tidy<P, Q>(&self, file: P, build_root: Q, fix: bool, ignore_warn: bool) -> RunResult
     where
         P: AsRef<path::Path>,
         Q: AsRef<path::Path>,
@@ -135,7 +147,7 @@ impl Runner {
         // This suppresses printing statistics about ignored warnings:
         // cmd.arg("-quiet");
 
-        Runner::run(cmd)
+        Runner::run(cmd, ignore_warn)
     }
 
     pub fn supports_config_file(&self) -> Result<(), io::Error> {