/
ManagedFileUtil.java
89 lines (75 loc) · 3.87 KB
/
ManagedFileUtil.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
The MIT License
Copyright (c) 2011, Dominik Bartholdi, Olivier Lamy
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
package org.jenkinsci.plugins.configfiles.buildwrapper;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import edu.umd.cs.findbugs.annotations.Nullable;
import hudson.EnvVars;
import org.jenkinsci.lib.configprovider.model.ConfigFileManager;
import hudson.AbortException;
import hudson.FilePath;
import hudson.model.Run;
import hudson.model.TaskListener;
public class ManagedFileUtil {
/**
* provisions (publishes) the given files to the workspace.
*
* @param managedFiles the files to be provisioned
* @param build the build
* @param workspace target workspace
* @param listener the listener
* @param tempFiles temp files created by this method, these files should be deleted by the caller
* @return a map of all the files copied, mapped to the path of the remote location, never <code>null</code>.
* @throws IOException
* @throws InterruptedException
* @throws AbortException config file has not been found
*
* @deprecated Use method that provides 'env' instead.
*/
@Deprecated
public static Map<ManagedFile, FilePath> provisionConfigFiles(List<ManagedFile> managedFiles, Run<?, ?> build, FilePath workspace, TaskListener listener, List<String> tempFiles) throws IOException, InterruptedException {
return provisionConfigFiles(managedFiles, null, build, workspace, listener, tempFiles);
}
/**
* provisions (publishes) the given files to the workspace.
*
* @param managedFiles the files to be provisioned
* @param env enhanced environment to use in the variable substitution
* @param build the build
* @param workspace target workspace
* @param listener the listener
* @param tempFiles temp files created by this method, these files should be deleted by the caller
* @return a map of all the files copied, mapped to the path of the remote location, never <code>null</code>.
* @throws IOException
* @throws InterruptedException
* @throws AbortException config file has not been found
*/
public static Map<ManagedFile, FilePath> provisionConfigFiles(List<ManagedFile> managedFiles, @Nullable EnvVars env, Run<?, ?> build, FilePath workspace, TaskListener listener, List<String> tempFiles) throws IOException, InterruptedException {
final Map<ManagedFile, FilePath> file2Path = new HashMap<ManagedFile, FilePath>();
listener.getLogger().println("provisioning config files...");
for (ManagedFile managedFile : managedFiles) {
FilePath target = ConfigFileManager.provisionConfigFile(managedFile, env, build, workspace, listener, tempFiles);
file2Path.put(managedFile, target);
}
return file2Path;
}
}