Testing Frameworks in lfnovo/open-notebook: pytest and vitest Explained

The lfnovo/open-notebook repository uses pytest for Python backend tests and vitest with React Testing Library for the TypeScript frontend.

The lfnovo/open-notebook project is a full-stack application built with a Python FastAPI backend and a TypeScript React/Next.js frontend. Understanding the testing frameworks used across both layers is essential for contributing to the codebase or extending its functionality. The repository implements distinct but complementary testing ecosystems tailored to each environment.

Backend Testing: pytest with Async Support

The Python layer relies on pytest as its primary test runner, configured to handle asynchronous FastAPI code. According to the project documentation in CLAUDE.md, the standard command to execute the suite is uv run pytest tests/.

Dependencies and Configuration

The backend testing stack includes several supporting libraries:

• pytest-asyncio: Enables testing of async functions and database calls
• unittest.mock: Provides mocking capabilities from the Python standard library
• pytest-cov: Handles test coverage reporting

These dependencies are utilized in the tests/ directory, which contains modules like tests/test_utils.py and tests/test_models_api.py.

Example: Testing Utilities in tests/test_utils.py

The following test demonstrates the standard pytest patterns used for utility functions:

def test_remove_non_ascii():
    # Text with various non‑ASCII characters

    text = "Hello 世界 café naïve"
    result = remove_non_ascii(text)

    # Only ASCII characters remain

    assert result == "Hello  caf nave"
    assert all(ord(c) < 128 for c in result)

This example from tests/test_utils.py shows basic assertion patterns without requiring external mock objects, suitable for pure function testing.

Frontend Testing: vitest and React Testing Library

The TypeScript frontend uses vitest as its test runner, leveraging its Vite-native speed for the React/Next.js application. The configuration is defined in frontend/package.json, where the test script executes vitest run.

Configuration and Setup

Key testing dependencies for the frontend include:

• @testing-library/react: Provides component rendering and interaction utilities
• @testing-library/jest-dom: Supplies custom DOM matchers (e.g., toHaveTextContent)
• vitest/ui: Optional UI mode for debugging test runs

The global test harness is initialized in frontend/src/test/setup.ts, which imports the Jest DOM matchers to extend vitest's assertion capabilities.

Example: Component Testing with React Testing Library

Component tests follow this pattern, as seen in the test suite:

import { render, screen } from '@testing-library/react';
import { MyButton } from '@/components/MyButton';

test('renders button with provided label', () => {
  render(<MyButton label="Click me" />);
  expect(screen.getByRole('button')).toHaveTextContent('Click me');
});

This test file imports the setup configuration from frontend/src/test/setup.ts, ensuring DOM matchers are available throughout the frontend test suite.

Key Testing Files and Directories

Understanding the repository structure helps locate relevant test configurations:

• CLAUDE.md: Documents the uv run pytest tests/ command for running Python tests
• tests/: Contains all Python test modules, including test_utils.py and test_models_api.py
• frontend/package.json: Defines the vitest run script and lists frontend testing dependencies
• frontend/src/test/setup.ts: Configures global test utilities and Jest DOM matchers for the frontend

Summary

• The Python backend uses pytest with pytest-asyncio, pytest-cov, and unittest.mock for comprehensive API and utility testing
• The TypeScript frontend employs vitest as the test runner, paired with React Testing Library for component-level validation
• Test commands are standardized via uv run pytest tests/ for Python and vitest run (via npm scripts) for the frontend
• Configuration files CLAUDE.md and frontend/package.json document the testing workflows for each environment

Frequently Asked Questions

Does Open-Notebook use Jest for frontend testing?

No, the frontend uses vitest as the test runner. While the repository includes @testing-library/jest-dom for DOM assertion matchers, the actual execution and watching capabilities are handled by vitest, configured in frontend/package.json.

How do I run the backend tests in lfnovo/open-notebook?

Execute uv run pytest tests/ from the repository root. This command is documented in CLAUDE.md and runs the full Python test suite located in the tests/ directory, including coverage reporting if pytest-cov is configured.

What mocking library is used for Python unit tests?

The Python tests use unittest.mock from the Python standard library. This integrates seamlessly with pytest fixtures and is used alongside pytest-asyncio when mocking async dependencies in the FastAPI backend.

Where are the frontend test utilities configured?

Global frontend test configuration resides in frontend/src/test/setup.ts. This file imports @testing-library/jest-dom to extend vitest's assertion methods and can include additional setup logic like global mocks or environment initialization.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}