serenity-bdd / serenity-core

That feeling you get when you know you can trust your tests Serenity BDD is a library designed to make writing automated acceptance tests easier, and more fun. Learn more about Serenity, and discover tutorials, docs and more, on the official Serenity BDD website What does it do? Serenity helps structure your automated acceptance tests in order to make them easier to understand and maintain, and provides great reporting capabilties on top of tools like Cucumber and JUnit. It also provides tight integration with WebDriver and RestAssured, to make both web testing and API testing easier and more efficient. Serenity works in two ways: • It instruments your test code and reports on the steps that your tests execute to achieve their goals, and stores the test results in a standardized format; • It aggregates these test results into clear and meaningful reports, that reflect not only the outcomes of your tests, but also the status of your project. For example, you can get Serenity to report on what requirements, features or stories you have implemented, and how well (or not) they were tested. Serenity makes your test cleaner Serenity provides libraries and patterns that make it easier to write cleaner, more reusable code. It provides tight integration with Selenium WebDriver, and modern testing patterns such as Lean Page Objects, Action Classes, and the Screenplay Pattern. You can learn more about these patterns in this article. Serenity makes your reports richer Serenity reports aim to be more than simple test reports - they are designed to provide _living documentation_ of your product. The reports give an overview of the test results: But they also let you document your requirements hierarchy, and the state of the acceptance criteria associated with your requirements: When you use BDD tools like Cucumber or JBehave, Serenity will include the feature details in a format that both team members and business folk can read: And if you drill into the details, Serenity will give you a detailed account of how the test played out, including interactions and screenshots: Found a bug? You can raise a defect here. Note that this is an open source project, so **the fastest way to fix an issue is to fix it yourself and to propose a pull request**. Note that pretty much **all current development on the Serenity code base is driven by commercial support contracts**. As with any open source project, support is never free - it is just payed for from a volunteer's spare time, through a sponsoring organisation or via a commercial support package. Currently, we have very little bandwidth for issues which are not requested or prioritised by a client with a commercial support package, so if an issue is important to you, your project or your company, a commercial support package is the more effective and most ethical way of getting a fix or implementation done quickly. We also propose one-on-one troubleshooting sessions to help you get your problems resolved faster. Some companies and individuals who find that Serenity BDD helps in their daily work choose to give back by sponsoring the project in different capacities. Bug fixes or change requests coming from sponsors are generally prioritised over other requests. Here are a few tips to make it easier for us to help you: Give as much context as possible. Simply saying "The reports don't get generated" will not help us very much. Give as much context as possible, including: • Serenity version (serenity-core and the other serenity libraries, such as serenity-cucummber and serenity-jbehave) • If you are using Firefox, firefox and geckodriver version • If you are using Chrome, chrome and chromedriver version • What Operating System are you using Also, make sure you try with the latest version of Serenity - your bug may already be fixed, and in any case error messages from the latest version will be more relevant when we try to track down the source of the problem. Use living documentation It is easier for us to fix something we can see breaking. If someone has to volunteer an hour of there time to reproduce a defect, Start of with one of the Serenity started projects (like this one and add a scenario or test case that both illustrates and describes your issue. If possible, write the test to describe the behaviour you expect, so that it fails when the defect is present, and that it will pass when the defect is fixed. **You can help out by sponsoring Serenity BDD directly here: :heart: Sponsor** Take a look at this article for more information. Tidelift Subscription Serenity BDD is available as part of the Tidelift Subscription. Tidelift helps organizations use Serenity BDD with confidence by providing enterprise-grade security updates, maintenance assurances and compliance guidance. Learn more at: https://tidelift.com/subscription/pkg/maven-net.serenity-bdd Security contact information To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure. Need Commercial Support? If you are using Serenity for your company projects and need faster or more in-depth support, including training and coaching, why not ask your company to explore our **commercial support options**? We recognize that businesses have unique needs and require specialized attention. That's why we've designed a comprehensive range of support options tailored to your requirements. Whether it's prioritized tickets for pressing issues, custom Serenity work to integrate seamlessly with your existing systems, or remote mentoring and pair programming sessions to enhance your team's capabilities, we've got you covered. Our packages even include options for unlimited email support and additional live support hours at competitive rates. With monthly and annual payment plans, our support models aim to supercharge your Serenity experience, reducing downtime, accelerating development, and ensuring you get the most value o…