Merge pull request #17 from armosec/add-relevant-fields

add fields and functions

Author: Daniel-GrunbergerCA

containerscan/commonContainerScanSummaryResultMethods.go

@@ -78,6 +78,10 @@ func (summary *CommonContainerScanSummaryResult) GetJobIDs() []string {
 	return summary.JobIDs
 }
 
+func (summary *CommonContainerScanSummaryResult) GetRelevantLabel() RelevantLabel {
+	return summary.RelevantLabel
+}
+
 func (summary *CommonContainerScanSummaryResult) Validate() bool {
 	return summary.CustomerGUID != "" && summary.ContainerScanID != "" && (summary.ImageTag != "" || summary.ImageID != "") && summary.Timestamp > 0
 }
@@ -149,6 +153,10 @@ func (summary *CommonContainerScanSummaryResult) SetTimestamp(timestamp int64) {
 	summary.Timestamp = timestamp
 }
 
+func (summary *CommonContainerScanSummaryResult) SetRelevantLabel(label RelevantLabel) {
+	summary.RelevantLabel = label
+}
+
 func (summary *CommonContainerScanSummaryResult) GetHasRelevancyData() bool {
 	return summary.HasRelevancyData
 }

containerscan/commonContainerScanSummaryResultMethods_test.go

@@ -238,6 +238,23 @@ func TestGetSeverityStats(t *testing.T) {
 	assert.Equal(t, "critical", stats.Severity)
 }
 
+func Test_CommonContainerScanSummaryResult_GetRelevantLabel(t *testing.T) {
+	summary := &CommonContainerScanSummaryResult{}
+	assert.Equal(t, RelevantLabelNotExists, summary.GetRelevantLabel())
+
+	summary.RelevantLabel = RelevantLabelYes
+	assert.Equal(t, RelevantLabelYes, summary.GetRelevantLabel())
+
+}
+
+func Test_CommonContainerScanSummaryResult_SetRelevantLabel(t *testing.T) {
+	summary := &CommonContainerScanSummaryResult{}
+	assert.Equal(t, RelevantLabelNotExists, summary.RelevantLabel)
+
+	summary.SetRelevantLabel(RelevantLabelNo)
+	assert.Equal(t, RelevantLabelNo, summary.RelevantLabel)
+}
+
 func TestGetHasRelevancyData(t *testing.T) {
 	reportWithRelevancy := CommonContainerScanSummaryResult{HasRelevancyData: true}
 	if !reportWithRelevancy.GetHasRelevancyData() {

containerscan/commonContainerVulnerabilityResultMethods.go

@@ -58,6 +58,10 @@ func (c *CommonContainerVulnerabilityResult) GetVulnerability() VulnerabilityRes
 	return &c.Vulnerability
 }
 
+func (c *CommonContainerVulnerabilityResult) GetRelevantLabel() RelevantLabel {
+	return c.RelevantLabel
+}
+
 func (c *CommonContainerVulnerabilityResult) SetDesignators(designators armotypes.PortalDesignator) {
 	c.Designators = designators
 }
@@ -105,3 +109,7 @@ func (c *CommonContainerVulnerabilityResult) SetRelevantLinks(relevantLinks []st
 func (c *CommonContainerVulnerabilityResult) SetRelatedExceptions(relatedExceptions []armotypes.VulnerabilityExceptionPolicy) {
 	c.RelatedExceptions = relatedExceptions
 }
+
+func (c *CommonContainerVulnerabilityResult) SetRelevantLabel(relevantLabel RelevantLabel) {
+	c.RelevantLabel = relevantLabel
+}

containerscan/commonContainerVulnerabilityResultMethods_test.go

@@ -172,3 +172,20 @@ func TestVulnerability(t *testing.T) {
 	}
 	assert.Equal(t, "severity1", vulnerability.Severity)
 }
+
+func TestCommonContainerVulnerabilityResult_GetRelevantLabel(t *testing.T) {
+	vulnerabilityResult := CommonContainerVulnerabilityResult{}
+	assert.Equal(t, RelevantLabelNotExists, vulnerabilityResult.GetRelevantLabel())
+
+	vulnerabilityResult.RelevantLabel = RelevantLabelYes
+	assert.Equal(t, RelevantLabelYes, vulnerabilityResult.GetRelevantLabel())
+
+}
+
+func TestCommonContainerVulnerabilityResult_SetRelevantLabel(t *testing.T) {
+	vulnerabilityResult := CommonContainerVulnerabilityResult{}
+	assert.Equal(t, RelevantLabelNotExists, vulnerabilityResult.RelevantLabel)
+
+	vulnerabilityResult.SetRelevantLabel(RelevantLabelNo)
+	assert.Equal(t, RelevantLabelNo, vulnerabilityResult.RelevantLabel)
+}

containerscan/commondatastructures.go

@@ -6,6 +6,12 @@ import (
 	"github.com/armosec/armoapi-go/armotypes"
 )
 
+type RelevantLabel string
+
+const RelevantLabelYes RelevantLabel = "yes"
+const RelevantLabelNo RelevantLabel = "no"
+const RelevantLabelNotExists RelevantLabel = ""
+
 type CommonContainerVulnerabilityResult struct {
 	Designators       armotypes.PortalDesignator `json:"designators"`
 	IntroducedInLayer string                     `json:"layerHash"`
@@ -20,6 +26,7 @@ type CommonContainerVulnerabilityResult struct {
 	Timestamp         int64                                    `json:"timestamp"`
 	IsLastScan        int                                      `json:"isLastScan"`
 	IsFixed           int                                      `json:"isFixed"`
+	RelevantLabel     RelevantLabel                            `json:"relevantLabel"`
 }
 
 type ESLayer struct {
@@ -35,16 +42,16 @@ type LayerInfo struct {
 }
 
 type SeverityStats struct {
-	Severity                     string `json:"severity,omitempty"`
-	HealthStatus                 string `json:"healthStatus"`
-	TotalCount                   int64  `json:"total"`
-	RCEFixCount                  int64  `json:"rceFixCount"`
-	FixAvailableOfTotalCount     int64  `json:"fixedTotal"`
-	RelevantCount                int64  `json:"totalRelevant"`
-	FixAvailableForRelevantCount int64  `json:"fixedRelevant"`
-	RCECount                     int64  `json:"rceTotal"`
-	UrgentCount                  int64  `json:"urgent"`
-	NeglectedCount               int64  `json:"neglected"`
+	Severity                 string `json:"severity,omitempty"`
+	HealthStatus             string `json:"healthStatus"`
+	TotalCount               int64  `json:"total"`
+	RCEFixCount              int64  `json:"rceFixCount"`
+	RelevantFixCount         int64  `json:"relevantFixCount"`
+	FixAvailableOfTotalCount int64  `json:"fixedTotal"`
+	RelevantCount            int64  `json:"relevantTotal"`
+	RCECount                 int64  `json:"rceTotal"`
+	UrgentCount              int64  `json:"urgent"`
+	NeglectedCount           int64  `json:"neglected"`
 }
 
 type ShortVulnerabilityResult struct {
@@ -97,5 +104,6 @@ type CommonContainerScanSummaryResult struct {
 	Timestamp                     int64                      `json:"timestamp"`
 	ImageSignatureValid           bool                       `json:"imageSignatureValid,omitempty"`
 	ImageHasSignature             bool                       `json:"imageHasSignature,omitempty"`
+	RelevantLabel                 RelevantLabel              `json:"relevantLabel"`
 	HasRelevancyData              bool                       `json:"hasRelevancyData"`
 }

containerscan/containerscan_test.go

@@ -82,8 +82,8 @@ func TestExceptions(t *testing.T) {
 	if excludedStats.RelevantCount != 0 {
 		t.Errorf("excludedStats.RelevantCount = %v", excludedStats.RelevantCount)
 	}
-	if excludedStats.FixAvailableForRelevantCount != 0 {
-		t.Errorf("excludedStats.FixAvailableForRelevantCount = %v", excludedStats.FixAvailableForRelevantCount)
+	if excludedStats.RelevantFixCount != 0 {
+		t.Errorf("excludedStats.FixAvailableForRelevantCount = %v", excludedStats.RelevantFixCount)
 	}
 	if excludedStats.RCECount != 1 {
 		t.Errorf("excludedStats.RCECount = %v", excludedStats.RCECount)
@@ -105,8 +105,8 @@ func TestExceptions(t *testing.T) {
 	if regularSum.RelevantCount != (sumObj.RelevantCount + excludedStats.RelevantCount) {
 		t.Errorf("sumObj.RelevantCount = %v", sumObj.RelevantCount)
 	}
-	if regularSum.FixAvailableForRelevantCount != (sumObj.FixAvailableForRelevantCount + excludedStats.FixAvailableForRelevantCount) {
-		t.Errorf("sumObj.FixAvailableForRelevantCoun = %v", sumObj.FixAvailableForRelevantCount)
+	if regularSum.RelevantFixCount != (sumObj.RelevantFixCount + excludedStats.RelevantFixCount) {
+		t.Errorf("sumObj.FixAvailableForRelevantCoun = %v", sumObj.RelevantFixCount)
 	}
 	if regularSum.RCECount != (sumObj.RCECount + excludedStats.RCECount) {
 		t.Errorf("sumObj.RCECount = %v", sumObj.RCECount)

containerscan/interfaces.go

@@ -44,6 +44,7 @@ type ContainerScanSummaryResult interface {
 	GetContainerScanID() string
 	GetTimestamp() int64
 	GetJobIDs() []string
+	GetRelevantLabel() RelevantLabel
 	Validate() bool
 	GetHasRelevancyData() bool
 
@@ -64,6 +65,7 @@ type ContainerScanSummaryResult interface {
 	SetCustomerGUID(string)
 	SetContainerScanID(string)
 	SetTimestamp(int64)
+	SetRelevantLabel(RelevantLabel)
 	SetHasRelevancyData(bool)
 }
 
@@ -81,6 +83,7 @@ type ContainerScanVulnerabilityResult interface {
 	GetRelevantLinks() []string
 	GetRelatedExceptions() []armotypes.VulnerabilityExceptionPolicy
 	GetVulnerability() VulnerabilityResult
+	GetRelevantLabel() RelevantLabel
 
 	SetDesignators(designators armotypes.PortalDesignator)
 	SetContext(context []armotypes.ArmoContext)
@@ -94,6 +97,7 @@ type ContainerScanVulnerabilityResult interface {
 	SetIntroducedInLayer(introducedInLayer string)
 	SetRelevantLinks(relevantLinks []string)
 	SetRelatedExceptions(relatedExceptions []armotypes.VulnerabilityExceptionPolicy)
+	SetRelevantLabel(relevantLabel RelevantLabel)
 }
 
 type VulnerabilityResult interface {