diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/AbstractModuleTestSupport.java b/src/test/java/com/puppycrawl/tools/checkstyle/AbstractModuleTestSupport.java index 7ed5515b986..60f2a745e5e 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/AbstractModuleTestSupport.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/AbstractModuleTestSupport.java @@ -44,7 +44,7 @@ import com.puppycrawl.tools.checkstyle.api.Configuration; import com.puppycrawl.tools.checkstyle.api.Violation; import com.puppycrawl.tools.checkstyle.bdd.InlineConfigParser; -import com.puppycrawl.tools.checkstyle.bdd.TestInputConfiguration; +import com.puppycrawl.tools.checkstyle.bdd.ModuleInputConfiguration; import com.puppycrawl.tools.checkstyle.bdd.TestInputViolation; import com.puppycrawl.tools.checkstyle.internal.utils.BriefUtLogger; import com.puppycrawl.tools.checkstyle.internal.utils.TestUtil; @@ -221,19 +221,19 @@ protected final void verifyFilterWithInlineConfigParser(Configuration aConfig, String filePath, String[] expectedUnfiltered, String... expectedFiltered) throws Exception { - final TestInputConfiguration checkTestInputConfiguration = + final ModuleInputConfiguration checkModuleInputConfiguration = InlineConfigParser.parseWithFilteredViolations(filePath); - final Configuration parsedCheckConfig = checkTestInputConfiguration.createConfiguration(); - verifyConfig(aConfig, parsedCheckConfig, checkTestInputConfiguration); - verifyViolations(parsedCheckConfig, filePath, checkTestInputConfiguration); + final Configuration parsedCheckConfig = checkModuleInputConfiguration.createConfiguration(); + verifyConfig(aConfig, parsedCheckConfig, checkModuleInputConfiguration); + verifyViolations(parsedCheckConfig, filePath, checkModuleInputConfiguration); verify(parsedCheckConfig, filePath, expectedUnfiltered); - final TestInputConfiguration filterTestInputConfiguration = + final ModuleInputConfiguration filterModuleInputConfiguration = InlineConfigParser.parseFilter(filePath); - final Configuration parsedFilterConfig = filterTestInputConfiguration.createConfiguration(); - verifyConfig(filterConfig, parsedFilterConfig, filterTestInputConfiguration); + final Configuration parsedFilterConfig = filterModuleInputConfiguration.createConfiguration(); + verifyConfig(filterConfig, parsedFilterConfig, filterModuleInputConfiguration); final DefaultConfiguration rootConfig = createRootConfig(parsedCheckConfig); rootConfig.addChild(parsedFilterConfig); - verifyViolations(rootConfig, filePath, filterTestInputConfiguration); + verifyViolations(rootConfig, filePath, filterModuleInputConfiguration); verify(rootConfig, filePath, expectedFiltered); } @@ -250,11 +250,11 @@ protected final void verifyFilterWithInlineConfigParser(Configuration aConfig, protected final void verifyWithInlineConfigParser(Configuration aConfig, String filePath, String... expected) throws Exception { - final TestInputConfiguration testInputConfiguration = + final ModuleInputConfiguration moduleInputConfiguration = InlineConfigParser.parse(filePath); - final Configuration parsedConfig = testInputConfiguration.createConfiguration(); - verifyConfig(aConfig, parsedConfig, testInputConfiguration); - verifyViolations(parsedConfig, filePath, testInputConfiguration); + final Configuration parsedConfig = moduleInputConfiguration.createConfiguration(); + verifyConfig(aConfig, parsedConfig, moduleInputConfiguration); + verifyViolations(parsedConfig, filePath, moduleInputConfiguration); verify(parsedConfig, filePath, expected); } @@ -396,12 +396,12 @@ protected final void verifyWithLimitedResources(Configuration aConfig, * * @param testConfig hardcoded test config. * @param parsedConfig parsed config from input file. - * @param testInputConfiguration TestInputConfiguration object. + * @param moduleInputConfiguration ModuleInputConfiguration object. * @throws CheckstyleException if property keys not found. */ private static void verifyConfig(Configuration testConfig, Configuration parsedConfig, - TestInputConfiguration testInputConfiguration) + ModuleInputConfiguration moduleInputConfiguration) throws CheckstyleException { assertWithMessage("Check name differs from expected.") .that(testConfig.getName()) @@ -416,7 +416,7 @@ private static void verifyConfig(Configuration testConfig, testProperties.removeAll(Arrays.asList(parsedConfig.getPropertyNames())); for (String property : testProperties) { assertWithMessage("Property value for key %s differs from expected.", property) - .that(testInputConfiguration.getDefaultPropertyValue(property)) + .that(moduleInputConfiguration.getDefaultPropertyValue(property)) .isEqualTo(testConfig.getProperty(property)); } } @@ -426,14 +426,14 @@ private static void verifyConfig(Configuration testConfig, * * @param config parsed config. * @param file file path. - * @param testInputConfiguration TestInputConfiguration object. + * @param moduleInputConfiguration ModuleInputConfiguration object. * @throws Exception if exception occurs during verification process. */ private void verifyViolations(Configuration config, String file, - TestInputConfiguration testInputConfiguration) throws Exception { + ModuleInputConfiguration moduleInputConfiguration) throws Exception { final List actualViolations = getActualViolationsForFile(config, file); - final List testInputViolations = testInputConfiguration.getViolations(); + final List testInputViolations = moduleInputConfiguration.getViolations(); assertWithMessage("Number of actual and expected violations differ.") .that(actualViolations) .hasSize(testInputViolations.size()); diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/bdd/InlineConfigParser.java b/src/test/java/com/puppycrawl/tools/checkstyle/bdd/InlineConfigParser.java index cfb813b0ed2..e60d92c9cad 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/bdd/InlineConfigParser.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/bdd/InlineConfigParser.java @@ -84,7 +84,7 @@ public final class InlineConfigParser { private InlineConfigParser() { } - public static TestInputConfiguration parse(String inputFilePath) throws Exception { + public static ModuleInputConfiguration parse(String inputFilePath) throws Exception { return parse(inputFilePath, false); } @@ -95,19 +95,19 @@ public static TestInputConfiguration parse(String inputFilePath) throws Exceptio * @param setFilteredViolations flag to set filtered violations. * @throws Exception if unable to read file or file not formatted properly. */ - private static TestInputConfiguration parse(String inputFilePath, - boolean setFilteredViolations) throws Exception { + private static ModuleInputConfiguration parse(String inputFilePath, + boolean setFilteredViolations) throws Exception { final Path filePath = Paths.get(inputFilePath); final List lines = readFile(filePath); - final TestInputConfiguration.Builder inputConfigBuilder = - new TestInputConfiguration.Builder(); - setCheckName(inputConfigBuilder, inputFilePath, lines); + final ModuleInputConfiguration.Builder inputConfigBuilder = + new ModuleInputConfiguration.Builder(); + setModuleName(inputConfigBuilder, inputFilePath, lines); setProperties(inputConfigBuilder, inputFilePath, lines, 2); setViolations(inputConfigBuilder, lines, setFilteredViolations); return inputConfigBuilder.build(); } - public static TestInputConfiguration parseWithFilteredViolations(String inputFilePath) + public static ModuleInputConfiguration parseWithFilteredViolations(String inputFilePath) throws Exception { return parse(inputFilePath, true); } @@ -118,12 +118,12 @@ public static TestInputConfiguration parseWithFilteredViolations(String inputFil * @param inputFilePath the input file path. * @throws Exception if unable to read file or file not formatted properly. */ - public static TestInputConfiguration parseFilter(String inputFilePath) + public static ModuleInputConfiguration parseFilter(String inputFilePath) throws Exception { final Path filePath = Paths.get(inputFilePath); final List lines = readFile(filePath); - final TestInputConfiguration.Builder inputConfigBuilder = - new TestInputConfiguration.Builder(); + final ModuleInputConfiguration.Builder inputConfigBuilder = + new ModuleInputConfiguration.Builder(); final int lineNo = getFilterConfigLineNo(lines); setFilterName(inputConfigBuilder, inputFilePath, lines, lineNo); setProperties(inputConfigBuilder, inputFilePath, lines, lineNo + 1); @@ -193,14 +193,14 @@ private static List readFile(Path filePath) throws CheckstyleException { } } - private static void setCheckName(TestInputConfiguration.Builder inputConfigBuilder, - String filePath, List lines) + private static void setModuleName(ModuleInputConfiguration.Builder inputConfigBuilder, + String filePath, List lines) throws CheckstyleException { if (lines.size() < 2) { throw new CheckstyleException("Config not specified in " + filePath); } - final String checkName = lines.get(1); - final String fullyQualifiedClassName = getFullyQualifiedClassName(filePath, checkName); + final String moduleName = lines.get(1); + final String fullyQualifiedClassName = getFullyQualifiedClassName(filePath, moduleName); inputConfigBuilder.setModuleName(fullyQualifiedClassName); } @@ -212,7 +212,7 @@ private static int getFilterConfigLineNo(List lines) { return lineNo; } - private static void setFilterName(TestInputConfiguration.Builder inputConfigBuilder, + private static void setFilterName(ModuleInputConfiguration.Builder inputConfigBuilder, String filePath, List lines, int lineNo) throws CheckstyleException { final String filterName = lines.get(lineNo); @@ -223,7 +223,7 @@ private static void setFilterName(TestInputConfiguration.Builder inputConfigBuil inputConfigBuilder.setModuleName(fullyQualifiedClassName); } - private static void setProperties(TestInputConfiguration.Builder inputConfigBuilder, + private static void setProperties(ModuleInputConfiguration.Builder inputConfigBuilder, String inputFilePath, List lines, int beginLineNo) @@ -242,7 +242,7 @@ private static void setProperties(TestInputConfiguration.Builder inputConfigBuil final String key = entry.getKey().toString(); final String value = entry.getValue().toString(); if (key.startsWith("message.")) { - inputConfigBuilder.addCheckMessage(key.substring(8), value); + inputConfigBuilder.addModulekMessage(key.substring(8), value); } else if (value.startsWith("(file)")) { final String fileName = value.substring(value.indexOf(')') + 1); @@ -269,7 +269,7 @@ else if (value.startsWith("(default)")) { } } - private static void setViolations(TestInputConfiguration.Builder inputConfigBuilder, + private static void setViolations(ModuleInputConfiguration.Builder inputConfigBuilder, List lines, boolean useFilteredViolations) { for (int lineNo = 0; lineNo < lines.size(); lineNo++) { final Matcher violationMatcher = @@ -321,7 +321,7 @@ else if (useFilteredViolations) { } } - private static void setFilteredViolation(TestInputConfiguration.Builder inputConfigBuilder, + private static void setFilteredViolation(ModuleInputConfiguration.Builder inputConfigBuilder, int lineNo, String line) { final Matcher violationMatcher = FILTERED_VIOLATION_PATTERN.matcher(line); diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/bdd/TestInputConfiguration.java b/src/test/java/com/puppycrawl/tools/checkstyle/bdd/ModuleInputConfiguration.java similarity index 75% rename from src/test/java/com/puppycrawl/tools/checkstyle/bdd/TestInputConfiguration.java rename to src/test/java/com/puppycrawl/tools/checkstyle/bdd/ModuleInputConfiguration.java index 56be58bb5b1..bdf90b7da82 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/bdd/TestInputConfiguration.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/bdd/ModuleInputConfiguration.java @@ -27,10 +27,10 @@ import com.puppycrawl.tools.checkstyle.DefaultConfiguration; -public final class TestInputConfiguration { +public final class ModuleInputConfiguration { - /** The check name. */ - private final String checkName; + /** The module name. */ + private final String moduleName; /** Map of default properties. */ private final Map defaultProperties; @@ -38,26 +38,26 @@ public final class TestInputConfiguration { /** Map of non default properties. */ private final Map nonDefaultProperties; - /** Map of check messages. */ - private final Map checkMessages; + /** Map of module messages. */ + private final Map moduleMessages; /** List of parsed violations. */ private final List violations; - private TestInputConfiguration(String checkName, - Map defaultProperties, - Map nonDefaultProperties, - Map checkMessages, - List violations) { - this.checkName = checkName; + private ModuleInputConfiguration(String moduleName, + Map defaultProperties, + Map nonDefaultProperties, + Map moduleMessages, + List violations) { + this.moduleName = moduleName; this.defaultProperties = defaultProperties; this.nonDefaultProperties = nonDefaultProperties; - this.checkMessages = checkMessages; + this.moduleMessages = moduleMessages; this.violations = violations; } - public String getCheckName() { - return checkName; + public String getModuleName() { + return moduleName; } public Map getAllProperties() { @@ -75,8 +75,8 @@ public Map getNonDefaultProperties() { return Collections.unmodifiableMap(nonDefaultProperties); } - public Map getCheckMessages() { - return Collections.unmodifiableMap(checkMessages); + public Map getModuleMessages() { + return Collections.unmodifiableMap(moduleMessages); } public List getViolations() { @@ -84,9 +84,9 @@ public List getViolations() { } public DefaultConfiguration createConfiguration() { - final DefaultConfiguration parsedConfig = new DefaultConfiguration(checkName); + final DefaultConfiguration parsedConfig = new DefaultConfiguration(moduleName); nonDefaultProperties.forEach(parsedConfig::addProperty); - checkMessages.forEach(parsedConfig::addMessage); + moduleMessages.forEach(parsedConfig::addMessage); return parsedConfig; } @@ -100,7 +100,7 @@ public static final class Builder { private final Map nonDefaultProperties = new HashMap<>(); - private final Map checkMessages = new HashMap<>(); + private final Map moduleMessages = new HashMap<>(); private final List violations = new ArrayList<>(); @@ -118,20 +118,20 @@ public void addNonDefaultProperty(String propertyName, String nonDefaultProperty nonDefaultProperties.put(propertyName, nonDefaultPropertyValue); } - public void addCheckMessage(String messageKey, String messageString) { - checkMessages.put(messageKey, messageString); + public void addModulekMessage(String messageKey, String messageString) { + moduleMessages.put(messageKey, messageString); } public void addViolation(int violationLine, String violationMessage) { violations.add(new TestInputViolation(violationLine, violationMessage)); } - public TestInputConfiguration build() { - return new TestInputConfiguration( + public ModuleInputConfiguration build() { + return new ModuleInputConfiguration( moduleName, defaultProperties, nonDefaultProperties, - checkMessages, + moduleMessages, violations ); }