2 | The name of the parameter. 3 | Depending on the type of parameter, this may or may not be bound as an environment variable during the build. 4 |
5 |
6 | If a local filename was given, an environment variable paramname_FILENAME will also be set.
7 | If the build is triggered via the CLI, the variable will not be set.
8 |
${it.filename}2 | Simple file parameter compatible with Pipeline. 3 | Transmits file contents as an environment variable in Base64 encoding, 4 | so it is best used with fairly small files. 5 | Example usage from Declarative Pipeline: 6 |
7 |
8 | pipeline {
9 | agent any
10 | parameters {
11 | base64File 'FILE'
12 | }
13 | stages {
14 | stage('Example') {
15 | steps {
16 | sh 'echo $FILE | base64 -d > config.yaml'
17 | }
18 | }
19 | }
20 | }
21 |
22 |
--------------------------------------------------------------------------------
/src/main/resources/io/jenkins/plugins/file_parameters/FileParameterWrapper/config.jelly:
--------------------------------------------------------------------------------
1 |
2 |
25 |
26 |
27 | How to use it in a declarative pipeline:
7 |
8 | pipeline {
9 | agent any
10 | parameters {
11 | base64File 'THEFILE'
12 | }
13 | stages {
14 | stage('Example') {
15 | steps {
16 | withFileParameter('THEFILE') {
17 | sh 'cat $THEFILE'
18 | }
19 | }
20 | }
21 | }
22 | }
23 |
24 | allowNoFile. In this case your Pipeline must take into account the possibility that the file does not exist:
28 |
29 | pipeline {
30 | agent any
31 | parameters {
32 | base64File 'THEFILE'
33 | }
34 | stages {
35 | stage('Example') {
36 | steps {
37 | withFileParameter(name:'THEFILE', allowNoFile: true) {
38 | sh 'if [ -f "$THEFILE" ]; then cat $THEFILE; fi'
39 | }
40 | }
41 | }
42 | }
43 | }
44 |
45 | 2 | File parameter compatible with Pipeline but using the stash system, better suited to large files. 3 | The file will be saved to a stash named like the parameter containing one entry, also named like the parameter. 4 | Example usage from Declarative Pipeline: 5 |
6 |
7 | pipeline {
8 | agent any
9 | parameters {
10 | stashedFile 'assets.zip'
11 | }
12 | stages {
13 | stage('Example') {
14 | steps {
15 | unstash 'assets.zip'
16 | sh 'unzip assets.zip'
17 | }
18 | }
19 | }
20 | }
21 |
22 |
--------------------------------------------------------------------------------
/src/test/java/io/jenkins/plugins/file_parameters/AbstractFileParameterDefinitionTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright 2020 CloudBees, Inc.
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 |
25 | package io.jenkins.plugins.file_parameters;
26 |
27 | import hudson.cli.CLICommandInvoker;
28 | import hudson.model.ParametersDefinitionProperty;
29 | import jenkins.model.Jenkins;
30 | import org.apache.commons.io.FileUtils;
31 | import org.htmlunit.FormEncodingType;
32 | import org.htmlunit.HttpMethod;
33 | import org.htmlunit.WebRequest;
34 | import org.htmlunit.html.HtmlFileInput;
35 | import org.htmlunit.html.HtmlForm;
36 | import org.htmlunit.html.HtmlPage;
37 | import org.htmlunit.http.HttpStatus;
38 | import org.htmlunit.util.KeyDataPair;
39 | import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
40 | import org.jenkinsci.plugins.workflow.job.WorkflowJob;
41 | import org.jenkinsci.plugins.workflow.job.WorkflowRun;
42 | import org.junit.jupiter.api.Test;
43 | import org.junit.jupiter.api.io.TempDir;
44 | import org.jvnet.hudson.test.Issue;
45 | import org.jvnet.hudson.test.JenkinsRule;
46 | import org.jvnet.hudson.test.MockAuthorizationStrategy;
47 | import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
48 |
49 | import java.io.ByteArrayInputStream;
50 | import java.io.File;
51 | import java.net.URL;
52 | import java.nio.charset.StandardCharsets;
53 | import java.nio.file.Files;
54 | import java.util.Collections;
55 |
56 | import static org.hamcrest.MatcherAssert.assertThat;
57 | import static org.hamcrest.Matchers.is;
58 | import static org.junit.jupiter.api.Assertions.assertNotNull;
59 |
60 | @WithJenkins
61 | class AbstractFileParameterDefinitionTest {
62 |
63 | @TempDir
64 | private File tmp;
65 |
66 | @Test
67 | void gui(JenkinsRule r) throws Exception {
68 | r.jenkins.setSecurityRealm(r.createDummySecurityRealm());
69 | r.jenkins.setAuthorizationStrategy(new MockAuthorizationStrategy().grant(Jenkins.ADMINISTER).everywhere().to("admin"));
70 | WorkflowJob p = r.createProject(WorkflowJob.class, "myjob");
71 | p.addProperty(new ParametersDefinitionProperty(new Base64FileParameterDefinition("FILE")));
72 | p.setDefinition(new CpsFlowDefinition("echo(/received $FILE_FILENAME: $FILE/)", true));
73 | File f = Files.createFile(new File(tmp, "myfile.txt").toPath()).toFile();
74 | FileUtils.write(f, "uploaded content here", StandardCharsets.UTF_8);
75 | JenkinsRule.WebClient wc = r.createWebClient().login("admin");
76 | wc.setThrowExceptionOnFailingStatusCode(false);
77 | wc.setRedirectEnabled(true);
78 | HtmlPage parametersPage = wc.goTo("job/myjob/build?delay=0sec");
79 | assertThat(parametersPage.getWebResponse().getStatusCode(), is(HttpStatus.METHOD_NOT_ALLOWED_405));
80 | HtmlForm form = parametersPage.getFormByName("parameters");
81 | HtmlFileInput file = form.getInputByName("file");
82 | file.setValue(f.getAbsolutePath());
83 | assertThat(r.submit(form).getWebResponse().getStatusCode(), is(HttpStatus.OK_200)); // 303 myjob/build → myjob/
84 | r.waitUntilNoActivity();
85 | WorkflowRun b = p.getBuildByNumber(1);
86 | assertNotNull(b);
87 | r.assertLogContains("received myfile.txt: dXBsb2FkZWQgY29udGVudCBoZXJl", b);
88 | }
89 |
90 | // adapted from BuildCommandTest.fileParameter
91 | @Test
92 | void cli(JenkinsRule r) throws Exception {
93 | WorkflowJob p = r.createProject(WorkflowJob.class, "myjob");
94 | p.addProperty(new ParametersDefinitionProperty(new Base64FileParameterDefinition("FILE")));
95 | p.setDefinition(new CpsFlowDefinition("echo(/received $env.FILE_FILENAME: $FILE/)", true));
96 | assertThat(new CLICommandInvoker(r, "build").
97 | withStdin(new ByteArrayInputStream("uploaded content here".getBytes())).
98 | invokeWithArgs("-f", "-p", "FILE=", "myjob"),
99 | CLICommandInvoker.Matcher.succeeded());
100 | WorkflowRun b = p.getBuildByNumber(1);
101 | assertNotNull(b);
102 | r.assertLogContains("received null: dXBsb2FkZWQgY29udGVudCBoZXJl", b);
103 | }
104 |
105 | @Test
106 | void rest(JenkinsRule r) throws Exception {
107 | r.jenkins.setSecurityRealm(r.createDummySecurityRealm());
108 | r.jenkins.setAuthorizationStrategy(new MockAuthorizationStrategy().grant(Jenkins.ADMINISTER).everywhere().to("admin"));
109 | WorkflowJob p = r.createProject(WorkflowJob.class, "myjob");
110 | p.addProperty(new ParametersDefinitionProperty(new Base64FileParameterDefinition("FILE")));
111 | p.setDefinition(new CpsFlowDefinition("echo(/received $FILE_FILENAME: $FILE/)", true));
112 | // Like: curl -u $auth -F FILE=@/tmp/f $jenkins/job/myjob/buildWithParameters
113 | WebRequest req = new WebRequest(new URL(r.getURL() + "job/myjob/buildWithParameters"), HttpMethod.POST);
114 | File f = File.createTempFile("junit", null, tmp);
115 | FileUtils.write(f, "uploaded content here", StandardCharsets.UTF_8);
116 | req.setEncodingType(FormEncodingType.MULTIPART);
117 | req.setRequestParameters(Collections.singletonList(new KeyDataPair("FILE", f, "myfile.txt", "text/plain", StandardCharsets.UTF_8)));
118 | r.createWebClient().withBasicApiToken("admin").getPage(req);
119 | r.waitUntilNoActivity();
120 | WorkflowRun b = p.getBuildByNumber(1);
121 | assertNotNull(b);
122 | r.assertLogContains("received myfile.txt: dXBsb2FkZWQgY29udGVudCBoZXJl", b);
123 | }
124 |
125 | @Issue("https://github.com/jenkinsci/file-parameters-plugin/issues/26")
126 | @Test
127 | void restMissingValue(JenkinsRule r) throws Exception {
128 | r.jenkins.setSecurityRealm(r.createDummySecurityRealm());
129 | r.jenkins.setAuthorizationStrategy(new MockAuthorizationStrategy().grant(Jenkins.ADMINISTER).everywhere().to("admin"));
130 | WorkflowJob p = r.createProject(WorkflowJob.class, "myjob");
131 | p.addProperty(new ParametersDefinitionProperty(new Base64FileParameterDefinition("FILE")));
132 | p.setDefinition(new CpsFlowDefinition("echo(/received $env.FILE_FILENAME: $env.FILE/)", true));
133 | // Like: curl -u $auth $jenkins/job/myjob/buildWithParameters
134 | WebRequest req = new WebRequest(new URL(r.getURL() + "job/myjob/buildWithParameters"), HttpMethod.POST);
135 | r.createWebClient().withBasicApiToken("admin").getPage(req);
136 | r.waitUntilNoActivity();
137 | WorkflowRun b = p.getBuildByNumber(1);
138 | assertNotNull(b);
139 | r.assertLogContains("received null: null", b);
140 | }
141 |
142 | @Test
143 | void buildStep(JenkinsRule r) throws Exception {
144 | WorkflowJob us = r.createProject(WorkflowJob.class, "us");
145 | us.setDefinition(new CpsFlowDefinition("build job: 'ds', parameters: [base64File(name: 'FILE', base64: Base64.encoder.encodeToString('a message'.bytes))]", true));
146 | WorkflowJob ds = r.createProject(WorkflowJob.class, "ds");
147 | ds.addProperty(new ParametersDefinitionProperty(new Base64FileParameterDefinition("FILE")));
148 | ds.setDefinition(new CpsFlowDefinition("echo(/got ${new String(Base64.decoder.decode(FILE))}/)", true));
149 | r.buildAndAssertSuccess(us);
150 | WorkflowRun b = ds.getBuildByNumber(1);
151 | assertNotNull(b);
152 | r.assertLogContains("got a message", b);
153 | }
154 |
155 | }
156 |
--------------------------------------------------------------------------------
/src/test/java/io/jenkins/plugins/file_parameters/FileParameterWrapperTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright 2020 CloudBees, Inc.
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 |
25 | package io.jenkins.plugins.file_parameters;
26 |
27 | import hudson.cli.CLICommandInvoker;
28 | import hudson.model.Failure;
29 | import hudson.model.ParameterDefinition;
30 | import hudson.model.ParametersDefinitionProperty;
31 | import hudson.model.Result;
32 | import org.apache.commons.io.FileUtils;
33 | import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
34 | import org.jenkinsci.plugins.workflow.job.WorkflowJob;
35 | import org.jenkinsci.plugins.workflow.job.WorkflowRun;
36 | import org.junit.jupiter.api.Test;
37 | import org.jvnet.hudson.test.Issue;
38 | import org.jvnet.hudson.test.JenkinsRule;
39 | import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
40 |
41 | import java.io.ByteArrayInputStream;
42 | import java.io.File;
43 |
44 | import static org.hamcrest.MatcherAssert.assertThat;
45 | import static org.junit.jupiter.api.Assertions.assertEquals;
46 | import static org.junit.jupiter.api.Assertions.assertFalse;
47 | import static org.junit.jupiter.api.Assertions.assertNotNull;
48 |
49 | @WithJenkins
50 | class FileParameterWrapperTest {
51 |
52 | @Test
53 | void base64(JenkinsRule r) throws Exception {
54 | r.createSlave("remote", null, null);
55 | WorkflowJob p = r.createProject(WorkflowJob.class, "myjob");
56 | p.addProperty(new ParametersDefinitionProperty(new Base64FileParameterDefinition("FILE")));
57 | String pipeline = """
58 | node('remote') {
59 | withFileParameter('FILE') {
60 | echo(/loaded '${readFile(FILE).toUpperCase(Locale.ROOT)}' from $FILE/)
61 | }
62 | }""";
63 | p.setDefinition(new CpsFlowDefinition(pipeline, true));
64 | assertThat(new CLICommandInvoker(r, "build").
65 | withStdin(new ByteArrayInputStream("uploaded content here".getBytes())).
66 | invokeWithArgs("-f", "-p", "FILE=", "myjob"),
67 | CLICommandInvoker.Matcher.succeeded());
68 | WorkflowRun b = p.getBuildByNumber(1);
69 | assertNotNull(b);
70 | r.assertLogContains("loaded 'UPLOADED CONTENT HERE' from ", b);
71 | }
72 |
73 | @Test
74 | void base64UndefinedFail(JenkinsRule r) throws Exception {
75 | r.createSlave("remote", null, null);
76 | WorkflowJob p = r.createProject(WorkflowJob.class, "myjob");
77 | p.addProperty(new ParametersDefinitionProperty(new Base64FileParameterDefinition("FILE")));
78 | String pipeline = """
79 | pipeline {
80 | agent any
81 | parameters {
82 | base64File 'FILE'
83 | }
84 | stages {
85 | stage('Example') {
86 | steps {
87 | withFileParameter('FILE') {
88 | echo('foo')
89 | }
90 | }
91 | }
92 | }
93 | }""";
94 | p.setDefinition(new CpsFlowDefinition(pipeline, true));
95 | WorkflowRun run = p.scheduleBuild2(0).get();
96 | r.waitForCompletion(run);
97 | r.assertBuildStatus(Result.FAILURE, run);
98 | r.assertLogContains("No parameter named FILE", run);
99 | }
100 |
101 | @Test
102 | void base64WithAllowNoFile(JenkinsRule r) throws Exception {
103 | r.createSlave("remote", null, null);
104 | WorkflowJob p = r.createProject(WorkflowJob.class, "myjob");
105 | p.addProperty(new ParametersDefinitionProperty(new Base64FileParameterDefinition("FILE")));
106 | String pipeline = """
107 | pipeline {
108 | agent any
109 | parameters {
110 | base64File 'FILE'
111 | }
112 | stages {
113 | stage('Example') {
114 | steps {
115 | withFileParameter(name:'FILE', allowNoFile: true) {
116 | echo('foo')
117 | }
118 | }
119 | }
120 | }
121 | }""";
122 | p.setDefinition(new CpsFlowDefinition(pipeline, true));
123 | WorkflowRun run = p.scheduleBuild2(0).get();
124 | r.waitForCompletion(run);
125 | r.assertBuildStatus(Result.SUCCESS, run);
126 | r.assertLogContains("foo", run);
127 | r.assertLogContains("Skip file parameter as there is no parameter with name: 'FILE'", run);
128 | }
129 |
130 | @Test
131 | void base64DeclarativeParameterCreated(JenkinsRule r) throws Exception {
132 | r.createSlave("remote", null, null);
133 | WorkflowJob p = r.createProject(WorkflowJob.class, "myjob");
134 |
135 | String pipeline = """
136 | pipeline {
137 | agent any
138 | parameters {
139 | base64File 'FILE'
140 | }
141 | stages {
142 | stage('Example') {
143 | steps {
144 | withFileParameter('FILE') {
145 | echo(/loaded '${readFile(FILE).toUpperCase(Locale.ROOT)}' from $FILE/)
146 | }
147 | }
148 | }
149 | }
150 | }""";
151 |
152 | p.setDefinition(new CpsFlowDefinition(pipeline, true));
153 | WorkflowRun run = p.scheduleBuild2(0).get();
154 | r.waitForCompletion(run);
155 | // definitely will fail but we just ensure parameter has been created
156 | r.assertBuildStatus(Result.FAILURE, run);
157 | ParametersDefinitionProperty pdp = p.getProperty(ParametersDefinitionProperty.class);
158 | assertNotNull(pdp, "parameters definition property is null");
159 | ParameterDefinition pd = pdp.getParameterDefinition( "FILE");
160 | assertNotNull(pd, "parameters definition is null");
161 | assertEquals(Base64FileParameterDefinition.class, pd.getClass(), "parameter not type Base64FileParameterDefinition");
162 |
163 | assertThat(new CLICommandInvoker(r, "build").
164 | withStdin(new ByteArrayInputStream("uploaded content here".getBytes())).
165 | invokeWithArgs("-f", "-p", "FILE=", "myjob"),
166 | CLICommandInvoker.Matcher.succeeded());
167 | WorkflowRun b = p.getBuildByNumber(2);
168 | assertNotNull(b);
169 | r.assertLogContains("loaded 'UPLOADED CONTENT HERE'", b);
170 | }
171 |
172 | @Test
173 | void stashed(JenkinsRule r) throws Exception {
174 | r.createSlave("remote", null, null);
175 | WorkflowJob p = r.createProject(WorkflowJob.class, "myjob");
176 | p.addProperty(new ParametersDefinitionProperty(new StashedFileParameterDefinition("FILE")));
177 | String pipeline = """
178 | node('remote') {
179 | withFileParameter('FILE') {
180 | echo(/loaded '${readFile(FILE).toUpperCase(Locale.ROOT)}' from $FILE/)
181 | }
182 | }""";
183 | p.setDefinition(new CpsFlowDefinition(pipeline, true));
184 | assertThat(new CLICommandInvoker(r, "build").
185 | withStdin(new ByteArrayInputStream("uploaded content here".getBytes())).
186 | invokeWithArgs("-f", "-p", "FILE=", "myjob"),
187 | CLICommandInvoker.Matcher.succeeded());
188 | WorkflowRun b = p.getBuildByNumber(1);
189 | assertNotNull(b);
190 | r.assertLogContains("loaded 'UPLOADED CONTENT HERE'", b);
191 | }
192 |
193 | @Test
194 | void stashedDeclarativeParameterCreated(JenkinsRule r) throws Exception {
195 | r.createSlave("remote", null, null);
196 | WorkflowJob p = r.createProject(WorkflowJob.class, "myjob");
197 |
198 | String pipeline = """
199 | pipeline {
200 | agent any
201 | parameters {
202 | stashedFile 'FILE'
203 | }
204 | stages {
205 | stage('Example') {
206 | steps {
207 | withFileParameter('FILE') {
208 | echo(/loaded '${readFile(FILE).toUpperCase(Locale.ROOT)}'/)
209 | }
210 | }
211 | }
212 | }
213 | }""";
214 |
215 | p.setDefinition(new CpsFlowDefinition(pipeline, true));
216 | WorkflowRun run = p.scheduleBuild2(0).get();
217 | r.waitForCompletion(run);
218 | // definitely will fail but we just ensure parameter has been created
219 | r.assertBuildStatus(Result.FAILURE, run);
220 | ParametersDefinitionProperty pdp = p.getProperty(ParametersDefinitionProperty.class);
221 | assertNotNull(pdp, "parameters definition property is null");
222 | ParameterDefinition pd = pdp.getParameterDefinition("FILE");
223 | assertNotNull(pd, "parameters definition is null");
224 | assertEquals(StashedFileParameterDefinition.class, pd.getClass(), "parameter not type Base64FileParameterDefinition");
225 |
226 | assertThat(new CLICommandInvoker(r, "build").
227 | withStdin(new ByteArrayInputStream("uploaded content here".getBytes())).
228 | invokeWithArgs("-f", "-p", "FILE=", "myjob"),
229 | CLICommandInvoker.Matcher.succeeded());
230 | WorkflowRun b = p.getBuildByNumber(2);
231 | assertNotNull(b);
232 | r.assertLogContains("loaded 'UPLOADED CONTENT HERE'", b);
233 | }
234 |
235 | @Issue("SECURITY-3123")
236 | @Test
237 | void stashMaliciousFilename(JenkinsRule r) throws Exception {
238 | String hack = "../../../../../../../../../../../../../../../../../../../../../tmp/file-parameters-plugin-SECURITY-3123";
239 | File result = new File("/tmp/file-parameters-plugin-SECURITY-3123");
240 | FileUtils.deleteQuietly(result);
241 | WorkflowJob p = r.createProject(WorkflowJob.class, "p");
242 | try {
243 | p.addProperty(new ParametersDefinitionProperty(new StashedFileParameterDefinition(hack)));
244 | } catch (Failure x) {
245 | return; // good
246 | }
247 | p.setDefinition(new CpsFlowDefinition("", true));
248 | assertThat(new CLICommandInvoker(r, "build").
249 | withStdin(new ByteArrayInputStream("malicious content here".getBytes())).
250 | invokeWithArgs("-f", "-p", hack + "=", "p"),
251 | CLICommandInvoker.Matcher.succeeded());
252 | WorkflowRun b = p.getBuildByNumber(1);
253 | assertNotNull(b);
254 | assertFalse(result.isFile());
255 | }
256 |
257 | @Test
258 | void shortParameterName(JenkinsRule r) throws Exception {
259 | r.createSlave("remote", null, null);
260 | WorkflowJob p = r.createProject(WorkflowJob.class, "p");
261 | p.addProperty(new ParametersDefinitionProperty(new Base64FileParameterDefinition("F")));
262 | String pipeline = """
263 | node('remote') {
264 | withFileParameter('F') {
265 | echo(/loaded '${readFile(F).toUpperCase(Locale.ROOT)}' from $F/)
266 | }
267 | }""";
268 | p.setDefinition(new CpsFlowDefinition(pipeline, true));
269 | assertThat(new CLICommandInvoker(r, "build").
270 | withStdin(new ByteArrayInputStream("uploaded content here".getBytes())).
271 | invokeWithArgs("-f", "-p", "F=", "p"),
272 | CLICommandInvoker.Matcher.succeeded());
273 | WorkflowRun b = p.getBuildByNumber(1);
274 | assertNotNull(b);
275 | r.assertLogContains("loaded 'UPLOADED CONTENT HERE' from ", b);
276 | }
277 |
278 | }
279 |
--------------------------------------------------------------------------------
/src/test/java/io/jenkins/plugins/file_parameters/RestartTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright 2024 CloudBees, Inc.
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 |
25 | package io.jenkins.plugins.file_parameters;
26 |
27 | import hudson.ExtensionList;
28 | import hudson.model.Node;
29 | import hudson.model.ParametersDefinitionProperty;
30 | import hudson.model.Queue;
31 | import hudson.model.queue.CauseOfBlockage;
32 | import hudson.model.queue.QueueTaskDispatcher;
33 | import jenkins.model.Jenkins;
34 | import org.apache.commons.io.FileUtils;
35 | import org.htmlunit.FormEncodingType;
36 | import org.htmlunit.HttpMethod;
37 | import org.htmlunit.WebRequest;
38 | import org.htmlunit.util.KeyDataPair;
39 | import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
40 | import org.jenkinsci.plugins.workflow.job.WorkflowJob;
41 | import org.jenkinsci.plugins.workflow.job.WorkflowRun;
42 | import org.junit.ClassRule;
43 | import org.junit.Rule;
44 | import org.junit.Test;
45 | import org.junit.rules.TemporaryFolder;
46 | import org.jvnet.hudson.test.BuildWatcher;
47 | import org.jvnet.hudson.test.Issue;
48 | import org.jvnet.hudson.test.JenkinsSessionRule;
49 | import org.jvnet.hudson.test.MockAuthorizationStrategy;
50 | import org.jvnet.hudson.test.TestExtension;
51 |
52 | import java.io.File;
53 | import java.net.URL;
54 | import java.util.Collections;
55 |
56 | import static org.junit.Assert.assertNotNull;
57 |
58 | @Issue("JENKINS-73161")
59 | public final class RestartTest {
60 |
61 | @ClassRule public static BuildWatcher buildWatcher = new BuildWatcher();
62 |
63 | @Rule public final JenkinsSessionRule rr = new JenkinsSessionRule();
64 |
65 | @Rule public TemporaryFolder tmp = new TemporaryFolder();
66 |
67 | /** @see AbstractFileParameterDefinitionTest#rest */
68 | @Test public void restBase64() throws Throwable {
69 | rr.then(r -> {
70 | r.jenkins.setSecurityRealm(r.createDummySecurityRealm());
71 | r.jenkins.setAuthorizationStrategy(new MockAuthorizationStrategy().grant(Jenkins.ADMINISTER).everywhere().to("admin"));
72 | WorkflowJob p = r.createProject(WorkflowJob.class, "p");
73 | p.addProperty(new ParametersDefinitionProperty(new Base64FileParameterDefinition("FILE")));
74 | p.setDefinition(new CpsFlowDefinition("echo(/received $FILE_FILENAME: $FILE/)", true));
75 | WebRequest req = new WebRequest(new URL(r.getURL() + "job/p/buildWithParameters"), HttpMethod.POST);
76 | File f = tmp.newFile();
77 | FileUtils.write(f, "uploaded content here", "UTF-8");
78 | req.setEncodingType(FormEncodingType.MULTIPART);
79 | req.setRequestParameters(Collections.singletonList(new KeyDataPair("FILE", f, "myfile.txt", "text/plain", "UTF-8")));
80 | r.createWebClient().withBasicApiToken("admin").getPage(req);
81 | });
82 | rr.then(r -> {
83 | ExtensionList.lookupSingleton(Block.class).ready = true;
84 | WorkflowJob p = r.jenkins.getItemByFullName("p", WorkflowJob.class);
85 | r.waitUntilNoActivity();
86 | WorkflowRun b = p.getBuildByNumber(1);
87 | assertNotNull(b);
88 | r.assertLogContains("received myfile.txt: dXBsb2FkZWQgY29udGVudCBoZXJl", b);
89 | });
90 | }
91 | @TestExtension("restBase64") public static final class Block extends QueueTaskDispatcher {
92 | boolean ready;
93 | @Override public CauseOfBlockage canTake(Node node, Queue.BuildableItem item) {
94 | return ready ? null : new CauseOfBlockage.BecauseNodeIsBusy(node);
95 | }
96 | }
97 |
98 | }
99 |
--------------------------------------------------------------------------------