Add tests

open-telemetry · Jun 27, 2024 · 9b1b1a5 · 9b1b1a5
1 parent e4c0138
commit 9b1b1a5
Show file tree

Hide file tree

Showing 3 changed files with 172 additions and 0 deletions.
diff --git a/processors/minsev/go.mod b/processors/minsev/go.mod
@@ -3,16 +3,20 @@ module go.opentelemetry.io/contrib/processors/minsev
 go 1.21
 
 require (
+	github.com/stretchr/testify v1.9.0
 	go.opentelemetry.io/otel/log v0.3.0
 	go.opentelemetry.io/otel/sdk/log v0.3.0
 )
 
 require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/go-logr/logr v1.4.1 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	go.opentelemetry.io/otel v1.27.0 // indirect
 	go.opentelemetry.io/otel/metric v1.27.0 // indirect
 	go.opentelemetry.io/otel/sdk v1.27.0 // indirect
 	go.opentelemetry.io/otel/trace v1.27.0 // indirect
 	golang.org/x/sys v0.20.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
diff --git a/processors/minsev/go.sum b/processors/minsev/go.sum
@@ -25,5 +25,7 @@ go.opentelemetry.io/otel/trace v1.27.0 h1:IqYb813p7cmbHk0a5y6pD5JPakbVfftRXABGt5
 go.opentelemetry.io/otel/trace v1.27.0/go.mod h1:6RiD1hkAprV4/q+yd2ln1HG9GoPx39SuvvstaLBl+l4=
 golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y=
 golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
diff --git a/processors/minsev/minsev_test.go b/processors/minsev/minsev_test.go
@@ -0,0 +1,166 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package minsev
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	api "go.opentelemetry.io/otel/log"
+	"go.opentelemetry.io/otel/sdk/log"
+)
+
+var severities = []api.Severity{
+	api.SeverityTrace, api.SeverityTrace1, api.SeverityTrace2, api.SeverityTrace3, api.SeverityTrace4,
+	api.SeverityDebug, api.SeverityDebug1, api.SeverityDebug2, api.SeverityDebug3, api.SeverityDebug4,
+	api.SeverityInfo, api.SeverityInfo1, api.SeverityInfo2, api.SeverityInfo3, api.SeverityInfo4,
+	api.SeverityWarn, api.SeverityWarn1, api.SeverityWarn2, api.SeverityWarn3, api.SeverityWarn4,
+	api.SeverityError, api.SeverityError1, api.SeverityError2, api.SeverityError3, api.SeverityError4,
+	api.SeverityFatal, api.SeverityFatal1, api.SeverityFatal2, api.SeverityFatal3, api.SeverityFatal4,
+}
+
+type args struct {
+	Ctx    context.Context
+	Record log.Record
+}
+
+type processor struct {
+	ReturnErr error
+
+	OnEmitCalls     []args
+	EnabledCalls    []args
+	ForceFlushCalls []context.Context
+	ShutdownCalls   []context.Context
+}
+
+func (p *processor) OnEmit(ctx context.Context, r log.Record) error {
+	p.OnEmitCalls = append(p.OnEmitCalls, args{ctx, r})
+	return p.ReturnErr
+}
+
+func (p *processor) Enabled(ctx context.Context, r log.Record) bool {
+	p.EnabledCalls = append(p.EnabledCalls, args{ctx, r})
+	return true
+}
+
+func (p *processor) Shutdown(ctx context.Context) error {
+	p.ShutdownCalls = append(p.ShutdownCalls, ctx)
+	return p.ReturnErr
+}
+
+func (p *processor) ForceFlush(ctx context.Context) error {
+	p.ForceFlushCalls = append(p.ForceFlushCalls, ctx)
+	return p.ReturnErr
+}
+
+func (p *processor) Reset() {
+	p.OnEmitCalls = p.OnEmitCalls[:0]
+	p.EnabledCalls = p.EnabledCalls[:0]
+	p.ShutdownCalls = p.ShutdownCalls[:0]
+	p.ForceFlushCalls = p.ForceFlushCalls[:0]
+}
+
+func TestLogProcessorOnEmit(t *testing.T) {
+	t.Run("Passthrough", func(t *testing.T) {
+		wrapped := &processor{ReturnErr: assert.AnError}
+
+		p := NewLogProcessor(wrapped, api.SeverityTrace1)
+		ctx := context.Background()
+		r := &log.Record{}
+		for _, sev := range severities {
+			r.SetSeverity(sev)
+			assert.ErrorIs(t, p.OnEmit(ctx, *r), assert.AnError, sev.String())
+
+			if assert.Lenf(t, wrapped.OnEmitCalls, 1, "Record with severity %s not passed-through", sev) {
+				assert.Equal(t, ctx, wrapped.OnEmitCalls[0].Ctx, sev.String())
+				assert.Equal(t, *r, wrapped.OnEmitCalls[0].Record, sev.String())
+			}
+			wrapped.Reset()
+		}
+	})
+
+	t.Run("Dropped", func(t *testing.T) {
+		wrapped := &processor{ReturnErr: assert.AnError}
+
+		p := NewLogProcessor(wrapped, api.SeverityFatal4+1)
+		ctx := context.Background()
+		r := &log.Record{}
+		for _, sev := range severities {
+			r.SetSeverity(sev)
+			assert.NoError(t, p.OnEmit(ctx, *r), assert.AnError, sev.String())
+
+			if !assert.Lenf(t, wrapped.OnEmitCalls, 0, "Record with severity %s passed-through", sev) {
+				wrapped.Reset()
+			}
+		}
+	})
+}
+
+func TestLogProcessorEnabled(t *testing.T) {
+	t.Run("Passthrough", func(t *testing.T) {
+		wrapped := &processor{}
+
+		p := NewLogProcessor(wrapped, api.SeverityTrace1)
+		ctx := context.Background()
+		r := &log.Record{}
+		for _, sev := range severities {
+			r.SetSeverity(sev)
+			assert.True(t, p.Enabled(ctx, *r), sev.String())
+
+			if assert.Lenf(t, wrapped.EnabledCalls, 1, "Record with severity %s not passed-through", sev) {
+				assert.Equal(t, ctx, wrapped.EnabledCalls[0].Ctx, sev.String())
+				assert.Equal(t, *r, wrapped.EnabledCalls[0].Record, sev.String())
+			}
+			wrapped.Reset()
+		}
+	})
+
+	t.Run("NotEnabled", func(t *testing.T) {
+		wrapped := &processor{}
+
+		p := NewLogProcessor(wrapped, api.SeverityFatal4+1)
+		ctx := context.Background()
+		r := &log.Record{}
+		for _, sev := range severities {
+			r.SetSeverity(sev)
+			assert.False(t, p.Enabled(ctx, *r), sev.String())
+
+			if !assert.Lenf(t, wrapped.EnabledCalls, 0, "Record with severity %s passed-through", sev) {
+				wrapped.Reset()
+			}
+		}
+	})
+}
+
+func TestLogProcessorForceFlushPassthrough(t *testing.T) {
+	wrapped := &processor{ReturnErr: assert.AnError}
+
+	p := NewLogProcessor(wrapped, api.SeverityTrace1)
+	ctx := context.Background()
+	assert.ErrorIs(t, p.ForceFlush(ctx), assert.AnError)
+	assert.Len(t, wrapped.ForceFlushCalls, 1, "ForceFlush not passed-through")
+}
+
+func TestLogProcessorShutdownPassthrough(t *testing.T) {
+	wrapped := &processor{ReturnErr: assert.AnError}
+
+	p := NewLogProcessor(wrapped, api.SeverityTrace1)
+	ctx := context.Background()
+	assert.ErrorIs(t, p.Shutdown(ctx), assert.AnError)
+	assert.Len(t, wrapped.ShutdownCalls, 1, "Shutdown not passed-through")
+}
+
+func TestLogProcessorNilDownstream(t *testing.T) {
+	p := NewLogProcessor(nil, api.SeverityTrace1)
+	ctx := context.Background()
+	r := log.Record{}
+	r.SetSeverity(api.SeverityTrace1)
+	assert.NotPanics(t, func() {
+		assert.NoError(t, p.OnEmit(ctx, r))
+		assert.False(t, p.Enabled(ctx, r))
+		assert.NoError(t, p.ForceFlush(ctx))
+		assert.NoError(t, p.Shutdown(ctx))
+	})
+}