option_test.go

// Copyright Sam Xie
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package otelsql

import (
	"context"
	"database/sql/driver"
	"testing"

	"github.com/stretchr/testify/assert"
	"go.opentelemetry.io/otel/attribute"
	"go.opentelemetry.io/otel/metric"
	sdktrace "go.opentelemetry.io/otel/sdk/trace"
)

func TestOptions(t *testing.T) {
	tracerProvider := sdktrace.NewTracerProvider()
	meterProvider := metric.NewNoopMeterProvider()

	dummyAttributesGetter := func(ctx context.Context, method Method, query string, args []driver.NamedValue) []attribute.KeyValue {
		return []attribute.KeyValue{attribute.String("foo", "bar")}
	}

	testCases := []struct {
		name           string
		option         Option
		expectedConfig config
	}{
		{
			name:           "WithTracerProvider",
			option:         WithTracerProvider(tracerProvider),
			expectedConfig: config{TracerProvider: tracerProvider},
		},
		{
			name: "WithAttributes",
			option: WithAttributes(
				attribute.String("foo", "bar"),
				attribute.String("foo2", "bar2"),
			),
			expectedConfig: config{Attributes: []attribute.KeyValue{
				attribute.String("foo", "bar"),
				attribute.String("foo2", "bar2"),
			}},
		},
		{
			name:           "WithSpanNameFormatter",
			option:         WithSpanNameFormatter(&defaultSpanNameFormatter{}),
			expectedConfig: config{SpanNameFormatter: &defaultSpanNameFormatter{}},
		},
		{
			name:           "WithSpanOptions",
			option:         WithSpanOptions(SpanOptions{Ping: true}),
			expectedConfig: config{SpanOptions: SpanOptions{Ping: true}},
		},
		{
			name:           "WithMeterProvider",
			option:         WithMeterProvider(meterProvider),
			expectedConfig: config{MeterProvider: meterProvider},
		},
		{
			name:           "WithSQLCommenter",
			option:         WithSQLCommenter(true),
			expectedConfig: config{SQLCommenterEnabled: true},
		},
		{
			name:           "WithAttributesGetter",
			option:         WithAttributesGetter(dummyAttributesGetter),
			expectedConfig: config{AttributesGetter: dummyAttributesGetter},
		},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			var cfg config

			tc.option.Apply(&cfg)

			if tc.expectedConfig.AttributesGetter != nil {
				assert.Equal(t, tc.expectedConfig.AttributesGetter(context.Background(), "", "", nil), cfg.AttributesGetter(context.Background(), "", "", nil))
			} else {
				assert.Equal(t, tc.expectedConfig, cfg)
			}
		})
	}
}