#include "lib/test/event-log.hpp"

Description

ongoing evaluation and match within an [EventLog].

Remarks: an EventMatch object is returned when building query expression to verify the occurrence of some events within the EventLog. This "matcher" object implements the query logic with backtracking. The query expressions are added as filter functors to a filtering iterator; when all of the log's contents are filtered away, the evaluation counts as failed.

Definition at line 120 of file event-log.hpp.

Public Member Functions
	operator bool () const
	final evaluation of the match query, usually triggered from the unit test `CHECK()`.

EventMatch &	locate (string match)
	basic search function: continue linear lookup over the elements of the EventLog to find a match (substring match) of the given text.

EventMatch &	locateMatch (string regExp)
	basic search like locate() but with the given regular expression

EventMatch &	locateEvent (string match)
	basic search for a matching "event"

EventMatch &	locateEvent (string classifier, string match)

EventMatch &	locateCall (string match)
	basic search for some specific function invocation

EventMatch &	before (string match)
	find a match (substring match) of the given text in an EventLog entry after the current position

EventMatch &	beforeMatch (string regExp)
	find a match with the given regular expression

EventMatch &	beforeEvent (string match)
	find a match for an "event" after the current point of reference

EventMatch &	beforeEvent (string classifier, string match)

EventMatch &	beforeCall (string match)
	find a match for some function invocation after the current point of reference

EventMatch &	after (string match)
	find a match (substring match) of the given text in an EventLog entry before the current position, switching to backwards search direction

EventMatch &	afterMatch (string regExp)

EventMatch &	afterEvent (string match)

EventMatch &	afterEvent (string classifier, string match)

EventMatch &	afterCall (string match)
	find a function invocation backwards, before the current point of reference

template<typename... ARGS>
EventMatch &	arg (ARGS const &...args)
	refine filter to additionally require specific arguments

template<typename... ARGS>
EventMatch &	argMatch (ARGS const &...regExps)
	refine filter to additionally cover all arguments with a series of regular expressions.

template<typename ARG >
EventMatch &	argPos (size_t idx, ARG const &arg)
	refine filter to additionally require match on a specific positional argument

EventMatch &	type (string typeID)
	refine filter to additionally require a matching log entry type

EventMatch &	key (string key)
	refine filter to additionally require the presence an attribute

EventMatch &	attrib (string key, string valueMatch)
	refine filter to additionally match on a specific attribute

EventMatch &	id (string classifier)
	refine filter to additionally match on the ID attribute

EventMatch &	on (string targetID)
	refine filter to additionally match the ‘'this’` attribute

EventMatch &	on (CStr targetID)

template<typename X >
EventMatch &	on (const X *const targetObj)

Friends
class	EventLog

Private Types
using	Filter = decltype(buildSearchFilter(std::declval< Log const & >()))

using	ArgSeq = lib::diff::RecordSetup< string >::Storage

using	RExSeq = std::vector< std::regex >

Private Member Functions
	EventMatch (Log const &srcSeq)

bool	foundSolution ()
	core of the evaluation machinery: apply a filter predicate and then pull through the log to find a acceptable entry

void	evaluateQuery (string matchSpec, Literal rel="after")
	this is actually called after each refinement of the filter and matching conditions.

void	refineSerach_matchArgument (size_t idx, string match)

void	refineSerach_matchArguments (ArgSeq &&argSeq)

void	refineSerach_matchArgsRegExp (RExSeq &&regExpSeq, string rendered_regExps)

Private Attributes
Filter	solution_
	match predicate evaluator

string	lastMatch_
	record last match for diagnostics

bool	look_for_match_
	support for positive and negative queries.

string	violation_
	record when the underlying query has failed

Constructor & Destructor Documentation

◆ EventMatch()

EventMatch ( Log const & srcSeq )

private

for creating EventLog matchers

Definition at line 258 of file event-log.cpp.

Member Typedef Documentation

◆ Filter

using Filter = decltype( buildSearchFilter (std::declval<Log const&>()) )

private

Definition at line 122 of file event-log.hpp.

◆ ArgSeq

using ArgSeq = lib::diff::RecordSetup<string>::Storage

private

Definition at line 124 of file event-log.hpp.

◆ RExSeq

using RExSeq = std::vector<std::regex>

private

Definition at line 125 of file event-log.hpp.

Member Function Documentation

◆ operator bool()

operator bool ( ) const

inline

final evaluation of the match query, usually triggered from the unit test CHECK().

Note: failure cause is printed to STDERR.

Definition at line 153 of file event-log.hpp.

References util::isnil(), and EventMatch::violation_.

Here is the call graph for this function:

◆ locate()

EventMatch & locate ( string match )

basic search function: continue linear lookup over the elements of the EventLog to find a match (substring match) of the given text.

The search begins at the current position and proceeds in the currently configured direction. Initially the search starts at the first record and proceeds forward.

Definition at line 321 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by EventLog::ensureNot(), EventLog::verify(), and EventLog_test::verify_backwardMatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ locateMatch()

EventMatch & locateMatch ( string regExp )

basic search like locate() but with the given regular expression

Definition at line 332 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by EventLog::verifyMatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ locateEvent() [1/2]

EventMatch & locateEvent ( string match )

basic search for a matching "event"

Parameters

match perform a substring match against the arguments of the event

See also: beforeEvent() for a description of possible "events"

Definition at line 345 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by EventLog::verifyEvent(), and EventLog::verifyEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ locateEvent() [2/2]

EventMatch & locateEvent	(	string	classifier,
		string	match
	)

Definition at line 353 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Here is the call graph for this function:

◆ locateCall()

EventMatch & locateCall ( string match )

basic search for some specific function invocation

Parameters

match perform a substring match against the name of the function invoked

Definition at line 365 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by ActivityDetector::ensureNoInvocation(), and EventLog::verifyCall().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ before()

EventMatch & before ( string match )

find a match (substring match) of the given text in an EventLog entry after the current position

Remarks: the name of this junctor might seem counter intuitive; it was chosen due to expected DSL usage: log.verify("α").before("β"). Operationally this means first to find a Record matching the substring "α" and then to forward from this point until hitting a record to match "β".

Definition at line 384 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by TestTracking_test::demonstrate_checkAllocator(), TreeMutatorBinding_test::mutateDummy(), AbstractTangible_test::notify(), EventLog_test::verify_backwardMatch(), EventLog_test::verify_callLogging(), EventLog_test::verify_eventLogging(), EventLog_test::verify_genericLogging(), EventLog_test::verify_logJoining(), AbstractTangible_test::verify_mockManipulation(), EventLog_test::verify_negatedMatch(), EventLog_test::verify_regExpMatch(), and EventLog_test::verify_simpleUsage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beforeMatch()

EventMatch & beforeMatch ( string regExp )

find a match with the given regular expression

Definition at line 395 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by EventLog_test::verify_regExpMatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beforeEvent() [1/2]

EventMatch & beforeEvent ( string match )

find a match for an "event" after the current point of reference

Remarks

the term "event" designates several types of entries, which typically capture something happening within the observed entity. Especially, the following record types qualify as event:

event
error
create
destroy
logJoin

Parameters

match perform a substring match against the arguments of the event

See also: ::findEvent

Definition at line 417 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by BusTerm_test::attachNewBusTerm(), ActivityMatch::beforeSeqIncrement(), TestTracking_test::demonstrate_checkAllocator(), TestTracking_test::demonstrate_logObject(), AbstractTangible_test::markState(), AbstractTangible_test::mutate(), TreeMutatorBinding_test::mutateDummy(), AbstractTangible_test::revealer(), LateBindInstance_test::verify_forwarding(), EventLog_test::verify_genericLogging(), AbstractTangible_test::verify_mockManipulation(), Nexus::wasInvoked(), and Nexus::wasInvoked().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beforeEvent() [2/2]

EventMatch & beforeEvent	(	string	classifier,
		string	match
	)

Definition at line 425 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Here is the call graph for this function:

◆ beforeCall()

EventMatch & beforeCall ( string match )

find a match for some function invocation after the current point of reference

Parameters

match perform a substring match against the name of the function invoked

See also: ::findCall

Definition at line 438 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by BusTerm_test::attachNewBusTerm(), TestTracking_test::demonstrate_checkAllocator(), TestTracking_test::demonstrate_logObject(), AbstractTangible_test::markState(), AbstractTangible_test::mutate(), BusTerm_test::pushDiff(), AbstractTangible_test::revealer(), EventLog_test::verify_eventLogging(), LateBindInstance_test::verify_forwarding(), AbstractTangible_test::verify_mockManipulation(), Nexus::wasBound(), Nexus::wasInvoked(), and Nexus::wasInvoked().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ after()

EventMatch & after ( string match )

find a match (substring match) of the given text in an EventLog entry before the current position, switching to backwards search direction

Definition at line 454 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by TreeMutatorBinding_test::mutateDummy(), EventLog_test::verify_backwardMatch(), EventLog_test::verify_callLogging(), EventLog_test::verify_eventLogging(), EventLog_test::verify_logJoining(), EventLog_test::verify_logPurging(), EventLog_test::verify_negatedMatch(), and EventLog_test::verify_regExpMatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterMatch()

EventMatch & afterMatch ( string regExp )

Definition at line 462 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by EventLog_test::verify_regExpMatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterEvent() [1/2]

EventMatch & afterEvent ( string match )

Definition at line 470 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by ActivityMatch::afterSeqIncrement(), BusTerm_test::attachNewBusTerm(), AbstractTangible_test::markState(), AbstractTangible_test::revealer(), and LateBindInstance_test::verify_forwarding().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterEvent() [2/2]

EventMatch & afterEvent	(	string	classifier,
		string	match
	)

Definition at line 478 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Here is the call graph for this function:

◆ afterCall()

EventMatch & afterCall ( string match )

find a function invocation backwards, before the current point of reference

Definition at line 489 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by AbstractTangible_test::revealer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ arg()

template<typename... ARGS>

EventMatch & arg ( ARGS const &... args )

inline

refine filter to additionally require specific arguments

Remarks: the refined filter works on each record qualified by the query expression established thus far; it additionally looks into the arguments (children list) of the log entry.

Warning: match is processed by comparison of string representation.

Definition at line 198 of file event-log.hpp.

References EventMatch::refineSerach_matchArguments().

Referenced by EventMatch::argPos(), BusTerm_test::attachNewBusTerm(), TestTracking_test::demonstrate_checkAllocator(), TestTracking_test::demonstrate_logObject(), AbstractTangible_test::markState(), BusTerm_test::pushDiff(), AbstractTangible_test::revealer(), EventLog_test::verify_callLogging(), EventLog_test::verify_eventLogging(), LateBindInstance_test::verify_forwarding(), EventLog_test::verify_genericLogging(), AbstractTangible_test::verify_mockManipulation(), Nexus::wasBound(), Nexus::wasInvoked(), and Nexus::wasInvoked().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ argMatch()

template<typename... ARGS>

EventMatch & argMatch ( ARGS const &... regExps )

inline

refine filter to additionally cover all arguments with a series of regular expressions.

Note: For this match to succeed, any arguments of the log entry must be covered by applying the given regular expressions consecutively. Each regular expression is applied to further arguments, as long as it matches. It is possible to have just one RegExp to "rule them all", but as soon as there is one argument, that can not be covered by the next RegExp, the whole match counts as failed.

Definition at line 217 of file event-log.hpp.

References util::join(), and EventMatch::refineSerach_matchArgsRegExp().

Referenced by EventLog_test::verify_regExpMatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ argPos()

template<typename ARG >

EventMatch & argPos	(	size_t	idx,
		ARG const &	arg
	)

inline

refine filter to additionally require match on a specific positional argument

Definition at line 227 of file event-log.hpp.

References EventMatch::arg(), EventMatch::refineSerach_matchArgument(), and util::toString().

Referenced by TestTracking_test::demonstrate_checkAllocator(), and EventLog_test::verify_callLogging().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ type()

EventMatch & type ( string typeID )

refine filter to additionally require a matching log entry type

Definition at line 539 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by EventLog_test::verify_genericLogging(), EventLog_test::verify_logPurging(), MockElm::verifyMark(), MockElm::verifyMark(), and MockElm::verifyMark().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ key()

EventMatch & key ( string key )

refine filter to additionally require the presence an attribute

Definition at line 550 of file event-log.cpp.

References EventMatch::evaluateQuery(), EventMatch::key(), and EventMatch::solution_.

Referenced by EventMatch::attrib(), and EventMatch::key().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ attrib()

EventMatch & attrib	(	string	key,
		string	valueMatch
	)

refine filter to additionally match on a specific attribute

Definition at line 561 of file event-log.cpp.

References EventMatch::evaluateQuery(), EventMatch::key(), and EventMatch::solution_.

Referenced by ActivityMatch::seq(), and EventLog_test::verify_genericLogging().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ id()

EventMatch & id ( string classifier )

refine filter to additionally match on the ID attribute

Definition at line 572 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by EventLog_test::verify_eventLogging(), MockElm::verifyMark(), MockElm::verifyMark(), and MockElm::verifyMark().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ on() [1/3]

EventMatch & on ( string targetID )

refine filter to additionally match the ‘'this’` attribute

Definition at line 583 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by BusTerm_test::attachNewBusTerm(), TestTracking_test::demonstrate_checkAllocator(), TestTracking_test::demonstrate_logObject(), AbstractTangible_test::mutate(), EventMatch::on(), EventLog_test::verify_callLogging(), EventLog_test::verify_eventLogging(), EventLog_test::verify_logPurging(), AbstractTangible_test::verify_mockManipulation(), Nexus::wasBound(), Nexus::wasInvoked(), and Nexus::wasInvoked().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ on() [2/3]

EventMatch & on ( CStr targetID )

Definition at line 591 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Here is the call graph for this function:

◆ on() [3/3]

template<typename X >

EventMatch & on ( const X *const targetObj )

inline

Definition at line 244 of file event-log.hpp.

References lib::idi::instanceTypeID(), and EventMatch::on().

Here is the call graph for this function:

◆ foundSolution()

bool foundSolution ( )

private

core of the evaluation machinery: apply a filter predicate and then pull through the log to find a acceptable entry

Definition at line 272 of file event-log.cpp.

References EventMatch::solution_.

Referenced by EventMatch::evaluateQuery().

Here is the caller graph for this function:

◆ evaluateQuery()

void evaluateQuery	(	string	matchSpec,
		Literal	rel = `"after"`
	)

private

this is actually called after each refinement of the filter and matching conditions.

The effect is to search for an (intermediary) solution right away and to mark failure as soon as some condition can not be satisfied. Rationale is to indicate the point where a chained match fails

See also: operator bool() for extracting the result

Parameters

matchSpec	diagnostics description of the predicate just being added
rel	indication of the searching relation / direction

Definition at line 288 of file event-log.cpp.

References EventMatch::foundSolution(), EventMatch::lastMatch_, EventMatch::look_for_match_, EventMatch::solution_, and EventMatch::violation_.

Referenced by EventMatch::after(), EventMatch::afterCall(), EventMatch::afterEvent(), EventMatch::afterEvent(), EventMatch::afterMatch(), EventMatch::attrib(), EventMatch::before(), EventMatch::beforeCall(), EventMatch::beforeEvent(), EventMatch::beforeEvent(), EventMatch::beforeMatch(), EventMatch::id(), EventMatch::key(), EventMatch::locate(), EventMatch::locateCall(), EventMatch::locateEvent(), EventMatch::locateEvent(), EventMatch::locateMatch(), EventMatch::on(), EventMatch::on(), EventMatch::refineSerach_matchArgsRegExp(), EventMatch::refineSerach_matchArgument(), EventMatch::refineSerach_matchArguments(), and EventMatch::type().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refineSerach_matchArgument()

void refineSerach_matchArgument	(	size_t	idx,
		string	match
	)

private

refine filter condition additionally to match a specific positional call argument.

Definition at line 502 of file event-log.cpp.

References EventMatch::evaluateQuery(), EventMatch::solution_, and util::toString().

Referenced by EventMatch::argPos().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refineSerach_matchArguments()

void refineSerach_matchArguments ( ArgSeq && argSeq )

private

refine filter condition additionally to match a sequence of call arguments.

Definition at line 512 of file event-log.cpp.

References EventMatch::evaluateQuery(), util::join(), and EventMatch::solution_.

Referenced by EventMatch::arg().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refineSerach_matchArgsRegExp()

void refineSerach_matchArgsRegExp	(	RExSeq &&	regExpSeq,
		string	rendered_regExps
	)

private

refine filter condition additionally to cover call arguments by a sequence of regular expressions. Each regExp is used consecutively, until it fails to match; at that point, the next regExp is tried. When reaching the end of the argument sequence, we also expect to have used up all available regular expressions.

Definition at line 527 of file event-log.cpp.

References EventMatch::evaluateQuery(), and EventMatch::solution_.

Referenced by EventMatch::argMatch().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ solution_

Filter solution_

private

◆ lastMatch_

string lastMatch_

private

record last match for diagnostics

Definition at line 132 of file event-log.hpp.

Referenced by EventMatch::evaluateQuery().

◆ look_for_match_

bool look_for_match_

private

support for positive and negative queries.

Definition at line 135 of file event-log.hpp.

Referenced by EventLog::ensureNot(), and EventMatch::evaluateQuery().

◆ violation_

string violation_

private

record when the underlying query has failed

Definition at line 138 of file event-log.hpp.

Referenced by EventMatch::evaluateQuery(), and EventMatch::operator bool().

Friends And Related Symbol Documentation

◆ EventLog

friend class EventLog

friend

Definition at line 145 of file event-log.hpp.

Inheritance diagram for EventMatch:

Collaboration diagram for EventMatch:

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

Description

Public Member Functions

Friends

Private Types

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ EventMatch()

Member Typedef Documentation

◆ Filter

◆ ArgSeq

◆ RExSeq

Member Function Documentation

◆ operator bool()

◆ locate()

◆ locateMatch()

◆ locateEvent() [1/2]

◆ locateEvent() [2/2]

◆ locateCall()

◆ before()

◆ beforeMatch()

◆ beforeEvent() [1/2]

◆ beforeEvent() [2/2]

◆ beforeCall()

◆ after()

◆ afterMatch()

◆ afterEvent() [1/2]

◆ afterEvent() [2/2]

◆ afterCall()

◆ arg()

◆ argMatch()

◆ argPos()

◆ type()

◆ key()

◆ attrib()

◆ id()

◆ on() [1/3]

◆ on() [2/3]

◆ on() [3/3]

◆ foundSolution()

◆ evaluateQuery()

◆ refineSerach_matchArgument()

◆ refineSerach_matchArguments()

◆ refineSerach_matchArgsRegExp()

Member Data Documentation

◆ solution_

◆ lastMatch_

◆ look_for_match_

◆ violation_

Friends And Related Symbol Documentation

◆ EventLog