use crate::sros2::LintViolation;
use roxmltree::Document;
pub fn lint_package_xml(doc: &Document<'_>) -> Vec<LintViolation> {
let mut violations = Vec::new();
if let Some(package_node) = doc.descendants().find(|n| n.has_tag_name("package")) {
let format = package_node.attribute("format").unwrap_or("1");
if format == "1" || format == "2" {
violations.push(LintViolation {
message: format!(
"Legacy package.xml format='{}'. ROS 2 packages should use format='3'.",
format
),
range: package_node.range(),
});
}
}
let has_license = doc.descendants().any(|n| n.has_tag_name("license"));
if !has_license {
if let Some(package_node) = doc.descendants().find(|n| n.has_tag_name("package")) {
violations.push(LintViolation {
message: "Missing <license> tag. Open Source robotics packages must declare a license to prevent accidental proprietary poisoning.".to_string(),
range: package_node.range(),
});
}
}
violations
}
#[cfg(test)]
mod tests {
use super::*;
use roxmltree::Document;
#[test]
fn test_package_legacy_format() {
let xml =
"<package format=\"2\"><name>my_pkg</name><license>Apache-2.0</license></package>";
let doc = Document::parse(xml).unwrap();
let violations = lint_package_xml(&doc);
assert_eq!(violations.len(), 1);
assert!(violations[0].message.contains("Legacy package.xml format"));
}
#[test]
fn test_package_missing_license() {
let xml = "<package format=\"3\"><name>my_pkg</name></package>";
let doc = Document::parse(xml).unwrap();
let violations = lint_package_xml(&doc);
assert_eq!(violations.len(), 1);
assert!(violations[0].message.contains("Missing <license> tag"));
}
#[test]
fn test_package_valid() {
let xml =
"<package format=\"3\"><name>my_pkg</name><license>Apache-2.0</license></package>";
let doc = Document::parse(xml).unwrap();
let violations = lint_package_xml(&doc);
assert_eq!(violations.len(), 0);
}
}