Centralized path.absolute + added reports_dir to config.json

Author: rimutaka

.gitignore

@@ -1,8 +1,7 @@
 /target
-/reports
-.stm_config
+/.reports
+*stm_config*
 Cargo.lock
-stm-report.json
 trace*.txt
 *report*.json
 !samples/*report*.json

README.md

@@ -180,7 +180,7 @@ Example:
 #### Debug settings
 
 * `--log error|warn|info|debug|trace`: the log is written to _stdout_. Defaults to `error` for least verbose output. Redirect the output to a file or _null device_ to completely silence it. E.g. `stackmuncher --log debug >> ~/stm_trace.log`
-* `--reports "path to reports folder"`: a path to an alternative location for saving stack reports. The path can be relative or absolute. Defaults to a platform-specific user-data location.
+* `--reports "path to reports folder"`: a path to an alternative location for saving stack reports. The path can be relative or absolute. Defaults to a platform-specific user-data location. Set once.
 * `--config "path to config folder"`: a path to an alternative location of the config folder. The path can be relative or absolute. Defaults to a platform-specific user-data location.
 
 #### Additional info

stackmuncher/src/app_args.rs

@@ -4,6 +4,7 @@ use regex::Regex;
 use std::env::consts::EXE_SUFFIX;
 use std::str::FromStr;
 use std::{path::PathBuf, process::exit};
+use tracing::debug;
 
 pub(crate) const GIST_ID_REGEX: &str = "[a-f0-9]{32}";
 
@@ -169,8 +170,9 @@ impl AppArgs {
                 exit(1);
             }
 
+            // try to covert to path and expand ~/somepath on Linux to /home/user/...
             match PathBuf::from_str(&project) {
-                Ok(v) => app_args.project = Some(v),
+                Ok(v) => app_args.project = Some(tilde_expand(v)),
                 Err(_) => {
                     eprintln!(
                         "STACKMUNCHER CONFIG ERROR: `{}` is not a valid path for `--project`. Omit that param to use the current folder or provide a valid path to where the project is located (absolute or relative).",
@@ -193,8 +195,10 @@ impl AppArgs {
                 exit(1);
             }
 
-            match PathBuf::from_str(&reports) {
-                Ok(v) => app_args.reports = Some(v),
+            // try to convert to path
+            let reports_dir = match PathBuf::from_str(&reports) {
+                // expand ~/somepath on Linux to /home/user/...
+                Ok(v) => tilde_expand(v),
                 Err(_) => {
                     eprintln!(
                         "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).",
@@ -203,7 +207,10 @@ impl AppArgs {
                     help::emit_report_dir_msg();
                     exit(1);
                 }
-            }
+            };
+
+            // this should be an OK value that will be validated further downstream
+            app_args.reports = Some(reports_dir);
         };
 
         // config folder
@@ -218,7 +225,7 @@ impl AppArgs {
             }
 
             match PathBuf::from_str(&config_folder) {
-                Ok(v) => app_args.config = Some(v),
+                Ok(v) => app_args.config = Some(tilde_expand(v)),
                 Err(_) => {
                     eprintln!(
                         "STACKMUNCHER CONFIG ERROR: `{}` is not a valid path for `--config`. Omit it to use the default location or provide a valid path to where your encryption keys and config details should be stored (absolute or relative)",
@@ -292,3 +299,53 @@ fn string_to_log_level(s: String) -> tracing::Level {
         }
     }
 }
+
+/// Replaces `~` in Linux paths with the full path to the home directory.
+/// E.g. `~/rust/stm_app` -> `/home/ubuntu/rust/stm_app`
+fn tilde_expand(path: PathBuf) -> PathBuf {
+    // check if there is a ~ at all
+    if !path.starts_with("~") {
+        return path;
+    }
+
+    // is there a home directory?
+    let home_dir = match std::env::var("HOME") {
+        Ok(v) => v,
+        Err(e) => {
+            eprintln!("STACKMUNCHER CONFIG ERROR: Cannot get the name of HOME directory due to {}", e);
+            eprintln!();
+            eprintln!("     Try replacing ~ with an absolute path.");
+            eprintln!();
+            help::emit_usage_msg();
+            exit(1);
+        }
+    };
+
+    debug!("Home dir: {}", home_dir);
+
+    let home_dir = match PathBuf::from_str(&home_dir) {
+        Err(_) => {
+            eprintln!("STACKMUNCHER CONFIG ERROR: $HOME has invalid home directory path: {}", home_dir);
+            eprintln!();
+            eprintln!("     Try replacing ~ with an absolute path.");
+            eprintln!();
+            help::emit_usage_msg();
+            exit(1);
+        }
+        Ok(v) => {
+            if path.starts_with("~/") {
+                v.join(&path.to_string_lossy()[2..])
+            } else {
+                eprintln!("STACKMUNCHER CONFIG ERROR: cannot expand ~ shortcut");
+                eprintln!();
+                eprintln!("     Try replacing ~ with an absolute path.");
+                eprintln!();
+                help::emit_usage_msg();
+                exit(1);
+            }
+        }
+    };
+
+    debug!("Expanded {} -> {}", path.to_string_lossy(), home_dir.to_string_lossy());
+    home_dir
+}

stackmuncher/src/cmd_config.rs

@@ -3,7 +3,6 @@ use crate::help;
 use crate::signing::ReportSignature;
 use hyper::{Client, Request};
 use hyper_rustls::HttpsConnector;
-use path_absolutize::{self, Absolutize};
 use ring::signature::{self, Ed25519KeyPair, KeyPair};
 use serde::Deserialize;
 use serde_json::Value;
@@ -12,6 +11,11 @@ use tracing::{debug, error, info, warn};
 /// A "well-known" string used as the content to be signed for GH verification. The signature is uploaded to a Gist.
 const GH_VERIFICATION_STRING_TO_SIGN: &str = "stackmuncher";
 
+#[cfg(not(target_os = "windows"))]
+const PATH_SEPARATOR: &str = "/";
+#[cfg(target_os = "windows")]
+const PATH_SEPARATOR: &str = "\\";
+
 /// A stripped-down representation of GH GetGist API response: Owner details.
 #[derive(Deserialize)]
 pub(crate) struct GistOwner {
@@ -55,18 +59,15 @@ pub(crate) async fn view_config(config: AppConfig) {
     // prepare values needed in println!() macros to prevent line wrapping in the code
     let pub_key = ReportSignature::get_public_key(&config.user_key_pair);
     let reports = config
-        .lib_config
-        .report_dir
+        .reports_dir
         .as_ref()
-        .expect("config.report_dir is not set. It's a bug.")
-        .absolutize()
-        .expect("Cannot convert config.report_dir to absolute path. It's a bug.")
+        .expect("config.reports_dir is not set. It's a bug.")
         .to_string_lossy()
         .to_string();
     let config_file = config
         .config_file_path
-        .absolutize()
-        .expect("Cannot convert config.config_file_path to absolute path. It's a bug.")
+        .parent()
+        .expect("config_file_path has no parent. It's a bug.")
         .to_string_lossy()
         .to_string();
     let exe_file = match std::env::current_exe() {
@@ -95,8 +96,8 @@ pub(crate) async fn view_config(config: AppConfig) {
     println!("    Public profile:    {}", public_profile);
     println!("    GitHub validation: {}", github_validation);
     println!();
-    println!("    Stack reports: {}", reports);
-    println!("    Config folder: {}", config_file);
+    println!("    Stack reports: {}{}", reports, PATH_SEPARATOR);
+    println!("    Config folder: {}{}", config_file, PATH_SEPARATOR);
     println!("    Executable:    {}", exe_file);
     println!();
 }

stackmuncher/src/cmd_munch.rs

@@ -3,7 +3,6 @@ use crate::help;
 use crate::signing::ReportSignature;
 use crate::submission::submit_report;
 use futures::stream::{FuturesUnordered, StreamExt};
-use path_absolutize::{self, Absolutize};
 use stackmuncher_lib::{code_rules::CodeRules, config::Config, git, report::Report, utils::hash_str_sha1};
 use std::path::Path;
 use tracing::{debug, info, warn};
@@ -18,7 +17,7 @@ pub(crate) async fn run(config: AppConfig) -> Result<(), ()> {
     let report_dir = Path::new(
         config
             .lib_config
-            .report_dir
+            .project_report_dir
             .as_ref()
             .expect("Cannot unwrap config.report_dir. It's a bug."),
     );
@@ -43,10 +42,7 @@ pub(crate) async fn run(config: AppConfig) -> Result<(), ()> {
         None => {
             // there were no changes since the previous report - it can be reused as-is
             info!("Done in {}ms", instant.elapsed().as_millis());
-            // do not print the end user msg if the logging is enabled
-            if config.lib_config.log_level == tracing::Level::ERROR {
-                println!("No new commits since the last run.");
-            }
+            println!("    No new commits since the last run.");
             cached_project_report.expect("Cannot unwrap cached report. It's a bug.")
         }
         Some(v) => {
@@ -56,17 +52,6 @@ pub(crate) async fn run(config: AppConfig) -> Result<(), ()> {
         }
     };
 
-    // print the location of the reports
-    if config.lib_config.log_level == tracing::Level::ERROR {
-        println!(
-            "   Stack report:         {}",
-            report_dir
-                .absolutize()
-                .expect("Cannot convert report_dir to absolute path. It's a bug.")
-                .to_string_lossy()
-        );
-    }
-
     info!("Contributor reports requested for: {:?}", config.lib_config.git_identities);
 
     // check if there are multiple contributors and generate individual reports
@@ -189,10 +174,7 @@ pub(crate) async fn run(config: AppConfig) -> Result<(), ()> {
                 // check if the submission to the directory should go ahead
                 if config.dryrun {
                     // a dry-run was requested by the user
-                    if config.lib_config.log_level == tracing::Level::ERROR {
-                        println!("Directory Profile update skipped: `--dryrun` flag.");
-                    }
-                    warn!("Skipping report submission: `--dryrun` flag.")
+                    println!("    Directory Profile update skipped: `--dryrun` flag.");
                 } else {
                     if first_run {
                         info!("No report submission on the first run");
@@ -215,6 +197,8 @@ pub(crate) async fn run(config: AppConfig) -> Result<(), ()> {
         }
     }
 
+    // print the location of the reports
+    println!("    Stack reports:        {}", report_dir.to_string_lossy());
     info!("Repo processed in {}ms", instant.elapsed().as_millis());
 
     Ok(())