Junit sample - broken link in report and inability to add more narrative

[huima]

Problem:

Based on documentation and examples, it is unclear how in JUnit based scenario developers could add narrative documentation to be used in the reports.

After reading BDD in action and Serenity BDD documentation about the living documentation features, I had assumption and expectation that same features and functionalities would be available also when using just JUnit tests.

I tested this with current serenity-junit-starter, using Serenity BDD 3.6.12 and the template on Ubuntu Linux, openjdk 19.

I tried adding @Narrative annotation to the WhenSearchingForTerms test class.

I tried to add package-info.java to the starter.wikipedia package with @Narrative annotation.

Neither of those was processed into the content anywhere.

Additionally in the example case report while listing Automated Tests the link on Feature column item "When searching for terms" is to a non existent page.

Expectation:

Product documentation and or test cases would show and describe all the available features and capabilities that are available in different configurations.

Additional discussion:

I started to look at the source code of the product, but the codebase is huge and has layers of also old features - so it is not quite easy to understand how everything works.

I've tried to look around serenity-model, serenity-junit5 and serenity-core but it is hard to understand how things work together and where to actually start to read things. And build better understanding.

Any help and insight would be appreciated, and I could based on that contribute something to documentation and / or tests, so that other new people would not make the same mistakes.

I already also asked in the discussion group:

https://matrix.to/#/!QxFcPAtRfsRjFzyfCj:gitter.im/$mdgCqmcO4AGKTU79acZBtrEFclr3B0JR4tcj0tvhz5w?via=gitter.im&via=matrix.org

[wakaleo]

Thanks for proposing to help Huima. Features like the @Narrative annotation are related to the JUnit 4 Serenity integration - the JUnit 5 integration is a completely different implementation, and doesn't have those features yet (it's still evolving feature-wise). @cliviu might have some ideas on this too.

[globalworming]

it works good for me. admittedly, you don't have the whole markdown support and images etc, only text
see package.info https://github.com/globalworming/serenity-junit-screenplay-starter/blob/main/src/test/java/com/example/e2e/browser/package-info.java

and class https://github.com/globalworming/serenity-junit-screenplay-starter/blob/main/src/test/java/com/example/e2e/browser/ReportNavigatorIT.java#L19

and it's junit5

[huima]

Thanks @globalworming - I can try to see if that works on my machine, and then what are the differences.

In any case I would like to understand the information processing pipeline better and contribute to the documentation / information then more.