boulder: Write a monitoring.yaml file with boulder new #375
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joebonrichie
force-pushed
the
write-monitoring-template
branch
2 times, most recently
from
cf62693 to
e02e0c3
Compare
|
draft pending code cleanup |
joebonrichie
force-pushed
the
write-monitoring-template
branch
from
e02e0c3 to
8f6086d
Compare
joebonrichie
changed the title
joebonrichie
force-pushed
the
write-monitoring-template
branch
6 times, most recently
from
6fc836c to
d114e4c
Compare
joebonrichie
force-pushed
the
write-monitoring-template
branch
3 times, most recently
from
4be8c0a to
158fda0
Compare
tarkah
reviewed
Jan 6, 2025
boulder/src/draft/monitoring.rs
Outdated
Comment on lines
58
to
67
| pub fn run(&self) -> Result<(), Error> { | ||
| let client = self.create_reqwest_client(); | ||
|
|
||
| let id = self.find_monitoring_id(&self.name, &client)?; | ||
| let cpes = self.find_security_cpe(&self.name, &client)?; | ||
|
|
||
| self.write_monitoring(id, cpes)?; | ||
|
|
||
| Ok(()) | ||
| } |
There was a problem hiding this comment.
run doesn't describe this very well. Maybe fetch_and_output, but that name is a bit of a code smell. Does this API really need to be responsible over outputting the data?
Maybe we should just make this Monitoring::fetch which can be simplified to a module level function.. monitoring::fetch(name) -> Monitoring and then the caller can handle this type / write it however they want (Monitoring can be the name of what's currently MonitoringTemplate)
joebonrichie
force-pushed
the
write-monitoring-template
branch
7 times, most recently
from
bee6f84 to
9dc1efc
Compare
tarkah
reviewed
Jan 8, 2025
boulder/src/draft/monitoring.rs
Outdated
Comment on lines
175
to
209
| let mut yaml_string = serde_yaml::to_string(&monitoring_template).expect("Failed to serialize to YAML"); | ||
|
|
||
| // We may not have matched any ID or CPE which is fine | ||
| // Unwrap the default value then mangle it into a YAML ~ (null) value | ||
| if monitoring_template.releases.id.unwrap_or_default() == 0 { | ||
| let id_string = "id: 0"; | ||
| let id_marker = yaml_string.find(id_string).expect("releases id marker not found"); | ||
| yaml_string = yaml_string.replace(id_string, "id: ~"); | ||
| const ID_HELP_TEXT: &str = | ||
| " # https://release-monitoring.org/ and use the numeric id in the url of project"; | ||
| yaml_string.insert_str(id_marker + id_string.len(), ID_HELP_TEXT); | ||
| } | ||
|
|
||
| if monitoring_template.releases.rss.is_none() { | ||
| let rss_string = "rss: null"; | ||
| yaml_string = yaml_string.replace(rss_string, "rss: ~"); | ||
| } | ||
|
|
||
| if monitoring_template.security.cpe.unwrap_or_default().is_empty() { | ||
| let cpe_string = "cpe: []"; | ||
| let cpe_marker = yaml_string.find(cpe_string).expect("security cpe marker not found"); | ||
| yaml_string = yaml_string.replace(cpe_string, "cpe: ~"); | ||
| let cpe_help_text = format!( | ||
| " # Last checked {}", | ||
| chrono::Local::now().date_naive().format("%Y-%m-%d") | ||
| ); | ||
| yaml_string.insert_str(cpe_marker + cpe_string.len() - 1, &cpe_help_text); | ||
| } |
There was a problem hiding this comment.
Is it even worth using serde_yaml::to_string vs building the formatted string ourselves since we're doing all these replaces?
let id = id.map_or_else(
|| "~ # https://release-monitoring.org/ and use the numeric id in the url of project".to_string(),
ToString::to_string
);
format!(r"---
releases:
id: {id}
")A bit more readable imo and more robust
There was a problem hiding this comment.
Potential multiple CPE matches make this more annoying
tarkah
reviewed
Jan 8, 2025
tarkah
reviewed
Jan 8, 2025
joebonrichie
force-pushed
the
write-monitoring-template
branch
2 times, most recently
from
ef7fe57 to
752c7fa
Compare
Attempt to match ID from release-monitoring.org using the metadata name Attempt to match CPEs from cpe-guesser using the metadata name Attempt to match RSS from homepage (only github is currently supported) Output the recipe and monitoring to a folder instead
joebonrichie
force-pushed
the
write-monitoring-template
branch
from
752c7fa to
81d90a4
Compare
tarkah
approved these changes
Jan 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Attempt to match the id from release-monitoring and any CPE from cpe-guesser.