tests — themes

tests — themes

This document provides an overview of the tests/themes/theme-manager.test.ts module, which contains the unit tests for the ThemeManager class. Its primary purpose is to ensure the ThemeManager correctly handles theme selection, custom colors, avatars, and its singleton behavior.

Module Purpose

The theme-manager.test.ts module is dedicated to thoroughly testing the ThemeManager class, located in src/themes/theme-manager.ts. It verifies that the ThemeManager adheres to its design specifications, including:

• Implementing the singleton pattern correctly.
• Managing built-in themes and allowing their selection.
• Providing access to current theme properties like colors and avatars.
• Supporting customization of colors and avatars.
• Handling theme export and import functionalities.
• Listing available themes and avatar presets.

Testing Methodology

The tests are written using Jest and follow a standard unit testing approach:

• Singleton Reset: A beforeEach hook is used to reset the ThemeManager's singleton instance before each test. This ensures that tests are isolated and do not interfere with each other's state.

    beforeEach(() => {
      (ThemeManager as any).instance = undefined; class="hl-cmt">// Reset singleton
      themeManager = ThemeManager.getInstance();
    });

• Descriptive Blocks: Tests are organized into describe blocks for logical grouping of related functionalities (e.g., "Singleton Pattern", "Built-in Themes", "Theme Selection").
• Assertions: Jest's expect function is used with various matchers (toBe, toBeDefined, toBeGreaterThan, toEqual, toContain, toMatch, toBeNull) to assert the expected behavior and return values of ThemeManager methods.

Key Functionalities Tested

The tests cover a comprehensive set of ThemeManager features:

Singleton Pattern Verification

Ensures that ThemeManager.getInstance() always returns the same instance, confirming the correct implementation of the singleton pattern.

graph TD
    A[Test 1: getInstance()] --> B{Returns instance1}
    C[Test 2: getInstance()] --> D{Returns instance2}
    B -- instance1 === instance2 --> E[Expect instance1 to be instance2]

Built-in Themes

Tests confirm the presence and correct retrieval of several default themes:

• getAvailableThemes(): Verifies that a list of themes is returned and is not empty.
• getTheme(id): Checks for specific themes like "dark", "neon", "matrix", and "ocean", ensuring they are defined and have expected properties (e.g., theme?.name).

Theme Selection and Retrieval

• getCurrentTheme(): Asserts that a current theme is always available and has basic properties (id, name).
• setTheme(id): Verifies that setting a theme by its ID is successful and updates the current theme. It also tests the failure case for unknown theme IDs.

Theme Colors

Tests ensure that the ThemeManager correctly provides color information:

• getCurrentTheme().colors: Checks that essential colors (primary, text, error, success, warning) are defined within the current theme object.
• getColors(): Verifies that the effective colors (which might include custom overrides) are returned and contain expected properties.

Custom Colors

• setCustomColor(key, value): Confirms that custom colors can be set and override the theme's default colors.
• clearCustomColors(): Ensures that custom color overrides can be cleared, reverting to the current theme's default colors.

Avatars

Similar to colors, avatar management is tested:

• getAvatars(): Verifies that default avatars (user, assistant, system) are available.
• setCustomAvatar(key, value): Checks that custom avatars can be set and override defaults.
• clearCustomAvatars(): Ensures custom avatar overrides can be cleared.

Avatar Presets

• applyAvatarPreset(presetId): Tests the application of predefined avatar presets.
• getAvatarPresets(): Verifies that a list of available presets is returned.

Theme Listing

• getAvailableThemes(): Confirms that the method returns an array of themes, including their IDs (e.g., "dark", "default").

Theme Export/Import

These tests validate the serialization and deserialization of themes:

• exportTheme(id): Checks that a theme can be exported as a JSON string, and that the parsed JSON matches the original theme's properties. It also tests for null return on unknown themes.
• importTheme(json): Verifies that a theme can be successfully imported from a valid JSON string, making it available via getTheme(). It also includes a test for rejecting invalid JSON.

Edge Cases

The module also includes tests for edge cases, such as:

• Handling empty theme IDs for setTheme().
• Ensuring theme IDs have valid characters.
• Verifying consistency of returned color objects.

How it Connects to the Codebase

This test module directly interacts with the ThemeManager class (src/themes/theme-manager.ts). Every test case involves calling one or more methods of ThemeManager and asserting their behavior. It serves as a critical component for maintaining the stability and correctness of the application's theming system. Developers contributing to the ThemeManager or related theme definitions should refer to these tests to understand expected behavior and to add new tests for any new features or bug fixes.