Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

test: use t.Setenv to set env vars in tests #2437

Merged
merged 3 commits into from
Jan 25, 2024
Merged

test: use t.Setenv to set env vars in tests #2437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
32b93f7
test: use `t.Setenv` to set env vars in tests
Juneezee Dec 14, 2023
488629a
Split Test128 into two subtests
Juneezee Jan 2, 2024
9b7c8df
Apply code suggestion
Juneezee Jan 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 1 addition & 18 deletions contrib/internal/httptrace/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
package httptrace

import (
"os"
"testing"

"github.com/stretchr/testify/require"
Expand Down Expand Up @@ -50,28 +49,12 @@ func TestConfig(t *testing.T) {
},
} {
t.Run(tc.name, func(t *testing.T) {
defer cleanEnv()()
for k, v := range tc.env {
os.Setenv(k, v)
t.Setenv(k, v)
}
c := newConfig()
require.Equal(t, tc.cfg.queryStringRegexp, c.queryStringRegexp)
require.Equal(t, tc.cfg.queryString, c.queryString)
})
}
}

func cleanEnv() func() {
env := map[string]string{
envQueryStringDisabled: os.Getenv(envQueryStringDisabled),
envQueryStringRegexp: os.Getenv(envQueryStringRegexp),
}
for k := range env {
os.Unsetenv(k)
}
return func() {
for k, v := range env {
os.Setenv(k, v)
}
}
}
62 changes: 32 additions & 30 deletions ddtrace/tracer/context_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (
"context"
"encoding/binary"
"encoding/hex"
"os"
"testing"

"gopkg.in/DataDog/dd-trace-go.v1/ddtrace"
Expand Down Expand Up @@ -116,35 +115,38 @@ func Test128(t *testing.T) {
_, _, _, stop := startTestTracer(t)
defer stop()

os.Setenv("DD_TRACE_128_BIT_TRACEID_GENERATION_ENABLED", "false")
katiehockman marked this conversation as resolved.
Show resolved Hide resolved
span, _ := StartSpanFromContext(context.Background(), "http.request")
assert.NotZero(t, span.Context().TraceID())
w3cCtx, ok := span.Context().(ddtrace.SpanContextW3C)
if !ok {
assert.Fail(t, "couldn't cast to ddtrace.SpanContextW3C")
}
id128 := w3cCtx.TraceID128()
assert.Len(t, id128, 32) // ensure there are enough leading zeros
idBytes, err := hex.DecodeString(id128)
assert.NoError(t, err)
assert.Equal(t, uint64(0), binary.BigEndian.Uint64(idBytes[:8])) // high 64 bits should be 0
assert.Equal(t, span.Context().TraceID(), binary.BigEndian.Uint64(idBytes[8:]))

// Enable 128 bit trace ids
os.Unsetenv("DD_TRACE_128_BIT_TRACEID_GENERATION_ENABLED")
span128, _ := StartSpanFromContext(context.Background(), "http.request")
assert.NotZero(t, span128.Context().TraceID())
w3cCtx, ok = span128.Context().(ddtrace.SpanContextW3C)
if !ok {
assert.Fail(t, "couldn't cast to ddtrace.SpanContextW3C")
}
id128bit := w3cCtx.TraceID128()
assert.NotEmpty(t, id128bit)
assert.Len(t, id128bit, 32)
// Ensure that the lower order bits match the span's 64-bit trace id
b, err := hex.DecodeString(id128bit)
assert.NoError(t, err)
assert.Equal(t, span128.Context().TraceID(), binary.BigEndian.Uint64(b[8:]))
t.Run("disable 128 bit trace ids", func(t *testing.T) {
t.Setenv("DD_TRACE_128_BIT_TRACEID_GENERATION_ENABLED", "false")
span, _ := StartSpanFromContext(context.Background(), "http.request")
assert.NotZero(t, span.Context().TraceID())
w3cCtx, ok := span.Context().(ddtrace.SpanContextW3C)
if !ok {
assert.Fail(t, "couldn't cast to ddtrace.SpanContextW3C")
}
id128 := w3cCtx.TraceID128()
assert.Len(t, id128, 32) // ensure there are enough leading zeros
idBytes, err := hex.DecodeString(id128)
assert.NoError(t, err)
assert.Equal(t, uint64(0), binary.BigEndian.Uint64(idBytes[:8])) // high 64 bits should be 0
assert.Equal(t, span.Context().TraceID(), binary.BigEndian.Uint64(idBytes[8:]))
})

t.Run("enable 128 bit trace ids", func(t *testing.T) {
// DD_TRACE_128_BIT_TRACEID_GENERATION_ENABLED is true by default
span128, _ := StartSpanFromContext(context.Background(), "http.request")
assert.NotZero(t, span128.Context().TraceID())
w3cCtx, ok := span128.Context().(ddtrace.SpanContextW3C)
if !ok {
assert.Fail(t, "couldn't cast to ddtrace.SpanContextW3C")
}
id128bit := w3cCtx.TraceID128()
assert.NotEmpty(t, id128bit)
assert.Len(t, id128bit, 32)
// Ensure that the lower order bits match the span's 64-bit trace id
b, err := hex.DecodeString(id128bit)
assert.NoError(t, err)
assert.Equal(t, span128.Context().TraceID(), binary.BigEndian.Uint64(b[8:]))
})
}

func TestStartSpanFromNilContext(t *testing.T) {
Expand Down
16 changes: 5 additions & 11 deletions ddtrace/tracer/log_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ package tracer
import (
"fmt"
"math"
"os"
"testing"

"gopkg.in/DataDog/dd-trace-go.v1/internal/globalconfig"
Expand Down Expand Up @@ -39,8 +38,7 @@ func TestStartupLog(t *testing.T) {
assert := assert.New(t)
tp := new(log.RecordLogger)

os.Setenv("DD_TRACE_SAMPLE_RATE", "0.123")
defer os.Unsetenv("DD_TRACE_SAMPLE_RATE")
t.Setenv("DD_TRACE_SAMPLE_RATE", "0.123")
tracer, _, _, stop := startTestTracer(t,
WithLogger(tp),
WithService("configured.service"),
Expand Down Expand Up @@ -71,10 +69,8 @@ func TestStartupLog(t *testing.T) {
t.Run("limit", func(t *testing.T) {
assert := assert.New(t)
tp := new(log.RecordLogger)
os.Setenv("DD_TRACE_SAMPLE_RATE", "0.123")
defer os.Unsetenv("DD_TRACE_SAMPLE_RATE")
os.Setenv("DD_TRACE_RATE_LIMIT", "1000.001")
defer os.Unsetenv("DD_TRACE_RATE_LIMIT")
t.Setenv("DD_TRACE_SAMPLE_RATE", "0.123")
t.Setenv("DD_TRACE_RATE_LIMIT", "1000.001")
tracer, _, _, stop := startTestTracer(t,
WithLogger(tp),
WithService("configured.service"),
Expand Down Expand Up @@ -103,8 +99,7 @@ func TestStartupLog(t *testing.T) {
t.Run("errors", func(t *testing.T) {
assert := assert.New(t)
tp := new(log.RecordLogger)
os.Setenv("DD_TRACE_SAMPLING_RULES", `[{"service": "some.service","sample_rate": 0.234}, {"service": "other.service"}]`)
defer os.Unsetenv("DD_TRACE_SAMPLING_RULES")
t.Setenv("DD_TRACE_SAMPLING_RULES", `[{"service": "some.service","sample_rate": 0.234}, {"service": "other.service"}]`)
tracer, _, _, stop := startTestTracer(t, WithLogger(tp))
defer stop()

Expand Down Expand Up @@ -149,8 +144,7 @@ func TestLogSamplingRules(t *testing.T) {
assert := assert.New(t)
tp := new(log.RecordLogger)
tp.Ignore("appsec: ", telemetry.LogPrefix)
os.Setenv("DD_TRACE_SAMPLING_RULES", `[{"service": "some.service", "sample_rate": 0.234}, {"service": "other.service"}, {"service": "last.service", "sample_rate": 0.56}, {"odd": "pairs"}, {"sample_rate": 9.10}]`)
defer os.Unsetenv("DD_TRACE_SAMPLING_RULES")
t.Setenv("DD_TRACE_SAMPLING_RULES", `[{"service": "some.service", "sample_rate": 0.234}, {"service": "other.service"}, {"service": "last.service", "sample_rate": 0.56}, {"odd": "pairs"}, {"sample_rate": 9.10}]`)
_, _, _, stop := startTestTracer(t, WithLogger(tp))
defer stop()

Expand Down
Loading
Loading