├── .github └── workflows │ ├── gradle.yml │ ├── living-documentation.yml │ └── maven.yml ├── .gitignore ├── LICENSE ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── pom.xml ├── serenity.properties └── src ├── main └── java │ └── starter │ └── README.md └── test ├── java └── starter │ ├── CucumberTestSuite.java │ ├── navigation │ ├── DuckDuckGoHomePage.java │ └── NavigateTo.java │ ├── search │ ├── LookForInformation.java │ ├── SearchArticle.java │ └── SearchForm.java │ └── stepdefinitions │ ├── ParameterDefinitions.java │ └── SearchStepDefinitions.java └── resources ├── features └── search │ └── search_by_keyword.feature ├── junit-platform.properties ├── logback-test.xml └── serenity.conf /.github/workflows/gradle.yml: -------------------------------------------------------------------------------- 1 | # This workflow will build a Java project with Maven 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven 3 | 4 | name: Gradle build 5 | 6 | on: 7 | push: 8 | branches: [ master ] 9 | pull_request: 10 | branches: [ master ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@v2 19 | - name: Set up JDK 17 20 | uses: actions/setup-java@v2 21 | with: 22 | java-version: '17' 23 | distribution: 'adopt' 24 | - name: Build with Gradle 25 | run: gradle clean test 26 | -------------------------------------------------------------------------------- /.github/workflows/living-documentation.yml: -------------------------------------------------------------------------------- 1 | name: Living Documentation 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | jobs: 10 | build: 11 | 12 | runs-on: ubuntu-latest 13 | 14 | steps: 15 | - uses: actions/checkout@v2 16 | - name: Set up JDK 17 17 | uses: actions/setup-java@v2 18 | with: 19 | java-version: '17' 20 | distribution: 'adopt' 21 | cache: maven 22 | 23 | - name: Cache the Maven packages to speed up build 24 | uses: actions/cache@v1 25 | with: 26 | path: ~/.m2 27 | key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} 28 | restore-keys: ${{ runner.os }}-m2 29 | 30 | - name: Build with Maven 31 | run: mvn -B verify --file pom.xml -Denvironment=with_screenshots 32 | 33 | - name: Deploy 34 | uses: JamesIves/github-pages-deploy-action@4.1.1 35 | with: 36 | branch: gh-pages # The branch the action should deploy to. 37 | folder: target/site/serenity # The folder the action should deploy. 38 | -------------------------------------------------------------------------------- /.github/workflows/maven.yml: -------------------------------------------------------------------------------- 1 | # This workflow will build a Java project with Maven 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven 3 | 4 | name: Maven Build 5 | 6 | on: 7 | push: 8 | branches: [ master ] 9 | pull_request: 10 | branches: [ master ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@v2 19 | - name: Set up JDK 17 20 | uses: actions/setup-java@v2 21 | with: 22 | java-version: '17' 23 | distribution: 'adopt' 24 | cache: maven 25 | - name: Build with Maven 26 | run: mvn -B verify --file pom.xml 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | build 3 | out 4 | .gradle 5 | pom.xml.tag 6 | pom.xml.releaseBackup 7 | pom.xml.versionsBackup 8 | pom.xml.next 9 | release.properties 10 | dependency-reduced-pom.xml 11 | buildNumber.properties 12 | .mvn/timing.properties 13 | .idea 14 | *.iml 15 | .DS_Store 16 | 17 | # Avoid ignoring Maven wrapper jar file (.jar files are usually ignored) 18 | !/.mvn/wrapper/maven-wrapper.jar 19 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Getting started with Serenity and Cucumber 2 | 3 | Serenity BDD is a library that makes it easier to write high quality automated acceptance tests, with powerful reporting and living documentation features. It has strong support for both web testing with Selenium, and API testing using RestAssured. 4 | 5 | Serenity strongly encourages good test automation design, and supports several design patterns, including classic Page Objects, the newer Lean Page Objects/ Action Classes approach, and the more sophisticated and flexible Screenplay pattern. 6 | 7 | The latest version of Serenity supports Cucumber 6.x. 8 | 9 | ## The starter project 10 | The best place to start with Serenity and Cucumber is to clone or download the starter project on Github ([https://github.com/serenity-bdd/serenity-cucumber-starter](https://github.com/serenity-bdd/serenity-cucumber-starter)). This project gives you a basic project setup, along with some sample tests and supporting classes. There are two versions to choose from. The master branch uses a more classic approach, using action classes and lightweight page objects, whereas the **[screenplay](https://github.com/serenity-bdd/serenity-cucumber-starter/tree/screenplay)** branch shows the same sample test implemented using Screenplay. 11 | 12 | ### The project directory structure 13 | The project has build scripts for both Maven and Gradle, and follows the standard directory structure used in most Serenity projects: 14 | ```Gherkin 15 | src 16 | + main 17 | + test 18 | + java Test runners and supporting code 19 | + resources 20 | + features Feature files 21 | 
 + search Feature file subdirectories
 22 | search_by_keyword.feature 23 | ``` 24 | 25 | Serenity 2.2.13 introduced integration with WebdriverManager to download webdriver binaries. 26 | 27 | ## The sample scenario 28 | Both variations of the sample project uses the sample Cucumber scenario. In this scenario, Sergey (who likes to search for stuff) is performing a search on the internet: 29 | 30 | ```Gherkin 31 | Feature: Search by keyword 32 | 33 | Scenario: Searching for a term 34 | Given Sergey is researching things on the internet 35 | When he looks up "Cucumber" 36 | Then he should see information about "Cucumber" 37 | ``` 38 | 39 | ### The Screenplay implementation 40 | The sample code in the master branch uses the Screenplay pattern. The Screenplay pattern describes tests in terms of actors and the tasks they perform. Tasks are represented as objects performed by an actor, rather than methods. This makes them more flexible and composable, at the cost of being a bit more wordy. Here is an example: 41 | ```java 42 | @Given("{actor} is researching things on the internet") 43 | public void researchingThings(Actor actor) { 44 | actor.wasAbleTo(NavigateTo.theWikipediaHomePage()); 45 | } 46 | 47 | @When("{actor} looks up {string}") 48 | public void searchesFor(Actor actor, String term) { 49 | actor.attemptsTo( 50 | LookForInformation.about(term) 51 | ); 52 | } 53 | 54 | @Then("{actor} should see information about {string}") 55 | public void should_see_information_about(Actor actor, String term) { 56 | actor.attemptsTo( 57 | Ensure.that(WikipediaArticle.HEADING).hasText(term) 58 | ); 59 | } 60 | ``` 61 | 62 | Screenplay classes emphasise reusable components and a very readable declarative style, whereas Lean Page Objects and Action Classes (that you can see further down) opt for a more imperative style. 63 | 64 | The `NavigateTo` class is responsible for opening the Wikipedia home page: 65 | ```java 66 | public class NavigateTo { 67 | public static Performable theWikipediaHomePage() { 68 | return Task.where("{0} opens the Wikipedia home page", 69 | Open.browserOn().the(WikipediaHomePage.class)); 70 | } 71 | } 72 | ``` 73 | 74 | The `LookForInformation` class does the actual search: 75 | ```java 76 | public class LookForInformation { 77 | public static Performable about(String searchTerm) { 78 | return Task.where("{0} searches for '" + searchTerm + "'", 79 | Enter.theValue(searchTerm) 80 | .into(SearchForm.SEARCH_FIELD) 81 | .thenHit(Keys.ENTER) 82 | ); 83 | } 84 | } 85 | ``` 86 | 87 | In Screenplay, we keep track of locators in light weight page or component objects, like this one: 88 | ```java 89 | class SearchForm { 90 | static Target SEARCH_FIELD = Target.the("search field") 91 | .locatedBy("#searchInput"); 92 | 93 | } 94 | ``` 95 | 96 | The Screenplay DSL is rich and flexible, and well suited to teams working on large test automation projects with many team members, and who are reasonably comfortable with Java and design patterns. 97 | 98 | ### The Action Classes implementation. 99 | 100 | A more imperative-style implementation using the Action Classes pattern can be found in the `action-classes` branch. The glue code in this version looks this this: 101 | 102 | ```java 103 | @Given("^(?:.*) is researching things on the internet") 104 | public void i_am_on_the_Wikipedia_home_page() { 105 | navigateTo.theHomePage(); 106 | } 107 | 108 | @When("she/he looks up {string}") 109 | public void i_search_for(String term) { 110 | searchFor.term(term); 111 | } 112 | 113 | @Then("she/he should see information about {string}") 114 | public void all_the_result_titles_should_contain_the_word(String term) { 115 | assertThat(searchResult.displayed()).contains(term); 116 | } 117 | ``` 118 | 119 | These classes are declared using the Serenity `@Steps` annotation, shown below: 120 | ```java 121 | @Steps 122 | NavigateTo navigateTo; 123 | 124 | @Steps 125 | SearchFor searchFor; 126 | 127 | @Steps 128 | SearchResult searchResult; 129 | ``` 130 | 131 | The `@Steps`annotation tells Serenity to create a new instance of the class, and inject any other steps or page objects that this instance might need. 132 | 133 | Each action class models a particular facet of user behaviour: navigating to a particular page, performing a search, or retrieving the results of a search. These classes are designed to be small and self-contained, which makes them more stable and easier to maintain. 134 | 135 | The `NavigateTo` class is an example of a very simple action class. In a larger application, it might have some other methods related to high level navigation, but in our sample project, it just needs to open the DuckDuckGo home page: 136 | ```java 137 | public class NavigateTo { 138 | 139 | WikipediaHomePage homePage; 140 | 141 | @Step("Open the Wikipedia home page") 142 | public void theHomePage() { 143 | homePage.open(); 144 | } 145 | } 146 | ``` 147 | 148 | It does this using a standard Serenity Page Object. Page Objects are often very minimal, storing just the URL of the page itself: 149 | ```java 150 | @DefaultUrl("https://wikipedia.org") 151 | public class WikipediaHomePage extends PageObject {} 152 | ``` 153 | 154 | The second class, `SearchFor`, is an interaction class. It needs to interact with the web page, and to enable this, we make the class extend the Serenity `UIInteractionSteps`. This gives the class full access to the powerful Serenity WebDriver API, including the `$()` method used below, which locates a web element using a `By` locator or an XPath or CSS expression: 155 | ```java 156 | public class SearchFor extends UIInteractionSteps { 157 | 158 | @Step("Search for term {0}") 159 | public void term(String term) { 160 | $(SearchForm.SEARCH_FIELD).clear(); 161 | $(SearchForm.SEARCH_FIELD).sendKeys(term, Keys.ENTER); 162 | } 163 | } 164 | ``` 165 | 166 | The `SearchForm` class is typical of a light-weight Page Object: it is responsible uniquely for locating elements on the page, and it does this by defining locators or occasionally by resolving web elements dynamically. 167 | ```java 168 | class SearchForm { 169 | static By SEARCH_FIELD = By.cssSelector("#searchInput"); 170 | } 171 | ``` 172 | 173 | The last step library class used in the step definition code is the `SearchResult` class. The job of this class is to query the web page, and retrieve a list of search results that we can use in the AssertJ assertion at the end of the test. This class also extends `UIInteractionSteps` and 174 | ```java 175 | public class SearchResult extends UIInteractionSteps { 176 | public String displayed() { 177 | return find(WikipediaArticle.HEADING).getText(); 178 | } 179 | } 180 | ``` 181 | 182 | The `WikipediaArticle` class is a lean Page Object that locates the article titles on the results page: 183 | ```java 184 | public class WikipediaArticle { 185 | public static final By HEADING = By.id("firstHeading"); 186 | } 187 | ``` 188 | 189 | The main advantage of the approach used in this example is not in the lines of code written, although Serenity does reduce a lot of the boilerplate code that you would normally need to write in a web test. The real advantage is in the use of many small, stable classes, each of which focuses on a single job. This application of the _Single Responsibility Principle_ goes a long way to making the test code more stable, easier to understand, and easier to maintain. 190 | 191 | ## Executing the tests 192 | To run the sample project, you can either just run the `CucumberTestSuite` test runner class, or run either `mvn verify` or `gradle test` from the command line. 193 | 194 | By default, the tests will run using Chrome. You can run them in Firefox by overriding the `driver` system property, e.g. 195 | ```json 196 | $ mvn clean verify -Ddriver=firefox 197 | ``` 198 | Or 199 | ```json 200 | $ gradle clean test -Pdriver=firefox 201 | ``` 202 | 203 | The test results will be recorded in the `target/site/serenity` directory. 204 | 205 | ## Generating the reports 206 | Since the Serenity reports contain aggregate information about all of the tests, they are not generated after each individual test (as this would be extremenly inefficient). Rather, The Full Serenity reports are generated by the `serenity-maven-plugin`. You can trigger this by running `mvn serenity:aggregate` from the command line or from your IDE. 207 | 208 | They reports are also integrated into the Maven build process: the following code in the `pom.xml` file causes the reports to be generated automatically once all the tests have completed when you run `mvn verify`? 209 | 210 | ``` 211 | 212 | net.serenity-bdd.maven.plugins 213 | serenity-maven-plugin 214 | ${serenity.maven.version} 215 | 216 | ${tags} 217 | 218 | 219 | 220 | serenity-reports 221 | post-integration-test 222 | 223 | aggregate 224 | 225 | 226 | 227 | 228 | ``` 229 | 230 | ## Simplified WebDriver configuration and other Serenity extras 231 | The sample projects both use some Serenity features which make configuring the tests easier. In particular, Serenity uses the `serenity.conf` file in the `src/test/resources` directory to configure test execution options. 232 | ### Webdriver configuration 233 | The WebDriver configuration is managed entirely from this file, as illustrated below: 234 | ```java 235 | webdriver { 236 | driver = chrome 237 | } 238 | headless.mode = true 239 | 240 | chrome.switches="""--start-maximized;--test-type;--no-sandbox;--ignore-certificate-errors; 241 | --disable-popup-blocking;--disable-default-apps;--disable-extensions-file-access-check; 242 | --incognito;--disable-infobars,--disable-gpu""" 243 | 244 | ``` 245 | 246 | Serenity uses WebDriverManager to download the WebDriver binaries automatically before the tests are executed. 247 | 248 | ### Environment-specific configurations 249 | We can also configure environment-specific properties and options, so that the tests can be run in different environments. Here, we configure three environments, __dev__, _staging_ and _prod_, with different starting URLs for each: 250 | ```json 251 | environments { 252 | default { 253 | webdriver.base.url = "https://duckduckgo.com" 254 | } 255 | dev { 256 | webdriver.base.url = "https://duckduckgo.com/dev" 257 | } 258 | staging { 259 | webdriver.base.url = "https://duckduckgo.com/staging" 260 | } 261 | prod { 262 | webdriver.base.url = "https://duckduckgo.com/prod" 263 | } 264 | } 265 | ``` 266 | 267 | You use the `environment` system property to determine which environment to run against. For example to run the tests in the staging environment, you could run: 268 | ```json 269 | $ mvn clean verify -Denvironment=staging 270 | ``` 271 | 272 | See [**this article**](https://johnfergusonsmart.com/environment-specific-configuration-in-serenity-bdd/) for more details about this feature. 273 | 274 | ## Want to learn more? 275 | For more information about Serenity BDD, you can read the [**Serenity BDD Book**](https://serenity-bdd.github.io/theserenitybook/latest/index.html), the official online Serenity documentation source. Other sources include: 276 | * **[Learn Serenity BDD Online](https://expansion.serenity-dojo.com/)** with online courses from the Serenity Dojo Training Library 277 | * **[Byte-sized Serenity BDD](https://www.youtube.com/channel/UCav6-dPEUiLbnu-rgpy7_bw/featured)** - tips and tricks about Serenity BDD 278 | * For regular posts on agile test automation best practices, join the **[Agile Test Automation Secrets](https://www.linkedin.com/groups/8961597/)** groups on [LinkedIn](https://www.linkedin.com/groups/8961597/) and [Facebook](https://www.facebook.com/groups/agiletestautomation/) 279 | * [**Serenity BDD Blog**](https://johnfergusonsmart.com/category/serenity-bdd/) - regular articles about Serenity BDD 280 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | defaultTasks 'clean', 'test', 'aggregate' 2 | 3 | repositories { 4 | mavenCentral() 5 | mavenLocal() 6 | } 7 | 8 | buildscript { 9 | repositories { 10 | maven { 11 | url "https://plugins.gradle.org/m2/" 12 | } 13 | } 14 | dependencies { 15 | classpath "net.serenity-bdd:serenity-gradle-plugin:4.2.22" 16 | classpath "net.serenity-bdd:serenity-single-page-report:4.2.22" 17 | } 18 | } 19 | 20 | 21 | apply plugin: 'java' 22 | apply plugin: 'eclipse' 23 | apply plugin: 'idea' 24 | apply plugin: "net.serenity-bdd.serenity-gradle-plugin" 25 | 26 | sourceCompatibility = 16 27 | targetCompatibility = 16 28 | 29 | ext { 30 | serenity_version = '4.2.22' 31 | junit_platform_launcher_version="1.11.4" 32 | cucumber_junit_platform_engine_version="7.20.1" 33 | junit_platform_suite_version="1.11.4" 34 | junit_jupiter_engine_version="5.11.4" 35 | junit_vintage_engine_version="5.11.4" 36 | logback_classic_version="1.2.10" 37 | assertj_core_version="3.23.1" 38 | } 39 | 40 | dependencies { 41 | dependencies { 42 | testImplementation "net.serenity-bdd:serenity-core:${serenity_version}" 43 | testImplementation "net.serenity-bdd:serenity-cucumber:${serenity_version}" 44 | testImplementation "net.serenity-bdd:serenity-screenplay:${serenity_version}" 45 | testImplementation "net.serenity-bdd:serenity-screenplay-webdriver:${serenity_version}" 46 | testImplementation "net.serenity-bdd:serenity-ensure:${serenity_version}" 47 | testImplementation "org.junit.platform:junit-platform-launcher:${junit_platform_launcher_version}" 48 | testImplementation "io.cucumber:cucumber-junit-platform-engine:${cucumber_junit_platform_engine_version}" 49 | testImplementation "org.junit.platform:junit-platform-suite:${junit_platform_suite_version}" 50 | testImplementation "org.junit.jupiter:junit-jupiter-engine:${junit_jupiter_engine_version}" 51 | testImplementation "org.junit.vintage:junit-vintage-engine:${junit_vintage_engine_version}" 52 | implementation "ch.qos.logback:logback-classic:${logback_classic_version}" 53 | testImplementation "org.assertj:assertj-core:${assertj_core_version}" 54 | } 55 | } 56 | 57 | test { 58 | useJUnitPlatform() 59 | } 60 | 61 | serenity { 62 | reports = ["single-page-html"] 63 | } 64 | gradle.startParameter.continueOnFailure = true 65 | 66 | test.finalizedBy(aggregate, reports) 67 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serenity-bdd/serenity-cucumber-starter/18e6123f059f747e3b84b1e4921dbce759af8499/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.1-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 84 | 85 | APP_NAME="Gradle" 86 | APP_BASE_NAME=${0##*/} 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | MAX_FD=$( ulimit -H -n ) || 147 | warn "Could not query maximum file descriptor limit" 148 | esac 149 | case $MAX_FD in #( 150 | '' | soft) :;; #( 151 | *) 152 | ulimit -n "$MAX_FD" || 153 | warn "Could not set maximum file descriptor limit to $MAX_FD" 154 | esac 155 | fi 156 | 157 | # Collect all arguments for the java command, stacking in reverse order: 158 | # * args from the command line 159 | # * the main class name 160 | # * -classpath 161 | # * -D...appname settings 162 | # * --module-path (only if needed) 163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 164 | 165 | # For Cygwin or MSYS, switch paths to Windows format before running java 166 | if "$cygwin" || "$msys" ; then 167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 169 | 170 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 171 | 172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 173 | for arg do 174 | if 175 | case $arg in #( 176 | -*) false ;; # don't mess with options #( 177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 178 | [ -e "$t" ] ;; #( 179 | *) false ;; 180 | esac 181 | then 182 | arg=$( cygpath --path --ignore --mixed "$arg" ) 183 | fi 184 | # Roll the args list around exactly as many times as the number of 185 | # args, so each arg winds up back in the position where it started, but 186 | # possibly modified. 187 | # 188 | # NB: a `for` loop captures its iteration list before it begins, so 189 | # changing the positional parameters here affects neither the number of 190 | # iterations, nor the values presented in `arg`. 191 | shift # remove old arg 192 | set -- "$@" "$arg" # push replacement arg 193 | done 194 | fi 195 | 196 | # Collect all arguments for the java command; 197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 198 | # shell script including quotes and variable substitutions, so put them in 199 | # double quotes to make sure that they get re-expanded; and 200 | # * put everything else in single quotes, so that it's not re-expanded. 201 | 202 | set -- \ 203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 204 | -classpath "$CLASSPATH" \ 205 | org.gradle.wrapper.GradleWrapperMain \ 206 | "$@" 207 | 208 | # Stop when "xargs" is not available. 209 | if ! command -v xargs >/dev/null 2>&1 210 | then 211 | die "xargs is not available" 212 | fi 213 | 214 | # Use "xargs" to parse quoted args. 215 | # 216 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 217 | # 218 | # In Bash we could simply go: 219 | # 220 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 221 | # set -- "${ARGS[@]}" "$@" 222 | # 223 | # but POSIX shell has neither arrays nor command substitution, so instead we 224 | # post-process each arg (as a line of input to sed) to backslash-escape any 225 | # character that might be a shell metacharacter, then use eval to reverse 226 | # that process (while maintaining the separation between arguments), and wrap 227 | # the whole thing up as a single "set" statement. 228 | # 229 | # This will of course break if any of these variables contains a newline or 230 | # an unmatched quote. 231 | # 232 | 233 | eval "set -- $( 234 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 235 | xargs -n1 | 236 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 237 | tr '\n' ' ' 238 | )" '"$@"' 239 | 240 | exec "$JAVACMD" "$@" 241 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if %ERRORLEVEL% equ 0 goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if %ERRORLEVEL% equ 0 goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | set EXIT_CODE=%ERRORLEVEL% 84 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 85 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 86 | exit /b %EXIT_CODE% 87 | 88 | :mainEnd 89 | if "%OS%"=="Windows_NT" endlocal 90 | 91 | :omega 92 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | net.serenitybdd.starter 6 | cucumber-starter 7 | 1.0.0-SNAPSHOT 8 | jar 9 | 10 | Sample Serenity BDD project using Cucumber 11 | 12 | 13 | UTF-8 14 | 4.2.22 15 | 5.11.4 16 | 1.11.4 17 | 7.20.1 18 | UTF-8 19 | 20 | 21 | 22 | 23 | 24 | net.serenity-bdd 25 | serenity-core 26 | ${serenity.version} 27 | test 28 | 29 | 30 | net.serenity-bdd 31 | serenity-cucumber 32 | ${serenity.version} 33 | test 34 | 35 | 36 | net.serenity-bdd 37 | serenity-screenplay 38 | ${serenity.version} 39 | test 40 | 41 | 42 | net.serenity-bdd 43 | serenity-screenplay-webdriver 44 | ${serenity.version} 45 | test 46 | 47 | 48 | net.serenity-bdd 49 | serenity-ensure 50 | ${serenity.version} 51 | test 52 | 53 | 54 | org.junit.platform 55 | junit-platform-launcher 56 | ${junit-platform-suite.version} 57 | test 58 | 59 | 60 | io.cucumber 61 | cucumber-junit-platform-engine 62 | ${cucumber-junit-platform-engine.version} 63 | test 64 | 65 | 66 | org.junit.platform 67 | junit-platform-suite 68 | ${junit-platform-suite.version} 69 | test 70 | 71 | 72 | org.junit.jupiter 73 | junit-jupiter-engine 74 | ${junit-vintage-engine.version} 75 | test 76 | 77 | 78 | org.junit.vintage 79 | junit-vintage-engine 80 | ${junit-vintage-engine.version} 81 | test 82 | 83 | 84 | ch.qos.logback 85 | logback-classic 86 | 1.2.10 87 | 88 | 89 | org.assertj 90 | assertj-core 91 | 3.23.1 92 | test 93 | 94 | 95 | 96 | 97 | 98 | org.apache.maven.plugins 99 | maven-surefire-plugin 100 | 3.1.2 101 | 102 | true 103 | 104 | 105 | 106 | maven-failsafe-plugin 107 | 3.1.2 108 | 109 | 110 | **/*Test.java 111 | **/Test*.java 112 | **/*TestSuite.java 113 | **/When*.java 114 | 115 | 116 | ${webdriver.base.url} 117 | 118 | classes 119 | methods 120 | true 121 | 122 | 123 | 124 | 125 | integration-test 126 | verify 127 | 128 | 129 | 130 | 131 | 132 | org.apache.maven.plugins 133 | maven-compiler-plugin 134 | 3.8.1 135 | 136 | 1.8 137 | 1.8 138 | 139 | 140 | 141 | net.serenity-bdd.maven.plugins 142 | serenity-maven-plugin 143 | ${serenity.version} 144 | 145 | ${tags} 146 | single-page-html 147 | 148 | 149 | 150 | 151 | net.serenity-bdd 152 | serenity-single-page-report 153 | ${serenity.version} 154 | 155 | 156 | 157 | 158 | serenity-reports 159 | post-integration-test 160 | 161 | aggregate 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | -------------------------------------------------------------------------------- /serenity.properties: -------------------------------------------------------------------------------- 1 | serenity.project.name=Serenity and Cucumber Quick Start -------------------------------------------------------------------------------- /src/main/java/starter/README.md: -------------------------------------------------------------------------------- 1 | ### Application code 2 | 3 | These packages generally contain application code. 4 | If you are writing a reusable test library, you can also place reusable test components such as Page Objects or Tasks here. -------------------------------------------------------------------------------- /src/test/java/starter/CucumberTestSuite.java: -------------------------------------------------------------------------------- 1 | package starter; 2 | 3 | import org.junit.platform.suite.api.ConfigurationParameter; 4 | import org.junit.platform.suite.api.IncludeEngines; 5 | import org.junit.platform.suite.api.SelectClasspathResource; 6 | import org.junit.platform.suite.api.Suite; 7 | 8 | import static io.cucumber.junit.platform.engine.Constants.PLUGIN_PROPERTY_NAME; 9 | 10 | @Suite 11 | @IncludeEngines("cucumber") 12 | @SelectClasspathResource("/features") 13 | @ConfigurationParameter(key = PLUGIN_PROPERTY_NAME, value = "io.cucumber.core.plugin.SerenityReporterParallel,pretty,timeline:build/test-results/timeline") 14 | public class CucumberTestSuite { 15 | } 16 | -------------------------------------------------------------------------------- /src/test/java/starter/navigation/DuckDuckGoHomePage.java: -------------------------------------------------------------------------------- 1 | package starter.navigation; 2 | 3 | import net.serenitybdd.annotations.DefaultUrl; 4 | import net.thucydides.core.pages.PageObject; 5 | 6 | @DefaultUrl("https://duckduckgo.com") 7 | public class DuckDuckGoHomePage extends PageObject { 8 | } 9 | -------------------------------------------------------------------------------- /src/test/java/starter/navigation/NavigateTo.java: -------------------------------------------------------------------------------- 1 | package starter.navigation; 2 | 3 | import net.serenitybdd.screenplay.Performable; 4 | import net.serenitybdd.screenplay.Task; 5 | import net.serenitybdd.screenplay.actions.Open; 6 | 7 | public class NavigateTo { 8 | public static Performable theSearchHomePage() { 9 | return Task.where("{0} opens the DuckDuckGo home page", 10 | Open.browserOn().the(DuckDuckGoHomePage.class)); 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /src/test/java/starter/search/LookForInformation.java: -------------------------------------------------------------------------------- 1 | package starter.search; 2 | 3 | import net.serenitybdd.screenplay.Performable; 4 | import net.serenitybdd.screenplay.Task; 5 | import net.serenitybdd.screenplay.actions.Enter; 6 | import org.openqa.selenium.Keys; 7 | 8 | public class LookForInformation { 9 | public static Performable about(String searchTerm) { 10 | return Task.where("{0} searches for '" + searchTerm + "'", 11 | Enter.theValue(searchTerm) 12 | .into(SearchForm.SEARCH_FIELD) 13 | .thenHit(Keys.ENTER) 14 | ); 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /src/test/java/starter/search/SearchArticle.java: -------------------------------------------------------------------------------- 1 | package starter.search; 2 | 3 | import net.serenitybdd.screenplay.targets.Target; 4 | 5 | public class SearchArticle { 6 | public static final Target BODY = Target.the("article identifier").locatedBy("//article"); 7 | } 8 | -------------------------------------------------------------------------------- /src/test/java/starter/search/SearchForm.java: -------------------------------------------------------------------------------- 1 | package starter.search; 2 | 3 | import net.serenitybdd.screenplay.targets.Target; 4 | 5 | class SearchForm { 6 | static Target SEARCH_FIELD = Target.the("search field").locatedBy("#searchbox_input"); 7 | 8 | } 9 | -------------------------------------------------------------------------------- /src/test/java/starter/stepdefinitions/ParameterDefinitions.java: -------------------------------------------------------------------------------- 1 | package starter.stepdefinitions; 2 | 3 | import io.cucumber.java.Before; 4 | import io.cucumber.java.ParameterType; 5 | import net.serenitybdd.screenplay.Actor; 6 | import net.serenitybdd.screenplay.actors.OnStage; 7 | import net.serenitybdd.screenplay.actors.OnlineCast; 8 | 9 | public class ParameterDefinitions { 10 | 11 | @ParameterType(".*") 12 | public Actor actor(String actorName) { 13 | return OnStage.theActorCalled(actorName); 14 | } 15 | 16 | @Before 17 | public void setTheStage() { 18 | OnStage.setTheStage(new OnlineCast()); 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /src/test/java/starter/stepdefinitions/SearchStepDefinitions.java: -------------------------------------------------------------------------------- 1 | package starter.stepdefinitions; 2 | 3 | import io.cucumber.java.en.Given; 4 | import io.cucumber.java.en.Then; 5 | import io.cucumber.java.en.When; 6 | import net.serenitybdd.screenplay.Actor; 7 | import net.serenitybdd.screenplay.ensure.Ensure; 8 | import net.serenitybdd.screenplay.questions.page.TheWebPage; 9 | import starter.navigation.NavigateTo; 10 | import starter.search.LookForInformation; 11 | 12 | public class SearchStepDefinitions { 13 | 14 | @Given("{actor} is researching things on the internet") 15 | public void researchingThings(Actor actor) { 16 | actor.wasAbleTo(NavigateTo.theSearchHomePage()); 17 | } 18 | 19 | @When("{actor} looks up {string}") 20 | public void searchesFor(Actor actor, String term) { 21 | actor.attemptsTo( 22 | LookForInformation.about(term) 23 | ); 24 | } 25 | 26 | @Then("{actor} should see information about {string}") 27 | public void should_see_information_about(Actor actor, String term) { 28 | actor.attemptsTo( 29 | Ensure.that(TheWebPage.title()).containsIgnoringCase(term) 30 | ); 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/test/resources/features/search/search_by_keyword.feature: -------------------------------------------------------------------------------- 1 | Feature: Search by keyword 2 | 3 | @green 4 | Scenario: Searching for 'green' 5 | Given Sergey is researching things on the internet 6 | When he looks up "green" 7 | Then he should see information about "green" 8 | 9 | @red 10 | Scenario: Searching for 'red' 11 | Given Sergey is researching things on the internet 12 | When he looks up "red" 13 | Then he should see information about "red" 14 | -------------------------------------------------------------------------------- /src/test/resources/junit-platform.properties: -------------------------------------------------------------------------------- 1 | cucumber.execution.parallel.enabled=true 2 | cucumber.execution.parallel.config.strategy=fixed 3 | cucumber.execution.parallel.config.fixed.parallelism=4 4 | cucumber.execution.parallel.config.fixed.max-pool-size=4 5 | -------------------------------------------------------------------------------- /src/test/resources/logback-test.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /src/test/resources/serenity.conf: -------------------------------------------------------------------------------- 1 | serenity { 2 | take.screenshots = FOR_FAILURES 3 | } 4 | 5 | headless.mode = true 6 | webdriver { 7 | driver = chrome 8 | capabilities { 9 | browserName = "chrome" 10 | acceptInsecureCerts = true 11 | "goog:chromeOptions" { 12 | args = ["remote-allow-origins=*","test-type", "no-sandbox", "ignore-certificate-errors", "--window-size=1000,800", 13 | "incognito", "disable-infobars", "disable-gpu", "disable-default-apps", "disable-popup-blocking", 14 | "disable-dev-shm-usage", "disable-extensions", "disable-web-security", "disable-translate", "disable-logging"] 15 | } 16 | } 17 | } 18 | --------------------------------------------------------------------------------