feat: test models + list tests endpoint #2681

mathnogueira · 2023-06-07T19:18:05Z

This PR adds the list tests endpoint. I'll add the resource manager test in the next PR (POST /api/tests) because it will be way easier to do that way. It's hard to implement it right now because there's no easy way of adding the test into the database (I don't want to mess up with the models.Test object.

Checklist

tested locally
added new dependencies
updated the docs
added a test

mathnogueira · 2023-06-08T16:52:18Z

.github/workflows/pull-request.yaml

@@ -88,7 +88,7 @@ jobs:
          cache: true
          cache-dependency-path: go.work
      - name: Run unit tests
-        run: cd server; make test
+        run: cd server; make test -B


For some reason, this was not running the tests and was printing test is up-to-date. Adding the -B forces make to run this regardless of the cache.

xoscar

Hey @mathnogueira this looks great! One question have you done anything about the resource endpoint FE uses for the dashboard? or should stay as it is for the moment?

Awesome job! 🔥

xoscar · 2023-06-08T22:44:45Z

api/triggers.yaml

        triggerType:
          type: string
          enum: ["http", "grpc", "traceid"]
+        type:
+          type: string
+          enum: ["http", "grpc", "traceid"]


We can update the FE to use the new version right?

xoscar · 2023-06-08T22:44:54Z

server/app/app.go

+	registerDemosResource(demoRepo, apiRouter, provisioner, tracer)
+	registerDataStoreResource(dataStoreRepo, apiRouter, provisioner, tracer)
+	registerlinterResource(linterRepo, apiRouter, provisioner, tracer)
+	registerTestResource(testRepo, apiRouter, provisioner, tracer)


xoscar · 2023-06-08T22:46:10Z

server/test/trigger/grpc.go

@@ -0,0 +1,65 @@
+package trigger


I like that we moved the triggers here!

schoren

This is looking great. There are some improvements that we can make, since we're already working on this are, so I added some comments.

Specially around versioning of json representations. I think it's very important that we standardize on a way to handle this, since it's happened a few times so far, and it's very likely to keep happening

server/app/app.go

schoren · 2023-06-08T22:24:58Z

server/http/custom_routes.go

@@ -43,7 +43,6 @@ func (c *customController) Routes() openapi.Routes {

 	routes[c.getRouteIndex("GetTestRuns")].HandlerFunc = c.GetTestRuns

-	routes[c.getRouteIndex("GetTests")].HandlerFunc = paginatedEndpoint[openapi.Test](c.service.GetTests, c.errorHandler)


schoren · 2023-06-08T22:34:30Z

server/test/test_json.go

+	Assertions []Assertion
+}
+
+type keyValueSpec struct {


I think it would be better to version the entire TestSpec json instead of just the things that change, like here: https://github.com/kubeshop/tracetest/blob/main/server/model/trigger_json.go

This makes it easier to keep updating the json, adding new versions, with a standardized approach

schoren · 2023-06-08T22:35:44Z

server/test/test_json_test.go

+	"github.com/stretchr/testify/require"
+)
+
+func TestSpecRetrocompability(t *testing.T) {


Same for the tests: https://github.com/kubeshop/tracetest/blob/main/server/model/trigger_json_test.go

It's easier to understand the chronological order of the versions

server/test/tests.go

server/test/trigger/traceid.go

schoren · 2023-06-08T22:51:03Z

server/test/trigger/trigger.go

+	TraceID *TraceIDRequest `json:"traceid,omitempty"`
+}
+
+type oldTriggerFormat struct {


again, I think having "versioned" formats makes it easier to understand the chronology: https://github.com/kubeshop/tracetest/blob/main/server/model/trigger_json.go

schoren · 2023-06-08T22:52:24Z

server/test/trigger/trigger.go

+func (t *Trigger) UnmarshalJSON(data []byte) error {
+	var trigger triggerFormat
+	err := json.Unmarshal(data, &trigger)
+	if err != nil || trigger.Type == "" {


I think the current main version of this function is more future-friendly with the versioning: https://github.com/kubeshop/tracetest/blob/main/server/model/trigger_json.go#LL49C6-L49C6

Co-authored-by: Sebastian Choren <[email protected]>

mathnogueira · 2023-06-09T18:40:47Z

@schoren I changed all the things you mentioned

schoren

this is great! lef a few optional nits, but it's ready to merge!

schoren · 2023-06-09T18:43:16Z

.github/workflows/pull-request.yaml

@@ -4,7 +4,6 @@ on:
  push:
    branches: [main]
  pull_request:
-    branches: [main]


schoren · 2023-06-09T18:46:24Z

server/test/trigger/trigger_json.go

+		return deepcopy.DeepCopy(v2, t)
+	}
+
+	// v2


Suggested change

// v2

// v3

schoren · 2023-06-09T18:47:31Z

server/test/trigger/trigger_json_test.go

+	assert.Equal(t, expected, current)
+}
+
+func TestTriggerFormatV2(t *testing.T) {


do we need a TestTriggerFormatv3 or is that covered by other tests? if possible I would add it here for the sake of completeness

* add test, run, and trigger objects * feat: move test and run structs into the test package * list tests * add old format attributes again * fix mapping * compatibility mode * fix server prefix integration test * force server unit tests to run * fix tracetest test * trigger CI * Apply suggestions from code review Co-authored-by: Sebastian Choren <[email protected]> * fix build * version test specs * update test names * use sqlutils * dont specify branch target in pull_request * fix list test --------- Co-authored-by: Sebastian Choren <[email protected]>

* chore(docs): Adding App Insights Configuration Page (#2820) * chore(docs): Adding App Insights Configuration Page * fixing typo * fix(frontend): Fixing Resizable Panels UI bugs (#2827) * fix(tests): add analyzer resource to cli e2e table (#2826) * chore(docs): Azure App Insights Recipes (#2821) * chore(docs): Adding App Insights Configuration Page * chore(docs): Adding App Insights Recipes * chore(docs): Adding App Insights Recipes * chore(docs): fixing typo * adding recipe links * adding recipe links * fixing typo * chore(frotend): Test Definition Name Input (#2830) * chore(frotend): Updating Panel Splitter w/ Tooltip (#2828) * chore(frotend): Updating Panel Splitter w/ Tooltip * Updating theme color * removing unnecessary flag * undo change * fix(frontend): fix missing font-face (#2833) * feat(cli): refactor list formatter for better resource manager support (#2829) * feat(frontend): add independent trace vs test data (#2815) * feat(cli): refactor Get formatter for better resource manager support (#2831) * feat(cli): dynamic list of available resources (#2832) * feat(cli): refactor Delete to new resource manager client (#2836) * feat(cli): update export command with new resourcemanager client (#2838) * Standardize old resources to to use list method with SQL Injection protection and stardardize PollingProfile file (#2839) * wip: update list on demo and environment to use the same standards as tests and transactions * Fixing provisioning test * Update provisioning test * feature(frontend): Contact Us Modal (#2835) * feature(frontend): Contact Us Modal * feature(frontend): Contact Us Modal * feat(cli): update apply command with new resourcemanager client (#2841) * feat(frontend): trace vs test data for timeline and attribute list (#2837) * feat: new tests openapi spec (#2658) update get tests endpoint to use resource manager * fix: move transactions to it's own module (#2664) * fix: move transactions to the transactions folder * remove alias to transactions module * feat: test models + list tests endpoint (#2681) * add test, run, and trigger objects * feat: move test and run structs into the test package * list tests * add old format attributes again * fix mapping * compatibility mode * fix server prefix integration test * force server unit tests to run * fix tracetest test * trigger CI * Apply suggestions from code review Co-authored-by: Sebastian Choren <[email protected]> * fix build * version test specs * update test names * use sqlutils * dont specify branch target in pull_request * fix list test --------- Co-authored-by: Sebastian Choren <[email protected]> * 2659 cli improvements migrate tests to resource manager architecture get tests frontend (#2702) chore(frontend): updating FE to support GET /tests endpoint changes * feat: test list augmented response (#2732) add augmented list * fix(server): fix trigger json encoding versioning and test (#2795) * feat: test models + list tests endpoint (#2681) * add test, run, and trigger objects * feat: move test and run structs into the test package * list tests * add old format attributes again * fix mapping * compatibility mode * fix server prefix integration test * force server unit tests to run * fix tracetest test * trigger CI * Apply suggestions from code review Co-authored-by: Sebastian Choren <[email protected]> * fix build * version test specs * update test names * use sqlutils * dont specify branch target in pull_request * fix list test --------- Co-authored-by: Sebastian Choren <[email protected]> * GET endpoint * fix rebase * add create method and fix tests * add rest of methods * Changing test structure and fixing method by method * Update tests * Fixing test errors for Delete * Adding gRPC tests * Adding tests for traceid trigger * migrate rest of endpoints and fix compilation errors * fix all unit and integration tests * Improving tests * fix building errors --------- Co-authored-by: Oscar Reyes <[email protected]> Co-authored-by: Jorge Padilla <[email protected]> Co-authored-by: Sebastian Choren <[email protected]> Co-authored-by: Daniel Baptista Dias <[email protected]> Co-authored-by: Daniel Dias <[email protected]>

* feat: new tests openapi spec (#2658) update get tests endpoint to use resource manager * fix: move transactions to it's own module (#2664) * fix: move transactions to the transactions folder * remove alias to transactions module * feat: test models + list tests endpoint (#2681) * add test, run, and trigger objects * feat: move test and run structs into the test package * list tests * add old format attributes again * fix mapping * compatibility mode * fix server prefix integration test * force server unit tests to run * fix tracetest test * trigger CI * Apply suggestions from code review Co-authored-by: Sebastian Choren <[email protected]> * fix build * version test specs * update test names * use sqlutils * dont specify branch target in pull_request * fix list test --------- Co-authored-by: Sebastian Choren <[email protected]> * 2659 cli improvements migrate tests to resource manager architecture get tests frontend (#2702) chore(frontend): updating FE to support GET /tests endpoint changes * feat: test list augmented response (#2732) add augmented list * fix(server): fix trigger json encoding versioning and test (#2795) * WIP feat: get endpoint (#2789) * chore(docs): Adding App Insights Configuration Page (#2820) * chore(docs): Adding App Insights Configuration Page * fixing typo * fix(frontend): Fixing Resizable Panels UI bugs (#2827) * fix(tests): add analyzer resource to cli e2e table (#2826) * chore(docs): Azure App Insights Recipes (#2821) * chore(docs): Adding App Insights Configuration Page * chore(docs): Adding App Insights Recipes * chore(docs): Adding App Insights Recipes * chore(docs): fixing typo * adding recipe links * adding recipe links * fixing typo * chore(frotend): Test Definition Name Input (#2830) * chore(frotend): Updating Panel Splitter w/ Tooltip (#2828) * chore(frotend): Updating Panel Splitter w/ Tooltip * Updating theme color * removing unnecessary flag * undo change * fix(frontend): fix missing font-face (#2833) * feat(cli): refactor list formatter for better resource manager support (#2829) * feat(frontend): add independent trace vs test data (#2815) * feat(cli): refactor Get formatter for better resource manager support (#2831) * feat(cli): dynamic list of available resources (#2832) * feat(cli): refactor Delete to new resource manager client (#2836) * feat(cli): update export command with new resourcemanager client (#2838) * Standardize old resources to to use list method with SQL Injection protection and stardardize PollingProfile file (#2839) * wip: update list on demo and environment to use the same standards as tests and transactions * Fixing provisioning test * Update provisioning test * feature(frontend): Contact Us Modal (#2835) * feature(frontend): Contact Us Modal * feature(frontend): Contact Us Modal * feat(cli): update apply command with new resourcemanager client (#2841) * feat(frontend): trace vs test data for timeline and attribute list (#2837) * feat: new tests openapi spec (#2658) update get tests endpoint to use resource manager * fix: move transactions to it's own module (#2664) * fix: move transactions to the transactions folder * remove alias to transactions module * feat: test models + list tests endpoint (#2681) * add test, run, and trigger objects * feat: move test and run structs into the test package * list tests * add old format attributes again * fix mapping * compatibility mode * fix server prefix integration test * force server unit tests to run * fix tracetest test * trigger CI * Apply suggestions from code review Co-authored-by: Sebastian Choren <[email protected]> * fix build * version test specs * update test names * use sqlutils * dont specify branch target in pull_request * fix list test --------- Co-authored-by: Sebastian Choren <[email protected]> * 2659 cli improvements migrate tests to resource manager architecture get tests frontend (#2702) chore(frontend): updating FE to support GET /tests endpoint changes * feat: test list augmented response (#2732) add augmented list * fix(server): fix trigger json encoding versioning and test (#2795) * feat: test models + list tests endpoint (#2681) * add test, run, and trigger objects * feat: move test and run structs into the test package * list tests * add old format attributes again * fix mapping * compatibility mode * fix server prefix integration test * force server unit tests to run * fix tracetest test * trigger CI * Apply suggestions from code review Co-authored-by: Sebastian Choren <[email protected]> * fix build * version test specs * update test names * use sqlutils * dont specify branch target in pull_request * fix list test --------- Co-authored-by: Sebastian Choren <[email protected]> * GET endpoint * fix rebase * add create method and fix tests * add rest of methods * Changing test structure and fixing method by method * Update tests * Fixing test errors for Delete * Adding gRPC tests * Adding tests for traceid trigger * migrate rest of endpoints and fix compilation errors * fix all unit and integration tests * Improving tests * fix building errors --------- Co-authored-by: Oscar Reyes <[email protected]> Co-authored-by: Jorge Padilla <[email protected]> Co-authored-by: Sebastian Choren <[email protected]> Co-authored-by: Daniel Baptista Dias <[email protected]> Co-authored-by: Daniel Dias <[email protected]> * fix a couple of issues * fix wrong variable name * fix part of the tracetests * Fixing small bugs on server * Fixing test run problem * fix: tracetests (#2852) fix grpc tests and transaction tracetests * fixing FE tests and types * Updating test assertion validation * Tests cli resourcemanager client (#2849) * fixing FE tests and updating models * fixing FE tests and updating models * Updating trigger mapping to populate httpRequest field on OpenAPI based endpoints * Removing deprecated fields * fix trigger type in fe * add cli e2e test for test resource (#2854) * Fixed bug in dogfooding test * Making backend-arch-graph step not block CI on failure * fix trigger result type in fe * Deprecate commands (#2857) * Move test deprecated notice to subcommands * Update CLI e2e docs * fix(docs): fix deprecated test command (#2874) --------- Co-authored-by: Matheus Nogueira <[email protected]> Co-authored-by: Sebastian Choren <[email protected]> Co-authored-by: Jorge Padilla <[email protected]> Co-authored-by: Daniel Baptista Dias <[email protected]> Co-authored-by: Daniel Dias <[email protected]> Co-authored-by: Sebastian Choren <[email protected]>

mathnogueira added 4 commits June 5, 2023 18:01

add test, run, and trigger objects

95e447d

feat: move test and run structs into the test package

4f79cb0

list tests

ba15282

add old format attributes again

3633532

mathnogueira changed the base branch from main to feat/tests-as-resources June 7, 2023 19:35

mathnogueira added 4 commits June 8, 2023 13:41

fix mapping

16c6f1a

compatibility mode

ac15d99

fix server prefix integration test

ef47f89

force server unit tests to run

57a31c9

mathnogueira commented Jun 8, 2023

View reviewed changes

fix tracetest test

3b988b5

mathnogueira marked this pull request as ready for review June 8, 2023 19:26

trigger CI

f163265

xoscar approved these changes Jun 8, 2023

View reviewed changes

schoren suggested changes Jun 8, 2023

View reviewed changes

mathnogueira and others added 5 commits June 9, 2023 10:30

Apply suggestions from code review

7fe21c4

Co-authored-by: Sebastian Choren <[email protected]>

fix build

70f2c10

version test specs

fe72672

update test names

906de39

use sqlutils

ef7bca1

mathnogueira requested a review from schoren June 9, 2023 18:40

dont specify branch target in pull_request

c559c80

schoren approved these changes Jun 9, 2023

View reviewed changes

fix list test

b88e2ef

mathnogueira merged commit 156e841 into feat/tests-as-resources Jun 9, 2023

mathnogueira deleted the feat/test-models branch June 9, 2023 19:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: test models + list tests endpoint #2681

feat: test models + list tests endpoint #2681

mathnogueira commented Jun 7, 2023 •

edited

Loading

mathnogueira Jun 8, 2023

xoscar left a comment

xoscar Jun 8, 2023

xoscar Jun 8, 2023

xoscar Jun 8, 2023

schoren left a comment

schoren Jun 8, 2023

schoren Jun 8, 2023

schoren Jun 8, 2023

schoren Jun 8, 2023

schoren Jun 8, 2023

mathnogueira commented Jun 9, 2023

schoren left a comment

schoren Jun 9, 2023

schoren Jun 9, 2023

schoren Jun 9, 2023

		@@ -43,7 +43,6 @@ func (c *customController) Routes() openapi.Routes {

		routes[c.getRouteIndex("GetTestRuns")].HandlerFunc = c.GetTestRuns

		routes[c.getRouteIndex("GetTests")].HandlerFunc = paginatedEndpoint[openapi.Test](c.service.GetTests, c.errorHandler)

feat: test models + list tests endpoint #2681

feat: test models + list tests endpoint #2681

Conversation

mathnogueira commented Jun 7, 2023 • edited Loading

Checklist

Choose a reason for hiding this comment

xoscar 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

schoren 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

mathnogueira commented Jun 9, 2023

schoren 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

mathnogueira commented Jun 7, 2023 •

edited

Loading