From ad09b3b2fb1097be7dea74a5cbb2c0027ea6df77 Mon Sep 17 00:00:00 2001
From: Henri Lunnikivi <heggggxa@gmail.com>
Date: Fri, 19 Apr 2024 17:42:11 +0300
Subject: [PATCH] CLI: logs and filters (#34)

* Control log output from CLI using env_logger
* Pass regex filters for top & paths from CLI
---
 keelhaul-cli/Cargo.toml   |  2 ++
 keelhaul-cli/src/main.rs  | 38 ++++++++++++++++++++++++++++++++++++--
 keelhaul/src/filtering.rs | 10 +++++++++-
 3 files changed, 47 insertions(+), 3 deletions(-)

diff --git a/keelhaul-cli/Cargo.toml b/keelhaul-cli/Cargo.toml
index fa45af3..7ef7aaf 100644
--- a/keelhaul-cli/Cargo.toml
+++ b/keelhaul-cli/Cargo.toml
@@ -17,4 +17,6 @@ path = "src/main.rs"
 anyhow = "1.0.81"
 clap = { version = "4.5.3", features = ["derive", "cargo"] }
 clap-num = "1.1.1"
+clap-verbosity-flag = "2.2.0"
+env_logger = "0.11.3"
 keelhaul = { version = "0.1.0", path = "../keelhaul", features = ["rustfmt"] }
diff --git a/keelhaul-cli/src/main.rs b/keelhaul-cli/src/main.rs
index 9550bd7..8fd4fd9 100644
--- a/keelhaul-cli/src/main.rs
+++ b/keelhaul-cli/src/main.rs
@@ -1,4 +1,4 @@
-use std::{env, iter, ops, path};
+use std::{env, iter, ops, path, str::FromStr};
 
 use anyhow::{anyhow, Context};
 use clap::{Args, Parser, Subcommand, ValueEnum};
@@ -8,6 +8,9 @@ use clap::{Args, Parser, Subcommand, ValueEnum};
 struct Cli {
     #[command(subcommand)]
     command: Option<Command>,
+
+    #[command(flatten)]
+    verbose: clap_verbosity_flag::Verbosity,
 }
 
 #[derive(Args, Clone)]
@@ -125,6 +128,14 @@ enum Command {
         /// Use zero as the assumed default reset value when a reset value is not provided
         #[arg(long = "reset-defaults-zero", action = clap::ArgAction::SetTrue)]
         use_zero_as_default_reset: bool,
+
+        /// Filter top elements using a regex
+        #[arg(long = "filter-top")]
+        filter_top_regex: Option<String>,
+
+        /// Filter register paths using a regex. Dash (`-`) is the separator between path elements.
+        #[arg(long = "filter-path")]
+        filter_path_regex: Option<String>,
     },
     /// Generate memory tests
     #[command(name = "gen-memtest")]
@@ -401,6 +412,11 @@ fn get_sources(
 fn main() -> anyhow::Result<()> {
     let cli = Cli::parse();
 
+    // Install a logger to print useful messages to stderr
+    env_logger::Builder::new()
+        .filter_module("keelhaul", cli.verbose.log_level_filter())
+        .init();
+
     let sources = cli
         .command
         .as_ref()
@@ -478,6 +494,8 @@ fn main() -> anyhow::Result<()> {
                 no_format,
                 use_zero_as_default_reset,
                 validate_level: _,
+                filter_top_regex,
+                filter_path_regex,
             } => {
                 let mut config = keelhaul::CodegenConfig::default()
                     .tests_to_generate(tests_to_generate.iter().cloned().map(|tk| tk.0).collect())
@@ -487,8 +505,24 @@ fn main() -> anyhow::Result<()> {
                 if let Some(on_fail) = on_fail {
                     config = config.on_fail(on_fail.clone().into());
                 }
+
+                let filters = keelhaul::Filters::from_filters(
+                    None,
+                    filter_top_regex
+                        .as_ref()
+                        .map(|s| keelhaul::RegexFilter::from_str(s))
+                        .transpose()?
+                        .map(|f| -> Box<dyn keelhaul::Filter> { Box::new(f) }),
+                    filter_path_regex
+                        .as_ref()
+                        .map(|s| keelhaul::RegexFilter::from_str(s))
+                        .transpose()?
+                        .map(|f| -> Box<dyn keelhaul::Filter> { Box::new(f) }),
+                );
+
                 generate(
                     arch.unwrap().into(),
+                    filters,
                     config,
                     sources.unwrap(),
                     *no_format,
@@ -565,12 +599,12 @@ fn main() -> anyhow::Result<()> {
 
 fn generate(
     arch: keelhaul::ArchWidth,
+    filters: keelhaul::Filters,
     config: keelhaul::CodegenConfig,
     sources: Vec<keelhaul::ModelSource>,
     no_format: bool,
     use_zero_as_default_reset: bool,
 ) -> Result<(), anyhow::Error> {
-    let filters = keelhaul::Filters::all();
     let output = if no_format {
         keelhaul::generate_tests(&sources, arch, &config, &filters, use_zero_as_default_reset)?
     } else {
diff --git a/keelhaul/src/filtering.rs b/keelhaul/src/filtering.rs
index 9ef2757..3cf1461 100644
--- a/keelhaul/src/filtering.rs
+++ b/keelhaul/src/filtering.rs
@@ -1,4 +1,4 @@
-use std::ops;
+use std::{ops, str};
 
 use regex::Regex;
 
@@ -82,6 +82,14 @@ impl RegexFilter {
     }
 }
 
+impl str::FromStr for RegexFilter {
+    type Err = regex::Error;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        Ok(Self::new(Regex::new(s)?))
+    }
+}
+
 impl Filter for RegexFilter {
     fn is_allowed(&self, value: &str) -> bool {
         let value_string = value.to_string();