From a571bc10697eaee7c27f13f177afecd7b9754849 Mon Sep 17 00:00:00 2001 From: codeimmortal Date: Thu, 22 May 2025 12:54:32 +0530 Subject: [PATCH] remove internal/matchers (#6777) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes https://github.com/open-telemetry/opentelemetry-go/issues/6523 Remove internal/matchers from code base and its code generation Co-authored-by: Robert Pająk Co-authored-by: Damien Mathieu <42@dmathieu.com> --- .golangci.yml | 2 - internal/gen.go | 4 - internal/matchers/expectation.go | 299 -------------------------- internal/matchers/expecter.go | 28 --- internal/matchers/package.go | 4 - internal/matchers/temporal_matcher.go | 17 -- 6 files changed, 354 deletions(-) delete mode 100644 internal/matchers/expectation.go delete mode 100644 internal/matchers/expecter.go delete mode 100644 internal/matchers/package.go delete mode 100644 internal/matchers/temporal_matcher.go diff --git a/.golangci.yml b/.golangci.yml index 888e5da80..2de8c4ed4 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -66,8 +66,6 @@ linters: desc: Do not use cross-module internal packages. - pkg: go.opentelemetry.io/otel/internal/internaltest desc: Do not use cross-module internal packages. - - pkg: go.opentelemetry.io/otel/internal/matchers - desc: Do not use cross-module internal packages. otlp-internal: files: - '!**/exporters/otlp/internal/**/*.go' diff --git a/internal/gen.go b/internal/gen.go index 7f3d0d8e5..516c7fe54 100644 --- a/internal/gen.go +++ b/internal/gen.go @@ -4,10 +4,6 @@ // Package internal contains utility functions and internal implementations package internal // import "go.opentelemetry.io/otel/internal" -//go:generate gotmpl --body=./shared/matchers/expectation.go.tmpl "--data={}" --out=matchers/expectation.go -//go:generate gotmpl --body=./shared/matchers/expecter.go.tmpl "--data={}" --out=matchers/expecter.go -//go:generate gotmpl --body=./shared/matchers/temporal_matcher.go.tmpl "--data={}" --out=matchers/temporal_matcher.go - //go:generate gotmpl --body=./shared/internaltest/doc.go.tmpl "--data={}" --out=internaltest/doc.go //go:generate gotmpl --body=./shared/internaltest/text_map_carrier.go.tmpl "--data={}" --out=internaltest/text_map_carrier.go //go:generate gotmpl --body=./shared/internaltest/text_map_carrier_test.go.tmpl "--data={}" --out=internaltest/text_map_carrier_test.go diff --git a/internal/matchers/expectation.go b/internal/matchers/expectation.go deleted file mode 100644 index 08dbd3bc1..000000000 --- a/internal/matchers/expectation.go +++ /dev/null @@ -1,299 +0,0 @@ -// Code generated by gotmpl. DO NOT MODIFY. -// source: internal/shared/matchers/expectation.go.tmpl - -// Copyright The OpenTelemetry Authors -// SPDX-License-Identifier: Apache-2.0 - -// Package matchers provides comparison and matching functionality for tests. -package matchers // import "go.opentelemetry.io/otel/internal/matchers" - -import ( - "fmt" - "reflect" - "regexp" - "runtime/debug" - "strings" - "testing" - "time" -) - -var stackTracePruneRE = regexp.MustCompile(`runtime\/debug|testing|internal\/matchers`) - -type Expectation struct { - t *testing.T - actual interface{} -} - -func (e *Expectation) ToEqual(expected interface{}) { - e.verifyExpectedNotNil(expected) - - if !reflect.DeepEqual(e.actual, expected) { - e.fatalf("Expected\n\t%v\nto equal\n\t%v", e.actual, expected) - } -} - -func (e *Expectation) NotToEqual(expected interface{}) { - e.verifyExpectedNotNil(expected) - - if reflect.DeepEqual(e.actual, expected) { - e.fatalf("Expected\n\t%v\nnot to equal\n\t%v", e.actual, expected) - } -} - -func (e *Expectation) ToBeNil() { - if e.actual != nil { - e.fatalf("Expected\n\t%v\nto be nil", e.actual) - } -} - -func (e *Expectation) NotToBeNil() { - if e.actual == nil { - e.fatalf("Expected\n\t%v\nnot to be nil", e.actual) - } -} - -func (e *Expectation) ToBeTrue() { - switch a := e.actual.(type) { - case bool: - if !a { - e.fatalf("Expected\n\t%v\nto be true", e.actual) - } - default: - e.fatalf("Cannot check if non-bool value\n\t%v\nis truthy", a) - } -} - -func (e *Expectation) ToBeFalse() { - switch a := e.actual.(type) { - case bool: - if a { - e.fatalf("Expected\n\t%v\nto be false", e.actual) - } - default: - e.fatalf("Cannot check if non-bool value\n\t%v\nis truthy", a) - } -} - -func (e *Expectation) NotToPanic() { - switch a := e.actual.(type) { - case func(): - func() { - defer func() { - if recovered := recover(); recovered != nil { - e.fatalf("Expected panic\n\t%v\nto have not been raised", recovered) - } - }() - - a() - }() - default: - e.fatalf("Cannot check if non-func value\n\t%v\nis truthy", a) - } -} - -func (e *Expectation) ToSucceed() { - switch actual := e.actual.(type) { - case error: - if actual != nil { - e.fatalf("Expected error\n\t%v\nto have succeeded", actual) - } - default: - e.fatalf("Cannot check if non-error value\n\t%v\nsucceeded", actual) - } -} - -func (e *Expectation) ToMatchError(expected interface{}) { - e.verifyExpectedNotNil(expected) - - actual, ok := e.actual.(error) - if !ok { - e.fatalf("Cannot check if non-error value\n\t%v\nmatches error", e.actual) - } - - switch expected := expected.(type) { - case error: - if !reflect.DeepEqual(actual, expected) { - e.fatalf("Expected\n\t%v\nto match error\n\t%v", actual, expected) - } - case string: - if actual.Error() != expected { - e.fatalf("Expected\n\t%v\nto match error\n\t%v", actual, expected) - } - default: - e.fatalf("Cannot match\n\t%v\nagainst non-error\n\t%v", actual, expected) - } -} - -func (e *Expectation) ToContain(expected interface{}) { - actualValue := reflect.ValueOf(e.actual) - actualKind := actualValue.Kind() - - switch actualKind { - case reflect.Array, reflect.Slice: - default: - e.fatalf("Expected\n\t%v\nto be an array", e.actual) - return - } - - expectedValue := reflect.ValueOf(expected) - expectedKind := expectedValue.Kind() - - switch expectedKind { - case reflect.Array, reflect.Slice: - default: - expectedValue = reflect.ValueOf([]interface{}{expected}) - } - - for i := 0; i < expectedValue.Len(); i++ { - var contained bool - expectedElem := expectedValue.Index(i).Interface() - - for j := 0; j < actualValue.Len(); j++ { - if reflect.DeepEqual(actualValue.Index(j).Interface(), expectedElem) { - contained = true - break - } - } - - if !contained { - e.fatalf("Expected\n\t%v\nto contain\n\t%v", e.actual, expectedElem) - return - } - } -} - -func (e *Expectation) NotToContain(expected interface{}) { - actualValue := reflect.ValueOf(e.actual) - actualKind := actualValue.Kind() - - switch actualKind { - case reflect.Array, reflect.Slice: - default: - e.fatalf("Expected\n\t%v\nto be an array", e.actual) - return - } - - expectedValue := reflect.ValueOf(expected) - expectedKind := expectedValue.Kind() - - switch expectedKind { - case reflect.Array, reflect.Slice: - default: - expectedValue = reflect.ValueOf([]interface{}{expected}) - } - - for i := 0; i < expectedValue.Len(); i++ { - expectedElem := expectedValue.Index(i).Interface() - - for j := 0; j < actualValue.Len(); j++ { - if reflect.DeepEqual(actualValue.Index(j).Interface(), expectedElem) { - e.fatalf("Expected\n\t%v\nnot to contain\n\t%v", e.actual, expectedElem) - return - } - } - } -} - -func (e *Expectation) ToMatchInAnyOrder(expected interface{}) { - expectedValue := reflect.ValueOf(expected) - expectedKind := expectedValue.Kind() - - switch expectedKind { - case reflect.Array, reflect.Slice: - default: - e.fatalf("Expected\n\t%v\nto be an array", expected) - return - } - - actualValue := reflect.ValueOf(e.actual) - actualKind := actualValue.Kind() - - if actualKind != expectedKind { - e.fatalf("Expected\n\t%v\nto be the same type as\n\t%v", e.actual, expected) - return - } - - if actualValue.Len() != expectedValue.Len() { - e.fatalf("Expected\n\t%v\nto have the same length as\n\t%v", e.actual, expected) - return - } - - var unmatched []interface{} - - for i := 0; i < expectedValue.Len(); i++ { - unmatched = append(unmatched, expectedValue.Index(i).Interface()) - } - - for i := 0; i < actualValue.Len(); i++ { - var found bool - - for j, elem := range unmatched { - if reflect.DeepEqual(actualValue.Index(i).Interface(), elem) { - found = true - unmatched = append(unmatched[:j], unmatched[j+1:]...) - - break - } - } - - if !found { - e.fatalf("Expected\n\t%v\nto contain the same elements as\n\t%v", e.actual, expected) - } - } -} - -func (e *Expectation) ToBeTemporally(matcher TemporalMatcher, compareTo interface{}) { - if actual, ok := e.actual.(time.Time); ok { - ct, ok := compareTo.(time.Time) - if !ok { - e.fatalf("Cannot compare to non-temporal value\n\t%v", compareTo) - return - } - - switch matcher { - case Before: - if !actual.Before(ct) { - e.fatalf("Expected\n\t%v\nto be temporally before\n\t%v", e.actual, compareTo) - } - case BeforeOrSameTime: - if actual.After(ct) { - e.fatalf("Expected\n\t%v\nto be temporally before or at the same time as\n\t%v", e.actual, compareTo) - } - case After: - if !actual.After(ct) { - e.fatalf("Expected\n\t%v\nto be temporally after\n\t%v", e.actual, compareTo) - } - case AfterOrSameTime: - if actual.Before(ct) { - e.fatalf("Expected\n\t%v\nto be temporally after or at the same time as\n\t%v", e.actual, compareTo) - } - default: - e.fatalf("Cannot compare times with unexpected temporal matcher") - } - - return - } - - e.fatalf("Cannot compare non-temporal value\n\t%v", e.actual) -} - -func (e *Expectation) verifyExpectedNotNil(expected interface{}) { - if expected == nil { - e.fatalf("Refusing to compare with . Use `ToBeNil` or `NotToBeNil` instead.") - } -} - -func (e *Expectation) fatalf(format string, a ...any) { - // Prune the stack trace so that it's easier to see relevant lines - stack := strings.Split(string(debug.Stack()), "\n") - var prunedStack []string - - for _, line := range stack { - if !stackTracePruneRE.MatchString(line) { - prunedStack = append(prunedStack, line) - } - } - - msg := fmt.Sprintf(format, a...) - e.t.Fatalf("\n%s\n%s\n", strings.Join(prunedStack, "\n"), msg) -} diff --git a/internal/matchers/expecter.go b/internal/matchers/expecter.go deleted file mode 100644 index 18c174fda..000000000 --- a/internal/matchers/expecter.go +++ /dev/null @@ -1,28 +0,0 @@ -// Code generated by gotmpl. DO NOT MODIFY. -// source: internal/shared/matchers/expecter.go.tmpl - -// Copyright The OpenTelemetry Authors -// SPDX-License-Identifier: Apache-2.0 - -package matchers // import "go.opentelemetry.io/otel/internal/matchers" - -import ( - "testing" -) - -type Expecter struct { - t *testing.T -} - -func NewExpecter(t *testing.T) *Expecter { - return &Expecter{ - t: t, - } -} - -func (a *Expecter) Expect(actual interface{}) *Expectation { - return &Expectation{ - t: a.t, - actual: actual, - } -} diff --git a/internal/matchers/package.go b/internal/matchers/package.go deleted file mode 100644 index 812ce9704..000000000 --- a/internal/matchers/package.go +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright The OpenTelemetry Authors -// SPDX-License-Identifier: Apache-2.0 - -package matchers // import "go.opentelemetry.io/otel/internal/matchers" diff --git a/internal/matchers/temporal_matcher.go b/internal/matchers/temporal_matcher.go deleted file mode 100644 index e77251f35..000000000 --- a/internal/matchers/temporal_matcher.go +++ /dev/null @@ -1,17 +0,0 @@ -// Code generated by gotmpl. DO NOT MODIFY. -// source: internal/shared/matchers/temporal_matcher.go.tmpl - -// Copyright The OpenTelemetry Authors -// SPDX-License-Identifier: Apache-2.0 - -package matchers // import "go.opentelemetry.io/otel/internal/matchers" - -type TemporalMatcher byte - -//nolint:revive // ignoring missing comments for unexported constants in an internal package -const ( - Before TemporalMatcher = iota - BeforeOrSameTime - After - AfterOrSameTime -)