Skip to content

Add titlePath as the default test hierarchy path #1271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
baev merged 1 commit into from
May 8, 2026
Merged

Add titlePath as the default test hierarchy path #1271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion allure-citrus/src/main/java/io/qameta/allure/citrus/AllureCitrus.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
import static io.qameta.allure.util.ResultsUtils.createParameter;
import static io.qameta.allure.util.ResultsUtils.createSuiteLabel;
import static io.qameta.allure.util.ResultsUtils.createThreadLabel;
import static io.qameta.allure.util.ResultsUtils.createTitlePath;
import static io.qameta.allure.util.ResultsUtils.getProvidedLabels;

/**
Expand Down Expand Up @@ -161,16 +162,19 @@ public void onTestActionSkipped(final TestCase testCase, final TestAction testAc

private void startTestCase(final TestCase testCase) {
final String uuid = createUuid(testCase);
final Optional<? extends Class<?>> testClass = Optional.ofNullable(testCase.getTestClass());

final TestResult result = new TestResult()
.setUuid(uuid)
.setName(testCase.getName())
.setTitlePath(testClass
.map(ResultsUtils::createTitlePathFromJavaClass)
.orElseGet(() -> createTitlePath(testCase.getName())))
.setStage(Stage.RUNNING);

result.getLabels().addAll(getProvidedLabels());


final Optional<? extends Class<?>> testClass = Optional.ofNullable(testCase.getTestClass());
testClass.map(this::getLabels).ifPresent(result.getLabels()::addAll);
testClass.map(this::getLinks).ifPresent(result.getLinks()::addAll);

Expand Down
2 changes: 2 additions & 0 deletions allure-citrus/src/test/java/io/qameta/allure/citrus/AllureCitrusTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ void shouldSetName() {
assertThat(results.getTestResults())
.extracting(TestResult::getName)
.containsExactly("Simple test");
assertThat(results.getTestResults().get(0).getTitlePath())
.containsExactly("com", "consol", "citrus", "dsl", "design", "DefaultTestDesigner");
}

@AllureFeatures.PassedTests
Expand Down
6 changes: 6 additions & 0 deletions allure-cucumber4-jvm/src/main/java/io/qameta/allure/cucumber4jvm/AllureCucumber4Jvm.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@

import static cucumber.api.HookType.Before;
import static io.qameta.allure.util.ResultsUtils.createParameter;
import static io.qameta.allure.util.ResultsUtils.createTitlePath;
import static io.qameta.allure.util.ResultsUtils.createTitlePathFromSourcePath;
import static io.qameta.allure.util.ResultsUtils.getStatus;
import static io.qameta.allure.util.ResultsUtils.getStatusDetails;
import static io.qameta.allure.util.ResultsUtils.md5;
Expand Down Expand Up @@ -156,11 +158,15 @@ private void handleTestCaseStarted(final TestCaseStarted event) {
final String testCaseUuid = testCaseUuids
.computeIfAbsent(testCase, tc -> UUID.randomUUID().toString());

final List<String> titlePath = createTitlePathFromSourcePath(getTestCaseUri(testCase));
titlePath.addAll(createTitlePath(feature.getName()));

final TestResult result = new TestResult()
.setUuid(testCaseUuid)
.setTestCaseId(getTestCaseId(testCase))
.setHistoryId(getHistoryId(testCase))
.setFullName(fullName)
.setTitlePath(titlePath)
.setName(name)
.setLabels(labelBuilder.getScenarioLabels())
.setLinks(labelBuilder.getScenarioLinks());
Expand Down
2 changes: 2 additions & 0 deletions allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/AllureCucumber4JvmTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ void shouldSetName() {
assertThat(testResults)
.extracting(TestResult::getName)
.containsExactlyInAnyOrder("Add a to b");
assertThat(testResults.get(0).getTitlePath())
.containsExactly("src", "test", "resources", "features", "simple.feature", "Simple feature");
}

@AllureFeatures.PassedTests
Expand Down
6 changes: 6 additions & 0 deletions allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/AllureCucumber5Jvm.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@
import java.util.stream.Stream;

import static io.qameta.allure.util.ResultsUtils.createParameter;
import static io.qameta.allure.util.ResultsUtils.createTitlePath;
import static io.qameta.allure.util.ResultsUtils.createTitlePathFromSourcePath;
import static io.qameta.allure.util.ResultsUtils.getStatus;
import static io.qameta.allure.util.ResultsUtils.getStatusDetails;
import static io.qameta.allure.util.ResultsUtils.md5;
Expand Down Expand Up @@ -150,11 +152,15 @@ private void handleTestCaseStarted(final TestCaseStarted event) {

final String testCaseUuid = testCase.getId().toString();

final List<String> titlePath = createTitlePathFromSourcePath(getTestCaseUri(testCase));
titlePath.addAll(createTitlePath(feature.getName()));

final TestResult result = new TestResult()
.setUuid(testCaseUuid)
.setTestCaseId(getTestCaseId(testCase))
.setHistoryId(getHistoryId(testCase))
.setFullName(fullName)
.setTitlePath(titlePath)
.setName(name)
.setLabels(labelBuilder.getScenarioLabels())
.setLinks(labelBuilder.getScenarioLinks());
Expand Down
2 changes: 2 additions & 0 deletions allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/AllureCucumber5JvmTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ void shouldSetName() {
assertThat(testResults)
.extracting(TestResult::getName)
.containsExactlyInAnyOrder("Add a to b");
assertThat(testResults.get(0).getTitlePath())
.containsExactly("src", "test", "resources", "features", "simple.feature", "Simple feature");
}

@AllureFeatures.PassedTests
Expand Down
6 changes: 6 additions & 0 deletions allure-cucumber6-jvm/src/main/java/io/qameta/allure/cucumber6jvm/AllureCucumber6Jvm.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@
import java.util.stream.Stream;

import static io.qameta.allure.util.ResultsUtils.createParameter;
import static io.qameta.allure.util.ResultsUtils.createTitlePath;
import static io.qameta.allure.util.ResultsUtils.createTitlePathFromSourcePath;
import static io.qameta.allure.util.ResultsUtils.getStatus;
import static io.qameta.allure.util.ResultsUtils.getStatusDetails;
import static io.qameta.allure.util.ResultsUtils.md5;
Expand Down Expand Up @@ -145,11 +147,15 @@ private void handleTestCaseStarted(final TestCaseStarted event) {

final String testCaseUuid = testCase.getId().toString();

final List<String> titlePath = createTitlePathFromSourcePath(getTestCaseUri(testCase));
titlePath.addAll(createTitlePath(feature.getName()));

final TestResult result = new TestResult()
.setUuid(testCaseUuid)
.setTestCaseId(getTestCaseId(testCase))
.setHistoryId(getHistoryId(testCase))
.setFullName(fullName)
.setTitlePath(titlePath)
.setName(name)
.setLabels(labelBuilder.getScenarioLabels())
.setLinks(labelBuilder.getScenarioLinks());
Expand Down
2 changes: 2 additions & 0 deletions allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/AllureCucumber6JvmTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ void shouldSetName() {
assertThat(testResults)
.extracting(TestResult::getName)
.containsExactlyInAnyOrder("Add a to b");
assertThat(testResults.get(0).getTitlePath())
.containsExactly("src", "test", "resources", "features", "simple.feature", "Simple feature");
}

@AllureFeatures.PassedTests
Expand Down
6 changes: 6 additions & 0 deletions allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/AllureCucumber7Jvm.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@
import java.util.stream.Stream;

import static io.qameta.allure.util.ResultsUtils.createParameter;
import static io.qameta.allure.util.ResultsUtils.createTitlePath;
import static io.qameta.allure.util.ResultsUtils.createTitlePathFromSourcePath;
import static io.qameta.allure.util.ResultsUtils.getStatus;
import static io.qameta.allure.util.ResultsUtils.getStatusDetails;
import static io.qameta.allure.util.ResultsUtils.md5;
Expand Down Expand Up @@ -146,11 +148,15 @@ private void handleTestCaseStarted(final TestCaseStarted event) {

final String testCaseUuid = testCase.getId().toString();

final List<String> titlePath = createTitlePathFromSourcePath(getTestCaseUri(testCase));
titlePath.addAll(createTitlePath(feature.getName()));

final TestResult result = new TestResult()
.setUuid(testCaseUuid)
.setTestCaseId(getTestCaseId(testCase))
.setHistoryId(getHistoryId(testCase))
.setFullName(fullName)
.setTitlePath(titlePath)
.setName(name)
.setLabels(labelBuilder.getScenarioLabels())
.setLinks(labelBuilder.getScenarioLinks());
Expand Down
2 changes: 2 additions & 0 deletions allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/AllureCucumber7JvmTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ void shouldSetName() {
assertThat(testResults)
.extracting(TestResult::getName)
.containsExactlyInAnyOrder("Add a to b");
assertThat(testResults.get(0).getTitlePath())
.containsExactly("src", "test", "resources", "features", "simple.feature", "Simple feature");
}

@AllureFeatures.PassedTests
Expand Down
110 changes: 110 additions & 0 deletions allure-java-commons/src/main/java/io/qameta/allure/util/ResultsUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import org.slf4j.LoggerFactory;

import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
Expand All @@ -40,16 +41,21 @@
import java.lang.reflect.Method;
import java.math.BigInteger;
import java.net.InetAddress;
import java.net.URI;
import java.net.UnknownHostException;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.Properties;
import java.util.Set;
import java.util.function.Consumer;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;

Expand Down Expand Up @@ -98,6 +104,7 @@ public final class ResultsUtils {
private static final Logger LOGGER = LoggerFactory.getLogger(ResultsUtils.class);
private static final String ALLURE_DESCRIPTIONS_FOLDER = "META-INF/allureDescriptions/";
private static final String MD_5 = "MD5";
private static final String DOT = ".";

private static String cachedHost;

Expand Down Expand Up @@ -142,6 +149,51 @@ public static Label createPackageLabel(final String packageName) {
return createLabel(PACKAGE_LABEL_NAME, packageName);
}

public static List<String> createTitlePath(final String... values) {
return createTitlePath(Arrays.asList(values));
}

public static List<String> createTitlePath(final Collection<String> values) {
if (Objects.isNull(values)) {
return new ArrayList<>();
}
return values.stream()
.filter(Objects::nonNull)
.map(String::trim)
.filter(value -> !value.isEmpty())
.collect(Collectors.toList());
}

public static List<String> createTitlePathFromPackageAndClass(final String packageName, final String className) {
final List<String> result = createTitlePathFromPackage(packageName);
getClassTitle(packageName, className).ifPresent(result::add);
return result;
}

public static List<String> createTitlePathFromQualifiedClassName(final String className) {
return getPackageName(className)
.map(packageName -> createTitlePathFromPackageAndClass(packageName, className))
.orElseGet(() -> createTitlePath(className));
}

public static List<String> createTitlePathFromJavaClass(final Class<?> clazz) {
if (Objects.isNull(clazz)) {
return createTitlePath();
}
final String packageName = Optional.ofNullable(clazz.getPackage())
.map(Package::getName)
.orElse("");
return createTitlePathFromPackageAndClass(packageName, clazz.getName());
}

public static List<String> createTitlePathFromPackage(final String packageName) {
return split(packageName, DOT);
}

public static List<String> createTitlePathFromSourcePath(final String sourcePath) {
return split(normalizeSourcePath(sourcePath), "/");
}

public static Label createEpicLabel(final String epic) {
return createLabel(EPIC_LABEL_NAME, epic);
}
Expand Down Expand Up @@ -474,6 +526,64 @@ private static Optional<String> formatLambdaName(final SerializedLambda lambda)
return Optional.of(simpleClassName(lambda.getImplClass()) + "::" + getLambdaMethodName(methodName));
}

private static Optional<String> getPackageName(final String className) {
if (Objects.isNull(className)) {
return Optional.empty();
}
final int index = className.lastIndexOf('.');
if (index < 0) {
return Optional.empty();
}
return Optional.of(className.substring(0, index));
}

private static Optional<String> getClassTitle(final String packageName, final String className) {
if (Objects.isNull(className) || className.isEmpty()) {
return Optional.empty();
}
final String prefix = packageName + DOT;
if (!packageName.isEmpty() && className.startsWith(prefix)) {
return Optional.of(className.substring(prefix.length()));
}
return Optional.of(className);
}

private static List<String> split(final String value, final String delimiter) {
if (Objects.isNull(value) || value.isEmpty()) {
return new ArrayList<>();
}
return Stream.of(value.split(Pattern.quote(delimiter)))
.map(String::trim)
.filter(item -> !item.isEmpty())
.collect(Collectors.toList());
}

private static String normalizeSourcePath(final String sourcePath) {
if (Objects.isNull(sourcePath)) {
return "";
}
try {
final URI uri = URI.create(sourcePath);
if (nonNull(uri.getScheme())) {
final URI normalized = uri.normalize();
if (!normalized.isOpaque()) {
final URI relative = new File("").toURI().relativize(normalized);
final String path = relative.getPath();
if (nonNull(path) && !path.isEmpty()) {
return path.replace('\\', '/');
}
}
final String schemeSpecificPart = normalized.getSchemeSpecificPart();
if (nonNull(schemeSpecificPart)) {
return schemeSpecificPart.replace('\\', '/');
}
}
} catch (IllegalArgumentException ignored) {
// Fall back to plain path normalization below.
}
return sourcePath.replace('\\', '/');
}

private static String getLambdaMethodName(final String methodName) {
if ("<init>".equals(methodName)) {
return "new";
Expand Down
17 changes: 17 additions & 0 deletions allure-java-commons/src/test/java/io/qameta/allure/FileSystemResultsWriterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.UUID;

import static io.qameta.allure.FileSystemResultsWriter.generateTestResultName;
Expand Down Expand Up @@ -56,6 +57,22 @@ void shouldWriteTestResult(@TempDir final Path folder) {
.isRegularFile();
}

@Test
void shouldWriteTitlePath(@TempDir final Path folder) throws IOException {
FileSystemResultsWriter writer = new FileSystemResultsWriter(folder);
final String uuid = UUID.randomUUID().toString();
final TestResult testResult = new TestResult()
.setUuid(uuid)
.setTitlePath(Arrays.asList("parent", "child"));

writer.write(testResult);

assertThat(Files.readString(folder.resolve(generateTestResultName(uuid))))
.contains("\"titlePath\"")
.contains("\"parent\"")
.contains("\"child\"");
}

@Test
void shouldPreserveOldResultsWhenCleanIsDisabled(@TempDir final Path folder) throws IOException {
Path existingFile = folder.resolve("existing-result.json");
Expand Down
21 changes: 21 additions & 0 deletions allure-java-commons/src/test/java/io/qameta/allure/ResultsUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@
import static io.qameta.allure.util.ResultsUtils.TMS_LINK_TYPE;
import static io.qameta.allure.util.ResultsUtils.createIssueLink;
import static io.qameta.allure.util.ResultsUtils.createLink;
import static io.qameta.allure.util.ResultsUtils.createTitlePath;
import static io.qameta.allure.util.ResultsUtils.createTitlePathFromQualifiedClassName;
import static io.qameta.allure.util.ResultsUtils.createTitlePathFromSourcePath;
import static io.qameta.allure.util.ResultsUtils.createTmsLink;
import static io.qameta.allure.util.ResultsUtils.getLinkTypePatternPropertyName;
import static org.assertj.core.api.Assertions.assertThat;
Expand All @@ -44,6 +47,24 @@
@ExtendWith(SystemPropertyExtension.class)
class ResultsUtilsTest {

@Test
void shouldCreateTitlePath() {
assertThat(createTitlePath(" parent ", null, " ", "child"))
.containsExactly("parent", "child");
}

@Test
void shouldCreateTitlePathFromQualifiedClassName() {
assertThat(createTitlePathFromQualifiedClassName("io.qameta.allure.samples.MyTest"))
.containsExactly("io", "qameta", "allure", "samples", "MyTest");
}

@Test
void shouldCreateTitlePathFromSourcePath() {
assertThat(createTitlePathFromSourcePath("features/nested/my.test.feature"))
.containsExactly("features", "nested", "my.test.feature");
}

@Test
void shouldCreateLink() {
io.qameta.allure.model.Link actual = createLink("a", "b", "c", "d");
Expand Down
Loading
Loading