created a test class header for database api

[nedvedba]

Summary by Sourcery

Introduce a TestDatabaseAPI class to facilitate testing of database interactions and modify access specifiers in DatabaseAPI to support subclassing.

New Features:

• Introduce a new TestDatabaseAPI class for testing purposes, providing methods for database interactions such as dbGet and dbPost.

Enhancements:

• Change the access specifier of dbGet and dbPost methods in DatabaseAPI from private to protected to allow subclass access.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR introduces a new test class header for the DatabaseAPI and modifies the access level of some DatabaseAPI methods to support testing. The implementation creates a new TestDatabaseAPI class that will be used for testing database operations, and changes the access modifiers in the original DatabaseAPI class to allow the test class to access necessary methods.

Class diagram for DatabaseAPI and TestDatabaseAPI

classDiagram
    class DatabaseAPI {
        +metricsPurge(uint32_t a_timestamp, LogContext)
        #dbGet(const char *a_url_path, const std::vector<std::pair<std::string, std::string>> &a_params, libjson::Value &a_result, LogContext, bool a_log = true)
        #dbPost(const char *a_url_path, const std::vector<std::pair<std::string, std::string>> &a_params, const std::string *a_body, libjson::Value &a_result, LogContext)
        -setAuthStatus(Anon::AuthStatusReply &a_reply, const libjson::Value &a_result)
        -setUserData(Auth::UserDataReply &a_reply, const libjson::Value &a_result)
    }

    class TestDatabaseAPI {
        +TestDatabaseAPI(const std::string &a_db_url, const std::string &a_db_user, const std::string &a_db_pass)
        +~TestDatabaseAPI()
        +dbGet(const char *a_url_path, const std::vector<std::pair<std::string, std::string>> &a_params, libjson::Value &a_result, LogContext, bool a_log = true)
        +dbGetRaw(const char *a_url_path, const std::vector<std::pair<std::string, std::string>> &a_params, std::string &a_result)
        +dbPost(const char *a_url_path, const std::vector<std::pair<std::string, std::string>> &a_params, const std::string *a_body, libjson::Value &a_result, LogContext)
    }

    TestDatabaseAPI --> DatabaseAPI

Loading

File-Level Changes

Change	Details	Files
Modified access modifiers in DatabaseAPI class to support testing	Changed access level of database operation methods from private to protected Moved authentication-related methods to private section	core/server/DatabaseAPI.hpp
Created new TestDatabaseAPI class header	Defined class structure with constructor and destructor Added database operation methods matching the protected methods from DatabaseAPI Included necessary header files and namespace declarations	core/server/TestDatabaseAPI.hpp

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @nedvedba - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider using inheritance instead of duplicating the database access methods. TestDatabaseAPI should extend DatabaseAPI if you need to override behavior for testing.
• Rather than modifying access levels and duplicating code, consider using dependency injection and a mocking framework for testing. This would maintain better encapsulation and reduce code duplication.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion: Consider having TestDatabaseAPI inherit from DatabaseAPI to avoid code duplication

The database access methods are currently duplicated between DatabaseAPI and TestDatabaseAPI. Since these methods are now protected in DatabaseAPI, you could inherit from it and override only the methods that need different behavior for testing.

class TestDatabaseAPI : public DatabaseAPI {

[JoshuaSBrown]

@par-hermes format

[JoshuaSBrown]

Just get unit test working .