add junit test for stash file parameter

.github/dependabot.yml

@@ -6,3 +6,7 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/release-drafter.yml

@@ -1,16 +1,15 @@
 # Automates creation of Release Drafts using Release Drafter
 # More Info: https://github.com/jenkinsci/.github/blob/master/.github/release-drafter.adoc
 
+name: Release Drafter
 on:
   push:
     branches:
       - master
-
 jobs:
   update_release_draft:
     runs-on: ubuntu-latest
     steps:
-      # Drafts your next Release notes as Pull Requests are merged into "master"
-      - uses: release-drafter/release-drafter@v5
+      - uses: release-drafter/[email protected]
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -12,20 +12,45 @@ Offers alternative types of file parameter that are compatible with Pipeline and
 
 See [JENKINS-27413](https://issues.jenkins-ci.org/browse/JENKINS-27413) and [JENKINS-29289](https://issues.jenkins-ci.org/browse/JENKINS-29289) for background.
 
+## Usage in declarative pipeline
+
+You can now declare file parameters as is in declarative pipeline:
+
+```groovy
+pipeline {
+  agent any
+  parameters {
+    base64File 'FILE'
+    stashedFile 'FILE-STASH'
+  }
+  stages {
+    stage('Example') {
+      steps {
+        withFileParameter('FILE') {
+          sh 'cat $FILE'
+        }
+        unstash 'FILE-STASH'
+        echo(/loaded '${readFile('FILE-STASH')}'/)
+      }
+    }
+  }
+}
+```
+
 ## Implementation status
 
 - [X] Base64 file parameter (simple and suitable for small files)
   - [X] implementation
-  - [ ] inline help text
+  - [X] inline help text
   - [X] `withFileParameter` compatibility
   - [X] manual test
   - [X] automated test
 - [ ] stashed file parameter (suitable for larger files used in Pipeline)
   - [X] implementation
-  - [ ] inline help text
-  - [ ] `withFileParameter` compatibility
+  - [X] inline help text
+  - [X] `withFileParameter` compatibility (manual test)
   - [X] manual test
-  - [ ] automated test
+  - [X] automated test
   - [ ] sanity check against `artifact-manager-s3`
 - [ ] archived file parameter (compatible with freestyle, and suitable if you want to ensure parameters are kept after the build ends)
   - [ ] implementation
@@ -45,12 +70,12 @@ See [JENKINS-27413](https://issues.jenkins-ci.org/browse/JENKINS-27413) and [JEN
   - [X] implementation
   - [ ] manual test
   - [ ] automated test
-- [ ] `withFileParameter` wrapper step
+- [X] `withFileParameter` wrapper step
   - [X] implementation
   - [X] inline help text
-  - [ ] manual test
+  - [X] manual test
   - [X] automated test
-  - [ ] option to tolerate undefined parameter
+  - [X] option to tolerate undefined parameter
 - [ ] `input` step submission
   - [ ] design
   - [ ] manual test

pom.xml

@@ -42,6 +42,11 @@
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-api</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>jackson2-api</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.jenkins-ci.plugins.workflow</groupId>
             <artifactId>workflow-job</artifactId>
@@ -62,6 +67,11 @@
             <artifactId>workflow-basic-steps</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.jenkinsci.plugins</groupId>
+            <artifactId>pipeline-model-definition</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <licenses>

src/main/java/io/jenkins/plugins/file_parameters/Base64FileParameterDefinition.java

@@ -53,7 +53,8 @@ public final class Base64FileParameterDefinition extends AbstractFileParameterDe
         @Override public String getDisplayName() {
             return "Base64 File Parameter";
         }
-
     }
 
+
+
 }

src/main/java/io/jenkins/plugins/file_parameters/FileParameterWrapper.java

@@ -41,6 +41,7 @@
 import jenkins.tasks.SimpleBuildWrapper;
 import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.DataBoundSetter;
 
 /**
  * Saves a file parameter to a temporary local file.
@@ -49,22 +50,37 @@ public final class FileParameterWrapper extends SimpleBuildWrapper {
 
     public final String name;
 
+    private boolean allowNoFile;
+
     @DataBoundConstructor public FileParameterWrapper(String name) {
         this.name = name;
     }
 
+    public boolean isAllowNoFile() {
+        return allowNoFile;
+    }
+
+    @DataBoundSetter
+    public void setAllowNoFile(boolean allowNoFile) {
+        this.allowNoFile = allowNoFile;
+    }
+
     @Override public void setUp(Context context, Run<?, ?> build, FilePath workspace, Launcher launcher, TaskListener listener, EnvVars initialEnvironment) throws IOException, InterruptedException {
         ParametersAction pa = build.getAction(ParametersAction.class);
         if (pa == null) {
             throw new AbortException("No parameters");
         }
         ParameterValue pv = pa.getParameter(name);
-        if (pv == null) {
+        if (pv == null && !allowNoFile) {
             throw new AbortException("No parameter named " + name);
         }
-        if (!(pv instanceof AbstractFileParameterValue)) {
+        if (!(pv instanceof AbstractFileParameterValue) && !allowNoFile) {
             throw new AbortException("Unsupported parameter type");
         }
+        if (pv == null && allowNoFile) {
+            listener.getLogger().println("Skip file parameter as there is no parameter with name: '" + name + "'");
+            return;
+        }
         FilePath tempDir = WorkspaceList.tempDir(workspace);
         if (tempDir == null) {
             throw new AbortException("Missing workspace or could not make temp dir");

src/main/java/io/jenkins/plugins/file_parameters/StashedFileParameterDefinition.java

@@ -47,7 +47,7 @@ public final class StashedFileParameterDefinition extends AbstractFileParameterD
 
     // TODO equals/hashCode
 
-    @Symbol("stashed64File")
+    @Symbol("stashedFile")
     @Extension public static final class DescriptorImpl extends ParameterDefinition.ParameterDescriptor {
 
         @Override public String getDisplayName() {

src/main/resources/io/jenkins/plugins/file_parameters/Base64FileParameterDefinition/help.html

@@ -0,0 +1,41 @@
+<div>
+  <p>File parameter compatible with Pipeline, how to use it in a declarative pipeline:</p>
+  <pre>
+pipeline {
+  agent any
+  parameters {
+    base64File(name: 'THEFILE')
+  }
+  stages {
+    stage('Example') {
+      steps {
+        withFileParameter('THEFILE') {
+          echo(/loaded '${readFile(FILE)}' from $FILE/)
+        }
+      }
+    }
+  }
+}
+  </pre>
+</div>
+<div>
+  Per default, there will be an error if there is no parameter for the build but you can ignore this error using the
+  parameter attribute <code>allowNoFile</code>. In this case your pipeline must take into account the file doesn't exists
+  <pre>
+pipeline {
+  agent any
+  parameters {
+    base64File(name: 'THEFILE')
+  }
+  stages {
+    stage('Example') {
+      steps {
+        withFileParameter(name:'THEFILE', allowNoFile: true) {
+          echo(/loaded '${readFile(FILE)}' from $FILE/)
+        }
+      }
+    }
+  }
+}
+  </pre>
+</div>

src/main/resources/io/jenkins/plugins/file_parameters/StashedFileParameterDefinition/help.html

@@ -0,0 +1,19 @@
+<div>
+  <p>File parameter compatible with Pipeline but this one stash the file, how to use it in a declarative pipeline:</p>
+  <pre>
+pipeline {
+  agent any
+  parameters {
+    stashedFile(name: 'FILE-STASH')
+  }
+  stages {
+    stage('Example') {
+      steps {
+        unstash "FILE-STASH"
+        echo(/loaded '${readFile("./FILE-STASH")}'/)
+      }
+    }
+  }
+}
+ </pre>
+</div>