feat(webdriverio): migrated to WebdriverIO 9

serenity-js · Dec 12, 2024 · b82e218 · b82e218
1 parent d0d8673
commit b82e218
Show file tree

Hide file tree

Showing 4 changed files with 5,797 additions and 7,104 deletions.
diff --git a/README.md b/README.md
@@ -1,97 +1,112 @@
-# Serenity/JS Cucumber WebdriverIO Template
-
-[![Build Status](https://github.com/serenity-js/serenity-js-cucumber-webdriverio-template/workflows/build/badge.svg)](https://github.com/serenity-js/serenity-js-cucumber-webdriverio-template/actions)
-[![Serenity/JS on GitHub](https://img.shields.io/badge/github-serenity--js-yellow?logo=github)](https://github.com/serenity-js/serenity-js)
-[![Serenity/JS on StackOverflow](https://img.shields.io/badge/stackoverflow-serenity--js-important?logo=stackoverflow)](https://stackoverflow.com/questions/tagged/serenity-js)
-[![Contribute with Gitpod](https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod)](https://gitpod.io/from-referrer/)
+# Serenity/JS Mocha WebdriverIO Template
 
 [![Follow Serenity/JS on LinkedIn](https://img.shields.io/badge/Follow-Serenity%2FJS%20-0077B5?logo=linkedin)](https://www.linkedin.com/company/serenity-js)
 [![Watch Serenity/JS on YouTube](https://img.shields.io/badge/Watch-@serenity--js-E62117?logo=youtube)](https://www.youtube.com/@serenity-js)
 [![Join Serenity/JS Community Chat](https://img.shields.io/badge/Chat-Serenity%2FJS%20Community-FBD30B?logo=matrix)](https://matrix.to/#/#serenity-js:gitter.im)
+[![GitHub stars](https://img.shields.io/github/stars/serenity-js/serenity-js?label=Serenity%2FJS&logo=github&style=badge)](https://github.com/serenity-js/serenity-js)
 [![Support Serenity/JS on GitHub](https://img.shields.io/badge/Support-@serenity--js-703EC8?logo=github)](https://github.com/sponsors/serenity-js)
 
-Use this [template repository](https://help.github.com/en/articles/creating-a-repository-from-a-template)
-to get started with acceptance testing your web applications using [Serenity/JS](https://serenity-js.org),
-[Cucumber](https://github.com/cucumber/cucumber-js) and [WebdriverIO](https://webdriver.io/).
+[![Build Status](https://github.com/serenity-js/serenity-js-cucumber-webdriverio-template/workflows/build/badge.svg)](https://github.com/serenity-js/serenity-js-cucumber-webdriverio-template/actions)
+[![Contribute with Gitpod](https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod)](https://gitpod.io/from-referrer/)
+
+
+Kickstart your web application acceptance testing with [Serenity/JS](https://serenity-js.org), [Cucumber](https://github.com/cucumber/cucumber-js),
+and [WebdriverIO](https://webdriver.io/) using this template repository.
 
-Learn more:
-- [Serenity BDD reports for this project](https://serenity-js.github.io/serenity-js-cucumber-webdriverio-template/)
-- [Serenity/JS website, tutorials, and API docs](https://serenity-js.org/)
+Learn more about Serenity/JS:
+[Serenity/JS and WebdriverIO guide](https://serenity-js.org/handbook/test-runners/webdriverio/)
 
-## Usage
+## 🚀 Quick Start
 
-This repository is a GitHub template. You can use it to [create a new GitHub repository](https://help.github.com/en/articles/creating-a-repository-from-a-template), [clone it to your computer](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
+### 1. Create a Project
 
-You can also launch it in a virtual Gitpod workspace without having to install anything on your machine:
+This repository is a GitHub template. Use it to [create a new GitHub repository](https://help.github.com/en/articles/creating-a-repository-from-a-template)
+for your project.
+
+If you prefer to work in a virtual environment, you can launch this repository in a [Gitpod](https://gitpod.io/from-referrer/) workspace.
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
 
-### Installation
+### 2. Set Up Your Environment
+
+Install the required tools:
+
+- [Node.js](https://nodejs.org/en/) (LTS version 18.12 or later)
 
-To use this project, you'll need:
-- Node.js, a Long-Term Support (LTS) release version 16 or later - [download](https://nodejs.org/en/)
-- Java Runtime Environment (JRE) or a Java Development Kit (JDK) version 11 or later - [download](https://adoptopenjdk.net/)
-- Chrome web browser - [download](https://www.google.co.uk/chrome/)
+- [Java](https://adoptopenjdk.net/) (JRE or JDK version 11 or later)
 
-Follow the [installation instructions](https://serenity-js.org/handbook/getting-started/installation/) to help you verify your setup.
+Follow the [installation guide](https://serenity-js.org/handbook/getting-started/installation/) to verify your setup.
+
+### 3. Install Dependencies
+
+[Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the project and run:
 
-Once you have the code on your computer, use your computer terminal to run the following command in the directory where you've cloned the project:
 ```
 npm ci
 ```
 
-Running [`npm ci`](https://docs.npmjs.com/cli/v6/commands/npm-ci) downloads the [Node modules](https://docs.npmjs.com/about-packages-and-modules) this project depends on, as well as the latest version of [`chromedriver`](https://www.npmjs.com/package/chromedriver) and the [Serenity BDD CLI](https://github.com/serenity-bdd/serenity-cli) reporter jar.
-
-### Corporate networks
+This installs dependencies, including the [Serenity BDD CLI](https://serenity-js.org/handbook/reporting/serenity-bdd-reporter/).
 
-If your network administrators require you to use proxy servers or an internal artifact registry (Artifactory, Nexus, etc.), your development environment might require some additional configuration.
+### 4. Run Tests
 
-The easiest way to do it is to create an [`.npmrc` file](https://docs.npmjs.com/cli/v6/configuring-npm/npmrc) in your home directory: 
+Use the predefined [NPM scripts](https://docs.npmjs.com/cli/v10/using-npm/scripts) defined in [`package.json`](package.json) to run your tests
+and related tasks:
 
 ```
-proxy=http://user:[email protected]:8080/
-https-proxy=http://user:[email protected]:8080/
-strict-ssl=false
-registry=https://artifactory.mycompany.com/artifactory/
+npm test                # Run tests and generate reports
+npm start               # Serve test reports at http://localhost:8080
+
+npm run lint            # Run code linter
+npm run lint:fix        # Try to automatically fix linting issues
+npm run clean           # Remove test reports from any previous test run
 ```
 
-If you encounter issues downloading the Serenity BDD CLI jar, please follow the [detailed instructions in the Serenity/JS Handbook](https://serenity-js.org/api/serenity-bdd/#downloading-the-serenity-bdd-reporting-cli).
+### 5. Write your tests
+
+Test scenarios are located in the [`./test/specs`](/test/specs) directory.
+Modify the examples or write your own scenarios using the [Serenity/JS Screenplay Pattern](https://serenity-js.org/handbook/design/screenplay-pattern/).
 
-Similar instructions are available for the [`chromedriver` module](https://www.npmjs.com/package/chromedriver).
+## 🌟 Features
 
-### Execution
+- **All automation tools ready to go**: Start testing immediately with WebdriverIO, Serenity/JS and Mocha already integrated and configured.
+- **Serenity BDD Reports**: Serenity BDD reporter pre-configured with reports available at `./target/site/serenity`
+    - **Published Reports**: Reports for this repository are published to GitHub Pages and available at https://serenity-js.github.io/serenity-js-cucumber-webdriverio-template/.
+- **Screenplay Pattern**: Out-of-the-box integration with the Serenity/JS actors and Screenplay Pattern APIs
+- **GitHub Actions**: Continuous Integration setup included
+- **VS Code**: Pre-configured for a seamless developer experience
 
-The project provides several [NPM scripts](https://docs.npmjs.com/cli/v6/using-npm/scripts) defined in [`package.json`](package.json):
+### 🔧 Configuration for Corporate Networks
+
+If you're behind a proxy or use an internal registry, configure an [`.npmrc` file](https://docs.npmjs.com/cli/v6/configuring-npm/npmrc) in your home directory:
 
 ```
-npm run lint            # runs code linter
-npm run lint:fix        # attempts to automatically fix linting issues
-npm run clean           # removes reports from any previous test run
-npm test                # executes the example test suite
-                        # and generates the report under ./target/site/serenity
-npm start               # starts a mini HTTP server and serves the test reports
-                        # at http://localhost:8080
+proxy=http://user:[email protected]:8080/
+https-proxy=http://user:[email protected]:8080/
+strict-ssl=false
+registry=https://artifactory.mycompany.com/artifactory/
 ```
 
-## Your feedback matters!
-
-Do you find Serenity/JS useful? Give it a ⭐ star on GitHub!
+## 💡️ Learn Serenity/JS
 
-[![GitHub stars](https://img.shields.io/github/stars/serenity-js/serenity-js)](https://github.com/serenity-js/serenity-js)
+- [Serenity/JS WebdriverIO integration guide](https://serenity-js.org/handbook/test-runners/webdriverio/) - Integrate Serenity/JS with your WebdriverIO test suite, enable Serenity BDD reports, and start using the Screenplay Pattern
+- [Serenity/JS Handbook](https://serenity-js.org/handbook/) - Write high-quality automated acceptance tests with Serenity/JS
+- [Serenity/JS API documentation](https://serenity-js.org/api/) - Explore Serenity/JS modules and features
+- [Serenity/JS Project Templates](https://serenity-js.org/handbook/getting-started/project-templates/) - Kickstart your projects with best practices built right in
 
-Found a bug? Need a feature? Raise [an issue](https://github.com/serenity-js/serenity-js/issues?state=open)
-or submit a pull request.
+## 👋 Join the Serenity/JS Community
 
-Have feedback? Let me know on [LinkedIn](https://www.linkedin.com/in/janmolak/) or leave a comment in [Serenity/JS discussions on GitHub](/serenity-js/serenity-js/discussions/categories/comments).
+- [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im) - Meet Serenity/JS developers and maintainers
+- [Serenity/JS Forum](https://github.com/orgs/serenity-js/discussions/categories/how-to) - Find answers to your Serenity/JS questions
+- [Contribute to Serenity/JS](https://serenity-js.org/community/contributing/) - Learn how to propose features, report bugs, and contribute to the Serenity/JS codebase
 
-And if you have any questions about the framework, or simply want to say hello to other Serenity/JS developers, join us on [Serenity/JS Community Chat](https://matrix.to/#/#serenity-js:gitter.im).
+## 📣 Stay up to date
 
-## Support Serenity/JS
+- [Serenity/JS on YouTube](https://www.youtube.com/@serenity-js) - Subscribe for tutorials, demos, conference talks, and more
+- [Serenity/JS on LinkedIn](https://www.linkedin.com/company/serenity-js) - Follow for release and community event announcements
+- [Serenity/JS on GitHub](https://github.com/serenity-js/serenity-js) - Star Serenity/JS to help others discover the framework!
 
-Serenity/JS is a free open-source framework, so we rely on our [wonderful GitHub sponsors](https://github.com/sponsors/serenity-js) to keep the lights on.
+## 💛 Support Serenity/JS
 
-If you appreciate all the effort that goes into making sophisticated tools easy to work with, please support our work and [become a Serenity/JS GitHub Sponsor](https://github.com/sponsors/serenity-js) today!
+Support our mission to make test automation collaborative and easier to scale. Become a Serenity/JS GitHub Sponsor today!
 
-[![LinkedIn Follow](https://img.shields.io/badge/Follow%20Serenity%2FJS-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/serenity-js)
-[![YouTube Follow](https://img.shields.io/badge/Watch%20@serenity&#8212;JS-FA120F?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/@serenity-js)
-[![GitHub Sponsors](https://img.shields.io/badge/Support%20@serenity%2FJS-703EC8?style=for-the-badge&logo=github&logoColor=white)](https://github.com/sponsors/serenity-js)
+[![GitHub Sponsors](https://img.shields.io/badge/Sponsor%20@serenity%2FJS-703EC8?style=for-the-badge&logo=github&logoColor=white)](https://github.com/sponsors/serenity-js)