feat: add endpoint to list events from a test run (#2276)

add endpoint to list events from a test run

api/openapi.yaml

@@ -863,7 +863,7 @@ paths:
         - in: path
           name: runId
           schema:
-            type: string
+            type: integer
           required: true
       summary: "get events from a test run"
       description: "get events from a test run"

api/testEvents.yaml

@@ -22,7 +22,7 @@ components:
         testId:
           type: string
         runId:
-          type: string
+          type: integer
         dataStoreConnection:
           $ref: "./config.yaml#/components/schemas/ConnectionResult"
         polling:

server/http/controller.go

@@ -184,8 +184,13 @@ func (c *controller) GetTestRun(ctx context.Context, testID, runID string) (open
 	return openapi.Response(200, c.mappers.Out.Run(&run)), nil
 }
 
-func (*controller) GetTestRunEvents(context.Context, string, string) (openapi.ImplResponse, error) {
-	return openapi.Response(http.StatusOK, []openapi.TestRunEvent{}), nil
+func (c *controller) GetTestRunEvents(ctx context.Context, testID string, runID int32) (openapi.ImplResponse, error) {
+	events, err := c.testDB.GetTestRunEvents(ctx, id.ID(testID), int(runID))
+	if err != nil {
+		return openapi.Response(http.StatusInternalServerError, nil), err
+	}
+
+	return openapi.Response(http.StatusOK, c.mappers.Out.TestRunEvents(events)), nil
 }
 
 func (c *controller) DeleteTestRun(ctx context.Context, testID, runID string) (openapi.ImplResponse, error) {

server/http/mappings/test_run_events.go

@@ -0,0 +1,64 @@
+package mappings
+
+import (
+	"github.com/kubeshop/tracetest/server/model"
+	"github.com/kubeshop/tracetest/server/openapi"
+)
+
+func (m OpenAPI) TestRunEvents(in []model.TestRunEvent) []openapi.TestRunEvent {
+	out := make([]openapi.TestRunEvent, 0, len(in))
+	for _, event := range in {
+		out = append(out, m.TestRunEvent(event))
+	}
+
+	return out
+}
+
+func (m OpenAPI) TestRunEvent(in model.TestRunEvent) openapi.TestRunEvent {
+	return openapi.TestRunEvent{
+		Type:                in.Type,
+		Stage:               string(in.Stage),
+		Description:         in.Description,
+		CreatedAt:           in.CreatedAt,
+		TestId:              string(in.TestID),
+		RunId:               int32(in.RunID),
+		DataStoreConnection: m.ConnectionTestResult(in.DataStoreConnection),
+		Polling:             m.PollingInfo(in.Polling),
+		Outputs:             m.OutputsInfo(in.Outputs),
+	}
+}
+
+func (m OpenAPI) PollingInfo(in model.PollingInfo) openapi.PollingInfo {
+	return openapi.PollingInfo{
+		Type:                string(in.Type),
+		ReasonNextIteration: in.ReasonNextIteration,
+		IsComplete:          in.IsComplete,
+		Periodic:            m.PeriodicPollingInfo(in.Periodic),
+	}
+}
+
+func (m OpenAPI) PeriodicPollingInfo(in *model.PeriodicPollingConfig) openapi.PollingInfoPeriodic {
+	if in == nil {
+		return openapi.PollingInfoPeriodic{}
+	}
+
+	return openapi.PollingInfoPeriodic{
+		NumberSpans:      int32(in.NumberSpans),
+		NumberIterations: int32(in.NumberIterations),
+	}
+}
+
+func (m OpenAPI) OutputsInfo(in []model.OutputInfo) []openapi.OutputInfo {
+	out := make([]openapi.OutputInfo, 0, len(in))
+	for _, output := range in {
+		newOutput := openapi.OutputInfo{
+			LogLevel:   string(output.LogLevel),
+			Message:    output.Message,
+			OutputName: output.OutputName,
+		}
+
+		out = append(out, newOutput)
+	}
+
+	return out
+}

server/openapi/api.go

@@ -116,7 +116,7 @@ type ApiApiServicer interface {
 	GetTest(context.Context, string) (ImplResponse, error)
 	GetTestResultSelectedSpans(context.Context, string, string, string) (ImplResponse, error)
 	GetTestRun(context.Context, string, string) (ImplResponse, error)
-	GetTestRunEvents(context.Context, string, string) (ImplResponse, error)
+	GetTestRunEvents(context.Context, string, int32) (ImplResponse, error)
 	GetTestRuns(context.Context, string, int32, int32) (ImplResponse, error)
 	GetTestSpecs(context.Context, string) (ImplResponse, error)
 	GetTestVersion(context.Context, string, int32) (ImplResponse, error)

server/openapi/api_api.go

@@ -858,7 +858,11 @@ func (c *ApiApiController) GetTestRunEvents(w http.ResponseWriter, r *http.Reque
 	params := mux.Vars(r)
 	testIdParam := params["testId"]
 
-	runIdParam := params["runId"]
+	runIdParam, err := parseInt32Parameter(params["runId"], true)
+	if err != nil {
+		c.errorHandler(w, r, &ParsingError{Err: err}, nil)
+		return
+	}
 
 	result, err := c.service.GetTestRunEvents(r.Context(), testIdParam, runIdParam)
 	// If an error occurred, encode the error with the status code

server/openapi/model_test_run_event.go

@@ -26,7 +26,7 @@ type TestRunEvent struct {
 
 	TestId string `json:"testId,omitempty"`
 
-	RunId string `json:"runId,omitempty"`
+	RunId int32 `json:"runId,omitempty"`
 
 	DataStoreConnection ConnectionResult `json:"dataStoreConnection,omitempty"`
 

web/src/types/Generated.types.ts

@@ -818,7 +818,7 @@ export interface operations {
     parameters: {
       path: {
         testId: string;
-        runId: string;
+        runId: number;
       };
     };
     responses: {
@@ -1802,7 +1802,7 @@ export interface external {
           /** Format: date-time */
           createdAt?: string;
           testId?: string;
-          runId?: string;
+          runId?: number;
           dataStoreConnection?: external["config.yaml"]["components"]["schemas"]["ConnectionResult"];
           polling?: external["testEvents.yaml"]["components"]["schemas"]["PollingInfo"];
           outputs?: external["testEvents.yaml"]["components"]["schemas"]["OutputInfo"][];