Skip to content

build: replace FindBugs with SpotBugs #2174

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

Open
arnabnandy7 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

build: replace FindBugs with SpotBugs #2174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions google-http-client-findbugs/google-http-client-findbugs-test/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.google.http-client</groupId>
<artifactId>google-http-client-findbugs-test</artifactId>
<version>1.15.0-rc-SNAPSHOT</version>
<name>Findbugs Google API Client Library plugin test.</name>
<version>2.1.2-SNAPSHOT</version>
<name>SpotBugs Google API Client Library plugin test.</name>
<packaging>jar</packaging>
<build>
<plugins>
Expand All @@ -30,9 +30,9 @@
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
<version>3.0.5</version>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
<version>4.8.6.8</version>
<configuration>
<plugins>
<plugin>
Expand Down
32 changes: 9 additions & 23 deletions google-http-client-findbugs/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@
</parent>
<artifactId>google-http-client-findbugs</artifactId>
<version>2.1.2-SNAPSHOT</version><!-- {x-version-update:google-http-client-findbugs:current} -->
<name>Google APIs Client Library Findbugs custom plugin.</name>
<name>Google APIs Client Library SpotBugs custom plugin.</name>
<description>
SpotBugs plugin for detecting usages of beta Google HTTP Client APIs. The artifact ID retains
its historical name for compatibility.
</description>

<build>
<pluginManagement>
Expand Down Expand Up @@ -50,28 +54,10 @@
</build>
<dependencies>
<dependency>
<groupId>com.google.code.findbugs</groupId>
<artifactId>findbugs</artifactId>
<version>3.0.1</version>
<exclusions>
<exclusion>
<artifactId>xalan</artifactId>
<groupId>xalan</groupId>
</exclusion>
<exclusion>
<artifactId>xmlParserAPIs</artifactId>
<groupId>xerces</groupId>
</exclusion>
<exclusion>
<artifactId>annotations</artifactId>
<groupId>com.google.code.findbugs</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>com.google.code.findbugs</groupId>
<artifactId>bcel-findbugs</artifactId>
<version>6.0</version>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs</artifactId>
<version>4.8.6</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.google.http-client</groupId>
Expand Down
37 changes: 16 additions & 21 deletions google-http-client-findbugs/src/main/java/com/google/api/client/findbugs/BetaDetector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
import edu.umd.cs.findbugs.BugInstance;
import edu.umd.cs.findbugs.BugReporter;
import edu.umd.cs.findbugs.bcel.OpcodeStackDetector;
import edu.umd.cs.findbugs.visitclass.Constants2;
import org.apache.bcel.Const;
import org.apache.bcel.Constants;
import org.apache.bcel.Repository;
import org.apache.bcel.classfile.AnnotationEntry;
import org.apache.bcel.classfile.ConstantClass;
Expand All @@ -26,11 +29,11 @@
import org.apache.bcel.classfile.Method;

/**
* Findbugs plugin detector which detects usage of {@link Beta} in your code.
* SpotBugs plugin detector which detects usage of {@link Beta} in your code.
*
* @author Eyal Peled
*/
public class BetaDetector extends OpcodeStackDetector {
public class BetaDetector extends OpcodeStackDetector implements Constants, Constants2 {

/** Beta annotation "signature". */
private static final String BETA_ANNOTATION = "Lcom/google/api/client/util/Beta;";
Expand All @@ -54,33 +57,25 @@ public BetaDetector(BugReporter bugReporter) {
@Override
public void sawOpcode(int seen) {
switch (seen) {
case INVOKEINTERFACE:
case INVOKESTATIC:
case INVOKESPECIAL:
case INVOKEVIRTUAL:
case Const.INVOKEINTERFACE:
case Const.INVOKESTATIC:
case Const.INVOKESPECIAL:
case Const.INVOKEVIRTUAL:
// Method usage
checkMethod(getNameConstantOperand(), getSigConstantOperand());
break;

case GETFIELD:
case GETFIELD_QUICK:
case GETFIELD_QUICK_W:
case PUTFIELD:
case PUTFIELD_QUICK:
case PUTFIELD_QUICK_W:
case GETSTATIC:
case GETSTATIC_QUICK:
case GETSTATIC2_QUICK:
case PUTSTATIC:
case PUTSTATIC_QUICK:
case PUTSTATIC2_QUICK:
case Const.GETFIELD:
case Const.PUTFIELD:
case Const.GETSTATIC:
case Const.PUTSTATIC:
// Field usage
checkField(getNameConstantOperand());
break;

case LDC:
case LDC_W:
case LDC2_W:
case Const.LDC:
case Const.LDC_W:
case Const.LDC2_W:
// Class usage
if (getConstantRefOperand() instanceof ConstantClass) {
// report bug in case it's google api @Beta class
Expand Down
9 changes: 6 additions & 3 deletions google-http-client-findbugs/src/main/java/com/google/api/client/findbugs/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,17 @@
*/

/**
* Findbugs package which supports custom Google APIs Client library findbugs Plugins.
* SpotBugs package which supports the custom Google APIs Client Library SpotBugs plugin.
*
* <p>The artifact ID retains its historical {@code google-http-client-findbugs} name for
* compatibility.
*
* <p>Usage on pom.xml:
*
* <pre>
* &lt;plugin&gt;
* &lt;groupId>org.codehaus.mojo&lt;/groupId&gt;
* &lt;artifactId>findbugs-maven-plugin&lt;/artifactId&gt;
* &lt;groupId&gt;com.github.spotbugs&lt;/groupId&gt;
* &lt;artifactId&gt;spotbugs-maven-plugin&lt;/artifactId&gt;
* ...
* &lt;configuration&gt;
* &lt;plugins&gt;
Expand Down
2 changes: 1 addition & 1 deletion google-http-client-findbugs/src/main/resources/messages.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
xsi:noNamespaceSchemaLocation="messagecollection.xsd">

<Plugin>
<ShortDescription>FindBugs Google API's Client library plugin</ShortDescription>
<ShortDescription>SpotBugs Google APIs Client Library plugin</ShortDescription>
<Details>Provides detectors for Google APIs Client library.</Details>
</Plugin>

Expand Down
5 changes: 3 additions & 2 deletions google-http-client/src/main/java/com/google/api/client/util/Beta.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@
* used in client applications, and if the wrong version of this library is used, it has the
* potential to break client applications.
*
* <p>You may use the google-http-client-findbugs plugin to find usages of API bearing this
* annotation.
* <p>You may use the SpotBugs plugin in the {@code google-http-client-findbugs} artifact to find
* usages of API bearing this annotation. The artifact ID retains its historical name for
* compatibility.
*
* @since 1.15
* @author Eyal Peled
Expand Down
12 changes: 6 additions & 6 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,9 +366,9 @@
<version>3.6.0</version>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
<version>3.0.5</version>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
<version>4.8.6.8</version>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
Expand Down Expand Up @@ -503,10 +503,10 @@
</executions>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
<configuration>
<excludeFilterFile>${basedir}/../findbugs-exclude.xml</excludeFilterFile>
<excludeFilterFile>${basedir}/../spotbugs-exclude.xml</excludeFilterFile>
<plugins>
<plugin>
<groupId>com.google.http-client</groupId>
Expand Down
6 changes: 3 additions & 3 deletions samples/dailymotion-simple-cmdline-sample/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-maven-plugin</artifactId>
<configuration>
<excludeFilterFile>../../findbugs-exclude.xml</excludeFilterFile>
<excludeFilterFile>../../spotbugs-exclude.xml</excludeFilterFile>
<failOnError>false</failOnError>
</configuration>
<executions>
Expand Down
2 changes: 1 addition & 1 deletion findbugs-exclude.xml → spotbugs-exclude.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>

<FindBugsFilter>
<!-- see http://findbugs.sourceforge.net/bugDescriptions.html -->
<!-- see https://spotbugs.readthedocs.io/en/stable/bugDescriptions.html -->
<LastVersion value="-1" relOp="NEQ"/>
<!-- The following have not yet been investigated -->
<!-- TODO(yanivi): investigate them -->
Expand Down
Loading