GitAuto: [FEATURE] Implement Database wrapper

[gitauto-ai]

Original issue: #83

What is the feature

The feature is to implement a Database wrapper that abstracts the underlying database operations, providing a simplified and consistent interface for interacting with the database.

Why we need the feature

A Database wrapper is essential for maintaining clean and maintainable code. It allows developers to interact with the database without needing to know the specifics of the database implementation. This abstraction layer can help in reducing code duplication, improving testability, and making it easier to switch database engines if needed.

How to implement and why

1. Define the Interface:

   • Create an interface that outlines the basic operations needed (e.g., connect, disconnect, executeQuery, fetchResults).
   • This ensures that any database implementation adheres to a consistent contract.

2. Implement the Wrapper Class:

   • Develop a class that implements the defined interface.
   • Use a popular database library (e.g., SQLAlchemy for Python, PDO for PHP) to handle the actual database operations.
   • Ensure that the class handles connection pooling, error handling, and transaction management.

3. Add Configuration Management:

   • Allow the wrapper to accept configuration parameters (e.g., database type, host, port, credentials) to support different environments.
   • Use environment variables or configuration files to manage these settings.

4. Write Unit Tests:

   • Develop unit tests to ensure that the wrapper behaves as expected.
   • Mock the database operations to test the wrapper independently of the actual database.

5. Documentation:

   • Update the project documentation to include usage examples and configuration instructions for the Database wrapper.

About backward compatibility

The implementation of the Database wrapper should maintain backward compatibility by ensuring that existing code can still interact with the database through the new wrapper without requiring changes. This can be achieved by providing the same method signatures and expected behaviors as the current database interaction code.

Test these changes locally

git checkout -b gitauto/issue-#83-2bdc6d36-b3f0-4ec0-ab17-f46887c159b3
git pull origin gitauto/issue-#83-2bdc6d36-b3f0-4ec0-ab17-f46887c159b3

[deepsource-io]

Here's the code health analysis summary for commits 3ee8b2e..c231a1b. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Test coverage	✅ Success		View Check ↗
SQL	✅ Success		View Check ↗
Secrets	✅ Success		View Check ↗
PHP	✅ Success		View Check ↗
Docker	✅ Success		View Check ↗

Code Coverage Report

Metric	Aggregate	Php
Branch Coverage	100%	100%
Composite Coverage	95.8%	95.8%
Line Coverage	95.8%	95.8%

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00% (target: -1.00%)	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (3ee8b2e)	236	226	95.76%
Head commit (c231a1b)	236 (+0)	226 (+0)	95.76% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#205)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.65%. Comparing base (3ee8b2e) to head (c231a1b).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #205   +/-   ##
=======================================
  Coverage   95.65%   95.65%           
=======================================
  Files           8        8           
  Lines         230      230           
=======================================
  Hits          220      220           
  Misses         10       10           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

Infisical secrets check: ✅ No secrets leaked!

Scan results:

11:29PM INF scanning for exposed secrets...
11:29PM INF 148 commits scanned.
11:29PM INF scan completed in 423ms
11:29PM INF no leaks found

[sonarcloud]

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud