Issue #933: Rename CatchParameterName in patch-diff-report-tool

Praveen7294 · romani · commit 6bc57a2085ca · 2025-05-05T05:38:59.000-07:00
diff --git a/patch-diff-report-tool/src/main/java/com/github/checkstyle/parser/CheckstyleConfigurationsParser.java b/patch-diff-report-tool/src/main/java/com/github/checkstyle/parser/CheckstyleConfigurationsParser.java
@@ -125,8 +125,8 @@ private static ConfigurationModule parseConfiguration(Path xml, String rootName)
             final XMLEventReader reader = StaxUtils.createReader(xml);
             parseModule(reader, root);
         }
-        catch (XMLStreamException ex) {
-            throw new XMLStreamException("Exception was thrown while processing: " + xml, ex);
+        catch (XMLStreamException exc) {
+            throw new XMLStreamException("Exception was thrown while processing: " + xml, exc);
         }
         return root;
     }
diff --git a/patch-diff-report-tool/src/main/java/com/github/checkstyle/site/TextTransform.java b/patch-diff-report-tool/src/main/java/com/github/checkstyle/site/TextTransform.java
@@ -130,16 +130,16 @@ public void transform(String sourceFile, String destFile, Locale outputLocale,
                 try {
                     reader.close();
                 }
-                catch (IOException ex) {
-                    ex.printStackTrace();
+                catch (IOException exc) {
+                    exc.printStackTrace();
                 }
             }
             if (writer != null) {
                 try {
                     writer.close();
                 }
-                catch (IOException ex) {
-                    ex.printStackTrace();
+                catch (IOException exc) {
+                    exc.printStackTrace();
                 }
             }
         }
diff --git a/patch-diff-report-tool/src/main/java/com/github/checkstyle/site/XrefGenerator.java b/patch-diff-report-tool/src/main/java/com/github/checkstyle/site/XrefGenerator.java
@@ -144,7 +144,7 @@ public final String generateXref(String name, boolean shortFilePaths) {
                     ENCODING, ENCODING, null, "", "");
             }
             // -@cs[IllegalCatch] We need to catch all exceptions from JXR
-            catch (Exception ex) {
+            catch (Exception exc) {
                 try {
                     textTransform.transform(sourceFile.getAbsolutePath(),
                         dest.toString(), Locale.ENGLISH,
diff --git a/patch-diff-report-tool/src/test/java/com/github/checkstyle/CliArgsValidatorTest.java b/patch-diff-report-tool/src/test/java/com/github/checkstyle/CliArgsValidatorTest.java
@@ -35,9 +35,9 @@ public void testNoPatchReportPath() throws Exception {
         try {
             Main.main();
         }
-        catch (IllegalArgumentException ex) {
+        catch (IllegalArgumentException exc) {
             Assert.assertEquals("obligatory argument --patchReportPath not present, -h for help",
-                    ex.getMessage());
+                    exc.getMessage());
         }
     }
 
@@ -46,8 +46,8 @@ public void testInvalidBaseReportPath() throws Exception {
         try {
             Main.main("-baseReport", "test", "-patchReport", VALID_BASE_REPORT_EMPTY);
         }
-        catch (IllegalArgumentException ex) {
-            Assert.assertEquals("Base XML Report file doesn't exist: test", ex.getMessage());
+        catch (IllegalArgumentException exc) {
+            Assert.assertEquals("Base XML Report file doesn't exist: test", exc.getMessage());
         }
     }
 
@@ -56,8 +56,8 @@ public void testInvalidPatchReportPath() throws Exception {
         try {
             Main.main("-baseReport", VALID_BASE_REPORT_EMPTY, "-patchReport", "test");
         }
-        catch (IllegalArgumentException ex) {
-            Assert.assertEquals("Patch XML Report file doesn't exist: test", ex.getMessage());
+        catch (IllegalArgumentException exc) {
+            Assert.assertEquals("Patch XML Report file doesn't exist: test", exc.getMessage());
         }
     }
 
@@ -67,9 +67,9 @@ public void testBatchPatchReportSamePath() throws Exception {
             Main.main("-baseReport", VALID_BASE_REPORT_EMPTY, "-patchReport",
                     VALID_BASE_REPORT_EMPTY);
         }
-        catch (IllegalArgumentException ex) {
+        catch (IllegalArgumentException exc) {
             Assert.assertEquals("Both Base and Patch XML report files have the same path.",
-                    ex.getMessage());
+                    exc.getMessage());
         }
     }
 
@@ -79,8 +79,8 @@ public void testInvalidOutputPath() throws Exception {
             Main.main("-baseReport", VALID_BASE_REPORT_EMPTY, "-patchReport",
                     VALID_PATCH_REPORT_EMPTY, "-output", "pom.xml");
         }
-        catch (IllegalArgumentException ex) {
-            Assert.assertEquals("Output path is not a directory: pom.xml", ex.getMessage());
+        catch (IllegalArgumentException exc) {
+            Assert.assertEquals("Output path is not a directory: pom.xml", exc.getMessage());
         }
     }
 
@@ -90,8 +90,8 @@ public void testInvalidRefFilesPath() throws Exception {
             Main.main("-baseReport", VALID_BASE_REPORT_EMPTY, "-patchReport",
                     VALID_PATCH_REPORT_EMPTY, "-refFiles", "pom.xml");
         }
-        catch (IllegalArgumentException ex) {
-            Assert.assertEquals("Ref Files path is not a directory: pom.xml", ex.getMessage());
+        catch (IllegalArgumentException exc) {
+            Assert.assertEquals("Ref Files path is not a directory: pom.xml", exc.getMessage());
         }
     }
 
@@ -101,10 +101,10 @@ public void testBaseConfigAlone() throws Exception {
             Main.main("-baseReport", VALID_BASE_REPORT_EMPTY, "-patchReport",
                     VALID_PATCH_REPORT_EMPTY, "-baseConfig", "test");
         }
-        catch (IllegalArgumentException ex) {
+        catch (IllegalArgumentException exc) {
             Assert.assertEquals(
                     "Patch checkstyle configuration xml path is missing while base configuration"
-                            + " path is present", ex.getMessage());
+                            + " path is present", exc.getMessage());
         }
     }
 
@@ -114,10 +114,10 @@ public void testPatchConfigAlone() throws Exception {
             Main.main("-baseReport", VALID_BASE_REPORT_EMPTY, "-patchReport",
                     VALID_PATCH_REPORT_EMPTY, "-patchConfig", VALID_BASE_CONFIG);
         }
-        catch (IllegalArgumentException ex) {
+        catch (IllegalArgumentException exc) {
             Assert.assertEquals(
                     "Base checkstyle configuration xml path is missing while patch configuration"
-                            + " path is present", ex.getMessage());
+                            + " path is present", exc.getMessage());
         }
     }
 
@@ -128,9 +128,9 @@ public void testInvalidBaseConfig() throws Exception {
                     VALID_PATCH_REPORT_EMPTY, "-baseConfig", "test", "-patchConfig",
                     VALID_BASE_CONFIG);
         }
-        catch (IllegalArgumentException ex) {
+        catch (IllegalArgumentException exc) {
             Assert.assertEquals("Base checkstyle configuration xml file is missing: test",
-                    ex.getMessage());
+                    exc.getMessage());
         }
     }
 
@@ -141,9 +141,9 @@ public void testInvalidPatchConfig() throws Exception {
                     VALID_PATCH_REPORT_EMPTY, "-baseConfig", VALID_BASE_CONFIG, "-patchConfig",
                     "test");
         }
-        catch (IllegalArgumentException ex) {
+        catch (IllegalArgumentException exc) {
             Assert.assertEquals("Patch checkstyle configuration xml file is missing: test",
-                    ex.getMessage());
+                    exc.getMessage());
         }
     }
 
@@ -153,11 +153,11 @@ public void testBaseConfigWithoutBaseReport() throws Exception {
             Main.main("-patchReport", VALID_PATCH_REPORT_EMPTY, "-baseConfig", VALID_BASE_CONFIG,
                     "-patchConfig", VALID_BASE_CONFIG);
         }
-        catch (IllegalArgumentException ex) {
+        catch (IllegalArgumentException exc) {
             Assert.assertEquals(
                     "Base checkstyle configuration xml path is missing while base configuration "
                             + "path is present.",
-                    ex.getMessage());
+                    exc.getMessage());
         }
     }
 
@@ -167,9 +167,9 @@ public void testTextBaseConfigGiven() throws Exception {
             Main.main("-compareMode", "text", "-patchReport", VALID_PATCH_REPORT_EMPTY,
                     "-baseConfig", "test");
         }
-        catch (IllegalArgumentException ex) {
+        catch (IllegalArgumentException exc) {
             Assert.assertEquals("Checkstyle configuration xml paths do not need to be present for "
-                    + "text mode.", ex.getMessage());
+                    + "text mode.", exc.getMessage());
         }
     }
 
@@ -179,9 +179,9 @@ public void testTextPatchConfigGiven() throws Exception {
             Main.main("-compareMode", "text", "-patchReport", VALID_PATCH_REPORT_EMPTY,
                     "-patchConfig", "test");
         }
-        catch (IllegalArgumentException ex) {
+        catch (IllegalArgumentException exc) {
             Assert.assertEquals("Checkstyle configuration xml paths do not need to be present for "
-                    + "text mode.", ex.getMessage());
+                    + "text mode.", exc.getMessage());
         }
     }
 
@@ -190,8 +190,8 @@ public void testTextInvalidPatchReportPath() throws Exception {
         try {
             Main.main("-compareMode", "text", "-patchReport", "test");
         }
-        catch (IllegalArgumentException ex) {
-            Assert.assertEquals("Patch Report directory doesn't exist: test", ex.getMessage());
+        catch (IllegalArgumentException exc) {
+            Assert.assertEquals("Patch Report directory doesn't exist: test", exc.getMessage());
         }
     }
 
@@ -201,8 +201,8 @@ public void testTextInvalidBaseReportPath() throws Exception {
             Main.main("-compareMode", "text", "-baseReport", "test", "-patchReport",
                     VALID_PATCH_DIR);
         }
-        catch (IllegalArgumentException ex) {
-            Assert.assertEquals("Base Report directory doesn't exist: test", ex.getMessage());
+        catch (IllegalArgumentException exc) {
+            Assert.assertEquals("Base Report directory doesn't exist: test", exc.getMessage());
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -125,8 +125,8 @@ private static ConfigurationModule parseConfiguration(Path xml, String rootName)`
`125`	`125`	`final XMLEventReader reader = StaxUtils.createReader(xml);`
`126`	`126`	`parseModule(reader, root);`
`127`	`127`	`}`
`128`		`- catch (XMLStreamException ex) {`
`129`		`- throw new XMLStreamException("Exception was thrown while processing: " + xml, ex);`
	`128`	`+ catch (XMLStreamException exc) {`
	`129`	`+ throw new XMLStreamException("Exception was thrown while processing: " + xml, exc);`
`130`	`130`	`}`
`131`	`131`	`return root;`
`132`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -130,16 +130,16 @@ public void transform(String sourceFile, String destFile, Locale outputLocale,`
`130`	`130`	`try {`
`131`	`131`	`reader.close();`
`132`	`132`	`}`
`133`		`- catch (IOException ex) {`
`134`		`- ex.printStackTrace();`
	`133`	`+ catch (IOException exc) {`
	`134`	`+ exc.printStackTrace();`
`135`	`135`	`}`
`136`	`136`	`}`
`137`	`137`	`if (writer != null) {`
`138`	`138`	`try {`
`139`	`139`	`writer.close();`
`140`	`140`	`}`
`141`		`- catch (IOException ex) {`
`142`		`- ex.printStackTrace();`
	`141`	`+ catch (IOException exc) {`
	`142`	`+ exc.printStackTrace();`
`143`	`143`	`}`
`144`	`144`	`}`
`145`	`145`	`}`
Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,7 @@ public final String generateXref(String name, boolean shortFilePaths) {`
`144`	`144`	`ENCODING, ENCODING, null, "", "");`
`145`	`145`	`}`
`146`	`146`	`// -@cs[IllegalCatch] We need to catch all exceptions from JXR`
`147`		`- catch (Exception ex) {`
	`147`	`+ catch (Exception exc) {`
`148`	`148`	`try {`
`149`	`149`	`textTransform.transform(sourceFile.getAbsolutePath(),`
`150`	`150`	`dest.toString(), Locale.ENGLISH,`
Original file line number	Diff line number	Diff line change
`@@ -35,9 +35,9 @@ public void testNoPatchReportPath() throws Exception {`
`35`	`35`	`try {`
`36`	`36`	`Main.main();`
`37`	`37`	`}`
`38`		`- catch (IllegalArgumentException ex) {`
	`38`	`+ catch (IllegalArgumentException exc) {`
`39`	`39`	`Assert.assertEquals("obligatory argument --patchReportPath not present, -h for help",`
`40`		`- ex.getMessage());`
	`40`	`+ exc.getMessage());`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`
`@@ -46,8 +46,8 @@ public void testInvalidBaseReportPath() throws Exception {`
`46`	`46`	`try {`
`47`	`47`	`Main.main("-baseReport", "test", "-patchReport", VALID_BASE_REPORT_EMPTY);`
`48`	`48`	`}`
`49`		`- catch (IllegalArgumentException ex) {`
`50`		`- Assert.assertEquals("Base XML Report file doesn't exist: test", ex.getMessage());`
	`49`	`+ catch (IllegalArgumentException exc) {`
	`50`	`+ Assert.assertEquals("Base XML Report file doesn't exist: test", exc.getMessage());`
`51`	`51`	`}`
`52`	`52`	`}`
`53`	`53`
`@@ -56,8 +56,8 @@ public void testInvalidPatchReportPath() throws Exception {`
`56`	`56`	`try {`
`57`	`57`	`Main.main("-baseReport", VALID_BASE_REPORT_EMPTY, "-patchReport", "test");`
`58`	`58`	`}`
`59`		`- catch (IllegalArgumentException ex) {`
`60`		`- Assert.assertEquals("Patch XML Report file doesn't exist: test", ex.getMessage());`
	`59`	`+ catch (IllegalArgumentException exc) {`
	`60`	`+ Assert.assertEquals("Patch XML Report file doesn't exist: test", exc.getMessage());`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`
`@@ -67,9 +67,9 @@ public void testBatchPatchReportSamePath() throws Exception {`
`67`	`67`	`Main.main("-baseReport", VALID_BASE_REPORT_EMPTY, "-patchReport",`
`68`	`68`	`VALID_BASE_REPORT_EMPTY);`
`69`	`69`	`}`
`70`		`- catch (IllegalArgumentException ex) {`
	`70`	`+ catch (IllegalArgumentException exc) {`
`71`	`71`	`Assert.assertEquals("Both Base and Patch XML report files have the same path.",`
`72`		`- ex.getMessage());`
	`72`	`+ exc.getMessage());`
`73`	`73`	`}`
`74`	`74`	`}`
`75`	`75`
`@@ -79,8 +79,8 @@ public void testInvalidOutputPath() throws Exception {`
`79`	`79`	`Main.main("-baseReport", VALID_BASE_REPORT_EMPTY, "-patchReport",`
`80`	`80`	`VALID_PATCH_REPORT_EMPTY, "-output", "pom.xml");`
`81`	`81`	`}`
`82`		`- catch (IllegalArgumentException ex) {`
`83`		`- Assert.assertEquals("Output path is not a directory: pom.xml", ex.getMessage());`
	`82`	`+ catch (IllegalArgumentException exc) {`
	`83`	`+ Assert.assertEquals("Output path is not a directory: pom.xml", exc.getMessage());`
`84`	`84`	`}`
`85`	`85`	`}`
`86`	`86`
`@@ -90,8 +90,8 @@ public void testInvalidRefFilesPath() throws Exception {`
`90`	`90`	`Main.main("-baseReport", VALID_BASE_REPORT_EMPTY, "-patchReport",`
`91`	`91`	`VALID_PATCH_REPORT_EMPTY, "-refFiles", "pom.xml");`
`92`	`92`	`}`
`93`		`- catch (IllegalArgumentException ex) {`
`94`		`- Assert.assertEquals("Ref Files path is not a directory: pom.xml", ex.getMessage());`
	`93`	`+ catch (IllegalArgumentException exc) {`
	`94`	`+ Assert.assertEquals("Ref Files path is not a directory: pom.xml", exc.getMessage());`
`95`	`95`	`}`
`96`	`96`	`}`
`97`	`97`
`@@ -101,10 +101,10 @@ public void testBaseConfigAlone() throws Exception {`
`101`	`101`	`Main.main("-baseReport", VALID_BASE_REPORT_EMPTY, "-patchReport",`
`102`	`102`	`VALID_PATCH_REPORT_EMPTY, "-baseConfig", "test");`
`103`	`103`	`}`
`104`		`- catch (IllegalArgumentException ex) {`
	`104`	`+ catch (IllegalArgumentException exc) {`
`105`	`105`	`Assert.assertEquals(`
`106`	`106`	`"Patch checkstyle configuration xml path is missing while base configuration"`
`107`		`- + " path is present", ex.getMessage());`
	`107`	`+ + " path is present", exc.getMessage());`
`108`	`108`	`}`
`109`	`109`	`}`
`110`	`110`
`@@ -114,10 +114,10 @@ public void testPatchConfigAlone() throws Exception {`
`114`	`114`	`Main.main("-baseReport", VALID_BASE_REPORT_EMPTY, "-patchReport",`
`115`	`115`	`VALID_PATCH_REPORT_EMPTY, "-patchConfig", VALID_BASE_CONFIG);`
`116`	`116`	`}`
`117`		`- catch (IllegalArgumentException ex) {`
	`117`	`+ catch (IllegalArgumentException exc) {`
`118`	`118`	`Assert.assertEquals(`
`119`	`119`	`"Base checkstyle configuration xml path is missing while patch configuration"`
`120`		`- + " path is present", ex.getMessage());`
	`120`	`+ + " path is present", exc.getMessage());`
`121`	`121`	`}`
`122`	`122`	`}`
`123`	`123`
`@@ -128,9 +128,9 @@ public void testInvalidBaseConfig() throws Exception {`
`128`	`128`	`VALID_PATCH_REPORT_EMPTY, "-baseConfig", "test", "-patchConfig",`
`129`	`129`	`VALID_BASE_CONFIG);`
`130`	`130`	`}`
`131`		`- catch (IllegalArgumentException ex) {`
	`131`	`+ catch (IllegalArgumentException exc) {`
`132`	`132`	`Assert.assertEquals("Base checkstyle configuration xml file is missing: test",`
`133`		`- ex.getMessage());`
	`133`	`+ exc.getMessage());`
`134`	`134`	`}`
`135`	`135`	`}`
`136`	`136`
`@@ -141,9 +141,9 @@ public void testInvalidPatchConfig() throws Exception {`
`141`	`141`	`VALID_PATCH_REPORT_EMPTY, "-baseConfig", VALID_BASE_CONFIG, "-patchConfig",`
`142`	`142`	`"test");`
`143`	`143`	`}`
`144`		`- catch (IllegalArgumentException ex) {`
	`144`	`+ catch (IllegalArgumentException exc) {`
`145`	`145`	`Assert.assertEquals("Patch checkstyle configuration xml file is missing: test",`
`146`		`- ex.getMessage());`
	`146`	`+ exc.getMessage());`
`147`	`147`	`}`
`148`	`148`	`}`
`149`	`149`
`@@ -153,11 +153,11 @@ public void testBaseConfigWithoutBaseReport() throws Exception {`
`153`	`153`	`Main.main("-patchReport", VALID_PATCH_REPORT_EMPTY, "-baseConfig", VALID_BASE_CONFIG,`
`154`	`154`	`"-patchConfig", VALID_BASE_CONFIG);`
`155`	`155`	`}`
`156`		`- catch (IllegalArgumentException ex) {`
	`156`	`+ catch (IllegalArgumentException exc) {`
`157`	`157`	`Assert.assertEquals(`
`158`	`158`	`"Base checkstyle configuration xml path is missing while base configuration "`
`159`	`159`	`+ "path is present.",`
`160`		`- ex.getMessage());`
	`160`	`+ exc.getMessage());`
`161`	`161`	`}`
`162`	`162`	`}`
`163`	`163`
`@@ -167,9 +167,9 @@ public void testTextBaseConfigGiven() throws Exception {`
`167`	`167`	`Main.main("-compareMode", "text", "-patchReport", VALID_PATCH_REPORT_EMPTY,`
`168`	`168`	`"-baseConfig", "test");`
`169`	`169`	`}`
`170`		`- catch (IllegalArgumentException ex) {`
	`170`	`+ catch (IllegalArgumentException exc) {`
`171`	`171`	`Assert.assertEquals("Checkstyle configuration xml paths do not need to be present for "`
`172`		`- + "text mode.", ex.getMessage());`
	`172`	`+ + "text mode.", exc.getMessage());`
`173`	`173`	`}`
`174`	`174`	`}`
`175`	`175`
`@@ -179,9 +179,9 @@ public void testTextPatchConfigGiven() throws Exception {`
`179`	`179`	`Main.main("-compareMode", "text", "-patchReport", VALID_PATCH_REPORT_EMPTY,`
`180`	`180`	`"-patchConfig", "test");`
`181`	`181`	`}`
`182`		`- catch (IllegalArgumentException ex) {`
	`182`	`+ catch (IllegalArgumentException exc) {`
`183`	`183`	`Assert.assertEquals("Checkstyle configuration xml paths do not need to be present for "`
`184`		`- + "text mode.", ex.getMessage());`
	`184`	`+ + "text mode.", exc.getMessage());`
`185`	`185`	`}`
`186`	`186`	`}`
`187`	`187`
`@@ -190,8 +190,8 @@ public void testTextInvalidPatchReportPath() throws Exception {`
`190`	`190`	`try {`
`191`	`191`	`Main.main("-compareMode", "text", "-patchReport", "test");`
`192`	`192`	`}`
`193`		`- catch (IllegalArgumentException ex) {`
`194`		`- Assert.assertEquals("Patch Report directory doesn't exist: test", ex.getMessage());`
	`193`	`+ catch (IllegalArgumentException exc) {`
	`194`	`+ Assert.assertEquals("Patch Report directory doesn't exist: test", exc.getMessage());`
`195`	`195`	`}`
`196`	`196`	`}`
`197`	`197`
`@@ -201,8 +201,8 @@ public void testTextInvalidBaseReportPath() throws Exception {`
`201`	`201`	`Main.main("-compareMode", "text", "-baseReport", "test", "-patchReport",`
`202`	`202`	`VALID_PATCH_DIR);`
`203`	`203`	`}`
`204`		`- catch (IllegalArgumentException ex) {`
`205`		`- Assert.assertEquals("Base Report directory doesn't exist: test", ex.getMessage());`
	`204`	`+ catch (IllegalArgumentException exc) {`
	`205`	`+ Assert.assertEquals("Base Report directory doesn't exist: test", exc.getMessage());`
`206`	`206`	`}`
`207`	`207`	`}`
`208`	`208`	`}`