feature: Tracetest Linter 🐙 #2547

xoscar · 2023-05-16T10:27:13Z

This PR adds the first version of the Tracetest Linter to the project, including the following features:

Enable/disable the linter
Score system
Minimum score to break the tests
Plugins and rules

Changes

Adds new components to support the linter system
Includes new domain for the BE to support linter plugins and rules
Wires up the linter to the test runner

Checklist

tested locally
added new dependencies
updated the docs
added a test

https://www.loom.com/share/577fd2cb4f3b45b6be9b8c6c6e0abfe0

…o feature/the-dream

olha23 · 2023-05-31T10:21:46Z

@xoscar i have couple comments:
Settings page needs to be improved:

I prefer to place toggle before the text, like we did on configure data store page. It looks more clear.
what mean that Required checkboxes near each of toggles? If you explain it maybe I can create more good visual representation for it.
need to add some info icon near each of plugins where we give short explanation for them
Lint result page:
Circle charts must be align in one line at top
results for each of plugins not looks collapsed, please make it like in my mockups (with arrow)

xoscar · 2023-05-31T16:23:51Z

Moving @schoren slack comment to the PRs thread

This looks awesome. My only suggestion would be: in the tracing page, where you see the lint results, we could add some text explaining what this is (or linking to docs), and a link to the settings to enable/disable it.
If the setting is disabled, I’d show some text encouraging users to enable, and again the link to settings.
Other than that, while everything can always be improved, I think it’s a good enough v1 for this feature, and it looks very appealing IMO

xoscar · 2023-05-31T18:30:28Z

Hello @schoren and @olha23 I just updated the PR with some changes based on your feedback. Here's a video demonstrating the things that changed

https://www.loom.com/share/42a61e7ac7e546b0814cedb6a7fe0e30

schoren · 2023-05-31T19:12:51Z

looks good to me!

danielbdias

First of all: fantastic work, team! This feature is pretty cool!

I've added some comments about one little thing here or there in the code that we can improve, but that can be on future versions.

danielbdias · 2023-05-31T18:59:53Z

server/app/app.go

@@ -23,6 +23,7 @@ import (
 	httpServer "github.com/kubeshop/tracetest/server/http"
 	"github.com/kubeshop/tracetest/server/http/mappings"
 	"github.com/kubeshop/tracetest/server/http/websocket"
+	linter_resource "github.com/kubeshop/tracetest/server/linter/resource"


Nit: we should avoid snake_case and use camelCase here.

danielbdias · 2023-05-31T19:00:55Z

server/app/facade.go

@@ -7,6 +7,7 @@ import (
 	"github.com/kubeshop/tracetest/server/executor"
 	"github.com/kubeshop/tracetest/server/executor/pollingprofile"
 	"github.com/kubeshop/tracetest/server/executor/trigger"
+	linter_resource "github.com/kubeshop/tracetest/server/linter/resource"


Same here. Can we rename this to camelCase?

danielbdias · 2023-05-31T19:01:37Z

server/executor/linter_runner.go

+
+	"github.com/kubeshop/tracetest/server/analytics"
+	"github.com/kubeshop/tracetest/server/linter"
+	linter_resource "github.com/kubeshop/tracetest/server/linter/resource"


Can we change to camelCase?

danielbdias · 2023-05-31T19:02:53Z

server/executor/linter_runner.go

+	}
+}
+
+func (e *defaultlinterRunner) Runlinter(ctx context.Context, request LinterRequest) {


Suggested change

func (e *defaultlinterRunner) Runlinter(ctx context.Context, request LinterRequest) {

func (e *defaultlinterRunner) RunLinter(ctx context.Context, request LinterRequest) {

danielbdias · 2023-05-31T19:09:32Z

server/linter/plugins/common/rules/enforce_dns.go

+	dnsFields = []string{"net.peer.name", "http.url", "db.connection_string", "net.sock.peer.addr", "net.host.name"}
+)


To think in the future: can we open this configuration this somehow in the future (probably as an outside yaml)?

Some linters as ESLint (https://eslint.org/docs/latest/rules/array-callback-return) and Rubocop (https://docs.rubocop.org/rubocop/1.51/configuration.html) does this.

Yes sir, we are going to have a bunch of fancy ways to configure the octolint

danielbdias · 2023-05-31T19:14:17Z

server/model/events/events.go

+		TestID:              testID,
+		RunID:               runID,
+		Stage:               model.StageTrace,
+		Type:                "TRACE_linter_START",


Suggested change

Type: "TRACE_linter_START",

Type: "TRACE_LINTER_START",

danielbdias · 2023-05-31T19:14:32Z

server/model/events/events.go

+		TestID:              testID,
+		RunID:               runID,
+		Stage:               model.StageTrace,
+		Type:                "TRACE_linter_SKIPPED",


Suggested change

Type: "TRACE_linter_SKIPPED",

Type: "TRACE_LINTER_SKIPPED",

danielbdias · 2023-05-31T19:14:44Z

server/model/events/events.go

+		TestID:              testID,
+		RunID:               runID,
+		Stage:               model.StageTrace,
+		Type:                "TRACE_linter_SUCCESS",


Suggested change

Type: "TRACE_linter_SUCCESS",

Type: "TRACE_LINTER_SUCCESS",

danielbdias · 2023-05-31T19:14:57Z

server/model/events/events.go

+		TestID:              testID,
+		RunID:               runID,
+		Stage:               model.StageTrace,
+		Type:                "TRACE_linter_ERROR",


Suggested change

Type: "TRACE_linter_ERROR",

Type: "TRACE_LINTER_ERROR",

danielbdias · 2023-05-31T19:17:11Z

web/cypress/e2e/Transactions/TransactionsRun.spec.ts

@@ -62,7 +62,7 @@ describe('Transactions', () => {

    cy.submitCreateForm('CreateTransactionFactory');
    cy.get('[data-cy=transaction-details-name').should('have.text', `${name} (v1)`);
-    cy.get('[data-cy=transaction-run-button]', {timeout: 30000}).should('be.visible');
+    cy.get('[data-cy=transaction-run-button]', {timeout: 50000}).should('be.visible');


Should timeout be a constant on this test file?

We need to revamp the FE e2e tests, which would include cleaning up all of this 💩 more tests, better tests!

* feature: The Dream 💜 * feature(openapi): adding specs for linterns * updating types for lintern * updating types for lintern * adding lintern resource logic * feature(cli): fixing UI type * add runner structure * add rule to check if there are missing required attributes * add test to required attributes rule * registering lintern resource on app * registering lintern resource on app * feat(frontend): add linter settings page * adding lintern runner logic * registering lintern resource on app * feat(frontend): add LintResult component in test run page * first working version * fix(frontend): fix rule results * add not empty attribute rule * feat(frontend): add LinterResults component styles * add rule to validate attribute names * remove anonymous variables * rename files * add kind to span and add span naming rule * registering rules * finishing required attrs rule * feat(frontend): add dag lint icon and result click * feat(frontend): add linter loading component * adding common and security plugins * feat(frontend): add dag lint errors component * UI cleanup * UI cleanup * fix(frontend): fix styles and linter settings * feat(frontend): add octolint footer * fixing unit tests * fixing unit tests * fixing annoying typo * fixing e2e tests * cleanup changes * tracetest linter UX mvp improvements * tracetest linter UX mvp improvements * PR comments and beta badge --------- Co-authored-by: Matheus Nogueira <matheus.nogueira2008@gmail.com> Co-authored-by: Jorge Padilla <jorge.esteban.padilla@gmail.com>

feature: The Dream 💜

da44b8a

xoscar self-assigned this May 16, 2023

xoscar and others added 28 commits May 16, 2023 20:41

feature(openapi): adding specs for linterns

4240cf5

updating types for lintern

0b15b07

updating types for lintern

6735cf7

adding lintern resource logic

06a9f96

feature(cli): fixing UI type

bef8ba3

add runner structure

7532390

add rule to check if there are missing required attributes

537b2ae

add test to required attributes rule

ce1c622

registering lintern resource on app

9f06782

registering lintern resource on app

ed12ff6

feat(frontend): add linter settings page

8760f47

adding lintern runner logic

a777ea8

registering lintern resource on app

55cdd49

feat(frontend): add LintResult component in test run page

bbdd135

first working version

ca98dbb

fix(frontend): fix rule results

6c9d430

Merge branch 'feature/the-dream' of github.com:kubeshop/tracetest int…

51e4ad8

…o feature/the-dream

add not empty attribute rule

3b6d065

feat(frontend): add LinterResults component styles

5dc5487

add rule to validate attribute names

f72a23e

Merge branch 'feature/the-dream' of github.com:kubeshop/tracetest int…

5507899

…o feature/the-dream

remove anonymous variables

0bf54fa

rename files

6da6312

add kind to span and add span naming rule

cf4b0aa

registering rules

046c62d

finishing required attrs rule

f1bcdf7

feat(frontend): add dag lint icon and result click

92b80c1

feat(frontend): add linter loading component

caf894f

fixing annoying typo

f97baea

xoscar changed the title ~~feature: Tracetest OctoLint 🐙~~ feature: Tracetest Linter 🐙 May 29, 2023

xoscar added 3 commits May 30, 2023 11:53

fixing e2e tests

be52464

Merge branch 'main' into feature/the-dream

48ac283

cleanup changes

f41d7d4

xoscar marked this pull request as ready for review May 30, 2023 18:20

xoscar assigned mathnogueira and jorgeepc May 30, 2023

xoscar added enhancement New feature or request frontend backend labels May 30, 2023

xoscar added 2 commits May 31, 2023 12:25

tracetest linter UX mvp improvements

c7da6b8

tracetest linter UX mvp improvements

d4d3006

xoscar requested review from jorgeepc, mathnogueira, kdhamric, olha23 and danielbdias and removed request for jorgeepc May 31, 2023 18:30

danielbdias approved these changes May 31, 2023

View reviewed changes

PR comments and beta badge

b8833ce

xoscar requested a review from schoren May 31, 2023 21:50

xoscar merged commit a5de528 into main May 31, 2023
28 checks passed

xoscar deleted the feature/the-dream branch May 31, 2023 22:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: Tracetest Linter 🐙 #2547

feature: Tracetest Linter 🐙 #2547

xoscar commented May 16, 2023 •

edited

Loading

olha23 commented May 31, 2023

xoscar commented May 31, 2023

xoscar commented May 31, 2023

schoren commented May 31, 2023

danielbdias left a comment

danielbdias May 31, 2023

danielbdias May 31, 2023

danielbdias May 31, 2023

danielbdias May 31, 2023

danielbdias May 31, 2023

xoscar May 31, 2023

danielbdias May 31, 2023

danielbdias May 31, 2023

danielbdias May 31, 2023

danielbdias May 31, 2023

danielbdias May 31, 2023

xoscar May 31, 2023

	func (e *defaultlinterRunner) Runlinter(ctx context.Context, request LinterRequest) {
	func (e *defaultlinterRunner) RunLinter(ctx context.Context, request LinterRequest) {

		dnsFields = []string{"net.peer.name", "http.url", "db.connection_string", "net.sock.peer.addr", "net.host.name"}
		)

feature: Tracetest Linter 🐙 #2547

feature: Tracetest Linter 🐙 #2547

Conversation

xoscar commented May 16, 2023 • edited Loading

Changes

Checklist

olha23 commented May 31, 2023

xoscar commented May 31, 2023

xoscar commented May 31, 2023

schoren commented May 31, 2023

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xoscar commented May 16, 2023 •

edited

Loading