Класс svcs::test::cli::utils::MockHelpService

Mock реализация HelpService для тестирования HelpCommand. Подробнее...

#include <MockHelpService.hxx>

Открытые члены
	MockHelpService (const std::shared_ptr< MockSubject > &mockEventBus)
	Конструктор для MockHelpService.
std::vector< std::string >	getAvailableCommands () const
	Возвращает предварительно настроенный список доступных команд.
std::string	getCommandDescription (const std::string &commandName) const
	Возвращает предварительно настроенное описание для заданной команды.
void	showCommandHelp (const std::string &commandName)
	Записывает, что справка была запрошена для заданной команды.
void	showGeneralHelp ()
	Записывает, что была запрошена общая справка.
void	setAvailableCommands (const std::vector< std::string > &commands)
	Устанавливает список имен команд, возвращаемых getAvailableCommands().
void	setCommandDescription (const std::string &commandName, const std::string &description)
	Настраивает описание для конкретного имени команды.
bool	wasCommandHelpCalled (const std::string &commandName) const
	Проверяет, был ли вызван showCommandHelp() для конкретной команды.
bool	wasGeneralHelpCalled () const
	Проверяет, был ли вызван showGeneralHelp().
void	clear ()
	Сбрасывает внутреннее состояние mock'а (вызванные команды, списки и описания).

Подробное описание

Mock реализация HelpService для тестирования HelpCommand.

Этот mock позволяет тестовым случаям:

1. Настраивать список доступных команд.
2. Настраивать описания для конкретных команд.
3. Проверять, справка какой команды была запрошена HelpCommand.
4. Использовать предоставленный MockSubject для вывода отладочной информации во время тестирования.

Конструктор(ы)

MockHelpService()

svcs::test::cli::mocks::MockHelpService::MockHelpService ( const std::shared_ptr< MockSubject > & mockEventBus )

inlineexplicit

Конструктор для MockHelpService.

Аргументы

mockEventBus

Общий указатель на MockSubject, используемый для уведомлений.

Методы

getAvailableCommands()

std::vector< std::string > svcs::test::cli::mocks::MockHelpService::getAvailableCommands ( ) const

inlinenodiscard

Возвращает предварительно настроенный список доступных команд.

Возвращает

Вектор имен команд.

getCommandDescription()

std::string svcs::test::cli::mocks::MockHelpService::getCommandDescription ( const std::string & commandName ) const

inlinenodiscard

Возвращает предварительно настроенное описание для заданной команды.

Аргументы

commandName

Имя команды.

Возвращает

Настроенное описание или "No description available", если не установлено.

setAvailableCommands()

void svcs::test::cli::mocks::MockHelpService::setAvailableCommands ( const std::vector< std::string > & commands )

inline

Устанавливает список имен команд, возвращаемых getAvailableCommands().

Аргументы

commands

Вектор имен команд.

setCommandDescription()

void svcs::test::cli::mocks::MockHelpService::setCommandDescription ( const std::string & commandName, const std::string & description )

inline

Настраивает описание для конкретного имени команды.

Аргументы

commandName	Имя команды.
description	Описание для возврата для этой команды.

showCommandHelp()

void svcs::test::cli::mocks::MockHelpService::showCommandHelp ( const std::string & commandName )

inline

Записывает, что справка была запрошена для заданной команды.

Также отправляет отладочное сообщение в mock шину событий.

Аргументы

commandName

Имя команды, для которой запрашивается справка.

showGeneralHelp()

void svcs::test::cli::mocks::MockHelpService::showGeneralHelp ( )

inline

Записывает, что была запрошена общая справка.

Также отправляет отладочное сообщение в mock шину событий.

wasCommandHelpCalled()

bool svcs::test::cli::mocks::MockHelpService::wasCommandHelpCalled ( const std::string & commandName ) const

inlinenodiscard

Проверяет, был ли вызван showCommandHelp() для конкретной команды.

Аргументы

commandName

Имя команды для проверки.

Возвращает

true если showCommandHelp() был вызван с этим именем, false в противном случае.

wasGeneralHelpCalled()

bool svcs::test::cli::mocks::MockHelpService::wasGeneralHelpCalled ( ) const

inlinenodiscard

Проверяет, был ли вызван showGeneralHelp().

Возвращает

true если showGeneralHelp() был вызван, false в противном случае.

---

Объявления и описания членов класса находятся в файле:

• tests/cli/mocks/MockHelpService.hxx