feat: Check logs against parts of the message only

[paulbalandan]

Description
Currently, CIUnitTestCase::assertLogged() matches the logged message verbatim. For simple messages this is no problem but for complex, hard-to-build, or volatile messages, it may be hard to come up with the exact message. This PR adds the capability for the assertLogged method to compare only parts of the message instead of the whole.

Checklist:

• Securely signed commits
• Component(s) with PHPDoc blocks, only if necessary or adds value
• Unit testing, with >80% coverage
• User guide updated
• Conforms to style guide

[kenjis]

The implementation looks good.

[kenjis]

Something wrong with GA checks.

Some checks were not successful
1 failing and 5 successful checks

[MGatner]

I would lean towards creating a new assertLoggedStrict() or the like, but if you two prefer this I'm good with it.

Edit: the opposite, I suppose! assertLogContains()

[paulbalandan]

I was actually contemplating between a new method and modified method. I'll check what I can do.

[kenjis]

Generally It is better to avoid boolean flag parameter.
I prefer a new method, because it is easier to read.

$this->assertLogged('error', 'variable did not', false); // What's false? Jump to the method.
$this->assertLogContains('error', 'variable did not');

[kenjis]

This is not related to this PR, but why $expectedMessage can be null?

[paulbalandan]

I'm not sure either.

[MGatner]

🤦‍♂️

[kenjis]

$expectedMessage is better? assertLogged() uses it.

[paulbalandan]

My understanding is $expectedMessage is used since the assertion compares the message as expected in the logs.
For assertLogContains, I think it is counter-intuitive to use $expectedMessage when it can only be a part of the whole expected message. I was also thinking whether to use $needle or $needleMessage as alternative name.

[MGatner]

No preference from me

[kenjis]

I am a little uncomfortable with both $needle and $needleMessage.
needle needs haystack.

So let's leave it as it is.