add cargo xtask clippy (#3705)

.cargo/config

@@ -15,3 +15,7 @@ rustdocflags = "--document-private-items"
 rustflags = [
     "-C", "link-arg=-Wl,-znocompstrtab"
 ]
+
+# Set up `cargo xtask`.
+[alias]
+xtask = "run --package xtask -- "

.github/buildomat/jobs/clippy.sh

@@ -28,5 +28,4 @@ banner prerequisites
 ptime -m bash ./tools/install_builder_prerequisites.sh -y
 
 banner clippy
-# See the corresponding GitHub Actions job for more about these arguments.
-ptime -m cargo clippy --all-targets -- --deny warnings --allow clippy::style
+ptime -m cargo xtask clippy

.github/workflows/rust.yml

@@ -69,12 +69,7 @@ jobs:
     - name: Install Pre-Requisites
       run: ./tools/install_builder_prerequisites.sh -y
     - name: Run Clippy Lints
-      #
-      # Clippy's style nits are useful, but not worth keeping in CI.  This
-      # override belongs in src/lib.rs, and it is there, but that doesn't
-      # reliably work due to rust-lang/rust-clippy#6610.
-      #
-      run: cargo clippy --all-targets -- --deny warnings --allow clippy::style
+      run: cargo xtask clippy
 
   # This is just a test build of docs.  Publicly available docs are built via
   # the separate "rustdocs" repo.

Cargo.toml

@@ -7,60 +7,61 @@ members = [
     "certificates",
     "common",
     "ddm-admin-client",
-    "dpd-client",
     "deploy",
     "dev-tools",
     "dns-server",
     "dns-service-client",
+    "dpd-client",
     "end-to-end-tests",
-    "gateway",
     "gateway-cli",
     "gateway-client",
     "gateway-test-utils",
+    "gateway",
     "illumos-utils",
-    "installinator",
     "installinator-artifact-client",
     "installinator-artifactd",
     "installinator-common",
-    "internal-dns",
+    "installinator",
     "internal-dns-cli",
+    "internal-dns",
     "ipcc-key-value",
     "key-manager",
-    "nexus",
     "nexus-client",
+    "nexus",
     "nexus/authz-macros",
     "nexus/db-macros",
     "nexus/db-model",
     "nexus/db-queries",
     "nexus/defaults",
     "nexus/test-interface",
-    "nexus/test-utils",
     "nexus/test-utils-macros",
+    "nexus/test-utils",
     "nexus/types",
     "oxide-client",
     "oximeter-client",
     "oximeter/collector",
     "oximeter/db",
     "oximeter/instruments",
-    "oximeter/oximeter",
     "oximeter/oximeter-macro-impl",
+    "oximeter/oximeter",
     "oximeter/producer",
     "package",
     "passwords",
     "rpaths",
-    "sled-agent",
     "sled-agent-client",
+    "sled-agent",
     "sled-hardware",
     "sp-sim",
     "test-utils",
-    "tufaceous",
     "tufaceous-lib",
+    "tufaceous",
     "update-engine",
-    "wicket",
     "wicket-common",
     "wicket-dbg",
-    "wicketd",
+    "wicket",
     "wicketd-client",
+    "wicketd",
+    "xtask",
 ]
 
 default-members = [
@@ -120,6 +121,7 @@ default-members = [
     "wicket-dbg",
     "wicketd",
     "wicketd-client",
+    "xtask",
 ]
 resolver = "2"
 

README.adoc

@@ -47,7 +47,7 @@ To build and run the non-simulated version of Omicron, see: xref:docs/how-to-run
 
 You can **format the code** using `cargo fmt`.  Make sure to run this before pushing changes.  The CI checks that the code is correctly formatted.
 
-You can **run the https://github.com/rust-lang/rust-clippy[Clippy linter]** using `cargo clippy --all-targets \-- --deny warnings --allow clippy::style`.  Make sure to run this before pushing changes.  The CI checks that the code is clippy-clean.
+You can **run the https://github.com/rust-lang/rust-clippy[Clippy linter]** using `cargo xtask clippy`.  CI checks that code is clippy-clean.
 
 == Working in Omicron
 

xtask/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "xtask"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+anyhow.workspace = true
+clap.workspace = true

xtask/src/main.rs

@@ -0,0 +1,72 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+//! Workspace-related developer tools
+//!
+//! See <https://github.com/matklad/cargo-xtask>.
+
+use anyhow::{bail, Context, Result};
+use clap::{Parser, Subcommand};
+use std::process::Command;
+
+#[derive(Parser)]
+#[command(name = "cargo xtask", about = "Workspace-related developer tools")]
+struct Args {
+    #[command(subcommand)]
+    cmd: Cmds,
+}
+
+#[derive(Subcommand)]
+enum Cmds {
+    /// Run configured clippy checks
+    Clippy,
+}
+
+fn main() -> Result<()> {
+    let args = Args::parse();
+    match args.cmd {
+        Cmds::Clippy => cmd_clippy(),
+    }
+}
+
+fn cmd_clippy() -> Result<()> {
+    let cargo =
+        std::env::var("CARGO").unwrap_or_else(|_| String::from("cargo"));
+    let mut command = Command::new(&cargo);
+    command
+        .arg("clippy")
+        // Make sure we check everything.
+        .arg("--all-targets")
+        .arg("--")
+        // We disallow warnings by default.
+        .arg("--deny")
+        .arg("warnings")
+        // Clippy's style nits are useful, but not worth keeping in CI.  This
+        // override belongs in src/lib.rs, and it is there, but that doesn't
+        // reliably work due to rust-lang/rust-clippy#6610.
+        .arg("--allow")
+        .arg("clippy::style");
+
+    eprintln!(
+        "running: {:?} {}",
+        &cargo,
+        command
+            .get_args()
+            .map(|arg| format!("{:?}", arg.to_str().unwrap()))
+            .collect::<Vec<_>>()
+            .join(" ")
+    );
+
+    let exit_status = command
+        .spawn()
+        .context("failed to spawn child process")?
+        .wait()
+        .context("failed to wait for child process")?;
+
+    if !exit_status.success() {
+        bail!("clippy failed: {}", exit_status);
+    }
+
+    Ok(())
+}