Merge pull request #112 from jenkinsci/us-1682183

Us-1682183 preparation for deprecating authenticaiton via username & password
jenkinsci · Jun 26, 2024 · dcb78cf · dcb78cf
2 parents dbdb713 + afdae17
commit dcb78cf
Show file tree

Hide file tree

Showing 14 changed files with 98 additions and 120 deletions.
diff --git a/README.md b/README.md
@@ -26,8 +26,8 @@ Both steps are also exposed in the pipeline job as `lrcRunTest` and `lrcGenTrend
 
 ### System configuration
 - Navigate to **Manage Jenkins** &rarr; **System Configuration** &rarr; **Configure System** &rarr; **LoadRunner Cloud** and then configure the following settings: 
-  - **Username** and **Password**  
-  - If you use [API Access keys](https://admhelp.microfocus.com/lrc/en/Latest/Content/Storm/Admin-APIAccess.htm), select the **Use OAuth token** checkbox, then input the **Client ID** and **Client Secret**.
+  - **Client ID** and **Client Secret**  
+  Refer to [API access keys](https://admhelp.microfocus.com/lrc/en/Latest/Content/Storm/Admin-APIAccess.htm) for details. You can still input **Username** and **Password** in the fields (depends on the feature toggle in your tenant). However, it's recommended to use API access keys.
   - **URL**, default: "https://loadrunner-cloud.saas.microfocus.com"
   - **Tenant ID**, for example: 123456789
   - **Proxy** settings (optional). If you need to use a proxy to access LoadRunner Cloud, select **Connect LoadRunner Cloud via proxy** checkbox, then configure the following fields.
@@ -45,10 +45,7 @@ Both steps are also exposed in the pipeline job as `lrcRunTest` and `lrcGenTrend
 unclassified:
   lrcRunTest:
     tenantId: "<TENANT ID>"
-    username: "<USERNAME>"
-    password: "<PASSWORD>"
     url: "https://loadrunner-cloud.saas.microfocus.com"
-    useOAuth: false
     clientId: "<CLIENT ID>"
     clientSecret: "<CLIENT SECRET>"
     useProxy: false

diff --git a/images/system_config.png b/images/system_config.png
diff --git a/pom.xml b/pom.xml
@@ -41,7 +41,7 @@
         <url>https://github.com/${gitHubRepo}</url>
     </scm>
     <properties>
-        <revision>5.0.5-</revision>
+        <revision>5.1.0-</revision>
         <changelist>-SNAPSHOT</changelist>
 
         <!-- Baseline Jenkins version you use to build the plugin. Users must have this version or newer to run. -->

diff --git a/src/main/java/com/microfocus/lrc/core/entity/ProxyConfiguration.java b/src/main/java/com/microfocus/lrc/core/entity/ProxyConfiguration.java
@@ -33,7 +33,7 @@ public final class ProxyConfiguration implements Serializable {
     // #endregion
 
     public ProxyConfiguration(final String host, final int port, final String username, final String password) {
-        if (host == null || host.length() == 0) {
+        if (host == null || host.isEmpty()) {
             throw new IllegalArgumentException("host must not be empty.");
         }
         if (port <= 0 || port > MAX_PORT_RANGE) {
@@ -43,15 +43,15 @@ public ProxyConfiguration(final String host, final int port, final String userna
         this.host = host;
         this.port = port;
 
-        if (username != null && password != null && username.length() > 0 && password.length() > 0) {
+        if (username != null && password != null && !username.isEmpty() && !password.isEmpty()) {
             this.username = username;
             this.password = Secret.fromString(password);
         }
     }
 
     public ProxyConfiguration(final String host, final String port, final String username, final String password)
             throws IllegalArgumentException {
-        if (host == null || host.length() == 0) {
+        if (host == null || host.isEmpty()) {
             throw new IllegalArgumentException("host must not be empty.");
         }
         int portNum;
@@ -67,7 +67,7 @@ public ProxyConfiguration(final String host, final String port, final String use
         this.host = host;
         this.port = portNum;
 
-        if (username != null && password != null && username.length() > 0 && password.length() > 0) {
+        if (username != null && password != null && !username.isEmpty() && !password.isEmpty()) {
             this.username = username;
             this.password = Secret.fromString(password);
         }

diff --git a/src/main/java/com/microfocus/lrc/jenkins/TestRunBuilder.java b/src/main/java/com/microfocus/lrc/jenkins/TestRunBuilder.java
@@ -74,7 +74,7 @@ public TestRunBuilder(
 
     static Map<String, String> readStringConfigFromEnvVars(final Run<?, ?> run, final Launcher launcher) {
         Map<String, String> map = new HashMap<>();
-        for (StringOptionInEnvVars key : StringOptionInEnvVars.values()) {
+        for (StringOptionInEnvVars key : StringOptionInEnvVars.getEntries()) {
             String value = EnvVarsUtil.getEnvVar(run, launcher, key.name());
             if (StringUtils.isNotBlank(value)) {
                 map.put(key.name(), value.trim());
@@ -333,7 +333,7 @@ public void perform(
 
     private Map<String, String> readBoolConfigFromEnvVars(final Run<?, ?> run, final Launcher launcher) {
         Map<String, String> map = new HashMap<>();
-        for (BooleanOptionInEnvVars key : BooleanOptionInEnvVars.values()) {
+        for (BooleanOptionInEnvVars key : BooleanOptionInEnvVars.getEntries()) {
             String value = EnvVarsUtil.getEnvVar(run, launcher, key.name());
             if (StringUtils.isNotBlank(value) && !value.equals("0")
                     && !value.equalsIgnoreCase("false") && !value.equalsIgnoreCase("no")) {
@@ -452,22 +452,21 @@ public static final class DescriptorImpl extends BuildStepDescriptor<Builder> {
 
         public DescriptorImpl() {
             load();
+
+            if (Boolean.FALSE.equals(this.useOAuth) && !StringUtils.isBlank(this.username)) {
+                this.clientId = this.username;
+                this.clientSecret = this.password;
+            }
+
+            this.useOAuth = true; // always use fields: 'clientId' and 'clientSecret'
         }
 
         public String getUser() {
-            if (Boolean.TRUE.equals(this.useOAuth)) {
-                return this.clientId;
-            } else {
-                return this.username;
-            }
+            return this.clientId;
         }
 
         public String getPswd() {
-            if (Boolean.TRUE.equals(this.useOAuth)) {
-                return (this.clientSecret != null) ? this.clientSecret.getPlainText() : "";
-            } else {
-                return (this.password != null) ? this.password.getPlainText() : "";
-            }
+            return (this.clientSecret != null) ? this.clientSecret.getPlainText() : "";
         }
 
         @Override
@@ -515,9 +514,8 @@ private Boolean getBooleanConfig(final JSONObject data, final String key) {
         public boolean configure(final StaplerRequest req, final JSONObject formData) throws FormException {
             // set all properties from formData
             // validate all properties, throw FormException if invalid
-            this.username = this.getStringConfig(formData, Constants.USERNAME);
-            this.password = this.getPasswordConfig(formData, Constants.PASSWORD);
             this.url = StringUtils.stripEnd(this.getStringConfig(formData, Constants.URL), "/");
+            this.tenantId = this.getStringConfig(formData, Constants.TENANTID);
 
             this.useProxy = this.getBooleanConfig(formData, "useProxy");
             this.proxyHost = this.getStringConfig(formData, "proxyHost");
@@ -533,10 +531,12 @@ public boolean configure(final StaplerRequest req, final JSONObject formData) th
 
             this.proxyPassword = this.getPasswordConfig(formData, "proxyPassword");
 
-            this.useOAuth = this.getBooleanConfig(formData, Constants.USE_OAUTH);
             this.clientId = this.getStringConfig(formData, Constants.CLIENT_ID);
             this.clientSecret = this.getPasswordConfig(formData, Constants.CLIENT_SECRET);
-            this.tenantId = this.getStringConfig(formData, Constants.TENANTID);
+            this.useOAuth = true;
+
+            this.username = "";
+            this.password = null;
 
             save();
             return super.configure(req, formData);
@@ -545,7 +545,7 @@ public boolean configure(final StaplerRequest req, final JSONObject formData) th
         @POST
         public FormValidation doCheckUrl(@QueryParameter final String value) {
             String errorMsg = "Please input a valid URL";
-            if (value == null || value.trim().length() == 0) {
+            if (value == null || value.trim().isEmpty()) {
                 return FormValidation.error(errorMsg);
             }
 
@@ -558,8 +558,8 @@ public FormValidation doCheckUrl(@QueryParameter final String value) {
 
         @POST
         public FormValidation doCheckTenantId(@QueryParameter final String value) {
-            if (value == null || value.trim().length() == 0) {
-                return FormValidation.error("Please input a Tenant ID");
+            if (value == null || value.trim().isEmpty()) {
+                return FormValidation.error("Please input tenant id");
             }
 
             return FormValidation.ok();
@@ -568,15 +568,10 @@ public FormValidation doCheckTenantId(@QueryParameter final String value) {
         @SuppressWarnings("checkstyle:HiddenField")
         @POST
         public FormValidation doCheckUsername(
-                @QueryParameter final String value,
-                @QueryParameter final String useOAuth
+                @QueryParameter final String value
         ) {
-            if (Boolean.parseBoolean(useOAuth)) {
-                return FormValidation.ok();
-            }
-
-            if (value == null || value.trim().length() == 0) {
-                return FormValidation.error("Please input a Username");
+            if (value == null || value.trim().isEmpty()) {
+                return FormValidation.error("Please input client id or username");
             }
 
             return FormValidation.ok();
@@ -585,49 +580,10 @@ public FormValidation doCheckUsername(
         @SuppressWarnings("checkstyle:HiddenField")
         @POST
         public FormValidation doCheckPassword(
-                @QueryParameter final String value,
-                final @QueryParameter String useOAuth
+                @QueryParameter final String value
         ) {
-            if (Boolean.parseBoolean(useOAuth)) {
-                return FormValidation.ok();
-            }
-
-            if (value == null || value.trim().length() == 0) {
-                return FormValidation.error("Please input a Password");
-            }
-
-            return FormValidation.ok();
-        }
-
-        @SuppressWarnings("checkstyle:HiddenField")
-        @POST
-        public FormValidation doCheckClientId(
-                @QueryParameter final String value,
-                @QueryParameter final String useOAuth
-        ) {
-            if (!Boolean.parseBoolean(useOAuth)) {
-                return FormValidation.ok();
-            }
-
-            if (!ApiClient.isOAuthClientId(value.trim())) {
-                return FormValidation.error("Please input a valid Client ID");
-            }
-
-            return FormValidation.ok();
-        }
-
-        @SuppressWarnings("checkstyle:HiddenField")
-        @POST
-        public FormValidation doCheckClientSecret(
-                @QueryParameter final String value,
-                @QueryParameter final String useOAuth
-        ) {
-            if (!Boolean.parseBoolean(useOAuth)) {
-                return FormValidation.ok();
-            }
-
-            if (value == null || value.trim().length() == 0) {
-                return FormValidation.error("Please input a valid Client Secret");
+            if (value == null || value.trim().isEmpty()) {
+                return FormValidation.error("Please input client secret or password");
             }
 
             return FormValidation.ok();
@@ -643,8 +599,8 @@ public FormValidation doCheckProxyHost(
                 return FormValidation.ok();
             }
 
-            if (value == null || value.trim().length() == 0) {
-                return FormValidation.error("Please input a Host");
+            if (value == null || value.trim().isEmpty()) {
+                return FormValidation.error("Please input a valid proxy host");
             }
 
             return FormValidation.ok();
@@ -660,31 +616,31 @@ public FormValidation doCheckProxyPort(
                 return FormValidation.ok();
             }
 
-            if (value == null || value.trim().length() == 0) {
+            if (value == null || value.trim().isEmpty()) {
                 return FormValidation.ok();
             }
 
             if (!StringUtils.isNumeric(value)) {
-                return FormValidation.error("Please input a valid port number.");
+                return FormValidation.error("Please input a valid port number");
             }
 
             int portVal = Integer.parseInt(value);
 
             if (portVal < 0 || portVal > 65535) {
-                return FormValidation.error("Please input a valid port number.");
+                return FormValidation.error("Please input a valid port number");
             }
 
             return FormValidation.ok();
         }
 
         @POST
         public FormValidation doCheckProjectID(@QueryParameter final String value) {
-            if (value == null || value.trim().length() == 0) {
-                return FormValidation.error("Please input a Project ID");
+            if (value == null || value.trim().isEmpty()) {
+                return FormValidation.error("Please input project id");
             }
 
             if (!value.matches("^\\d+$")) {
-                return FormValidation.error("Invalid Project ID");
+                return FormValidation.error("Invalid project id");
             }
             return FormValidation.ok();
         }
@@ -795,8 +751,6 @@ public void setUseOAuth(final Boolean useOAuth) {
         @SuppressWarnings({"java:S107", "checkstyle:ParameterNumber", "checkstyle:HiddenField"})
         @POST
         public FormValidation doTestConnection(
-                @QueryParameter("username") final String username,
-                @QueryParameter("password") final Secret password,
                 @QueryParameter("url") final String url,
                 @QueryParameter("proxyHost") final String proxyHost,
                 @QueryParameter("proxyPort") final String proxyPort,
@@ -805,7 +759,6 @@ public FormValidation doTestConnection(
                 @QueryParameter("clientId") final String clientId,
                 @QueryParameter("clientSecret") final Secret clientSecret,
                 @QueryParameter("tenantId") final String tenantId,
-                @QueryParameter("useOAuth") final String useOAuth,
                 @QueryParameter("useProxy") final String useProxy
         ) {
             Jenkins.get().checkPermission(Jenkins.ADMINISTER);
@@ -818,15 +771,8 @@ public FormValidation doTestConnection(
                 return FormValidation.error("Invalid parameter: Tenant ID");
             }
 
-            boolean useOAuthFlag = Boolean.parseBoolean(useOAuth);
-            String user = useOAuthFlag ? clientId : username;
-            String pswd;
-
-            if (useOAuthFlag) {
-                pswd = (clientSecret != null) ? clientSecret.getPlainText() : "";
-            } else {
-                pswd = (password != null) ? password.getPlainText() : "";
-            }
+            String user = clientId;
+            String pswd = (clientSecret != null) ? clientSecret.getPlainText() : "";
 
             ServerConfiguration config = new ServerConfiguration(
                     url,

diff --git a/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/global.jelly b/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/global.jelly
@@ -27,10 +27,10 @@
       so it should be straightforward to find them.
     -->
     <f:section title="LoadRunner Cloud">
-        <f:entry title="Username" field="username">
+        <f:entry title="Client ID" field="clientId">
             <f:textbox />
         </f:entry>
-        <f:entry title="Password" field="password">
+        <f:entry title="Client Secret" field="clientSecret">
             <f:password />
         </f:entry>
         <f:entry title="URL" field="url">
@@ -39,16 +39,6 @@
         <f:entry title="Tenant ID" field="tenantId">
             <f:textbox clazz="required" />
         </f:entry>
-        <f:block>
-            <f:optionalBlock checked="${descriptor.useOAuth}" name="useOAuth" field="useOAuth" inline="true" title="Use OAuth token">
-                <f:entry title="Client ID" field="clientId" description="If it's set, jobs will use client id and client secret.">
-                    <f:textbox />
-                </f:entry>
-                <f:entry title="Client Secret" field="clientSecret">
-                    <f:password />
-                </f:entry>
-            </f:optionalBlock>
-        </f:block>
         <f:block>
             <f:optionalBlock checked="${descriptor.useProxy}" name="useProxy" field="useProxy" inline="true" title="Connect LoadRunner Cloud via proxy">
                 <f:entry title="Proxy Host" field="proxyHost" description="If a valid proxy setting is specified here, all other proxy settings will be ignored while connecting LoadRunner Cloud.">
@@ -68,7 +58,7 @@
 
         <f:validateButton title="Test Connection" progress="Testing..."
                           method="testConnection"
-                          with="username,password,url,useProxy,proxyHost,proxyPort,proxyUsername,proxyPassword,useOAuth,clientId,clientSecret,tenantId"
+                          with="url,useProxy,proxyHost,proxyPort,proxyUsername,proxyPassword,clientId,clientSecret,tenantId"
         />
 
     </f:section>

diff --git a/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/help-clientId.html b/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/help-clientId.html
@@ -0,0 +1,3 @@
+<div>
+    Your client id or username to login LoadRunner Cloud
+</div>
diff --git a/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/help-clientSecret.html b/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/help-clientSecret.html
@@ -0,0 +1,3 @@
+<div>
+    Your client secret or password to login LoadRunner Cloud
+</div>
diff --git a/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/help-password.html b/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/help-password.html
diff --git a/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/help-testId.html b/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/help-testId.html
@@ -1,3 +1,3 @@
 <div>
-    Test ID. Navigate to the General page of target load test in LoadRunner Cloud to see the ID.
+    Test ID. Navigate to "Test settings" page of target load test in LoadRunner Cloud to see the ID.
 </div>
diff --git a/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/help-url.html b/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/help-url.html
@@ -1,3 +1,3 @@
 <div>
-    LoadRunner Cloud URL, for example: https://loadrunner-cloud.saas.microfocus.com
+    LoadRunner Cloud URL. For example: https://loadrunner-cloud.saas.microfocus.com
 </div>
diff --git a/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/help-username.html b/src/main/resources/com/microfocus/lrc/jenkins/TestRunBuilder/help-username.html