Switch to SSH transport

jenkins-infra · Dec 17, 2024 · b14006e · b14006e
1 parent d420063
commit b14006e
Show file tree

Hide file tree

Showing 20 changed files with 712 additions and 118 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,14 +3,13 @@ target/
 !**/src/main/**/target/
 !**/src/test/**/target/
 
-### Plugins Directory ###
-test-plugins
-
 ### Log file ###
 logs/
 
 ### IntelliJ IDEA ###
 .idea/
+!.idea/runConfigurations/
+!.idea/.gitignore/
 *.iws
 *.iml
 *.ipr
@@ -34,6 +33,8 @@ build/
 !**/src/main/**/build/
 !**/src/test/**/build/
 
+!**/test/resources/**/.git
+
 ### VS Code ###
 .vscode/
 

diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/...cli/src/main/java/io/jenkins/tools/pluginmodernizer/cli/command/BuildMetadataCommand.java b/...cli/src/main/java/io/jenkins/tools/pluginmodernizer/cli/command/BuildMetadataCommand.java
@@ -6,6 +6,8 @@
 import io.jenkins.tools.pluginmodernizer.core.config.Config;
 import io.jenkins.tools.pluginmodernizer.core.config.Settings;
 import io.jenkins.tools.pluginmodernizer.core.impl.PluginModernizer;
+import io.jenkins.tools.pluginmodernizer.core.model.ModernizerException;
+import java.nio.file.Path;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import picocli.CommandLine;
@@ -27,6 +29,14 @@ public class BuildMetadataCommand implements ICommand {
     @CommandLine.ArgGroup(exclusive = true, multiplicity = "1")
     private PluginOptions pluginOptions;
 
+    /**
+     * Path to the authentication key in case of private repo
+     */
+    @CommandLine.Option(
+            names = {"--ssh-private-key"},
+            description = "Path to the authentication key for GitHub. Default to ~/.ssh/id_rsa")
+    private Path sshPrivateKey = Settings.SSH_PRIVATE_KEY;
+
     /**
      * Global options for all commands
      */
@@ -44,12 +54,21 @@ public Config setup(Config.Builder builder) {
         options.config(builder);
         envOptions.config(builder);
         pluginOptions.config(builder);
-        return builder.withRecipe(Settings.FETCH_METADATA_RECIPE).build();
+        return builder.withSshPrivateKey(sshPrivateKey)
+                .withRecipe(Settings.FETCH_METADATA_RECIPE)
+                .build();
     }
 
     @Override
-    public Integer call() throws Exception {
+    public Integer call() {
         PluginModernizer modernizer = getModernizer();
+        try {
+            modernizer.validate();
+        } catch (ModernizerException e) {
+            LOG.error("Validation error");
+            LOG.error(e.getMessage());
+            return 1;
+        }
         modernizer.start();
         return 0;
     }

diff --git a/...izer-cli/src/main/java/io/jenkins/tools/pluginmodernizer/cli/command/ValidateCommand.java b/...izer-cli/src/main/java/io/jenkins/tools/pluginmodernizer/cli/command/ValidateCommand.java
@@ -6,6 +6,8 @@
 import io.jenkins.tools.pluginmodernizer.core.config.Config;
 import io.jenkins.tools.pluginmodernizer.core.impl.PluginModernizer;
 import io.jenkins.tools.pluginmodernizer.core.model.ModernizerException;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import picocli.CommandLine;
@@ -53,6 +55,11 @@ public Integer call() throws Exception {
         try {
             modernizer.validate();
             LOG.info("GitHub owner: {}", modernizer.getGithubOwner());
+            if (Files.isRegularFile(Path.of(modernizer.getSshPrivateKeyPath()))) {
+                LOG.info("SSH key path: {}", modernizer.getSshPrivateKeyPath());
+            } else {
+                LOG.info("SSH key not set. Will use GitHub token for Git operation");
+            }
             LOG.info("Maven home: {}", modernizer.getMavenHome());
             LOG.info("Maven version: {}", modernizer.getMavenVersion());
             LOG.info("Java version: {}", modernizer.getJavaVersion());

diff --git a/...rnizer-cli/src/main/java/io/jenkins/tools/pluginmodernizer/cli/options/GitHubOptions.java b/...rnizer-cli/src/main/java/io/jenkins/tools/pluginmodernizer/cli/options/GitHubOptions.java
@@ -2,6 +2,7 @@
 
 import io.jenkins.tools.pluginmodernizer.core.config.Config;
 import io.jenkins.tools.pluginmodernizer.core.config.Settings;
+import java.nio.file.Path;
 import picocli.CommandLine;
 
 /**
@@ -15,6 +16,14 @@
         commandListHeading = "%nCommands:%n")
 public class GitHubOptions implements IOption {
 
+    /**
+     * Path to the authentication key
+     */
+    @CommandLine.Option(
+            names = {"--ssh-private-key"},
+            description = "Path to the authentication key for GitHub. Default to ~/.ssh/id_rsa")
+    private Path sshPrivateKey = Settings.SSH_PRIVATE_KEY;
+
     @CommandLine.Option(
             names = {"-g", "--github-owner"},
             description = "GitHub owner for forked repositories.")
@@ -46,6 +55,7 @@ public void config(Config.Builder builder) {
         builder.withGitHubOwner(githubOwner)
                 .withGitHubAppId(githubAppId)
                 .withGitHubAppSourceInstallationId(githubAppSourceInstallationId)
-                .withGitHubAppTargetInstallationId(githubAppTargetInstallationId);
+                .withGitHubAppTargetInstallationId(githubAppTargetInstallationId)
+                .withSshPrivateKey(sshPrivateKey);
     }
 }
diff --git a/plugin-modernizer-cli/src/main/resources/logback.xml b/plugin-modernizer-cli/src/main/resources/logback.xml
@@ -45,7 +45,9 @@
     <logger name="java.lang.Runtime" level="WARN" />
     <logger name="org.apache.mina.core" level="WARN" />
     <logger name="org.apache.sshd.client" level="WARN" />
+    <logger name="org.apache.sshd.client.keyverifier" level="ERROR" />
     <logger name="org.apache.sshd.common" level="WARN" />
+    <logger name="org.apache.sshd.git.transport" level="WARN" />
     <logger name="org.eclipse.jgit.internal" level="WARN" />
     <logger name="org.eclipse.jgit.transport" level="INFO" />
     <logger name="org.eclipse.jgit.util" level="INFO" />