Add generate diff command to create html difference reports by AleksandarSavchev · Pull Request #199 · gardener/diki

AleksandarSavchev · 2024-03-26T15:09:16Z

What this PR does / why we need it:
This PR adds a new diki report generate diff command that creates a html difference report with 1 or more json difference reports. The --identity-attributes is required, it's value is a list of key=value pairs, where the keys are the IDs for the providers that will be present in the generated difference report and the values are metadata attributes to be used as IDs.

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

Special notes for your reviewer:

Release note:

A new command `diki report generate diff` that converts one or more `json` difference reports into a single `html` difference report was introduced.

gardener-robot · 2024-04-01T03:07:43Z

@dimityrmirchev You have pull request review open invite, please check

dimityrmirchev

Looks, good. Only some cosmetic suggestions.

dimityrmirchev · 2024-04-01T10:12:31Z

 #### Difference

-Diki can generate a json containing the difference between 2 output files of `diki run` executions. This can help to identify improvements (or regressions).
+Diki can generate a json containing the difference between 2 output files of `diki run` executions. This can help to identify improvements (or regressions). A human readable html difference report can also be generated from the json difference reports.


Suggested change

Diki can generate a json containing the difference between 2 output files of `diki run` executions. This can help to identify improvements (or regressions). A human readable html difference report can also be generated from the json difference reports.

Diki can generate a json containing the difference between 2 output files of `diki run` executions. This can help to identify improvements (or regressions). A human readable html difference report can be generated from the difference reports.

dimityrmirchev · 2024-04-01T10:14:32Z

+diki report diff --title=Title --old=output1.json --new=output2.json --output=difference.json
+```
+
+- Generate html difference report from 1 or more json difference reports.


Suggested change

- Generate html difference report from 1 or more json difference reports.

- Combine one or more json difference reports to an html report.

dimityrmirchev · 2024-04-01T10:15:56Z

+
+- Generate html difference report from 1 or more json difference reports.
+```bash
+diki report generate diff --unique-attributes=gardener=id --output=difference.html difference1.json difference2.json


Suggested change

diki report generate diff --unique-attributes=gardener=id --output=difference.html difference1.json difference2.json

diki report generate diff --identity-attributes=gardener=id --output=difference.html difference1.json difference2.json

dimityrmirchev · 2024-04-01T10:17:25Z

+		Short: "Generate diff converts difference reports to html.",
+		Long:  "Generate diff converts difference reports to html.",


Suggested change

Short: "Generate diff converts difference reports to html.",

Long: "Generate diff converts difference reports to html.",

Short: "Generate diff combines difference reports into an html report.",

Long: "Generate diff converts difference reports to html.",

dimityrmirchev · 2024-04-01T10:17:48Z

 func addReportDiffFlags(cmd *cobra.Command, opts *diffOptions) {
 	cmd.PersistentFlags().StringVar(&opts.oldReport, "old", "", "Old report path.")
 	cmd.PersistentFlags().StringVar(&opts.newReport, "new", "", "New report path.")
+	cmd.PersistentFlags().StringVar(&opts.title, "title", "", "Title for difference report.")


Suggested change

cmd.PersistentFlags().StringVar(&opts.title, "title", "", "Title for difference report.")

cmd.PersistentFlags().StringVar(&opts.title, "title", "", "The title of a difference report.")

dimityrmirchev · 2024-04-01T10:18:36Z

+}
+
+func addReportGenerateDiffFlags(cmd *cobra.Command, opts *generateDiffOptions) {
+	cmd.PersistentFlags().Var(cliflag.NewMapStringString(&opts.uniqueAttributes), "unique-attributes", "The keys are the IDs for the providers that will be present in the generated difference report and the values are metadata attributes to be used as IDs")


Suggested change

cmd.PersistentFlags().Var(cliflag.NewMapStringString(&opts.uniqueAttributes), "unique-attributes", "The keys are the IDs for the providers that will be present in the generated difference report and the values are metadata attributes to be used as IDs")

cmd.PersistentFlags().Var(cliflag.NewMapStringString(&opts.uniqueAttributes), "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.")

dimityrmirchev · 2024-04-01T10:19:59Z

+	htlmRenderer, err := report.NewHTMLRenderer()
+	if err != nil {
+		return fmt.Errorf("failed to initialize renderer: %w", err)
+	}


This can be moved closer to its usage.

dimityrmirchev · 2024-04-01T10:21:12Z

 }

+type generateDiffOptions struct {
+	uniqueAttributes map[string]string


This should be renamed

dimityrmirchev · 2024-04-01T10:21:34Z

-// Difference contains the difference between 2 reports.
-type Difference struct {
+// DifferenceReportWrapper wraps DifferenceReports and additional attributes needed for html rendering.
+type DifferenceReportWrapper struct {


Suggested change

type DifferenceReportWrapper struct {

type DifferenceReportsWrapper struct {

dimityrmirchev · 2024-04-01T10:26:02Z

+	return template.HTML(summaryBuilder.String()) //nolint:gosec
+}
+
+func getDiffUniqAttrsText(providerDiff ProviderDifference, key string) string {


Suggested change

func getDiffUniqAttrsText(providerDiff ProviderDifference, key string) string {

func getProviderDiffIDText(providerDiff ProviderDifference, key string) string {

dimityrmirchev

/lgtm

Add report generate diff command

e0defc7

AleksandarSavchev requested a review from dimityrmirchev March 26, 2024 15:09

gardener-robot added needs/review size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 26, 2024

gardener-robot-ci-1 added reviewed/ok-to-test and removed reviewed/ok-to-test labels Mar 26, 2024

AleksandarSavchev added 3 commits March 29, 2024 14:50

Add difference_report.html to dep5

f0ff572

Address feedback

0ac6a13

Whitelist template HTML usage

2fba0dd

gardener-robot-ci-2 added reviewed/ok-to-test and removed reviewed/ok-to-test labels Mar 29, 2024

AleksandarSavchev marked this pull request as ready for review March 29, 2024 13:11

AleksandarSavchev requested a review from a team as a code owner March 29, 2024 13:11

Improve README

27200ae

gardener-robot-ci-2 added the reviewed/ok-to-test label Apr 1, 2024

gardener-robot-ci-1 removed the reviewed/ok-to-test label Apr 1, 2024

AleksandarSavchev added 2 commits April 1, 2024 12:35

Minor improvements

af2e27d

Use camel case for html template functions

27015e1

gardener-robot-ci-2 added reviewed/ok-to-test and removed reviewed/ok-to-test labels Apr 1, 2024

dimityrmirchev requested changes Apr 1, 2024

View reviewed changes

gardener-robot added the needs/changes label Apr 1, 2024

Add suggested changes

b278152

ghost added reviewed/ok-to-test and removed reviewed/ok-to-test labels Apr 1, 2024

AleksandarSavchev requested a review from dimityrmirchev April 1, 2024 12:38

dimityrmirchev approved these changes Apr 1, 2024

View reviewed changes

gardener-robot added reviewed/lgtm and removed needs/changes labels Apr 1, 2024

gardener-robot-ci-2 added the reviewed/ok-to-test label Apr 1, 2024

AleksandarSavchev merged commit 687f282 into gardener:main Apr 1, 2024

gardener-robot added the status/closed label Apr 1, 2024

	Diki can generate a json containing the difference between 2 output files of `diki run` executions. This can help to identify improvements (or regressions). A human readable html difference report can also be generated from the json difference reports.
	Diki can generate a json containing the difference between 2 output files of `diki run` executions. This can help to identify improvements (or regressions). A human readable html difference report can be generated from the difference reports.

	- Generate html difference report from 1 or more json difference reports.
	- Combine one or more json difference reports to an html report.

	diki report generate diff --unique-attributes=gardener=id --output=difference.html difference1.json difference2.json
	diki report generate diff --identity-attributes=gardener=id --output=difference.html difference1.json difference2.json

		Short: "Generate diff converts difference reports to html.",
		Long: "Generate diff converts difference reports to html.",

	cmd.PersistentFlags().StringVar(&opts.title, "title", "", "Title for difference report.")
	cmd.PersistentFlags().StringVar(&opts.title, "title", "", "The title of a difference report.")

	cmd.PersistentFlags().Var(cliflag.NewMapStringString(&opts.uniqueAttributes), "unique-attributes", "The keys are the IDs for the providers that will be present in the generated difference report and the values are metadata attributes to be used as IDs")
	cmd.PersistentFlags().Var(cliflag.NewMapStringString(&opts.uniqueAttributes), "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.")

	type DifferenceReportWrapper struct {
	type DifferenceReportsWrapper struct {

	func getDiffUniqAttrsText(providerDiff ProviderDifference, key string) string {
	func getProviderDiffIDText(providerDiff ProviderDifference, key string) string {

Conversation

AleksandarSavchev commented Mar 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gardener-robot commented Apr 1, 2024

Uh oh!

dimityrmirchev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dimityrmirchev left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

AleksandarSavchev commented Mar 26, 2024 •

edited

Loading