2e070380e8
* Draft solution masking on the `onBeforeCommand` Use same default string as appium Use same default token as appium Full working solutions Fix compilation problems Remove it from capabilities from simplicity Fix grammar Use Regex native type Draft mask body & command args in webdriver directly Full working solution Removing old solution and complete the new one Revert "Draft solution masking on the `onBeforeCommand`" This reverts commit 5feb324af2d2a1ded4e81c86cad2670a34150b7b. Code review Update packages/webdriver/src/command.ts Co-authored-by: Christian Bromann <git@bromann.dev> Unit test on the regExp converter from string Add missing case of missing starting and ending slash Remove undesired changes Convert string to regExps only once Fix problem after rebase remove occurences of any Add new mask parameter to elementSendKeys to mask text input and more Added also the `/session/:sessionId/appium/settings` endpoints to generate regEx from the sensitive value so that we can mask the value int he appium log on top of WebDriver log and other touchpoint e2e test for masking text value with setValue command Use `updateSettings` only with Appium Review solution to be completely outside of `request.ts` Use env `WDIO_LOG_MASKING_PATTERNS` to pass regex and mask log Full working solutions to mask logs with 0 1 or 2 capturing group Working solution to mask for example BrowserStack key in logs Code review Fix masking not working when output directly in console mask string logging only Better code for wdio-logger masking + more unit tests - Better typing in logger to reflect reality of having only 1 arg of type string of 3 args where the third can be anything. - Move masking utility code into an utils file and add better unit tests - Add `setMaskingPatterns` following `setLogLevelsConfig` for more flexible configuration - Fix a couple fo edge cases - Ensure we mask the output of serializers too Have mask in command optional and fix ut - Have mask optional in send and add command to not interfere with expected output and be less "breaking" if masking is not used - fix ut affected by new logData eventhandler Better masking code for command with masking at true - Move masking code for command into an utility - Use args better with index to fetch mask and text - Apply masking only if the command has the param 'mask', 'text' and mask is true - Share the logger replacer with this package - Fix Logger mock for the `SENSITIVE_DATA_REPLACER` - Replace the sensitive info in both the body and args - Make sure we reuse existing body and args if no masking require for better backward compatibility - Add unit test for commands with masking Review e2e tests to had a input with masking case Remove `.only` on tests Remove fail tentative Tentative fix for failure in `react.test.tsx` - react.test.tsx: SyntaxError: Importing binding name 'SENSITIVE_DATA_REPLACER' is not found * Use the new appium http header masking automatically * fix: used an additional non-typed options to pass the masking property * Add an options object for future needs * Fix masking e2e * Be more verbose on the unmasked vs masked version in the code * Update packages/wdio-logger/src/index.ts Co-authored-by: Christian Bromann <git@bromann.dev> * Update packages/wdio-logger/src/index.ts Co-authored-by: Christian Bromann <git@bromann.dev> * Code review - Use optional options instead - Add more comment on intentions * Update packages/webdriver/src/types.ts * Update packages/webdriverio/src/types.ts * Update packages/webdriver/tests/command.test.ts * Update packages/webdriverio/src/types.ts * Update packages/webdriver/tests/utils.test.ts * On more UT for emit and log.info cases with masked data * make sure the capture data are reset * Better integration of the appium header * final code review * Fix pipeline * Fix depcheck * Fix this.client header undesired alteration * Ensure more code coverage * Apply suggestions from code review Apply suggestions from code review Apply suggestions from code review * Code reviews * Fix `CommandRuntimeOptions is not defined` * Review to mask all captured group + documentation * Add more verbose e2e * Add `maskingPatterns` capabilities to set easily masking patterns * Code review * Test if this is causing e2e to fails! * Fix typo * Rectify doc since it is not a capability * More robust masking algorithm supporting logging of string array - Apply masking on the entire string after stripping the colors (ansi) for a more robust algorithm - The above allow to support regular expression with keyword like `RESULT` or `COMMAND` or `BIDI COMMAND` - Downside is in the console some colors are lost - Enhance doc for the above and show an example to configure all loggers since using wdio.conf object not always work for all of them * Simplify `setMaskingPatterns` API * Add JSDOC and simplify `mask` following previous changes * Update packages/webdriverio/src/types.ts Co-authored-by: Christian Bromann <git@bromann.dev> * Update packages/webdriver/src/types.ts Co-authored-by: Christian Bromann <git@bromann.dev> * Use suggested return-early version of mask in used command.ts * Fix grammar + review doc * be more human friendly * Test * Code review * Fix new line sometimes stripped away * Update packages/wdio-logger/README.md Co-authored-by: Christian Bromann <git@bromann.dev> * Apply suggestions from code review Co-authored-by: Christian Bromann <git@bromann.dev> * Last comment review checking types in setMaskingPatterns * Add doc on `maskingPatterns` in Configuration.md * Add guides on security * Apply suggestions from code review * Add missing import in example --------- Co-authored-by: Christian Bromann <git@bromann.dev> |
||
|---|---|---|
| .devcontainer | ||
| .github | ||
| .gitpod | ||
| .husky | ||
| .vscode | ||
| @types | ||
| __mocks__ | ||
| e2e | ||
| examples | ||
| infra | ||
| packages | ||
| scripts | ||
| tests | ||
| website | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .gitpod.yml | ||
| .nvmrc | ||
| AUTHORS.md | ||
| BACKERS.md | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| crowdin.yaml | ||
| eslint.config.mjs | ||
| GOVERNANCE.md | ||
| lerna.json | ||
| LICENSE | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| PROJECT_CHARTER.md | ||
| README.md | ||
| ROADMAP.md | ||
| tsconfig.json | ||
| vitest.config.ts | ||
Next-gen browser and mobile automation test framework for Node.js.
Homepage | Developer Guide | API Reference | Contribute | Changelog | Roadmap
WebdriverIO is a test automation framework, for e2e as well as unit and component testing in the browser, that allows you to run tests based on the WebDriver and WebDriver BiDi as well as Appium automation technology. It provides support for your favorite BDD/TDD test framework and will run your tests locally or in the cloud using Sauce Labs, BrowserStack, TestingBot or LambdaTest.
👩💻 👨💻 Contributing
Do you like WebdriverIO and want to help make it better? Awesome! Have a look into our Contributor Documentation to get started and find out what contributions can be and how to make them.
Getting started with GitHub Codespaces
To get started, create a codespace for this repository by clicking this 👇
A codespace will open in a web-based version of Visual Studio Code. The dev container is fully configured with the software needed for this project.
Note: Dev containers are an open spec that is supported by GitHub Codespaces and other tools.
Getting started with Gitpod
You can also just click on:
to get a ready-to-use development environment for you to start working on this code base.
If you're looking for issues to help out with, check out the issues labeled "good first pick". You can also reach out to our Matrix Channel if you have questions on where to start contributing.
🏢 WebdriverIO for Enterprise
Available as part of the Tidelift Subscription.
The maintainers of WebdriverIO and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open-source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.
📦 Packages
This repository contains some of the core packages of the WebdriverIO project. There are many wonderful curated resources the WebdriverIO community has put together.
Did you build a WebdriverIO service or reporter? That's awesome! Please add it to our configuration wizard and docs (e.g. like in this example commit) as well as to our awesome-webdriverio list. Thank you! 🙏 ❤️
Core
- webdriver - A Node.js bindings implementation for the W3C WebDriver and Mobile JSONWire Protocol
- webdriverio - Next-gen browser and mobile automation test framework for Node.js
- @wdio/cli - A WebdriverIO testrunner command line interface
Helper
- @wdio/config - A helper utility to parse and validate WebdriverIO options
- @wdio/logger - A helper utility for logging WebdriverIO packages
- @wdio/protocols - Utility package providing information about automation protocols
- @wdio/repl - A WDIO helper utility to provide a repl interface for WebdriverIO
- @wdio/reporter - A WebdriverIO utility to help report all events
- @wdio/runner - A WebdriverIO service that runs tests in arbitrary environments
- @wdio/utils - A WDIO helper utility to provide several utility functions used across the project
- @wdio/globals - A WDIO helper utility for importing global variables directly
Reporter
- @wdio/allure-reporter - A WebdriverIO reporter plugin to create Allure Test Reports
- @wdio/concise-reporter - A WebdriverIO reporter plugin to create concise test reports
- @wdio/dot-reporter - A WebdriverIO plugin to report in dot style
- @wdio/junit-reporter - A WebdriverIO reporter that creates test results in XML format
- @wdio/spec-reporter - A WebdriverIO plugin to report in spec style
- @wdio/sumologic-reporter - A WebdriverIO reporter that sends test results to Sumologic for data analyses
Services
- @wdio/appium-service - A WebdriverIO service to start & stop Appium Server
- @wdio/browserstack-service - A WebdriverIO service that can be used to use BrowserStack Test Observability which is a reporting, debugging, and test suite quality tracking tool for any test running anywhere. The service also helps for a better integration with the BrowserStack grid if you're running tests on the grid.
- @wdio/lighthouse-service - A WebdriverIO service that integrates Google Lighthouse commands to use it for automate tests
- @wdio/firefox-profile-service - A WebdriverIO service that lets you define your Firefox profile in your wdio.conf.js
- @wdio/sauce-service - A WebdriverIO service that provides a better integration into Sauce Labs
- @wdio/shared-store-service - A WebdriverIO service to exchange data across processes
- @wdio/testingbot-service - A WebdriverIO service that provides a better integration into TestingBot
Runner
- @wdio/local-runner - A WebdriverIO runner to run tests locally
- @wdio/browser-runner - A WebdriverIO runner to run unit or component tests in the browser
Framework Adapters
- @wdio/cucumber-framework - Adapter for Cucumber testing framework
- @wdio/jasmine-framework - Adapter for Jasmine testing framework
- @wdio/mocha-framework - Adapter for Mocha testing framework.
Others
- eslint-plugin-wdio - Eslint rules for WebdriverIO
- @wdio/smoke-test-reporter - A WebdriverIO utility to smoke test reporters for internal testing purposes
- @wdio/smoke-test-service - A WebdriverIO utility to smoke test services for internal testing purposes
- @wdio/webdriver-mock-service - A WebdriverIO service to stub all endpoints for internal testing purposes
Infrastructure Packages
These packages are not released to NPM and used to work on this codebase.
- @wdio/compiler - Esbuild script to compile the source code all of all packages
- @wdio/lerna-patch - This sub-package is being used to patch Lerna to not run
pnpm installafter it prepared all packages for release
🤝 Project Governance
This project is maintained by awesome people following a common set of rules and treating each other with respect and appreciation.
👨🍳 👩🍳 Backers
Become a backer and show your support for our open-source project.
💸 Sponsors
Does your company use WebdriverIO? Ask your manager or marketing team if your company would be interested in supporting our project. Support will allow the maintainers to dedicate more time to maintenance and new features for everyone. Also, your company's logo will show on GitHub - who doesn't want a little extra exposure? Here's the info.
💎 Premium Sponsor
We are immensely grateful to our exclusive Premium Sponsor for their invaluable support in the development of this project:
🥇 Gold Sponsor
🥈 Silver Sponsor
🥉 Bronze Sponsor
📄 License
🔰 Badge
Show the world you're using webdriver.io →
GitHub markup
[](https://webdriver.io/)
HTML
<a href="https://webdriver.io/">
<img alt="WebdriverIO" src="https://img.shields.io/badge/tested%20with-webdriver.io-%23ea5906">
</a>
👏 Supporters
