database::testing::backend_expectation Class Reference

Single query expectation with configurable behavior for database_backend. More...

#include <mock_backend_expectations.h>

Collaboration diagram for database::testing::backend_expectation:

Public Member Functions
	backend_expectation ()
backend_expectation &	for_query (const std::string &query, backend_match_type type=backend_match_type::EXACT)
backend_expectation &	for_pattern (const std::string &pattern)
backend_expectation &	for_any ()
backend_expectation &	returning (const core::database_result &result)
backend_expectation &	returning_rows_affected (uint64_t count)
backend_expectation &	returning_error (const std::string &error_message)
backend_expectation &	returning_execute_success ()
backend_expectation &	times (int count)
backend_expectation &	at_least (int count)
backend_expectation &	at_most (int count)
backend_expectation &	once ()
backend_expectation &	never ()
bool	matches (const std::string &query) const
bool	is_satisfied () const
bool	can_be_invoked () const
kcenon::common::Result< core::database_result >	get_select_result ()
kcenon::common::Result< uint64_t >	get_rows_affected ()
kcenon::common::VoidResult	get_execute_result ()
bool	should_error () const
std::string	get_error_message () const

Private Attributes
std::string	query_
backend_match_type	match_type_
std::regex	pattern_
std::optional< core::database_result >	result_
std::optional< uint64_t >	rows_affected_
std::optional< std::string >	error_message_
bool	execute_success_
int	min_invocations_
int	max_invocations_
int	actual_invocations_

Detailed Description

Single query expectation with configurable behavior for database_backend.

Unlike the legacy expectation class, this one works with Result<T> types for proper error handling.

Definition at line 37 of file mock_backend_expectations.h.

Constructor & Destructor Documentation

backend_expectation()

database::testing::backend_expectation::backend_expectation

(

)

Definition at line 11 of file mock_backend_expectations.cpp.

    : match_type_(backend_match_type::ANY)
    , execute_success_(true)
    , min_invocations_(0)
    , max_invocations_(std::numeric_limits<int>::max())
    , actual_invocations_(0)
{
}

Member Function Documentation

at_least()

backend_expectation & database::testing::backend_expectation::at_least

(

int

count

)

Definition at line 65 of file mock_backend_expectations.cpp.

                                                            {
    min_invocations_ = count;
    return *this;
}

References min_invocations_.

Referenced by database::testing::backend_expectation_builder::any_times().

Here is the caller graph for this function:

at_most()

backend_expectation & database::testing::backend_expectation::at_most

(

int

count

)

Definition at line 70 of file mock_backend_expectations.cpp.

                                                           {
    max_invocations_ = count;
    return *this;
}

References max_invocations_.

can_be_invoked()

bool database::testing::backend_expectation::can_be_invoked

(

)

const

Definition at line 100 of file mock_backend_expectations.cpp.

                                               {
    return actual_invocations_ < max_invocations_;
}

References actual_invocations_, and max_invocations_.

for_any()

backend_expectation & database::testing::backend_expectation::for_any

(

)

Definition at line 33 of file mock_backend_expectations.cpp.

                                                  {
    match_type_ = backend_match_type::ANY;
    return *this;
}

References database::testing::ANY, and match_type_.

Referenced by database::testing::mock_backend::expect_any().

Here is the caller graph for this function:

for_pattern()

backend_expectation & database::testing::backend_expectation::for_pattern

(

const std::string &

pattern

)

Definition at line 29 of file mock_backend_expectations.cpp.

                                                                              {
    return for_query(pattern, backend_match_type::PATTERN);
}

References for_query(), and database::testing::PATTERN.

Referenced by database::testing::mock_backend::expect_pattern().

Here is the call graph for this function:

Here is the caller graph for this function:

for_query()

backend_expectation & database::testing::backend_expectation::for_query	(	const std::string &	query,
		backend_match_type	type = backend_match_type::EXACT )

Definition at line 20 of file mock_backend_expectations.cpp.

                                                                                                   {
    query_ = query;
    match_type_ = type;
    if (type == backend_match_type::PATTERN) {
        pattern_ = std::regex(query);
    }
    return *this;
}

References match_type_, database::testing::PATTERN, pattern_, and query_.

Referenced by database::testing::mock_backend::expect_query(), and for_pattern().

Here is the caller graph for this function:

get_error_message()

std::string database::testing::backend_expectation::get_error_message

(

)

const

Definition at line 132 of file mock_backend_expectations.cpp.

                                                       {
    return error_message_.value_or("");
}

References error_message_.

get_execute_result()

kcenon::common::VoidResult database::testing::backend_expectation::get_execute_result

(

)

Definition at line 120 of file mock_backend_expectations.cpp.

                                                               {
    ++actual_invocations_;
    if (error_message_) {
        return kcenon::common::VoidResult(kcenon::common::error_info{-1, *error_message_});
    }
    return kcenon::common::VoidResult(std::monostate{});
}

References actual_invocations_, and error_message_.

get_rows_affected()

kcenon::common::Result< uint64_t > database::testing::backend_expectation::get_rows_affected

(

)

Definition at line 112 of file mock_backend_expectations.cpp.

                                                                    {
    ++actual_invocations_;
    if (error_message_) {
        return kcenon::common::Result<uint64_t>(kcenon::common::error_info{-1, *error_message_});
    }
    return kcenon::common::Result<uint64_t>::ok(rows_affected_.value_or(0));
}

References actual_invocations_, error_message_, and rows_affected_.

get_select_result()

kcenon::common::Result< core::database_result > database::testing::backend_expectation::get_select_result

(

)

Definition at line 104 of file mock_backend_expectations.cpp.

                                                                               {
    ++actual_invocations_;
    if (error_message_) {
        return kcenon::common::Result<core::database_result>(kcenon::common::error_info{-1, *error_message_});
    }
    return kcenon::common::Result<core::database_result>::ok(result_.value_or(core::database_result{}));
}

References actual_invocations_, error_message_, and result_.

is_satisfied()

bool database::testing::backend_expectation::is_satisfied

(

)

const

Definition at line 96 of file mock_backend_expectations.cpp.

                                             {
    return actual_invocations_ >= min_invocations_;
}

References actual_invocations_, and min_invocations_.

matches()

bool database::testing::backend_expectation::matches

(

const std::string &

query

)

const

Definition at line 83 of file mock_backend_expectations.cpp.

                                                              {
    switch (match_type_) {
        case backend_match_type::EXACT:
            return query == query_;
        case backend_match_type::PATTERN:
            return std::regex_search(query, pattern_);
        case backend_match_type::ANY:
            return true;
        default:
            return false;
    }
}

References database::testing::ANY, database::testing::EXACT, match_type_, database::testing::PATTERN, pattern_, and query_.

never()

backend_expectation & database::testing::backend_expectation::never

(

)

Definition at line 79 of file mock_backend_expectations.cpp.

                                                {
    return times(0);
}

References times().

Here is the call graph for this function:

once()

backend_expectation & database::testing::backend_expectation::once

(

)

Definition at line 75 of file mock_backend_expectations.cpp.

                                               {
    return times(1);
}

References times().

Referenced by database::testing::backend_expectation_builder::once().

Here is the call graph for this function:

Here is the caller graph for this function:

returning()

backend_expectation & database::testing::backend_expectation::returning

(

const core::database_result &

result

)

Definition at line 38 of file mock_backend_expectations.cpp.

                                                                                     {
    result_ = result;
    return *this;
}

References result_.

Referenced by database::testing::backend_expectation_builder::will_return().

Here is the caller graph for this function:

returning_error()

backend_expectation & database::testing::backend_expectation::returning_error

(

const std::string &

error_message

)

Definition at line 48 of file mock_backend_expectations.cpp.

                                                                                        {
    error_message_ = error_message;
    return *this;
}

References error_message_.

Referenced by database::testing::backend_expectation_builder::will_fail().

Here is the caller graph for this function:

returning_execute_success()

backend_expectation & database::testing::backend_expectation::returning_execute_success

(

)

Definition at line 53 of file mock_backend_expectations.cpp.

                                                                    {
    execute_success_ = true;
    error_message_.reset();
    return *this;
}

References error_message_, and execute_success_.

Referenced by database::testing::backend_expectation_builder::will_succeed().

Here is the caller graph for this function:

returning_rows_affected()

backend_expectation & database::testing::backend_expectation::returning_rows_affected

(

uint64_t

count

)

Definition at line 43 of file mock_backend_expectations.cpp.

                                                                                {
    rows_affected_ = count;
    return *this;
}

References rows_affected_.

Referenced by database::testing::backend_expectation_builder::will_return_rows().

Here is the caller graph for this function:

should_error()

bool database::testing::backend_expectation::should_error

(

)

const

Definition at line 128 of file mock_backend_expectations.cpp.

                                             {
    return error_message_.has_value();
}

References error_message_.

times()

backend_expectation & database::testing::backend_expectation::times

(

int

count

)

Definition at line 59 of file mock_backend_expectations.cpp.

                                                         {
    min_invocations_ = count;
    max_invocations_ = count;
    return *this;
}

References max_invocations_, and min_invocations_.

Referenced by never(), once(), and database::testing::backend_expectation_builder::times().

Here is the caller graph for this function:

Member Data Documentation

actual_invocations_

int database::testing::backend_expectation::actual_invocations_

private

Definition at line 85 of file mock_backend_expectations.h.

Referenced by can_be_invoked(), get_execute_result(), get_rows_affected(), get_select_result(), and is_satisfied().

error_message_

std::optional<std::string> database::testing::backend_expectation::error_message_

private

Definition at line 80 of file mock_backend_expectations.h.

Referenced by get_error_message(), get_execute_result(), get_rows_affected(), get_select_result(), returning_error(), returning_execute_success(), and should_error().

execute_success_

bool database::testing::backend_expectation::execute_success_

private

Definition at line 81 of file mock_backend_expectations.h.

Referenced by returning_execute_success().

match_type_

backend_match_type database::testing::backend_expectation::match_type_

private

Definition at line 75 of file mock_backend_expectations.h.

Referenced by for_any(), for_query(), and matches().

max_invocations_

int database::testing::backend_expectation::max_invocations_

private

Definition at line 84 of file mock_backend_expectations.h.

Referenced by at_most(), can_be_invoked(), and times().

min_invocations_

int database::testing::backend_expectation::min_invocations_

private

Definition at line 83 of file mock_backend_expectations.h.

Referenced by at_least(), is_satisfied(), and times().

pattern_

std::regex database::testing::backend_expectation::pattern_

private

Definition at line 76 of file mock_backend_expectations.h.

Referenced by for_query(), and matches().

query_

std::string database::testing::backend_expectation::query_

private

Definition at line 74 of file mock_backend_expectations.h.

Referenced by for_query(), and matches().

result_

std::optional<core::database_result> database::testing::backend_expectation::result_

private

Definition at line 78 of file mock_backend_expectations.h.

Referenced by get_select_result(), and returning().

rows_affected_

std::optional<uint64_t> database::testing::backend_expectation::rows_affected_

private

Definition at line 79 of file mock_backend_expectations.h.

Referenced by get_rows_affected(), and returning_rows_affected().

---

The documentation for this class was generated from the following files:

• tests/mocks/mock_backend_expectations.h
• tests/mocks/mock_backend_expectations.cpp