Add a warning in case of incorrect syntax of highlighting style.

[awadammar]

Add a warning in case of incorrect syntax of highlighting style (without =).

This PR is related to #issue1545, it meant to ensure that the user is providing a correct syntax for highlighting style.

e.g. %highlight{%5level}{LOGBACK} should be %highlight{%5level}{STYLE=LOGBACK}. For more information see the documentation here.

[awadammar]

@ppkarwasz I wonder If there's a way to check on a specific logged message in one of the unit tests?

[garydgregory]

Better message IMO:
Syntax error, missing '=': Expected "{KEY1=VALUE, KEY2=VALUE, ...}"

[awadammar]

Noted, but I have a question regarding the following code block:

final String string = options[1]
              .replaceAll(PatternParser.DISABLE_ANSI + "=(true|false)", Strings.EMPTY)
              .replaceAll(PatternParser.NO_CONSOLE_NO_ANSI + "=(true|false)", Strings.EMPTY);

To avoid false positive warning messages, aren't we need to replace also the commas with Strings.empty()?
for example: if Options[1] = "noConsoleNoAnsi=false, disableAnsi=false, LOGBACK", string will be ", , LOGBACK".

So I'd suggest to tweak the match pattern to looks like the following:

final String string = options[1]
        .replaceAll(",?" + PatternParser.DISABLE_ANSI + "=(true|false),?", Strings.EMPTY)
        .replaceAll(",?" + PatternParser.NO_CONSOLE_NO_ANSI + "=(true|false),?", Strings.EMPTY)
        .trim();

[ppkarwasz]

@aawad6,

A while back I added a @UsingStatusListener JUnit 5 extensions, which allows you to capture status logger messages into a ListStatusListener:

    @Test
    @UsingStatusListener
    public void testSomething(final ListStatusListener listener) {
        ...
        assertThat(listener.findStatusData(Level.WARN)).hasSize(1);
        ...
    }

Regarding the "disableAnsi" and "noConsoleNoAnsi" keys, we could probably deal with them better. E.g. instead of removing them through a regex, we can add them to the dontEscapeKeys and deal with them in the HighlightConverter constructor.

[ppkarwasz]

Apart from the comment below, it looks good to me.

[vy]

Thanks for the improvement @aawad6, much appreciated! 🙇 Merging it...