Merge pull request #41 from DataDog/juli1/add-short-description

add short description to the rule
DataDog · Jul 26, 2023 · 46bb0c2 · 46bb0c2
2 parents 70c573b + 670b83a
commit 46bb0c2
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 4 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -7,7 +7,7 @@ members = [
 ]
 
 [workspace.package]
-version = "0.0.5"
+version = "0.0.6"
 
 [profile.release]
 lto = true

diff --git a/cli/src/sarif/sarif_utils.rs b/cli/src/sarif/sarif_utils.rs
@@ -32,14 +32,27 @@ impl IntoSarif for &Rule {
                 .decode(d.as_bytes())
                 .unwrap();
             let text_description =
-                std::str::from_utf8(&decrypted_description).unwrap_or("invalid description");
+                std::str::from_utf8(&decrypted_description).unwrap_or("invalid full description");
             let text = sarif::MultiformatMessageStringBuilder::default()
                 .text(std::str::from_utf8(text_description.as_bytes()).unwrap())
                 .build()
                 .unwrap();
             builder.full_description(text);
         }
 
+        if let Some(d) = self.short_description_base64.as_ref() {
+            let decrypted_description = base64::engine::general_purpose::STANDARD
+                .decode(d.as_bytes())
+                .unwrap();
+            let text_description =
+                std::str::from_utf8(&decrypted_description).unwrap_or("invalid short description");
+            let text = sarif::MultiformatMessageStringBuilder::default()
+                .text(std::str::from_utf8(text_description.as_bytes()).unwrap())
+                .build()
+                .unwrap();
+            builder.short_description(text);
+        }
+
         builder.help_uri(self.get_url()).build().unwrap()
     }
 }
@@ -331,7 +344,7 @@ mod tests {
         println!("{}", sarif_report_to_string);
         assert_json_eq!(
             sarif_report_to_string,
-            serde_json::json!({"runs":[{"results":[{"fixes":[{"artifactChanges":[{"artifactLocation":{"uri":"myfile"},"replacements":[{"deletedRegion":{"endColumn":6,"endLine":6,"startColumn":6,"startLine":6},"insertedContent":{"text":"newcontent"}}]}],"description":{"text":"myfix"}}],"level":"error","locations":[{"physicalLocation":{"artifactLocation":{"uri":"myfile"},"region":{"endColumn":4,"endLine":3,"startColumn":2,"startLine":1}}}],"message":{"text":"violation message"},"properties":{"tags":["DATADOG_CATEGORY:BEST_PRACTICES"]},"ruleId":"my-rule","ruleIndex":0}],"tool":{"driver":{"informationUri":"https://www.datadoghq.com","name":"datadog-static-analyzer","rules":[{"fullDescription":{"text":"awesome rule"},"helpUri":"https://static-analysis.datadoghq.com/my-rule","id":"my-rule"}]}}}],"version":"2.1.0"})
+            serde_json::json!({"runs":[{"results":[{"fixes":[{"artifactChanges":[{"artifactLocation":{"uri":"myfile"},"replacements":[{"deletedRegion":{"endColumn":6,"endLine":6,"startColumn":6,"startLine":6},"insertedContent":{"text":"newcontent"}}]}],"description":{"text":"myfix"}}],"level":"error","locations":[{"physicalLocation":{"artifactLocation":{"uri":"myfile"},"region":{"endColumn":4,"endLine":3,"startColumn":2,"startLine":1}}}],"message":{"text":"violation message"},"properties":{"tags":["DATADOG_CATEGORY:BEST_PRACTICES"]},"ruleId":"my-rule","ruleIndex":0}],"tool":{"driver":{"informationUri":"https://www.datadoghq.com","name":"datadog-static-analyzer","rules":[{"fullDescription":{"text":"awesome rule"},"helpUri":"https://docs.datadoghq.com/continuous_integration/static_analysis/rules/my-rule","id":"my-rule","shortDescription":{"text":"short description"}}]}}}],"version":"2.1.0"})
         );
 
         // validate the schema

diff --git a/kernel/src/model/rule.rs b/kernel/src/model/rule.rs
@@ -156,7 +156,10 @@ pub struct RuleInternal {
 
 impl Rule {
     pub fn get_url(&self) -> String {
-        format!("https://static-analysis.datadoghq.com/{}", self.name)
+        format!(
+            "https://docs.datadoghq.com/continuous_integration/static_analysis/rules/{}",
+            self.name
+        )
     }
 
     fn decode_description(&self) -> anyhow::Result<Option<String>> {

diff --git a/versions.json b/versions.json
@@ -1,6 +1,19 @@
 {
   "0": [
     {
+      "0.0.6": {
+        "windows": {
+          "x86_64": "https://github.com/DataDog/datadog-static-analyzer/releases/download/0.0.6/datadog-static-analyzer-x86_64-pc-windows-msvc.zip"
+        },
+        "linux": {
+          "x86_64": "https://github.com/DataDog/datadog-static-analyzer/releases/download/0.0.6/datadog-static-analyzer-x86_64-unknown-linux-gnu.zip",
+          "aarch64": "https://github.com/DataDog/datadog-static-analyzer/releases/download/0.0.6/datadog-static-analyzer-aarch64-unknown-linux-gnu.zip"
+        },
+        "macos": {
+          "x86_64": "https://github.com/DataDog/datadog-static-analyzer/releases/download/0.0.6/datadog-static-analyzer-x86_64-apple-darwin.zip",
+          "aarch64": "https://github.com/DataDog/datadog-static-analyzer/releases/download/0.0.6/datadog-static-analyzer-aarch64-apple-darwin.zip"
+        }
+      },
       "0.0.5": {
         "windows": {
           "x86_64": "https://github.com/DataDog/datadog-static-analyzer/releases/download/0.0.5/datadog-static-analyzer-x86_64-pc-windows-msvc.zip"