Merge pull request #470 from Kobzol/test-config

Add test for making sure that example config is valid

Author: Kobzol

src/config.rs

@@ -38,6 +38,11 @@ pub struct RepositoryConfig {
     pub merge_queue_enabled: bool,
 }
 
+/// Load a repository config from TOML.
+pub fn deserialize_config(text: &str) -> Result<RepositoryConfig, toml::de::Error> {
+    toml::from_str(text)
+}
+
 fn default_timeout() -> Duration {
     Duration::from_secs(3600)
 }
@@ -150,10 +155,10 @@ where
 
 #[cfg(test)]
 mod tests {
+    use crate::config::{RepositoryConfig, default_timeout, deserialize_config};
+    use std::path::Path;
     use std::{collections::BTreeMap, time::Duration};
 
-    use crate::config::{RepositoryConfig, default_timeout};
-
     #[test]
     fn deserialize_empty() {
         let content = "";
@@ -274,7 +279,16 @@ approved = ["foo"]
         load_config(content);
     }
 
+    #[test]
+    fn load_example_config() {
+        let path = Path::new(env!("CARGO_MANIFEST_DIR")).join("rust-bors.example.toml");
+        let config = std::fs::read_to_string(path)
+            .expect("Cannot load example bors config from repository root");
+        deserialize_config(&config)
+            .expect("Cannot deserialize example bors config from `rust-bors.example.toml`");
+    }
+
     fn load_config(config: &str) -> RepositoryConfig {
-        toml::from_str(config).unwrap()
+        deserialize_config(config).expect("Cannot deserialize repository config")
     }
 }

src/github/api/client.rs

@@ -9,7 +9,7 @@ use tracing::log;
 
 use crate::bors::event::PullRequestComment;
 use crate::bors::{Comment, WorkflowRun};
-use crate::config::{CONFIG_FILE_PATH, RepositoryConfig};
+use crate::config::{CONFIG_FILE_PATH, RepositoryConfig, deserialize_config};
 use crate::database::WorkflowStatus;
 use crate::github::api::operations::{
     BranchUpdateError, ForcePush, MergeError, create_check_run, merge_branches,
@@ -83,7 +83,7 @@ impl GithubRepositoryClient {
                     .ok_or_else(|| anyhow::anyhow!("Configuration file not found"))
                     .and_then(|content| {
                         let config: RepositoryConfig =
-                            toml::from_str(&content).map_err(|error| {
+                            deserialize_config(&content).map_err(|error| {
                                 anyhow::anyhow!(
                                     "Could not deserialize repository config: {error:?}"
                                 )