Skip to content
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.

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

Segregate junit4 dependencies #2648

Conversation

nicerloop
Copy link
Contributor

@wakaleo
Copy link
Member

wakaleo commented Dec 21, 2021

Thanks, I will merge this in for the next release. Could you write up some documentation about how it works in a short readme file? (I will include it in the new docs).

@nicerloop
Copy link
Contributor Author

nicerloop commented Dec 22, 2021

see serenity-bdd/serenity-cucumber-starter#61

it shows how to use serenity-cucumber, cucumber-junit-platform-engine and junit-platform-suite together

@nicerloop
Copy link
Contributor Author

Obsoletes serenity-bdd/serenity-cucumber6#36

@wakaleo
Copy link
Member

wakaleo commented Dec 22, 2021

see serenity-bdd/serenity-cucumber-starter#61

it shows how to use serenity-cucumber, cucumber-junit-platform-engine and junit-platform-suite together

The sample code is good, but for people to be able to use it properly, it needs to be documented. We are putting together an updated version of the Serenity User Guide here: https://github.com/serenity-bdd/documentation. Could you have a look at https://github.com/serenity-bdd/documentation/tree/main/docs/guide and add a short readme file that explains how to use this feature?

@nicerloop
Copy link
Contributor Author

cucumber-junit uses junit4 and is a dependency of serenity-cucumber.

Should cucumber-junit-platform-engine be the default cucumber integration with serenity described in the documentation, with junit4/cucumber-junit made optional dependencies?

@wakaleo
Copy link
Member

wakaleo commented Dec 22, 2021

I would rather the JUnit 5 integration be the default, though the legacy JUnit 4 integration should continue to work.

@nicerloop
Copy link
Contributor Author

Hi, I looked at https://github.com/serenity-bdd/documentation, and skimmed over https://docusaurus.io/docs.

The thing that annoys me is that much of the contents will be duplicated between the different ways of using Serenity with/without Cucumber with JUnit 4/5 with/without screenplay, such as the pre-requisites, the test scenario, the page objects, generating the reports, etc.

I did not find how to externalize and include common parts of a document, or how to refer to specific sections of another document.

How should I proceed with documenting using serenity with cucumber with junit-platform?

@wakaleo
Copy link
Member

wakaleo commented Jan 4, 2022

That's a good point. The docusaurus site will be the target for all the updated docs, and I think the simplest approach is to have tutorials for different tool combinations and then more detailed reference sections which can apply to different approaches. So I would start with a tutorial on "how to write a Serenity BDD test suite with Cucumber and JUnit 5".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants