DAG-2777 Added better logging around errors in yaml parsing

Author: IamXander

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.7.9 - 2022-07-31
+* DAG-2777: Added better logging around yaml failures
+
 ## 0.7.8 - 2022-05-25
 * Update burn in tags API to accommodate all required and suggested buildvariants.
 

Cargo.lock

@@ -2,7 +2,7 @@
 name = "mongo-task-generator"
 description = "Dynamically split evergreen tasks into subtasks for testing the mongodb/mongo project."
 license = "Apache-2.0"
-version = "0.7.8"
+version = "0.7.9"
 repository = "https://github.com/mongodb/mongo-task-generator"
 authors = ["Decision Automation Group <[email protected]>"]
 edition = "2018"
@@ -28,7 +28,7 @@ shellexpand = "2.1"
 shrub-rs = "0.5.1"
 tokio = { version = "1", features = ["full"] }
 tracing = "0.1"
-tracing-subscriber = {version = "0.3", features = ["json", "fmt", "std"]}
+tracing-subscriber = { version = "0.3", features = ["json", "fmt", "std"] }
 
 [dev-dependencies]
 assert_cmd = "2.0"

Cargo.toml

@@ -1,4 +1,5 @@
 use std::{collections::HashSet, path::Path};
+use tracing::error;
 
 use anyhow::Result;
 use serde::Deserialize;
@@ -10,9 +11,18 @@ pub struct GenerateSubTasksConfig {
 
 impl GenerateSubTasksConfig {
     pub fn from_yaml_file<P: AsRef<Path>>(location: P) -> Result<Self> {
-        let contents = std::fs::read_to_string(location)?;
+        let contents = std::fs::read_to_string(&location)?;
 
-        Ok(serde_yaml::from_str(&contents)?)
+        let subtasks: Result<Self, serde_yaml::Error> = serde_yaml::from_str(&contents);
+        if subtasks.is_err() {
+            error!(
+                file = location.as_ref().display().to_string(),
+                contents = &contents,
+                "Failed to parse yaml for GenerateSubTasksConfig from file",
+            );
+        }
+
+        Ok(subtasks?)
     }
 
     pub fn ignore_missing_large_distro(&self, build_variant_name: &str) -> bool {

src/generate_sub_tasks_config.rs

@@ -10,7 +10,7 @@ use mongo_task_generator::{
     generate_configuration, Dependencies, ExecutionConfiguration, ProjectInfo,
 };
 use serde::Deserialize;
-use tracing::{event, Level};
+use tracing::{error, event, Level};
 use tracing_subscriber::fmt::format;
 
 const DEFAULT_EVG_AUTH_FILE: &str = "~/.evergreen.yml";
@@ -41,7 +41,17 @@ impl EvgExpansions {
     /// * `path` - Path to YAML file to read.
     pub fn from_yaml_file(path: &Path) -> Result<Self> {
         let contents = std::fs::read_to_string(path)?;
-        Ok(serde_yaml::from_str(&contents)?)
+
+        let evg_expansions: Result<Self, serde_yaml::Error> = serde_yaml::from_str(&contents);
+        if evg_expansions.is_err() {
+            error!(
+                file = path.display().to_string(),
+                contents = &contents,
+                "Failed to parse yaml for EvgExpansions from file",
+            );
+        }
+
+        Ok(evg_expansions?)
     }
 
     /// File to store generated configuration under.

src/main.rs

@@ -2,7 +2,7 @@ use std::{path::Path, time::Instant};
 
 use anyhow::Result;
 use serde::Deserialize;
-use tracing::{event, Level};
+use tracing::{error, event, Level};
 
 use crate::resmoke::external_cmd::run_command;
 
@@ -100,7 +100,16 @@ impl BurnInDiscovery for BurnInProxy {
             "Burn In Discovery Finished"
         );
 
-        let output: DiscoveredTaskList = serde_yaml::from_str(&cmd_output)?;
-        Ok(output.discovered_tasks)
+        let output: Result<DiscoveredTaskList, serde_yaml::Error> =
+            serde_yaml::from_str(&cmd_output);
+        if output.is_err() {
+            error!(
+                command = cmd.join(" "),
+                command_output = &cmd_output,
+                "Failed to parse yaml from discover tasks command output",
+            );
+        }
+
+        Ok(output?.discovered_tasks)
     }
 }

src/resmoke/burn_in_proxy.rs

@@ -2,7 +2,7 @@ use std::{path::Path, str::FromStr, time::Instant};
 
 use anyhow::Result;
 use serde::Deserialize;
-use tracing::{event, Level};
+use tracing::{error, event, Level};
 
 use super::{external_cmd::run_command, resmoke_suite::ResmokeSuiteConfig};
 
@@ -95,8 +95,17 @@ impl TestDiscovery for ResmokeProxy {
             "Resmoke test discovery finished"
         );
 
-        let output: TestDiscoveryOutput = serde_yaml::from_str(&cmd_output)?;
-        Ok(output
+        let output: Result<TestDiscoveryOutput, serde_yaml::Error> =
+            serde_yaml::from_str(&cmd_output);
+        if output.is_err() {
+            error!(
+                command = cmd.join(" "),
+                command_output = &cmd_output,
+                "Failed to parse yaml from discover tests command output",
+            );
+        }
+
+        Ok(output?
             .tests
             .into_iter()
             .filter(|f| Path::new(f).exists())
@@ -150,7 +159,16 @@ impl MultiversionConfig {
         cmd.append(&mut script.iter().map(|s| s.as_str()).collect());
         cmd.append(&mut vec!["multiversion-config"]);
         let cmd_output = run_command(&cmd).unwrap();
-        Ok(serde_yaml::from_str(&cmd_output)?)
+        let multiversion_config: Result<MultiversionConfig, serde_yaml::Error> =
+            serde_yaml::from_str(&cmd_output);
+        if multiversion_config.is_err() {
+            error!(
+                command = cmd.join(" "),
+                command_output = &cmd_output,
+                "Failed to parse yaml from multiversion config command output",
+            );
+        }
+        Ok(multiversion_config?)
     }
 
     /// Get the required FCV tag for the lts version.

src/resmoke/resmoke_proxy.rs

@@ -5,6 +5,7 @@ use std::{collections::HashSet, str::FromStr};
 use anyhow::Result;
 use serde::{Deserialize, Serialize};
 use serde_yaml::{Error, Value};
+use tracing::error;
 
 #[derive(Serialize, Debug, Clone, Deserialize)]
 #[serde(untagged)]
@@ -79,7 +80,11 @@ impl FromStr for ResmokeSuiteConfig {
 
     /// Read Resmoke suite configuration from the given string.
     fn from_str(s: &str) -> Result<Self, Self::Err> {
-        serde_yaml::from_str(s)
+        let resmoke_suite_config: Result<Self, serde_yaml::Error> = serde_yaml::from_str(s);
+        if resmoke_suite_config.is_err() {
+            error!(yaml = s, "Failed to parse yaml for ResmokeSuiteConfig",);
+        }
+        resmoke_suite_config
     }
 }