Add a show command to the Diki CLI #412

georgibaltiev · 2024-12-23T11:55:14Z

What this PR does / why we need it:
This PR implements a new Cobra command that generates a JSON object containing the metadata of the specified provider and it's supported rulesets, or a JSON list of all providers available.

Which issue(s) this PR fixes:
Fixes #300

Special notes for your reviewer:

Release note:

Diki now has a `show` command that reveals metadata about the binary's supported providers and their rulesets

…access

dimityrmirchev

Thanks! I did an initial review. I would probably go once again over the PR once the comments are addressed.

dimityrmirchev · 2025-01-03T08:10:39Z

cmd/diki/app/app.go

+		Short: "",
+		Long:  "",


Suggested change

Short: "",

Long: "",

Short: "Show detailed information for the given provider.",

Long: "Show detailed information for the given provider.",

dimityrmirchev · 2025-01-03T08:19:13Z

pkg/metadata/metadata.go

@@ -0,0 +1,41 @@
+// SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and Gardener contributors


Suggested change

// SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and Gardener contributors

// SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Gardener contributors

dimityrmirchev · 2025-01-03T08:19:43Z

pkg/metadata/metadata.go

+
+// Version is used to represent a specific version of a ruleset
+type Version struct {
+	// Version is the human-readable name of the ruleset release


Suggested change

// Version is the human-readable name of the ruleset release

// Version is the name of the ruleset release.

dimityrmirchev · 2025-01-03T08:20:16Z

pkg/metadata/metadata.go

+type Version struct {
+	// Version is the human-readable name of the ruleset release
+	Version string `json:"version"`
+	// Latest is a bool tag that showcases if the specific version is the latest one


Suggested change

// Latest is a bool tag that showcases if the specific version is the latest one

// Latest shows if the specific version is the latest one.

dimityrmirchev · 2025-01-03T08:21:59Z

pkg/metadata/metadata.go

+	ProviderName string `json:"name"`
+}
+
+// ProviderMetadata is used to represent a specific provider and it's metadata


Please put dots at the end of all sentences.

dimityrmirchev · 2025-01-03T08:47:45Z

pkg/provider/builder/garden.go

+// GardenProviderMetadata returns available metadata for the Garden Provider and it's supported rulesets.
+func GardenProviderMetadata() metadata.ProviderMetadata {
+	providerMetadata := metadata.ProviderMetadata{}
+	providerMetadata.ProviderID = "garden"


This would not be correct if the provider id changes here

diki/cmd/diki/main.go

Lines 19 to 22 in a4a8e8f

"garden": builder.GardenProviderFromConfig,

"gardener": builder.GardenerProviderFromConfig,

"managedk8s": builder.ManagedK8SProviderFromConfig,

"virtualgarden": builder.VirtualGardenProviderFromConfig,

We should either fix the provider id to a constant or not hardcode it here.

dimityrmirchev · 2025-01-03T08:57:52Z

pkg/provider/builder/garden.go

+	var availableRulesets = map[string]string{
+		securityhardenedshoot.RulesetID: securityhardenedshoot.RulesetName,
+	}
+
+	for rulesetID, rulesetName := range availableRulesets {
+		rulesetMetadata := &metadata.RulesetMetadata{}
+		rulesetMetadata.RulesetID = rulesetID
+		rulesetMetadata.RulesetName = rulesetName
+		rulesetSupportedVersions := gardenGetSupportedVersions(rulesetMetadata.RulesetID)
+
+		for index, supportedVersion := range rulesetSupportedVersions {
+			if index == 0 {
+				rulesetMetadata.Versions = append(rulesetMetadata.Versions, metadata.Version{Version: supportedVersion, Latest: true})
+			} else {
+				rulesetMetadata.Versions = append(rulesetMetadata.Versions, metadata.Version{Version: supportedVersion, Latest: false})
+			}
+		}
+		providerMetadata.ProviderRulesets = append(providerMetadata.ProviderRulesets, *rulesetMetadata)
+	}
+
+	return providerMetadata


Why not just initialize the structs?

providerMetadata := metadata.ProviderMetadata{ ProviderID: "garden", ProviderName: "Garden", ProviderRulesets: []metadata.RulesetMetadata{ { RulesetID: securityhardenedshoot.RulesetID, RulesetName: securityhardenedshoot.RulesetName, }, }, } for i := range providerMetadata.ProviderRulesets { supportedVersions := gardenGetSupportedVersions(providerMetadata.ProviderRulesets[i].RulesetID) for _, supportedVersion := range supportedVersions { providerMetadata.ProviderRulesets[i].Versions = append( providerMetadata.ProviderRulesets[i].Versions, metadata.Version{Version: supportedVersion, Latest: false}, ) } // Mark the first version as latest as the versions are sorted from newest to oldest if len(providerMetadata.ProviderRulesets[i].Versions) > 0 { providerMetadata.ProviderRulesets[i].Versions[0].Latest = true } } return providerMetadata

pkg/provider/garden/ruleset/securityhardenedshoot/ruleset.go

cmd/diki/app/app.go

dimityrmirchev · 2025-01-03T09:02:17Z

cmd/diki/app/app.go

+	} else {
+		var providerArg = args[0]
+
+		metadataFunc, ok := providerFuncMap[providerArg]
+		if !ok {
+			return fmt.Errorf("provider %s does not exist in the current diki binary", providerArg)
+		}
+
+		providerMetadata := metadataFunc()
+
+		if bytes, err := json.Marshal(providerMetadata); err != nil {
+			return err
+		} else {
+			fmt.Println(string(bytes))
+		}
+	}


Suggested change

} else {

var providerArg = args[0]

metadataFunc, ok := providerFuncMap[providerArg]

if !ok {

return fmt.Errorf("provider %s does not exist in the current diki binary", providerArg)

}

providerMetadata := metadataFunc()

if bytes, err := json.Marshal(providerMetadata); err != nil {

return err

} else {

fmt.Println(string(bytes))

}

}

}

metadataFunc, ok := providerFuncMap[args[0]]

if !ok {

return fmt.Errorf("provider %s does not exist in the current diki binary", args[0])

}

if bytes, err := json.Marshal(metadataFunc()); err != nil {

return err

}

fmt.Println(string(bytes))

dimityrmirchev

Just a few minor remarks

dimityrmirchev · 2025-01-21T08:30:46Z

cmd/diki/app/app.go

@@ -124,6 +125,28 @@ e.g. to check compliance of your hyperscaler accounts.`,
 	addReportGenerateDiffFlags(generateDiffCmd, &generateDiffOpts)
 	generateCmd.AddCommand(generateDiffCmd)

+	showCmd := &cobra.Command{
+		Use:   "show",
+		Short: "Show metadata of the providers that the current diki binary supports.",


Suggested change

Short: "Show metadata of the providers that the current diki binary supports.",

Short: "Show metadata information for different diki internals, i.e. providers.",

dimityrmirchev · 2025-01-21T08:31:51Z

cmd/diki/app/app.go

+
+	showProviderCmd := &cobra.Command{
+		Use:   "provider",
+		Short: "Show detailed information for the given provider.",


Suggested change

Short: "Show detailed information for the given provider.",

Short: "Show detailed information for providers.",

dimityrmirchev · 2025-01-21T08:33:32Z

cmd/diki/app/app.go

+
+	metadataFunc, ok := metadataFuncs[args[0]]
+	if !ok {
+		return fmt.Errorf("provider %s does not exist in the current diki binary", args[0])


Suggested change

return fmt.Errorf("provider %s does not exist in the current diki binary", args[0])

return fmt.Errorf("unknown provider: %s", args[0])

dimityrmirchev · 2025-01-21T08:35:42Z

cmd/diki/app/app.go

 	"github.com/gardener/diki/pkg/provider"
 	"github.com/gardener/diki/pkg/report"
 	"github.com/gardener/diki/pkg/ruleset"
 )

 // NewDikiCommand creates a new command that is used to start Diki.
-func NewDikiCommand(providerCreateFuncs map[string]provider.ProviderFromConfigFunc) *cobra.Command {
+func NewDikiCommand(providerCreateFuncs map[string]provider.ProviderFromConfigFunc, metadataFuncs map[string]metadata.MetadataFunc) *cobra.Command {


Use a single map, so there is consistency across provider id keys.

dimityrmirchev · 2025-01-21T08:36:15Z

cmd/diki/app/app.go

@@ -156,6 +179,39 @@ func addReportGenerateDiffFlags(cmd *cobra.Command, opts *generateDiffOptions) {
 	cmd.PersistentFlags().Var(cliflag.NewMapStringString(&opts.identityAttributes), "identity-attributes", "The keys are the IDs of the providers that will be present in the generated difference report and the values are metadata attributes to be used as identifiers.")
 }

+func showProviderCmd(args []string, metadataFuncs map[string]metadata.MetadataFunc) error {
+	if len(args) > 1 {
+		return errors.New("command `show provider` accepts at most one provider")


Suggested change

return errors.New("command `show provider` accepts at most one provider")

return errors.New("command 'show provider' accepts at most one provider")

dimityrmirchev · 2025-01-21T08:38:42Z

pkg/metadata/metadata.go

+}
+
+// MetadataFunc constructs a detailed Provider metadata object.
+type MetadataFunc func() ProviderDetailed


Please move this func to pkg/provider/provider.go

pkg/provider/virtualgarden/provider.go

dimityrmirchev

/lgtm

georgibaltiev added 4 commits December 23, 2024 11:53

Add supported versions metadata for each ruleset instance

70446dc

Add ruleset version resolving methods to the provider definitions

5c608f6

Add comments

a69a4d4

Add show command implementation

d8ae1c3

georgibaltiev requested a review from a team as a code owner December 23, 2024 11:55

gardener-robot added needs/review Needs review size/m Size of pull request is medium (see gardener-robot robot/bots/size.py) labels Dec 23, 2024

georgibaltiev added 6 commits December 27, 2024 15:27

Move JSON defined structures into a separate module

30719f1

Move ruleset user-friendly names into constant variables for broader …

686523d

…access

Add description comments for the new constants

1de2bb0

Add functions that showcase each provider's metadata

619ac19

Refactor showProvider command and additional tabulations

6a31e32

formatting

d4a4f1c

gardener-robot added size/l Size of pull request is large (see gardener-robot robot/bots/size.py) needs/second-opinion Needs second review by someone else and removed size/m Size of pull request is medium (see gardener-robot robot/bots/size.py) labels Dec 27, 2024

gardener-robot-ci-2 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Dec 27, 2024

gardener-robot-ci-1 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Dec 27, 2024

dimityrmirchev requested changes Jan 3, 2025

View reviewed changes

georgibaltiev added 8 commits January 3, 2025 11:33

Rename variables and comments in the metadata and builder packages

c5e8f5e

Add comment and reference changes to the app command

688fadc

Add additional comments to the ruleset files

99e3b2e

Refactor metadata initalizing builder methods

683c7b5

Fix typo

98adb5e

Add constants to the provider definition files

9011efd

Add constants to the metadata builder methods

ff6f2e6

Declare and utilize a new string to Metadata map in main.go

03bc32a

gardener-robot-ci-1 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Jan 7, 2025

gardener-robot-ci-3 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Jan 7, 2025

Remove support for version v1r11

afe1993

gardener-robot-ci-2 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Jan 7, 2025

Correct some nits

d5ac7d0

gardener-robot-ci-3 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Jan 7, 2025

georgibaltiev requested a review from dimityrmirchev January 8, 2025 08:36

dimityrmirchev requested changes Jan 21, 2025

View reviewed changes

Add suggestions

94a0128

gardener-robot-ci-3 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Jan 21, 2025

Fix typo

271e590

gardener-robot-ci-2 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Jan 21, 2025

gardener-robot-ci-1 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Jan 21, 2025

Tabulation

7ca3599

gardener-robot-ci-2 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Jan 21, 2025

Change comments

8fbdbce

gardener-robot-ci-2 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Jan 21, 2025

dimityrmirchev approved these changes Jan 22, 2025

View reviewed changes

gardener-robot added reviewed/lgtm Has approval for merging and removed needs/changes Needs (more) changes needs/review Needs review needs/second-opinion Needs second review by someone else labels Jan 22, 2025

dimityrmirchev merged commit 6e41ef6 into gardener:main Jan 22, 2025
9 checks passed

gardener-robot-ci-3 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Jan 22, 2025

gardener-robot added the status/closed Issue is closed (either delivered or triaged) label Jan 22, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a show command to the Diki CLI #412

Add a show command to the Diki CLI #412

georgibaltiev commented Dec 23, 2024

dimityrmirchev left a comment

dimityrmirchev Jan 3, 2025

dimityrmirchev Jan 3, 2025

dimityrmirchev Jan 3, 2025

dimityrmirchev Jan 3, 2025

dimityrmirchev Jan 3, 2025

dimityrmirchev Jan 3, 2025

dimityrmirchev Jan 3, 2025

dimityrmirchev Jan 3, 2025

dimityrmirchev left a comment

dimityrmirchev Jan 21, 2025

dimityrmirchev Jan 21, 2025

dimityrmirchev Jan 21, 2025

dimityrmirchev Jan 21, 2025

dimityrmirchev Jan 21, 2025

dimityrmirchev Jan 21, 2025

dimityrmirchev left a comment

		@@ -0,0 +1,41 @@
		// SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and Gardener contributors

	// SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and Gardener contributors
	// SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Gardener contributors

	// Version is the human-readable name of the ruleset release
	// Version is the name of the ruleset release.

	// Latest is a bool tag that showcases if the specific version is the latest one
	// Latest shows if the specific version is the latest one.

	"garden": builder.GardenProviderFromConfig,
	"gardener": builder.GardenerProviderFromConfig,
	"managedk8s": builder.ManagedK8SProviderFromConfig,
	"virtualgarden": builder.VirtualGardenProviderFromConfig,

	Short: "Show metadata of the providers that the current diki binary supports.",
	Short: "Show metadata information for different diki internals, i.e. providers.",

	Short: "Show detailed information for the given provider.",
	Short: "Show detailed information for providers.",

	return fmt.Errorf("provider %s does not exist in the current diki binary", args[0])
	return fmt.Errorf("unknown provider: %s", args[0])

	return errors.New("command `show provider` accepts at most one provider")
	return errors.New("command 'show provider' accepts at most one provider")

Add a show command to the Diki CLI #412

Add a show command to the Diki CLI #412

Conversation

georgibaltiev commented Dec 23, 2024

dimityrmirchev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dimityrmirchev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dimityrmirchev left a comment

Choose a reason for hiding this comment