Issue #11446: Update SuppressionCommentFilterTest to use verifyWithInlineConfigParser

[Rahulkhinchi03]

Resolves update for SuppressionCommentFilterTest in #11446.

[Rahulkhinchi03]

GitHub, rebase

[Rahulkhinchi03]

GitHub, rebase

[romani]

Items

[romani]

We do not need these parameters

[romani]

e77a62f

[romani]

https://github.com/checkstyle/checkstyle/pull/11465/files

[Rahulkhinchi03]

But we have the verify method in verifySuppressed which uses these 2 parameters like expected violation and suppressed violations

[Rahulkhinchi03]

e77a62f#diff-cf838e5bbdb7de5a3e0e91f9919a389a0fd2ffdbda60c85a3c6dba07dcf69acdR406-R420 only deals with config and file name and when I am using this execute method then we can't use expected and suppressed violation

[Rahulkhinchi03]

    private void verifySuppressed(Configuration moduleConfig, String fileName)
        throws Exception {

        execute(moduleConfig, getPath(fileName));
    }

Like this?

[romani]

Yes

[romani]

New method should be created.

Please do not push your code until mvn verify is passing on local.

[Rahulkhinchi03]

Need Help:

1. I started with creating:

private void verifySuppressed(Configuration moduleConfig, String fileName)
        throws Exception {

        execute(moduleConfig, getPath(fileName));
    }

in the SuppressionCommentFilterTest.java

2. I saw that I should change this verifySuppressed method of 3 parameters with my verifySuppressed method that only takes 2 parameters.

    @Test
    public void testInvalidMessageFormat() throws Exception {
        final DefaultConfiguration filterConfig =
            createModuleConfig(SuppressionCommentFilter.class);
        filterConfig.addProperty("messageFormat", "e[l");

        try {
            final String[] suppressed = CommonUtil.EMPTY_STRING_ARRAY;
            verifySuppressed(filterConfig, "InputSuppressionCommentFilter11.java", suppressed);
            assertWithMessage("Exception is expected").fail();
        }
        catch (CheckstyleException ex) {
            final IllegalArgumentException cause = (IllegalArgumentException) ex.getCause();
            assertWithMessage("Invalid exception message")
                .that(cause)
                .hasMessageThat()
                .isEqualTo("unable to parse expanded comment e[l");
        }
    }

Like this -->

        try {
            verifySuppressed(filterConfig, "InputSuppressionCommentFilter11.java");
            assertWithMessage("Exception is expected").fail();
        }

But now I am getting an error of EXCEPTION IS EXPECTED

PS; I haven't changed the verify() method in verifySuppressed method which takes 4 parameter

[romani]

you updating too much.

you need to remove methods:

-    private void verifySuppressed(Configuration moduleConfig, String fileName,
-            String... aSuppressed)
-            throws Exception {
- 
-    private void verifySuppressed(Configuration moduleConfig, String fileName,
-            String[] expectedViolations, String... suppressedViolations) throws Exception {

and figure out how to upadate test that that used them to execute validation by checkstyle but wihtout comparison with expected violation, as you expect exception.

test has problem with path to file and Input file is over complicated for no reason, so please redo Input file content and have only config for filter and for one Check and in code to have only one violation (no more code in Input file is requied).

time to debug how Checks are working :).

[romani]

Items

[romani]

Method should be "execute" as we do not validate anything, we just run and expect exception

[Rahulkhinchi03]

I have used execute method in the verifySuppressed method which takes 2 parameters.

[romani]

Do not use it inside, use it here.

[romani]

Follow complains from CI

[romani]

@Rahulkhinchi03, ping

[Rahulkhinchi03]

@romani I am currently debugging the code and trying to find the reason for EXCEPTION IS EXPECTED

[Rahulkhinchi03]

@romani I had some issues with this commit so I created a new PR: #11503