add test for deep-dependencies

Signed-off-by: adityachopra29 <[email protected]>

Author: adityachopra29

cmd/query/app/analytics/gateway_test.go

@@ -0,0 +1,69 @@
+// Copyright (c) 2021 The Jaeger Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package analytics
+
+import (
+	"encoding/json"
+	"io"
+	"net/http"
+	"testing"
+
+	"github.com/gorilla/mux"
+	"github.com/stretchr/testify/require"
+
+	_ "github.com/jaegertracing/jaeger/pkg/gogocodec" // force gogo codec registration
+)
+
+// Utility functions used from http_gateway_test.go.
+type testGateway struct {
+	url    string
+	router *mux.Router
+	// used to set a tenancy header when executing requests
+	setupRequest func(*http.Request)
+}
+
+func (gw *testGateway) execRequest(t *testing.T, url string) ([]byte, int) {
+	req, err := http.NewRequest(http.MethodGet, gw.url+url, nil)
+	require.NoError(t, err)
+	req.Header.Set("Content-Type", "application/json")
+	gw.setupRequest(req)
+	response, err := http.DefaultClient.Do(req)
+	require.NoError(t, err)
+	body, err := io.ReadAll(response.Body)
+	require.NoError(t, err)
+	require.NoError(t, response.Body.Close())
+	return body, response.StatusCode
+}
+
+func runGatewayTests(
+	t *testing.T,
+	basePath string,
+	setupRequest func(*http.Request),
+) {
+	gw := setupHTTPGateway(t, basePath)
+	gw.setupRequest = setupRequest
+	t.Run("getDeepDependencies", gw.runGatewayGetDeepDependencies)
+}
+
+func (gw *testGateway) runGatewayGetDeepDependencies(t *testing.T) {
+	expectedPath := []TDdgPayloadEntry{
+		{Service: "sample-serviceA", Operation: "sample-opA"},
+		{Service: "sample-serviceB", Operation: "sample-opB"},
+	}
+	expectedAttributes := []Attribute{
+		{Key: "exemplar_trace_id", Value: "abc123"},
+	}
+
+	body, statusCode := gw.execRequest(t, "/api/deep-dependencies")
+
+	require.Equal(t, http.StatusOK, statusCode)
+
+	var response TDdgPayload
+	err := json.Unmarshal(body, &response)
+	require.NoError(t, err)
+
+	require.Len(t, response.Dependencies, 1)
+	require.Equal(t, expectedPath, response.Dependencies[0].Path)
+	require.Equal(t, expectedAttributes, response.Dependencies[0].Attributes)
+}

cmd/query/app/analytics/http_gateway.go

@@ -65,7 +65,7 @@ func (h *HTTPGateway) getDeepDependencies(w http.ResponseWriter, r *http.Request
 
 	w.Header().Set("Content-Type", "application/json")
 	if err := json.NewEncoder(w).Encode(dependencies); err != nil {
-		http.Error(w, "Failed to encode response", http.StatusInternalServerError)
+		h.Logger.Error("Failed to encode response", zap.Error(err))
 	}
 }
 

cmd/query/app/analytics/http_gateway_test.go

@@ -2,3 +2,51 @@
 // SPDX-License-Identifier: Apache-2.0
 
 package analytics
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/gorilla/mux"
+	"go.uber.org/zap"
+)
+
+// setup the http gateway
+func setupHTTPGatewayNoServer(
+	_ *testing.T,
+	basePath string,
+) *testGateway {
+	gw := &testGateway{}
+
+	hgw := &HTTPGateway{
+		Logger: zap.NewNop(),
+	}
+
+	gw.router = &mux.Router{}
+	if basePath != "" && basePath != "/" {
+		gw.router = gw.router.PathPrefix(basePath).Subrouter()
+	}
+	hgw.RegisterRoutes(gw.router)
+	return gw
+}
+
+func setupHTTPGateway(
+	t *testing.T,
+	basePath string,
+) *testGateway {
+	gw := setupHTTPGatewayNoServer(t, basePath)
+
+	httpServer := httptest.NewServer(gw.router)
+	t.Cleanup(func() { httpServer.Close() })
+
+	gw.url = httpServer.URL
+	if basePath != "/" {
+		gw.url += basePath
+	}
+	return gw
+}
+
+func TestHTTPGateway(t *testing.T) {
+	runGatewayTests(t, "/", func(_ *http.Request) {})
+}

cmd/query/app/analytics/package_test.go

@@ -0,0 +1,14 @@
+// Copyright (c) 2023 The Jaeger Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package analytics
+
+import (
+	"testing"
+
+	"github.com/jaegertracing/jaeger/pkg/testutils"
+)
+
+func TestMain(m *testing.M) {
+	testutils.VerifyGoLeaks(m)
+}