Skip to content

Commit ad0cb28

Browse files
nikita-tkachenko-datadognikita-tkachenko-datadog
authored
Fix Cucumber JUnit 4 instrumentation to correctly handle feature and scenario names with brackets (#7446)
1 parent 2fa95bf commit ad0cb28

7 files changed

Lines changed: 229 additions & 5 deletions

File tree

‎dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/events/TestEventsHandlerImpl.java‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,14 @@ public void onTestStart(
132132
}
133133

134134
TestSuiteImpl testSuite = inProgressTestSuites.get(suiteDescriptor);
135+
if (testSuite == null) {
136+
throw new IllegalStateException(
137+
"Could not find test suite with descriptor "
138+
+ suiteDescriptor
139+
+ "; test descriptor: "
140+
+ descriptor);
141+
}
142+
135143
TestImpl test = testSuite.testStart(testName, testParameters, testMethod, null);
136144

137145
TestIdentifier thisTest = new TestIdentifier(testSuiteName, testName, testParameters, null);

‎dd-java-agent/instrumentation/junit-4.10/cucumber-junit-4/src/main/java/datadog/trace/instrumentation/junit4/CucumberTracingListener.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public void testSuiteFinished(final Description description) {
6666
@Override
6767
public void testStarted(final Description description) {
6868
String testSuiteName = CucumberUtils.getTestSuiteNameForScenario(description);
69-
String testName = description.getMethodName();
69+
String testName = CucumberUtils.getTestNameForScenario(description);
7070
List<String> categories = getCategories(description);
7171

7272
TestRetryPolicy retryPolicy = retryPolicies.get(description);
@@ -159,7 +159,7 @@ public void testIgnored(final Description description) {
159159
TestEventsHandlerHolder.TEST_EVENTS_HANDLER.onTestSuiteFinish(suiteDescriptor);
160160
} else {
161161
String testSuiteName = CucumberUtils.getTestSuiteNameForScenario(description);
162-
String testName = description.getMethodName();
162+
String testName = CucumberUtils.getTestNameForScenario(description);
163163
List<String> categories = getCategories(description);
164164
TestEventsHandlerHolder.TEST_EVENTS_HANDLER.onTestIgnore(
165165
new TestSuiteDescriptor(testSuiteName, null),

‎dd-java-agent/instrumentation/junit-4.10/cucumber-junit-4/src/main/java/datadog/trace/instrumentation/junit4/CucumberUtils.java‎

Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,53 @@ public static String getTestSuiteNameForFeature(Description featureDescription)
7979

8080
public static String getTestSuiteNameForScenario(Description scenarioDescription) {
8181
URI featureUri = getFeatureUri(scenarioDescription);
82-
return (featureUri != null ? featureUri + ":" : "") + scenarioDescription.getClassName();
82+
return (featureUri != null ? featureUri + ":" : "")
83+
+ getFeatureNameForScenario(scenarioDescription);
84+
}
85+
86+
private static String getFeatureNameForScenario(Description scenarioDescription) {
87+
String scenarioDescriptionString = scenarioDescription.toString();
88+
int featureNameStart = getFeatureNameStartIdx(scenarioDescriptionString);
89+
if (featureNameStart >= 0) {
90+
int descriptionLength = scenarioDescriptionString.length();
91+
// feature name is wrapped in brackets, hence the +1/-1
92+
return scenarioDescriptionString.substring(featureNameStart + 1, descriptionLength - 1);
93+
} else {
94+
// fallback to default method
95+
return scenarioDescription.getClassName();
96+
}
97+
}
98+
99+
public static String getTestNameForScenario(Description scenarioDescription) {
100+
String scenarioDescriptionString = scenarioDescription.toString();
101+
int featureNameStart = getFeatureNameStartIdx(scenarioDescriptionString);
102+
if (featureNameStart >= 0) {
103+
return scenarioDescriptionString.substring(0, featureNameStart);
104+
} else {
105+
// fallback to default method
106+
return scenarioDescription.getMethodName();
107+
}
108+
}
109+
110+
/**
111+
* JUnit 4 expects description string to have the form {@code "Scenario Name(Feature Name)"} The
112+
* standard {@link Description#getClassName()} and {@link Description#getMethodName()} methods use
113+
* a regex to split the name parts. This does not work correctly when feature or scenario names
114+
* have bracket characters in them.
115+
*/
116+
private static int getFeatureNameStartIdx(String scenarioDescriptionString) {
117+
int openBrackets = 0;
118+
for (int i = scenarioDescriptionString.length() - 1; i >= 0; i--) {
119+
char c = scenarioDescriptionString.charAt(i);
120+
if (c == ')') {
121+
openBrackets++;
122+
} else if (c == '(') {
123+
if (--openBrackets == 0) {
124+
return i;
125+
}
126+
}
127+
}
128+
return -1;
83129
}
84130

85131
private static URI getFeatureUri(Description scenarioDescription) {
@@ -100,13 +146,13 @@ public static Description getPickleRunnerDescription(
100146

101147
public static TestIdentifier toTestIdentifier(Description description) {
102148
String suite = getTestSuiteNameForScenario(description);
103-
String name = description.getMethodName();
149+
String name = getTestNameForScenario(description);
104150
return new TestIdentifier(suite, name, null, null);
105151
}
106152

107153
public static TestDescriptor toTestDescriptor(Description description) {
108154
String suite = getTestSuiteNameForScenario(description);
109-
String name = description.getMethodName();
155+
String name = getTestNameForScenario(description);
110156
return new TestDescriptor(suite, null, name, null, null);
111157
}
112158

‎dd-java-agent/instrumentation/junit-4.10/cucumber-junit-4/src/test/groovy/CucumberTest.groovy‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ class CucumberTest extends CiVisibilityInstrumentationTest {
2828
"org/example/cucumber/calculator/basic_arithmetic.feature",
2929
"org/example/cucumber/calculator/basic_arithmetic_failed.feature"
3030
] | 3
31+
"test-name-with-brackets" | ["org/example/cucumber/calculator/name_with_brackets.feature"] | 2
3132
}
3233

3334
def "test ITR #testcaseName"() {

‎dd-java-agent/instrumentation/junit-4.10/cucumber-junit-4/src/test/resources/org/example/cucumber/calculator/name_with_brackets.feature‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
@foo
2+
Feature: This (Name) Has Bracket Characters
3+
4+
Background: A Calculator
5+
Given a calculator I just turned on
6+
7+
Scenario: Addition (Has) Brackets Too
8+
# Try to change one of the values below to provoke a failure
9+
When I add 4 and 5
10+
Then the result is 9

‎dd-java-agent/instrumentation/junit-4.10/cucumber-junit-4/src/test/resources/test-name-with-brackets/coverages.ftl‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[ {
2+
"test_session_id" : ${content_test_session_id},
3+
"test_suite_id" : ${content_test_suite_id},
4+
"span_id" : ${content_span_id},
5+
"files" : [ {
6+
"filename" : "org/example/cucumber/calculator/name_with_brackets.feature"
7+
} ]
8+
} ]

‎dd-java-agent/instrumentation/junit-4.10/cucumber-junit-4/src/test/resources/test-name-with-brackets/events.ftl‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
[ {
2+
"type" : "test_suite_end",
3+
"version" : 1,
4+
"content" : {
5+
"test_session_id" : ${content_test_session_id},
6+
"test_module_id" : ${content_test_module_id},
7+
"test_suite_id" : ${content_test_suite_id},
8+
"service" : "worker.org.gradle.process.internal.worker.gradleworkermain",
9+
"name" : "junit.test_suite",
10+
"resource" : "classpath:org/example/cucumber/calculator/name_with_brackets.feature:This (Name) Has Bracket Characters",
11+
"start" : ${content_start},
12+
"duration" : ${content_duration},
13+
"error" : 0,
14+
"metrics" : { },
15+
"meta" : {
16+
"test.type" : "test",
17+
"os.architecture" : ${content_meta_os_architecture},
18+
"test.module" : "cucumber-junit-4",
19+
"test.status" : "pass",
20+
"runtime.name" : ${content_meta_runtime_name},
21+
"runtime.vendor" : ${content_meta_runtime_vendor},
22+
"env" : "none",
23+
"os.platform" : ${content_meta_os_platform},
24+
"dummy_ci_tag" : "dummy_ci_tag_value",
25+
"os.version" : ${content_meta_os_version},
26+
"library_version" : ${content_meta_library_version},
27+
"component" : "junit",
28+
"span.kind" : "test_suite_end",
29+
"test.suite" : "classpath:org/example/cucumber/calculator/name_with_brackets.feature:This (Name) Has Bracket Characters",
30+
"runtime.version" : ${content_meta_runtime_version},
31+
"test.framework_version" : ${content_meta_test_framework_version},
32+
"test.framework" : "cucumber"
33+
}
34+
}
35+
}, {
36+
"type" : "test",
37+
"version" : 2,
38+
"content" : {
39+
"trace_id" : ${content_trace_id},
40+
"span_id" : ${content_span_id},
41+
"parent_id" : ${content_parent_id},
42+
"test_session_id" : ${content_test_session_id},
43+
"test_module_id" : ${content_test_module_id},
44+
"test_suite_id" : ${content_test_suite_id},
45+
"service" : "worker.org.gradle.process.internal.worker.gradleworkermain",
46+
"name" : "junit.test",
47+
"resource" : "classpath:org/example/cucumber/calculator/name_with_brackets.feature:This (Name) Has Bracket Characters.Addition (Has) Brackets Too",
48+
"start" : ${content_start_2},
49+
"duration" : ${content_duration_2},
50+
"error" : 0,
51+
"metrics" : {
52+
"process_id" : ${content_metrics_process_id},
53+
"_dd.profiling.enabled" : 0,
54+
"_dd.trace_span_attribute_schema" : 0
55+
},
56+
"meta" : {
57+
"os.architecture" : ${content_meta_os_architecture},
58+
"test.module" : "cucumber-junit-4",
59+
"test.status" : "pass",
60+
"language" : "jvm",
61+
"runtime.name" : ${content_meta_runtime_name},
62+
"os.platform" : ${content_meta_os_platform},
63+
"os.version" : ${content_meta_os_version},
64+
"library_version" : ${content_meta_library_version},
65+
"test.name" : "Addition (Has) Brackets Too",
66+
"span.kind" : "test",
67+
"test.suite" : "classpath:org/example/cucumber/calculator/name_with_brackets.feature:This (Name) Has Bracket Characters",
68+
"runtime.version" : ${content_meta_runtime_version},
69+
"runtime-id" : ${content_meta_runtime_id},
70+
"test.type" : "test",
71+
"test.traits" : "{\"category\":[\"foo\"]}",
72+
"runtime.vendor" : ${content_meta_runtime_vendor},
73+
"env" : "none",
74+
"dummy_ci_tag" : "dummy_ci_tag_value",
75+
"component" : "junit",
76+
"_dd.profiling.ctx" : "test",
77+
"test.framework_version" : ${content_meta_test_framework_version},
78+
"test.framework" : "cucumber"
79+
}
80+
}
81+
}, {
82+
"type" : "test_session_end",
83+
"version" : 1,
84+
"content" : {
85+
"test_session_id" : ${content_test_session_id},
86+
"service" : "worker.org.gradle.process.internal.worker.gradleworkermain",
87+
"name" : "junit.test_session",
88+
"resource" : "cucumber-junit-4",
89+
"start" : ${content_start_3},
90+
"duration" : ${content_duration_3},
91+
"error" : 0,
92+
"metrics" : {
93+
"process_id" : ${content_metrics_process_id},
94+
"_dd.profiling.enabled" : 0,
95+
"_dd.trace_span_attribute_schema" : 0
96+
},
97+
"meta" : {
98+
"test.type" : "test",
99+
"os.architecture" : ${content_meta_os_architecture},
100+
"test.status" : "pass",
101+
"language" : "jvm",
102+
"runtime.name" : ${content_meta_runtime_name},
103+
"runtime.vendor" : ${content_meta_runtime_vendor},
104+
"env" : "none",
105+
"os.platform" : ${content_meta_os_platform},
106+
"dummy_ci_tag" : "dummy_ci_tag_value",
107+
"os.version" : ${content_meta_os_version},
108+
"library_version" : ${content_meta_library_version},
109+
"component" : "junit",
110+
"_dd.profiling.ctx" : "test",
111+
"span.kind" : "test_session_end",
112+
"runtime.version" : ${content_meta_runtime_version},
113+
"runtime-id" : ${content_meta_runtime_id},
114+
"test.command" : "cucumber-junit-4",
115+
"test.framework_version" : ${content_meta_test_framework_version},
116+
"test.framework" : "cucumber"
117+
}
118+
}
119+
}, {
120+
"type" : "test_module_end",
121+
"version" : 1,
122+
"content" : {
123+
"test_session_id" : ${content_test_session_id},
124+
"test_module_id" : ${content_test_module_id},
125+
"service" : "worker.org.gradle.process.internal.worker.gradleworkermain",
126+
"name" : "junit.test_module",
127+
"resource" : "cucumber-junit-4",
128+
"start" : ${content_start_4},
129+
"duration" : ${content_duration_4},
130+
"error" : 0,
131+
"metrics" : { },
132+
"meta" : {
133+
"test.type" : "test",
134+
"os.architecture" : ${content_meta_os_architecture},
135+
"test.module" : "cucumber-junit-4",
136+
"test.status" : "pass",
137+
"runtime.name" : ${content_meta_runtime_name},
138+
"runtime.vendor" : ${content_meta_runtime_vendor},
139+
"env" : "none",
140+
"os.platform" : ${content_meta_os_platform},
141+
"dummy_ci_tag" : "dummy_ci_tag_value",
142+
"os.version" : ${content_meta_os_version},
143+
"library_version" : ${content_meta_library_version},
144+
"component" : "junit",
145+
"span.kind" : "test_module_end",
146+
"runtime.version" : ${content_meta_runtime_version},
147+
"test.framework_version" : ${content_meta_test_framework_version},
148+
"test.framework" : "cucumber"
149+
}
150+
}
151+
} ]

0 commit comments

Comments
 (0)