Update SpotBugs

blacelle · blacelle · commit a31709f31604 · 2023-12-04T23:15:59.000+04:00
diff --git a/code-providers/pom.xml b/code-providers/pom.xml
@@ -42,6 +42,14 @@
 			<version>1.3.0</version>
 		</dependency>
 
+		<dependency>
+			<!-- https://stackoverflow.com/questions/1829904/is-there-a-way-to-ignore-a-single-findbugs-warning -->
+			<groupId>com.google.code.findbugs</groupId>
+			<artifactId>annotations</artifactId>
+			<version>3.0.1u2</version>
+			<scope>provided</scope>
+		</dependency>
+
 		<dependency>
 			<groupId>io.github.solven-eu.cleanthat</groupId>
 			<artifactId>test-helpers</artifactId>
diff --git a/code-providers/src/main/java/eu/solven/cleanthat/code_provider/inmemory/FileSystemCodeProvider.java b/code-providers/src/main/java/eu/solven/cleanthat/code_provider/inmemory/FileSystemCodeProvider.java
@@ -38,6 +38,7 @@
 
 import com.google.common.jimfs.Jimfs;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import eu.solven.cleanthat.code_provider.CleanthatPathHelpers;
 import eu.solven.cleanthat.codeprovider.CodeProviderHelpers;
 import eu.solven.cleanthat.codeprovider.DummyCodeProviderFile;
@@ -58,6 +59,8 @@ public class FileSystemCodeProvider implements ICodeProviderWriter {
 	final Path root;
 	final Charset charset;
 
+	@SuppressFBWarnings(value = "CT_CONSTRUCTOR_THROW",
+			justification = "We need to derive this class in FileSystemGitCodeProvider")
 	public FileSystemCodeProvider(Path root, Charset charset) {
 		this.fs = root.getFileSystem();
 		this.root = root.normalize();
@@ -131,7 +134,7 @@ public String toString() {
 		return root.toAbsolutePath().toString();
 	}
 
-	protected Path resolvePath(Path inMemoryPath) {
+	private Path resolvePath(Path inMemoryPath) {
 		return CleanthatPathHelpers.resolveChild(root, inMemoryPath);
 	}
 
@@ -171,7 +174,7 @@ public Optional<String> loadContentForPath(Path path) throws IOException {
 		return safeReadString(pathForRootFS);
 	}
 
-	protected Optional<String> safeReadString(Path pathForRootFS) throws IOException {
+	private Optional<String> safeReadString(Path pathForRootFS) throws IOException {
 		if (Files.exists(pathForRootFS)) {
 			String asString;
 			try {
diff --git a/code-providers/src/main/java/eu/solven/cleanthat/codeprovider/DummyCodeProviderFile.java b/code-providers/src/main/java/eu/solven/cleanthat/codeprovider/DummyCodeProviderFile.java
@@ -25,7 +25,7 @@
  * @author Benoit Lacelle
  *
  */
-public class DummyCodeProviderFile implements ICodeProviderFile {
+public final class DummyCodeProviderFile implements ICodeProviderFile {
 	private final Path path;
 	private final Object raw;
 
diff --git a/code-providers/src/main/java/eu/solven/cleanthat/codeprovider/git/GitRepoBranchSha1.java b/code-providers/src/main/java/eu/solven/cleanthat/codeprovider/git/GitRepoBranchSha1.java
@@ -25,7 +25,7 @@
  *
  */
 // https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#webhook-payload-example-32
-public class GitRepoBranchSha1 {
+public final class GitRepoBranchSha1 {
 	final String repoName;
 	final String ref;
 	final String sha;
diff --git a/code-providers/src/main/java/eu/solven/cleanthat/codeprovider/git/GitWebhookRelevancyResult.java b/code-providers/src/main/java/eu/solven/cleanthat/codeprovider/git/GitWebhookRelevancyResult.java
@@ -23,7 +23,7 @@
  * @author Benoit Lacelle
  *
  */
-public class GitWebhookRelevancyResult implements IExternalWebhookRelevancyResult {
+public final class GitWebhookRelevancyResult implements IExternalWebhookRelevancyResult {
 	final boolean rrOpen;
 	final boolean pushRef;
 	final Optional<GitRepoBranchSha1> optRef;
diff --git a/config/src/main/java/eu/solven/cleanthat/utils/ResultOrError.java b/config/src/main/java/eu/solven/cleanthat/utils/ResultOrError.java
@@ -25,7 +25,7 @@
  * @param <R>
  * @param <E>
  */
-public class ResultOrError<R, E> {
+public final class ResultOrError<R, E> {
 	final Optional<R> optResult;
 	final Optional<E> optError;
 
diff --git a/github/pom.xml b/github/pom.xml
@@ -87,6 +87,15 @@
 			<groupId>com.squareup.okhttp3</groupId>
 			<artifactId>okhttp</artifactId>
 		</dependency>
+
+		<dependency>
+			<!-- https://stackoverflow.com/questions/1829904/is-there-a-way-to-ignore-a-single-findbugs-warning -->
+			<groupId>com.google.code.findbugs</groupId>
+			<artifactId>annotations</artifactId>
+			<version>3.0.1u2</version>
+			<scope>provided</scope>
+		</dependency>
+
 		<dependency>
 			<!-- Enables loading a PEM file -->
 			<groupId>org.bouncycastle</groupId>
diff --git a/github/src/main/java/eu/solven/cleanthat/code_provider/github/event/GithubAppFactory.java b/github/src/main/java/eu/solven/cleanthat/code_provider/github/event/GithubAppFactory.java
@@ -43,6 +43,7 @@
 import com.nimbusds.jose.crypto.impl.RSAKeyUtils;
 import com.nimbusds.jose.jwk.RSAKey;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import eu.solven.cleanthat.code_provider.github.event.pojo.WebhookRelevancyResult;
 import eu.solven.cleanthat.utils.ResultOrError;
 import okhttp3.OkHttpClient;
@@ -53,6 +54,8 @@
  * @author Benoit Lacelle
  *
  */
+// https://github.com/spotbugs/spotbugs/issues/2695
+@SuppressFBWarnings("CT_CONSTRUCTOR_THROW")
 public class GithubAppFactory implements IGithubAppFactory {
 	private static final int PUBLIC_CHARS_IN_TOKEN = 10;
 
@@ -108,7 +111,7 @@ private ImmutableMap<String, GHPermissionType> getRequestedPermissions() {
 				.build();
 	}
 
-	protected GitHub makeInstallationGithub(GitHub github, String appToken) throws IOException {
+	private GitHub makeInstallationGithub(GitHub github, String appToken) throws IOException {
 		GitHubConnector ghConnector = createGithubConnector();
 		return new GitHubBuilder().withEndpoint(github.getApiUrl())
 				.withAppInstallationToken(appToken)
diff --git a/github/src/main/java/eu/solven/cleanthat/code_provider/github/event/GithubWebhookHandler.java b/github/src/main/java/eu/solven/cleanthat/code_provider/github/event/GithubWebhookHandler.java
@@ -59,7 +59,7 @@
  */
 // https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads
 @SuppressWarnings("PMD.GodClass")
-public class GithubWebhookHandler implements IGithubWebhookHandler {
+public final class GithubWebhookHandler implements IGithubWebhookHandler {
 	private static final String EOL = "\r\n";
 
 	private static final Logger LOGGER = LoggerFactory.getLogger(GithubWebhookHandler.class);
@@ -100,7 +100,7 @@ public GHApp getGithubAsApp() {
 	 * @return an {@link Optional} rejection reason
 	 * @throws IOException
 	 */
-	protected Optional<String> checkMarketPlacePlan(GHAppInstallation appInstallation, GHRepository ghRepository)
+	private Optional<String> checkMarketPlacePlan(GHAppInstallation appInstallation, GHRepository ghRepository)
 			throws IOException {
 		// https://github.com/hub4j/github-api/issues/1613
 		GHMarketplaceAccount account = appInstallation.getMarketplaceAccount();
diff --git a/github/src/main/java/eu/solven/cleanthat/code_provider/github/refs/AGithubDiffCodeProvider.java b/github/src/main/java/eu/solven/cleanthat/code_provider/github/refs/AGithubDiffCodeProvider.java
@@ -32,6 +32,7 @@
 import com.google.common.base.Supplier;
 import com.google.common.base.Suppliers;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import eu.solven.cleanthat.code_provider.CleanthatPathHelpers;
 import eu.solven.cleanthat.code_provider.github.code_provider.AGithubCodeProvider;
 import eu.solven.cleanthat.code_provider.github.code_provider.FileIsTooBigException;
@@ -56,6 +57,7 @@ public abstract class AGithubDiffCodeProvider extends AGithubCodeProvider implem
 
 	final Supplier<GHCompare> diffSupplier;
 
+	@SuppressFBWarnings(value = "CT_CONSTRUCTOR_THROW", justification = "Unclear FB case")
 	public AGithubDiffCodeProvider(Path repositoryRoot, String token, GHRepository baseRepository) {
 		super(repositoryRoot);
 		this.token = token;
diff --git a/github/src/main/java/eu/solven/cleanthat/git_abstraction/GithubFacade.java b/github/src/main/java/eu/solven/cleanthat/git_abstraction/GithubFacade.java
@@ -36,7 +36,7 @@
  * @author Benoit Lacelle
  *
  */
-public class GithubFacade {
+public final class GithubFacade {
 	private static final Logger LOGGER = LoggerFactory.getLogger(GithubFacade.class);
 
 	final GitHub github;
diff --git a/parent/pom.xml b/parent/pom.xml
@@ -55,7 +55,7 @@
 		<!-- https://mvnrepository.com/artifact/com.diffplug.spotless/spotless-maven-plugin -->
 		<spotless.version>2.41.1</spotless.version>
 		<!-- https://mvnrepository.com/artifact/com.github.spotbugs/spotbugs-maven-plugin -->
-		<spotbugs.version>4.7.3.6</spotbugs.version>
+		<spotbugs.version>4.8.2.0</spotbugs.version>
 		<!-- https://mvnrepository.com/artifact/org.apache.maven.plugins/maven-pmd-plugin -->
 		<maven-pmd-plugin.version>3.21.2</maven-pmd-plugin.version>
 		<!-- https://mvnrepository.com/artifact/net.sourceforge.pmd/pmd -->
diff --git a/runnable/src/main/java/eu/solven/cleanthat/logback/LocalDumperAppender.java b/runnable/src/main/java/eu/solven/cleanthat/logback/LocalDumperAppender.java
@@ -51,6 +51,10 @@ protected List<byte[]> initialValue() {
 	 */
 	protected Encoder<ILoggingEvent> encoder;
 
+	public void setEncoder(Encoder<ILoggingEvent> encoder) {
+		this.encoder = encoder;
+	}
+
 	@Override
 	protected void append(ILoggingEvent event) {
 		byte[] byteArray = this.encoder.encode(event);
diff --git a/spotless/src/main/java/eu/solven/cleanthat/spotless/pojo/SpotlessFormatterProperties.java b/spotless/src/main/java/eu/solven/cleanthat/spotless/pojo/SpotlessFormatterProperties.java
@@ -39,7 +39,7 @@
 @Data
 @Builder
 @Jacksonized
-public class SpotlessFormatterProperties {
+public final class SpotlessFormatterProperties {
 	// If left to default, we will rely on the engine encoding
 	private String encoding;
 
diff --git a/spotless/src/main/java/eu/solven/cleanthat/spotless/pojo/SpotlessStepProperties.java b/spotless/src/main/java/eu/solven/cleanthat/spotless/pojo/SpotlessStepProperties.java
@@ -36,7 +36,7 @@
 @Builder
 @Jacksonized
 // @JsonDeserialize(converter = SpotlessStepPropertiesSanitizer.class)
-public class SpotlessStepProperties {
+public final class SpotlessStepProperties {
 
 	// the step name/id
 	@lombok.NonNull

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`* @author Benoit Lacelle`
`26`	`26`	`*`
`27`	`27`	`*/`
`28`		`-public class DummyCodeProviderFile implements ICodeProviderFile {`
	`28`	`+public final class DummyCodeProviderFile implements ICodeProviderFile {`
`29`	`29`	`private final Path path;`
`30`	`30`	`private final Object raw;`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`* @author Benoit Lacelle`
`24`	`24`	`*`
`25`	`25`	`*/`
`26`		`-public class GitWebhookRelevancyResult implements IExternalWebhookRelevancyResult {`
	`26`	`+public final class GitWebhookRelevancyResult implements IExternalWebhookRelevancyResult {`
`27`	`27`	`final boolean rrOpen;`
`28`	`28`	`final boolean pushRef;`
`29`	`29`	`final Optional<GitRepoBranchSha1> optRef;`