# Obsidian Plugin Testing Service

> wdio-obsidian-service is a 3rd party package, for more information please see [GitHub](https://github.com/jesse-r-s-hines/wdio-obsidian-service) | [npm](https://www.npmjs.com/package/wdio-obsidian-service)

Test your [Obsidian](https://obsidian.md) plugins end-to-end using [WebdriverIO](https://webdriver.io)!

WDIO Obsidian Service can:

* Download and test multiple versions of Obsidian
* Run tests on Windows, macOS, Linux, and Android
* Sandbox Obsidian so tests don't interfere with your system and can run in parallel
* Open and switch between vaults
* Provide helper functions for common testing tasks
* Run tests in CI

For instructions on how to set up end-to-end tests using WDIO Obsidian Service see the [service api docs](https://jesse-r-s-hines.github.io/wdio-obsidian-service/wdio-obsidian-service/README.html), or get started quickly by using the [sample plugin](https://github.com/jesse-r-s-hines/wdio-obsidian-service-sample-plugin) as a template.

This project is split into several NPM packages:

* [wdio-obsidian-service](https://github.com/jesse-r-s-hines/wdio-obsidian-service/blob/main/./packages/wdio-obsidian-service/README.md): A WebdriverIO service to test Obsidian plugins
* [obsidian-launcher](https://github.com/jesse-r-s-hines/wdio-obsidian-service/blob/main/./packages/obsidian-launcher/README.md): A package for downloading and launching different versions of Obsidian
* [wdio-obsidian-reporter](https://github.com/jesse-r-s-hines/wdio-obsidian-service/blob/main/./packages/wdio-obsidian-reporter/README.md): Wrapper around [@wdio/spec-reporter](https://www.npmjs.com/package/@wdio/spec-reporter) that logs Obsidian version instead of Chromium version

## API Docs[​](#api-docs "Direct link to API Docs")

API docs for all the packages are available [here](https://jesse-r-s-hines.github.io/wdio-obsidian-service/wdio-obsidian-service/README.html).

## Contributing[​](#contributing "Direct link to Contributing")

PRs and issues welcome! See [CONTRIBUTING.md](https://github.com/jesse-r-s-hines/wdio-obsidian-service/blob/main/./CONTRIBUTING.md) for instructions on how to set up local development.