From 908970b0d0f19b5427a85988c87bafba47f3d6e6 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Mon, 17 May 2021 12:28:18 -0700 Subject: [PATCH] Rename local variables in test assertions to improve some groovy assert messages (#3013) --- .../test/asserts/AttributesAssert.groovy | 20 ++--- .../test/asserts/SpanAssert.groovy | 86 +++++++++---------- 2 files changed, 51 insertions(+), 55 deletions(-) diff --git a/testing-common/src/main/groovy/io/opentelemetry/instrumentation/test/asserts/AttributesAssert.groovy b/testing-common/src/main/groovy/io/opentelemetry/instrumentation/test/asserts/AttributesAssert.groovy index 42620a242e..c0163284bc 100644 --- a/testing-common/src/main/groovy/io/opentelemetry/instrumentation/test/asserts/AttributesAssert.groovy +++ b/testing-common/src/main/groovy/io/opentelemetry/instrumentation/test/asserts/AttributesAssert.groovy @@ -28,20 +28,20 @@ class AttributesAssert { asserter.assertAttributesAllVerified() } - def attribute(String name, value) { - if (value == null) { + def attribute(String name, expected) { + if (expected == null) { return } assertedAttributes.add(name) - def val = attributes.get(name) - if (value instanceof Pattern) { - assert val =~ value - } else if (value instanceof Class) { - assert ((Class) value).isInstance(val) - } else if (value instanceof Closure) { - assert ((Closure) value).call(val) + def value = attributes.get(name) + if (expected instanceof Pattern) { + assert value =~ expected + } else if (expected instanceof Class) { + assert ((Class) expected).isInstance(value) + } else if (expected instanceof Closure) { + assert ((Closure) expected).call(value) } else { - assert val == value + assert value == expected } } diff --git a/testing-common/src/main/groovy/io/opentelemetry/instrumentation/test/asserts/SpanAssert.groovy b/testing-common/src/main/groovy/io/opentelemetry/instrumentation/test/asserts/SpanAssert.groovy index c63e1852f3..6aa62f2ff7 100644 --- a/testing-common/src/main/groovy/io/opentelemetry/instrumentation/test/asserts/SpanAssert.groovy +++ b/testing-common/src/main/groovy/io/opentelemetry/instrumentation/test/asserts/SpanAssert.groovy @@ -54,34 +54,30 @@ class SpanAssert { assertEvent(span.events.get(index), spec) } - def assertNameContains(String spanName, String... shouldContainArr) { - for (String shouldContain : shouldContainArr) { - assert spanName.contains(shouldContain) + def name(String expected) { + assert span.name == expected + checked.name = true + } + + def name(Pattern expected) { + assert span.name =~ expected + checked.name = true + } + + def name(Closure expected) { + assert ((Closure) expected).call(span.name) + checked.name = true + } + + def nameContains(String... expectedParts) { + for (String expectedPart : expectedParts) { + assert span.name.contains(expectedPart) } - } - - def name(String name) { - assert span.name == name checked.name = true } - def name(Pattern pattern) { - assert span.name =~ pattern - checked.name = true - } - - def name(Closure spec) { - assert ((Closure) spec).call(span.name) - checked.name = true - } - - def nameContains(String... nameParts) { - assertNameContains(span.name, nameParts) - checked.name = true - } - - def kind(SpanKind kind) { - assert span.kind == kind + def kind(SpanKind expected) { + assert span.kind == expected checked.kind = true } @@ -90,29 +86,29 @@ class SpanAssert { checked.parentSpanId = true } - def parentSpanId(String parentSpanId) { - assert span.parentSpanId == parentSpanId + def parentSpanId(String expected) { + assert span.parentSpanId == expected checked.parentId = true } - def traceId(String traceId) { - assert span.traceId == traceId + def traceId(String expected) { + assert span.traceId == expected checked.traceId = true } - def childOf(SpanData parent) { - parentSpanId(parent.spanId) - traceId(parent.traceId) + def childOf(SpanData expectedParent) { + parentSpanId(expectedParent.spanId) + traceId(expectedParent.traceId) } - def hasLink(SpanData linked) { - hasLink(linked.traceId, linked.spanId) + def hasLink(SpanData expectedLink) { + hasLink(expectedLink.traceId, expectedLink.spanId) } - def hasLink(String traceId, String spanId) { + def hasLink(String expectedTraceId, String expectedSpanId) { def found = false for (def link : span.links) { - if (link.spanContext.traceId == traceId && link.spanContext.spanId == spanId) { + if (link.spanContext.traceId == expectedTraceId && link.spanContext.spanId == expectedSpanId) { found = true break } @@ -120,27 +116,27 @@ class SpanAssert { assert found } - def status(StatusCode status) { - assert span.status.statusCode == status + def status(StatusCode expected) { + assert span.status.statusCode == expected checked.status = true } - def errorEvent(Class errorType) { - errorEvent(errorType, null) + def errorEvent(Class expectedClass) { + errorEvent(expectedClass, null) } - def errorEvent(Class errorType, message) { - errorEvent(errorType, message, 0) + def errorEvent(Class expectedClass, expectedMessage) { + errorEvent(expectedClass, expectedMessage, 0) } - def errorEvent(Class errorType, message, int index) { + def errorEvent(Class errorClass, expectedMessage, int index) { event(index) { eventName(SemanticAttributes.EXCEPTION_EVENT_NAME) attributes { - "${SemanticAttributes.EXCEPTION_TYPE.key}" errorType.canonicalName + "${SemanticAttributes.EXCEPTION_TYPE.key}" errorClass.canonicalName "${SemanticAttributes.EXCEPTION_STACKTRACE.key}" String - if (message != null) { - "${SemanticAttributes.EXCEPTION_MESSAGE.key}" message + if (expectedMessage != null) { + "${SemanticAttributes.EXCEPTION_MESSAGE.key}" expectedMessage } } }