feat: add a examples field to check metadata (#8068)

Signed-off-by: nikpivkin <[email protected]>
aquasecurity · Jan 17, 2025 · 6d84e0c · 6d84e0c
1 parent 4f77e01
commit 6d84e0c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/pkg/iac/rego/metadata.go b/pkg/iac/rego/metadata.go
@@ -40,6 +40,7 @@ type StaticMetadata struct {
 	Library            bool
 	CloudFormation     *scan.EngineMetadata
 	Terraform          *scan.EngineMetadata
+	Examples           string
 }
 
 func NewStaticMetadata(pkgPath string, inputOpt InputOptions) *StaticMetadata {
@@ -76,6 +77,7 @@ func (sm *StaticMetadata) update(meta map[string]any) error {
 	upd(&sm.Provider, "provider")
 	upd(&sm.RecommendedActions, "recommended_actions")
 	upd(&sm.RecommendedActions, "recommended_action")
+	upd(&sm.Examples, "examples")
 
 	if raw, ok := meta["deprecated"]; ok {
 		if dep, ok := raw.(bool); ok {
@@ -270,6 +272,7 @@ func (m StaticMetadata) ToRule() scan.Rule {
 		Frameworks:     m.Frameworks,
 		CloudFormation: m.CloudFormation,
 		Terraform:      m.Terraform,
+		Examples:       m.Examples,
 	}
 }
 

diff --git a/pkg/iac/scan/rule.go b/pkg/iac/scan/rule.go
@@ -50,6 +50,7 @@ type Rule struct {
 	Severity       severity.Severity                `json:"severity"`
 	Terraform      *EngineMetadata                  `json:"terraform,omitempty"`
 	CloudFormation *EngineMetadata                  `json:"cloud_formation,omitempty"`
+	Examples       string                           `json:"-"`
 	CustomChecks   CustomChecks                     `json:"-"`
 	RegoPackage    string                           `json:"-"`
 	Frameworks     map[framework.Framework][]string `json:"frameworks"`