View Javadoc
1   /*
2    * SPDX-FileCopyrightText: Copyright (c) 2011-2026 Yegor Bugayenko
3    * SPDX-License-Identifier: MIT
4    */
5   package com.qulice.checkstyle;
6   
7   import com.qulice.spi.Environment;
8   import com.qulice.spi.Violation;
9   import java.io.File;
10  import java.io.IOException;
11  import java.util.Collection;
12  import org.cactoos.io.ResourceOf;
13  import org.cactoos.text.FormattedText;
14  import org.cactoos.text.IoCheckedText;
15  import org.cactoos.text.TextOf;
16  import org.hamcrest.MatcherAssert;
17  import org.hamcrest.Matchers;
18  import org.junit.jupiter.api.Test;
19  
20  /**
21   * Test case for {@link CheckstyleValidator}'s handling of the
22   * stock {@code CatchParameterName} check.
23   * @since 0.25.1
24   */
25  final class CheckstyleCatchParameterNameTest {
26  
27      @Test
28      @SuppressWarnings("unchecked")
29      void distinguishesValidCatchParameterNames() throws Exception {
30          final String file = "CatchParameterNames.java";
31          final String name = "CatchParameterNameCheck";
32          MatcherAssert.assertThat(
33              "All naming violations should be found",
34              this.runValidation(file, false),
35              Matchers.<Iterable<Violation>>allOf(
36                  Matchers.iterableWithSize(3),
37                  Matchers.hasItems(
38                      new ViolationMatcher(
39                          "Name 'ex_invalid_1' must match pattern", file, "27", name
40                      ),
41                      new ViolationMatcher(
42                          "Name '$xxx' must match pattern", file, "29", name
43                      ),
44                      new ViolationMatcher(
45                          "Name '_exp' must match pattern", file, "31", name
46                      )
47                  )
48              )
49          );
50      }
51  
52      private Collection<Violation> runValidation(final String file,
53          final boolean passes) throws IOException {
54          final Environment.Mock mock = new Environment.Mock();
55          final Environment env = mock.withParam(
56              "license",
57              String.format(
58                  "file:%s",
59                  new License().savePackageInfo(
60                      new File(mock.basedir(), "src/main/java/foo")
61                  ).withLines("Hello.")
62                      .withEol(String.valueOf('\n')).file()
63              )
64          ).withFile(
65              String.format("src/main/java/foo/%s", file),
66              new IoCheckedText(
67                  new TextOf(
68                      new ResourceOf(
69                          new FormattedText("com/qulice/checkstyle/%s", file)
70                      )
71                  )
72              ).asString()
73          );
74          final Collection<Violation> results =
75              new CheckstyleValidator(env).validate(env.files(file));
76          MatcherAssert.assertThat(
77              "validation result should match expected state",
78              results.isEmpty(),
79              Matchers.is(passes)
80          );
81          return results;
82      }
83  }