Add Error Prone code style verification

.github/workflows/main.yml

@@ -46,3 +46,21 @@ jobs:
         job-id: jdk14
         multi-cache-enabled: false
         arguments: --scan --no-parallel build -x distTar -x distTarSource -Dskip.test_TestDNSCacheManager.testWithCustomResolverAnd1Server=true
+
+  errorprone:
+    name: 'Error Prone (JDK 11)'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 50
+    - name: 'Set up JDK 11'
+      uses: actions/setup-java@v1
+      with:
+        java-version: 11
+    - uses: burrunan/gradle-cache-action@v1
+      name: Test
+      with:
+        job-id: errprone
+        multi-cache-enabled: false
+        arguments: --scan --no-parallel --no-daemon -PenableErrorprone classes

build.gradle.kts

@@ -24,6 +24,7 @@ import com.github.vlsi.gradle.git.dsl.gitignore
 import com.github.vlsi.gradle.properties.dsl.lastEditYear
 import com.github.vlsi.gradle.properties.dsl.props
 import com.github.vlsi.gradle.release.RepositoryType
+import net.ltgt.gradle.errorprone.errorprone
 import org.ajoberstar.grgit.Grgit
 import org.gradle.api.tasks.testing.logging.TestExceptionFormat
 import org.sonarqube.gradle.SonarQubeProperties
@@ -36,6 +37,7 @@ plugins {
     id("org.nosphere.apache.rat")
     id("com.github.autostyle")
     id("com.github.spotbugs")
+    id("net.ltgt.errorprone") apply false
     id("org.sonarqube")
     id("com.github.vlsi.crlf")
     id("com.github.vlsi.gradle-extensions")
@@ -147,9 +149,11 @@ val jacocoEnabled by extra {
 
 // Do not enable spotbugs by default. Execute it only when -Pspotbugs is present
 val enableSpotBugs = props.bool("spotbugs", default = false)
+val enableErrorprone by props()
 val ignoreSpotBugsFailures by props()
 val skipCheckstyle by props()
 val skipAutostyle by props()
+val werror by props(true) // treat javac warnings as errors
 // Allow to skip building source/binary distributions
 val skipDist by extra {
     boolProp("skipDist") ?: false
@@ -381,6 +385,37 @@ allprojects {
                 dependsOn("checkstyleAll")
             }
         }
+
+        if (enableErrorprone) {
+            apply(plugin = "net.ltgt.errorprone")
+            dependencies {
+                "errorprone"("com.google.errorprone:error_prone_core:${"errorprone".v}")
+                "annotationProcessor"("com.google.guava:guava-beta-checker:1.0")
+            }
+            tasks.withType<JavaCompile>().configureEach {
+                options.compilerArgs.addAll(listOf("-Xmaxerrs", "10000", "-Xmaxwarns", "10000"))
+                options.errorprone {
+                    disableWarningsInGeneratedCode.set(true)
+                    errorproneArgs.add("-XepExcludedPaths:.*/javacc/.*")
+                    disable(
+                        "ComplexBooleanConstant",
+                        "EqualsGetClass",
+                        "OperatorPrecedence",
+                        "MutableConstantField",
+                        // "ReferenceEquality",
+                        "SameNameButDifferent",
+                        "TypeParameterUnusedInFormals"
+                    )
+                    // Analyze issues, and enable the check
+                    disable(
+                        "MissingSummary",
+                        "EmptyBlockTag",
+                        "BigDecimalEquals",
+                        "StringSplitter"
+                    )
+                }
+            }
+        }
     }
     plugins.withId("groovy") {
         if (!skipAutostyle) {
@@ -468,6 +503,10 @@ allprojects {
         tasks {
             withType<JavaCompile>().configureEach {
                 options.encoding = "UTF-8"
+                options.compilerArgs.add("-Xlint:deprecation")
+                if (werror) {
+                    options.compilerArgs.add("-Werror")
+                }
             }
             withType<ProcessResources>().configureEach {
                 filteringCharset = "UTF-8"

checksum.xml

@@ -12,12 +12,17 @@
     <trusted-key id='105cb91cac2aee0e' group='com.github.autostyle' />
     <trusted-key id='3c0a8f4744f37328' group='com.github.ben-manes.caffeine' />
     <trusted-key id='8ea48d105232855d' group='com.github.jknack' />
+    <trusted-key id='218fa0f6a941a037' group='com.github.kevinstern' />
     <trusted-key id='461a804f2609fd89' group='com.github.shyiko.klob' />
     <trusted-key id='1756b920eecf0e90' group='com.github.spotbugs' />
     <trusted-key id='a5def5a76f94a471' group='com.github.spotbugs' />
     <trusted-key id='78fcd238c26ea995' group='com.github.tomakehurst' />
     <trusted-key id='105cb91cac2aee0e' group='com.github.vlsi.gradle' />
     <trusted-key id='254e9c64c264c176' group='com.github.weisj' />
+    <trusted-key id='5e1f79a7c298661e' group='com.google.auto' />
+    <trusted-key id='c51e6cbc7ff46f0b' group='com.google.auto.service' />
+    <trusted-key id='b0f3710fa64900e7' group='com.google.auto.value' />
+    <trusted-key id='353a436e043e3145' group='com.google.code.findbugs' />
     <trusted-key id='59a252fb1199d873' group='com.google.code.findbugs' />
     <trusted-key id='7a01b0f236e5430f' group='com.google.code.gson' />
     <trusted-key id='1669c4bb543e0445' group='com.google.errorprone' />
@@ -28,7 +33,9 @@
     <trusted-key id='abe9f3126bb741c1' group='com.google.guava' />
     <trusted-key id='f6d4a1d411e9d1ae' group='com.google.guava' />
     <trusted-key id='29579f18fa8fd93b' group='com.google.j2objc' />
+    <trusted-key id='a7764f502a938c99' group='com.google.protobuf' />
     <trusted-key id='7eb97d110dfadd60' group='com.googlecode.concurrent-trees' />
+    <trusted-key id='476634a4694e716a' group='com.googlecode.java-diff-utils' />
     <trusted-key id='72475fd306b9cab7' group='com.googlecode.javaewah' />
     <trusted-key id='e57428da9e879e7d' group='com.helger' />
     <trusted-key id='3684155e9365c30e' group='com.jayway.jsonpath' />
@@ -144,6 +151,7 @@
     <trusted-key id='7c7d8456294423ba' group='org.objenesis' />
     <trusted-key id='85911f425ec61b51' group='org.opentest4j' />
     <trusted-key id='5f69ad087600b22c' group='org.ow2.asm' />
+    <trusted-key id='2be5d98f751f4136' group='org.pcollections' />
     <trusted-key id='1364c5e2df3e99c5' group='org.reactivestreams' />
     <trusted-key id='2c7b12f2a511e325' group='org.slf4j' />
     <trusted-key id='cfca4a29d26468de' group='org.sonarsource.scanner.api' />
@@ -152,6 +160,7 @@
     <trusted-key id='af0a94402ea0a67f' group='org.spockframework' />
     <trusted-key id='9a2c7a98e457c53d' group='org.springframework' />
     <trusted-key id='e4b53844e02b191b' group='org.swinglabs' />
+    <trusted-key id='72385ff0af338d52' group='org.threeten' />
     <trusted-key id='a2115ae15f6b8b72' group='org.xmlunit' />
     <trusted-key id='9ff25980f5ba7e4f' group='xalan' />
     <trusted-key id='858fc4c4f43856a3' group='xerces' />
@@ -188,6 +197,9 @@
     <dependency group='net.jcip' module='jcip-annotations' version='1.0'>
       <sha512>CB312B3F571D91EF183C119D878F50464FFD97F853B7311CBA386463F295E8B7B3A5A89ED4269A045CACD5AA7CB4C803D4882854A0FDDEFA9BBC28C72AA6C786</sha512>
     </dependency>
+    <dependency group='net.ltgt.gradle' module='gradle-errorprone-plugin' version='1.2.1'>
+      <sha512>DC1FA477AE67F94B7CA427F1F88FD3C56E562EB3ED92A3CBC4CC116258EB3856F4B53C99506FDC279F6983EAE74BA21271E4A152F5DB8B41392FFCBB6B087C78</sha512>
+    </dependency>
     <dependency group='net.sf.ezmorph' module='ezmorph' version='1.0.6'>
       <sha512>16D30BE564723B74F312B4E7D06F349370FB6726B3162778C869CD723ECA2A40C4972C2757B3E107E1820CEC0D70B0BD2B96EFCD466518FC64495F7AEF97967A</sha512>
     </dependency>

extras/startup.bsh

@@ -33,7 +33,6 @@ bsh.system.shutdownOnExit = false;
 print("Startup script running");
 
 import org.apache.jmeter.util.JMeterUtils;
-import org.apache.jorphan.logging.LoggingManager;
 
 getprop(p){// get a JMeter property
 return JMeterUtils.getPropDefault(p,"");
@@ -49,7 +48,8 @@ print(p + " = " + getprop(p));
 }
 
 loglevel(String priority, String category){
-LoggingManager.setPriority(priority, category);
+// Previous implementation delegated the call to LoggingManager which
+// was deprecated since JMeter 3.2
 }
 
 logdebug(String text){

gradle.properties

@@ -34,6 +34,7 @@ jmeter.version=5.3.1
 
 # Tools
 checkstyle.version=8.35
+errorprone.version=2.4.0
 jacoco.version=0.8.5
 spotbugs.version=4.1.2
 velocity.version=1.7
@@ -44,6 +45,7 @@ com.github.spotbugs.version=4.5.0
 com.github.vlsi.checksum-dependency.sha512=4D1A76F38F327CEA0C723D9BDD9ABFE16933769052F47BCECD555DDD1A6CD0A9C21E3CC8F9E1B92780F9B443070D4844889EE9ECB0690D30E50AAB085096D8E1
 com.github.vlsi.checksum-dependency.version=1.70
 com.github.vlsi.vlsi-release-plugins.version=1.70
+net.ltgt.errorprone.version=1.2.1
 org.jetbrains.gradle.plugin.idea-ext.version=0.5
 org.nosphere.apache.rat.version=0.7.0
 org.sonarqube.version=3.0

settings.gradle.kts

@@ -26,6 +26,7 @@ pluginManagement {
         idv("com.github.vlsi.gradle-extensions", "com.github.vlsi.vlsi-release-plugins")
         idv("com.github.vlsi.ide", "com.github.vlsi.vlsi-release-plugins")
         idv("com.github.vlsi.stage-vote-release", "com.github.vlsi.vlsi-release-plugins")
+        idv("net.ltgt.errorprone")
         idv("org.jetbrains.gradle.plugin.idea-ext")
         idv("org.nosphere.apache.rat")
         idv("org.sonarqube")

src/bshclient/src/main/java/org/apache/jmeter/util/BeanShellClient.java

@@ -17,12 +17,14 @@
 
 package org.apache.jmeter.util;
 
-import java.io.FileReader;
+import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStream;
-import java.io.InputStreamReader;
 import java.io.OutputStream;
 import java.net.Socket;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Paths;
 
 // N.B. Do not call any JMeter methods; the jar is standalone
 
@@ -65,7 +67,7 @@ public static void main(String [] args) throws Exception{
             sendLine("};", os);
 
             int b;
-            try (InputStreamReader fis = new FileReader(file)) {
+            try (BufferedReader fis = Files.newBufferedReader(Paths.get(file))) {
                 while ((b = fis.read()) != -1) {
                     os.write(b);
                 }
@@ -80,7 +82,7 @@ public static void main(String [] args) throws Exception{
     private static void sendLine( String line, OutputStream outPipe )
     throws IOException
     {
-        outPipe.write( line.getBytes() ); // TODO - charset?
+        outPipe.write(line.getBytes(StandardCharsets.UTF_8));
         outPipe.flush();
     }
 
@@ -93,6 +95,7 @@ public SockRead(InputStream _is) {
         }
 
         @Override
+        @SuppressWarnings("CatchAndPrintStackTrace")
         public void run(){
             System.out.println("Reading responses from server ...");
             int x = 0;

src/components/src/main/java/org/apache/jmeter/assertions/CompareAssertion.java

@@ -18,8 +18,8 @@
 package org.apache.jmeter.assertions;
 
 import java.io.Serializable;
+import java.util.ArrayList;
 import java.util.Collection;
-import java.util.LinkedList;
 import java.util.List;
 
 import org.apache.jmeter.engine.event.LoopIterationEvent;
@@ -170,7 +170,7 @@ private String filterString(final String content) {
 
     @Override
     public void iterationStart(LoopIterationEvent iterEvent) {
-        responses = new LinkedList<>();
+        responses = new ArrayList<>();
     }
 
     /**

src/components/src/main/java/org/apache/jmeter/assertions/HTMLAssertion.java

@@ -19,12 +19,14 @@
 
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
-import java.io.FileWriter;
 import java.io.IOException;
 import java.io.PrintWriter;
 import java.io.Serializable;
 import java.io.StringWriter;
+import java.io.Writer;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Paths;
 import java.text.MessageFormat;
 
 import org.apache.commons.lang3.StringUtils;
@@ -191,7 +193,7 @@ private void writeOutput(String inOutput) {
 
         // check if filename defined
         if (StringUtils.isNotBlank(filename)) {
-            try (FileWriter writer = new FileWriter(filename, false)){
+            try (Writer writer = Files.newBufferedWriter(Paths.get(filename))) {
                 // write to file
                 writer.write(inOutput);
                 log.debug("writeOutput() -> output successfully written to file: {}", filename);

src/components/src/main/java/org/apache/jmeter/assertions/XMLAssertion.java

@@ -21,6 +21,9 @@
 import java.io.Serializable;
 import java.io.StringReader;
 
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.parsers.SAXParserFactory;
+
 import org.apache.jmeter.samplers.SampleResult;
 import org.apache.jmeter.testelement.AbstractTestElement;
 import org.apache.jmeter.testelement.ThreadListener;
@@ -29,7 +32,6 @@
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
 import org.xml.sax.XMLReader;
-import org.xml.sax.helpers.XMLReaderFactory;
 
 /**
  * Checks if the result is a well-formed XML content using {@link XMLReader}
@@ -45,10 +47,12 @@ public class XMLAssertion extends AbstractTestElement implements Serializable, A
         @Override
         protected XMLReader initialValue() {
             try {
-                XMLReader reader = XMLReaderFactory.createXMLReader();
+                XMLReader reader = SAXParserFactory.newInstance()
+                        .newSAXParser()
+                        .getXMLReader();
                 reader.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
                 return reader;
-            } catch (SAXException e) {
+            } catch (SAXException | ParserConfigurationException e) {
                 log.error("Error initializing XMLReader in XMLAssertion", e);
                 return null;
             }

src/components/src/main/java/org/apache/jmeter/config/CSVDataSet.java

@@ -219,21 +219,21 @@ private void initVars(FileServer server, final JMeterContext context, String del
         trimVarNames(vars);
     }
 
-    private void setAlias(final JMeterContext context, String fileName) {
+    private void setAlias(final JMeterContext context, String alias) {
         String mode = getShareMode();
         int modeInt = CSVDataSetBeanInfo.getShareModeAsInt(mode);
         switch(modeInt){
             case CSVDataSetBeanInfo.SHARE_ALL:
-                alias = fileName;
+                this.alias = alias;
                 break;
             case CSVDataSetBeanInfo.SHARE_GROUP:
-                alias = fileName+"@"+System.identityHashCode(context.getThreadGroup());
+                this.alias = alias + "@" + System.identityHashCode(context.getThreadGroup());
                 break;
             case CSVDataSetBeanInfo.SHARE_THREAD:
-                alias = fileName+"@"+System.identityHashCode(context.getThread());
+                this.alias = alias + "@" + System.identityHashCode(context.getThread());
                 break;
             default:
-                alias = fileName+"@"+mode; // user-specified key
+                this.alias = alias + "@" + mode; // user-specified key
                 break;
         }
     }