obsidian-integration-test

Automates the testing of custom commands in the context of a specific domain.

1.2k|107|Updated Oct 2, 2023
One-click install
npx skills add https://github.com/your-papa/obsidian-Smart2Brain --skill obsidian-integration-test
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-integration-test
Source: https://github.com/your-papa/obsidian-Smart2Brain/tree/main/.github/skills/obsidian-integration-test
Command: npx skills add https://github.com/your-papa/obsidian-Smart2Brain --skill obsidian-integration-test

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the end-to-end testing of Obsidian plugins by interacting with a live Obsidian vault and its CLI, ensuring plugin functionality and stability.

Core Features & Use Cases

  • End-to-End Plugin Verification: Test plugin commands, UI rendering, and vault interactions in a real environment.
  • Automated Fixture Management: Create, read, update, and delete test files within the Obsidian vault.
  • DOM and Console Inspection: Assert UI states, check for runtime errors, and inspect console logs.
  • Use Case: After updating your Obsidian plugin, use this Skill to automatically run a suite of tests that verify all core commands still work as expected and that no new errors have been introduced.

Quick Start

Run the obsidian CLI command to reload the smart-second-brain plugin and check for any errors.

Frequently Asked Questions about obsidian-integration-test

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I run integration tests for an Obsidian plugin against a live vault?

To run integration tests for an Obsidian plugin, use this Skill to execute the obsidian CLI against a live vault, verifying plugin commands, UI rendering, and vault interactions while capturing console output and runtime errors.

What do I need to set up before testing Obsidian plugin behavior live?

Testing Obsidian plugin behavior requires the Obsidian desktop app to be installed and running, alongside the target plugin being fully installed and built, ensuring the CLI can interact with the live vault environment.

Can I automate fixture management when running e2e tests in Obsidian?

Yes, you can automate fixture management during e2e tests by using this Skill to create, read, update, and delete test files directly within the Obsidian vault to verify plugin interactions.

How to inspect DOM state and check for runtime errors in an Obsidian plugin?

You inspect DOM state and check for runtime errors by executing CLI commands through this Skill, which asserts UI states, monitors console logs, and identifies runtime errors during live vault interactions.

When should I use CLI integration testing instead of manual Obsidian plugin checks?

Use CLI integration testing when you need to automate end-to-end verification after plugin updates, ensuring core commands function correctly and catching newly introduced errors without manual vault inspection.

Does this integration test approach support checking Obsidian plugin console output?

Yes, this integration test approach supports checking Obsidian plugin console output by capturing logs and asserting UI states during automated CLI interactions with the live vault environment.