Add integration tests

Author: syl20bnr

.cargo/config.toml

@@ -1,2 +1,2 @@
 [alias]
-xtask = "run --release --target-dir target/xtask/release --package xtask --bin xtask --"
+xtask = "run --target-dir target/xtask --package xtask --bin xtask --"

.gitignore

@@ -1,4 +1,5 @@
 /target
+xtask/target
 
 .DS_Store
 .vscode

Cargo.lock

@@ -0,0 +1,4 @@
+[files]
+extend-exclude = [
+    "target",
+]

_typos.toml

@@ -6,4 +6,8 @@ edition = "2021"
 [dependencies]
 strum = { workspace = true }
 log = { workspace = true }
-tracel-xtask = { path = "../crates/tracel-xtask" }
+tracel-xtask = { path = "../crates/tracel-xtask" }
+rstest.workspace = true
+
+[dev-dependencies]
+rstest = { workspace = true }

xtask/Cargo.toml

@@ -9,7 +9,9 @@ pub struct ExtendedBuildArgsCmdArgs {
 
 pub fn handle_command(args: ExtendedBuildArgsCmdArgs) -> anyhow::Result<()> {
     if args.debug {
-        println!("Debug is enabled");
+        println!("debug enabled");
+    } else {
+        println!("debug disabled");
     }
     base_commands::build::handle_command(args.try_into().unwrap())
 }

xtask/src/commands/build.rs

@@ -4,32 +4,41 @@ use strum::IntoEnumIterator;
 use tracel_xtask::prelude::*;
 
 #[macros::extend_command_args(CheckCmdArgs, Target, ExtendedCheckSubcommand)]
-pub struct ExtendedCheckedArgsCmdArgs {}
+pub struct ExtendedCheckArgsCmdArgs {}
 
 #[macros::extend_subcommands(CheckSubCommand)]
 pub enum ExtendedCheckSubcommand {
     /// An additional subcommand for our extended Fix command.
-    MySubcommand,
+    MySubCommand,
 }
 
-pub fn handle_command(args: ExtendedCheckedArgsCmdArgs) -> anyhow::Result<()> {
+pub fn handle_command(args: ExtendedCheckArgsCmdArgs) -> anyhow::Result<()> {
     match args.get_command() {
-        ExtendedCheckSubcommand::MySubcommand => run_my_subcommand(args.clone()),
-        ExtendedCheckSubcommand::All => ExtendedCheckSubcommand::iter()
-            .filter(|c| *c != ExtendedCheckSubcommand::All)
-            .try_for_each(|c| {
-                handle_command(ExtendedCheckedArgsCmdArgs {
-                    command: Some(c),
-                    target: args.target.clone(),
-                    exclude: args.exclude.clone(),
-                    only: args.only.clone(),
+        ExtendedCheckSubcommand::MySubCommand => run_my_subcommand(args.clone()),
+        ExtendedCheckSubcommand::All => {
+            println!("Executing all");
+            ExtendedCheckSubcommand::iter()
+                .filter(|c| *c != ExtendedCheckSubcommand::All)
+                .try_for_each(|c| {
+                    handle_command(ExtendedCheckArgsCmdArgs {
+                        command: Some(c),
+                        target: args.target.clone(),
+                        exclude: args.exclude.clone(),
+                        only: args.only.clone(),
+                    })
                 })
-            }),
-        _ => base_commands::check::handle_command(args.try_into().unwrap()),
+        }
+        command => {
+            println!("Executing {command}");
+            // this should be uncommented but we skip the actual execution here because we use
+            // this command in the integration test as well.
+            // base_commands::check::handle_command(args.try_into().unwrap())
+            Ok(())
+        }
     }
 }
 
-fn run_my_subcommand(_args: ExtendedCheckedArgsCmdArgs) -> Result<(), anyhow::Error> {
+fn run_my_subcommand(_args: ExtendedCheckArgsCmdArgs) -> Result<(), anyhow::Error> {
     println!("Executing new subcommand");
     Ok(())
 }

xtask/src/commands/extended_build_args.rs

@@ -18,7 +18,7 @@ pub struct ExtendedFixCmdArgs {}
 #[macros::extend_subcommands(FixSubCommand)]
 pub enum ExtendedFixSubCommand {
     /// An additional subcommand for our extended Fix command.
-    NewSubcommand(NewSubcommandArgs),
+    NewSubCommand(NewSubcommandArgs),
 }
 
 // We can add custom arguments for our 'new-subcommand' subcommand as well
@@ -30,10 +30,13 @@ pub struct NewSubcommandArgs {
 }
 
 // Handle function processing the extended command arguments struct with extended subcommands
-pub fn handle_command(args: ExtendedFixCmdArgs, answer: Option<bool>) -> anyhow::Result<()> {
+#[allow(unused_assignments)]
+pub fn handle_command(args: ExtendedFixCmdArgs, mut answer: Option<bool>) -> anyhow::Result<()> {
+    // force the ansert to yes for the integration tests
+    answer = Some(true);
     // we need to handle both the new subcommand 'new-subcommand' and the 'all' subcommand
     match args.get_command() {
-        ExtendedFixSubCommand::NewSubcommand(ref subcmd_args) => {
+        ExtendedFixSubCommand::NewSubCommand(ref subcmd_args) => {
             run_new_subcommand_fix(args.clone(), subcmd_args, answer)
         }
         ExtendedFixSubCommand::All => {
@@ -52,7 +55,12 @@ pub fn handle_command(args: ExtendedFixCmdArgs, answer: Option<bool>) -> anyhow:
                     )
                 })
         }
-        _ => base_commands::fix::handle_command(args.try_into().unwrap(), answer),
+        _ => {
+            // this should be uncommented but we skip the actual execution here because we use
+            // this command in the integration test as well.
+            // base_commands::fix::handle_command(args.try_into().unwrap(), answer),
+            Ok(())
+        }
     }
 }
 

xtask/src/commands/extended_check_sub_commands.rs

@@ -1,4 +1,3 @@
-pub(crate) mod build;
 pub(crate) mod extended_build_args;
 pub(crate) mod extended_build_new_sub_commands;
 pub(crate) mod extended_check_sub_commands;