Merge pull request #958 from tgauth/add-sshdconfig-tracing

sshdconfig: add tracing and update constants

Author: SteveL-MSFT

sshdconfig/Cargo.lock

@@ -17,13 +17,14 @@ lto = true
 atty = { version = "0.2" }
 chrono = { version = "0.4" }
 clap = { version = "4.5", features = ["derive"] }
+crossterm = { version = "0.27" }
 rust-i18n = { version = "3.1" }
 schemars = "0.8"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = { version = "1.0", features = ["preserve_order"] }
 thiserror = { version = "2.0" }
 tracing = "0.1.37"
-tracing-subscriber = "0.3.17"
+tracing-subscriber = { version = "0.3.17", features = ["ansi", "env-filter", "json"] }
 tree-sitter = "0.25"
 tree-sitter-rust = "0.24"
 tree-sitter-ssh-server-config = { path = "../tree-sitter-ssh-server-config" }

sshdconfig/Cargo.toml

@@ -14,17 +14,18 @@ parseInt = "Parse Integer"
 registry = "Registry"
 
 [get]
+debugSetting = "Get setting:"
 defaultShellCmdOptionMustBeString = "cmdOption must be a string"
 defaultShellEscapeArgsMustBe0Or1 = "'%{input}' must be a 0 or 1"
 defaultShellEscapeArgsMustBeDWord = "escapeArguments must be a DWord"
 defaultShellMustBeString = "shell must be a string"
 notImplemented = "get not yet implemented for Microsoft.OpenSSH.SSHD/sshd_config"
 windowsOnly = "Microsoft.OpenSSH.SSHD/Windows is only applicable to Windows"
 
-[set]
-failedToParseInput = "failed to parse input as DefaultShell with error: '%{error}'"
-shellPathDoesNotExist = "shell path does not exist: '%{shell}'"
-shellPathMustNotBeRelative = "shell path must not be relative"
+[main]
+export = "Export"
+schema = "Schema command:"
+set = "Set command: '%{input}'"
 
 [parser]
 failedToParse = "failed to parse: '%{input}'"
@@ -33,13 +34,22 @@ failedToParseChildNode = "failed to parse child node: '%{input}'"
 failedToParseNode = "failed to parse '%{input}'"
 failedToParseRoot = "failed to parse root: '%{input}'"
 invalidConfig = "invalid config: '%{input}'"
+invalidMultiArgNode = "multi-arg node '%{input}' is not valid"
 invalidValue = "operator is an invalid value for node"
 keyNotFound = "key '%{key}' not found"
 keyNotRepeatable = "key '%{key}' is not repeatable"
-missingKeyInChildNode = "missing key in child node: '%{input}'"
+keywordDebug = "Parsing keyword: '%{text}'"
 missingValueInChildNode = "missing value in child node: '%{input}'"
+missingKeyInChildNode = "missing key in child node: '%{input}'"
+valueDebug = "Parsed argument value:"
 unknownNode = "unknown node: '%{kind}'"
 unknownNodeType = "unknown node type: '%{node}'"
 
+[set]
+failedToParseInput = "failed to parse input as DefaultShell with error: '%{error}'"
+shellPathDoesNotExist = "shell path does not exist: '%{shell}'"
+shellPathMustNotBeRelative = "shell path must not be relative"
+
 [util]
 sshdElevation = "elevated security context required"
+tracingInitError = "Failed to initialize tracing"

sshdconfig/locales/en-us.toml

@@ -8,16 +8,19 @@ use {
     crate::metadata::windows::{DEFAULT_SHELL, DEFAULT_SHELL_CMD_OPTION, DEFAULT_SHELL_ESCAPE_ARGS, REGISTRY_PATH},
 };
 
+use rust_i18n::t;
+use tracing::debug;
+
 use crate::args::Setting;
 use crate::error::SshdConfigError;
-use rust_i18n::t;
 
 /// Invoke the get command.
 ///
 /// # Errors
 ///
 /// This function will return an error if the desired settings cannot be retrieved.
 pub fn invoke_get(setting: &Setting) -> Result<(), SshdConfigError> {
+    debug!("{}: {:?}", t!("get.debugSetting").to_string(), setting);
     match *setting {
         Setting::SshdConfig => Err(SshdConfigError::NotImplemented(t!("get.notImplemented").to_string())),
         Setting::WindowsGlobal => get_default_shell()

sshdconfig/src/get.rs

@@ -2,14 +2,17 @@
 // Licensed under the MIT License.
 
 use clap::{Parser};
-use rust_i18n::i18n;
+use rust_i18n::{i18n, t};
 use schemars::schema_for;
+use std::process::exit;
+use tracing::{debug, error};
 
 use args::{Args, Command, DefaultShell, Setting};
 use export::invoke_export;
 use get::invoke_get;
 use parser::SshdConfigParser;
 use set::invoke_set;
+use util::enable_tracing;
 
 mod args;
 mod error;
@@ -22,14 +25,24 @@ mod util;
 
 i18n!("locales", fallback = "en-us");
 
+const EXIT_SUCCESS: i32 = 0;
+const EXIT_FAILURE: i32 = 1;
+
 fn main() {
+    enable_tracing();
+
     let args = Args::parse();
 
     let result = match &args.command {
-        Command::Export => invoke_export(),
-        Command::Get { setting } => invoke_get(setting),
-        Command::Set { input } => invoke_set(input),
+        Command::Export => {
+            debug!("{}", t!("main.export").to_string());
+            invoke_export()
+        },
+        Command::Get { setting } => {
+            invoke_get(setting)
+        },
         Command::Schema { setting } => {
+            debug!("{}; {:?}", t!("main.schema").to_string(), setting);
             let schema = match setting {
                 Setting::SshdConfig => {
                     schema_for!(SshdConfigParser)
@@ -40,11 +53,17 @@ fn main() {
             };
             println!("{}", serde_json::to_string(&schema).unwrap());
             Ok(())
-        }
+        },
+        Command::Set { input } => {
+            debug!("{}", t!("main.set", input = input).to_string());
+            invoke_set(input)
+        },
     };
 
     if let Err(e) = result {
-        eprintln!("{e}");
-        std::process::exit(1);
+        error!("{e}");
+        exit(EXIT_FAILURE);
     }
+
+    exit(EXIT_SUCCESS);
 }