View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2026 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package org.checkstyle.suppressionxpathfilter.modules;
21  
22  import java.io.File;
23  import java.util.Collections;
24  import java.util.List;
25  
26  import org.checkstyle.suppressionxpathfilter.AbstractXpathTestSupport;
27  import org.junit.jupiter.api.Test;
28  
29  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
30  import com.puppycrawl.tools.checkstyle.checks.modules.ModuleDirectiveOrderCheck;
31  
32  public class XpathRegressionModuleDirectiveOrderTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = ModuleDirectiveOrderCheck.class.getSimpleName();
35  
36      @Override
37      protected String getCheckName() {
38          return checkName;
39      }
40  
41      @Override
42      public String getPackageLocation() {
43          return "org/checkstyle/suppressionxpathfilter/modules/moduledirectiveorder";
44      }
45  
46      @Test
47      public void testOrder() throws Exception {
48          final File fileToProcess = new File(getNonCompilablePath(
49                  "order/module-info.java"));
50  
51          final DefaultConfiguration moduleConfig =
52                  createModuleConfig(ModuleDirectiveOrderCheck.class);
53  
54          final String[] expectedViolation = {
55              "5:5: " + getCheckMessage(ModuleDirectiveOrderCheck.class,
56                      ModuleDirectiveOrderCheck.MSG_ORDER, "requires", "exports"),
57          };
58  
59          final List<String> expectedXpathQueries = Collections.singletonList(
60              "/COMPILATION_UNIT/MODULE_DEF/DIRECTIVE_BLOCK/REQUIRES"
61          );
62  
63          runVerifications(moduleConfig, fileToProcess, expectedViolation,
64                  expectedXpathQueries);
65      }
66  
67      @Test
68      public void testGrouping() throws Exception {
69          final File fileToProcess = new File(getNonCompilablePath(
70                  "grouping/module-info.java"));
71  
72          final DefaultConfiguration moduleConfig =
73                  createModuleConfig(ModuleDirectiveOrderCheck.class);
74  
75          final String[] expectedViolation = {
76              "7:5: " + getCheckMessage(ModuleDirectiveOrderCheck.class,
77                      ModuleDirectiveOrderCheck.MSG_GROUPING, "requires"),
78          };
79  
80          final List<String> expectedXpathQueries = Collections.singletonList(
81              "/COMPILATION_UNIT/MODULE_DEF/DIRECTIVE_BLOCK/REQUIRES[./IDENT[@text='jdk']]"
82          );
83  
84          runVerifications(moduleConfig, fileToProcess, expectedViolation,
85                  expectedXpathQueries);
86      }
87  
88      @Test
89      public void testSeparation() throws Exception {
90          final File fileToProcess = new File(getNonCompilablePath(
91                  "separation/module-info.java"));
92  
93          final DefaultConfiguration moduleConfig =
94                  createModuleConfig(ModuleDirectiveOrderCheck.class);
95  
96          final String[] expectedViolation = {
97              "4:5: " + getCheckMessage(ModuleDirectiveOrderCheck.class,
98                      ModuleDirectiveOrderCheck.MSG_SEPARATION, "exports"),
99          };
100 
101         final List<String> expectedXpathQueries = Collections.singletonList(
102             "/COMPILATION_UNIT/MODULE_DEF/DIRECTIVE_BLOCK/EXPORTS"
103         );
104 
105         runVerifications(moduleConfig, fileToProcess, expectedViolation,
106                 expectedXpathQueries);
107     }
108 
109 }