Feature/impl factory pattern repos

[takahiromitsui]

Tasks

• Analysed existing features (ref: README-feature/existing-features.md).
• Tested existing codes (ref: README-feature/existing-features.md).
• Implemented repository patterns (ref: README-feature/impl-repository_pattern.md).
• Implemented factory pattern on the repositories (ref: README-feature/impl-factory_pattern_repos.md).

Description

Before implementing event-driven architecture on the backend, I have taken four steps to improve existing codes. I branched off the main branch and created four branches for each step.

This merge request includes four steps/branches (1. feature/analysis-existing-fatures => 2. feature/tests-existing-code => 3. feature/impl-repository_pattern => 4. feature/impl-factory_pattern_repos).

I also created README files as a feature on each branch with the same name as the branch name.

Please refer to the README files for review.

Testing

I also wrote unit tests and e2e tests. For unit testing, I used SQLite and tests can be run by pytest command to specify tests/unit dir. For e2e unit testing, you need to pass DB_ENV= testing and other parameters (ref: env.example file)
and create a testing database on PostgreSQL.

Caution

I exempt e2e tests(tests/e2e and tests/api/versions) from CI/CD pipeline. The reason is that I set up local PostgreSQL to test API endpoints, whereas tests/api/versions(old ones) use a Remote database. My e2e tests have insertion and clean-up functions to the database; therefore, the testing can delete/clean up tables from the remote database. Hence, I took a different approach.

Suggestion

tests/api checks remote database. I'm unsure if it is set up for a testing or production database. If we use a production database, I suggest testing a testing database. Or, it might be better to test a local database since the testing process for a remote database takes a lot of time.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

0.0% Coverage
0.0% Duplication