Skip to content

CHANGE @W-20736388@ - Add PMD run tests for NcssCount and ExcessiveClassLength #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aruntyagiTutu merged 4 commits into from
Jan 27, 2026
Merged

CHANGE @W-20736388@ - Add PMD run tests for NcssCount and ExcessiveClassLength #403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3177a35
add java PMD wrapper test to check for custom deprecated rule
aruntyagiTutu Jan 21, 2026
655bc82
tests for describing deperecated rules in pmd
aruntyagiTutu Jan 22, 2026
919422e
Merge branch 'arun.tyagi/pmd_warning_stdout_marker' into arun.tyagi/f…
aruntyagiTutu Jan 27, 2026
9bdf107
fix test for warn and error
aruntyagiTutu Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion ...ngine/pmd-cpd-wrappers/src/main/java/com/salesforce/sfca/pmdwrapper/PmdRuleDescriber.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,11 @@ public void logEx(Level level, @Nullable String s, Object[] objects, @Nullable T
throw new RuntimeException("PMD threw an unexpected exception:\n" + message, throwable);
} else if (level == Level.WARN && s != null){
String message = MessageFormat.format(s, objects);
System.out.println("[Warning] " + message.replaceAll("\n","{NEWLINE}"));
if (message.contains("Discontinue using Rule ")) {
System.out.println("[Warning] " + message.replaceAll("\n","{NEWLINE}"));
} else {
throw new RuntimeException("PMD threw an unexpected exception:\n" + message);
}
}else if (s != null) {
String message = MessageFormat.format(s, objects);
throw new RuntimeException("PMD threw an unexpected exception:\n" + message);
Expand Down
155 changes: 155 additions & 0 deletions ...-engine/pmd-cpd-wrappers/src/test/java/com/salesforce/sfca/pmdwrapper/PmdWrapperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,70 @@ void whenCallingMainWithDescribeWithCustomRulesetsFile_thenRulesetsAreApplied(@T
assertThat(ruleInfo2.ruleSetFile, is(sampleRulesetFile2.toAbsolutePath().toString()));
}

@Test
void whenCallingMainWithDescribeWithNcssCountRuleset_thenRuleAppearsInDescribe(@TempDir Path tempDir) throws Exception {
// Create a minimal ruleset that references Apex NcssCount (metrics)
String rulesetXml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
"<ruleset name=\"Ruleset for NcssCount\"\n" +
" xmlns=\"http://pmd.sourceforge.net/ruleset/2.0.0\"\n" +
" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n" +
" xsi:schemaLocation=\"http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd\">\n" +
" <description>Include Apex NcssCount</description>\n" +
" <rule ref=\"category/apex/design.xml/NcssCount\" />\n" +
"</ruleset>";
Path ncssRuleset = tempDir.resolve("ncss-ruleset.xml");
Files.write(ncssRuleset, rulesetXml.getBytes());

// Prepare describe args with a custom rulesets list file
Path outputFile = tempDir.resolve("describe-output.json");
Path rulesetsList = tempDir.resolve("customRulesetsList.txt");
Files.write(rulesetsList, (ncssRuleset.toAbsolutePath().toString() + "\n").getBytes());

String[] args = {"describe", outputFile.toAbsolutePath().toString(),
rulesetsList.toAbsolutePath().toString(), "apex"};
callPmdWrapper(args);

// Parse output and assert NcssCount is present and references our ruleset file
String fileContents = Files.readString(outputFile);
Gson gson = new Gson();
Type pmdRuleInfoListType = new TypeToken<List<PmdRuleInfo>>(){}.getType();
List<PmdRuleInfo> pmdRuleInfoList = gson.fromJson(fileContents, pmdRuleInfoListType);
PmdRuleInfo ruleInfo = assertContainsOneRuleWithNameAndLanguage(pmdRuleInfoList, "NcssCount", "apex");
assertThat(ruleInfo.ruleSetFile, is(ncssRuleset.toAbsolutePath().toString()));
}

@Test
void whenCallingMainWithDescribeWithExcessiveClassLengthRuleset_thenRuleAppearsInDescribe(@TempDir Path tempDir) throws Exception {
// Create a minimal ruleset that references Apex ExcessiveClassLength (design)
String rulesetXml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
"<ruleset name=\"Ruleset for ExcessiveClassLength\"\n" +
" xmlns=\"http://pmd.sourceforge.net/ruleset/2.0.0\"\n" +
" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n" +
" xsi:schemaLocation=\"http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd\">\n" +
" <description>Include Apex ExcessiveClassLength</description>\n" +
" <rule ref=\"category/apex/design.xml/ExcessiveClassLength\" />\n" +
"</ruleset>";
Path excessiveClassLengthRuleset = tempDir.resolve("excessive-class-length-ruleset.xml");
Files.write(excessiveClassLengthRuleset, rulesetXml.getBytes());

// Prepare describe args with a custom rulesets list file
Path outputFile = tempDir.resolve("describe-output.json");
Path rulesetsList = tempDir.resolve("customRulesetsList.txt");
Files.write(rulesetsList, (excessiveClassLengthRuleset.toAbsolutePath().toString() + "\n").getBytes());

String[] args = {"describe", outputFile.toAbsolutePath().toString(),
rulesetsList.toAbsolutePath().toString(), "apex"};
callPmdWrapper(args);

// Parse output and assert ExcessiveClassLength is present and references our ruleset file
String fileContents = Files.readString(outputFile);
Gson gson = new Gson();
Type pmdRuleInfoListType = new TypeToken<List<PmdRuleInfo>>(){}.getType();
List<PmdRuleInfo> pmdRuleInfoList = gson.fromJson(fileContents, pmdRuleInfoListType);
PmdRuleInfo ruleInfo = assertContainsOneRuleWithNameAndLanguage(pmdRuleInfoList, "ExcessiveClassLength", "apex");
assertThat(ruleInfo.ruleSetFile, is(excessiveClassLengthRuleset.toAbsolutePath().toString()));
}

@Test
void whenCallingMainWithRunAndTwoFewArgs_thenError() {
String[] args = {"run", "notEnough"};
Expand Down Expand Up @@ -373,6 +437,97 @@ void whenCallingRunWithAnInvalidApexFileWithValidApexFile_thenSkipInvalidApexFil
assertThat(resultsJsonString, containsString("\"processingErrors\":[{\"file\":")); // Contains the processing error for the invalid file
}

@Test
void whenRunningWithNcssCountRule_thenReportsOrExecutesSuccessfully(@TempDir Path tempDir) throws Exception {
// Create a minimal ruleset that references the Apex NcssCount rule with a very low threshold
String rulesetXml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
"<ruleset name=\"Ruleset for NcssCount\"\n" +
" xmlns=\"http://pmd.sourceforge.net/ruleset/2.0.0\"\n" +
" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n" +
" xsi:schemaLocation=\"http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd\">\n" +
" <description>Run Apex NcssCount</description>\n" +
" <rule ref=\"category/apex/design.xml/NcssCount\">\n" +
" <properties>\n" +
" <property name=\"minimum\" value=\"1\"/>\n" +
" </properties>\n" +
" </rule>\n" +
"</ruleset>";
String rulesetFile = createTempFile(tempDir, "ncss-ruleset.xml", rulesetXml);

// Create a simple Apex file with a few statements; the low threshold should trigger a violation
String apexCode = "public class ManyStatements {\n" +
" public static void foo(){\n" +
" Integer a = 1; Integer b = 2; Integer c = 3; // multiple statements\n" +
" }\n" +
"}\n";
String apexFile = createTempFile(tempDir, "ManyStatements.cls", apexCode);

String inputJson = "{\n" +
" \"ruleSetInputFile\":\"" + makePathJsonSafe(rulesetFile) + "\",\n" +
" \"runDataPerLanguage\": {\n" +
" \"apex\": {\n" +
" \"filesToScan\": [\"" + makePathJsonSafe(apexFile) + "\"]\n" +
" }\n" +
" }\n" +
"}";
String inputFile = createTempFile(tempDir, "input.json", inputJson);

String resultsOutputFile = tempDir.resolve("results.json").toAbsolutePath().toString();
String[] args = {"run", inputFile, resultsOutputFile};
callPmdWrapper(args); // Should not error

String resultsJsonString = new String(Files.readAllBytes(Paths.get(resultsOutputFile)));
JsonElement element = JsonParser.parseString(resultsJsonString); // Should not error
assertThat(element.isJsonObject(), is(true));
}

@Test
void whenRunningWithDeprecatedExcessiveClassLengthRule_thenExecutesSuccessfully(@TempDir Path tempDir) throws Exception {
// Create a minimal ruleset referencing the Apex ExcessiveClassLength rule with a low threshold
String rulesetXml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
"<ruleset name=\"Ruleset for ExcessiveClassLength\"\n" +
" xmlns=\"http://pmd.sourceforge.net/ruleset/2.0.0\"\n" +
" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n" +
" xsi:schemaLocation=\"http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd\">\n" +
" <description>Run Apex ExcessiveClassLength</description>\n" +
" <rule ref=\"category/apex/design.xml/ExcessiveClassLength\">\n" +
" <properties>\n" +
" <property name=\"minimum\" value=\"5\"/>\n" +
" </properties>\n" +
" </rule>\n" +
"</ruleset>";
String rulesetFile = createTempFile(tempDir, "excessive-class-length.xml", rulesetXml);

// Create an Apex class with enough lines to exceed the small threshold
StringBuilder apexBuilder = new StringBuilder();
apexBuilder.append("public class LargeClass {\n");
apexBuilder.append(" public static void m0(){ Integer x0 = 0; }\n");
apexBuilder.append(" public static void m1(){ Integer x1 = 1; }\n");
apexBuilder.append(" public static void m2(){ Integer x2 = 2; }\n");
apexBuilder.append(" public static void m3(){ Integer x3 = 3; }\n");
apexBuilder.append(" public static void m4(){ Integer x4 = 4; }\n");
apexBuilder.append("}\n");
String apexFile = createTempFile(tempDir, "LargeClass.cls", apexBuilder.toString());

String inputJson = "{\n" +
" \"ruleSetInputFile\":\"" + makePathJsonSafe(rulesetFile) + "\",\n" +
" \"runDataPerLanguage\": {\n" +
" \"apex\": {\n" +
" \"filesToScan\": [\"" + makePathJsonSafe(apexFile) + "\"]\n" +
" }\n" +
" }\n" +
"}";
String inputFile = createTempFile(tempDir, "input-excessive-class-length.json", inputJson);

String resultsOutputFile = tempDir.resolve("results-excessive-class-length.json").toAbsolutePath().toString();
String[] args = {"run", inputFile, resultsOutputFile};
callPmdWrapper(args); // Should not error

String resultsJsonString = new String(Files.readAllBytes(Paths.get(resultsOutputFile)));
JsonElement element = JsonParser.parseString(resultsJsonString); // Should not error
assertThat(element.isJsonObject(), is(true));
}


private static String createSampleRulesetFile(Path tempDir) throws Exception {
String ruleSetContents = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
Expand Down