Add unit tests for the recategorization script.

Author: rvermeulen

scripts/guideline_recategorization/recategorize_test.py

@@ -0,0 +1,101 @@
+import pytest
+import difflib
+import recategorize
+import jsonschema
+from pathlib import Path
+import argparse
+import sys
+
+TEST_DATA_DIR = Path(__file__).resolve().parent / 'test-data'
+
+class TestsInputs:
+    def test_invalid_codeql_config(self):
+        with pytest.raises(SystemExit):
+            recategorize.main(argparse.Namespace(
+                coding_standards_schema_file= Path.cwd(),
+                sarif_schema_file= Path.cwd(),
+                coding_standards_config_file= TEST_DATA_DIR / 'invalid-coding-standards-config.yml'
+            ))
+
+    def test_valid_codeql_config(self):
+        with (TEST_DATA_DIR / 'valid-sarif.json').open(mode='r') as sarif_in:
+            recategorize.main(argparse.Namespace(
+                coding_standards_schema_file= Path.cwd(),
+                sarif_schema_file= Path.cwd(),
+                coding_standards_config_file= TEST_DATA_DIR / 'valid-coding-standards-config.yml',
+                sarif_in=sarif_in,
+                sarif_out=sys.stdout,
+                dump_json_patch=None
+            ))
+
+    def test_invalid_sarif_file(self):
+        with pytest.raises(SystemExit):
+            with (TEST_DATA_DIR / 'invalid-sarif.json').open(mode='r') as sarif_in:
+                recategorize.main(argparse.Namespace(
+                    coding_standards_schema_file= Path.cwd(),
+                    sarif_schema_file= Path.cwd(),
+                    coding_standards_config_file= TEST_DATA_DIR / 'valid-coding-standards-config.yml',
+                    sarif_in=sarif_in
+                ))
+    
+    def test_valid_sarif_file(self):
+        with (TEST_DATA_DIR / 'valid-sarif.json').open(mode='r') as sarif_in:
+            recategorize.main(argparse.Namespace(
+                coding_standards_schema_file= Path.cwd(),
+                sarif_schema_file= Path.cwd(),
+                coding_standards_config_file= TEST_DATA_DIR / 'valid-coding-standards-config.yml',
+                sarif_in=sarif_in,
+                sarif_out=sys.stdout,
+                dump_json_patch=None
+            ))
+
+    def test_invalid_yaml(self):
+        with pytest.raises(SystemExit):
+            recategorize.main(argparse.Namespace(
+                coding_standards_schema_file= Path.cwd(),
+                sarif_schema_file= Path.cwd(),
+                coding_standards_config_file= TEST_DATA_DIR / 'invalid-yaml.yml'
+            ))
+    
+    def test_invalid_json_for_schema(self):
+        with pytest.raises(SystemExit):
+            recategorize.main(argparse.Namespace(
+                coding_standards_schema_file= TEST_DATA_DIR / 'invalid-json.json'
+            ))
+
+class TestUnsupportedSchemas:
+    def test_unsupported_sarif_schema(self):
+        with pytest.raises(SystemExit):
+            recategorize.main(argparse.Namespace(
+                    coding_standards_schema_file= Path.cwd(),
+                    sarif_schema_file= TEST_DATA_DIR / 'unsupported-sarif-schema-2.0.0.json',
+                    coding_standards_config_file= Path.cwd()
+                ))
+    def test_unsupported_coding_standards_config_schema(self):
+        with pytest.raises(SystemExit):
+            recategorize.main(argparse.Namespace(
+                    coding_standards_schema_file= Path.cwd(),
+                    sarif_schema_file= TEST_DATA_DIR / 'unsupported-coding-standards-schema-0.0.1.json',
+                    coding_standards_config_file= Path.cwd()
+                ))
+
+class TestRecategorization:
+    def test_recategorization(self, tmp_path):
+        with (TEST_DATA_DIR / 'valid-sarif.json').open(mode='r') as sarif_in:
+            with (tmp_path / 'sarif.json').open(mode='w') as sarif_out:
+                recategorize.main(argparse.Namespace(
+                    coding_standards_schema_file= Path.cwd(),
+                    sarif_schema_file= Path.cwd(),
+                    coding_standards_config_file= TEST_DATA_DIR / 'valid-coding-standards-config.yml',
+                    sarif_in=sarif_in,
+                    sarif_out=sarif_out,
+                    dump_json_patch=tmp_path / 'json-patch.json'
+                ))
+        
+        expected_patch = (TEST_DATA_DIR / 'json-patch.expected').read_text()
+        actual_patch = (tmp_path / 'json-patch.json').read_text()
+        assert(expected_patch == actual_patch)
+
+        expected_sarif = (TEST_DATA_DIR / 'valid-sarif-recategorized.expected').read_text()
+        actual_sarif = (tmp_path / 'sarif.json').read_text()
+        assert(expected_sarif == actual_sarif)

scripts/guideline_recategorization/requirements.txt

@@ -3,4 +3,5 @@ jsonschema==4.9.1
 jsonpatch==1.32
 jsonpointer==2.3
 PyYAML==5.4
+pytest==7.2.0
 

scripts/guideline_recategorization/test-data/empty-coding-standards-config.yml

@@ -0,0 +1,2 @@
+guideline-recategorizations:
+  - rule-id: "A0-1-1"

scripts/guideline_recategorization/test-data/invalid-coding-standards-config.yml

@@ -0,0 +1,3 @@
+{
+    "foo": "bar",
+}

scripts/guideline_recategorization/test-data/invalid-json.json

@@ -0,0 +1,4 @@
+{
+    "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
+    "version": "2.1.0"
+}

scripts/guideline_recategorization/test-data/invalid-sarif.json

@@ -0,0 +1,3 @@
+key:
+  key1: "value"
+   key2: "value"

scripts/guideline_recategorization/test-data/invalid-yaml.yml

@@ -0,0 +1 @@
+[{"op": "replace", "path": "/runs/0/tool/driver/rules/0/properties/tags/5", "value": "external/autosar/obligation/mandatory"}, {"op": "add", "path": "/runs/0/tool/driver/rules/0/properties/tags/5", "value": "external/autosar/original-obligation/required"}, {"op": "replace", "path": "/runs/0/tool/driver/rules/1/properties/tags/5", "value": "external/autosar/obligation/disapplied"}, {"op": "add", "path": "/runs/0/tool/driver/rules/1/properties/tags/5", "value": "external/autosar/original-obligation/advisory"}, {"op": "replace", "path": "/runs/0/tool/driver/rules/2/properties/tags/4", "value": "external/autosar/obligation/mandatory"}, {"op": "add", "path": "/runs/0/tool/driver/rules/2/properties/tags/4", "value": "external/autosar/original-obligation/advisory"}]

scripts/guideline_recategorization/test-data/json-patch.expected

@@ -0,0 +1,54 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "https://raw.githubusercontent.com/github/codeql-coding-standards/main/schemas/coding-standards-schema-0.0.1.json",
+    "additionalProperties": false,
+    "definitions": {
+        "guideline-category": {
+            "enum": [
+                "mandatory",
+                "required",
+                "advisory",
+                "disapplied"
+            ]
+        },
+        "guideline-recategorization": {
+            "type": "object",
+            "properties": {
+                "rule-id": {
+                    "type": "string"
+                },
+                "category": {
+                    "$ref": "#/definitions/guideline-category"
+                }
+            },
+            "required": [
+                "rule-id",
+                "category"
+            ]
+        }
+    },
+    "properties": {
+        "report-deviated-alerts": {
+            "description": "When true includes alerts with an applicable deviation. Used for report generation.",
+            "type": "boolean"
+        },
+        "deviations": {
+            "description": "A set of deviation records.",
+            "type": "array"
+        },
+        "deviation-permits": {
+            "description": "A set of deviation permits.",
+            "type": "array"
+        },
+        "guideline-recategorizations": {
+            "type": "array",
+            "minProperties": 1,
+            "uniqueItems": true,
+            "items": {
+                "$ref": "#/definitions/guideline-recategorization"
+            }
+        }
+    },
+    "required": [],
+    "type": "object"
+}