Issue #13345: enable example test for SeverityMatchFilterExamplesTest

[Kexin2000]

part of issue: #13345
this is the first example test for filter, I've encountered some issues and need to discuss potential solutions. @romani @nrmancuso

1. My current approach to writing filter examples is inspired by this file: demonstrating the function of the filter through other checks. I used ParameterNameCheck and MethodNameCheck, setting the severity of ParameterNameCheck to info, while the MethodNameCheck defaults to error. However, when I run SeverityMatchFilterExamplesTest, the code enters line 382 of the following code block and throws an exception. The reason is that the path where SeverityMatchFilterExamplesTest is located does not contain module name parameters for 'parametername' and 'methodname'. So, I added 'parametername' and 'methodname' to the hashmap 'moduleMappings'. I think this approach should be acceptable, as I used 'git blame' to investigate the historical reason for 'moduleMappings'. The existence of this variable is to address some special cases in Enable examples tests #13345, such as SuppressWarningsHolder SuppressWarningsHolder naming inconsistency giving java.lang.ClassNotFoundException #13845.

checkstyle/src/test/java/com/puppycrawl/tools/checkstyle/bdd/InlineConfigParser.java

Lines 372 to 390 in 571e547

	String fullyQualifiedClassName;
	if (moduleMappings.containsKey(moduleName)) {
	fullyQualifiedClassName = moduleMappings.get(moduleName);
	}
	else if (moduleName.startsWith("com.")) {
	fullyQualifiedClassName = moduleName;
	}
	else {
	final String path = SLASH_PATTERN.matcher(filePath).replaceAll(".");
	final int endIndex = path.lastIndexOf(moduleName.toLowerCase(Locale.ROOT));
	if (endIndex == -1) {
	throw new CheckstyleException("Unable to resolve module name: " + moduleName
	+ ". Please check for spelling errors or specify fully qualified class name.");
	}
	final int beginIndex = path.indexOf("com.puppycrawl");
	fullyQualifiedClassName = path.substring(beginIndex, endIndex) + moduleName;
	if (!fullyQualifiedClassName.endsWith("Filter")) {
	fullyQualifiedClassName += "Check";
	}

2. While running SeverityMatchFilterExamplesTest, there's a similar issue with a path mismatch. The code will throw an exception at line 602 of the following code block because there is no message in the filters package. So, I added a messages.properties file under src/main/resources/com/puppycrawl/tools/checkstyle/filters, and for subsequent filter example tests, more violation messages can be added to this file to resolve this issue. Is my solution feasible? (Messages.properties files for other languages also need to be added.)

checkstyle/src/test/java/com/puppycrawl/tools/checkstyle/AbstractModuleTestSupport.java

Lines 600 to 610 in 571e547

	private static String internalGetCheckMessage(
	String messageBundle, String messageKey, Object... arguments) {
	final ResourceBundle resourceBundle = ResourceBundle.getBundle(
	messageBundle,
	Locale.ROOT,
	Thread.currentThread().getContextClassLoader(),
	new Utf8Control());
	final String pattern = resourceBundle.getString(messageKey);
	final MessageFormat formatter = new MessageFormat(pattern, Locale.ROOT);
	return formatter.format(arguments);
	}

[Kexin2000]

The work on this PR is not yet complete. To avoid unnecessary work, I want to first confirm a suitable solution.

[romani]

items:

[romani]

what forcing you to add this file and such property?

[romani]

see guidance at #14784 (comment)

[Kexin2000]

done

[romani]

So, I added 'parametername' and 'methodname' to the hashmap 'moduleMappings'. I think this approach should be acceptable,

yes, it is defect of our tes suite as it expects modules to be in same package and target module - Filter in this case.

So, I added a messages.properties file under src/main/resources/com/puppycrawl/tools/checkstyle/filters, and for subsequent filter example tests, more violation messages can be added to this file to resolve this issue. Is my solution feasible?

not good, can we update internal suite code to take messages from file we will provide as hardcoded values, same as we did for fully qualified names ( item above)

[romani]

Items

[romani]

// violation, as default severity is error

[romani]

// ok, ParameterName's severity is info

[romani]

Please change logic to use value from manual mapping if mapping is present.
If present in special map then use it , else use packageName

[romani]

@Kexin2000 ,please find time to finish PR