test: introduce integration test package (#819)

Author: skl

pkg/test/integration/config.go

@@ -0,0 +1,39 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package integration
+
+// TestConfig holds project-specific configuration for integration tests
+type TestConfig struct {
+	// Environment variable prefixes
+	EnvPrefix string
+
+	// Docker compose configuration
+	ComposeServiceName string
+	ComposeImageName   string
+	DockerfilePath     string
+	ConfigPath         string
+
+	// Metric naming
+	MetricPrefix string
+	IPAttribute  string
+
+	// Telemetry SDK attributes
+	SDKName    string
+	VersionPkg string
+}
+
+// DefaultOBIConfig returns the default OBI test configuration
+func DefaultOBIConfig() *TestConfig {
+	return &TestConfig{
+		EnvPrefix:          "OTEL_EBPF_",
+		ComposeServiceName: "obi",
+		ComposeImageName:   "hatest-obi",
+		DockerfilePath:     "ebpf-instrument/Dockerfile",
+		ConfigPath:         "obi-config.yml",
+		MetricPrefix:       "obi",
+		IPAttribute:        "obi.ip",
+		SDKName:            "opentelemetry-ebpf-instrumentation",
+		VersionPkg:         "obibuildinfo.Version",
+	}
+}

pkg/test/integration/constants.go

@@ -0,0 +1,11 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package integration
+
+import "time"
+
+const (
+	instrumentedServiceStdURL = "http://localhost:8080"
+	testTimeout               = 60 * time.Second
+)

pkg/test/integration/doc.go

@@ -0,0 +1,19 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+// Package integration provides reusable integration test utilities
+// for downstream projects, whilst allowing each project to maintain their own
+// project-specific configuration.
+//
+// Example usage:
+//
+//	config := &integration.TestConfig{
+//	    EnvPrefix:          "MY_PROJECT_",
+//	    ComposeServiceName: "my-service",
+//	    MetricPrefix:       "myproject",
+//	    // ... other project-specific settings
+//	}
+//	integration.InternalPrometheusExport(t, config)
+//
+// For OBI, use the provided DefaultOBIConfig() function.
+package integration

test/integration/internals_test.go renamed to pkg/test/integration/internals.go

@@ -1,8 +1,6 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-//go:build integration
-
 package integration
 
 import (
@@ -18,16 +16,21 @@ import (
 )
 
 const (
-	flushesMetricName            = "obi_ebpf_tracer_flushes"
-	promRequestsMetricName       = "obi_prometheus_http_requests_total"
+	flushesMetricName            = "_ebpf_tracer_flushes"
+	promRequestsMetricName       = "_prometheus_http_requests_total"
 	internalPrometheusMetricsURL = "http://localhost:8999/internal/metrics"
 )
 
-func testInternalPrometheusExport(t *testing.T) {
+// InternalPrometheusExport tests that internal metrics are properly exposed and updated
+func InternalPrometheusExport(t *testing.T, config *TestConfig) {
+	// Use config-specific metric names
+	flushesMetricName := config.MetricPrefix + flushesMetricName
+	promRequestsMetricName := config.MetricPrefix + promRequestsMetricName
+
 	// tests that internal metrics are properly exposed and updated
 	initialFlushedRecords := metricValue(t, flushesMetricName, nil)
 	for i := 0; i < 7; i++ {
-		doHTTPGet(t, instrumentedServiceStdURL+"/testing/some/flushes", http.StatusOK)
+		DoHTTPGet(t, instrumentedServiceStdURL+"/testing/some/flushes", http.StatusOK)
 	}
 	eventuallyIterations := 0
 	test.Eventually(t, testTimeout, func(t require.TestingT) {

pkg/test/integration/utils.go

@@ -0,0 +1,32 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package integration
+
+import (
+	"bytes"
+	"crypto/tls"
+	"net/http"
+
+	"github.com/stretchr/testify/require"
+)
+
+// HTTP client for testing
+var testHTTPClient = &http.Client{
+	Transport: &http.Transport{
+		TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
+	},
+}
+
+func DoHTTPGet(t require.TestingT, path string, status int) {
+	// Random fake body to cause the request to have some size (38 bytes)
+	jsonBody := []byte(`{"productId": 123456, "quantity": 100}`)
+
+	req, err := http.NewRequest(http.MethodGet, path, bytes.NewReader(jsonBody))
+	require.NoError(t, err)
+	req.Header.Set("Content-Type", "application/json")
+
+	r, err := testHTTPClient.Do(req)
+	require.NoError(t, err)
+	require.Equal(t, status, r.StatusCode)
+}

test/integration/constants.go

@@ -0,0 +1,22 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:build integration
+
+package integration
+
+import "time"
+
+const (
+	instrumentedServiceStdURL         = "http://localhost:8080"
+	instrumentedServiceGinURL         = "http://localhost:8081"
+	instrumentedServiceGorillaURL     = "http://localhost:8082"
+	instrumentedServiceGorillaMidURL  = "http://localhost:8083"
+	instrumentedServiceGorillaMid2URL = "http://localhost:8087"
+	instrumentedServiceStdTLSURL      = "https://localhost:8383"
+	instrumentedServiceJSONRPCURL     = "http://localhost:8088"
+	prometheusHostPort                = "localhost:9090"
+	jaegerQueryURL                    = "http://localhost:16686/api/traces"
+
+	testTimeout = 60 * time.Second
+)

test/integration/discovery_test.go

@@ -16,6 +16,7 @@ import (
 	"github.com/mariomac/guara/pkg/test"
 	"github.com/stretchr/testify/require"
 
+	ti "go.opentelemetry.io/obi/pkg/test/integration"
 	"go.opentelemetry.io/obi/test/integration/components/docker"
 	"go.opentelemetry.io/obi/test/integration/components/jaeger"
 	"go.opentelemetry.io/obi/test/integration/components/prom"
@@ -48,16 +49,16 @@ func testSelectiveExports(t *testing.T) {
 	// this with  a proper check to see if the target process has finished
 	// being instrumented
 	test.Eventually(t, 3*time.Minute, func(t require.TestingT) {
-		doHTTPGet(t, "http://localhost:5001/b", 200)
+		ti.DoHTTPGet(t, "http://localhost:5001/b", 200)
 		bTraces := getTraces("service-b", "/b")
 		require.NotNil(t, bTraces)
 	})
 
 	// Run couple of requests to make sure we flush out any transactions that might be
 	// stuck because of our tracking of full request times
 	for i := 0; i < 10; i++ {
-		doHTTPGet(t, "http://localhost:5000/a", 200)
-		doHTTPGet(t, "http://localhost:5001/b", 200)
+		ti.DoHTTPGet(t, "http://localhost:5000/a", 200)
+		ti.DoHTTPGet(t, "http://localhost:5001/b", 200)
 	}
 
 	test.Eventually(t, testTimeout, func(t require.TestingT) {

test/integration/http_go_otel_test.go

@@ -17,14 +17,15 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
+	ti "go.opentelemetry.io/obi/pkg/test/integration"
 	"go.opentelemetry.io/obi/test/integration/components/docker"
 	"go.opentelemetry.io/obi/test/integration/components/jaeger"
 	"go.opentelemetry.io/obi/test/integration/components/prom"
 )
 
 func testForHTTPGoOTelLibrary(t *testing.T, route, svcNs string) {
 	for i := 0; i < 4; i++ {
-		doHTTPGet(t, "http://localhost:8080"+route, 200)
+		ti.DoHTTPGet(t, "http://localhost:8080"+route, 200)
 	}
 
 	// Eventually, Prometheus would make this query visible
@@ -80,7 +81,7 @@ func testForHTTPGoOTelLibrary(t *testing.T, route, svcNs string) {
 
 func testInstrumentationMissing(t *testing.T, route, svcNs string) {
 	for i := 0; i < 4; i++ {
-		doHTTPGet(t, "http://localhost:8080"+route, 200)
+		ti.DoHTTPGet(t, "http://localhost:8080"+route, 200)
 	}
 
 	test.Eventually(t, testTimeout, func(t require.TestingT) {

test/integration/internal_metrics_test.go

@@ -18,6 +18,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
+	ti "go.opentelemetry.io/obi/pkg/test/integration"
 	"go.opentelemetry.io/obi/test/integration/components/docker"
 	"go.opentelemetry.io/obi/test/integration/components/prom"
 )
@@ -67,7 +68,7 @@ func TestAvoidedServicesMetrics(t *testing.T) {
 
 		// Make additional requests to ensure OTLP endpoints are hit
 		for i := 0; i < 3; i++ {
-			doHTTPGet(t, "http://localhost:8080/rolldice", 200)
+			ti.DoHTTPGet(t, "http://localhost:8080/rolldice", 200)
 			time.Sleep(1 * time.Second)
 		}
 

test/integration/nodejs_multiproc_test.go

@@ -16,6 +16,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
+	ti "go.opentelemetry.io/obi/pkg/test/integration"
 	"go.opentelemetry.io/obi/test/integration/components/docker"
 	"go.opentelemetry.io/obi/test/integration/components/jaeger"
 )
@@ -33,7 +34,7 @@ func testNestedTraces(t *testing.T) {
 	// being instrumented
 	t.Log("checking instrumentation status")
 	test.Eventually(t, 2*time.Minute, func(t require.TestingT) {
-		doHTTPGet(t, "http://localhost:5000/a", 200)
+		ti.DoHTTPGet(t, "http://localhost:5000/a", 200)
 
 		resp, err := http.Get(jaegerQueryURL + "?service=service-a&limit=1")
 		if err != nil || resp == nil || resp.StatusCode != http.StatusOK {
@@ -52,7 +53,7 @@ func testNestedTraces(t *testing.T) {
 	// Run couple of requests to make sure we flush out any transactions that might be
 	// stuck because of our tracking of full request times
 	for i := 0; i < 10; i++ {
-		doHTTPGet(t, "http://localhost:5000/a", 200)
+		ti.DoHTTPGet(t, "http://localhost:5000/a", 200)
 	}
 
 	// Get the first 5 traces