Skip to content

Testing-Guide.md

Latest commit

 

History

History
100 lines (74 loc) · 2.39 KB

Testing-Guide.md

File metadata and controls

100 lines (74 loc) · 2.39 KB

Testing Guide

Testing patterns and best practices for Exocortex.

📖 Comprehensive Guide: For complete testing documentation including all test types, patterns, CI/CD integration, and troubleshooting, see the main TESTING.md guide.

Quick Reference

Run Tests

npm test              # Unit + UI + Component tests
npm run test:all      # All tests including E2E
npm run test:unit     # Unit tests only
npm run test:component # Component tests
npm run test:e2e:docker # E2E in Docker
npm run bdd:check     # BDD coverage check

Test Locations

Type Location Framework
Unit packages/*/tests/unit/ Jest
Component packages/obsidian-plugin/tests/component/ Playwright CT
E2E packages/obsidian-plugin/tests/e2e/ Playwright
BDD packages/obsidian-plugin/specs/features/ Cucumber

Coverage Requirements

Metric Threshold
Statements 79%
Branches 67%
Functions 71%
Lines 78%
BDD scenarios 80%

Quick Start: Unit Test

import { MyService } from '../../src/services/MyService';

describe('MyService', () => {
  let service: MyService;

  beforeEach(() => {
    service = new MyService(mockVault);
  });

  it('should process task correctly', () => {
    const result = service.process(task);
    expect(result).toBe(expected);
  });
});

Mock Helpers

Location: packages/obsidian-plugin/tests/unit/helpers/testHelpers.ts

import {
  createMockApp,
  createMockPlugin,
  createMockMetadata,
  createMockTFile
} from './helpers/testHelpers';

const mockApp = createMockApp();
const mockPlugin = createMockPlugin();
const mockMetadata = createMockMetadata({
  exo__Asset_label: "Test Task"
});
const mockFile = createMockTFile('test.md');

Override Mock Defaults

Always test null/undefined cases explicitly:

const metadata = createMockMetadata({
  exo__Asset_label: null  // Test fallback behavior
});

Additional Resources