feature(CLI): Analyzer Resource Integration #2726

xoscar · 2023-06-13T19:24:13Z

This PR adds the actions and formatter to support the analyzer resource from the CLI

Changes

Adds analyzer actions
Adds analyzer formatter
Registers Analyzer actions to the resource actions object

Fixes

[Analyzer] Support analyzer resource from CLI #2722

Checklist

tested locally
added new dependencies
updated the docs
added a test

https://www.loom.com/share/45983054b6c548b6a21ed8b9a041936a

kdhamric

Watched the loom - looked great!

danielbdias

🤘

danielbdias · 2023-06-13T22:43:30Z

cli/actions/analyzer.go

+func (analyzer analyzerActions) Apply(ctx context.Context, fileContent file.File) (result *file.File, err error) {
+	result, err = analyzer.resourceClient.Update(ctx, fileContent, currentConfigID)
+	return result, err
+}


Suggested change

func (analyzer analyzerActions) Apply(ctx context.Context, fileContent file.File) (result *file.File, err error) {

result, err = analyzer.resourceClient.Update(ctx, fileContent, currentConfigID)

return result, err

}

func (analyzer analyzerActions) Apply(ctx context.Context, fileContent file.File) (*file.File, error) {

return analyzer.resourceClient.Update(ctx, fileContent, currentConfigID)

}

danielbdias · 2023-06-13T22:44:54Z

testing/cli-e2etest/testscenarios/analyzer/get_config_test.go

+	// When I try to set up a config
+	// Then it should be applied with success


Suggested change

// When I try to set up a config

// Then it should be applied with success

// When I try to set up an analyzer

// Then it should be applied with success

danielbdias · 2023-06-13T22:45:14Z

testing/cli-e2etest/testscenarios/analyzer/get_config_test.go

+	t.Run("get with no analyzer initialized", func(t *testing.T) {
+		// Given I am a Tracetest CLI user
+		// And I have my server recently created
+		// And no config previously registered


Suggested change

// And no config previously registered

// And no analyzer previously registered

danielbdias · 2023-06-13T22:45:37Z

testing/cli-e2etest/testscenarios/analyzer/get_config_test.go

+		// And I have my server recently created
+		// And no config previously registered
+
+		// When I try to get a config on yaml mode


Suggested change

// When I try to get a config on yaml mode

// When I try to get an analyzer on yaml mode

danielbdias · 2023-06-13T22:46:01Z

testing/cli-e2etest/testscenarios/analyzer/get_config_test.go

+		// And I have a config already set
+
+		// When I try to get a config on yaml mode


Suggested change

// And I have a config already set

// When I try to get a config on yaml mode

// And I have an analyzer already set

// When I try to get a analyzer on yaml mode

danielbdias · 2023-06-13T22:49:15Z

testing/cli-e2etest/testscenarios/analyzer/list_config_test.go

+		// When I try to list config on pretty mode and there is no config previously registered
+		// Then it should print an empty table
+		// Then it should print a table with 4 lines printed: header, separator, the default config item and empty line


Suggested change

// When I try to list config on pretty mode and there is no config previously registered

// Then it should print an empty table

// Then it should print a table with 4 lines printed: header, separator, the default config item and empty line

// When I try to list an analyzer on pretty mode and there is no analyzer previously registered

// Then it should print an empty table

// Then it should print a table with 4 lines printed: header, separator, the default analyzer item and empty line

danielbdias · 2023-06-13T22:49:47Z

testing/cli-e2etest/testscenarios/analyzer/list_config_test.go

+		// And I already have a config created
+
+		// When I try to list a config by an invalid field


Suggested change

// And I already have a config created

// When I try to list a config by an invalid field

// And I already have an analyzer created

// When I try to list one analyzer by an invalid field

danielbdias · 2023-06-13T22:50:20Z

testing/cli-e2etest/testscenarios/analyzer/list_config_test.go

+		// And I already have a config created
+
+		// When I try to list config again on yaml mode


Suggested change

// And I already have a config created

// When I try to list config again on yaml mode

// And I already have an analyzer created

// When I try to list one analyzer again on yaml mode

danielbdias · 2023-06-13T22:50:53Z

testing/cli-e2etest/testscenarios/analyzer/list_config_test.go

+		// And I already have a config created
+
+		// When I try to list config again on json mode


Suggested change

// And I already have a config created

// When I try to list config again on json mode

// And I already have an analyzer created

// When I try to list one analyzer again on json mode

danielbdias · 2023-06-13T22:51:54Z

testing/cli-e2etest/testscenarios/analyzer/list_config_test.go

+		// And I already have a config created
+
+		// When I try to list config again on pretty mode
+		// Then it should print a table with 4 lines printed: header, separator, config item and empty line


Suggested change

// And I already have a config created

// When I try to list config again on pretty mode

// Then it should print a table with 4 lines printed: header, separator, config item and empty line

// And I already have an analyzer created

// When I try to list one analyzer again on pretty mode

// Then it should print a table with 4 lines printed: header, separator, an analyzer item and empty line

jorgeepc

Looks good, a couple of questions.

jorgeepc · 2023-06-14T14:29:49Z

testing/cli-e2etest/testscenarios/analyzer/delete_config_test.go

@@ -0,0 +1,30 @@
+package analyzer


should the name of this file be delete_analyzer_test.go?

jorgeepc · 2023-06-14T14:30:12Z

testing/cli-e2etest/testscenarios/analyzer/get_config_test.go

@@ -0,0 +1,108 @@
+package analyzer


same here, get_analyzer_test.go?

jorgeepc · 2023-06-14T14:30:33Z

testing/cli-e2etest/testscenarios/analyzer/list_config_test.go

@@ -0,0 +1,120 @@
+package analyzer


list_analyzer_test.go?

* feature(CLI): Analyzer Resource Integration * feature(CLI): including e2e tests * feature(CLI): including e2e tests * feature(CLI): including e2e tests * fixing comments * fixing test file names

feature(CLI): Analyzer Resource Integration

29c0a89

xoscar added the CLI label Jun 13, 2023

xoscar self-assigned this Jun 13, 2023

xoscar linked an issue Jun 13, 2023 that may be closed by this pull request

[Analyzer] Support analyzer resource from CLI #2722

Closed

xoscar added 3 commits June 13, 2023 15:18

feature(CLI): including e2e tests

fea4a7e

feature(CLI): including e2e tests

e907209

feature(CLI): including e2e tests

e4a7894

xoscar requested review from danielbdias, schoren, mathnogueira and jorgeepc June 13, 2023 21:41

xoscar marked this pull request as ready for review June 13, 2023 21:41

kdhamric self-requested a review June 13, 2023 21:46

kdhamric approved these changes Jun 13, 2023

View reviewed changes

danielbdias approved these changes Jun 13, 2023

View reviewed changes

fixing comments

1ab4724

jorgeepc approved these changes Jun 14, 2023

View reviewed changes

fixing test file names

549801c

xoscar merged commit 707f918 into main Jun 15, 2023
24 checks passed

xoscar deleted the 2722-analyzer-support-analyzer-resource-from-cli branch June 15, 2023 14:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature(CLI): Analyzer Resource Integration #2726

feature(CLI): Analyzer Resource Integration #2726

xoscar commented Jun 13, 2023 •

edited

kdhamric left a comment

danielbdias left a comment

danielbdias Jun 13, 2023

danielbdias Jun 13, 2023

danielbdias Jun 13, 2023

danielbdias Jun 13, 2023

danielbdias Jun 13, 2023

danielbdias Jun 13, 2023

danielbdias Jun 13, 2023

danielbdias Jun 13, 2023

danielbdias Jun 13, 2023

danielbdias Jun 13, 2023

jorgeepc left a comment

jorgeepc Jun 14, 2023

jorgeepc Jun 14, 2023

jorgeepc Jun 14, 2023

		// When I try to set up a config
		// Then it should be applied with success

	// And no config previously registered
	// And no analyzer previously registered

	// When I try to get a config on yaml mode
	// When I try to get an analyzer on yaml mode

		// And I have a config already set

		// When I try to get a config on yaml mode

		// And I already have a config created

		// When I try to list a config by an invalid field

		// And I already have a config created

		// When I try to list config again on yaml mode

		// And I already have a config created

		// When I try to list config again on json mode

feature(CLI): Analyzer Resource Integration #2726

feature(CLI): Analyzer Resource Integration #2726

Conversation

xoscar commented Jun 13, 2023 • edited

Changes

Fixes

Checklist

kdhamric left a comment

Choose a reason for hiding this comment

danielbdias 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeepc 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

xoscar commented Jun 13, 2023 •

edited