refactor(ui): improve findings impact dashboard (#972)

* refactor: show rootkit message since too many unknown names * refactor(ui): display misconfiguration message in dashboard
openclarity · Nov 23, 2023 · d68ab44 · d68ab44
1 parent a87b65a
commit d68ab44
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 15 deletions.
diff --git a/pkg/uibackend/api/models/models.gen.go b/pkg/uibackend/api/models/models.gen.go
diff --git a/pkg/uibackend/api/openapi.yaml b/pkg/uibackend/api/openapi.yaml
@@ -242,6 +242,8 @@ components:
           type: string
         rootkitType:
           $ref: '#/components/schemas/RootkitType'
+        message:
+          type: string
 
     RootkitType:
       type: string

diff --git a/pkg/uibackend/api/server/server.gen.go b/pkg/uibackend/api/server/server.gen.go
diff --git a/pkg/uibackend/rest/dashboard_findings_impact.go b/pkg/uibackend/rest/dashboard_findings_impact.go
@@ -273,6 +273,7 @@ func createRootkitFindingImpact(findingInfo *backendmodels.Finding_FindingInfo,
 	return models.RootkitFindingImpact{
 		AffectedAssetsCount: &count,
 		Rootkit: &models.Rootkit{
+			Message:     info.Message,
 			RootkitName: info.RootkitName,
 			RootkitType: toModelsRootkitType(info.RootkitType),
 		},

diff --git a/pkg/uibackend/rest/dashboard_findings_impact_test.go b/pkg/uibackend/rest/dashboard_findings_impact_test.go
@@ -472,20 +472,23 @@ func Test_createFindingsImpact(t *testing.T) {
 				{
 					AffectedAssetsCount: utils.PointerTo(19),
 					Rootkit: &models.Rootkit{
+						Message:     utils.PointerTo("path1"),
 						RootkitName: utils.PointerTo("name1"),
 						RootkitType: utils.PointerTo(models.RootkitType("type1")),
 					},
 				},
 				{
 					AffectedAssetsCount: utils.PointerTo(7),
 					Rootkit: &models.Rootkit{
+						Message:     utils.PointerTo("path2"),
 						RootkitName: utils.PointerTo("name2"),
 						RootkitType: utils.PointerTo(models.RootkitType("type2")),
 					},
 				},
 				{
 					AffectedAssetsCount: utils.PointerTo(5),
 					Rootkit: &models.Rootkit{
+						Message:     utils.PointerTo("path3"),
 						RootkitName: utils.PointerTo("name3"),
 						RootkitType: utils.PointerTo(models.RootkitType("type3")),
 					},
@@ -532,34 +535,39 @@ func Test_createFindingsImpact(t *testing.T) {
 				{
 					AffectedAssetsCount: utils.PointerTo(19),
 					Rootkit: &models.Rootkit{
+						Message:     utils.PointerTo("path1"),
 						RootkitName: utils.PointerTo("name1"),
 						RootkitType: utils.PointerTo(models.RootkitType("type1")),
 					},
 				},
 				{
 					AffectedAssetsCount: utils.PointerTo(7),
 					Rootkit: &models.Rootkit{
+						Message:     utils.PointerTo("path2"),
 						RootkitName: utils.PointerTo("name2"),
 						RootkitType: utils.PointerTo(models.RootkitType("type2")),
 					},
 				},
 				{
 					AffectedAssetsCount: utils.PointerTo(5),
 					Rootkit: &models.Rootkit{
+						Message:     utils.PointerTo("path3"),
 						RootkitName: utils.PointerTo("name3"),
 						RootkitType: utils.PointerTo(models.RootkitType("type3")),
 					},
 				},
 				{
 					AffectedAssetsCount: utils.PointerTo(4),
 					Rootkit: &models.Rootkit{
+						Message:     utils.PointerTo("path4"),
 						RootkitName: utils.PointerTo("name3"),
 						RootkitType: utils.PointerTo(models.RootkitType("type3")),
 					},
 				},
 				{
 					AffectedAssetsCount: utils.PointerTo(3),
 					Rootkit: &models.Rootkit{
+						Message:     utils.PointerTo("path5"),
 						RootkitName: utils.PointerTo("name3"),
 						RootkitType: utils.PointerTo(models.RootkitType("type3")),
 					},

diff --git a/ui/src/layout/Dashboard/FindingsImpactWidget/index.js b/ui/src/layout/Dashboard/FindingsImpactWidget/index.js
@@ -33,9 +33,9 @@ const TABS_COLUMNS_MAPPING = {
 		]
 	},
 	[FINDINGS_MAPPING.MISCONFIGURATIONS.dataKey]: {
-		headerItems: ["Test description"],
+		headerItems: ["Message"],
 		bodyItems: [
-			{dataKey: "misconfiguration.testDescription"}
+			{dataKey: "misconfiguration.message"}
 		]
 	},
 	[FINDINGS_MAPPING.SECRETS.dataKey]: {
@@ -51,9 +51,10 @@ const TABS_COLUMNS_MAPPING = {
 		]
 	},
 	[FINDINGS_MAPPING.ROOTKITS.dataKey]: {
-		headerItems: ["Rootkit name"],
+		headerItems: ["Rootkit name", "Message"],
 		bodyItems: [
-			{dataKey: "rootkit.rootkitName"}
+			{dataKey: "rootkit.rootkitName"},
+			{dataKey: "rootkit.message"}
 		]
 	},
 	[FINDINGS_MAPPING.PACKAGES.dataKey]: {