is requirement in Junit has same approach as cucumber

[VeroBalta]

What happened?

I am currently use living documentation with cucumber by adding readme file under feature level but I am trying same approach with Junit and I don't have success question is this apply to work with Junit or only cucumber?

I am following this doc: https://serenity-bdd.github.io/docs/reporting/living_documentation#living-documentation-and-other-types-of-tests

@wakaleo is there any example doc for Junit.

Cucumber:

Junit:

What did you expect to happen?

expected to read living doc in requirement tab

Serenity BDD version

4.1.14

JDK version

jdk 17

Execution environment

No response

How to reproduce the bug.

n/a

How can we make it happen?

Work on this myself and propose a PR (with Serenity BDD team guidance)

[wakaleo]

This project gives an example of generating living documentation with requirements coverage using both JUnit 5 and Cucumber: https://github.com/serenity-dojo/wordle

[VeroBalta]

@wakaleo I have check out this project and having same structure but still not generating living documentation.

[wakaleo]

There might be some differences in the dependency versions. Also, are you using Gradle or Maven?

[VeroBalta]

Using Gradle

[VeroBalta]

@wakaleo in this project https://github.com/serenity-dojo/wordle the living documentation is not placed under requirement is placed under feature folder, in Junit test cases please check.

[wakaleo]

Requirements docs (readme files etc) must go under src/test/resources/features - they cannot be found if they are in src/test/java.

[VeroBalta]

@wakaleo right but this is for cucumber as I mentioned before it works with cucumber but looking to enable with Junit and this is what I see in the dojo project

[wakaleo]

That file isn't part of the living documentation, it's just there for training purposes.

On Fri, 6 Sept 2024 at 15:59, VeroBalta @.***> wrote:

@wakaleo https://github.com/wakaleo right but this is for cucumber as I mentioned before it works with cucumber but looking to enable with Junit and this is what I see in the dojo project

Screenshot.2024-09-06.at.10.49.41.AM.png (view on web) https://github.com/user-attachments/assets/cfcd8709-16ed-4cfd-af27-35f8e67acc44

— Reply to this email directly, view it on GitHub https://github.com/serenity-bdd/serenity-core/issues/3509#issuecomment-2334249507, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAANVMXYJB5T5YMEHMQZTVTZVG7NVAVCNFSM6AAAAABMLEYF2CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMZUGI2DSNJQG4 . You are receiving this because you were mentioned.Message ID: @.***>

--

John Ferguson Smart

Wakaleo Consulting

Mobile: +44739 883 2273

@.***

https://johnfergusonsmart.com/ http://www.serenity-dojo.com/

[image: Facebook icon] https://www.facebook.com/John-Ferguson-Smart-Serenity-Dojo-110131163912759/ [image: LinkedIn icon] https://uk.linkedin.com/in/john-ferguson-smart-7442907 [image: Twitter icon] https://twitter.com/wakaleo

[VeroBalta]

@wakaleo thanks for clarifying, is there any sample project of Junit5 where living documentation is actually working?

[wakaleo]

@wakaleo thanks for clarifying, is there any sample project of Junit5 where living documentation is actually working?

What do you expect it to do?

[VeroBalta]

enable living documentation with Junit similar to the cucumber feature as show in the screenshot attached

[wakaleo]

Java can't read a directory structure from a package structure so essentially it isn't possible to read the readme files from anywhere other than the src/test/resources/features directory.

[VeroBalta]

@wakaleo I understand in this case our test is Junit5 we have test cases instead of feature file. I created a file bellow resource and add readme file here, now I can see living documentation on report thanks for your help.