Bill
2e30b81f01
Add extensive test suite for note-tools.ts covering all major operations and error paths. Improves statement coverage from 13.94% to 96.01%. Tests added: - readNote: success, errors, frontmatter parsing - createNote: success, conflict strategies (error/overwrite/rename), parent folder creation - updateNote: success, errors, waypoint protection - deleteNote: soft/permanent delete, dry run, version checking - renameFile: success, errors, version checking, parent folder creation - readExcalidraw: success, non-Excalidraw files, errors - updateFrontmatter: success, field removal, version checking - updateSections: success, invalid ranges, version checking - Path validation for all methods - Empty path validation for all methods Mock enhancements: - Added modify, delete, trash methods to VaultAdapter mock - Added parseYaml function to Obsidian mock for frontmatter testing Coverage improvements for note-tools.ts: - Statements: 13.94% -> 96.01% (+82.07%) - Branches: 5.1% -> 88.44% (+83.34%) - Functions: 27.27% -> 90.9% (+63.63%) - Lines: 13.94% -> 96.4% (+82.46%)
Tests
This directory contains unit and integration tests for the Obsidian MCP Server plugin.
Current Status
The test files are currently documentation of expected behavior. To actually run these tests, you need to set up a testing framework.
Setting Up Jest (Recommended)
- Install Jest and related dependencies:
npm install --save-dev jest @types/jest ts-jest
- Create a
jest.config.jsfile in the project root:
module.exports = {
preset: 'ts-jest',
testEnvironment: 'node',
roots: ['<rootDir>/tests'],
testMatch: ['**/*.test.ts'],
moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
collectCoverageFrom: [
'src/**/*.ts',
'!src/**/*.d.ts',
],
};
- Add test script to
package.json:
{
"scripts": {
"test": "jest",
"test:watch": "jest --watch",
"test:coverage": "jest --coverage"
}
}
- Run tests:
npm test
Test Files
path-utils.test.ts
Tests for the PathUtils class, covering:
- Path normalization (cross-platform)
- Path validation
- File/folder resolution
- Path manipulation utilities
Key Test Categories:
- normalizePath: Tests for handling leading/trailing slashes, backslashes, drive letters
- isValidVaultPath: Tests for path validation rules
- Cross-platform: Tests for Windows, macOS, and Linux path handling
Mocking Obsidian API
Since these tests run outside of Obsidian, you'll need to mock the Obsidian API:
// Example mock setup
jest.mock('obsidian', () => ({
App: jest.fn(),
TFile: jest.fn(),
TFolder: jest.fn(),
TAbstractFile: jest.fn(),
// ... other Obsidian types
}));
Running Tests Without Jest
If you prefer not to set up Jest, you can:
- Use the test files as documentation of expected behavior
- Manually test the functionality through the MCP server
- Use TypeScript's type checking to catch errors:
npm run build
Future Improvements
- Set up Jest testing framework
- Add integration tests with mock Obsidian vault
- Add tests for error-messages.ts
- Add tests for tool implementations
- Add tests for MCP server endpoints
- Set up CI/CD with automated testing
- Add code coverage reporting
Test Coverage Goals
- PathUtils: 100% coverage (critical for cross-platform support)
- ErrorMessages: 100% coverage (important for user experience)
- Tool implementations: 80%+ coverage
- Server/middleware: 70%+ coverage
Writing New Tests
When adding new features, please:
- Write tests first (TDD approach recommended)
- Test both success and error cases
- Test edge cases and boundary conditions
- Test cross-platform compatibility where relevant
- Add descriptive test names that explain the expected behavior
Example test structure:
describe('FeatureName', () => {
describe('methodName', () => {
test('should handle normal case', () => {
// Arrange
const input = 'test';
// Act
const result = method(input);
// Assert
expect(result).toBe('expected');
});
test('should handle error case', () => {
expect(() => method(null)).toThrow();
});
});
});