Merge pull request #349 from DataDog/celia.yuen/default-for-bool

[STAL-1686] Follow-up for handling rules marked as `is_testing`

Author: modernplumbing

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

@@ -143,7 +143,6 @@ pub struct Rule {
     pub language: Language,
     pub rule_type: RuleType,
     pub entity_checked: Option<EntityChecked>,
-    pub is_testing: bool,
     #[serde(rename = "code")]
     pub code_base64: String,
     pub cwe: Option<String>,
@@ -154,6 +153,8 @@ pub struct Rule {
     #[serde(default)]
     pub arguments: Vec<Argument>,
     pub tests: Vec<RuleTest>,
+    #[serde(default)]
+    pub is_testing: bool,
 }
 
 #[derive(Clone, Deserialize, Debug, Serialize, Builder)]

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

@@ -27,7 +27,6 @@ pub struct ServerRule {
     pub tree_sitter_query_base64: Option<String>,
     #[serde(default)]
     pub arguments: Vec<Argument>,
-    pub is_testing: bool,
 }
 
 #[derive(Clone, Deserialize, Debug, Serialize)]

crates/static-analysis-server/src/request.rs

@@ -112,7 +112,7 @@ pub fn process_analysis_request(request: AnalysisRequest) -> AnalysisResponse {
             tree_sitter_query_base64: r.tree_sitter_query_base64.clone(),
             arguments: r.arguments.clone(),
             tests: vec![],
-            is_testing: r.is_testing,
+            is_testing: false,
         })
         .collect();
 
@@ -252,7 +252,6 @@ mod tests {
                     pattern: None,
                     tree_sitter_query_base64: Some("KGZ1bmN0aW9uX2RlZmluaXRpb24KICAgIG5hbWU6IChpZGVudGlmaWVyKSBAbmFtZQogIHBhcmFtZXRlcnM6IChwYXJhbWV0ZXJzKSBAcGFyYW1zCik=".to_string()),
                     arguments: vec![],
-                    is_testing: false,
                 }
             ]
         };
@@ -286,7 +285,6 @@ mod tests {
                     pattern: None,
                     tree_sitter_query_base64: Some("KGZ1bmN0aW9uX2RlZmluaXRpb24KICAgIG5hbWU6IChpZGVudGlmaWVyKSBAbmFtZQogIHBhcmFtZXRlcnM6IChwYXJhbWV0ZXJzKSBAcGFyYW1zCik=".to_string()),
                     arguments: vec![],
-                    is_testing: false,
                 }
             ]
         };
@@ -322,7 +320,6 @@ mod tests {
                     pattern: None,
                     tree_sitter_query_base64: Some("KGZ1bmN0aW9uX2RlZmluaXRpb24KICAgIG5hbWU6IChpZGVudGlmaWVyKSBAbmFtZQogIHBhcmFtZXRlcnM6IChwYXJhbWV0ZXJzKSBAcGFyYW1zCik=".to_string()),
                     arguments: vec![],
-                    is_testing: false,
                 }
             ]
         };
@@ -358,7 +355,6 @@ mod tests {
                     pattern: None,
                     tree_sitter_query_base64: Some("KGZ1bmN0aW9uX2RlZmluaXRpb24KICAgIG5hbWU6IChpZGVudGlmaWVyKSBAbmFtZQogIHBhcmFtZXRlcnM6IChwYXJhbWV0ZXJzKSBAcGFyYW1zCik=".to_string()),
                     arguments: vec![],
-                    is_testing: false,
                 }
             ]
         };
@@ -394,7 +390,6 @@ mod tests {
                     pattern: None,
                     tree_sitter_query_base64: Some("KGZ1bmN0aW9uX2RlZmluaXRpb24KICAgIG5hbWU6IChpZGVudGlmaWVyKSBAbmFtZQogIHBhcmFtZXRlcnM6IChwYXJhbWV0ZXJzKSBAcGFyYW1zCik=".to_string()),
                     arguments: vec![],
-                    is_testing: false,
                 }
             ]
         };
@@ -422,7 +417,6 @@ mod tests {
             pattern: None,
             tree_sitter_query_base64: Some("KGZ1bmN0aW9uX2RlZmluaXRpb24KICAgIG5hbWU6IChpZGVudGlmaWVyKSBAbmFtZQogIHBhcmFtZXRlcnM6IChwYXJhbWV0ZXJzKSBAcGFyYW1zCik=".to_string()),
             arguments: vec![],
-            is_testing: false,
         };
         let mut request = AnalysisRequest {
             filename: "path/to/myfile.py".to_string(),
@@ -594,7 +588,6 @@ rulesets:
                 pattern: None,
                 tree_sitter_query_base64: Some("KGZ1bmN0aW9uX2RlZmluaXRpb24KICAgIG5hbWU6IChpZGVudGlmaWVyKSBAbmFtZQogIHBhcmFtZXRlcnM6IChwYXJhbWV0ZXJzKSBAcGFyYW1zCik=".to_string()),
                 arguments: vec![],
-                is_testing: false,
             }],
         };
         let response = process_analysis_request(request.clone());
@@ -651,7 +644,6 @@ function visit(node, filename, code) {
                     pattern: None,
                     tree_sitter_query_base64: Some("KGZ1bmN0aW9uX2RlZmluaXRpb24KICAgIG5hbWU6IChpZGVudGlmaWVyKSBAbmFtZQogIHBhcmFtZXRlcnM6IChwYXJhbWV0ZXJzKSBAcGFyYW1zCik=".to_string()),
                     arguments: vec![],
-                    is_testing: false,
                 }
             ]
         };
@@ -693,7 +685,6 @@ function visit(node, filename, code) {
                     pattern: None,
                     tree_sitter_query_base64: Some("KGZ1bmN0aW9uX2RlZmluaXRpb24KICAgIG5hbWU6IChpZGVudGlmaWVyKSBAbmFtZQogIHBhcmFtZXRlcnM6IChwYXJhbWV0ZXJzKSBAcGFyYW1zCik=".to_string()),
                     arguments: vec![],
-                    is_testing: false,
                 }
             ]
         };

misc/test-production-rules.py

@@ -151,7 +151,6 @@ def transform_rule(rule):
         'code': rule['code'],
         'variables': {},
         'checksum': rule['checksum'],
-        'is_testing': rule['is_testing']
     }
 
 def test_ruleset_cli(ruleset):
@@ -205,8 +204,12 @@ def test_ruleset_cli(ruleset):
 
             # Invoke the tool, do not print anything
             cmd = f"{options.clibin} -r {test_rules_file} -i {ruledir} -o {test_results_file} -f json"
-            subprocess.run(shlex.split(cmd), check=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
-
+            # TODO: There should be a cleaner way to be able to parse the output of the error
+            try:
+                subprocess.run(shlex.split(cmd), check=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+            except subprocess.CalledProcessError as e:
+                raise RuntimeError("command '{}' return with error (code {}): {}".format(e.cmd, e.returncode, e.output))
+            
             # check that the number of violations match the number of expected annotations
             with open(test_results_file) as results_file:
                 results = results_file.read()