fix server rule

Author: juli1

crates/cli/src/model/cli_configuration.rs

@@ -176,6 +176,7 @@ mod tests {
                 arguments: vec![],
                 tests: vec![],
                 is_testing: false,
+                documentation_url: None,
             }],
             rule_config_provider: RuleConfigProvider::default(),
             max_file_size_kb: 1,

crates/cli/src/model/datadog_api.rs

@@ -169,6 +169,7 @@ pub struct ApiResponseRule {
     pub severity: RuleSeverity,
     pub category: RuleCategory,
     pub tests: Vec<ApiResponseRuleTest>,
+    pub documentation_url: Option<String>,
     pub is_testing: bool,
 }
 
@@ -230,6 +231,7 @@ impl APIResponseRuleset {
                         })
                         .collect(),
                     is_testing: rule_from_api.is_testing,
+                    documentation_url: rule_from_api.documentation_url,
                 })
                 .collect(),
             None => Vec::new(),

crates/cli/src/sarif/sarif_utils.rs

@@ -1069,6 +1069,7 @@ mod tests {
             arguments: vec![],
             tests: vec![],
             is_testing: false,
+            documentation_url: None,
         };
         let region0 = Region {
             start: Position { line: 50, col: 5 },

crates/static-analysis-kernel/src/analysis/analyze.rs

@@ -215,8 +215,10 @@ where
                         console_lines,
                         timing,
                     } = execution;
+
                     let console_output = (!console_lines.is_empty() && analysis_option.log_output)
                         .then_some(console_lines.join("\n"));
+
                     violations.retain(|v| {
                         let base_ignored =
                             lines_to_ignore.should_filter_rule(rule.name.as_str(), v.start.line);

crates/static-analysis-kernel/src/model/rule.rs

@@ -155,6 +155,8 @@ pub struct Rule {
     pub tests: Vec<RuleTest>,
     #[serde(default)]
     pub is_testing: bool,
+    #[serde(default)]
+    pub documentation_url: Option<String>,
 }
 
 #[derive(Clone, Deserialize, Debug, Serialize, Builder, Eq, PartialEq)]
@@ -208,10 +210,14 @@ impl DiffAware for Rule {
 
 impl Rule {
     pub fn get_url(&self) -> String {
-        format!(
-            "https://docs.datadoghq.com/static_analysis/rules/{}",
-            self.name
-        )
+        if let Some(url) = &self.documentation_url {
+            url.clone()
+        } else {
+            format!(
+                "https://docs.datadoghq.com/static_analysis/rules/{}",
+                self.name
+            )
+        }
     }
 
     // Sometimes, the API returns an empty CWE as an empty string. If we have an empty
@@ -341,6 +347,54 @@ mod tests {
     use super::*;
     use crate::utils::encode_base64_string;
 
+    #[test]
+    fn test_get_url() {
+        let rule_without_url = Rule {
+            name: "myrule".to_string(),
+            short_description_base64: Some("bla".to_string()),
+            description_base64: Some("bli".to_string()),
+            category: RuleCategory::BestPractices,
+            severity: RuleSeverity::Warning,
+            language: Language::Python,
+            rule_type: RuleType::TreeSitterQuery,
+            entity_checked: None,
+            code_base64: "mycode".to_string(),
+            checksum: "foobar".to_string(),
+            pattern: None,
+            cwe: None,
+            tree_sitter_query_base64: None,
+            arguments: vec![],
+            tests: vec![],
+            is_testing: false,
+            documentation_url: None,
+        };
+        assert_eq!(
+            rule_without_url.get_url(),
+            "https://docs.datadoghq.com/static_analysis/rules/myrule"
+        );
+
+        let rule_with_url = Rule {
+            name: "myrule".to_string(),
+            short_description_base64: Some("bla".to_string()),
+            description_base64: Some("bli".to_string()),
+            category: RuleCategory::BestPractices,
+            severity: RuleSeverity::Warning,
+            language: Language::Python,
+            rule_type: RuleType::TreeSitterQuery,
+            entity_checked: None,
+            code_base64: "mycode".to_string(),
+            checksum: "foobar".to_string(),
+            pattern: None,
+            cwe: None,
+            tree_sitter_query_base64: None,
+            arguments: vec![],
+            tests: vec![],
+            is_testing: false,
+            documentation_url: Some("https://my-rule-url".to_string()),
+        };
+        assert_eq!(rule_with_url.get_url(), "https://my-rule-url");
+    }
+
     #[test]
     fn test_checksum_valid() {
         let rule_invalid_checksum = Rule {
@@ -360,6 +414,7 @@ mod tests {
             arguments: vec![],
             tests: vec![],
             is_testing: false,
+            documentation_url: None,
         };
         let rule_valid_checksum = Rule {
             name: "myrule".to_string(),
@@ -379,6 +434,7 @@ mod tests {
             arguments: vec![],
             tests: vec![],
             is_testing: false,
+            documentation_url: None,
         };
         assert!(!rule_invalid_checksum.verify_checksum());
         assert!(rule_valid_checksum.verify_checksum());
@@ -403,6 +459,7 @@ mod tests {
             arguments: vec![],
             tests: vec![],
             is_testing: false,
+            documentation_url: None,
         };
         let fixed_ruled = rule.fix_cwe();
         assert!(fixed_ruled.cwe.is_none());
@@ -427,6 +484,7 @@ mod tests {
             arguments: vec![],
             tests: vec![],
             is_testing: false,
+            documentation_url: None,
         };
         let fixed_ruled = rule.fix_cwe();
         assert!(fixed_ruled.cwe.is_none());
@@ -451,6 +509,7 @@ mod tests {
             arguments: vec![],
             tests: vec![],
             is_testing: false,
+            documentation_url: None,
         };
         let fixed_ruled = rule.fix_cwe();
         assert!(fixed_ruled.cwe.is_some());

crates/static-analysis-kernel/src/model/ruleset.rs

@@ -89,6 +89,7 @@ mod tests {
             arguments: vec![],
             tests: vec![],
             is_testing: false,
+            documentation_url: None,
         }
     }
 

crates/static-analysis-server/src/model/analysis_request.rs

@@ -61,6 +61,7 @@ impl From<ServerRule> for kernel::model::rule::Rule {
             arguments: value.arguments,
             tests: vec![],
             is_testing: false,
+            documentation_url: None, // no need to have documentation for executing the rule
         }
     }
 }