rename enum for clarity

Author: tgauth

sshdconfig/src/args.rs

@@ -16,8 +16,8 @@ pub struct Args {
 pub enum Command {
     /// Get default shell, eventually to be used for `sshd_config` and repeatable keywords
     Get {
-        #[clap(short = 'r', long, hide = true)]
-        resource: Resource,
+        #[clap(short = 's', long, hide = true)]
+        setting: Setting,
     },
     /// Set default shell, eventually to be used for `sshd_config` and repeatable keywords
     Set {
@@ -28,8 +28,8 @@ pub enum Command {
     Export,
     Schema {
         // Used to inform which schema to generate
-        #[clap(short = 'r', long, hide = true)]
-        resource: Resource,
+        #[clap(short = 's', long, hide = true)]
+        setting: Setting,
     },
 }
 
@@ -41,7 +41,7 @@ pub struct DefaultShell {
 }
 
 #[derive(Clone, Debug, Eq, PartialEq, ValueEnum)]
-pub enum Resource {
+pub enum Setting {
     SshdConfig,
     WindowsGlobal
 }

sshdconfig/src/get.rs

@@ -4,10 +4,11 @@
 #[cfg(windows)]
 use {
     registry_lib::{config::{Registry, RegistryValueData}, RegistryHelper},
-    crate::args::{DefaultShell, Resource},
+    crate::args::DefaultShell,
     crate::metadata::{DEFAULT_SHELL, DEFAULT_SHELL_CMD_OPTION, DEFAULT_SHELL_ESCAPE_ARGS, REGISTRY_PATH},
 };
 
+use crate::args::Setting;
 use crate::error::SshdConfigError;
 use rust_i18n::t;
 
@@ -16,10 +17,10 @@ use rust_i18n::t;
 /// # Errors
 ///
 /// This function will return an error if the desired settings cannot be retrieved.
-pub fn invoke_get(resource: &Resource) -> Result<(), SshdConfigError> {
-    match *resource {
-        Resource::SshdConfig => Err(SshdConfigError::NotImplemented(t!("get.notImplemented").to_string())),
-        Resource::WindowsGlobal => get_default_shell()
+pub fn invoke_get(setting: &Setting) -> Result<(), SshdConfigError> {
+    match *setting {
+        Setting::SshdConfig => Err(SshdConfigError::NotImplemented(t!("get.notImplemented").to_string())),
+        Setting::WindowsGlobal => get_default_shell()
     }
 }
 

sshdconfig/src/main.rs

@@ -5,7 +5,7 @@ use clap::{Parser};
 use rust_i18n::i18n;
 use schemars::schema_for;
 
-use args::{Args, Command, DefaultShell, Resource};
+use args::{Args, Command, DefaultShell, Setting};
 use export::invoke_export;
 use get::invoke_get;
 use parser::SshdConfigParser;
@@ -27,14 +27,14 @@ fn main() {
 
     let result = match &args.command {
         Command::Export => invoke_export(),
-        Command::Get { resource } => invoke_get(resource),
+        Command::Get { setting } => invoke_get(setting),
         Command::Set { input } => invoke_set(input),
-        Command::Schema { resource } => {
-            let schema = match resource {
-                Resource::SshdConfig => {
+        Command::Schema { setting } => {
+            let schema = match setting {
+                Setting::SshdConfig => {
                     schema_for!(SshdConfigParser)
                 },
-                Resource::WindowsGlobal => {
+                Setting::WindowsGlobal => {
                     schema_for!(DefaultShell)
                 }
             };

sshdconfig/src/set.rs

@@ -67,7 +67,7 @@ fn set_default_shell(shell: Option<String>, cmd_option: Option<String>, escape_a
 
 #[cfg(not(windows))]
 fn set_default_shell(_shell: Option<String>, _cmd_option: Option<String>, _escape_arguments: Option<bool>) -> Result<(), SshdConfigError> {
-    Err(SshdConfigError::InvalidInput(t!("get.windowsOnly")))
+    Err(SshdConfigError::InvalidInput(t!("get.windowsOnly").to_string()))
 }
 
 #[cfg(windows)]

sshdconfig/sshd.dsc.resource.json

@@ -10,7 +10,7 @@
         "executable": "sshdconfig",
         "args": [
             "get",
-            "-r",
+            "-s",
             "windows-global"
         ]
     },
@@ -29,7 +29,7 @@
             "executable": "sshdconfig",
             "args": [
                 "schema",
-                "-r",
+                "-s",
                 "windows-global"
             ]
         }

sshdconfig/sshd_config.dsc.resource.json

@@ -14,7 +14,7 @@
             "executable": "sshdconfig",
             "args": [
                 "schema",
-                "-r",
+                "-s",
                 "sshd-config"
             ]
         }

sshdconfig/tests/defaultshell.tests.ps1

@@ -62,7 +62,7 @@ Describe 'Default Shell Configuration Tests' -Skip:(!$IsWindows) {
             $testShell = "C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe"
             New-ItemProperty -Path $RegistryPath -Name "DefaultShell" -Value $testShell
 
-            $output = sshdconfig get -r windows-global
+            $output = sshdconfig get -s windows-global
             $LASTEXITCODE | Should -Be 0
 
             $result = $output | ConvertFrom-Json
@@ -78,7 +78,7 @@ Describe 'Default Shell Configuration Tests' -Skip:(!$IsWindows) {
             New-ItemProperty -Path $RegistryPath -Name "DefaultShellCommandOption" -Value "/c"
             New-ItemProperty -Path $RegistryPath -Name "DefaultShellEscapeArguments" -Value 0 -Type DWord
 
-            $output = sshdconfig get -r windows-global
+            $output = sshdconfig get -s windows-global
             $LASTEXITCODE | Should -Be 0
 
             $result = $output | ConvertFrom-Json
@@ -88,7 +88,7 @@ Describe 'Default Shell Configuration Tests' -Skip:(!$IsWindows) {
         }
 
         It 'Should handle empty default shell registry values' -Skip:(!$IsWindows) {
-            $output = sshdconfig get -r windows-global
+            $output = sshdconfig get -s windows-global
             $LASTEXITCODE | Should -Be 0
 
             $result = $output | ConvertFrom-Json
@@ -165,7 +165,7 @@ Describe 'Default Shell Configuration Tests' -Skip:(!$IsWindows) {
             sshdconfig set --input $inputJson
             $LASTEXITCODE | Should -Be 0
 
-            $getOutput = sshdconfig get -r windows-global
+            $getOutput = sshdconfig get -s windows-global
             $LASTEXITCODE | Should -Be 0
 
             $retrievedConfig = $getOutput | ConvertFrom-Json
@@ -202,7 +202,7 @@ Describe 'Default Shell Configuration Error Handling on Non-Windows Platforms' -
     }
 
     It 'Should return error for get command' {
-        $out = sshdconfig get -r windows-global 2>&1
+        $out = sshdconfig get -s windows-global 2>&1
         $LASTEXITCODE | Should -Not -Be 0
         $out | Should -BeLike '*not applicable to this platform*'
     }