Address review comments

redhat-best-practices-for-k8s · Aug 29, 2024 · a02842e · a02842e
1 parent 96a8cdc
commit a02842e
Show file tree

Hide file tree

Showing 13 changed files with 102 additions and 102 deletions.
diff --git a/cmd/certsuite/check/check.go b/cmd/certsuite/check/check.go
@@ -9,7 +9,7 @@ import (
 var (
 	checkCmd = &cobra.Command{
 		Use:   "check",
-		Short: "check the status of workload resources or artifacts.",
+		Short: "check the status of certsuite resources or artifacts.",
 	}
 )
 

diff --git a/cmd/certsuite/claim/compare/compare.go b/cmd/certsuite/claim/compare/compare.go
@@ -16,7 +16,7 @@ import (
 
 const longHelp = `Compares sections of both claim files and the differences are shown in a table per section.
 This tool can be helpful when the result of some test cases is different between two (consecutive) runs, as it shows
-configuration differences in both the Workload Cert Suite config and the cluster nodes that could be the root cause for
+configuration differences in both the Cert Suite config and the cluster nodes that could be the root cause for
 some of the test cases results discrepancy.
 
 All the compared sections, except the test cases results are compared blindly, traversing the whole json tree and
@@ -148,7 +148,7 @@ func claimCompareFilesfunc(claim1, claim2 string) error {
 	tcsDiffReport := testcases.GetDiffReport(claimFile1Data.Claim.Results, claimFile2Data.Claim.Results)
 	fmt.Println(tcsDiffReport)
 
-	// Show Workload Certification Suite configuration differences.
+	// Show  Certification Suite configuration differences.
 	claim1Configurations := &claimFile1Data.Claim.Configurations
 	claim2Configurations := &claimFile2Data.Claim.Configurations
 	configurationsDiffReport := configurations.GetDiffReport(claim1Configurations, claim2Configurations)

diff --git a/cmd/certsuite/claim/compare/configurations/configurations.go b/cmd/certsuite/claim/compare/configurations/configurations.go
@@ -26,7 +26,7 @@ func (c *AbnormalEventsCount) String() string {
 }
 
 type DiffReport struct {
-	Config         *diff.Diffs         `json:"WorkloadCertSuiteConfig"`
+	Config         *diff.Diffs         `json:"CertSuiteConfig"`
 	AbnormalEvents AbnormalEventsCount `json:"abnormalEventsCount"`
 }
 
@@ -44,7 +44,7 @@ func (d *DiffReport) String() string {
 
 func GetDiffReport(claim1Configurations, claim2Configurations *claim.Configurations) *DiffReport {
 	return &DiffReport{
-		Config: diff.Compare("Workload Cert Suite Configuration", claim1Configurations.Config, claim2Configurations.Config, nil),
+		Config: diff.Compare("Cert Suite Configuration", claim1Configurations.Config, claim2Configurations.Config, nil),
 		AbnormalEvents: AbnormalEventsCount{
 			Claim1: len(claim1Configurations.AbnormalEvents),
 			Claim2: len(claim2Configurations.AbnormalEvents),

diff --git a/cmd/certsuite/claim/compare/configurations/configurations_test.go b/cmd/certsuite/claim/compare/configurations/configurations_test.go
@@ -21,20 +21,20 @@ func TestGetDiffReport(t *testing.T) {
 			configs1: &claim.Configurations{},
 			configs2: &claim.Configurations{},
 			expectedDiff: &DiffReport{
-				Config:         &diff.Diffs{Name: "Workload Cert Suite Configuration"},
+				Config:         &diff.Diffs{Name: "Cert Suite Configuration"},
 				AbnormalEvents: AbnormalEventsCount{},
 			},
 			expectedDiffStr: `CONFIGURATIONS
 --------------
 
-Workload Cert Suite Configuration: Differences
+Cert Suite Configuration: Differences
 FIELD     CLAIM 1     CLAIM 2
 <none>
 
-Workload Cert Suite Configuration: Only in CLAIM 1
+Cert Suite Configuration: Only in CLAIM 1
 <none>
 
-Workload Cert Suite Configuration: Only in CLAIM 2
+Cert Suite Configuration: Only in CLAIM 2
 <none>
 
 Cluster abnormal events count
@@ -57,7 +57,7 @@ CLAIM 1     CLAIM 2
 				AbnormalEvents: []interface{}{"event1", "event2"},
 			},
 			expectedDiff: &DiffReport{
-				Config: &diff.Diffs{Name: "Workload Cert Suite Configuration"},
+				Config: &diff.Diffs{Name: "Cert Suite Configuration"},
 				AbnormalEvents: AbnormalEventsCount{
 					Claim1: 2,
 					Claim2: 2,
@@ -66,14 +66,14 @@ CLAIM 1     CLAIM 2
 			expectedDiffStr: `CONFIGURATIONS
 --------------
 
-Workload Cert Suite Configuration: Differences
+Cert Suite Configuration: Differences
 FIELD     CLAIM 1     CLAIM 2
 <none>
 
-Workload Cert Suite Configuration: Only in CLAIM 1
+Cert Suite Configuration: Only in CLAIM 1
 <none>
 
-Workload Cert Suite Configuration: Only in CLAIM 2
+Cert Suite Configuration: Only in CLAIM 2
 <none>
 
 Cluster abnormal events count
@@ -98,7 +98,7 @@ CLAIM 1     CLAIM 2
 			},
 			expectedDiff: &DiffReport{
 				Config: &diff.Diffs{
-					Name: "Workload Cert Suite Configuration",
+					Name: "Cert Suite Configuration",
 					Fields: []diff.FieldDiff{{
 						FieldPath:   "/field1",
 						Claim1Value: "value1",
@@ -114,14 +114,14 @@ CLAIM 1     CLAIM 2
 			expectedDiffStr: `CONFIGURATIONS
 --------------
 
-Workload Cert Suite Configuration: Differences
+Cert Suite Configuration: Differences
 FIELD       CLAIM 1     CLAIM 2
 /field1     value1      value11
 
-Workload Cert Suite Configuration: Only in CLAIM 1
+Cert Suite Configuration: Only in CLAIM 1
 <none>
 
-Workload Cert Suite Configuration: Only in CLAIM 2
+Cert Suite Configuration: Only in CLAIM 2
 /field2/subfield1=58
 
 Cluster abnormal events count

diff --git a/cmd/certsuite/claim/compare/versions/versions_test.go b/cmd/certsuite/claim/compare/versions/versions_test.go
@@ -34,16 +34,16 @@ func TestCompare(t *testing.T) {
 					K8s:                "22",
 					OcClient:           "333",
 					Ocp:                "4444",
-					Certsuite:          "55555",
-					CertsuiteGitCommit: "666666",
+					CertSuite:          "55555",
+					CertSuiteGitCommit: "666666",
 				},
 				claim2Versions: &officialClaimScheme.Versions{
 					ClaimFormat:        "1",
 					K8s:                "22",
 					OcClient:           "333",
 					Ocp:                "4444",
-					Certsuite:          "55555",
-					CertsuiteGitCommit: "666666",
+					CertSuite:          "55555",
+					CertSuiteGitCommit: "666666",
 				},
 			},
 			want: &DiffReport{Diffs: &diff.Diffs{Name: "VERSIONS"}},
@@ -56,16 +56,16 @@ func TestCompare(t *testing.T) {
 					K8s:                "22AAA",
 					OcClient:           "333",
 					Ocp:                "4444",
-					Certsuite:          "55555",
-					CertsuiteGitCommit: "666666",
+					CertSuite:          "55555",
+					CertSuiteGitCommit: "666666",
 				},
 				claim2Versions: &officialClaimScheme.Versions{
 					ClaimFormat:        "1",
 					K8s:                "22",
 					OcClient:           "333",
 					Ocp:                "4444",
-					Certsuite:          "55555",
-					CertsuiteGitCommit: "666666",
+					CertSuite:          "55555",
+					CertSuiteGitCommit: "666666",
 				},
 			},
 			want: &DiffReport{Diffs: &diff.Diffs{
@@ -87,16 +87,16 @@ func TestCompare(t *testing.T) {
 					K8s:                "22AAA",
 					OcClient:           "333",
 					Ocp:                "4444",
-					Certsuite:          "55555",
-					CertsuiteGitCommit: "666666",
+					CertSuite:          "55555",
+					CertSuiteGitCommit: "666666",
 				},
 				claim2Versions: &officialClaimScheme.Versions{
 					ClaimFormat:        "1",
 					K8s:                "22",
 					OcClient:           "333",
 					Ocp:                "4444",
-					Certsuite:          "55555BBBB",
-					CertsuiteGitCommit: "666666",
+					CertSuite:          "55555BBBB",
+					CertSuiteGitCommit: "666666",
 				},
 			},
 			want: &DiffReport{Diffs: &diff.Diffs{
@@ -108,7 +108,7 @@ func TestCompare(t *testing.T) {
 						Claim2Value: "22",
 					},
 					{
-						FieldPath:   "/workload",
+						FieldPath:   "/certsuite",
 						Claim1Value: "55555",
 						Claim2Value: "55555BBBB",
 					},

diff --git a/cmd/certsuite/claim/show/failures/failures.go b/cmd/certsuite/claim/show/failures/failures.go
@@ -32,14 +32,14 @@ Test Suite: access-control
     Description: Ensures that containers do not use SYS_ADMIN capability
     Failure reasons:
        1 - Type: Container, Reason: Non compliant capability detected in container
-           Namespace: workload, Pod Name: test-887998557-8gwwm, Container Name: test, SCC Capability: SYS_ADMIN
+           Namespace: certsuite, Pod Name: test-887998557-8gwwm, Container Name: test, SCC Capability: SYS_ADMIN
        2 - Type: Container, Reason: Non compliant capability detected in container
-           Namespace: workload, Pod Name: test-887998557-pr2w5, Container Name: test, SCC Capability: SYS_ADMIN
+           Namespace: certsuite, Pod Name: test-887998557-pr2w5, Container Name: test, SCC Capability: SYS_ADMIN
   Test Case: access-control-security-context
     Description: Checks the security context matches one of the 4 categories
     Failure reasons:
        1 - Type: ContainerCategory, Reason: container category is NOT category 1 or category NoUID0
-           Namespace: workload, Pod Name: jack-6f88b5bfb4-q5cw6, Container Name: jack, Category: CategoryID4(anything not matching lower category)
+           Namespace: certsuite, Pod Name: jack-6f88b5bfb4-q5cw6, Container Name: jack, Category: CategoryID4(anything not matching lower category)
        2 - ...
        ...
 Test Suite: lifecycle
@@ -60,7 +60,7 @@ Test Suite: lifecycle
 				"type": "Container",
 				"reason": "Non compliant capability detected in container",
 				"spec": {
-				  "Namespace": "workload",
+				  "Namespace": "certsuite",
 				  "Pod Name": "test-887998557-8gwwm",
 				  "Container Name": "test",
 				  "SCC Capability": "SYS_ADMIN"
@@ -70,7 +70,7 @@ Test Suite: lifecycle
 				"type": "Container",
 				"reason": "Non compliant capability detected in container",
 				"spec": {
-				  "Namespace": "workload",
+				  "Namespace": "certsuite",
 				  "Pod Name": "test-887998557-pr2w5",
 				  "Container Name": "test",
 				  "SCC Capability": "SYS_ADMIN"

diff --git a/cmd/certsuite/claim/show/failures/failures_test.go b/cmd/certsuite/claim/show/failures/failures_test.go
@@ -119,7 +119,7 @@ func TestGetNonCompliantObjectsFromFailureReason(t *testing.T) {
 					],
 					"ObjectFieldsValues": [
 					  "Non compliant capability detected in container",
-					  "workload",
+					  "certSuite",
 					  "test-887998557-8gwwm",
 					  "test",
 					  "SYS_ADMIN"
@@ -138,7 +138,7 @@ func TestGetNonCompliantObjectsFromFailureReason(t *testing.T) {
 						}{
 							{
 								Key:   "Namespace",
-								Value: "workload",
+								Value: "certSuite",
 							},
 							{
 								Key:   "Pod Name",
@@ -173,7 +173,7 @@ func TestGetNonCompliantObjectsFromFailureReason(t *testing.T) {
 					],
 					"ObjectFieldsValues": [
 					  "Non compliant capability detected in container",
-					  "workload",
+					  "certSuite",
 					  "test-887998557-8gwwm",
 					  "test",
 					  "SYS_ADMIN"
@@ -190,7 +190,7 @@ func TestGetNonCompliantObjectsFromFailureReason(t *testing.T) {
 					],
 					"ObjectFieldsValues": [
 					  "Non compliant capability detected in container",
-					  "workload",
+					  "certSuite",
 					  "test-887998557-pr2w5",
 					  "test",
 					  "SYS_ADMIN"
@@ -210,7 +210,7 @@ func TestGetNonCompliantObjectsFromFailureReason(t *testing.T) {
 						}{
 							{
 								Key:   "Namespace",
-								Value: "workload",
+								Value: "certSuite",
 							},
 							{
 								Key:   "Pod Name",
@@ -237,7 +237,7 @@ func TestGetNonCompliantObjectsFromFailureReason(t *testing.T) {
 						}{
 							{
 								Key:   "Namespace",
-								Value: "workload",
+								Value: "certSuite",
 							},
 							{
 								Key:   "Pod Name",
@@ -322,7 +322,7 @@ func TestGetFailedTestCasesByTestSuite(t *testing.T) {
 										}{
 											{
 												Key:   "Namespace",
-												Value: "workload",
+												Value: "certSuite",
 											},
 											{
 												Key:   "Pod Name",
@@ -349,7 +349,7 @@ func TestGetFailedTestCasesByTestSuite(t *testing.T) {
 										}{
 											{
 												Key:   "Namespace",
-												Value: "workload",
+												Value: "certSuite",
 											},
 											{
 												Key:   "Pod Name",