Improve help text for cloud profiles and correct url/device id valida…

…tion Signed-off-by: James Rhodes <[email protected]>
thin-edge · Dec 13, 2024 · 7cb04c5 · 7cb04c5
1 parent 3409583
commit 7cb04c5
Show file tree

Hide file tree

Showing 6 changed files with 274 additions and 13 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/core/tedge/Cargo.toml b/crates/core/tedge/Cargo.toml
@@ -62,6 +62,7 @@ mockito = { workspace = true }
 mqtt_tests = { workspace = true }
 pem = { workspace = true }
 predicates = { workspace = true }
+rcgen = { workspace = true }
 tedge_test_utils = { workspace = true }
 tempfile = { workspace = true }
 test-case = { workspace = true }

diff --git a/crates/core/tedge/src/cli/common.rs b/crates/core/tedge/src/cli/common.rs
@@ -9,18 +9,21 @@ use tedge_config::ProfileName;
 pub enum CloudArg {
     C8y {
         /// The cloud profile you wish to use
+        ///
         /// [env: TEDGE_CLOUD_PROFILE]
         #[clap(long)]
         profile: Option<ProfileName>,
     },
     Az {
         /// The cloud profile you wish to use
+        ///
         /// [env: TEDGE_CLOUD_PROFILE]
         #[clap(long)]
         profile: Option<ProfileName>,
     },
     Aws {
         /// The cloud profile you wish to use
+        ///
         /// [env: TEDGE_CLOUD_PROFILE]
         #[clap(long)]
         profile: Option<ProfileName>,
@@ -148,4 +151,10 @@ impl MaybeBorrowedCloud<'_> {
             Self::Azure(Some(profile)) => format!("az@{profile}-bridge.conf").into(),
         }
     }
+
+    pub fn profile_name(&self) -> Option<&ProfileName> {
+        match self {
+            Self::Aws(profile) | Self::Azure(profile) | Self::C8y(profile) => profile.as_deref(),
+        }
+    }
 }
diff --git a/crates/core/tedge/src/cli/config/cli.rs b/crates/core/tedge/src/cli/config/cli.rs
@@ -12,7 +12,11 @@ pub enum ConfigCmd {
         /// Configuration key. Run `tedge config list --doc` for available keys
         key: ReadableKey,
 
-        /// Cloud profile
+        /// The cloud profile you wish to use, if accessing a cloud configuration
+        /// (i.e. `c8y.*`, `az.*` or `aws.*`). If you don't wish to use cloud profiles,
+        /// or want to access the default profile, don't supply this.
+        ///
+        /// [env: TEDGE_CLOUD_PROFILE]
         #[clap(long)]
         profile: Option<ProfileName>,
     },
@@ -25,7 +29,11 @@ pub enum ConfigCmd {
         /// Configuration value.
         value: String,
 
-        /// Cloud profile
+        /// The cloud profile you wish to use, if accessing a cloud configuration
+        /// (i.e. `c8y.*`, `az.*` or `aws.*`). If you don't wish to use cloud profiles,
+        /// or want to access the default profile, don't supply this.
+        ///
+        /// [env: TEDGE_CLOUD_PROFILE]
         #[clap(long)]
         profile: Option<ProfileName>,
     },
@@ -35,7 +43,11 @@ pub enum ConfigCmd {
         /// Configuration key. Run `tedge config list --doc` for available keys
         key: WritableKey,
 
-        /// Cloud profile
+        /// The cloud profile you wish to use, if accessing a cloud configuration
+        /// (i.e. `c8y.*`, `az.*` or `aws.*`). If you don't wish to use cloud profiles,
+        /// or want to access the default profile, don't supply this.
+        ///
+        /// [env: TEDGE_CLOUD_PROFILE]
         #[clap(long)]
         profile: Option<ProfileName>,
     },
@@ -48,7 +60,11 @@ pub enum ConfigCmd {
         /// Configuration value.
         value: String,
 
-        /// Cloud profile
+        /// The cloud profile you wish to use, if accessing a cloud configuration
+        /// (i.e. `c8y.*`, `az.*` or `aws.*`). If you don't wish to use cloud profiles,
+        /// or want to access the default profile, don't supply this.
+        ///
+        /// [env: TEDGE_CLOUD_PROFILE]
         #[clap(long)]
         profile: Option<ProfileName>,
     },
@@ -61,8 +77,12 @@ pub enum ConfigCmd {
         /// Configuration value.
         value: String,
 
+        /// The cloud profile you wish to use, if accessing a cloud configuration
+        /// (i.e. `c8y.*`, `az.*` or `aws.*`). If you don't wish to use cloud profiles,
+        /// or want to access the default profile, don't supply this.
+        ///
+        /// [env: TEDGE_CLOUD_PROFILE]
         #[clap(long)]
-        /// Cloud profile
         profile: Option<ProfileName>,
     },