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.

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

chore: use t.Cleanup() for integration tests cleanup #382

Merged
merged 2 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 0 additions & 2 deletions _integration-tests/tests/99designs.gqlgen/gqlgen.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@ func (tc *TestCase) Run(t *testing.T) {
}, resp)
}

func (*TestCase) Teardown(*testing.T) {}

func (*TestCase) ExpectedTraces() trace.Traces {
return trace.Traces{
{
Expand Down
8 changes: 0 additions & 8 deletions _integration-tests/tests/aws.v1/aws.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@
package awsv1

import (
"context"
"fmt"
"testing"
"time"

"datadoghq.dev/orchestrion/_integration-tests/utils"
"datadoghq.dev/orchestrion/_integration-tests/validator/trace"
Expand Down Expand Up @@ -47,12 +45,6 @@ func (tc *TestCase) Run(t *testing.T) {
require.NoError(t, err)
}

func (tc *TestCase) Teardown(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
require.NoError(t, tc.server.Terminate(ctx))
}

func (*TestCase) ExpectedTraces() trace.Traces {
return trace.Traces{
{
Expand Down
6 changes: 0 additions & 6 deletions _integration-tests/tests/aws.v2/base.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,6 @@ func (b *base) setup(t *testing.T) {
b.server, b.host, b.port = utils.StartDynamoDBTestContainer(t)
}

func (b *base) teardown(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
require.NoError(t, b.server.Terminate(ctx))
}

func (b *base) run(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
defer cancel()
Expand Down
4 changes: 0 additions & 4 deletions _integration-tests/tests/aws.v2/load_default_config.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,6 @@ func (tc *TestCaseLoadDefaultConfig) Run(t *testing.T) {
tc.base.run(t)
}

func (tc *TestCaseLoadDefaultConfig) Teardown(t *testing.T) {
tc.base.teardown(t)
}

func (tc *TestCaseLoadDefaultConfig) ExpectedTraces() trace.Traces {
return tc.base.expectedTraces()
}
4 changes: 0 additions & 4 deletions _integration-tests/tests/aws.v2/new_config.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,6 @@ func (tc *TestCaseNewConfig) Run(t *testing.T) {
tc.base.run(t)
}

func (tc *TestCaseNewConfig) Teardown(t *testing.T) {
tc.base.teardown(t)
}

func (tc *TestCaseNewConfig) ExpectedTraces() trace.Traces {
return tc.base.expectedTraces()
}
4 changes: 0 additions & 4 deletions _integration-tests/tests/aws.v2/struct_literal.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,6 @@ func (tc *TestCaseStructLiteral) Run(t *testing.T) {
tc.base.run(t)
}

func (tc *TestCaseStructLiteral) Teardown(t *testing.T) {
tc.base.teardown(t)
}

func (tc *TestCaseStructLiteral) ExpectedTraces() trace.Traces {
return tc.base.expectedTraces()
}
4 changes: 0 additions & 4 deletions _integration-tests/tests/aws.v2/struct_literal_ptr.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,6 @@ func (tc *TestCaseStructLiteralPtr) Run(t *testing.T) {
tc.base.run(t)
}

func (tc *TestCaseStructLiteralPtr) Teardown(t *testing.T) {
tc.base.teardown(t)
}

func (tc *TestCaseStructLiteralPtr) ExpectedTraces() trace.Traces {
return tc.base.expectedTraces()
}
12 changes: 5 additions & 7 deletions _integration-tests/tests/chi.v5/chi.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ func (tc *TestCase) Setup(t *testing.T) {
})

go func() { assert.ErrorIs(t, tc.Server.ListenAndServe(), http.ErrServerClosed) }()
t.Cleanup(func() {
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
assert.NoError(t, tc.Server.Shutdown(ctx))
})
}

func (tc *TestCase) Run(t *testing.T) {
Expand All @@ -47,13 +52,6 @@ func (tc *TestCase) Run(t *testing.T) {
require.Equal(t, http.StatusOK, resp.StatusCode)
}

func (tc *TestCase) Teardown(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()

require.NoError(t, tc.Server.Shutdown(ctx))
}

func (tc *TestCase) ExpectedTraces() trace.Traces {
return trace.Traces{
{
Expand Down
8 changes: 0 additions & 8 deletions _integration-tests/tests/confluent-kafka-go.v1/kafka.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
package kafka

import (
"context"
"strings"
"testing"
"time"
Expand Down Expand Up @@ -104,13 +103,6 @@ func (tc *TestCase) consumeMessage(t *testing.T) {
require.Equal(t, "key2", string(m.Key))
}

func (tc *TestCase) Teardown(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
defer cancel()

require.NoError(t, tc.container.Terminate(ctx))
}

func (*TestCase) ExpectedTraces() trace.Traces {
return trace.Traces{
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ func (skip) Setup(t *testing.T) {
}

func (skip) Run(t *testing.T) {}
func (skip) Teardown(t *testing.T) {}
func (skip) ExpectedTraces() trace.Traces { return nil }

type TestCase = skip
8 changes: 0 additions & 8 deletions _integration-tests/tests/confluent-kafka-go.v2/kafka.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
package kafka

import (
"context"
"strings"
"testing"
"time"
Expand Down Expand Up @@ -104,13 +103,6 @@ func (tc *TestCase) consumeMessage(t *testing.T) {
require.Equal(t, "key2", string(m.Key))
}

func (tc *TestCase) Teardown(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
defer cancel()

require.NoError(t, tc.container.Terminate(ctx))
}

func (*TestCase) ExpectedTraces() trace.Traces {
return trace.Traces{
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ func (skip) Setup(t *testing.T) {
}

func (skip) Run(t *testing.T) {}
func (skip) Teardown(t *testing.T) {}
func (skip) ExpectedTraces() trace.Traces { return nil }

type TestCase = skip
2 changes: 0 additions & 2 deletions _integration-tests/tests/dd-span/ddspan.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ func (*TestCase) Run(t *testing.T) {
_, _ = spanFromHTTPRequest(req)
}

func (*TestCase) Teardown(*testing.T) {}

//dd:span foo:bar
func spanFromHTTPRequest(*http.Request) (string, error) {
return tagSpecificSpan()
Expand Down
12 changes: 5 additions & 7 deletions _integration-tests/tests/echo.v4/echo.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ func (tc *TestCase) Setup(t *testing.T) {
tc.addr = "127.0.0.1:" + utils.GetFreePort(t)

go func() { assert.ErrorIs(t, tc.Echo.Start(tc.addr), http.ErrServerClosed) }()
t.Cleanup(func() {
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
require.NoError(t, tc.Echo.Shutdown(ctx))
})
}

func (tc *TestCase) Run(t *testing.T) {
Expand All @@ -44,13 +49,6 @@ func (tc *TestCase) Run(t *testing.T) {
require.Equal(t, http.StatusOK, resp.StatusCode)
}

func (tc *TestCase) Teardown(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()

require.NoError(t, tc.Echo.Shutdown(ctx))
}

func (tc *TestCase) ExpectedTraces() trace.Traces {
return trace.Traces{
{
Expand Down
7 changes: 3 additions & 4 deletions _integration-tests/tests/fiber.v2/fiber.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ func (tc *TestCase) Setup(t *testing.T) {
tc.addr = "127.0.0.1:" + utils.GetFreePort(t)

go func() { assert.NoError(t, tc.App.Listen(tc.addr)) }()
t.Cleanup(func() {
assert.NoError(t, tc.App.ShutdownWithTimeout(time.Second))
})
}

func (tc *TestCase) Run(t *testing.T) {
Expand All @@ -38,10 +41,6 @@ func (tc *TestCase) Run(t *testing.T) {
require.Equal(t, http.StatusOK, resp.StatusCode)
}

func (tc *TestCase) Teardown(t *testing.T) {
require.NoError(t, tc.App.ShutdownWithTimeout(time.Second))
}

func (tc *TestCase) ExpectedTraces() trace.Traces {
return trace.Traces{
{
Expand Down
12 changes: 4 additions & 8 deletions _integration-tests/tests/gcp_pubsub/gcp_pubsub.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ func (tc *TestCase) Setup(t *testing.T) {
utils.WithTestLogConsumer(t),
)
utils.AssertTestContainersError(t, err)
utils.RegisterContainerCleanup(t, tc.container)

projectID := tc.container.Settings.ProjectID

Expand All @@ -60,6 +61,9 @@ func (tc *TestCase) Setup(t *testing.T) {

tc.client, err = pubsub.NewClient(ctx, projectID, option.WithGRPCConn(conn))
require.NoError(t, err)
t.Cleanup(func() {
assert.NoError(t, tc.client.Close())
})

topic, err := tc.client.CreateTopic(ctx, testTopic)
require.NoError(t, err)
Expand Down Expand Up @@ -111,14 +115,6 @@ func (tc *TestCase) Run(t *testing.T) {
tc.receiveMessage(t)
}

func (tc *TestCase) Teardown(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
defer cancel()

require.NoError(t, tc.client.Close())
require.NoError(t, tc.container.Terminate(ctx))
}

func (tc *TestCase) ExpectedTraces() trace.Traces {
return trace.Traces{
{
Expand Down
12 changes: 5 additions & 7 deletions _integration-tests/tests/gin/gin.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ func (tc *TestCase) Setup(t *testing.T) {
engine.GET("/ping", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{"message": "pong"}) })

go func() { assert.ErrorIs(t, tc.Server.ListenAndServe(), http.ErrServerClosed) }()
t.Cleanup(func() {
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
assert.NoError(t, tc.Server.Shutdown(ctx))
})
}

func (tc *TestCase) Run(t *testing.T) {
Expand All @@ -44,13 +49,6 @@ func (tc *TestCase) Run(t *testing.T) {
require.Equal(t, http.StatusOK, resp.StatusCode)
}

func (tc *TestCase) Teardown(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()

require.NoError(t, tc.Server.Shutdown(ctx))
}

func (tc *TestCase) ExpectedTraces() trace.Traces {
return trace.Traces{
{
Expand Down
9 changes: 1 addition & 8 deletions _integration-tests/tests/go-elasticsearch/base.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import (

"datadoghq.dev/orchestrion/_integration-tests/utils"
"datadoghq.dev/orchestrion/_integration-tests/validator/trace"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/testcontainers/testcontainers-go"
testelasticsearch "github.com/testcontainers/testcontainers-go/modules/elasticsearch"
Expand Down Expand Up @@ -48,6 +47,7 @@ func (b *base) Setup(t *testing.T, image string, newClient func(addr string, caC
testcontainers.WithWaitStrategyAndDeadline(time.Minute, wait.ForLog(`.*("message":\s?"started(\s|")?.*|]\sstarted\n)`).AsRegexp()),
)
utils.AssertTestContainersError(t, err)
utils.RegisterContainerCleanup(t, b.container)

b.client, err = newClient(b.container.Settings.Address, b.container.Settings.CACert)
require.NoError(t, err)
Expand All @@ -66,13 +66,6 @@ func (b *base) Run(t *testing.T, doRequest func(t *testing.T, client esClient, b
doRequest(t, b.client, bytes.NewReader(data))
}

func (b *base) Teardown(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
defer cancel()

assert.NoError(t, b.container.Terminate(ctx))
}

func (*base) ExpectedTraces() trace.Traces {
return trace.Traces{
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ func (skip) Setup(t *testing.T) {
}

func (skip) Run(t *testing.T) {}
func (skip) Teardown(t *testing.T) {}
func (skip) ExpectedTraces() trace.Traces { return nil }

type TestCaseV6 = skip
Expand Down
14 changes: 3 additions & 11 deletions _integration-tests/tests/go-redis.v0/go-redis.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import (
"context"
"fmt"
"testing"
"time"

"datadoghq.dev/orchestrion/_integration-tests/utils"
"datadoghq.dev/orchestrion/_integration-tests/validator/trace"
Expand Down Expand Up @@ -40,6 +39,9 @@ func (tc *TestCase) Setup(t *testing.T) {
tc.server = container

tc.Client = redis.NewClient(&redis.Options{Addr: addr})
t.Cleanup(func() {
assert.NoError(t, tc.Client.Close())
})
}

func (tc *TestCase) Run(t *testing.T) {
Expand All @@ -50,16 +52,6 @@ func (tc *TestCase) Run(t *testing.T) {
require.NoError(t, tc.Client.WithContext(ctx).Get(tc.key).Err())
}

func (tc *TestCase) Teardown(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
defer cancel()

assert.NoError(t, tc.Client.Close())
if tc.server != nil && assert.NoError(t, tc.server.Terminate(ctx)) {
tc.server = nil
}
}

func (tc *TestCase) ExpectedTraces() trace.Traces {
return trace.Traces{
{
Expand Down
14 changes: 3 additions & 11 deletions _integration-tests/tests/go-redis.v7/go-redis.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import (
"context"
"fmt"
"testing"
"time"

"datadoghq.dev/orchestrion/_integration-tests/utils"
"datadoghq.dev/orchestrion/_integration-tests/validator/trace"
Expand Down Expand Up @@ -40,6 +39,9 @@ func (tc *TestCase) Setup(t *testing.T) {
tc.server = container

tc.Client = redis.NewClient(&redis.Options{Addr: addr})
t.Cleanup(func() {
assert.NoError(t, tc.Client.Close())
})
}

func (tc *TestCase) Run(t *testing.T) {
Expand All @@ -50,16 +52,6 @@ func (tc *TestCase) Run(t *testing.T) {
require.NoError(t, tc.Client.WithContext(ctx).Get(tc.key).Err())
}

func (tc *TestCase) Teardown(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
defer cancel()

assert.NoError(t, tc.Client.Close())
if tc.server != nil && assert.NoError(t, tc.server.Terminate(ctx)) {
tc.server = nil
}
}

func (tc *TestCase) ExpectedTraces() trace.Traces {
return trace.Traces{
{
Expand Down
Loading