Changeset 18974 in josm

Timestamp:

2024-02-12T23:00:59+01:00 (3 months ago)

Author:

taylor.smock

Message:

Fix #23465: Remove custom checkstyle plugin

TopLevelJavadocCheck.java is duplicating functionality from MissingJavadocType.
Our custom class is from #14794 (closed 2017-10-16). The check that makes it
redundant was added in checkstyle 8.20 (released 2019-04-28).

This adds the missing javadocs for the more comprehensive checkstyle version.

Location:

trunk

Files:

• build.xml (modified) (3 diffs)
• test/unit/org/openstreetmap/josm/testutils/PluginServer.java (modified) (2 diffs)
• test/unit/org/openstreetmap/josm/testutils/annotations/ResetUniquePrimitiveIdCounters.java (modified) (1 diff)
• test/unit/org/openstreetmap/josm/testutils/annotations/TaggingPresets.java (modified) (1 diff)
• test/unit/org/openstreetmap/josm/testutils/annotations/TestUser.java (modified) (1 diff)
• test/unit/org/openstreetmap/josm/testutils/annotations/Timezone.java (modified) (1 diff)
• tools/checkstyle/.classpath (deleted)
• tools/checkstyle/.project (deleted)
• tools/checkstyle/.settings (deleted)
• tools/checkstyle/josm_checks.xml (modified) (2 diffs)
• tools/checkstyle/josm_filters.xml (modified) (1 diff)
• tools/checkstyle/src (deleted)

trunk/build.xml

@@ -72 +72 @@
         <property name="proj-build.dir" location="${base.dir}/build2"/>
         <property name="script-build.dir" location="${base.dir}/build2"/>
-        <property name="checkstyle-build.dir" location="${base.dir}/build2"/>
         <property name="epsg.output" location="${resources.dir}/data/projection/custom-epsg"/>
         <property name="commons-lang3.jar" location="${tools.dir}/commons-lang3.jar"/>
@@ -363 +362 @@
         <delete dir="${proj-build.dir}"/>
         <delete dir="${script-build.dir}"/>
-        <delete dir="${checkstyle-build.dir}"/>
         <delete dir="${dist.dir}"/>
         <delete dir="${mapcss.dir}/parsergen"/>
@@ -883 +881 @@
     </target>
 
-    <target name="checkstyle-compile" depends="init" description="Compile Checkstyle rules">
+    <target name="checkstyle-changed" depends="init" description="Run Checkstyle on SVN/Git-changed source files">
         <ivy:cachepath log="download-only" file="${tools.ivy}" pathid="checkstyle.classpath" conf="checkstyle"/>
-        <mkdir dir="${checkstyle-build.dir}"/>
-        <javac sourcepath="" srcdir="${checkstyle.dir}/src" failonerror="true"
-            destdir="${checkstyle-build.dir}" release="${java.lang.version}" debug="on"
-            includeantruntime="false"
-            encoding="UTF-8" classpathref="checkstyle.classpath">
-        </javac>
-    </target>
-    <target name="checkstyle-changed" depends="checkstyle-compile" description="Run Checkstyle on SVN/Git-changed source files">
         <exec append="false" osfamily="unix" executable="bash" failifexecutionfails="true">
             <arg value="-c"/>
-            <arg value="(git ls-files src test --modified 2>/dev/null || svn status -q --ignore-externals src test) | grep -o '\(src\|test\)/.*' | xargs java -cp '${toString:checkstyle.classpath}:${checkstyle-build.dir}' com.puppycrawl.tools.checkstyle.Main -c ${checkstyle.dir}/josm_checks.xml | sed -e 's:\([^ ]*\) [^:]*/\([^:/]*.java\:[^:]*\):(\2)\1:'"/>
+            <arg value="(git ls-files src test --modified 2>/dev/null || svn status -q --ignore-externals src test) | grep -o '\(src\|test\)/.*' | xargs java -cp '${toString:checkstyle.classpath}' com.puppycrawl.tools.checkstyle.Main -c ${checkstyle.dir}/josm_checks.xml | sed -e 's:\([^ ]*\) [^:]*/\([^:/]*.java\:[^:]*\):(\2)\1:'"/>
         </exec>
         <exec append="false" osfamily="windows" executable="powershell" failifexecutionfails="true">
             <arg value="/c"/>
-            <arg value="svn status -q --ignore-externals src test | ForEach-Object {java -cp '${toString:checkstyle.classpath};${checkstyle-build.dir}' com.puppycrawl.tools.checkstyle.Main -c ${checkstyle.dir}/josm_checks.xml $_.split(' ')[7]}"/>
-        </exec>
-    </target>
-    <target name="checkstyle" depends="checkstyle-compile" description="Run Checkstyle on the source files">
+            <arg value="svn status -q --ignore-externals src test | ForEach-Object {java -cp '${toString:checkstyle.classpath}' com.puppycrawl.tools.checkstyle.Main -c ${checkstyle.dir}/josm_checks.xml $_.split(' ')[7]}"/>
+        </exec>
+    </target>
+    <target name="checkstyle" depends="init" description="Run Checkstyle on the source files">
+        <ivy:cachepath log="download-only" file="${tools.ivy}" pathid="checkstyle.classpath" conf="checkstyle"/>
         <taskdef resource="com/puppycrawl/tools/checkstyle/ant/checkstyle-ant-task.properties">
             <classpath refid="checkstyle.classpath"/>
-            <classpath path="${checkstyle-build.dir}"/>
         </taskdef>
         <checkstyle config="${checkstyle.dir}/josm_checks.xml">

trunk/test/unit/org/openstreetmap/josm/testutils/PluginServer.java

@@ -25 +25 @@
 import org.openstreetmap.josm.tools.Logging;
 
+/**
+ * Serve "remote" test plugins for tests
+ */
 public class PluginServer {
+    /**
+     * A holder class for a "remote" plugin for tests
+     */
     public static class RemotePlugin {
         private final File srcJar;
@@ -226 +232 @@
     }
 
+    /**
+     * A wiremock server rule for serving plugins
+     */
     public class PluginServerRule extends WireMockExtension {
         public PluginServerRule(Options ruleOptions, boolean failOnUnmatchedRequests) {

trunk/test/unit/org/openstreetmap/josm/testutils/annotations/ResetUniquePrimitiveIdCounters.java

@@ -37 +37 @@
 @ExtendWith(ResetUniquePrimitiveIdCounters.Reset.class)
 public @interface ResetUniquePrimitiveIdCounters {
+    /**
+     * Reset the id counters for {@link Node}, {@link Way}, and {@link Relation}
+     * {@link org.openstreetmap.josm.data.osm.AbstractPrimitive#getIdGenerator} calls.
+     */
     class Reset implements BeforeEachCallback {
         private static AtomicLong[] ID_COUNTERS;

trunk/test/unit/org/openstreetmap/josm/testutils/annotations/TaggingPresets.java

@@ -32 +32 @@
 public @interface TaggingPresets {
 
+    /**
+     * Reset the tagging presets between each test -- presets will be reset if they are changed.
+     */
     class TaggingPresetsExtension implements BeforeEachCallback, BeforeAllCallback {
         private static int expectedHashcode = 0;

trunk/test/unit/org/openstreetmap/josm/testutils/annotations/TestUser.java

@@ -33 +33 @@
 @Target({ElementType.TYPE, ElementType.METHOD})
 public @interface TestUser {
+    /**
+     * Initialize a user for tests
+     */
     class TestUserExtension implements BeforeAllCallback, BeforeEachCallback, AfterEachCallback {
         @Override

trunk/test/unit/org/openstreetmap/josm/testutils/annotations/Timezone.java

@@ -21 +21 @@
 @ExtendWith(Timezone.TimezoneExtension.class)
 public @interface Timezone {
+    /**
+     * Set the default timezone for tests (UTC)
+     */
     class TimezoneExtension implements BeforeEachCallback {
         @Override

trunk/tools/checkstyle/josm_checks.xml

@@ -32 +32 @@
       <property name="checkHtml" value="false"/>
     </module>
+    <module name="MissingJavadocType"/>
     <module name="NonEmptyAtclauseDescription"/>
     <module name="AtclauseOrder"/>
@@ -96 +97 @@
     <module name="FinalClass"/>
     <module name="HideUtilityClassConstructor"/>
-    <module name="org.openstreetmap.josm.TopLevelJavadocCheck"/>
     <module name="SuppressionCommentFilter">
       <property name="offCommentFormat" value="CHECKSTYLE\.OFF\: ([\w\|]+)"/>

trunk/tools/checkstyle/josm_filters.xml

@@ -45 +45 @@
   <suppress checks="FileLengthCheck" files="DomainValidator\.java" />
   <suppress checks="MissingDeprecatedCheck" files="package-info\.java" />
-  <suppress checks="org.openstreetmap.josm.TopLevelJavadocCheck" files="package-info\.java" />
-  <suppress checks="org.openstreetmap.josm.TopLevelJavadocCheck" files="[\\/]test[\\/]" />
 </suppressions>