add junit test for stash file parameter #7

olamy · 2021-01-21T06:00:25Z

No description provided.

Signed-off-by: olivier lamy <[email protected]>

olamy · 2021-01-22T11:13:23Z

@jglick please have a look there is a bit of testing and documentation.
Maybe we can merge that and have a first release? please let me know.
Thanks

pom.xml

Signed-off-by: olivier lamy <[email protected]>

jglick

Stuff to work with here. I would want to do some fixups before merging.

As to a release, I think it is prudent to look into input / build first. Also there is an unimplemented method. Need to look over the list of outstanding items, implement the easy ones, and refile the rest as GH issues.

README.md

pom.xml

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

src/main/webapp/help-base64File.html

README.md

jglick · 2021-01-22T23:06:39Z

README.md

+  stages {
+    stage('Example') {
+      steps {
+        withFileParameter('FILE') {


IIRC Declarative supports using block-scoped steps in an option block. Does it work here?

yep it works

But you prefer to demonstrate using a block-scoped step inside steps?

uhm I missed that one but I'm not sure what sort of syntax you mean?

Something like

pipeline { agent any parameters { base64File(name: 'FILE') } options { withFileParameter('FILE') } stages { stage('x') { steps { sh 'cat $FILE' } } } }

Bug in Declarative it seems: https://issues.jenkins.io/browse/JENKINS-64761

src/test/java/io/jenkins/plugins/file_parameters/FileParameterWrapperTest.java

Co-authored-by: Jesse Glick <[email protected]>

…ameterDefinition.java Co-authored-by: Jesse Glick <[email protected]>

Co-authored-by: Jesse Glick <[email protected]>

…WrapperTest.java Co-authored-by: Jesse Glick <[email protected]>

Signed-off-by: olivier lamy <[email protected]>

olamy · 2021-01-23T04:28:33Z

@jglick looks good to me to look into build/input. we can merge this PR then I can take care of it.

jglick · 2021-01-23T21:52:59Z

README.md

+  stages {
+    stage('Example') {
+      steps {
+        withFileParameter('FILE') {


But you prefer to demonstrate using a block-scoped step inside steps?

src/test/java/io/jenkins/plugins/file_parameters/FileParameterWrapperTest.java

…WrapperTest.java Co-authored-by: Jesse Glick <[email protected]>

Signed-off-by: olivier lamy <[email protected]>

jglick

Sorry I must have been tired!

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

README.md

jglick · 2021-01-24T15:50:34Z

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

@@ -4,7 +4,7 @@
 pipeline {
  agent any
  parameters {
-    stashed64File(name: 'FILE-STASH')
+    stashedBase64File(name: 'FILE-STASH')


Suggested change

stashedBase64File(name: 'FILE-STASH')

stashedFile(name: 'FILE-STASH')

or, if it works,

Suggested change

stashedBase64File(name: 'FILE-STASH')

stashedFile 'FILE-STASH'

simple syntax not working

addressed in another PR

src/test/java/io/jenkins/plugins/file_parameters/FileParameterWrapperTest.java

Co-authored-by: Jesse Glick <[email protected]>

…rameterDefinition.java Co-authored-by: Jesse Glick <[email protected]>

Co-authored-by: Jesse Glick <[email protected]>

Signed-off-by: olivier lamy <[email protected]>

jglick

Sorry the back-and-forth across time zones is a little crazy!

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

src/test/java/io/jenkins/plugins/file_parameters/FileParameterWrapperTest.java

jglick · 2021-01-26T02:58:34Z

README.md

+  stages {
+    stage('Example') {
+      steps {
+        withFileParameter('FILE') {


Something like

pipeline { agent any parameters { base64File(name: 'FILE') } options { withFileParameter('FILE') } stages { stage('x') { steps { sh 'cat $FILE' } } } }

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

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

Signed-off-by: olivier lamy <[email protected]>

…WrapperTest.java Co-authored-by: Jesse Glick <[email protected]>

…leParameterDefinition/help.html Co-authored-by: Jesse Glick <[email protected]>

…ileParameterDefinition/help.html Co-authored-by: Jesse Glick <[email protected]>

…WrapperTest.java Co-authored-by: Jesse Glick <[email protected]>

Signed-off-by: olivier lamy <[email protected]>

Co-authored-by: Jesse Glick <[email protected]>

Signed-off-by: olivier lamy <[email protected]>

olamy · 2021-01-27T11:41:51Z

Sorry the back-and-forth across time zones is a little crazy!

no worries especially with adding weekend, public holidays etc... 😄

presumably stale

jglick

Enough to merge, but I have various follow-ups and corrections.

jglick · 2021-01-30T18:09:29Z

README.md

-  - [ ] inline help text
-  - [ ] `withFileParameter` compatibility
+  - [X] inline help text
+  - [X] `withFileParameter` compatibility (manual test)


If you are using withFileParameter then you are not supposed to need unstash (and vice-versa).

jglick · 2021-01-30T18:11:09Z

README.md

-  - [ ] inline help text
-  - [ ] `withFileParameter` compatibility
+  - [X] inline help text
+  - [X] `withFileParameter` compatibility (manual test)


Suggested change

- [X] `withFileParameter` compatibility (manual test)

- [ ] `withFileParameter` compatibility

jglick · 2021-01-30T18:11:32Z

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 and must be used to handle bug files, how to use it in a declarative pipeline:</p>


Suggested change

<p>File parameter compatible with Pipeline but this one stash the file and must be used to handle bug files, how to use it in a declarative pipeline:</p>

<p>File parameter compatible with Pipeline but this one stash the file and must be used to handle big files, how to use it in a declarative pipeline:</p>

jglick · 2021-01-30T18:12:39Z

src/test/java/io/jenkins/plugins/file_parameters/FileParameterWrapperTest.java

+            "    stage('Example') {\n" +
+            "      steps {\n" +
+            "        withFileParameter('FILE') {\n" +
+            "          echo(/loaded '${readFile(FILE).toUpperCase(Locale.ROOT)}' from $FILE/) \n" +


BTW while sh 'cat $FILE' is most realistic for docs, I prefer readFile for functional tests because it requires no special work to pass on Windows.

jglick · 2021-01-30T18:13:53Z

src/test/java/io/jenkins/plugins/file_parameters/FileParameterWrapperTest.java

+        r.assertLogContains("loaded 'UPLOADED CONTENT HERE'", b);
+    }
+
+    @Test public void stashed() throws Exception {


Fine but it is not using FileParameterWrapper so does not belong here. (Unless the two are made to be compatible and the test made to exercise that.)

jglick · 2021-01-30T18:14:02Z

src/test/java/io/jenkins/plugins/file_parameters/FileParameterWrapperTest.java

+        r.assertLogContains("loaded 'UPLOADED CONTENT HERE'", b);
+    }
+
+    @Test public void stashedDeclarativeParameterCreated() throws Exception {


olamy added 2 commits January 20, 2021 12:26

upgrade release drafter and add dependabot for ghactions

9476558

Signed-off-by: olivier lamy <[email protected]>

add junit for stash file parameter

9bda7b9

Signed-off-by: olivier lamy <[email protected]>

olamy added the enhancement New feature or request label Jan 21, 2021

olamy added 5 commits January 22, 2021 08:12

add more details on manual tests done

9dc68fa

Signed-off-by: olivier lamy <[email protected]>

add more docs and inline help

542a861

Signed-off-by: olivier lamy <[email protected]>

mar inline help as done

83d4e02

Signed-off-by: olivier lamy <[email protected]>

add more tests including auto creation of build parameters with pipeline

a3e2f56

Signed-off-by: olivier lamy <[email protected]>

add ignored test for a coming feature

779d206

Signed-off-by: olivier lamy <[email protected]>

olamy requested a review from jglick January 22, 2021 11:12

oleg-nenashev approved these changes Jan 22, 2021

View reviewed changes

pom.xml Outdated Show resolved Hide resolved

use org.jenkins-ci.plugins:jackson2-api

1ba3a0b

Signed-off-by: olivier lamy <[email protected]>

jglick reviewed Jan 22, 2021

View reviewed changes

olamy and others added 7 commits January 23, 2021 14:05

Update README.md

7f25496

Co-authored-by: Jesse Glick <[email protected]>

Update README.md

237e9ee

Co-authored-by: Jesse Glick <[email protected]>

Update README.md

ed7877d

Co-authored-by: Jesse Glick <[email protected]>

Update src/main/java/io/jenkins/plugins/file_parameters/Base64FilePar…

ab26f20

…ameterDefinition.java Co-authored-by: Jesse Glick <[email protected]>

Update README.md

36d2f2f

Co-authored-by: Jesse Glick <[email protected]>

Update src/test/java/io/jenkins/plugins/file_parameters/FileParameter…

828f0ba

…WrapperTest.java Co-authored-by: Jesse Glick <[email protected]>

fix unit test

1b62df5

Signed-off-by: olivier lamy <[email protected]>

jglick previously requested changes Jan 23, 2021

View reviewed changes

olamy and others added 2 commits January 24, 2021 19:11

Update src/test/java/io/jenkins/plugins/file_parameters/FileParameter…

9558459

…WrapperTest.java Co-authored-by: Jesse Glick <[email protected]>

more fixes after review

ece717d

Signed-off-by: olivier lamy <[email protected]>

jglick reviewed Jan 24, 2021

View reviewed changes

olamy and others added 5 commits January 25, 2021 08:01

Update README.md

e5ae911

Co-authored-by: Jesse Glick <[email protected]>

Update src/main/java/io/jenkins/plugins/file_parameters/StashedFilePa…

ceabdb8

…rameterDefinition.java Co-authored-by: Jesse Glick <[email protected]>

Apply suggestions from code review

2c2d4f5

Co-authored-by: Jesse Glick <[email protected]>

fix test as simplified parameter syntax do not work

e677d30

Signed-off-by: olivier lamy <[email protected]>

add allowNoFile option to not fail if no parameter

292f870

Signed-off-by: olivier lamy <[email protected]>

olamy added 2 commits January 25, 2021 20:41

option to tolerate undefined parameter has been done

b960b79

Signed-off-by: olivier lamy <[email protected]>

all done for withFileParameter

b2e08aa

Signed-off-by: olivier lamy <[email protected]>

olamy requested a review from jglick January 25, 2021 22:26

jglick reviewed Jan 26, 2021

View reviewed changes

olamy and others added 10 commits January 27, 2021 11:09

add a comment on why this dependency with exclusions

5c29809

Signed-off-by: olivier lamy <[email protected]>

Update src/test/java/io/jenkins/plugins/file_parameters/FileParameter…

4920a15

…WrapperTest.java Co-authored-by: Jesse Glick <[email protected]>

Update src/test/java/io/jenkins/plugins/file_parameters/FileParameter…

06333dc

…WrapperTest.java Co-authored-by: Jesse Glick <[email protected]>

Update src/main/resources/io/jenkins/plugins/file_parameters/Base64Fi…

0d3acb6

…leParameterDefinition/help.html Co-authored-by: Jesse Glick <[email protected]>

Update src/main/resources/io/jenkins/plugins/file_parameters/StashedF…

89ee670

…ileParameterDefinition/help.html Co-authored-by: Jesse Glick <[email protected]>

Update src/test/java/io/jenkins/plugins/file_parameters/FileParameter…

4535fd3

…WrapperTest.java Co-authored-by: Jesse Glick <[email protected]>

remove extra empty lines

be09527

Signed-off-by: olivier lamy <[email protected]>

add allowNoFile help and move help

71928ff

Signed-off-by: olivier lamy <[email protected]>

Update README.md

12b668f

Co-authored-by: Jesse Glick <[email protected]>

stashed is for big files

405415f

Signed-off-by: olivier lamy <[email protected]>

jglick reviewed Jan 30, 2021

View reviewed changes

jglick merged commit f1292a8 into master Jan 30, 2021

jglick deleted the stash_file_junit branch January 30, 2021 18:16

This was referenced Jan 30, 2021

Make FileParameterWrapper work with StashedFileParameterValue #8

Merged

Use a simplified constructor for prettier Declarative syntax #10

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add junit test for stash file parameter #7

add junit test for stash file parameter #7

olamy commented Jan 21, 2021

olamy commented Jan 22, 2021

jglick left a comment

jglick Jan 22, 2021

olamy Jan 23, 2021

jglick Jan 23, 2021

olamy Jan 24, 2021

jglick Jan 26, 2021

jglick Jan 30, 2021

olamy commented Jan 23, 2021

jglick Jan 23, 2021

jglick left a comment

jglick Jan 24, 2021

olamy Jan 24, 2021

jglick Jan 30, 2021

jglick left a comment

jglick Jan 26, 2021

olamy commented Jan 27, 2021

jglick left a comment

jglick Jan 30, 2021

jglick Jan 30, 2021

jglick Jan 30, 2021

jglick Jan 30, 2021

jglick Jan 30, 2021

jglick Jan 30, 2021

	stashedBase64File(name: 'FILE-STASH')
	stashedFile(name: 'FILE-STASH')

	stashedBase64File(name: 'FILE-STASH')
	stashedFile 'FILE-STASH'

	- [X] `withFileParameter` compatibility (manual test)
	- [ ] `withFileParameter` compatibility

		@@ -0,0 +1,19 @@
		<div>
		<p>File parameter compatible with Pipeline but this one stash the file and must be used to handle bug files, how to use it in a declarative pipeline:</p>

add junit test for stash file parameter #7

add junit test for stash file parameter #7

Conversation

olamy commented Jan 21, 2021

olamy commented Jan 22, 2021

jglick left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

olamy commented Jan 23, 2021

Choose a reason for hiding this comment

jglick left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jglick left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

olamy commented Jan 27, 2021

jglick left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment