format(sarif): Add tflint-errors rules for errors (#2373)

Author: wata727

formatter/sarif.go

@@ -95,6 +95,8 @@ func (f *Formatter) sarifAddErrors(errRun *sarif.Run, err error) {
 	var diags hcl.Diagnostics
 	if errors.As(err, &diags) {
 		for _, diag := range diags {
+			rule := errRun.AddRule(diag.Summary).WithDescription("")
+
 			location := sarif.NewPhysicalLocation().
 				WithArtifactLocation(sarif.NewSimpleArtifactLocation(filepath.ToSlash(diag.Subject.Filename))).
 				WithRegion(
@@ -107,15 +109,17 @@ func (f *Formatter) sarifAddErrors(errRun *sarif.Run, err error) {
 						WithEndColumn(diag.Subject.End.Column),
 				)
 
-			errRun.CreateResultForRule(diag.Summary).
+			errRun.CreateResultForRule(rule.ID).
 				WithLevel(fromHclSeverity(diag.Severity)).
 				WithMessage(sarif.NewTextMessage(diag.Detail)).
 				AddLocation(sarif.NewLocationWithPhysicalLocation(location))
 		}
 		return
 	}
 
-	errRun.CreateResultForRule("application_error").
+	rule := errRun.AddRule("application_error").WithDescription("")
+
+	errRun.CreateResultForRule(rule.ID).
 		WithLevel("error").
 		WithMessage(sarif.NewTextMessage(err.Error()))
 }

formatter/sarif_test.go

@@ -407,14 +407,21 @@ func Test_sarifPrint(t *testing.T) {
         "driver": {
           "informationUri": "https://github.com/terraform-linters/tflint",
           "name": "tflint-errors",
-          "rules": [],
+          "rules": [
+            {
+              "id": "application_error",
+              "shortDescription": {
+                "text": ""
+              }
+            }
+          ],
           "version": "%s"
         }
       },
       "results": [
         {
           "ruleId": "application_error",
-          "ruleIndex": 18446744073709551615,
+          "ruleIndex": 0,
           "level": "error",
           "message": {
             "text": "Failed to work; I don't feel like working"
@@ -462,14 +469,21 @@ func Test_sarifPrint(t *testing.T) {
         "driver": {
           "informationUri": "https://github.com/terraform-linters/tflint",
           "name": "tflint-errors",
-          "rules": [],
+          "rules": [
+            {
+              "id": "summary",
+              "shortDescription": {
+                "text": ""
+              }
+            }
+          ],
           "version": "%s"
         }
       },
       "results": [
         {
           "ruleId": "summary",
-          "ruleIndex": 18446744073709551615,
+          "ruleIndex": 0,
           "level": "warning",
           "message": {
             "text": "detail"
@@ -535,30 +549,43 @@ func Test_sarifPrint(t *testing.T) {
         "driver": {
           "informationUri": "https://github.com/terraform-linters/tflint",
           "name": "tflint-errors",
-          "rules": [],
+          "rules": [
+            {
+              "id": "application_error",
+              "shortDescription": {
+                "text": ""
+              }
+            },
+            {
+              "id": "summary",
+              "shortDescription": {
+                "text": ""
+              }
+            }
+          ],
           "version": "%s"
         }
       },
       "results": [
         {
           "ruleId": "application_error",
-          "ruleIndex": 18446744073709551615,
+          "ruleIndex": 0,
           "level": "error",
           "message": {
             "text": "an error occurred"
           }
         },
         {
           "ruleId": "application_error",
-          "ruleIndex": 18446744073709551615,
+          "ruleIndex": 0,
           "level": "error",
           "message": {
             "text": "failed"
           }
         },
         {
           "ruleId": "summary",
-          "ruleIndex": 18446744073709551615,
+          "ruleIndex": 1,
           "level": "warning",
           "message": {
             "text": "detail"