Repository navigation
Add missing test infrastructure and comprehensive test suite #13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d6d1cc6
Initial plan
Copilot 65262c6
Add test infrastructure and initial tests
Copilot 2125042
Update src/tests/bigHelpers.test.ts
frouaix 051fcd4
Update TESTING.md to use pnpm and clarify test status
Copilot 06c222e
Add comprehensive test coverage for all bigHelpers functions
Copilot 71f4580
Merge branch 'main' into copilot/add-tests-directory
frouaix 2c8ee37
Merge branch 'main' into copilot/add-tests-directory
frouaix File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| # Testing Guide | ||
|
|
||
| ## Overview | ||
| This repository uses [Vitest](https://vitest.dev/) for unit testing, with React Testing Library for component tests. | ||
|
|
||
| ## Running Tests | ||
|
|
||
| ### Run all tests once | ||
| ```bash | ||
| pnpm test run | ||
| ``` | ||
|
|
||
| ### Run tests in watch mode | ||
| ```bash | ||
| pnpm test | ||
| ``` | ||
|
|
||
| ### Run tests with UI | ||
| ```bash | ||
| pnpm run test:ui | ||
| ``` | ||
|
|
||
| ### Run tests with coverage report | ||
| ```bash | ||
| pnpm run test:coverage | ||
| ``` | ||
|
|
||
| ## Test Structure | ||
|
|
||
| All tests are located in the `src/tests/` directory: | ||
| - `setup.ts` - Test environment setup | ||
| - `*.test.ts` - Unit tests for TypeScript modules | ||
| - `*.test.tsx` - Component tests for React components | ||
|
|
||
| ## Writing Tests | ||
|
|
||
| ### Basic Test Example | ||
| ```typescript | ||
| import { describe, it, expect } from 'vitest'; | ||
| import { functionToTest } from '../lib/module'; | ||
|
|
||
| describe('Module Name', () => { | ||
| describe('functionToTest', () => { | ||
| it('should do something specific', () => { | ||
| const result = functionToTest(input); | ||
| expect(result).toBe(expected); | ||
| }); | ||
| }); | ||
| }); | ||
| ``` | ||
|
|
||
| ### Component Test Example | ||
| ```typescript | ||
| import { describe, it, expect } from 'vitest'; | ||
| import { render, screen } from '@testing-library/react'; | ||
| import { MyComponent } from '../components/MyComponent'; | ||
|
|
||
| describe('MyComponent', () => { | ||
| it('should render correctly', () => { | ||
| render(<MyComponent />); | ||
| expect(screen.getByText('Expected Text')).toBeInTheDocument(); | ||
| }); | ||
| }); | ||
| ``` | ||
|
|
||
| ## Test Coverage | ||
|
|
||
| Run `pnpm run test:coverage` to generate a coverage report. The report will be available in: | ||
| - Console output (text summary) | ||
| - `coverage/index.html` (detailed HTML report) | ||
|
|
||
| ## Current Test Status | ||
|
|
||
| The test infrastructure is now in place with initial tests for the `bigHelpers` module (18 tests). Additional test coverage for other modules needs to be added. The testing framework and conventions are established to facilitate adding comprehensive tests across the codebase. | ||
|
|
||
| ## Adding New Tests | ||
|
|
||
| 1. Create a new file in `src/tests/` with the naming pattern `*.test.ts` or `*.test.tsx` | ||
| 2. Import the necessary testing utilities from vitest | ||
| 3. Write your test cases following the existing patterns | ||
| 4. Run tests to ensure they pass | ||
|
|
||
| ## Best Practices | ||
|
|
||
| - Write descriptive test names that explain what is being tested | ||
| - Use `describe` blocks to group related tests | ||
| - Test edge cases and error conditions | ||
| - Keep tests focused and independent | ||
| - Use meaningful assertions | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.