MockHelpService.hxx

Go to the documentation of this file.

#pragma once
 
#include <string>
#include <vector>
#include <map>
#include <set>
#include <functional>
#include <memory>
#include "MockSubject.hxx"
#include "../../../services/Event.hxx"

 * верификации для модульных тестов CLI команд.
 */
namespace svcs::test::cli::mocks {
 
using svcs::services::Event;

class MockHelpService {
private:
    std::vector<std::string> availableCommands_;

     * @brief Storage for pre-configured command descriptions.
     *
     * @russian
     * @brief Хранилище для предварительно настроенных описаний команд.
     */
    std::map<std::string, std::string> commandDescriptions_;

     * @russian
     * @brief Записывает имена команд, для которых была запрошена справка через showCommandHelp.
     */
    std::set<std::string> calledCommandHelp_;

     * @brief Mock шина событий, используемая для опционального отладочного вывода.
     */
    std::shared_ptr<MockSubject> mockEventBus_;


    bool wasGeneralHelpCalled_ = false;
 
public:
    /**
     * @english
     * @brief Constructor for MockHelpService.
     * @param mockEventBus The shared pointer to the MockSubject used for notifications.
     *
     * @russian
     * @brief Конструктор для MockHelpService.
     * @param mockEventBus Общий указатель на MockSubject, используемый для уведомлений.
     */
    explicit MockHelpService(const std::shared_ptr<MockSubject>& mockEventBus)
        : mockEventBus_(mockEventBus) {
    }
 
    // --- Mock Methods Matching HelpService Interface ---

     * @brief Returns the pre-configured list of available commands.
     * @return A vector of command names.
     *
     * @russian
     * @brief Возвращает предварительно настроенный список доступных команд.
     * @return Вектор имен команд.
     */
    [[nodiscard]] std::vector<std::string> getAvailableCommands() const {
        return availableCommands_;
    }


     * @param commandName Имя команды.
     * @return Настроенное описание или "No description available", если не установлено.
     */
    [[nodiscard]] std::string getCommandDescription(const std::string& commandName) const {
        auto it = commandDescriptions_.find(commandName);
        if (it != commandDescriptions_.end()) {
            return it->second;
        }
        return "No description available";
    }


     * @param commandName Имя команды, для которой запрашивается справка.
     */
    void showCommandHelp(const std::string& commandName) {
        calledCommandHelp_.insert(commandName);
        if (mockEventBus_) {
            // Создаем объект Event правильно - используем поле details
            Event event;
            event.type = Event::DEBUG_MESSAGE;
            event.details = "MockHelpService: Showing help for " + commandName;
            event.source_name = "help";
            mockEventBus_->notify(event);
        }
    }

     * @details Also emits a debug message to the mock event bus.
     *
     * @russian
     * @brief Записывает, что была запрошена общая справка.
     * @details Также отправляет отладочное сообщение в mock шину событий.
     */
    void showGeneralHelp() {
        wasGeneralHelpCalled_ = true;
        if (mockEventBus_) {
            // Создаем объект Event правильно - используем поле details
            Event event;
            event.type = Event::DEBUG_MESSAGE;
            event.details = "MockHelpService: Showing general help";
            event.source_name = "help";
            mockEventBus_->notify(event);
        }
    }
 
    // --- Test Control Methods ---

    void setAvailableCommands(const std::vector<std::string>& commands) {
        availableCommands_ = commands;
    }

    void setCommandDescription(const std::string& commandName, const std::string& description) {
        commandDescriptions_[commandName] = description;
    }

    [[nodiscard]] bool wasCommandHelpCalled(const std::string& commandName) const {
        return calledCommandHelp_.find(commandName) != calledCommandHelp_.end();
    }

    [[nodiscard]] bool wasGeneralHelpCalled() const {
        return wasGeneralHelpCalled_;
    }

    void clear() {
        calledCommandHelp_.clear();
        availableCommands_.clear();
        commandDescriptions_.clear();
        wasGeneralHelpCalled_ = false;
    }
};
 
} // namespace svcs::test::cli::mocks