Merge pull request #232 from saucelabs/alexh-handle-legacy-sc-cli

Handle legacy SC CLI options

Author: alexh-sauce

CHANGELOG.md

@@ -1,3 +1,22 @@
+# Jenkins 2.0 - 2025-01-15
+
+This is a new major version of the Sauce Ondemand Plugin to support Sauce
+Connect 5.
+
+There is a new option field added to the 'Freestyle' projects called "Sauce
+Connect v5 Options", and a new argument to 'Pipeline' projects is added called
+`optionsSC5`. This is meant to be used for all new versions, and the previous
+field has been renamed "Sauce Connect v4 Legacy Options".
+
+If you have anything in the legacy options, it will run the Sauce Connect
+client in `sc legacy` mode, and it will continue to work as before. **Note:**
+This legacy field/argument will be removed in a future release, so please
+convert your command line options to the new options format. See the [SC 5 Migration](https://docs.saucelabs.com/secure-connections/sauce-connect-5/migrating/#cli-changes-in-sauce-connect-5)
+docs for more details.
+
+If the legacy options are empty, the SC client will be started in `sc run`
+mode, any no additional changes are needed.
+
 # Jenkins 1.206 - 2022-11-07
 
 * Bump saucerest from 1.1.8 to 1.1.9

pom.xml

@@ -14,7 +14,7 @@
     <!-- Baseline Jenkins version you use to build the plugin. Users must have this version or newer to run. -->
     <jenkins.baseline>2.452</jenkins.baseline>
     <jenkins.version>${jenkins.baseline}.4</jenkins.version>
-    <ci-sauce.version>2.1</ci-sauce.version>
+    <ci-sauce.version>2.3</ci-sauce.version>
     <saucerest.version>2.5.3</saucerest.version>
   </properties>
 

src/main/java/com/saucelabs/jenkins/pipeline/SauceConnectStep.java

@@ -6,6 +6,7 @@
 import com.saucelabs.ci.sauceconnect.AbstractSauceTunnelManager;
 import com.saucelabs.ci.sauceconnect.SauceConnectManager;
 import com.saucelabs.jenkins.HudsonSauceManagerFactory;
+import com.saucelabs.saucerest.DataCenter;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.Extension;
 import hudson.ProxyConfiguration;
@@ -48,25 +49,28 @@ public class SauceConnectStep extends Step {
     private Boolean useLatestSauceConnect = false;
     private Boolean useGeneratedTunnelIdentifier = false;
     private String options;
+    private String optionsSC5;
     private String sauceConnectPath;
 
     @DataBoundConstructor
     public SauceConnectStep() {
     }
 
-    public SauceConnectStep(String options, Boolean verboseLogging, Boolean useLatestSauceConnect, Boolean useGeneratedTunnelIdentifier, String sauceConnectPath) {
+    public SauceConnectStep(String options, String optionsSC5, Boolean verboseLogging, Boolean useLatestSauceConnect, Boolean useGeneratedTunnelIdentifier, String sauceConnectPath) {
         this.verboseLogging = verboseLogging;
         this.useLatestSauceConnect = useLatestSauceConnect;
         this.useGeneratedTunnelIdentifier = useGeneratedTunnelIdentifier;
         this.sauceConnectPath = Util.fixEmptyAndTrim(sauceConnectPath);
         this.options = StringUtils.trimToEmpty(options);
+        this.optionsSC5 = StringUtils.trimToEmpty(optionsSC5);
     }
 
     @Override
     public StepExecution start(StepContext context) throws Exception {
         return new SauceConnectStepExecution(context,
             PluginImpl.get().getSauceConnectOptions(),
             options,
+            optionsSC5,
             useGeneratedTunnelIdentifier,
             verboseLogging,
             sauceConnectPath,
@@ -82,7 +86,16 @@ public String getOptions() {
 
     @DataBoundSetter
     public void setOptions(String options) {
-        this.options = options;
+        this.options = options.strip();
+    }
+
+    public String getOptionsSC5() {
+        return optionsSC5;
+    }
+
+    @DataBoundSetter
+    public void setOptionsSC5(String optionsSC5) {
+        this.optionsSC5 = optionsSC5.strip();
     }
 
     public String getSauceConnectPath() {
@@ -154,16 +167,18 @@ private static final class SauceStartConnectHandler extends MasterToSlaveCallabl
         private final Boolean verboseLogging;
         private final String sauceConnectPath;
         private final Boolean useLatestSauceConnect;
+        private final Boolean legacyCLI;
         private final ProxyConfiguration proxy;
 
-        SauceStartConnectHandler(SauceCredentials sauceCredentials, int port, String options, TaskListener listener, Boolean verboseLogging, String sauceConnectPath, Boolean useLatestSauceConnect, ProxyConfiguration proxy) {
+        SauceStartConnectHandler(SauceCredentials sauceCredentials, int port, String options, TaskListener listener, Boolean verboseLogging, String sauceConnectPath, Boolean useLatestSauceConnect, Boolean legacyCLI, ProxyConfiguration proxy) {
             this.sauceCredentials = sauceCredentials;
             this.port = port;
-            this.options = options;
+            this.options = options.strip();
             this.listener = listener;
             this.verboseLogging = verboseLogging;
             this.sauceConnectPath = sauceConnectPath;
             this.useLatestSauceConnect = useLatestSauceConnect;
+            this.legacyCLI = legacyCLI;
             this.proxy = proxy;
         }
 
@@ -175,13 +190,14 @@ public Void call() throws AbstractSauceTunnelManager.SauceConnectException {
             sauceTunnelManager.openConnection(
                 sauceCredentials.getUsername(),
                 sauceCredentials.getApiKey().getPlainText(),
-                sauceCredentials.getRestEndpointName(),
+                DataCenter.fromString(sauceCredentials.getRestEndpointName()),
                 port,
                 null, /*sauceConnectJar,*/
                 options,
                 listener.getLogger(),
                 verboseLogging,
-                sauceConnectPath
+                sauceConnectPath,
+                legacyCLI
             );
             return null;
         }
@@ -217,6 +233,7 @@ public Void call() throws AbstractSauceTunnelManager.SauceConnectException {
     public static class SauceConnectStepExecution extends StepExecution {
         private final String globalOptions;
         private final String options;
+        private final String optionsSC5;
         private final boolean useGeneratedTunnelIdentifier;
         private final boolean verboseLogging;
         private final String sauceConnectPath;
@@ -231,6 +248,7 @@ public SauceConnectStepExecution(
             @NonNull StepContext context,
             String globalOptions,
             String options,
+            String optionsSC5,
             boolean useGeneratedTunnelIdentifier,
             boolean verboseLogging,
             String sauceConnectPath,
@@ -240,6 +258,7 @@ public SauceConnectStepExecution(
             super(context);
             this.globalOptions = globalOptions;
             this.options = options;
+            this.optionsSC5 = optionsSC5;
             this.useGeneratedTunnelIdentifier = useGeneratedTunnelIdentifier;
             this.verboseLogging = verboseLogging;
             this.sauceConnectPath = sauceConnectPath;
@@ -249,6 +268,14 @@ public SauceConnectStepExecution(
 
         @Override
         public boolean start() throws Exception {
+            boolean legacyCLI = false;
+            if (options != null && optionsSC5 != null && !options.isEmpty() && !optionsSC5.isEmpty()) {
+                throw new Exception("Legacy and SC5 CLI options cannot both be specified");
+            }
+
+            if (options != null && !options.isEmpty()) {
+                legacyCLI = true;
+            }
 
             Run<?, ?> run = getContext().get(Run.class);
             Job<?,?> job = run.getParent();
@@ -266,10 +293,14 @@ public boolean start() throws Exception {
 
             ArrayList<String> optionsArray = new ArrayList<String>();
             optionsArray.add(globalOptions);
-            optionsArray.add(options);
+            if (legacyCLI) {
+                optionsArray.add(options);
+            } else {
+                optionsArray.add(optionsSC5);
+            }
             optionsArray.removeAll(Collections.singleton("")); // remove the empty strings
 
-            String options = StringUtils.join(optionsArray, " ");
+            String combinedOptions = StringUtils.join(optionsArray, " ");
 
             HashMap<String,String> overrides = new HashMap<String,String>();
             overrides.put(SauceOnDemandBuildWrapper.SELENIUM_PORT, String.valueOf(port));
@@ -278,26 +309,25 @@ public boolean start() throws Exception {
             if (useGeneratedTunnelIdentifier) {
                 final String tunnelName = SauceEnvironmentUtil.generateTunnelName(job.getName(), run.number);
                 overrides.put(SauceOnDemandBuildWrapper.TUNNEL_NAME, tunnelName);
-                options = options + " --tunnel-name " + tunnelName;
+                combinedOptions = combinedOptions + " --tunnel-name " + tunnelName;
             }
 
             SauceCredentials sauceCredentials = getContext().get(SauceCredentials.class);
-            final String restEndpoint = sauceCredentials.getRestEndpoint();
-
-            overrides.put(SauceOnDemandBuildWrapper.SAUCE_REST_ENDPOINT, restEndpoint);
-            options = options + " -x " + restEndpoint + "rest/v1";
+            final String region = sauceCredentials.getRegion();
+            combinedOptions = combinedOptions + " --region " + region;
 
             TaskListener listener = getContext().get(TaskListener.class);
             listener.getLogger().println("Starting sauce connect");
 
             SauceStartConnectHandler handler = new SauceStartConnectHandler(
                 sauceCredentials,
                 port,
-                options,
+                combinedOptions,
                 listener,
                 verboseLogging,
                 sauceConnectPath,
                 useLatestSauceConnect,
+                legacyCLI,
                 proxy
             );
             computer.getChannel().call(handler);
@@ -352,4 +382,4 @@ private static final class Callback extends BodyExecutionCallback.TailCall {
 
         }
     }
-}
+}

src/main/java/hudson/plugins/sauce_ondemand/PluginImpl.java

@@ -69,7 +69,9 @@ public class PluginImpl extends Plugin implements Describable<PluginImpl> {
 
   private String sauceConnectDirectory;
 
-  private String sauceConnectOptions;
+  private String sauceConnectOptions; // SC4 Legacy CLI Options
+
+  private String sauceConnectCLIOptions; // SC5 options
 
   private String sauceConnectMaxRetries;
 
@@ -150,6 +152,7 @@ public void configure(StaplerRequest req, JSONObject formData)
       throws IOException, ServletException, Descriptor.FormException {
     sauceConnectDirectory = formData.getString("sauceConnectDirectory");
     sauceConnectOptions = formData.getString("sauceConnectOptions");
+    sauceConnectCLIOptions = formData.getString("sauceConnectCLIOptions");
     environmentVariablePrefix = formData.getString("environmentVariablePrefix");
     setDisableUsageStats(formData.getBoolean("disableUsageStats"));
     sauceConnectMaxRetries = formData.getString("sauceConnectMaxRetries");
@@ -220,6 +223,14 @@ public void setSauceConnectOptions(String sauceConnectOptions) {
     this.sauceConnectOptions = sauceConnectOptions;
   }
 
+  public String getSauceConnectCLIOptions() {
+    return sauceConnectCLIOptions;
+  }
+
+  public void setSauceConnectCLIOptions(String sauceConnectCLIOptions) {
+    this.sauceConnectCLIOptions = sauceConnectCLIOptions;
+  }
+
   public void setDisableUsageStats(boolean disableUsageStats) {
     this.disableUsageStats = disableUsageStats;
   }
@@ -243,4 +254,4 @@ public ListBoxModel doFillCredentialIdItems(final @AncestorInPath ItemGroup<?> c
       return new StandardUsernameListBoxModel().withAll(SauceCredentials.all(context));
     }
   }
-}
+}