boulder: Write a template monitoring.yaml file with boulder new

Author: joebonrichie

boulder/src/draft.rs

@@ -8,6 +8,8 @@ use std::{io, path::PathBuf};
 use fs_err as fs;
 use itertools::Itertools;
 use moss::Dependency;
+use serde::Serialize;
+use std::io::Write;
 use thiserror::Error;
 use url::Url;
 
@@ -20,6 +22,22 @@ mod build;
 mod metadata;
 mod upstream;
 
+#[derive(Serialize)]
+struct Monitoring {
+    releases: Releases,
+    security: Security,
+}
+
+#[derive(Serialize)]
+struct Releases {
+    id: Option<u16>,
+}
+
+#[derive(Serialize)]
+struct Security {
+    cpe: Option<String>,
+}
+
 pub struct Drafter {
     upstreams: Vec<Url>,
 }
@@ -29,6 +47,33 @@ impl Drafter {
         Self { upstreams }
     }
 
+    pub fn write_monitoring(&self) -> Result<String, Error> {
+        let monitoring_template = Monitoring {
+            releases: Releases { id: None },
+            security: Security { cpe: None },
+        };
+
+        let mut yaml_string = serde_yaml::to_string(&monitoring_template).expect("Failed to serialize to YAML");
+
+        let id_string = "id: null";
+        let id_marker = yaml_string.find(id_string).expect("releases id marker not found");
+        let id_help_text = " # https://release-monitoring.org/ and use the numeric id in the url of project";
+
+        // append_str at marker instead of insert
+        yaml_string.insert_str(id_marker + id_string.len(), id_help_text);
+
+        let cpe_string = "cpe: null";
+        let cpe_marker = yaml_string.find(cpe_string).expect("security cpe marker not found");
+        let cpe_help_text = " # Use the cpesearch bash macro and insert [ { - vendor: foo, product: bar } ] if found";
+
+        yaml_string.insert_str(cpe_marker + cpe_string.len(), cpe_help_text);
+
+        let mut file = std::fs::File::create("monitoring.yaml")?;
+        file.write_all(yaml_string.as_bytes())?;
+        println!("Wrote template 'monitoring.yaml' file");
+        Ok(yaml_string)
+    }
+
     pub fn run(&self) -> Result<String, Error> {
         // TODO: Use tempdir
         let extract_root = PathBuf::from("/tmp/boulder-new");
@@ -42,7 +87,7 @@ impl Drafter {
         // Enumerate all extracted files
         let files = util::enumerate_files(&extract_root, |_| true)?
             .into_iter()
-            .map(|path| File {
+            .map(|path| DrafterFile {
                 path,
                 extract_root: &extract_root,
             })
@@ -90,6 +135,8 @@ license     : UPDATE LICENSE
             metadata.upstreams(),
         );
 
+        self.write_monitoring()?;
+
         Ok(template)
     }
 }
@@ -104,12 +151,12 @@ fn builddeps(deps: impl IntoIterator<Item = Dependency>) -> String {
     }
 }
 
-pub struct File<'a> {
+pub struct DrafterFile<'a> {
     pub path: PathBuf,
     pub extract_root: &'a Path,
 }
 
-impl File<'_> {
+impl DrafterFile<'_> {
     // The depth of a file relative to it's extracted archive
     pub fn depth(&self) -> usize {
         let relative = self.path.strip_prefix(self.extract_root).unwrap_or(&self.path);
@@ -145,7 +192,7 @@ mod test {
     fn test_file_depth() {
         let extract_root = Path::new("/tmp/test");
 
-        let file = File {
+        let file = DrafterFile {
             path: PathBuf::from("/tmp/test/some_archive/meson.build"),
             extract_root,
         };

boulder/src/draft/build.rs

@@ -6,7 +6,7 @@ use std::{fmt, num::NonZeroU64};
 
 use moss::Dependency;
 
-use super::File;
+use super::DrafterFile;
 
 mod autotools;
 mod cargo;
@@ -60,7 +60,7 @@ impl System {
         }
     }
 
-    fn process(&self, state: &mut State, file: &File) -> Result<(), Error> {
+    fn process(&self, state: &mut State, file: &DrafterFile) -> Result<(), Error> {
         match self {
             System::Autotools => autotools::process(state, file),
             System::Cargo => cargo::process(state, file),
@@ -126,7 +126,7 @@ pub struct Analysis {
 
 /// Analyze the provided paths to determine which build [`System`]
 /// the project uses and any dependencies that are identified
-pub fn analyze(files: &[File]) -> Result<Analysis, Error> {
+pub fn analyze(files: &[DrafterFile]) -> Result<Analysis, Error> {
     let mut dependencies = BTreeSet::new();
     let mut confidences = BTreeMap::new();
 

boulder/src/draft/build/autotools.rs

@@ -8,7 +8,7 @@ use regex::Regex;
 //
 // SPDX-License-Identifier: MPL-2.0
 use crate::draft::build::{Error, Phases, State};
-use crate::draft::File;
+use crate::draft::DrafterFile;
 
 pub fn phases() -> Phases {
     Phases {
@@ -19,7 +19,7 @@ pub fn phases() -> Phases {
     }
 }
 
-pub fn process(state: &mut State, file: &File) -> Result<(), Error> {
+pub fn process(state: &mut State, file: &DrafterFile) -> Result<(), Error> {
     // Depth too great
     if file.depth() > 0 {
         return Ok(());

boulder/src/draft/build/cargo.rs

@@ -2,7 +2,7 @@
 //
 // SPDX-License-Identifier: MPL-2.0
 use crate::draft::build::{Error, Phases, State};
-use crate::draft::File;
+use crate::draft::DrafterFile;
 
 pub fn phases() -> Phases {
     Phases {
@@ -13,7 +13,7 @@ pub fn phases() -> Phases {
     }
 }
 
-pub fn process(state: &mut State, file: &File) -> Result<(), Error> {
+pub fn process(state: &mut State, file: &DrafterFile) -> Result<(), Error> {
     if file.file_name() == "Cargo.toml" {
         state.increment_confidence(100);
     }

boulder/src/draft/build/cmake.rs

@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: MPL-2.0
 
 use crate::draft::build::{Error, Phases, State};
-use crate::draft::File;
+use crate::draft::DrafterFile;
 
 pub fn phases() -> Phases {
     Phases {
@@ -14,7 +14,7 @@ pub fn phases() -> Phases {
     }
 }
 
-pub fn process(state: &mut State, file: &File) -> Result<(), Error> {
+pub fn process(state: &mut State, file: &DrafterFile) -> Result<(), Error> {
     // Depth too great
     if file.depth() > 0 {
         return Ok(());

boulder/src/draft/build/meson.rs

@@ -8,7 +8,7 @@ use moss::{dependency, Dependency};
 use regex::Regex;
 
 use crate::draft::build::{Error, Phases, State};
-use crate::draft::File;
+use crate::draft::DrafterFile;
 
 pub fn phases() -> Phases {
     Phases {
@@ -19,7 +19,7 @@ pub fn phases() -> Phases {
     }
 }
 
-pub fn process(state: &mut State, file: &File) -> Result<(), Error> {
+pub fn process(state: &mut State, file: &DrafterFile) -> Result<(), Error> {
     match file.file_name() {
         "meson.build" if file.depth() == 0 => {
             state.increment_confidence(100);

boulder/src/draft/build/python.rs

@@ -4,7 +4,7 @@
 
 pub mod pep517 {
     use crate::draft::build::{Error, Phases, State};
-    use crate::draft::File;
+    use crate::draft::DrafterFile;
 
     pub fn phases() -> Phases {
         Phases {
@@ -15,7 +15,7 @@ pub mod pep517 {
         }
     }
 
-    pub fn process(state: &mut State, file: &File) -> Result<(), Error> {
+    pub fn process(state: &mut State, file: &DrafterFile) -> Result<(), Error> {
         match file.file_name() {
             "pyproject.toml" | "setup.cfg" => state.increment_confidence(100),
             _ => {}
@@ -27,7 +27,7 @@ pub mod pep517 {
 
 pub mod setup_tools {
     use crate::draft::build::{Error, Phases, State};
-    use crate::draft::File;
+    use crate::draft::DrafterFile;
 
     pub fn phases() -> Phases {
         Phases {
@@ -38,7 +38,7 @@ pub mod setup_tools {
         }
     }
 
-    pub fn process(state: &mut State, file: &File) -> Result<(), Error> {
+    pub fn process(state: &mut State, file: &DrafterFile) -> Result<(), Error> {
         if file.file_name() == "setup.py" {
             state.increment_confidence(100);
         }