factor out CheckConfigOpts

Author: EverlastingBugstopper

crates/rover-client/src/shared/check_response.rs

@@ -6,7 +6,7 @@ use crate::shared::GraphRef;
 use crate::RoverClientError;
 
 use prettytable::format::consts::FORMAT_BOX_CHARS;
-use serde::Serialize;
+use serde::{Deserialize, Serialize};
 
 use prettytable::{cell, row, Table};
 use serde_json::{json, Value};
@@ -162,7 +162,7 @@ pub struct CheckConfig {
     pub validation_period: Option<ValidationPeriod>,
 }
 
-#[derive(Debug, PartialEq, Eq, Serialize, Clone)]
+#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, Clone)]
 pub struct ValidationPeriod {
     pub from: Period,
     pub to: Period,
@@ -187,7 +187,7 @@ impl FromStr for ValidationPeriod {
     }
 }
 
-#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
 pub enum Period {
     Now,
     Past(i64),

src/command/fed2/supergraph/compose.rs

@@ -1,9 +1,12 @@
-use crate::utils::{
-    client::StudioClientConfig,
-    parsers::{parse_file_descriptor, FileDescriptorType},
-};
 use crate::Suggestion;
 use crate::{anyhow, command::RoverOutput, error::RoverError, Result};
+use crate::{
+    options::ProfileOpt,
+    utils::{
+        client::StudioClientConfig,
+        parsers::{parse_file_descriptor, FileDescriptorType},
+    },
+};
 
 use serde::Serialize;
 use structopt::StructOpt;
@@ -15,10 +18,9 @@ pub struct Compose {
     #[serde(skip_serializing)]
     supergraph_yaml: FileDescriptorType,
 
-    /// Name of configuration profile to use
-    #[structopt(long = "profile", default_value = "default")]
-    #[serde(skip_serializing)]
-    _profile_name: String,
+    #[structopt(flatten)]
+    #[allow(unused)]
+    profile: ProfileOpt,
 }
 
 impl Compose {

src/command/graph/check.rs

@@ -2,12 +2,11 @@ use serde::Serialize;
 use structopt::StructOpt;
 
 use rover_client::operations::graph::check::{self, GraphCheckInput};
-use rover_client::shared::{CheckConfig, GitContext, ValidationPeriod};
+use rover_client::shared::{CheckConfig, GitContext};
 
 use crate::command::RoverOutput;
-use crate::options::{GraphRefOpt, ProfileOpt, SchemaOpt};
+use crate::options::{CheckConfigOpts, GraphRefOpt, ProfileOpt, SchemaOpt};
 use crate::utils::client::StudioClientConfig;
-use crate::utils::parsers::{parse_query_count_threshold, parse_query_percentage_threshold};
 use crate::Result;
 
 #[derive(Debug, Serialize, StructOpt)]
@@ -22,20 +21,8 @@ pub struct Check {
     #[serde(skip_serializing)]
     schema: SchemaOpt,
 
-    /// The minimum number of times a query or mutation must have been executed
-    /// in order to be considered in the check operation
-    #[structopt(long, parse(try_from_str = parse_query_count_threshold))]
-    query_count_threshold: Option<i64>,
-
-    /// Minimum percentage of times a query or mutation must have been executed
-    /// in the time window, relative to total request count, for it to be
-    /// considered in the check. Valid numbers are in the range 0 <= x <= 100
-    #[structopt(long, parse(try_from_str = parse_query_percentage_threshold))]
-    query_percentage_threshold: Option<f64>,
-
-    /// Size of the time window with which to validate schema against (i.e "24h" or "1w 2d 5h")
-    #[structopt(long)]
-    validation_period: Option<ValidationPeriod>,
+    #[structopt(flatten)]
+    config: CheckConfigOpts,
 }
 
 impl Check {
@@ -60,9 +47,9 @@ impl Check {
                 proposed_schema,
                 git_context,
                 config: CheckConfig {
-                    query_count_threshold: self.query_count_threshold,
-                    query_count_threshold_percentage: self.query_percentage_threshold,
-                    validation_period: self.validation_period.clone(),
+                    query_count_threshold: self.config.query_count_threshold,
+                    query_count_threshold_percentage: self.config.query_percentage_threshold,
+                    validation_period: self.config.validation_period.clone(),
                 },
             },
             &client,

src/command/subgraph/check.rs

@@ -2,12 +2,11 @@ use serde::Serialize;
 use structopt::StructOpt;
 
 use rover_client::operations::subgraph::check::{self, SubgraphCheckInput};
-use rover_client::shared::{CheckConfig, GitContext, ValidationPeriod};
+use rover_client::shared::{CheckConfig, GitContext};
 
 use crate::command::RoverOutput;
-use crate::options::{GraphRefOpt, ProfileOpt, SchemaOpt, SubgraphOpt};
+use crate::options::{CheckConfigOpts, GraphRefOpt, ProfileOpt, SchemaOpt, SubgraphOpt};
 use crate::utils::client::StudioClientConfig;
-use crate::utils::parsers::{parse_query_count_threshold, parse_query_percentage_threshold};
 use crate::Result;
 
 #[derive(Debug, Serialize, StructOpt)]
@@ -25,20 +24,8 @@ pub struct Check {
     #[serde(skip_serializing)]
     schema: SchemaOpt,
 
-    /// The minimum number of times a query or mutation must have been executed
-    /// in order to be considered in the check operation
-    #[structopt(long, parse(try_from_str = parse_query_count_threshold))]
-    query_count_threshold: Option<i64>,
-
-    /// Minimum percentage of times a query or mutation must have been executed
-    /// in the time window, relative to total request count, for it to be
-    /// considered in the check. Valid numbers are in the range 0 <= x <= 100
-    #[structopt(long, parse(try_from_str = parse_query_percentage_threshold))]
-    query_percentage_threshold: Option<f64>,
-
-    /// Size of the time window with which to validate schema against (i.e "24h" or "1w 2d 5h")
-    #[structopt(long)]
-    validation_period: Option<ValidationPeriod>,
+    #[structopt(flatten)]
+    config: CheckConfigOpts,
 }
 
 impl Check {
@@ -65,9 +52,9 @@ impl Check {
                 subgraph: self.subgraph.subgraph_name.clone(),
                 git_context,
                 config: CheckConfig {
-                    query_count_threshold: self.query_count_threshold,
-                    query_count_threshold_percentage: self.query_percentage_threshold,
-                    validation_period: self.validation_period.clone(),
+                    query_count_threshold: self.config.query_count_threshold,
+                    query_count_threshold_percentage: self.config.query_percentage_threshold,
+                    validation_period: self.config.validation_period.clone(),
                 },
             },
             &client,

src/options/check.rs

@@ -0,0 +1,46 @@
+use serde::{Deserialize, Serialize};
+use structopt::StructOpt;
+
+use rover_client::shared::ValidationPeriod;
+
+use crate::{error::RoverError, Result};
+
+#[derive(Debug, Serialize, Deserialize, StructOpt)]
+pub struct CheckConfigOpts {
+    /// The minimum number of times a query or mutation must have been executed
+    /// in order to be considered in the check operation
+    #[structopt(long, parse(try_from_str = parse_query_count_threshold))]
+    pub query_count_threshold: Option<i64>,
+
+    /// Minimum percentage of times a query or mutation must have been executed
+    /// in the time window, relative to total request count, for it to be
+    /// considered in the check. Valid numbers are in the range 0 <= x <= 100
+    #[structopt(long, parse(try_from_str = parse_query_percentage_threshold))]
+    pub query_percentage_threshold: Option<f64>,
+
+    /// Size of the time window with which to validate schema against (i.e "24h" or "1w 2d 5h")
+    #[structopt(long)]
+    pub validation_period: Option<ValidationPeriod>,
+}
+
+fn parse_query_count_threshold(threshold: &str) -> Result<i64> {
+    let threshold = threshold.parse::<i64>()?;
+    if threshold < 1 {
+        Err(RoverError::parse_error(
+            "The number of queries must be a positive integer.",
+        ))
+    } else {
+        Ok(threshold)
+    }
+}
+
+fn parse_query_percentage_threshold(threshold: &str) -> Result<f64> {
+    let threshold = threshold.parse::<i64>()?;
+    if !(0..=100).contains(&threshold) {
+        Err(RoverError::parse_error(
+            "Valid numbers are in the range 0 <= x <= 100",
+        ))
+    } else {
+        Ok((threshold / 100) as f64)
+    }
+}

src/options/mod.rs

@@ -1,8 +1,10 @@
+mod check;
 mod graph;
 mod profile;
 mod schema;
 mod subgraph;
 
+pub(crate) use check::CheckConfigOpts;
 pub(crate) use graph::GraphRefOpt;
 pub(crate) use profile::ProfileOpt;
 pub(crate) use schema::SchemaOpt;

src/utils/parsers.rs

@@ -85,28 +85,6 @@ pub fn parse_file_descriptor(input: &str) -> Result<FileDescriptorType> {
     }
 }
 
-pub fn parse_query_count_threshold(threshold: &str) -> Result<i64> {
-    let threshold = threshold.parse::<i64>()?;
-    if threshold < 1 {
-        Err(RoverError::parse_error(
-            "The number of queries must be a positive integer.",
-        ))
-    } else {
-        Ok(threshold)
-    }
-}
-
-pub fn parse_query_percentage_threshold(threshold: &str) -> Result<f64> {
-    let threshold = threshold.parse::<i64>()?;
-    if !(0..=100).contains(&threshold) {
-        Err(RoverError::parse_error(
-            "Valid numbers are in the range 0 <= x <= 100",
-        ))
-    } else {
-        Ok((threshold / 100) as f64)
-    }
-}
-
 /// Parses a key:value pair from a string and returns a tuple of key:value.
 /// If a full key:value can't be parsed, it will error.
 pub fn parse_header(header: &str) -> Result<(String, String)> {