feat(dre): Add support for forum post links for version elect proposa…

…ls (#942)
dfinity · Sep 26, 2024 · fb3e145 · fb3e145
1 parent 480ac78
commit fb3e145
Show file tree

Hide file tree

Showing 48 changed files with 93 additions and 71 deletions.
diff --git a/rs/cli/src/commands/api_boundary_nodes/add.rs b/rs/cli/src/commands/api_boundary_nodes/add.rs
@@ -47,5 +47,5 @@ impl ExecutableCommand for Add {
         Ok(())
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/api_boundary_nodes/mod.rs b/rs/cli/src/commands/api_boundary_nodes/mod.rs
@@ -26,7 +26,7 @@ impl ExecutableCommand for ApiBoundaryNodes {
         self.subcommand.execute(ctx).await
     }
 
-    fn validate(&self, cmd: &mut clap::Command) {
-        self.subcommand.validate(cmd)
+    fn validate(&self, args: &crate::commands::Args, cmd: &mut clap::Command) {
+        self.subcommand.validate(args, cmd)
     }
 }
diff --git a/rs/cli/src/commands/api_boundary_nodes/remove.rs b/rs/cli/src/commands/api_boundary_nodes/remove.rs
@@ -39,5 +39,5 @@ impl ExecutableCommand for Remove {
         Ok(())
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/api_boundary_nodes/update.rs b/rs/cli/src/commands/api_boundary_nodes/update.rs
@@ -46,5 +46,5 @@ impl ExecutableCommand for Update {
         Ok(())
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/completions.rs b/rs/cli/src/commands/completions.rs
@@ -14,7 +14,7 @@ impl ExecutableCommand for Completions {
         super::AuthRequirement::Anonymous
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 
     async fn execute(&self, _ctx: crate::ctx::DreContext) -> anyhow::Result<()> {
         let mut command = super::Args::command();

diff --git a/rs/cli/src/commands/der_to_principal.rs b/rs/cli/src/commands/der_to_principal.rs
@@ -21,5 +21,5 @@ impl ExecutableCommand for DerToPrincipal {
         Ok(())
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/firewall.rs b/rs/cli/src/commands/firewall.rs
@@ -114,7 +114,7 @@ impl ExecutableCommand for Firewall {
         }
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
 
 impl Firewall {

diff --git a/rs/cli/src/commands/get.rs b/rs/cli/src/commands/get.rs
@@ -21,5 +21,5 @@ impl ExecutableCommand for Get {
         Ok(())
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/heal.rs b/rs/cli/src/commands/heal.rs
@@ -15,5 +15,5 @@ impl ExecutableCommand for Heal {
         runner.network_heal(ctx.forum_post_link()).await
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/hostos/mod.rs b/rs/cli/src/commands/hostos/mod.rs
@@ -24,7 +24,7 @@ impl ExecutableCommand for HostOs {
         self.subcommand.execute(ctx).await
     }
 
-    fn validate(&self, cmd: &mut clap::Command) {
-        self.subcommand.validate(cmd)
+    fn validate(&self, args: &crate::commands::Args, cmd: &mut clap::Command) {
+        self.subcommand.validate(args, cmd)
     }
 }
diff --git a/rs/cli/src/commands/hostos/rollout.rs b/rs/cli/src/commands/hostos/rollout.rs
@@ -26,5 +26,5 @@ impl ExecutableCommand for Rollout {
             .await
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/hostos/rollout_from_node_group.rs b/rs/cli/src/commands/hostos/rollout_from_node_group.rs
@@ -95,5 +95,5 @@ impl ExecutableCommand for RolloutFromNodeGroup {
         Ok(())
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/mod.rs b/rs/cli/src/commands/mod.rs
@@ -142,7 +142,7 @@ impl TryFrom<PathBuf> for AuthOpts {
 
 #[derive(Parser, Debug)]
 #[clap(version = env!("CARGO_PKG_VERSION"), about, author)]
-pub(crate) struct Args {
+pub struct Args {
     #[clap(flatten)]
     pub(crate) auth_opts: AuthOpts,
 
@@ -214,8 +214,14 @@ impl ExecutableCommand for Args {
         self.subcommands.execute(ctx).await
     }
 
-    fn validate(&self, cmd: &mut Command) {
-        self.subcommands.validate(cmd)
+    /// Validate the command line arguments. You can return an error with something like:
+    /// ```rust
+    /// if args.neuron_id.is_none() {
+    ///    cmd.error(ErrorKind::MissingRequiredArgument, "Neuron ID is required for this command.")).exit();
+    /// }
+    /// ```
+    fn validate(&self, args: &crate::commands::Args, cmd: &mut Command) {
+        self.subcommands.validate(args, cmd)
     }
 }
 
@@ -242,9 +248,9 @@ macro_rules! impl_executable_command_for_enums {
                 }
             }
 
-            fn validate(&self, cmd: &mut Command) {
+            fn validate(&self, args: &crate::commands::Args, cmd: &mut Command) {
                 match &self {
-                    $(Subcommands::$var(variant) => variant.validate(cmd),)*
+                    $(Subcommands::$var(variant) => variant.validate(args, cmd),)*
                 }
             }
         }
@@ -257,7 +263,7 @@ impl_executable_command_for_enums! { DerToPrincipal, Heal, Subnet, Get, Propose,
 pub trait ExecutableCommand {
     fn require_auth(&self) -> AuthRequirement;
 
-    fn validate(&self, cmd: &mut Command);
+    fn validate(&self, args: &crate::commands::Args, cmd: &mut Command);
 
     fn execute(&self, ctx: DreContext) -> impl std::future::Future<Output = anyhow::Result<()>>;
 }

diff --git a/rs/cli/src/commands/neuron/balance.rs b/rs/cli/src/commands/neuron/balance.rs
@@ -18,7 +18,7 @@ impl ExecutableCommand for Balance {
         }
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 
     async fn execute(&self, ctx: crate::ctx::DreContext) -> anyhow::Result<()> {
         let governance = GovernanceCanisterWrapper::from(ctx.create_ic_agent_canister_client(None)?);

diff --git a/rs/cli/src/commands/neuron/mod.rs b/rs/cli/src/commands/neuron/mod.rs
@@ -22,8 +22,8 @@ impl ExecutableCommand for Neuron {
         self.subcommand.require_auth()
     }
 
-    fn validate(&self, cmd: &mut Command) {
-        self.subcommand.validate(cmd)
+    fn validate(&self, args: &crate::commands::Args, cmd: &mut Command) {
+        self.subcommand.validate(args, cmd)
     }
 
     async fn execute(&self, ctx: DreContext) -> anyhow::Result<()> {

diff --git a/rs/cli/src/commands/neuron/refresh.rs b/rs/cli/src/commands/neuron/refresh.rs
@@ -11,7 +11,7 @@ impl ExecutableCommand for Refresh {
         crate::commands::AuthRequirement::Neuron
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 
     async fn execute(&self, ctx: crate::ctx::DreContext) -> anyhow::Result<()> {
         let governance_canister = GovernanceCanisterWrapper::from(ctx.create_ic_agent_canister_client(None)?);

diff --git a/rs/cli/src/commands/neuron/top_up.rs b/rs/cli/src/commands/neuron/top_up.rs
@@ -12,7 +12,7 @@ impl ExecutableCommand for TopUp {
         crate::commands::AuthRequirement::Neuron
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 
     async fn execute(&self, ctx: crate::ctx::DreContext) -> anyhow::Result<()> {
         let governance = GovernanceCanisterWrapper::from(ctx.create_ic_agent_canister_client(None)?);

diff --git a/rs/cli/src/commands/node_metrics.rs b/rs/cli/src/commands/node_metrics.rs
@@ -4,7 +4,6 @@ use std::{
     sync::{Arc, Mutex},
 };
 
-use anyhow::Ok;
 use clap::{error::ErrorKind, Args};
 use ic_canisters::{
     management::{NodeMetricsHistoryResponse, WalletCanisterWrapper},
@@ -145,7 +144,7 @@ impl ExecutableCommand for NodeMetrics {
         Ok(())
     }
 
-    fn validate(&self, cmd: &mut clap::Command) {
+    fn validate(&self, _args: &crate::commands::Args, cmd: &mut clap::Command) {
         if self.trustworthy && self.wallet.is_none() {
             cmd.error(ErrorKind::MissingRequiredArgument, "Wallet is required for fetching trustworthy metrics.")
                 .exit();

diff --git a/rs/cli/src/commands/nodes/mod.rs b/rs/cli/src/commands/nodes/mod.rs
@@ -21,7 +21,7 @@ impl ExecutableCommand for Nodes {
         self.subcommand.execute(ctx).await
     }
 
-    fn validate(&self, cmd: &mut clap::Command) {
-        self.subcommand.validate(cmd)
+    fn validate(&self, args: &crate::commands::Args, cmd: &mut clap::Command) {
+        self.subcommand.validate(args, cmd)
     }
 }
diff --git a/rs/cli/src/commands/nodes/remove.rs b/rs/cli/src/commands/nodes/remove.rs
@@ -44,10 +44,10 @@ impl ExecutableCommand for Remove {
             .await
     }
 
-    fn validate(&self, cmd: &mut clap::Command) {
+    fn validate(&self, _args: &crate::commands::Args, cmd: &mut clap::Command) {
         if self.motivation.is_none() && !self.extra_nodes_filter.is_empty() {
             cmd.error(ErrorKind::MissingRequiredArgument, "Required argument motivation not found")
-                .exit();
+                .exit()
         }
     }
 }
diff --git a/rs/cli/src/commands/proposals/analyze.rs b/rs/cli/src/commands/proposals/analyze.rs
@@ -42,5 +42,5 @@ impl ExecutableCommand for Analyze {
         }
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/proposals/filter.rs b/rs/cli/src/commands/proposals/filter.rs
@@ -309,5 +309,5 @@ impl ExecutableCommand for Filter {
         Ok(())
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/proposals/get.rs b/rs/cli/src/commands/proposals/get.rs
@@ -21,5 +21,5 @@ impl ExecutableCommand for Get {
         Ok(())
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/proposals/list.rs b/rs/cli/src/commands/proposals/list.rs
@@ -89,5 +89,5 @@ impl ExecutableCommand for List {
         Ok(())
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/proposals/mod.rs b/rs/cli/src/commands/proposals/mod.rs
@@ -73,8 +73,8 @@ impl ExecutableCommand for Proposals {
         self.subcommand.execute(ctx).await
     }
 
-    fn validate(&self, cmd: &mut clap::Command) {
-        self.subcommand.validate(cmd)
+    fn validate(&self, args: &crate::commands::Args, cmd: &mut clap::Command) {
+        self.subcommand.validate(args, cmd)
     }
 }
 

diff --git a/rs/cli/src/commands/proposals/pending.rs b/rs/cli/src/commands/proposals/pending.rs
@@ -21,5 +21,5 @@ impl ExecutableCommand for Pending {
         Ok(())
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/propose.rs b/rs/cli/src/commands/propose.rs
@@ -21,5 +21,5 @@ impl ExecutableCommand for Propose {
         Ok(())
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/qualify/execute.rs b/rs/cli/src/commands/qualify/execute.rs
@@ -44,7 +44,7 @@ impl ExecutableCommand for Execute {
         crate::commands::AuthRequirement::Neuron
     }
 
-    fn validate(&self, cmd: &mut clap::Command) {
+    fn validate(&self, _args: &crate::commands::Args, cmd: &mut clap::Command) {
         if self.artifacts.is_some() && self.grafana_url.is_none() {
             cmd.error(
                 clap::error::ErrorKind::InvalidValue,

diff --git a/rs/cli/src/commands/qualify/list.rs b/rs/cli/src/commands/qualify/list.rs
@@ -15,7 +15,7 @@ impl ExecutableCommand for List {
         crate::commands::AuthRequirement::Anonymous
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 
     async fn execute(&self, ctx: crate::ctx::DreContext) -> anyhow::Result<()> {
         let qualification_executor = QualificationExecutorBuilder::new(ctx)

diff --git a/rs/cli/src/commands/qualify/mod.rs b/rs/cli/src/commands/qualify/mod.rs
@@ -20,8 +20,8 @@ impl ExecutableCommand for Qualify {
         self.subcommand.require_auth()
     }
 
-    fn validate(&self, cmd: &mut clap::Command) {
-        self.subcommand.validate(cmd)
+    fn validate(&self, args: &crate::commands::Args, cmd: &mut clap::Command) {
+        self.subcommand.validate(args, cmd)
     }
 
     async fn execute(&self, ctx: crate::ctx::DreContext) -> anyhow::Result<()> {

diff --git a/rs/cli/src/commands/registry.rs b/rs/cli/src/commands/registry.rs
@@ -103,7 +103,7 @@ impl ExecutableCommand for Registry {
         Ok(())
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
 
 impl Registry {

diff --git a/rs/cli/src/commands/subnet/create.rs b/rs/cli/src/commands/subnet/create.rs
@@ -69,7 +69,7 @@ impl ExecutableCommand for Create {
             .await
     }
 
-    fn validate(&self, cmd: &mut clap::Command) {
+    fn validate(&self, _args: &crate::commands::Args, cmd: &mut clap::Command) {
         if self.motivation.is_none() && !self.help_other_args {
             cmd.error(
                 ErrorKind::MissingRequiredArgument,

diff --git a/rs/cli/src/commands/subnet/deploy.rs b/rs/cli/src/commands/subnet/deploy.rs
@@ -24,5 +24,5 @@ impl ExecutableCommand for Deploy {
         runner.deploy(&self.id, &self.version, ctx.forum_post_link()).await
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/subnet/mod.rs b/rs/cli/src/commands/subnet/mod.rs
@@ -32,7 +32,7 @@ impl ExecutableCommand for Subnet {
         self.subcommand.execute(ctx).await
     }
 
-    fn validate(&self, cmd: &mut clap::Command) {
-        self.subcommand.validate(cmd)
+    fn validate(&self, args: &crate::commands::Args, cmd: &mut clap::Command) {
+        self.subcommand.validate(args, cmd)
     }
 }
diff --git a/rs/cli/src/commands/subnet/replace.rs b/rs/cli/src/commands/subnet/replace.rs
@@ -70,22 +70,22 @@ impl ExecutableCommand for Replace {
         runner.propose_subnet_change(subnet_change_response, ctx.forum_post_link()).await
     }
 
-    fn validate(&self, cmd: &mut clap::Command) {
+    fn validate(&self, _args: &crate::commands::Args, cmd: &mut clap::Command) {
         if !self.nodes.is_empty() && self.id.is_some() {
             cmd.error(
                 ErrorKind::ArgumentConflict,
                 "Both subnet id and a list of nodes to replace are provided. Only one of the two is allowed.",
             )
-            .exit();
+            .exit()
         } else if self.nodes.is_empty() && self.id.is_none() {
             cmd.error(
                 ErrorKind::MissingRequiredArgument,
                 "Specify either a subnet id or a list of nodes to replace",
             )
-            .exit();
+            .exit()
         } else if !self.nodes.is_empty() && self.motivation.is_none() {
             cmd.error(ErrorKind::MissingRequiredArgument, "Required argument motivation not found")
-                .exit();
+                .exit()
         }
     }
 }
diff --git a/rs/cli/src/commands/subnet/rescue.rs b/rs/cli/src/commands/subnet/rescue.rs
@@ -25,5 +25,5 @@ impl ExecutableCommand for Rescue {
         runner.subnet_rescue(&self.id, self.keep_nodes.clone(), ctx.forum_post_link()).await
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/subnet/resize.rs b/rs/cli/src/commands/subnet/resize.rs
@@ -64,5 +64,5 @@ impl ExecutableCommand for Resize {
         runner.propose_subnet_change(subnet_change_response, ctx.forum_post_link()).await
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }
diff --git a/rs/cli/src/commands/subnet/whatif.rs b/rs/cli/src/commands/subnet/whatif.rs
@@ -42,5 +42,5 @@ impl ExecutableCommand for WhatifDecentralization {
             .await
     }
 
-    fn validate(&self, _cmd: &mut clap::Command) {}
+    fn validate(&self, _args: &crate::commands::Args, _cmd: &mut clap::Command) {}
 }