wdio-obsidian-service

KO | EN

gitlite — search

#python #docker #php #react #deep-learning #pytorch #mysql #python3 #template #matplotlib #audio #javascript

wdio-obsidian-service

★ 51 Open GitHub ↗

A WebdriverIO service for end-to-end testing Obsidian plugins

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# WDIO Obsidian Service [![](https://github.com/jesse-r-s-hines/wdio-obsidian-service/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/jesse-r-s-hines/wdio-obsidian-service/actions/workflows/test.yaml)

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 or each other
- 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](./packages/wdio-obsidian-service/README.md): A WebdriverIO service to test Obsidian plugins
- [obsidian-launcher](./packages/obsidian-launcher/README.md): A package for downloading and launching different versions of Obsidian
- [wdio-obsidian-reporter](./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 for all the packages are available [here](https://jesse-r-s-hines.github.io/wdio-obsidian-service/wdio-obsidian-service/README.html).

## Contributing
PRs and issues welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on how to set up local development.

wdio-obsidian-service

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README