See https://github.com/diffplug/spotless/

Currently there's no explicit documentation for setting the timeout and interval on Retryables in the manual, but only in the JavaDoc.

The most common use cases and default setting should be documented in the manual.

According to dependabot/dependabot-core#2180 Dependabot does not support buildSrc dependencies (yet).

Hence, dependencies should not be defined there.

Increase visibility what happens, especially when things go wrong, e.g. via logging/text, but also via images/videos/files when Selenium is involved.

It seems sub reports are printed in random order, but should be chronologically.

Example:

09:18:21.444 [Test worker] INFO  Romeo - Romeo does Register[emailAddress=EmailAddress[[email protected]]] ✓ 16s
├── Romeo does EnterAddress[address=Address[firstName=Romeo, lastName=Montague, company=Montague Ltd., addressLine1=515 W Verona Ave, addressLine2=, city=Verona, state=Wisconsin, zipCode=53593, homePhone=(202) 762-1401, mobilePhone=, addressAlias=Home]] ✓ 1s69ms
├── Romeo does EnterPersonalInformation[personalInformation=PersonalInformation[title=MR, firstName=Romeo, lastName=Montague, password=jul13t, dateOfBirth=1999-02-14]] ✓ 2s973ms
├── Romeo does StartRegistration[emailAddress=EmailAddress[[email protected]]] ✓ 309ms
├── Romeo does NavigateToSignInPage[] ✓ 2s263ms
└── Romeo does SubmitRegisterForm[] ✓ 2s282ms

should actually be (according to execution order):

09:18:21.444 [Test worker] INFO  Romeo - Romeo does Register[emailAddress=EmailAddress[[email protected]]] ✓ 16s
├── Romeo does NavigateToSignInPage[] ✓ 2s263ms
├── Romeo does StartRegistration[emailAddress=EmailAddress[[email protected]]] ✓ 309ms
├── Romeo does EnterPersonalInformation[personalInformation=PersonalInformation[title=MR, firstName=Romeo, lastName=Montague, password=jul13t, dateOfBirth=1999-02-14]] ✓ 2s973ms
├── Romeo does EnterAddress[address=Address[firstName=Romeo, lastName=Montague, company=Montague Ltd., addressLine1=515 W Verona Ave, addressLine2=, city=Verona, state=Wisconsin, zipCode=53593, homePhone=(202) 762-1401, mobilePhone=, addressAlias=Home]] ✓ 1s69ms
└── Romeo does SubmitRegisterForm[] ✓ 2s282ms

Simplified the current order is:

root
├ D
├ C
├ B
├ A
└ E

Interestingly this order seems to be consistent: when the test is re-run it does not change.

Filenames can currently be indefinitely long (due to activity toString and actor names). This should be reduced to not exceed 255 charters in total.

In order to enforce more rules from CONTRIBUTING.md, a Checkstyle configuration could be added.

See https://sonarcloud.io/project/issues?id=mkutz_shakespeare&issues=AXvfyp6KWKgjMPzcnnWP&open=AXvfyp6KWKgjMPzcnnWP and https://sonarcloud.io/project/issues?id=mkutz_shakespeare&issues=AXvfyp8WWKgjMPzcnnWQ&open=AXvfyp8WWKgjMPzcnnWQ

The project should have some logo… Ideas and drafts are very welcome 😃

Setting up an Actor for a number of complex test cases can lead to a lot of duplicate code.

In order to reduce this, any Actor could have a set of default Abilities and/or Facts that are available or created on demand.

To reduce test runtime and dependencies on Mockito.

• Getting started
• Actors
• Abilities
• Tasks
• Questions
• Retryables
• Facts
• Module Selenium
• Module Retrofit

In order to speed up build time, tests should be run in parallel.

Many projects are not yet on JDK 17, so newest older long term Java, which is 11.

Build can still happen on JDK 17.

Since v0.5 the base URL is opened every time getWebDriver is called. Effectively resetting any previous navigation.

As getWebDriver is usually called at the beginning of any web-based Task or Question, this is a critical bug.

The base URL should only be navigated to, if no other navigation already happened. This is usually the case when the current URL is not equal to about:blank.

Affected: retrofit

Describe the bug
Currently the Oauth2Api does not allow to set a scope (e.g. openid).

We need a way to define a scope.

I think it would be nice to have a link to the "official home page" of the project in the repo description.

Manual and JavaDocs for previous releases should still be accessible via permanent URLs.

• current snapshot should be at https://www.shakespeareframework.org/main/manual/
• latest release should be at https://www.shakespeareframework.org/latest/manual/
• v0.2 should be at https://www.shakespeareframework.org/v0.2/manual/
• Automatically trigger workflow when a release is published

The support for the Groovy syntax in Idea is really bad compared to Kotlin.

As an alternative to Selenium, Shakespeare should proved a standard module to support Playwrite for browser automation.

Something like JUnit's CONTRIBUTING.md.

See also Setting guidelines for repository contributors.

In our team it would be preferred to limit the retries to a certain number.

Describe the solution you'd like

We would need two new variables in the Actor class. The variable maxRetries should be overridable.
Integer retryNumber = 0
Integer maxRetries = 0

Currently in the Actor.class the check looks like this:
if (question.acceptable(lastAnswer)) { reporters.forEach(reporter -> reporter.success(this, question, answer)); return answer; }
It would need to be replaced by a wrapper function:



if (question.acceptableWrapper(lastAnswer)) { reporters.forEach(reporter -> reporter.success(this, question, answer)); return answer; }

default boolean acceptableWrapper(A answer){ if(maxTries!=0 && retryNumber>maxRetries) return answer tryNumber++ acceptable(answer) }

We currently use our own code to do the same. This would be a cleaner approach and it adds a valuable feature to the framework.

Since #116 was merged, all OperaDriver is deprecated and should be removed.

Should fix Sonar code smells Remove this use of "OperaOptions"; it is deprecated and Remove this use of "OperaDriver"; it is deprecated.

Right now the building of the project page relies on classic GitHub pages settings. Since recently it is also possible to deploy explicitly via GitHub Actions.

See https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow

Create a new module to support usage of Shakespeare with Cucumber.

Currently a LogReport for a Task or Question will always write exactly one line.

Readability would be improved if there was a line wrap, e.g. for long answers.

Another application for this would be custom supplements. For example, FileReporters could add their written file paths to the current LogReport.

The code used in doesEventually and checksEventually uses a Thread.sleep which causes warnings in Idea. There might be another smarter way to implement this.

Is your feature request related to a problem? Please describe.
We need a structured report format for a service that will trigger Shakespeare-based automation scripts and return a report via an HTTP interface.

Describe the solution you'd like
We suggest to use JSON as base structure. The concrete format is an implementation detail, but should be stable.

Describe alternatives you've considered
XML or similar formats would also work, but is unnecessarily complicated to create.

The Slf4jReporter does not seem to clear its currentRootReport when it was logged. Due to that reports are being re-logged in later reports.

Example:

09:18:21.444 [Test worker] INFO  Romeo - Romeo does Register[emailAddress=EmailAddress[[email protected]]] ✓ 16s
├── Romeo does EnterAddress[address=Address[firstName=Romeo, lastName=Montague, company=Montague Ltd., addressLine1=515 W Verona Ave, addressLine2=, city=Verona, state=Wisconsin, zipCode=53593, homePhone=(202) 762-1401, mobilePhone=, addressAlias=Home]] ✓ 1s69ms
├── Romeo does EnterPersonalInformation[personalInformation=PersonalInformation[title=MR, firstName=Romeo, lastName=Montague, password=jul13t, dateOfBirth=1999-02-14]] ✓ 2s973ms
├── Romeo does StartRegistration[emailAddress=EmailAddress[[email protected]]] ✓ 309ms
├── Romeo does NavigateToSignInPage[] ✓ 2s263ms
└── Romeo does SubmitRegisterForm[] ✓ 2s282ms
09:18:21.507 [Test worker] INFO  Romeo - Romeo does Register[emailAddress=EmailAddress[[email protected]]] ✓ 16s → true
├── Romeo does SubmitRegisterForm[] ✓ 2s282ms
├── Romeo does EnterAddress[address=Address[firstName=Romeo, lastName=Montague, company=Montague Ltd., addressLine1=515 W Verona Ave, addressLine2=, city=Verona, state=Wisconsin, zipCode=53593, homePhone=(202) 762-1401, mobilePhone=, addressAlias=Home]] ✓ 1s69ms
├── Romeo does EnterPersonalInformation[personalInformation=PersonalInformation[title=MR, firstName=Romeo, lastName=Montague, password=jul13t, dateOfBirth=1999-02-14]] ✓ 2s973ms
├── Romeo does StartRegistration[emailAddress=EmailAddress[[email protected]]] ✓ 309ms
├── Romeo does NavigateToSignInPage[] ✓ 2s263ms
└── Romeo checks LoginStatus[] ✓ 56ms → true

should actually be

09:18:21.444 [Test worker] INFO  Romeo - Romeo does Register[emailAddress=EmailAddress[[email protected]]] ✓ 16s
├── Romeo does EnterAddress[address=Address[firstName=Romeo, lastName=Montague, company=Montague Ltd., addressLine1=515 W Verona Ave, addressLine2=, city=Verona, state=Wisconsin, zipCode=53593, homePhone=(202) 762-1401, mobilePhone=, addressAlias=Home]] ✓ 1s69ms
├── Romeo does EnterPersonalInformation[personalInformation=PersonalInformation[title=MR, firstName=Romeo, lastName=Montague, password=jul13t, dateOfBirth=1999-02-14]] ✓ 2s973ms
├── Romeo does StartRegistration[emailAddress=EmailAddress[[email protected]]] ✓ 309ms
├── Romeo does NavigateToSignInPage[] ✓ 2s263ms
└── Romeo does SubmitRegisterForm[] ✓ 2s282ms
09:18:21.507 [Test worker] INFO  Romeo - Romeo checks LoginStatus[] ✓ 56ms → true

Most of the time there will be one base URL that should always be called at the beginning of a test. That URL should be added as a parameter to BrowseTheWeb and be automatically called, e.g. within getWebDriver, so all tests can rely on that setting.

Hello again,

In order to unify a/sync code I am considering using something like:

https://github.com/electronicarts/ea-async
https://github.com/vipcxj/jasync

Basically methods would return promises.

Any thoughts on this?

Jose

Hi again,

What is your view on actions/interactions?

Serenity/JS interactions are named using the vocabulary of the solution domain, so: "Click on a button", "Enter password into a form field" or "Send a request", and are focused on doing one thing and one thing only.

If you're considering implementing an interaction that performs more than one logical activity (i.e. checks if the button is visible and then clicks on it if is), consider implementing separate interactions for separate responsibilities and composing them together using a task.

I usually don't reference Serenity Java core as it's huge and way to complex for my liking.

The Serenity JS core is much more compact and closer to Shakesphere.

I would like to provide out of the box actions/interactions

Actor.named('Ernest').whoCan(Log.the("Current page", Website.title(), Website.url()));
Actor.named('Ernest').whoCan(WriteToStream.of(process.stdout));

I would like to be able to create a busines level task which is composed of multiple interactions.

// Task    
Actor.named('Ernest').whoCan(Create.Order(order));

// Actions
 actor.attemptsTo(
   Send.a(PostRequest.to('/orders/, order)),
   Ensure.that(LastResponse.status(), equals(200)),
   ...
 );

Would you consider adding this? Im pretty sure I will add it but wanted to first get your opinion.

Add a FileReporter to capture HTML snapshots of the current page (similar to #109).

Setup a publishing workflow for Maven Central.

E.g. via Sonatype OSSRH.

Add a new module to allow the Actor to call HTTP APIs.

E.g. based on Retrofit for type-safe calls or directly on OkHttp for simpler calls.

When answering a Question, the Actor could remember the answer automatically.

To be considered:

Answers can be any type (incl. String, Integer etc.).
The current implementation of the Actor's memory allows only one instance of a type. Unintended overwrites of memories could happen easily.
Both would be mitigated if the Answer needs to be a Fact to be remembered.

The alternative would be changing the Actor's memory in which memories can be any type but need to be named (key/value store).

Affected

• core
• selenium
• retrofit
• testutils
• manual
• other/project

Describe the bug
When using DockerWebDriverSupplier, various exceptions are being thrown.

To reproduce
Run DockerWebDriverSupplierTest

DockerWebDriverSupplierTest > getTest1(BrowserType) > org.shakespeareframework.selenium.DockerWebDriverSupplierTest.getTest1(BrowserType)[3] FAILED
    io.github.bonigarcia.wdm.config.WebDriverManagerException at DockerWebDriverSupplierTest.java:22
        Caused by: io.github.bonigarcia.wdm.config.WebDriverManagerException at DockerWebDriverSupplierTest.java:22
            Caused by: org.openqa.selenium.SessionNotCreatedException at DockerWebDriverSupplierTest.java:22

Hi,

I am currently working some Gauge modules (will make public in a few days) to make testing easier. I shamelessly use your code but I made some adjustments including:

• adding Cast, Stage and Director
• changing Fact to Memory and allowing to remember a question
• Adding pronoun support to actor
• basic assertion support but I will probably remove it.

I like the light approach and would like to support you. The serenity lib is way to big and confusing.

If you don't mind I would like to have a small chat (possibly video) and find out what your plans are and check if there is some way I can support you if the directions are aligned.

What do you think?

Add a Reporter that records screenshots of current websites.