johthor/feature/54 asciiDocReporter tags by hvennekate · Pull Request #2211 · TNG/JGiven

hvennekate · 2026-05-08T16:36:51Z

Continuation of #1945

Enclose scenarios with AsciiDoc tags
Simplify test to ensure both snippets are compatible
Add mapping JGiven tags to AsciiDoc tags
Collect tagged feature files and scenario counts
Write index files only for used tags
Replace spaces in tag names
Group scenarios by tags
Restructure report generator
Take the number of failed/pending scenarios into account
Fix intro for aborted scenarios and add them to report
Fix section intros
Cleanup import statements
Fix some more grammar errors
Reformat
Add testMethodName as another AsciiDoc tag around the scenario
Convert AsciiDoc plugin tests to JUnit 5
Reformat code
Add Kate swap files and Eclipse CheckStyle files to .gitignore
Fix variable name

These will be used prepare a hierarchical tag overview. Issue: #54 Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Issue: #54 Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com> # Conflicts: # jgiven-core/src/main/java/com/tngtech/jgiven/report/asciidoc/AsciiDocReportGenerator.java

Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com> # Conflicts: # jgiven-asciidoc-report/src/main/java/com/tngtech/jgiven/report/asciidoc/AsciiDocReportGenerator.java # jgiven-asciidoc-report/src/main/java/com/tngtech/jgiven/report/asciidoc/HierarchyCalculator.java # jgiven-asciidoc-report/src/test/java/com/tngtech/jgiven/report/asciidoc/AsciiDocIntroSnippetGeneratorTest.java

Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Also reformat Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Also optimize some tag prefixes to improve the understanding. Issue: #54 Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

l-1squared · 2026-07-24T12:33:19Z

    implementation(libs.guava)
    implementation(libs.slf4j.api)
    implementation(project(":jgiven-core"))
+    testImplementation(platform(libs.junit6.bom))


remind me to place a bundle that if we merge before the injection error

Will add TODO

l-1squared · 2026-07-24T13:02:56Z

@@ -298,38 +295,38 @@ public void convert_step_with_multiline_argument_and_data_table() {
    ////


I guess this can go too

Why, though, actually? I had it removed earlier, but looking back at it before committing: Why not split into nested classes?

l-1squared · 2026-07-26T10:26:40Z

 */
 final class AsciiDocSnippetGenerator {
+    private static final String LINE_BREAK = System.lineSeparator();
+    private static final String LEVEL_OFFSET = ":leveloffset:";


that would be a leveloffset indicator, woudnt it?

Seems to be called an "attribute": https://asciidoc-py.github.io/userguide.html

LEVEL_OFFSET_ATTRIBUTE_NAME seems lengthy

? It's just LEVEL_OFFSET_ATTRIBUTE...

l-1squared · 2026-07-26T10:38:32Z

 // Report title is provided via report config.
 :toc: left
-:toclevels: 3
+:toclevels: 2


a style choice, I presume?

Presumably @johthor looked at a lot of reports and got tired of too many levels in TOC, I suppose.

In order to make it more evident what collections of `String` really are Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

… of ID Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

hvennekate · 2026-08-28T13:25:26Z

+    private GsonHolder() {
+    }
+
+    public static Gson get() {


Ideally, we could also do this using a LazyInitializer. I was not sure what the position of pulling additional dependencies was (here: Apache Commons).

Generally speaking, though, GSON should only be initialized once, I believe.

hvennekate · 2026-08-28T13:29:45Z

+import static com.google.gson.internal.GsonTypes.newParameterizedTypeWithOwner;
+
+public class GsonHolder {
+    private static final class ClassTypeAdapter extends TypeAdapter<Class<?>> {


This is the controversial part: GSON does not per default allow for (de-)serializing Java classes for security reasons.
It stands to reason that there is little potential for harm here as we are limiting it to annotations and this mechanism is mainly used for writing and reading reports (unless I missed some aspects).

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

…asciiDocReporter-tags

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

…asciiDocReporter-tags

johthor added 18 commits January 15, 2024 15:41

Enclose scenarios with AsciiDoc tags

2c1f8e9

These will be used prepare a hierarchical tag overview. Issue: #54 Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Simplify test to ensure both snippets are compatible

dcc2273

Issue: #54 Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Add mapping JGiven tags to AsciiDoc tags

240daf5

Issue: #54 Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Collect tagged feature files and scenario counts

b48c593

Issue: #54 Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Write index files only for used tags

7659507

Issue: #54 Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Merge branch 'main' into feature/54-asciiDocReporter-tags

eadeb46

Replace spaces in tag names

2a3dfaf

Issue: #54 Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Group scenarios by tags

af5badc

Issue: #54 Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Restructure report generator

f1a3f43

Issue: #54 Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Merge branch 'main' into feature/54-asciiDocReporter-tags

a4825f4

Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com> # Conflicts: # jgiven-core/src/main/java/com/tngtech/jgiven/report/asciidoc/AsciiDocReportGenerator.java

Take the number of failed/pending scenarios into account

e1d9b69

Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Fix intro for aborted scenarios and add them to report

4a373d1

Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Fix section intros

b85acdd

Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Cleanup import statements

833e2f1

Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Fix some more grammar errors

1731e18

Also reformat Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Reformat

d5b8bef

Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

Add testMethodName as another AsciiDoc tag around the scenario

1866f6a

Also optimize some tag prefixes to improve the understanding. Issue: #54 Signed-off-by: Johannes Thorn <2544827+johthor@users.noreply.github.com>

hvennekate mentioned this pull request Jun 12, 2026

feature/54-asciiDocReporter-tags #1945

Merged

Convert AsciiDoc plugin tests to JUnit 5

8bc6ecf

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

hvennekate force-pushed the johthor/feature/54-asciiDocReporter-tags branch from 5b343e2 to 3d56500 Compare June 12, 2026 15:38

hvennekate added 8 commits June 12, 2026 17:51

Reformat code

713d9e9

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Add Kate swap files and Eclipse CheckStyle files to .gitignore

ec7f9b2

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Fix variable name

155fb8c

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Simplify tag comparison

4b468e0

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Use just one static method for HierarchyCalculator + add test

65d8ec6

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Minor refactorings and formattings

076d286

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

More test cases for HierarchyCalculator

a24cbd8

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Use only utility method in HierarchyCalculator

78578e2

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

hvennekate force-pushed the johthor/feature/54-asciiDocReporter-tags branch from d9716ad to ab02137 Compare June 12, 2026 15:53

l-1squared reviewed Jul 24, 2026

View reviewed changes

l-1squared reviewed Jul 26, 2026

View reviewed changes

Introduce tag ID type + several minor fixes

3ae53c5

In order to make it more evident what collections of `String` really are Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

hvennekate force-pushed the johthor/feature/54-asciiDocReporter-tags branch from a39c29b to 3ae53c5 Compare August 14, 2026 13:22

hvennekate added 5 commits August 14, 2026 15:30

Split test into nested classes

61f98dd

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Revert comment change

a8f54bc

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Rename parameterized test inputs method

d660178

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Fix more places where TagId should be used + fix GSON serialization…

a59fcfe

… of ID Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Introduce wrapper type for FeatureName

68782d0

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

hvennekate force-pushed the johthor/feature/54-asciiDocReporter-tags branch from f80de01 to 49b54c3 Compare August 28, 2026 13:18

hvennekate commented Aug 28, 2026

View reviewed changes

Comment thread jgiven-core/src/main/java/com/tngtech/jgiven/report/model/Tag.java Outdated

hvennekate commented Aug 28, 2026

View reviewed changes

hvennekate force-pushed the johthor/feature/54-asciiDocReporter-tags branch from b7a4b9a to 68782d0 Compare August 28, 2026 15:13

hvennekate added 7 commits September 11, 2026 17:30

Also wrap tag class to increase type safety

df17316

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Fix unit test

a6435a9

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Minor fixes and improvements

eeaec36

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Fix erroneous "999" output

7343596

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Include file content in asciidoc reporter

0407fb1

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Add test for asciidoc reporter with two tags

ea80324

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Clean up report generation a little

50ab04e

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

hvennekate commented Sep 15, 2026

View reviewed changes

Comment thread jgiven-tests/src/test/java/com/tngtech/jgiven/report/asciidoc/AsciiDocReportGeneratorTest.java

hvennekate added 2 commits September 18, 2026 19:38

Merge remote-tracking branch 'origin/master' into johthor/feature/54-…

3a55227

…asciiDocReporter-tags

Update Android setup action

8c46cfe

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

l-1squared approved these changes Oct 5, 2026

View reviewed changes

l-1squared mentioned this pull request Oct 9, 2026

3.X release date? #2313

Open

hvennekate added 2 commits October 9, 2026 11:57

Review comments (clean up)

fb94dae

Signed-off-by: Hendrik Vennekate <Hendrik.Vennekate@tngtech.com>

Merge remote-tracking branch 'origin/master' into johthor/feature/54-…

de0844d

…asciiDocReporter-tags

l-1squared merged commit 914c210 into master Oct 9, 2026
55 checks passed

l-1squared deleted the johthor/feature/54-asciiDocReporter-tags branch October 9, 2026 13:04

		@@ -298,38 +295,38 @@ public void convert_step_with_multiline_argument_and_data_table() {
		////

Conversation

hvennekate commented May 8, 2026

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hvennekate Jul 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hvennekate Jul 24, 2026 •

edited

Loading