Implement default Validate base command and add ignore-audit flag

Author: syl20bnr

crates/tracel-xtask-macros/src/lib.rs

@@ -1,4 +1,4 @@
-// TODO: Check if it is possible to refactor all the macros using an inventory: https://crates.io/crates/inventory
+// TODO Check if it is possible to refactor all the macros using an inventory: https://crates.io/crates/inventory
 // The idea would be to discover and register all the fields of base commands and all the variants of subcommand.
 // If this is possible this should allow to generalize the command extension mechanism and make it even more useful.
 extern crate proc_macro;
@@ -75,18 +75,17 @@ fn generate_dispatch_function(
     enum_ident: &syn::Ident,
     args: &Punctuated<Meta, Comma>,
 ) -> TokenStream {
-    let arms: Vec<proc_macro2::TokenStream> = args.iter().filter_map(|meta| {
+    let arms: Vec<proc_macro2::TokenStream> = args.iter().map(|meta| {
         let cmd_ident = meta.path().get_ident().unwrap();
         let cmd_ident_string = cmd_ident.to_string();
         let module_ident = syn::Ident::new(cmd_ident_string.to_lowercase().as_str(), cmd_ident.span());
         match cmd_ident_string.as_str() {
-            "Validate" => None,
-            "Fix" => Some(quote! {
+            "Fix" => quote! {
                 #enum_ident::#cmd_ident(args) => base_commands::#module_ident::handle_command(args, None),
-            }),
-            _ => Some(quote! {
+            },
+            _ => quote! {
                 #enum_ident::#cmd_ident(args) => base_commands::#module_ident::handle_command(args),
-            })
+            }
         }
     }).collect();
     let func = quote! {
@@ -182,7 +181,7 @@ pub fn base_commands(args: TokenStream, input: TokenStream) -> TokenStream {
         "Validate",
         quote! {
             #[doc = r"Validate the code base by running all the relevant checks and tests. Use this command before creating a new pull-request."]
-            Validate
+            Validate(tracel_xtask::commands::validate::ValidateCmdArgs)
         },
     );
     variant_map.insert("Vulnerabilities", quote! {
@@ -234,25 +233,43 @@ pub fn base_commands(args: TokenStream, input: TokenStream) -> TokenStream {
 // =================
 
 fn get_additional_cmd_args_map() -> HashMap<&'static str, proc_macro2::TokenStream> {
-    HashMap::from([(
-        "TestCmdArgs",
-        quote! {
-            #[doc = r"Maximum number of parallel test crate compilations."]
-            #[arg(
-                long = "compilation-jobs",
-                value_name = "NUMBER OF THREADS",
-                required = false
-            )]
-            pub jobs: Option<u16>,
-            #[doc = r"Maximum number of parallel test within a test crate execution."]
-            #[arg(
-                long = "test-threads",
-                value_name = "NUMBER OF THREADS",
-                required = false
-            )]
-            pub threads: Option<u16>,
-        },
-    )])
+    HashMap::from([
+        (
+            "CheckCmdArgs",
+            quote! {
+                #[doc = r"Ignore audit errors."]
+                #[arg(long = "ignore-audit", required = false)]
+                pub ignore_audit: bool,
+            },
+        ),
+        (
+            "TestCmdArgs",
+            quote! {
+                #[doc = r"Maximum number of parallel test crate compilations."]
+                #[arg(
+                    long = "compilation-jobs",
+                    value_name = "NUMBER OF THREADS",
+                    required = false
+                )]
+                pub jobs: Option<u16>,
+                #[doc = r"Maximum number of parallel test within a test crate execution."]
+                #[arg(
+                    long = "test-threads",
+                    value_name = "NUMBER OF THREADS",
+                    required = false
+                )]
+                pub threads: Option<u16>,
+            },
+        ),
+        (
+            "ValidateCmdArgs",
+            quote! {
+                #[doc = r"Ignore audit errors."]
+                #[arg(long = "ignore-audit", required = false)]
+                pub ignore_audit: bool,
+            },
+        ),
+    ])
 }
 
 // Returns a tuple where 0 is the actual struct and 1 is additional implementations
@@ -349,8 +366,11 @@ fn generate_command_args_struct(
         };
 
         let additional_cmd_args_map = get_additional_cmd_args_map();
-        let additional_fields = match additional_cmd_args_map.get(struct_name.to_string().as_str())
-        {
+        let mut base_command_type = struct_name.to_string();
+        if args.len() == 3 {
+            base_command_type = args.get(0).unwrap().path().get_ident().unwrap().to_string();
+        }
+        let additional_fields = match additional_cmd_args_map.get(base_command_type.as_str()) {
             Some(fields) => fields.clone(),
             None => quote! {},
         };
@@ -454,7 +474,15 @@ fn generate_command_args_tryinto(args: TokenStream, input: TokenStream) -> Token
         .filter_map(|f| {
             f.ident.as_ref().map(|ident| {
                 let ident_str = ident.to_string();
-                if ident_str != "target" && (ident_str == "exclude" || ident_str == "only") {
+                // TODO this hardcoded predicates are awful, they should be unneccesarry if
+                // we can use an inventory (see TODO at the top of the file)
+                if ident_str != "target"
+                    && (ident_str == "exclude"
+                        || ident_str == "only"
+                        || ident_str == "ignore_audit"
+                        || ident_str == "jobs"
+                        || ident_str == "threads")
+                {
                     quote! { #ident: self.#ident, }
                 } else {
                     quote! {}

crates/tracel-xtask/src/commands/check.rs

@@ -22,6 +22,12 @@ pub fn handle_command(args: CheckCmdArgs) -> anyhow::Result<()> {
     }
 
     match args.get_command() {
+        CheckSubCommand::Audit if args.ignore_audit => {
+            if run_audit().is_err() {
+                warn!("Ignoring audit error because of '--ignore-audit' flag.");
+            }
+            Ok(())
+        }
         CheckSubCommand::Audit => run_audit(),
         CheckSubCommand::Format => run_format(&args.target, &args.exclude, &args.only),
         CheckSubCommand::Lint => run_lint(&args.target, &args.exclude, &args.only),
@@ -34,6 +40,7 @@ pub fn handle_command(args: CheckCmdArgs) -> anyhow::Result<()> {
                     target: args.target.clone(),
                     exclude: args.exclude.clone(),
                     only: args.only.clone(),
+                    ignore_audit: args.ignore_audit,
                 })
             }),
     }

crates/tracel-xtask/src/commands/mod.rs

@@ -8,6 +8,7 @@ pub mod doc;
 pub mod fix;
 pub mod publish;
 pub mod test;
+pub mod validate;
 pub mod vulnerabilities;
 
 // use crate::declare_target;

xtask/src/commands/validate.rs renamed to crates/tracel-xtask/src/commands/validate.rs

@@ -1,6 +1,13 @@
-use tracel_xtask::prelude::*;
+use super::{
+    check::{CheckCmdArgs, CheckSubCommand},
+    test::{TestCmdArgs, TestSubCommand},
+    Target,
+};
 
-pub fn handle_command() -> anyhow::Result<()> {
+#[tracel_xtask_macros::declare_command_args(None, None)]
+struct ValidateCmdArgs {}
+
+pub fn handle_command(args: ValidateCmdArgs) -> anyhow::Result<()> {
     let target = Target::Workspace;
     let exclude = vec![];
     let only = vec![];
@@ -14,16 +21,17 @@ pub fn handle_command() -> anyhow::Result<()> {
     ]
     .iter()
     .try_for_each(|c| {
-        base_commands::check::handle_command(CheckCmdArgs {
+        super::check::handle_command(CheckCmdArgs {
             target: target.clone(),
             exclude: exclude.clone(),
             only: only.clone(),
             command: Some(c.clone()),
+            ignore_audit: args.ignore_audit,
         })
     })?;
 
     // tests
-    base_commands::test::handle_command(TestCmdArgs {
+    super::test::handle_command(TestCmdArgs {
         target: target.clone(),
         exclude: exclude.clone(),
         only: only.clone(),

crates/tracel-xtask/src/lib.rs

@@ -38,6 +38,7 @@ pub mod prelude {
     pub use crate::commands::publish::PublishCmdArgs;
     pub use crate::commands::test::TestCmdArgs;
     pub use crate::commands::test::TestSubCommand;
+    pub use crate::commands::validate::ValidateCmdArgs;
     pub use crate::commands::vulnerabilities::VulnerabilitiesCmdArgs;
     pub use crate::commands::vulnerabilities::VulnerabilitiesSubCommand;
     pub use crate::commands::Target;

xtask/src/commands/extended_check_sub_commands.rs

@@ -25,6 +25,7 @@ pub fn handle_command(args: ExtendedCheckArgsCmdArgs) -> anyhow::Result<()> {
                         target: args.target.clone(),
                         exclude: args.exclude.clone(),
                         only: args.only.clone(),
+                        ignore_audit: args.ignore_audit,
                     })
                 })
         }

xtask/src/commands/mod.rs

@@ -5,4 +5,3 @@ pub(crate) mod extended_target;
 pub(crate) mod fix;
 pub(crate) mod my_command;
 pub(crate) mod my_command_with_sub_commands;
-pub(crate) mod validate;

xtask/src/main.rs

@@ -56,7 +56,6 @@ fn main() -> anyhow::Result<()> {
         Command::MyCommandWithSubCommand(args) => {
             commands::my_command_with_sub_commands::handle_command(args)
         }
-        Command::Validate => commands::validate::handle_command(),
         // dispatch_base_commands function is generated by the commands macro
         _ => dispatch_base_commands(args),
     }?;