forked from open-telemetry/opentelemetry-go
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce logtest.AssertRecordEqual (open-telemetry#5499)
This is a follow-up to the comments in open-telemetry#5468 (comment), introducing `logtest.AssertRecordEqual` so bridges can compare log records more easily. --------- Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
- Loading branch information
Showing
5 changed files
with
106 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package logtest // import "go.opentelemetry.io/otel/log/logtest" | ||
|
||
import ( | ||
"slices" | ||
"testing" | ||
|
||
"go.opentelemetry.io/otel/log" | ||
) | ||
|
||
// AssertRecordEqual compares two log records, and fails the test if they are | ||
// not equal. | ||
func AssertRecordEqual(t testing.TB, want, got log.Record) bool { | ||
t.Helper() | ||
|
||
if !want.Timestamp().Equal(got.Timestamp()) { | ||
t.Errorf("Timestamp value is not equal:\nwant: %v\ngot: %v", want.Timestamp(), got.Timestamp()) | ||
return false | ||
} | ||
if !want.ObservedTimestamp().Equal(got.ObservedTimestamp()) { | ||
t.Errorf("ObservedTimestamp value is not equal:\nwant: %v\ngot: %v", want.ObservedTimestamp(), got.ObservedTimestamp()) | ||
return false | ||
} | ||
if want.Severity() != got.Severity() { | ||
t.Errorf("Severity value is not equal:\nwant: %v\ngot: %v", want.Severity(), got.Severity()) | ||
return false | ||
} | ||
if want.SeverityText() != got.SeverityText() { | ||
t.Errorf("SeverityText value is not equal:\nwant: %v\ngot: %v", want.SeverityText(), got.SeverityText()) | ||
return false | ||
} | ||
if !assertBody(t, want.Body(), got) { | ||
return false | ||
} | ||
|
||
var attrs []log.KeyValue | ||
want.WalkAttributes(func(kv log.KeyValue) bool { | ||
attrs = append(attrs, kv) | ||
return true | ||
}) | ||
return assertAttributes(t, attrs, got) | ||
} | ||
|
||
func assertBody(t testing.TB, want log.Value, r log.Record) bool { | ||
t.Helper() | ||
got := r.Body() | ||
if !got.Equal(want) { | ||
t.Errorf("Body value is not equal:\nwant: %v\ngot: %v", want, got) | ||
return false | ||
} | ||
|
||
return true | ||
} | ||
|
||
func assertAttributes(t testing.TB, want []log.KeyValue, r log.Record) bool { | ||
t.Helper() | ||
var got []log.KeyValue | ||
r.WalkAttributes(func(kv log.KeyValue) bool { | ||
got = append(got, kv) | ||
return true | ||
}) | ||
if !slices.EqualFunc(want, got, log.KeyValue.Equal) { | ||
t.Errorf("Attributes are not equal:\nwant: %v\ngot: %v", want, got) | ||
return false | ||
} | ||
|
||
return true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package logtest | ||
|
||
import ( | ||
"testing" | ||
"time" | ||
|
||
"go.opentelemetry.io/otel/log" | ||
) | ||
|
||
func TestAssertRecord(t *testing.T) { | ||
r1 := log.Record{} | ||
r2 := log.Record{} | ||
now := time.Now() | ||
|
||
AssertRecordEqual(t, r1, r2) | ||
|
||
r1.SetTimestamp(now) | ||
r2.SetTimestamp(now) | ||
r1.SetObservedTimestamp(now) | ||
r2.SetObservedTimestamp(now) | ||
r1.SetSeverity(log.SeverityTrace1) | ||
r2.SetSeverity(log.SeverityTrace1) | ||
r1.SetSeverityText("trace") | ||
r2.SetSeverityText("trace") | ||
r1.SetBody(log.StringValue("log body")) | ||
r2.SetBody(log.StringValue("log body")) | ||
r1.AddAttributes(log.Bool("attr", true)) | ||
r2.AddAttributes(log.Bool("attr", true)) | ||
AssertRecordEqual(t, r1, r2) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters