feat: Add backend tests and developer documentation #149
Conversation
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
This commit introduces several improvements:
1. **Backend Unit Tests:**
* Added comprehensive unit tests for the `AppUsecase` in `backend/usecase/app.go`.
* Refactored `AppUsecase` and related components to use interfaces for improved dependency injection and testability.
* Mocks for `AppRepository` and `NodeUsecase` were created to facilitate isolated testing.
2. **Developer Documentation:**
* Created a new `DEVELOPERS.md` file in the root directory.
* This file provides an overview of the project architecture, codebase structure, guidance on setting up the development environment, and contribution guidelines.
3. **Frontend Testing (Partial):**
* Initiated the setup of Vitest for the `web/admin` frontend application.
* Added basic tests for some components (e.g., `Header`, `Card`).
* Testing for `UploadFile/Drag.tsx` was attempted but encountered persistent timeouts in the JSDOM environment; these tests have been temporarily skipped.
* Further frontend testing was paused due to broader test environment instability.
This work aims to improve the robustness and maintainability of the backend and make it easier for new developers to contribute to the PandaWiki project.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This commit introduces several improvements:
Backend Unit Tests:
AppUsecaseinbackend/usecase/app.go.AppUsecaseand related components to use interfaces for improved dependency injection and testability.AppRepositoryandNodeUsecasewere created to facilitate isolated testing.Developer Documentation:
DEVELOPERS.mdfile in the root directory.Frontend Testing (Partial):
web/adminfrontend application.Header,Card).UploadFile/Drag.tsxwas attempted but encountered persistent timeouts in the JSDOM environment; these tests have been temporarily skipped.This work aims to improve the robustness and maintainability of the backend and make it easier for new developers to contribute to the PandaWiki project.