Skip to content

feature/54-asciiDocReporter-tags #1945

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

Open
johthor wants to merge 18 commits into
base: master
Choose a base branch
from
Open

feature/54-asciiDocReporter-tags #1945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
2c1f8e9
Enclose scenarios with AsciiDoc tags
johthor Jan 15, 2024
dcc2273
Simplify test to ensure both snippets are compatible
johthor Jan 15, 2024
240daf5
Add mapping JGiven tags to AsciiDoc tags
johthor Jan 22, 2024
b48c593
Collect tagged feature files and scenario counts
johthor Jan 23, 2024
7659507
Write index files only for used tags
johthor Jan 23, 2024
eadeb46
Merge branch 'main' into feature/54-asciiDocReporter-tags
johthor Jan 23, 2024
2a3dfaf
Replace spaces in tag names
johthor Feb 5, 2024
af5badc
Group scenarios by tags
johthor Feb 5, 2024
f1a3f43
Restructure report generator
johthor Feb 11, 2024
a4825f4
Merge branch 'main' into feature/54-asciiDocReporter-tags
johthor May 10, 2025
e1d9b69
Take the number of failed/pending scenarios into account
johthor May 18, 2025
4a373d1
Fix intro for aborted scenarios and add them to report
johthor May 18, 2025
b85acdd
Fix section intros
johthor Jul 11, 2025
c95464c
Merge branch 'master' into feature/54-asciiDocReporter-tags
johthor Oct 5, 2025
833e2f1
Cleanup import statements
johthor Oct 5, 2025
1731e18
Fix some more grammar errors
johthor Oct 5, 2025
d5b8bef
Reformat
johthor Oct 5, 2025
1866f6a
Add testMethodName as another AsciiDoc tag around the scenario
johthor Oct 5, 2025
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
120 changes: 83 additions & 37 deletions ...iidoc-report/src/main/java/com/tngtech/jgiven/report/asciidoc/AsciiDocBlockConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import static java.util.stream.Stream.generate;

import com.google.common.collect.ListMultimap;
import com.google.common.collect.Lists;
import com.tngtech.jgiven.impl.util.WordUtil;
import com.tngtech.jgiven.report.ReportBlockConverter;
import com.tngtech.jgiven.report.model.CasesTable;
Expand All @@ -26,8 +27,9 @@ class AsciiDocBlockConverter implements ReportBlockConverter {
private static final Pattern MULTILINE_PATTERN = Pattern.compile("\\R");

@Override
public String convertStatisticsBlock(final ListMultimap<String, ReportStatistics> featureStatistics,
final ReportStatistics totalStatistics) {
public String convertStatisticsBlock(
final ListMultimap<String, ReportStatistics> featureStatistics,
final ReportStatistics totalStatistics) {
final StringBuilder statisticsTable = new StringBuilder();

statisticsTable.append(".Total Statistics").append(LINE_BREAK);
Expand All @@ -46,7 +48,9 @@ public String convertStatisticsBlock(final ListMultimap<String, ReportStatistics
statisticsTable.append("| total steps ");
statisticsTable.append("| duration").append(LINE_BREAK);

featureStatistics.entries().stream().sorted(Map.Entry.comparingByKey())
featureStatistics.entries().stream()
.sorted(Map.Entry.comparingByKey())
.filter(entry -> entry.getValue() != null)
.forEach(entry -> appendStatisticsRowFragment(statisticsTable, entry.getKey(), entry.getValue()));

appendStatisticsRowFragment(statisticsTable, "sum", totalStatistics);
Expand All @@ -56,8 +60,10 @@ public String convertStatisticsBlock(final ListMultimap<String, ReportStatistics
}

@Override
public String convertFeatureHeaderBlock(final String featureName, final ReportStatistics statistics,
final String description) {
public String convertFeatureHeaderBlock(
final String featureName,
final ReportStatistics statistics,
final String description) {
StringBuilder blockContent = new StringBuilder();

blockContent.append("=== ").append(featureName).append(LINE_BREAK);
Expand Down Expand Up @@ -85,12 +91,20 @@ public String convertFeatureHeaderBlock(final String featureName, final ReportSt
}

@Override
public String convertScenarioHeaderBlock(final String name, final ExecutionStatus executionStatus,
final long duration, final List<Tag> tags,
final String extendedDescription) {
public String convertScenarioHeaderBlock(
final String identifier,
final String name,
final ExecutionStatus executionStatus,
final long duration,
final List<Tag> tags,
final String extendedDescription) {
StringBuilder blockContent = new StringBuilder();

blockContent.append(MetadataMapper.toAsciiDocTagStart(executionStatus)).append(LINE_BREAK);
blockContent.append(MetadataMapper.toAsciiDocStartTag(identifier)).append(LINE_BREAK);
blockContent.append(MetadataMapper.toAsciiDocStartTag(executionStatus)).append(LINE_BREAK);

tags.forEach(tag -> blockContent.append(TagMapper.toAsciiDocStartTag(tag)).append(LINE_BREAK));

blockContent.append(LINE_BREAK);

blockContent.append("==== ").append(WordUtil.capitalize(name)).append(LINE_BREAK);
Expand All @@ -110,15 +124,18 @@ public String convertScenarioHeaderBlock(final String name, final ExecutionStatu
blockContent.append(LINE_BREAK);
blockContent.append(LINE_BREAK);
blockContent.append("Tags: ");
blockContent.append(tags.stream().map(tag -> "_" + TagMapper.mapTag(tag) + "_").collect(joining(", ")));
blockContent.append(tags.stream().map(tag -> "_" + TagMapper.toHumanReadableLabel(tag) + "_").collect(joining(", ")));
}

return blockContent.toString();
}

@Override
public String convertCaseHeaderBlock(final int caseNr, final ExecutionStatus executionStatus,
final long duration, final String description) {
public String convertCaseHeaderBlock(
final int caseNr,
final ExecutionStatus executionStatus,
final long duration,
final String description) {
StringBuilder blockContent = new StringBuilder();

blockContent.append("===== Case ").append(caseNr);
Expand All @@ -135,10 +152,14 @@ public String convertCaseHeaderBlock(final int caseNr, final ExecutionStatus exe
}

@Override
public String convertFirstStepBlock(final int depth, final List<Word> words, final StepStatus status,
final long durationInNanos,
final String extendedDescription, final boolean caseIsUnsuccessful,
final String currentSectionTitle) {
public String convertFirstStepBlock(
final int depth,
final List<Word> words,
final StepStatus status,
final long durationInNanos,
final String extendedDescription,
final boolean caseIsUnsuccessful,
final String currentSectionTitle) {

StringBuilder blockContent = new StringBuilder();

Expand All @@ -154,9 +175,13 @@ public String convertFirstStepBlock(final int depth, final List<Word> words, fin
}

@Override
public String convertStepBlock(final int depth, final List<Word> words, final StepStatus status,
final long durationInNanos,
final String extendedDescription, final boolean caseIsUnsuccessful) {
public String convertStepBlock(
final int depth,
final List<Word> words,
final StepStatus status,
final long durationInNanos,
final String extendedDescription,
final boolean caseIsUnsuccessful) {

StringBuilder blockContent = new StringBuilder();

Expand Down Expand Up @@ -200,8 +225,10 @@ public String convertCasesTableBlock(final CasesTable casesTable) {
return blockContent.toString();
}

private static void convertCaseRow(final StringBuilder blockContent, final int columnCount,
final CasesTable.CaseRow caseRow) {
private static void convertCaseRow(
final StringBuilder blockContent,
final int columnCount,
final CasesTable.CaseRow caseRow) {
Optional<String> errorMessage = caseRow.errorMessage();

blockContent.append(errorMessage.isPresent() ? ".2+| " : "| ").append(caseRow.rowNumber());
Expand Down Expand Up @@ -234,12 +261,21 @@ public String convertCaseFooterBlock(final String errorMessage, final List<Strin
}

@Override
public String convertScenarioFooterBlock(final ExecutionStatus executionStatus) {
return MetadataMapper.toAsciiDocTagEnd(executionStatus);
public String convertScenarioFooterBlock(final String identifier, final ExecutionStatus executionStatus, final List<Tag> tags) {

@hvennekate hvennekate May 8, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • reformat

@hvennekate hvennekate Jun 10, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#2211

StringBuilder blockContent = new StringBuilder();

Lists.reverse(tags).forEach(tag -> blockContent.append(TagMapper.toAsciiDocEndTag(tag)).append(LINE_BREAK));

blockContent.append(MetadataMapper.toAsciiDocEndTag(executionStatus)).append(LINE_BREAK);
blockContent.append(MetadataMapper.toAsciiDocEndTag(identifier));

return blockContent.toString();
}

private static boolean appendWordFragments(final StringBuilder blockContent, final List<Word> words,
final String statusFragment) {
private static boolean appendWordFragments(
final StringBuilder blockContent,
final List<Word> words,
final String statusFragment) {
boolean statusAppended = false;
boolean lastFragmentWasBlockFragment = false;
for (Word word : words) {
Expand Down Expand Up @@ -283,13 +319,16 @@ private static boolean argumentContainsLineBreaks(String argumentValue) {
return MULTILINE_PATTERN.matcher(argumentValue).find();
}

private static boolean appendFragment(final StringBuilder blockContent, final boolean lastFragmentWasBlockFragment,
final String statusFragment, final boolean statusAlreadyAppended,
final String fragment) {
private static boolean appendFragment(
final StringBuilder blockContent,
final boolean lastFragmentWasBlockFragment,
final String statusFragment,
final boolean statusAlreadyAppended,
final String fragment) {
final String lineContinuation = lastFragmentWasBlockFragment ? "" : " ";
if (fragment.contains(LINE_BREAK)) {
if (!statusAlreadyAppended && !statusFragment.isBlank()){
blockContent.append(" ").append(statusFragment);
if (!statusAlreadyAppended && !statusFragment.isBlank()) {
blockContent.append(" ").append(statusFragment);
}
blockContent.append(fragment);
return true;
Expand All @@ -300,7 +339,9 @@ private static boolean appendFragment(final StringBuilder blockContent, final bo
}

private static void appendErrorFragment(
final StringBuilder blockContent, final String errorMessage, final List<String> stackTraceLines) {
final StringBuilder blockContent,
final String errorMessage,
final List<String> stackTraceLines) {
blockContent.append("[.jg-exception]").append(LINE_BREAK);
blockContent.append("====").append(LINE_BREAK);
blockContent.append("[%hardbreaks]").append(LINE_BREAK);
Expand All @@ -322,8 +363,10 @@ private static void appendErrorFragment(
blockContent.append("====").append(LINE_BREAK);
}

private static void appendStatisticsRowFragment(final StringBuilder builder, final String name,
final ReportStatistics statistics) {
private static void appendStatisticsRowFragment(
final StringBuilder builder,
final String name,
final ReportStatistics statistics) {
builder.append("| ").append(name);
builder.append(" | ").append(statistics.numClasses);
builder.append(" | ").append(statistics.numSuccessfulScenarios);
Expand All @@ -338,8 +381,10 @@ private static void appendStatisticsRowFragment(final StringBuilder builder, fin
.append(LINE_BREAK);
}

private static String buildStepStatusFragment(final boolean caseIsUnsuccessful, final StepStatus status,
final long duration) {
private static String buildStepStatusFragment(
final boolean caseIsUnsuccessful,
final StepStatus status,
final long duration) {
final String humanReadableStatus = caseIsUnsuccessful ? MetadataMapper.toHumanReadableStatus(status) : "";
final String humanReadableStepDuration = MetadataMapper.toHumanReadableStepDuration(duration);

Expand Down Expand Up @@ -411,8 +456,9 @@ private static String buildOtherWordFragment(final String word, final boolean di
}
}

private static String buildExtendedDescriptionFragment(final boolean lastFragmentIsBlock,
final String extendedDescription) {
private static String buildExtendedDescriptionFragment(
final boolean lastFragmentIsBlock,
final String extendedDescription) {

String fragment = "";
if (extendedDescription != null && !extendedDescription.isEmpty()) {
Expand Down
Loading