Merge branch 'release/v0.2.0' into readme_use-case

Signed-off-by: Ilya Abnitski <[email protected]>
zowe · Oct 23, 2024 · 1c61d27 · 1c61d27
2 parents 9f2e5b4 + fd4f407
commit 1c61d27
Show file tree

Hide file tree

Showing 27 changed files with 341 additions and 86 deletions.
diff --git a/.github/setup/action.yml b/.github/setup/action.yml
@@ -5,7 +5,7 @@ inputs:
   jdkVersion:
     description: "JDK version"
     required: false
-    default: "11"
+    default: "17"
   mavenVersion:
     description: "Maven version"
     required: false

diff --git a/.github/workflows/hpi-builder.yml b/.github/workflows/hpi-builder.yml
@@ -20,7 +20,7 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: '11'
+          java-version: '17'
           cache: maven
 
       - name: Build Jenkins Plugin into .hpi
@@ -52,9 +52,9 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: '11'
+          java-version: '17'
           cache: maven
 
       - name: Run Unit Tests with Maven
         shell: bash
-        run: ./mvnw test
+        run: ./mvnw test
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -8,4 +8,4 @@
  * Copyright IBA Group 2022
  */
 
-buildPlugin(useContainerAgent: true, tests: [[skip: 'true']], configurations: [[ platform: 'linux', jdk: '11' ]])
+buildPlugin(useContainerAgent: true, tests: [[skip: 'true']], configurations: [[ platform: 'linux', jdk: '17' ]])
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.jenkins-ci.plugins</groupId>
         <artifactId>plugin</artifactId>
-        <version>4.78</version>
+        <version>4.78</version> <!-- See https://github.com/jenkinsci/plugin-pom/releases for available versions-->
         <relativePath />
     </parent>
 
@@ -19,21 +19,31 @@
 
 
     <properties>
-        <revision>0.2.0-</revision>
+        <revision>0.2.0</revision>
         <changelist>-SNAPSHOT</changelist>
         <jenkins.version>2.414.3</jenkins.version>
-        <java.version>11</java.version>
-        <kotlin.version>1.8.21</kotlin.version>
+        <java.version>17</java.version>
+        <kotlin.version>1.9.20</kotlin.version>
         <kotlin.compiler.incremental>true</kotlin.compiler.incremental>
         <sezpoz.version>1.13</sezpoz.version>
         <okhttp3.version>4.10.0</okhttp3.version>
-        <zowekotlinsdk.version>0.5.0-rc.1</zowekotlinsdk.version>
+        <zowekotlinsdk.version>0.5.0-rc.11</zowekotlinsdk.version>
         <kotest.version>5.6.1</kotest.version>
         <kotlin.code.style>official</kotlin.code.style>
-        <kotlin.compiler.jvmTarget>11</kotlin.compiler.jvmTarget>
+        <kotlin.compiler.jvmTarget>17</kotlin.compiler.jvmTarget>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <spotbugs.threshold>High</spotbugs.threshold>
         <gitHubRepo>jenkinsci/${project.artifactId}-plugin</gitHubRepo>
+
+        <sonar.sourceEncoding>UTF-8</sonar.sourceEncoding>
+        <sonar.organization>zowe</sonar.organization>
+        <sonar.projectKey>zowe_zowe-zdevops-jenkins-plugin</sonar.projectKey>
+        <sonar.projectName>zowe-zdevops-jenkins-plugin</sonar.projectName>
+        <sonar.projectVersion>project.version</sonar.projectVersion>
+        <sonar.language>kotlin</sonar.language>
+        <sonar.links.scm>https://github.com/zowe/zowe-zdevops-jenkins-plugin</sonar.links.scm>
+
+        <maven.compiler.release>17</maven.compiler.release>
     </properties>
 
     <licenses>
@@ -133,10 +143,10 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.11.0</version>
+                <version>3.13.0</version>
                 <configuration>
-                    <source>11</source>
-                    <target>11</target>
+                    <source>17</source>
+                    <target>17</target>
                 </configuration>
                 <executions>
                     <!-- Replacing default-compile as it is treated specially by maven -->
@@ -302,19 +312,19 @@
         <dependency>
             <groupId>com.squareup.retrofit2</groupId>
             <artifactId>retrofit</artifactId>
-            <version>2.9.0</version>
+            <version>2.11.0</version>
         </dependency>
 
         <dependency>
             <groupId>com.squareup.retrofit2</groupId>
             <artifactId>converter-gson</artifactId>
-            <version>2.9.0</version>
+            <version>2.11.0</version>
         </dependency>
 
         <dependency>
             <groupId>com.squareup.retrofit2</groupId>
             <artifactId>converter-scalars</artifactId>
-            <version>2.9.0</version>
+            <version>2.11.0</version>
         </dependency>
 
         <dependency>
@@ -365,22 +375,12 @@
             <version>2.10.1</version>
         </dependency>
 
-        <dependency>
-            <groupId>org.jenkins-ci.plugins</groupId>
-            <artifactId>script-security</artifactId>
-        </dependency>
-
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-lang3</artifactId>
             <version>3.12.0</version>
         </dependency>
 
-        <dependency>
-            <groupId>org.jenkins-ci</groupId>
-            <artifactId>annotation-indexer</artifactId>
-        </dependency>
-
         <dependency>
             <groupId>com.squareup.okhttp3</groupId>
             <artifactId>okhttp</artifactId>
@@ -429,6 +429,28 @@
             <scope>test</scope>
         </dependency>
 
+        <!-- Jenkins plug-ins -->
+
+        <dependency>
+            <groupId>org.jenkins-ci</groupId>
+            <artifactId>annotation-indexer</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>script-security</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>credentials</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.jenkins-ci.plugins.workflow</groupId>
+            <artifactId>workflow-step-api</artifactId>
+        </dependency>
+
     </dependencies>
 
     <repositories>

diff --git a/src/main/kotlin/org/zowe/zdevops/classic/AbstractBuildStep.kt b/src/main/kotlin/org/zowe/zdevops/classic/AbstractBuildStep.kt
@@ -24,6 +24,7 @@ import org.kohsuke.stapler.QueryParameter
 import org.zowe.kotlinsdk.zowe.client.sdk.core.ZOSConnection
 import org.zowe.zdevops.Messages
 import org.zowe.zdevops.config.ZOSConnectionList
+import org.zowe.zdevops.utils.validateConnection
 import java.io.IOException
 import java.io.PrintWriter
 import java.io.StringWriter
@@ -71,6 +72,8 @@ abstract class AbstractBuildStep(val connectionName: String) : Builder(), Simple
             connURL.host, connURL.port.toString(), connection.username, connection.password, connURL.protocol
         )
 
+        validateConnection(zosConnection)
+
         perform(build, launcher, listener, zosConnection)
         return true
     }

diff --git a/src/main/kotlin/org/zowe/zdevops/classic/steps/AllocateDatasetStep.kt b/src/main/kotlin/org/zowe/zdevops/classic/steps/AllocateDatasetStep.kt
@@ -55,6 +55,7 @@ constructor(
   val primary: Int = 1,
   var secondary: Int,
   var recFm: RecordFormat,
+  var failOnExist: Boolean = false,
 ) : AbstractBuildStep(connectionName){
 
   private var volser: String? = null
@@ -177,7 +178,8 @@ constructor(
       dataClass,
       avgBlk,
       dsnType,
-      dsModel
+      dsModel,
+      failOnExist,
     )
   }
 

diff --git a/src/main/kotlin/org/zowe/zdevops/classic/steps/DeleteDatasetStep.kt b/src/main/kotlin/org/zowe/zdevops/classic/steps/DeleteDatasetStep.kt
@@ -22,7 +22,6 @@ import org.zowe.zdevops.Messages
 import org.zowe.zdevops.classic.AbstractBuildStep
 import org.zowe.zdevops.logic.deleteDatasetOrMember
 import org.zowe.zdevops.utils.validateDatasetName
-import org.zowe.zdevops.utils.validateFieldIsNotEmpty
 import org.zowe.zdevops.utils.validateMemberName
 
 class DeleteDatasetStep
@@ -38,6 +37,7 @@ constructor(
     connectionName: String,
     val dsn: String,
     val member: String?,
+    val failOnNotExist: Boolean = false ,
 ) : AbstractBuildStep(connectionName) {
 
     override fun perform(
@@ -46,7 +46,7 @@ constructor(
         listener: BuildListener,
         zosConnection: ZOSConnection
     ) {
-        deleteDatasetOrMember(dsn, member, zosConnection, listener)
+        deleteDatasetOrMember(dsn, member, zosConnection, listener, failOnNotExist)
     }
 
     @Extension
@@ -67,10 +67,14 @@ constructor(
          * Checks if the member name is valid
          *
          * @param member The dataset member name
-         * @return FormValidation.ok() if the member name is valid, or an error message otherwise
+         * @return FormValidation.ok() if either the member name is valid or is not provided, or an error message otherwise
          */
         fun doCheckMember(@QueryParameter member: String): FormValidation? {
-            return validateMemberName(member)?: validateFieldIsNotEmpty(member)
+            return if (member.isNotBlank()) {
+                validateMemberName(member)
+            } else {
+                FormValidation.ok()
+            }
         }
     }
 }
diff --git a/src/main/kotlin/org/zowe/zdevops/classic/steps/DeleteDatasetsByMaskStep.kt b/src/main/kotlin/org/zowe/zdevops/classic/steps/DeleteDatasetsByMaskStep.kt
@@ -31,6 +31,7 @@ class DeleteDatasetsByMaskStep
 constructor(
     connectionName: String,
     val dsnMask: String,
+    val failOnNotExist: Boolean = false,
 ) : AbstractBuildStep(connectionName) {
 
     override fun perform(
@@ -39,7 +40,7 @@ constructor(
         listener: BuildListener,
         zosConnection: ZOSConnection
     ) {
-        deleteDatasetsByMask(dsnMask, zosConnection, listener)
+        deleteDatasetsByMask(dsnMask, zosConnection, listener, failOnNotExist)
     }
 
     @Extension

diff --git a/src/main/kotlin/org/zowe/zdevops/classic/steps/SubmitJobStep.kt b/src/main/kotlin/org/zowe/zdevops/classic/steps/SubmitJobStep.kt
@@ -41,8 +41,8 @@ constructor(
       val linkBuilder: (String?, String, String) -> String = { jobUrl, jobName, jobId ->
         "${jobUrl}ws/${jobName}.${jobId}/*view*/"
       }
-      val returnCode = submitJobSync(jobName, zosConnection, listener, workspace, build.getEnvironment(listener)["JOB_URL"], linkBuilder)
-      if (checkRC && !returnCode.equals("CC 0000")) {
+      val jobResult = submitJobSync(jobName, zosConnection, listener, workspace, build.getEnvironment(listener)["JOB_URL"], linkBuilder)
+      if (checkRC && !jobResult.equals("CC 0000")) {
         throw AbortException("Job RC code is not 0000")
       }
     } else {

diff --git a/src/main/kotlin/org/zowe/zdevops/config/ZOSConnection.kt b/src/main/kotlin/org/zowe/zdevops/config/ZOSConnection.kt
@@ -8,18 +8,14 @@
  * Copyright IBA Group 2022
  */
 
-package org.zowe.zdevops.config;
+package org.zowe.zdevops.config
 
 import com.cloudbees.plugins.credentials.CredentialsMatchers
 import com.cloudbees.plugins.credentials.CredentialsProvider
 import com.cloudbees.plugins.credentials.common.StandardCredentials
 import com.cloudbees.plugins.credentials.common.StandardListBoxModel
 import com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials
 import com.cloudbees.plugins.credentials.domains.URIRequirementBuilder
-import org.zowe.kotlinsdk.zowe.client.sdk.zosfiles.ZosDsnList
-import org.zowe.kotlinsdk.zowe.client.sdk.zosfiles.input.ListParams
-import org.zowe.zdevops.Messages
-import org.zowe.zdevops.declarative.jobs.zMessages
 import hudson.Extension
 import hudson.model.AbstractDescribableImpl
 import hudson.model.Descriptor
@@ -32,6 +28,9 @@ import net.sf.json.JSONObject
 import org.kohsuke.stapler.DataBoundConstructor
 import org.kohsuke.stapler.QueryParameter
 import org.kohsuke.stapler.StaplerRequest
+import org.zowe.zdevops.Messages
+import org.zowe.zdevops.declarative.jobs.zMessages
+import org.zowe.zdevops.utils.getTestDatasetList
 import java.io.IOException
 import java.io.ObjectInputStream
 import java.io.ObjectOutputStream
@@ -119,9 +118,9 @@ constructor(
         val testConnection = org.zowe.kotlinsdk.zowe.client.sdk.core.ZOSConnection(
           connURL.host, connURL.port.toString(), credentials.username, credentials.password.plainText, connURL.protocol
         )
-        ZosDsnList(testConnection).listDsn(zMessages.zdevops_config_ZOSConnection_validation_testDS(), ListParams())
+        getTestDatasetList(testConnection)
       }.onFailure {
-        return FormValidation.error(zMessages.zdevops_config_ZOSConnection_validation_error());
+        return FormValidation.error("${zMessages.zdevops_config_ZOSConnection_validation_error()}\n(${it.message})");
       }
       return FormValidation.ok(zMessages.zdevops_config_ZOSConnection_validation_success())
     }

diff --git a/src/main/kotlin/org/zowe/zdevops/declarative/AbstractZosmfAction.kt b/src/main/kotlin/org/zowe/zdevops/declarative/AbstractZosmfAction.kt
@@ -21,11 +21,9 @@ import hudson.tasks.BuildStepDescriptor
 import hudson.tasks.Builder
 import jenkins.tasks.SimpleBuildStep
 import org.zowe.kotlinsdk.zowe.client.sdk.core.ZOSConnection
-import org.zowe.zdevops.Messages
-import org.zowe.zdevops.config.ZOSConnectionList
+import org.zowe.zdevops.utils.getZoweZosConnection
 import java.io.PrintWriter
 import java.io.StringWriter
-import java.net.URL
 import java.nio.charset.StandardCharsets
 
 abstract class AbstractZosmfAction : Builder(), SimpleBuildStep {
@@ -38,18 +36,8 @@ abstract class AbstractZosmfAction : Builder(), SimpleBuildStep {
 
   override fun perform(run: Run<*, *>, workspace: FilePath, env: EnvVars, launcher: Launcher, listener: TaskListener) {
     val connectionName = workspace.read().readBytes().toString(StandardCharsets.UTF_8)
-    val connection = ZOSConnectionList.resolve(connectionName) ?: let {
+    val zoweConnection = getZoweZosConnection(connectionName, listener)
 
-      val exception = IllegalArgumentException(Messages.zdevops_config_ZOSConnection_resolve_unknown(connectionName))
-      val sw = StringWriter()
-      exception.printStackTrace(PrintWriter(sw))
-      listener.logger.println(sw.toString())
-      throw exception
-    }
-    val connURL = URL(connection.url)
-    val zoweConnection = ZOSConnection(
-      connURL.host, connURL.port.toString(), connection.username, connection.password, connURL.protocol
-    )
     runCatching {
       perform(run, workspace, env, launcher, listener, zoweConnection)
     }.onFailure {

diff --git a/src/main/kotlin/org/zowe/zdevops/declarative/ZosmfStepDeclarative.kt b/src/main/kotlin/org/zowe/zdevops/declarative/ZosmfStepDeclarative.kt
@@ -13,17 +13,24 @@ package org.zowe.zdevops.declarative
 import hudson.EnvVars
 import hudson.Extension
 import hudson.FilePath
-import hudson.model.*
 import hudson.model.Run
+import hudson.model.TaskListener
 import org.jenkinsci.plugins.workflow.steps.Step
 import org.jenkinsci.plugins.workflow.steps.StepContext
 import org.jenkinsci.plugins.workflow.steps.StepDescriptor
 import org.jenkinsci.plugins.workflow.steps.StepExecution
 import org.kohsuke.stapler.DataBoundConstructor
+import org.zowe.zdevops.utils.getZoweZosConnection
+import org.zowe.zdevops.utils.validateConnection
 
 
 class ZosmfStepDeclarative @DataBoundConstructor constructor(private val connectionName: String) : Step() {
   override fun start(context: StepContext): StepExecution {
+    val listener: TaskListener? = context.get(TaskListener::class.java)
+    val zosConnection =  getZoweZosConnection(connectionName, listener)
+
+    validateConnection(zosConnection)
+
     return ZosmfExecution(connectionName, context)
   }
 

diff --git a/src/main/kotlin/org/zowe/zdevops/declarative/jobs/AllocateDatasetDeclarative.kt b/src/main/kotlin/org/zowe/zdevops/declarative/jobs/AllocateDatasetDeclarative.kt
@@ -46,7 +46,8 @@ constructor(
    private val dsOrg: DatasetOrganization,
    private val primary: Int,
    private var secondary: Int,
-   private var recFm: RecordFormat) :
+   private var recFm: RecordFormat,
+   private var failOnExist: Boolean = false) :
     AbstractZosmfAction() {
 
     private var volser: String? = null
@@ -126,7 +127,8 @@ constructor(
             dataClass,
             avgBlk,
             dsnType,
-            dsModel
+            dsModel,
+            failOnExist,
         )
     }