Embedded stm_rules, removed --rules #29

Author: rimutaka

stackmuncher/src/app_args.rs

@@ -35,7 +35,6 @@ pub(crate) struct AppArgs {
     /// E.g. `fb8fc0f87ee78231f064131022c8154a`
     pub gh_validation_id: Option<String>,
     pub project: Option<PathBuf>,
-    pub rules: Option<PathBuf>,
     pub reports: Option<PathBuf>,
     pub config: Option<PathBuf>,
     pub log: Option<tracing::Level>,
@@ -75,7 +74,6 @@ impl AppArgs {
             emails: None,
             gh_validation_id: None,
             project: None,
-            rules: None,
             reports: None,
             config: None,
             log: None,
@@ -184,38 +182,14 @@ impl AppArgs {
             }
         };
 
-        // rules folder
-        if let Some(rules) = find_arg_value(&mut pargs, vec!["--rules"]) {
-            // en empty value doesn't make sense in this context
-            if rules.trim().is_empty() {
-                eprintln!(
-                    "STACKMUNCHER CONFIG ERROR: param `--rules` has no value. Omit it to use the default set or provide a valid path to where the rules files are located (absolute or relative).",
-                );
-                help::emit_usage_msg();
-                exit(1);
-            }
-
-            match PathBuf::from_str(&rules) {
-                Ok(v) => app_args.rules = Some(v),
-                Err(_) => {
-                    eprintln!(
-                        "STACKMUNCHER CONFIG ERROR: `{}` is not a valid path for `--rules`. Omit it to use the default set or provide a valid path to where the rules files are located (absolute or relative).",
-                        rules
-                    );
-                    help::emit_report_dir_msg();
-                    exit(1);
-                }
-            }
-        };
-
         // report folder
         if let Some(reports) = find_arg_value(&mut pargs, vec!["--reports"]) {
             // en empty value doesn't make sense in this context
             if reports.trim().is_empty() {
                 eprintln!(
                     "STACKMUNCHER CONFIG ERROR: param `--reports` has no value. Omit it to use the default location or provide a valid path to where report files should be placed (absolute or relative).",
                 );
-                help::emit_usage_msg();
+                help::emit_report_dir_msg();
                 exit(1);
             }
 
@@ -226,7 +200,7 @@ impl AppArgs {
                         "STACKMUNCHER CONFIG ERROR: `{}` is not a valid path for `--reports`. Omit it to use the default location or provide a valid path to where report files should be placed (absolute or relative).",
                         reports
                     );
-                    help::emit_usage_msg();
+                    help::emit_report_dir_msg();
                     exit(1);
                 }
             }

stackmuncher/src/cmd_config.rs

@@ -63,13 +63,6 @@ pub(crate) async fn view_config(config: AppConfig) {
         .expect("Cannot convert config.report_dir to absolute path. It's a bug.")
         .to_string_lossy()
         .to_string();
-    let rules = config
-        .lib_config
-        .code_rules_dir
-        .absolutize()
-        .expect("Cannot convert config.code_rules_dir to absolute path. It's a bug.")
-        .to_string_lossy()
-        .to_string();
     let config_file = config
         .config_file_path
         .absolutize()
@@ -99,8 +92,7 @@ pub(crate) async fn view_config(config: AppConfig) {
     println!("    GitHub validation: {}", github_validation);
     println!();
     println!("    Local stack reports: {}", reports);
-    println!("    Code analysis rules: {}", rules);
-    println!("    Config file: {}", config_file);
+    println!("    Config folder: {}", config_file);
     println!();
 }
 

stackmuncher/src/cmd_munch.rs

@@ -12,7 +12,7 @@ pub(crate) async fn run(config: AppConfig) -> Result<(), ()> {
     let instant = std::time::Instant::now();
 
     // load code rules
-    let mut code_rules = CodeRules::new(&config.lib_config.code_rules_dir);
+    let mut code_rules = CodeRules::new();
 
     // Reports are grouped per project with a canonical project name as the last subfolder
     let report_dir = Path::new(

stackmuncher/src/config.rs

@@ -114,15 +114,8 @@ impl AppConfig {
         // only validate project, rules and report if code analysis is to be done
         // config should be validated regardless because nothing functions without it
         if app_args.command == AppArgCommands::Munch {
-            // rules and project folders are being validated only - not much difference if it's done now or later
+            // only `project` folder is being validated - not much difference if it's done now or later
             // replace default config with user values from the CLI
-            if let Some(rules) = app_args.rules {
-                validate_rules_dir(&rules);
-                config.code_rules_dir = rules;
-            } else {
-                // validate the default value
-                validate_rules_dir(&config.code_rules_dir);
-            };
 
             // check the project folder for existence and if it has .git in it
             config.project_dir = match app_args.project {
@@ -294,29 +287,26 @@ pub(crate) async fn new_config_with_defaults(current_dir: PathBuf) -> (Config, P
     // look for the rules in the current working dir if in debug mode
     // otherwise default to a platform-specific location
     // this can be overridden by `--rules` CLI param
-    let (code_rules_dir, report_dir, config_dir, log_level) = if is_local_release {
+    let (report_dir, config_dir, log_level) = if is_local_release {
         // this branch activates when the app is called directly from `stm_app/target/release` folder, but all the config files are 2 levels up
         // go 2 steps up in the hierarchy to get to the root of stm_app project
         let mut exec_dir = exec_dir;
         exec_dir.pop();
         exec_dir.pop();
         (
-            exec_dir.join(Config::RULES_FOLDER_NAME_DEBUG),
             exec_dir.join(Config::REPORT_FOLDER_NAME_DEBUG),
             exec_dir.join(CONFIG_FOLDER_NAME_DEBUG),
             tracing::Level::ERROR,
         )
     } else if cfg!(debug_assertions) {
         // this branch activates when run as `cargo run`
         (
-            Path::new(Config::RULES_FOLDER_NAME_DEBUG).to_path_buf(),
             Path::new(Config::REPORT_FOLDER_NAME_DEBUG).to_path_buf(),
             Path::new(CONFIG_FOLDER_NAME_DEBUG).to_path_buf(),
             tracing::Level::INFO,
         )
     } else if cfg!(target_os = "linux") {
         (
-            Path::new(Config::RULES_FOLDER_NAME_LINUX).to_path_buf(),
             Path::new(Config::REPORT_FOLDER_NAME_LINUX).to_path_buf(),
             Path::new(CONFIG_FOLDER_NAME_LINUX).to_path_buf(),
             tracing::Level::ERROR,
@@ -326,7 +316,6 @@ pub(crate) async fn new_config_with_defaults(current_dir: PathBuf) -> (Config, P
         let local_appdata_dir = std::env::var("LOCALAPPDATA").expect("%LOCALAPPDATA% env variable not found");
         let local_appdata_dir = Path::new(&local_appdata_dir);
         (
-            exec_dir.join(Config::RULES_FOLDER_NAME_WIN),
             local_appdata_dir.join(Config::REPORT_FOLDER_NAME_WIN),
             local_appdata_dir.join(CONFIG_FOLDER_NAME_WIN),
             tracing::Level::ERROR,
@@ -343,7 +332,6 @@ pub(crate) async fn new_config_with_defaults(current_dir: PathBuf) -> (Config, P
 
     let config = Config {
         log_level,
-        code_rules_dir,
         report_dir: Some(report_dir),
         project_dir: current_dir,
         user_name: String::new(),
@@ -380,50 +368,6 @@ fn trim_canonical_project_name(name: String) -> String {
     name
 }
 
-/// Validates the value for config.code_rules_dir and does process::exit(1) on error.
-/// Prints error messages.
-fn validate_rules_dir(rules: &PathBuf) {
-    // this checks if the rules dir is present, but not its contents
-    // incomplete, may fall over later
-    if !rules.exists() {
-        eprintln!("STACKMUNCHER CONFIG ERROR: Cannot find StackMuncher code parsing rules.");
-        help::emit_code_rules_msg();
-        exit(1);
-    }
-
-    // check if the sub-folders of stm_rules are present
-    let file_type_dir = rules.join(Config::RULES_SUBFOLDER_FILE_TYPES);
-    if !file_type_dir.exists() {
-        let file_type_dir = file_type_dir
-            .absolutize()
-            .expect("Cannot convert rules / file_types dir path to absolute. It's a bug.")
-            .to_path_buf();
-
-        eprintln!(
-            "STACKMUNCHER CONFIG ERROR: Cannot find file type rules folder {}",
-            file_type_dir.to_string_lossy()
-        );
-        help::emit_code_rules_msg();
-        std::process::exit(1);
-    }
-
-    // check if the munchers sub-folder is present
-    let muncher_dir = rules.join(Config::RULES_SUBFOLDER_MUNCHERS);
-    if !muncher_dir.exists() {
-        let muncher_dir = muncher_dir
-            .absolutize()
-            .expect("Cannot convert rules / munchers dir path to absolute. It's a bug.")
-            .to_path_buf();
-
-        eprintln!(
-            "STACKMUNCHER CONFIG ERROR: Cannot find rules directory for munchers in {}",
-            muncher_dir.to_string_lossy()
-        );
-        help::emit_code_rules_msg();
-        std::process::exit(1);
-    }
-}
-
 /// Returns a validated config.project_dir or exits with an error message
 fn validate_project_dir(project: PathBuf) -> PathBuf {
     // the project dir at this point is either a tested param from the CLI or the current dir

stackmuncher/src/help.rs

@@ -20,29 +20,6 @@ pub(crate) fn emit_support_msg() {
     println!("Support: https://github.com/stackmuncher/stm/issues or [email protected]");
 }
 
-/// Prints out info on where the rules are expected
-pub(crate) fn emit_code_rules_msg() {
-    println!("");
-    if cfg!(debug_assertions) {
-        println!("The default location for StackMuncher code rules in DEBUGGING MODE is `{}` sub-folder of the current working directory.", Config::RULES_FOLDER_NAME_DEBUG);
-    } else if cfg!(target_os = "linux") {
-        println!(
-            "The default location for StackMuncher code rules on Linux is `{}` folder.",
-            Config::RULES_FOLDER_NAME_LINUX
-        );
-    } else if cfg!(target_os = "windows") {
-        println!(
-            "The default location for StackMuncher code rules on Windows is `{}` folder placed next stackmuncher.exe.",
-            Config::RULES_FOLDER_NAME_WIN
-        );
-    }
-    println!();
-    println!("    To specify a different location use `--rules` param followed by a relative or absolute path to the rules folder.");
-    println!("    The latest copy of the rules can be downloaded from https://github.com/stackmuncher/stm repo or https://distro.stackmuncher.com/stm_rules.zip");
-    println!();
-    emit_support_msg();
-}
-
 /// Prints out info on where the reports can be saved
 pub(crate) fn emit_report_dir_msg() {
     println!("");

stackmuncher/src/main.rs

@@ -36,16 +36,6 @@ async fn main() -> Result<(), ()> {
             .to_string_lossy()
     );
 
-    info!(
-        "Code rules folder: {}",
-        config
-            .lib_config
-            .code_rules_dir
-            .absolutize()
-            .expect("Cannot convert config.code_rules_dir to absolute path. It's a bug.")
-            .to_string_lossy()
-    );
-
     #[cfg(debug_assertions)]
     info!("Running in debug mode");
 

stackmuncher_lib/Cargo.toml

@@ -23,6 +23,7 @@ sha2 = "0.9.5"
 bs58 = "0.4.0"
 path-absolutize = "3.0.10"
 flate2 = "1.0"
+rust-embed = { version = "6", features = ["compression"] }
 
 [dev-dependencies]
 tracing-subscriber = "0.2"