Merge pull request #935 from jenkinsci/java-17

Run OpenRewrite on all files to migrate to Java 17

Author: uhafner

plugin/pom.xml

@@ -4,30 +4,19 @@
   <parent>
     <groupId>org.jvnet.hudson.plugins</groupId>
     <artifactId>analysis-pom</artifactId>
-    <version>10.4.0</version>
+    <version>10.5.0</version>
     <relativePath />
   </parent>
 
-  <artifactId>git-forensics</artifactId>
   <groupId>io.jenkins.plugins</groupId>
+  <artifactId>git-forensics</artifactId>
+  <version>3.2.0-SNAPSHOT</version>
   <packaging>hpi</packaging>
   <name>Git Forensics Plugin</name>
-  <version>3.2.0-SNAPSHOT</version>
 
   <description>Jenkins plug-in that mines and analyzes data from a Git repository.</description>
   <url>https://github.com/jenkinsci/git-forensics-plugin</url>
 
-  <properties>
-    <module.name>${project.groupId}.git.forensics</module.name>
-
-    <!-- Library Dependencies Versions -->
-    <eclipse-collections.version>9.2.0</eclipse-collections.version>
-    <testcontainers.version>1.20.5</testcontainers.version>
-
-    <!-- Maven Surefire ArgLine -->
-    <argLine>-Djava.awt.headless=true -Xmx1024m -Djenkins.test.timeout=1000 --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.io=ALL-UNNAMED --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.util.concurrent=ALL-UNNAMED</argLine>
-  </properties>
-
   <licenses>
     <license>
       <name>MIT license</name>
@@ -43,6 +32,24 @@
     </developer>
   </developers>
 
+  <scm>
+    <connection>scm:git:https://github.com/jenkinsci/${project.artifactId}-plugin.git</connection>
+    <developerConnection>scm:git:[email protected]:jenkinsci/${project.artifactId}-plugin.git</developerConnection>
+    <url>https://github.com/jenkinsci/${project.artifactId}-plugin</url>
+    <tag>v1.6.0</tag>
+  </scm>
+
+  <properties>
+    <module.name>${project.groupId}.git.forensics</module.name>
+
+    <!-- Library Dependencies Versions -->
+    <eclipse-collections.version>9.2.0</eclipse-collections.version>
+    <testcontainers.version>1.20.5</testcontainers.version>
+
+    <!-- Maven Surefire ArgLine -->
+    <argLine>-Djava.awt.headless=true -Xmx1024m -Djenkins.test.timeout=1000 --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.io=ALL-UNNAMED --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.util.concurrent=ALL-UNNAMED</argLine>
+  </properties>
+
   <dependencies>
     <!-- Project Dependencies -->
     <dependency>
@@ -154,6 +161,23 @@
     </dependency>
 
   </dependencies>
+  <repositories>
+    <repository>
+      <id>incrementals.jenkins-ci.org</id>
+      <url>https://repo.jenkins-ci.org/incrementals/</url>
+    </repository>
+    <repository>
+      <id>repo.jenkins-ci.org</id>
+      <url>https://repo.jenkins-ci.org/public/</url>
+    </repository>
+  </repositories>
+
+  <pluginRepositories>
+    <pluginRepository>
+      <id>repo.jenkins-ci.org</id>
+      <url>https://repo.jenkins-ci.org/public/</url>
+    </pluginRepository>
+  </pluginRepositories>
 
   <build>
     <plugins>
@@ -182,30 +206,6 @@
 
     </plugins>
   </build>
-  <scm>
-    <connection>scm:git:https://github.com/jenkinsci/${project.artifactId}-plugin.git</connection>
-    <developerConnection>scm:git:[email protected]:jenkinsci/${project.artifactId}-plugin.git</developerConnection>
-    <url>https://github.com/jenkinsci/${project.artifactId}-plugin</url>
-    <tag>v1.6.0</tag>
-  </scm>
-
-  <repositories>
-    <repository>
-      <id>incrementals.jenkins-ci.org</id>
-      <url>https://repo.jenkins-ci.org/incrementals/</url>
-    </repository>
-    <repository>
-      <id>repo.jenkins-ci.org</id>
-      <url>https://repo.jenkins-ci.org/public/</url>
-    </repository>
-  </repositories>
-
-  <pluginRepositories>
-    <pluginRepository>
-      <id>repo.jenkins-ci.org</id>
-      <url>https://repo.jenkins-ci.org/public/</url>
-    </pluginRepository>
-  </pluginRepositories>
 
 </project>
 

plugin/src/main/java/io/jenkins/plugins/forensics/git/blame/GitBlamer.java

@@ -1,16 +1,11 @@
 package io.jenkins.plugins.forensics.git.blame;
 
-import java.io.IOException;
-import java.util.Optional;
-import java.util.stream.StreamSupport;
-
 import org.eclipse.jgit.api.BlameCommand;
 import org.eclipse.jgit.api.Git;
 import org.eclipse.jgit.api.errors.GitAPIException;
 import org.eclipse.jgit.api.errors.JGitInternalException;
 import org.eclipse.jgit.blame.BlameResult;
 import org.eclipse.jgit.lib.ObjectId;
-import org.eclipse.jgit.lib.PersonIdent;
 import org.eclipse.jgit.lib.Repository;
 import org.eclipse.jgit.revwalk.RevCommit;
 
@@ -19,6 +14,11 @@
 import edu.umd.cs.findbugs.annotations.CheckForNull;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 
+import java.io.IOException;
+import java.io.Serial;
+import java.util.Optional;
+import java.util.stream.StreamSupport;
+
 import org.jenkinsci.plugins.gitclient.GitClient;
 import hudson.plugins.git.GitException;
 import hudson.remoting.VirtualChannel;
@@ -45,6 +45,7 @@
 // TODO: Blame needs only run for new warnings
 @SuppressFBWarnings(value = "SE", justification = "GitClient implementation is Serializable")
 class GitBlamer extends Blamer {
+    @Serial
     private static final long serialVersionUID = -619059996626444900L;
 
     static final String NO_HEAD_ERROR = "Could not retrieve HEAD commit, aborting";
@@ -70,13 +71,13 @@ class GitBlamer extends Blamer {
 
     @Override
     public Blames blame(final FileLocations locations, final FilteredLog log) {
-        Blames blames = new Blames();
+        var blames = new Blames();
         try {
             log.logInfo("Invoking Git blamer to create author and commit information for %d affected files",
                     locations.size());
             log.logInfo("-> GIT_COMMIT env = '%s'", gitCommit);
 
-            ObjectId headCommit = git.revParse(gitCommit);
+            var headCommit = git.revParse(gitCommit);
             if (headCommit == null) {
                 log.logError(NO_HEAD_ERROR);
                 return blames;
@@ -106,6 +107,7 @@ public Blames blame(final FileLocations locations, final FilteredLog log) {
      * Starts the blame commands.
      */
     static class BlameCallback extends AbstractRepositoryCallback<RemoteResultWrapper<Blames>> {
+        @Serial
         private static final long serialVersionUID = 8794666938104738260L;
         private static final int WHOLE_FILE = 0;
 
@@ -129,15 +131,15 @@ public RemoteResultWrapper<Blames> invoke(final Repository repository, final Vir
                 log.logInfo("-> Git commit ID = '%s'", headCommit.getName());
                 log.logInfo("-> Git working tree = '%s'", getWorkTree(repository));
 
-                BlameRunner blameRunner = new BlameRunner(repository, headCommit);
-                LastCommitRunner lastCommitRunner = new LastCommitRunner(repository);
+                var blameRunner = new BlameRunner(repository, headCommit);
+                var lastCommitRunner = new LastCommitRunner(repository);
 
-                FileBlameBuilder builder = new FileBlameBuilder();
+                var builder = new FileBlameBuilder();
                 for (String file : locations.getFiles()) {
                     run(builder, file, blameRunner, lastCommitRunner, log);
 
                     if (Thread.interrupted()) { // Cancel request by user
-                        String message = "Blaming has been interrupted while computing blame information";
+                        var message = "Blaming has been interrupted while computing blame information";
                         log.logInfo(message);
 
                         throw new InterruptedException(message);
@@ -168,13 +170,13 @@ public RemoteResultWrapper<Blames> invoke(final Repository repository, final Vir
         void run(final FileBlameBuilder builder, final String relativePath, final BlameRunner blameRunner,
                 final LastCommitRunner lastCommitRunner, final FilteredLog log) {
             try {
-                BlameResult blame = blameRunner.run(relativePath);
+                var blame = blameRunner.run(relativePath);
                 if (blame == null) {
                     log.logError("- no blame results for file '%s'", relativePath);
                 }
                 else {
                     for (int line : locations.getLines(relativePath)) {
-                        FileBlame fileBlame = builder.build(relativePath);
+                        var fileBlame = builder.build(relativePath);
                         if (line <= 0) {
                             fillWithLastCommit(relativePath, fileBlame, lastCommitRunner);
                         }
@@ -194,7 +196,7 @@ else if (line <= blame.getResultContents().size()) {
         private void fillWithBlameResult(final String fileName, final FileBlame fileBlame, final BlameResult blame,
                 final int line, final FilteredLog log) {
             int lineIndex = line - 1; // first line is index 0
-            PersonIdent who = blame.getSourceAuthor(lineIndex);
+            var who = blame.getSourceAuthor(lineIndex);
             if (who == null) {
                 who = blame.getSourceCommitter(lineIndex);
             }
@@ -206,7 +208,7 @@ private void fillWithBlameResult(final String fileName, final FileBlame fileBlam
                 fileBlame.setName(line, who.getName());
                 fileBlame.setEmail(line, who.getEmailAddress());
             }
-            RevCommit commit = blame.getSourceCommit(lineIndex);
+            var commit = blame.getSourceCommit(lineIndex);
             if (commit == null) {
                 log.logError("- no commit ID and time found for line %d in file %s", lineIndex, fileName);
             }
@@ -220,9 +222,9 @@ private void fillWithLastCommit(final String relativePath, final FileBlame fileB
                 final LastCommitRunner lastCommitRunner) throws GitAPIException {
             Optional<RevCommit> commit = lastCommitRunner.run(relativePath);
             if (commit.isPresent()) {
-                RevCommit revCommit = commit.get();
+                var revCommit = commit.get();
                 fileBlame.setCommit(WHOLE_FILE, revCommit.getName());
-                PersonIdent who = revCommit.getAuthorIdent();
+                var who = revCommit.getAuthorIdent();
                 if (who == null) {
                     who = revCommit.getCommitterIdent();
                 }
@@ -248,7 +250,7 @@ static class BlameRunner {
 
         @CheckForNull
         BlameResult run(final String fileName) throws GitAPIException {
-            BlameCommand blame = new BlameCommand(repo);
+            var blame = new BlameCommand(repo);
             blame.setFilePath(fileName);
             blame.setStartCommit(headCommit);
             return blame.call();
@@ -266,7 +268,7 @@ static class LastCommitRunner {
         }
 
         Optional<RevCommit> run(final String fileName) throws GitAPIException {
-            try (Git git = new Git(repo)) {
+            try (var git = new Git(repo)) {
                 Iterable<RevCommit> commits = git.log().addPath(fileName).call();
 
                 return StreamSupport.stream(commits.spliterator(), false).findFirst();

plugin/src/main/java/io/jenkins/plugins/forensics/git/blame/GitBlamerFactory.java

@@ -1,11 +1,10 @@
 package io.jenkins.plugins.forensics.git.blame;
 
-import java.util.Optional;
-
 import edu.hm.hafner.util.FilteredLog;
 import edu.hm.hafner.util.PathUtil;
 
-import org.jenkinsci.plugins.gitclient.GitClient;
+import java.util.Optional;
+
 import hudson.Extension;
 import hudson.FilePath;
 import hudson.model.Run;
@@ -17,7 +16,7 @@
 import io.jenkins.plugins.forensics.git.util.GitRepositoryValidator;
 
 /**
- * A {@link BlamerFactory} for Git. Handles Git repositories that do not have option ShallowClone set.
+ * A {@link BlamerFactory} for Git. Handles Git repositories that do not have the option ShallowClone set.
  *
  * @author Ullrich Hafner
  */
@@ -26,9 +25,9 @@ public class GitBlamerFactory extends BlamerFactory {
     @Override
     public Optional<Blamer> createBlamer(final SCM scm, final Run<?, ?> build,
             final FilePath workTree, final TaskListener listener, final FilteredLog logger) {
-        GitRepositoryValidator validator = new GitRepositoryValidator(scm, build, workTree, listener, logger);
+        var validator = new GitRepositoryValidator(scm, build, workTree, listener, logger);
         if (validator.isGitRepository()) {
-            GitClient client = validator.createClient();
+            var client = validator.createClient();
             logger.logInfo("-> Git blamer successfully created in working tree '%s'",
                     new PathUtil().getAbsolutePath(client.getWorkTree().getRemote()));
             return Optional.of(new GitBlamer(client, validator.getHead()));

plugin/src/main/java/io/jenkins/plugins/forensics/git/blame/package-info.java

@@ -1,7 +1,7 @@
 /**
  * Provides classes to run `git blame`. Using this service, plugins can show in which Git revisions the lines of a file
  * have been modified by what authors. This information can be used to discover the original commit that is the origin
- * for a piece of problematic code.
+ *  of a problematic code snippet.
  */
 @DefaultAnnotation(NonNull.class)
 package io.jenkins.plugins.forensics.git.blame;