feat: endpoint to verify which spans are selected by selector

api/openapi.yaml

@@ -211,6 +211,40 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/TestRunResult"
+  /tests/{testId}/results/{resultId}/select:
+    get:
+      tags:
+        - api
+      parameters:
+        - in: path
+          name: testId
+          schema:
+            type: string
+            format: uuid
+          required: true
+        - in: path
+          name: resultId
+          schema:
+            type: string
+            format: uuid
+          required: true
+        - in: query
+          name: query
+          schema:
+            type: string
+      summary: "retrieve spans that will be selected by selector"
+      description: "get the spans ids that would be selected by a specific selector query"
+      operationId: getTestResultSelectedSpans
+      responses:
+        200:
+          description: successful operation
+          content:
+            application/json:
+              schema: 
+                type: array
+                items:
+                  type: string
+
   /tests/{testId}/results:
     get:
       tags:

server/http/controller.go

@@ -2,14 +2,17 @@ package http
 
 import (
 	"context"
+	"encoding/hex"
 	"errors"
 	"net/http"
 
 	"github.com/kubeshop/tracetest/analytics"
+	"github.com/kubeshop/tracetest/assertions/selectors"
 	"github.com/kubeshop/tracetest/executor"
 	"github.com/kubeshop/tracetest/openapi"
 	"github.com/kubeshop/tracetest/testdb"
 	"github.com/kubeshop/tracetest/tracedb"
+	"github.com/kubeshop/tracetest/traces"
 )
 
 type controller struct {
@@ -263,3 +266,29 @@ func (s *controller) GetAssertions(ctx context.Context, testID string) (openapi.
 
 	return openapi.Response(http.StatusOK, assertions), nil
 }
+
+func (s *controller) GetTestResultSelectedSpans(ctx context.Context, testID string, resultID string, selectorQuery string) (openapi.ImplResponse, error) {
+	selector, err := selectors.New(selectorQuery)
+	if err != nil {
+		return openapi.Response(http.StatusBadRequest, "invalid selector query"), nil
+	}
+
+	result, err := s.testDB.GetResult(ctx, resultID)
+	if err != nil {
+		return openapi.Response(http.StatusInternalServerError, ""), nil
+	}
+
+	trace, err := traces.FromOtel(result.Trace)
+	if err != nil {
+		return openapi.Response(http.StatusInternalServerError, ""), nil
+	}
+
+	selectedSpans := selector.Filter(trace)
+	selectedSpanIds := make([]string, len(selectedSpans))
+
+	for i, span := range selectedSpans {
+		selectedSpanIds[i] = hex.EncodeToString(span.ID[:])
+	}
+
+	return openapi.Response(http.StatusOK, selectedSpanIds), nil
+}

server/openapi/api.go

@@ -25,6 +25,7 @@ type ApiApiRouter interface {
 	GetAssertions(http.ResponseWriter, *http.Request)
 	GetTest(http.ResponseWriter, *http.Request)
 	GetTestResult(http.ResponseWriter, *http.Request)
+	GetTestResultSelectedSpans(http.ResponseWriter, *http.Request)
 	GetTestResults(http.ResponseWriter, *http.Request)
 	GetTests(http.ResponseWriter, *http.Request)
 	RunTest(http.ResponseWriter, *http.Request)
@@ -45,6 +46,7 @@ type ApiApiServicer interface {
 	GetAssertions(context.Context, string) (ImplResponse, error)
 	GetTest(context.Context, string) (ImplResponse, error)
 	GetTestResult(context.Context, string, string) (ImplResponse, error)
+	GetTestResultSelectedSpans(context.Context, string, string, string) (ImplResponse, error)
 	GetTestResults(context.Context, string, int32, int32) (ImplResponse, error)
 	GetTests(context.Context, int32, int32) (ImplResponse, error)
 	RunTest(context.Context, string) (ImplResponse, error)

server/openapi/api_api.go

@@ -92,6 +92,12 @@ func (c *ApiApiController) Routes() Routes {
 			"/api/tests/{testId}/results/{resultId}",
 			c.GetTestResult,
 		},
+		{
+			"GetTestResultSelectedSpans",
+			strings.ToUpper("Get"),
+			"/api/tests/{testId}/results/{resultId}/select",
+			c.GetTestResultSelectedSpans,
+		},
 		{
 			"GetTestResults",
 			strings.ToUpper("Get"),
@@ -266,6 +272,26 @@ func (c *ApiApiController) GetTestResult(w http.ResponseWriter, r *http.Request)
 
 }
 
+// GetTestResultSelectedSpans - retrieve spans that will be selected by selector
+func (c *ApiApiController) GetTestResultSelectedSpans(w http.ResponseWriter, r *http.Request) {
+	params := mux.Vars(r)
+	query := r.URL.Query()
+	testIdParam := params["testId"]
+
+	resultIdParam := params["resultId"]
+
+	queryParam := query.Get("query")
+	result, err := c.service.GetTestResultSelectedSpans(r.Context(), testIdParam, resultIdParam, queryParam)
+	// If an error occurred, encode the error with the status code
+	if err != nil {
+		c.errorHandler(w, r, err, &result)
+		return
+	}
+	// If no error, encode the body and the result code
+	EncodeJSONResponse(result.Body, &result.Code, w)
+
+}
+
 // GetTestResults - get the results for a test
 func (c *ApiApiController) GetTestResults(w http.ResponseWriter, r *http.Request) {
 	params := mux.Vars(r)