Skip to the content
Know your tech before you buy it. Makers: get listed from $49/mo

Serenity BDD

serenity-bdd.github.io

  • Free plan
  • Windows
  • macOS
  • Linux
  • Web
  • iPhone and iPad
  • Android
  • Self-hosted

What Serenity BDD is

Serenity BDD is an open source library for automated acceptance and regression testing. It generates illustrated narrative reports that can serve as living documentation, showing which requirements were tested and recording test steps with optional screenshots. Its documented testing approaches include Selenium for web tests, RestAssured for REST API tests, Screenplay, and executable specifications with Cucumber. Serenity Playwright supports Chromium, Firefox, and WebKit and can produce interactive HTML reports, screenshots, and HTML snapshots for debugging failures. Tests can use Page Object or Screenplay design; Screenplay organizes them around actors, tasks, questions, and targets. Playwright setup guidance lists Java 17 or higher and Maven 3.8+ or Gradle as prerequisites. CI/CD guidance covers GitHub Actions, Jenkins, and GitLab CI. BrowserStack and LambdaTest integrations are available for cloud testing, with a LambdaTest account required. Mobile testing guidance includes Playwright emulation for responsive designs. Serenity is free, and JUnit 4 support is deprecated and planned for removal in Serenity 6.0.0.

Who it suits

It suits teams writing automated acceptance or regression tests that want narrative reports and living documentation. It also fits projects using web, REST API, Cucumber, Screenplay, or Playwright testing approaches.

Good to know, and what to watch

  • Creates reports with requirements and step details.
  • Supports Selenium, RestAssured, Screenplay, and Cucumber.
  • Playwright supports Chromium, Firefox, and WebKit.
  • CI/CD guidance covers GitHub Actions, Jenkins, and GitLab CI.
  • Free and open source.
  • JUnit 4 support is deprecated.
  • JUnit 4 support is planned for removal in Serenity 6.0.0.
  • LambdaTest integration requires a LambdaTest account.

Serenity BDD

Free

Open source

Getting started

  1. Open the Serenity BDD website and documentation
  2. Install Java 17 or newer for Playwright work
  3. Set up Maven 3.8 or later or Gradle
  4. Choose JUnit 5 or Cucumber for the test framework
  5. Select Selenium, RestAssured, Playwright, or another documented approach
  6. Configure CI/CD with GitHub Actions, Jenkins, or GitLab CI
  7. Add a LambdaTest account when using LambdaTest cloud testing

Limits to check

Serenity BDD is free and open source. JUnit 4 support is deprecated and planned for removal in Serenity 6.0.0; LambdaTest cloud testing requires an account.

The Club's review

Overview

Serenity BDD is an open-source library for automated acceptance and regression testing, with reports designed to make test results useful as living documentation. It suits development and QA teams building tests into a local or CI workflow; its requirement-focused reporting is the clearest reason to choose it.

Rather than providing a standalone testing application, Serenity gives teams several ways to write tests and a record of what they exercised. The trade-off is that its setup and framework choices call for a software team comfortable with Java-based tooling.

Key features

Serenity’s documented testing approaches cover web tests with Selenium, REST APIs with RestAssured, executable specifications with Cucumber, and Screenplay testing. That breadth can keep different kinds of acceptance testing within one reporting workflow. Screenplay organizes tests around actors, tasks, questions, and targets; teams that prefer a page-oriented structure can use Page Objects with Serenity Playwright instead.

Reports connect test runs to requirements and record execution step by step, with optional screenshots. This makes failures and coverage easier to review than a bare pass-or-fail result, particularly when a team wants test output to document behavior as well as flag regressions. Serenity Playwright supports Chromium, Firefox, and WebKit, and adds interactive HTML reports, screenshots, and HTML snapshots for debugging failures.

The tooling fits existing development pipelines: its CI/CD guidance covers GitHub Actions, Jenkins, and GitLab CI. It also shows how to keep API keys, usernames, and passwords in GitHub Actions secrets and pass them into jobs as environment variables. BrowserStack integration uses a RemoteDriver, while the LambdaTest guide describes coverage across more than 3,000 real devices, browsers, and operating systems and requires a LambdaTest account.

Serenity supports local execution and parallel execution, browser testing, API access, and Gherkin. The Playwright setup prerequisites are Java 17 or higher and Maven 3.8+ or Gradle. Mobile emulation is described for responsive-design testing, and the manual includes a mobile-testing section; teams needing broader LambdaTest coverage should account for the required provider account.

JUnit 5 or Cucumber are the recommended choices in the Maven guide. JUnit 4 support is deprecated as of Serenity 5.0.0 and is planned for removal in 6.0.0, so teams with JUnit 4 suites should plan a migration rather than treat that integration as a durable foundation. Community routes include Gitter and Stack Overflow, alongside Serenity Dojo training and personalised coaching.

Pricing

Serenity BDD is free: its open-source library plan costs nothing. There are no paid tiers to weigh against the free option in this offering, making it a practical choice for teams able to adopt and maintain the library within their own testing workflow. The main cost to consider is the engineering work of setup and framework migration, especially for teams still relying on JUnit 4.

Platforms

Serenity BDD is listed for Android, iOS, Linux, macOS, self-hosted use, web, and Windows. The guides describe local execution, Java-based build prerequisites for Playwright, browser testing, and CI integrations, so platform support is most useful to teams integrating tests into development environments rather than looking for a packaged end-user app.

Who it's for

Choose Serenity if your team wants acceptance or regression tests to produce requirement-linked documentation, needs to combine browser, API, or Cucumber-based testing, and can work with Java build tooling. It is a weaker fit for teams seeking a standalone test-management interface or those unwilling to move away from JUnit 4 as that support approaches removal.

Pros and cons

  • Pro: Reports tie tests to requirements and preserve step-level detail. That gives teams a useful record of what ran, with screenshots when enabled.
  • Pro: Several testing styles fit within the same library. Selenium, RestAssured, Cucumber, and Screenplay address different acceptance-testing needs.
  • Pro: Playwright reports aid failure investigation. Interactive HTML reports, screenshots, and HTML snapshots accompany support for Chromium, Firefox, and WebKit.
  • Con: Playwright setup has specific build prerequisites. Teams need Java 17 or higher and Maven 3.8+ or Gradle.
  • Con: JUnit 4 is a declining path. Its deprecation and planned removal require affected teams to budget for a framework change.
  • Con: Expanded cloud testing depends on provider integrations. LambdaTest coverage requires an account with that service.

Alternatives

For a different BDD tool, compare BDD Testing Tools. Each alternative suits a different workflow:

  • CukeTest is worth considering if visual feature editing and JavaScript or Python matter; its free Lite plan has limited usage for some built-in automation libraries and 500 automation API calls.
  • Cucumber Open is a free open-source choice if you want Cucumber itself and free Cucumber Reports.
  • Ginkgo is a free Go testing framework, with v2 as its currently supported major version.
  • FitNesse is another free open-source option for teams seeking a tool with API, web, or self-hosted platform support.
  • Karate is a free MIT-licensed framework to consider if REST, GraphQL, or SOAP API testing, browser and desktop UI automation, or Gatling performance testing is the priority.
  • Reqnroll offers a free Community plan with Visual Studio and Rider integration, community plugins, and community support; consider it if those integrations are central to your work.
  • Concordion is a free Java library under Apache License 2.0.
  • BDDX may suit teams who want a web-based option with a free tier capped at 50 runs per month.

Verdict

Serenity BDD is a strong fit for development teams that want acceptance and regression tests to document requirements and execution, particularly when they need several testing styles and detailed reports in one workflow. Its free open-source model removes a license fee, but the choice is less compelling for teams that want a standalone app or need to retain JUnit 4 without a migration plan.

The verdict

Serenity BDD combines several test approaches with reports that document requirements and steps. Teams using JUnit 4 should account for its planned removal in Serenity 6.0.0.

Questions people ask

What does Serenity BDD test?

It supports web testing with Selenium, REST API testing with RestAssured, Screenplay testing, executable specifications with Cucumber, and Playwright browser testing.

Which browsers does Serenity Playwright support?

Serenity Playwright supports Chromium, Firefox, and WebKit.

Is Serenity BDD open source?

Yes. Serenity BDD is free and open source.

Which CI systems are covered?

The CI/CD guidance covers GitHub Actions, Jenkins, and GitLab CI.

Does it support cloud testing?

Yes. Serenity provides BrowserStack and LambdaTest integrations. LambdaTest requires a LambdaTest account.

What replaces JUnit 4?

The Maven guide recommends JUnit 5 or Cucumber. JUnit 4 support is deprecated and planned for removal in Serenity 6.0.0.

What the maker publishes

Build tools
The Playwright setup guide lists Java 17 or higher and Maven 3.8+ or Gradle as prerequisites. source
CI integrations
The CI/CD guide covers GitHub Actions, Jenkins, and GitLab CI. source
Cloud testing
Serenity provides a BrowserStack plugin and uses a RemoteDriver to connect tests to BrowserStack. source
Cloud testing scale
The LambdaTest integration guide says users can extend test coverage across more than 3,000 real devices, browsers, and operating systems, and requires a LambdaTest account. source
Mobile coverage
The Playwright guide describes mobile emulation for testing responsive designs, and the manual includes a Mobile Testing with Serenity section. source
Playwright
Serenity Playwright supports Chromium, Firefox, and WebKit and provides interactive HTML reports, screenshots, and HTML snapshots for debugging failures. source
Report detail
Serenity reports which requirements were tested and records step-by-step test details, with optional screenshots. source
Security configuration
The CI/CD guide demonstrates storing API keys, usernames, and passwords in GitHub Actions secrets and passing them to test jobs as environment variables. source
Support and community
The manual links to Gitter and Stack Overflow and offers links to Serenity Dojo training and personalised coaching. source
Test design
Serenity Playwright supports Page Object and Screenplay approaches, with Screenplay organizing tests around actors, tasks, questions, and targets. source
Test frameworks
The Maven guide recommends JUnit 5 or Cucumber, and says JUnit 4 support is deprecated as of Serenity 5.0.0 and will be removed in 6.0.0. source
Testing types
The manual describes web testing with Selenium, REST API testing with RestAssured, Screenplay testing, and executable specifications with Cucumber. source
What it does
Serenity BDD is an open source library for writing automated acceptance and regression tests and generating illustrated narrative reports as living documentation. source

Checked against the maker's pages on 2 Oct 2026.