Integrate Jest for Unit and Integration Testing

[anasakil]

Objective: To ensure the reliability and quality of our backend codebase, we aim to integrate Jest, a delightful JavaScript Testing Framework with a focus on simplicity, for writing unit and integration tests. This setup will enable us to test individual units of code, as well as the integration points between them, to catch and fix bugs early in the development process.

Tasks:

1. Install Jest and Supertest: Add Jest as our testing framework and Supertest for testing HTTP endpoints.
2. Configure Jest: Set up Jest configuration for Node.js environment and specify test directories and patterns.
3. Write Sample Unit Test: Create a simple unit test for a utility function to demonstrate Jest's syntax and usage.
4. Write Sample Integration Test: Develop a test for an API endpoint using Supertest to showcase how to test HTTP interactions.
5. Setup Test Scripts: Add scripts to package.json for running tests, including a watch mode for development.
6. CI Integration: Configure GitHub Actions workflow to run tests automatically on push and pull requests to ensure code quality.
7. Documentation: Update the README.md with instructions on how to run tests and add test coverage goals.

Acceptance Criteria:

• Jest and Supertest are correctly installed and configured in the project.
• Sample unit and integration tests are created, demonstrating how to write tests with Jest.
• Tests can be easily executed using npm scripts, and test results are clearly reported.
• Continuous Integration setup runs tests automatically for every push and pull request.
• Project documentation includes clear guidelines for running tests and contributing to test coverage.

Deliverables:

• Jest and Supertest configuration files and dependencies added to the project.
• Sample unit and integration tests written for existing code.
• Updated GitHub Actions workflow to include a testing step.
• Documentation updates including testing guidelines.

Notes:

• Focus on testing critical components first, such as authentication, user management, and core business logic.
• Aim for a test coverage goal (e.g., 80%) but prioritize meaningful tests over hitting arbitrary numbers.