> header) throws AbortException
27 | {
28 | if (!header.containsKey(key))
29 | throw new AbortException(String.format("Error triggering the remote job. The header of the response has an unexpected format: %n%s", header));
30 | location = header.get(key).get(0);
31 | try {
32 | String loc = location.substring(0, location.lastIndexOf('/'));
33 | id = loc.substring(loc.lastIndexOf('/')+1);
34 | } catch (Exception ex) {
35 | throw new AbortException(String.format("Error triggering the remote job. The header of the response contains an unexpected location: %s", location));
36 | }
37 | }
38 |
39 | @NonNull
40 | public String getLocation() {
41 | return location;
42 | }
43 |
44 | @NonNull
45 | public String getId() {
46 | return id;
47 | }
48 |
49 | }
50 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/remoteJob/QueueItemData.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.remoteJob;
2 |
3 | import java.net.MalformedURLException;
4 | import java.net.URL;
5 |
6 | import edu.umd.cs.findbugs.annotations.CheckForNull;
7 | import edu.umd.cs.findbugs.annotations.NonNull;
8 | import edu.umd.cs.findbugs.annotations.Nullable;
9 |
10 | import org.jenkinsci.plugins.ParameterizedRemoteTrigger.BuildContext;
11 | import net.sf.json.JSONException;
12 |
13 | import net.sf.json.JSONObject;
14 |
15 | /**
16 | * Contains information about the remote job while is waiting on the queue.
17 | *
18 | */
19 | public class QueueItemData
20 | {
21 | @NonNull
22 | private QueueItemStatus status;
23 |
24 | @Nullable
25 | private String why;
26 |
27 | @NonNull
28 | private int buildNumber;
29 |
30 | @Nullable
31 | private URL buildURL;
32 |
33 |
34 | public QueueItemData() throws MalformedURLException
35 | {
36 | this.status = QueueItemStatus.WAITING;
37 | }
38 |
39 | public boolean isWaiting()
40 | {
41 | return status == QueueItemStatus.WAITING;
42 | }
43 |
44 | public boolean isBlocked()
45 | {
46 | return status == QueueItemStatus.BLOCKED;
47 | }
48 |
49 | public boolean isBuildable()
50 | {
51 | return status == QueueItemStatus.BUILDABLE;
52 | }
53 |
54 | public boolean isPending()
55 | {
56 | return status == QueueItemStatus.PENDING;
57 | }
58 |
59 | public boolean isLeft()
60 | {
61 | return status == QueueItemStatus.LEFT;
62 | }
63 |
64 | public boolean isExecuted()
65 | {
66 | return status == QueueItemStatus.EXECUTED;
67 | }
68 |
69 | public boolean isCancelled()
70 | {
71 | return status == QueueItemStatus.CANCELLED;
72 | }
73 |
74 | @NonNull
75 | public QueueItemStatus getStatus() {
76 | return status;
77 | }
78 |
79 | @CheckForNull
80 | public String getWhy() {
81 | return why;
82 | }
83 |
84 | @NonNull
85 | public int getBuildNumber()
86 | {
87 | return buildNumber;
88 | }
89 |
90 | @CheckForNull
91 | public URL getBuildURL()
92 | {
93 | return buildURL;
94 | }
95 |
96 | /**
97 | * Updates the queue item data with a queue response.
98 | *
99 | * @param context
100 | * the context of this Builder/BuildStep.
101 | * @param queueResponse
102 | * the queue response
103 | * @throws MalformedURLException
104 | * if there is an error creating the build URL.
105 | */
106 | public void update(@NonNull BuildContext context, @NonNull JSONObject queueResponse) throws MalformedURLException
107 | {
108 | if (queueResponse.getBoolean("blocked")) status = QueueItemStatus.BLOCKED;
109 | if (queueResponse.getBoolean("buildable")) status = QueueItemStatus.BUILDABLE;
110 | if (getOptionalBoolean(queueResponse, "pending")) status = QueueItemStatus.PENDING;
111 | if (getOptionalBoolean(queueResponse, "cancelled")) status = QueueItemStatus.CANCELLED;
112 | if (isBlocked() || isBuildable() || isPending()) why = queueResponse.getString("why");
113 | else if (!isCancelled()) status = QueueItemStatus.LEFT;
114 |
115 | if (isLeft()) {
116 | try {
117 | JSONObject remoteJobInfo = queueResponse.getJSONObject("executable");
118 | if (!(remoteJobInfo.isNullObject())) {
119 | try {
120 | buildNumber = remoteJobInfo.getInt("number");
121 | } catch (JSONException e) {
122 | context.logger.println(String.format("[WARNING] The attribute \"number\" was not found. Unexpected response: %s", queueResponse.toString()));
123 | }
124 | try {
125 | buildURL = new URL(remoteJobInfo.getString("url"));
126 | } catch (JSONException e) {
127 | context.logger.println(String.format("[WARNING] The attribute \"url\" was not found. Unexpected response: %s", queueResponse.toString()));
128 | }
129 | }
130 | } catch (JSONException e) {
131 | context.logger.println(String.format("[WARNING] The attribute \"executable\" was not found. Unexpected response: %s", queueResponse.toString()));
132 | }
133 | if (buildNumber != 0 && buildURL != null) status = QueueItemStatus.EXECUTED;
134 | }
135 | }
136 |
137 | private boolean getOptionalBoolean(@NonNull JSONObject queueResponse, @NonNull String attribute)
138 | {
139 | if (queueResponse.containsKey(attribute))
140 | return queueResponse.getBoolean(attribute);
141 | else return false;
142 | }
143 | }
144 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/remoteJob/QueueItemStatus.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.remoteJob;
2 |
3 | /**
4 | * This class implements the status of an item while it is on the queue.
5 | *
6 | * See {@link hudson.model.Queue}.
7 | *
8 | *
{@code
9 | * (enter Queue) --> WAITING --+--> BLOCKED
10 | | ^
11 | | |
12 | | v
13 | +-------> BUILDABLE ---> PENDING ---> LEFT --> EXECUTED
14 | ^ |
15 | | |
16 | +---(rarely)---+
17 | *}
18 | *
19 | *
20 | * When the remote build is triggered, the remote job enters the queue (waiting list)
21 | * and the queue item status is WAITING.
22 | *
23 | * After that, if there is another build already in progress, the queue item status changes to BLOCKED.
24 | *
25 | * On the contrary, if there is not another build in progress, the queue item status changes to BUILDABLE.
26 | *
27 | * Once the queue item is buildable, it needs to wait for an available executor, and the status changes
28 | * to PENDING.
29 | *
30 | * If the node disappears before the execution starts, the status moves back to BUILDABLE,
31 | * but this is not the normal case.
32 | *
33 | * When there is an available executor and the execution starts, the queue item leaves the queue,
34 | * and the status changes to LEFT.
35 | *
36 | * When the remote job leaves the queue, the build number and the build URL are available.
37 | * The build URL can be used to request information about the remote job while it is being executed.
38 | *
39 | * Sometimes, we did face some issues, because the item left the queue but this properties where not available,
40 | * therefore the status EXECUTED was added.
41 | *
42 | * When this properties are available, the queue item status changes to EXECUTED. This is the final status.
43 | *
44 | * In addition, at any status, an item can be removed from the queue, in this case an AbortException is thrown.
45 | *
46 | */
47 | public enum QueueItemStatus
48 | {
49 | /**
50 | * If a queue item enters the queue (waiting list).
51 | */
52 | WAITING("WAITING"),
53 |
54 | /**
55 | * If another build is already in progress.
56 | */
57 | BLOCKED("BLOCKED"),
58 |
59 | /**
60 | * If there is not another build in progress.
61 | */
62 | BUILDABLE("BUILDABLE"),
63 |
64 | /**
65 | * If the queue item is waiting for an available executor.
66 | */
67 | PENDING("PENDING"),
68 |
69 | /**
70 | * If there is an available executor and no build is already in progress.
71 | */
72 | LEFT("LEFT"),
73 |
74 | /**
75 | * The queue item left the queue and the build information (build number and build URL) is available.
76 | */
77 | EXECUTED("EXECUTED"),
78 |
79 | /**
80 | * If the queue item was cancelled and therefore it will not be executed.
81 | */
82 | CANCELLED("CANCELLED");
83 |
84 |
85 | private final String id;
86 |
87 |
88 | private QueueItemStatus(String id) {
89 | this.id = id;
90 | }
91 |
92 | @Override
93 | public String toString() {
94 | return id;
95 | }
96 |
97 | }
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/remoteJob/RemoteBuildInfo.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.remoteJob;
2 |
3 | import java.io.Serializable;
4 | import java.net.URL;
5 |
6 | import edu.umd.cs.findbugs.annotations.CheckForNull;
7 | import edu.umd.cs.findbugs.annotations.NonNull;
8 | import edu.umd.cs.findbugs.annotations.Nullable;
9 |
10 | import hudson.AbortException;
11 | import hudson.model.Result;
12 |
13 | /**
14 | * This class contains information about the remote build.
15 | *
16 | *
{@code
17 | * NOT_TRIGGERED ---+---> QUEUED --+--> RUNNING -----+-----> FINISHED
18 | queueId buildNumber result
19 | & buildURL (ABORTED | UNSTABLE | FAILURE | SUCCESS)
20 | *}
21 | *
22 | *
23 | * By default, the remote build status is NOT_TRIGGERED and the remote build result is NOT_BUILT.
24 | *
25 | * When the remote build is triggered, the remote job enters the queue (waiting list)
26 | * and the status of the remote build changes to QUEUED. In this moment the queueId is available.
27 | * The queueId can be used to request information about the remote job while it is waiting to be executed.
28 | *
29 | * When the remote job leaves the queue, the status changes to RUNNING. Then, the build number and the build URL
30 | * are available. The build URL can be used to request information about the remote job while it is being executed.
31 | *
32 | * When the remote job is finished, the status changes to FINISHED. Then, the remote build result is available.
33 | *
34 | */
35 | public class RemoteBuildInfo implements Serializable
36 | {
37 | private static final long serialVersionUID = -5177308623227407314L;
38 |
39 | @CheckForNull
40 | private String queueId;
41 |
42 | @NonNull
43 | private int buildNumber;
44 |
45 | @CheckForNull
46 | private URL buildURL;
47 |
48 | @NonNull
49 | private RemoteBuildStatus status;
50 |
51 | @NonNull
52 | private Result result;
53 |
54 |
55 | public RemoteBuildInfo()
56 | {
57 | status = RemoteBuildStatus.NOT_TRIGGERED;
58 | result = Result.NOT_BUILT;
59 | }
60 |
61 | @CheckForNull
62 | public String getQueueId() {
63 | return queueId;
64 | }
65 |
66 | @NonNull
67 | public int getBuildNumber()
68 | {
69 | return buildNumber;
70 | }
71 |
72 | @CheckForNull
73 | public URL getBuildURL()
74 | {
75 | return buildURL;
76 | }
77 |
78 | @NonNull
79 | public RemoteBuildStatus getStatus()
80 | {
81 | return status;
82 | }
83 |
84 | @NonNull
85 | public Result getResult()
86 | {
87 | return result;
88 | }
89 |
90 | public void setQueueId(String queueId) {
91 | this.queueId = queueId;
92 | this.status = RemoteBuildStatus.QUEUED;
93 | }
94 |
95 | public void setBuildData(@NonNull int buildNumber, @Nullable URL buildURL) throws AbortException
96 | {
97 | if (buildURL == null) {
98 | throw new AbortException(String.format("Unexpected remote build status: %s", toString()));
99 | }
100 | this.buildNumber = buildNumber;
101 | this.buildURL = buildURL;
102 | this.status = RemoteBuildStatus.RUNNING;
103 | }
104 |
105 | public void setBuildStatus(RemoteBuildStatus status)
106 | {
107 | if (status == RemoteBuildStatus.FINISHED) {
108 | throw new IllegalArgumentException("It is not possible to set the status to finished without setting the build result. "
109 | + "Please use BuildInfo(Result result) or BuildInfo(String result) in order to set the status to finished.");
110 | } else {
111 | this.status = status;
112 | this.result = Result.NOT_BUILT;
113 | }
114 | }
115 |
116 | public void setBuildResult(Result result)
117 | {
118 | this.status = RemoteBuildStatus.FINISHED;
119 | this.result = result;
120 | }
121 |
122 | public void setBuildResult(String result)
123 | {
124 | this.status = RemoteBuildStatus.FINISHED;
125 | this.result = Result.fromString(result);
126 | }
127 |
128 | @NonNull
129 | @Override
130 | public String toString()
131 | {
132 | if (status == RemoteBuildStatus.FINISHED) return String.format("status=%s, result=%s", status.toString(), result.toString());
133 | else return String.format("status=%s", status.toString());
134 | }
135 |
136 | public boolean isNotTriggered() {
137 | return status == RemoteBuildStatus.NOT_TRIGGERED;
138 | }
139 |
140 | public boolean isQueued() {
141 | return status == RemoteBuildStatus.QUEUED;
142 | }
143 |
144 | public boolean isRunning() {
145 | return status == RemoteBuildStatus.RUNNING;
146 | }
147 |
148 | public boolean isFinished() {
149 | return status == RemoteBuildStatus.FINISHED;
150 | }
151 | }
152 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/remoteJob/RemoteBuildInfoExporterAction.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.remoteJob;
2 |
3 | import edu.umd.cs.findbugs.annotations.NonNull;
4 |
5 | import java.net.URL;
6 | import java.util.ArrayList;
7 | import java.util.LinkedHashSet;
8 | import java.util.List;
9 | import java.util.Set;
10 |
11 | import hudson.EnvVars;
12 | import hudson.model.AbstractBuild;
13 | import hudson.model.EnvironmentContributingAction;
14 | import hudson.model.Run;
15 |
16 | public class RemoteBuildInfoExporterAction implements EnvironmentContributingAction {
17 |
18 | public static final String JOB_NAME_VARIABLE = "LAST_TRIGGERED_JOB_NAME";
19 | public static final String ALL_JOBS_NAME_VARIABLE = "TRIGGERED_JOB_NAMES";
20 | public static final String BUILD_URL_VARIABLE_PREFIX = "TRIGGERED_BUILD_URL_";
21 | public static final String BUILD_NUMBER_VARIABLE_PREFIX = "TRIGGERED_BUILD_NUMBER_";
22 | public static final String ALL_BUILD_NUMBER_VARIABLE_PREFIX = "TRIGGERED_BUILD_NUMBERS_";
23 | public static final String BUILD_RESULT_VARIABLE_PREFIX = "TRIGGERED_BUILD_RESULT_";
24 | public static final String BUILD_RUN_COUNT_PREFIX = "TRIGGERED_BUILD_RUN_COUNT_";
25 | public static final String RUN = "_RUN_";
26 |
27 | private List builds;
28 |
29 | public RemoteBuildInfoExporterAction(Run parentBuild, BuildReference buildRef) {
30 | super();
31 |
32 | this.builds = new ArrayList();
33 | addBuildReferenceSafe(buildRef);
34 | }
35 |
36 | public static RemoteBuildInfoExporterAction addBuildInfoExporterAction(@NonNull Run parentBuild, String triggeredProjectName, int buildNumber, URL jobURL, RemoteBuildInfo buildInfo) {
37 | BuildReference reference = new BuildReference(triggeredProjectName, buildNumber, jobURL, buildInfo);
38 |
39 | RemoteBuildInfoExporterAction action;
40 | synchronized(parentBuild) {
41 | action = parentBuild.getAction(RemoteBuildInfoExporterAction.class);
42 | if (action == null) {
43 | action = new RemoteBuildInfoExporterAction(parentBuild, reference);
44 | parentBuild.addAction(action);
45 | } else {
46 | action.addBuildReference(reference);
47 | }
48 | }
49 | return action;
50 | }
51 |
52 | /**
53 | * Prevents duplicate build refs. The latest BuildReference wins (to reflect the latest Result).
54 | */
55 | private void addBuildReferenceSafe(BuildReference buildRef)
56 | {
57 | synchronized (builds) {
58 | removeDuplicates(builds, buildRef);
59 | builds.add(buildRef);
60 | }
61 | }
62 |
63 | /**
64 | * Finds and removes duplicates of buildRef in the buildRefList based on the projectName and buildNumber (only).
65 | * @return true if duplicates found and removed, false if nothing found
66 | */
67 | private boolean removeDuplicates(List buildRefList, BuildReference buildRef) {
68 | List duplicates = new ArrayList();
69 | for(BuildReference build : buildRefList) {
70 | if(build.projectName.equals(buildRef.projectName) && build.buildNumber == buildRef.buildNumber) {
71 | duplicates.add(build);
72 | }
73 | }
74 | if(duplicates.size() > 0) {
75 | buildRefList.removeAll(duplicates);
76 | return true;
77 | } else {
78 | return false;
79 | }
80 | }
81 |
82 | public void addBuildReference(BuildReference buildRef) {
83 | addBuildReferenceSafe(buildRef);
84 | }
85 |
86 | public static class BuildReference {
87 | public final String projectName;
88 | public final int buildNumber;
89 | public final RemoteBuildInfo buildInfo;
90 | public final URL jobURL;
91 |
92 | public BuildReference(String projectName, int buildNumber, URL jobURL, RemoteBuildInfo buildInfo) {
93 | this.projectName = projectName;
94 | this.buildNumber = buildNumber;
95 | this.buildInfo = buildInfo;
96 | this.jobURL = jobURL;
97 | }
98 | }
99 |
100 | public String getIconFileName() {
101 | // TODO Auto-generated method stub
102 | return null;
103 | }
104 |
105 | public String getDisplayName() {
106 | // TODO Auto-generated method stub
107 | return null;
108 | }
109 |
110 | public String getUrlName() {
111 | // TODO Auto-generated method stub
112 | return null;
113 | }
114 |
115 | public void buildEnvVars(AbstractBuild build, EnvVars env) {
116 | for (String project : getProjectsWithBuilds()) {
117 | String sanatizedProjectName = sanitizeProjectName(project);
118 | List refs = getBuildRefs(project);
119 |
120 | env.put(ALL_BUILD_NUMBER_VARIABLE_PREFIX + sanatizedProjectName, getBuildNumbersString(refs, ","));
121 | env.put(BUILD_RUN_COUNT_PREFIX + sanatizedProjectName, Integer.toString(refs.size()));
122 | for (BuildReference br : refs) {
123 | if (br.buildNumber != 0) {
124 | String tiggeredBuildRunResultKey = BUILD_RESULT_VARIABLE_PREFIX + sanatizedProjectName + RUN + Integer.toString(br.buildNumber);
125 | env.put(tiggeredBuildRunResultKey, br.buildInfo.getResult().toString());
126 | }
127 | }
128 | BuildReference lastBuild = null;
129 | for (int i = (refs.size()); i > 0; i--) {
130 | if (refs.get(i - 1).buildNumber != 0) {
131 | lastBuild = refs.get(i - 1);
132 | break;
133 | }
134 | }
135 | if (lastBuild != null) {
136 | env.put(JOB_NAME_VARIABLE, lastBuild.projectName);
137 | env.put(BUILD_NUMBER_VARIABLE_PREFIX + sanatizedProjectName, Integer.toString(lastBuild.buildNumber));
138 | env.put(BUILD_URL_VARIABLE_PREFIX + sanatizedProjectName, lastBuild.jobURL.toString());
139 | env.put(BUILD_RESULT_VARIABLE_PREFIX + sanatizedProjectName, lastBuild.buildInfo.getResult().toString());
140 | }
141 | }
142 | }
143 |
144 | public static String sanitizeProjectName(String project)
145 | {
146 | if(project == null) return null;
147 | return project.replaceAll("[^a-zA-Z0-9]+", "_");
148 | }
149 |
150 | private List getBuildRefs(String project) {
151 | List refs = new ArrayList();
152 | synchronized (builds) {
153 | for (BuildReference br : builds) {
154 | if (br.projectName.equals(project)) refs.add(br);
155 | }
156 | }
157 | return refs;
158 | }
159 |
160 | /**
161 | * Gets a string for all of the build numbers
162 | *
163 | * @param refs List of build references to process.
164 | * @param separator
165 | * @return String containing all the build numbers from refs, never null but
166 | * can be empty
167 | */
168 | private String getBuildNumbersString(List refs, String separator) {
169 | StringBuilder buf = new StringBuilder();
170 | boolean first = true;
171 |
172 | for (BuildReference s : refs) {
173 | if (s.buildNumber != 0) {
174 | if (first) {
175 | first = false;
176 | } else {
177 | buf.append(separator);
178 | }
179 | buf.append(s.buildNumber);
180 | }
181 | }
182 | return buf.toString();
183 | }
184 |
185 | /**
186 | * Gets the unique set of project names that have a linked build.
187 | * The later triggered jobs are later in the list. E.g.
188 | * C, A, B -> C, A, B
189 | * C, A, B, A, C -> B, A, C
190 | *
191 | * @return Set of project names that have at least one build linked.
192 | */
193 | protected Set getProjectsWithBuilds() {
194 | Set projects = new LinkedHashSet();
195 | synchronized (builds) {
196 | for (BuildReference br : this.builds) {
197 | if (br.buildNumber != 0) {
198 | if(projects.contains(br.projectName)) projects.remove(br.projectName); //Move to the end
199 | projects.add(br.projectName);
200 | }
201 | }
202 | }
203 | return projects;
204 | }
205 | }
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/remoteJob/RemoteBuildStatus.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.remoteJob;
2 |
3 | /**
4 | * This class implements the build status of a remote build.
5 | *
6 | *{@code
7 | * NOT_TRIGGERED --+--> QUEUED --+--> RUNNING --+--> FINISHED
8 | | |
9 | | |
10 | +-------> Cancelled <----------+
11 | *}
12 | *
13 | *
14 | * By default, the remote build status is NOT_TRIGGERED.
15 | *
16 | * When the remote build is triggered, the remote job enters the queue (waiting list)
17 | * and the status of the remote build changes to QUEUED.
18 | *
19 | * When the remote job leaves the queue, the status changes to RUNNING.
20 | *
21 | * When the remote job is finished, the status changes to FINISHED. This is the final status.
22 | *
23 | * In addition, at the status QUEUED and FINISHED, a remote build can be cancelled,
24 | * in this case an AbortException is thrown.
25 | */
26 | public enum RemoteBuildStatus
27 | {
28 | /**
29 | * The remote job was not triggered and it did not enter the queue.
30 | */
31 | NOT_TRIGGERED("NOT_TRIGGERED"),
32 |
33 | /**
34 | * The remote job was triggered and it did enter the queue.
35 | */
36 | QUEUED("QUEUED"),
37 |
38 | /**
39 | * The remote job left the queue and it is running currently.
40 | */
41 | RUNNING("RUNNING"),
42 |
43 | /**
44 | * The remote build is finished.
45 | */
46 | FINISHED("FINISHED");
47 |
48 |
49 | private final String id;
50 |
51 |
52 | private RemoteBuildStatus(String id) {
53 | this.id = id;
54 | }
55 |
56 | @Override
57 | public String toString() {
58 | return id;
59 | }
60 |
61 | }
62 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/utils/Base64Utils.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.utils;
2 |
3 | import static org.apache.commons.lang.StringUtils.isEmpty;
4 |
5 | import java.io.IOException;
6 |
7 | import edu.umd.cs.findbugs.annotations.NonNull;
8 | import java.io.UnsupportedEncodingException;
9 |
10 | import org.apache.commons.codec.binary.Base64;
11 | import org.jenkinsci.plugins.ParameterizedRemoteTrigger.BuildContext;
12 |
13 | public class Base64Utils
14 | {
15 |
16 | public static final String AUTHTYPE_BASIC = "Basic";
17 |
18 | public static String encode(String input) throws UnsupportedEncodingException
19 | {
20 | byte[] encoded = Base64.encodeBase64(input.getBytes("UTF-8"));
21 | return new String(encoded, "UTF-8");
22 | }
23 |
24 | /**
25 | * Creates the value for an Authorization header consisting of:
26 | * "authType base64Encoded(user:password)"
27 | * e.g. "Basic zhwef9tz33ergwerg4394zh370345zh=="
28 | *
29 | * @param authType
30 | * the authorization type.
31 | * @param user
32 | * the user name.
33 | * @param password
34 | * the user password.
35 | * @param context
36 | * the context of this Builder/BuildStep.
37 | * @param applyMacro
38 | * boolean to control if macro replacements occur
39 | * @return the base64 encoded authorization.
40 | * @throws IOException
41 | * if there is a failure while replacing token macros, or
42 | * if there is a failure while encoding user:password.
43 | */
44 | @NonNull
45 | public static String generateAuthorizationHeaderValue(String authType, String user, String password,
46 | BuildContext context, boolean applyMacro) throws IOException
47 | {
48 | if (isEmpty(user)) throw new IllegalArgumentException("user null or empty");
49 | if (password == null) throw new IllegalArgumentException("password null"); // is empty password allowed for Basic Auth?
50 | String authTypeKey = getAuthType(authType);
51 | String tuple = user + ":" + password;
52 | if (applyMacro) {
53 | tuple = TokenMacroUtils.applyTokenMacroReplacements(tuple, context);
54 | }
55 | String encodedTuple = Base64Utils.encode(tuple);
56 | return authTypeKey + " " + encodedTuple;
57 | }
58 |
59 | @NonNull
60 | private static String getAuthType(String authType)
61 | {
62 | if ("Basic".equalsIgnoreCase(authType)) return "Basic";
63 | throw new IllegalArgumentException("AuthType wrong or not supported yet: " + authType);
64 | }
65 |
66 | }
67 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/utils/DropCachePeriodicWork.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.utils;
2 |
3 | import java.util.HashMap;
4 | import java.util.Map;
5 | import java.util.concurrent.TimeUnit;
6 | import java.util.concurrent.locks.Lock;
7 | import java.util.concurrent.locks.ReentrantLock;
8 | import java.util.logging.Level;
9 | import java.util.logging.Logger;
10 |
11 | import org.jenkinsci.plugins.ParameterizedRemoteTrigger.JenkinsCrumb;
12 |
13 | import hudson.Extension;
14 | import hudson.model.PeriodicWork;
15 | import net.sf.json.JSONObject;
16 |
17 | @Extension
18 | public class DropCachePeriodicWork extends PeriodicWork {
19 |
20 | private static Map crumbMap = new HashMap<>();
21 | private static Map jobInfoMap = new HashMap<>();
22 |
23 | private static Logger logger = Logger.getLogger(DropCachePeriodicWork.class.getName());
24 | private static Lock jobInfoLock = new ReentrantLock();
25 | private static Lock crumbLock = new ReentrantLock();
26 |
27 | @Override
28 | public long getRecurrencePeriod() {
29 | return TimeUnit.MINUTES.toMillis(10);
30 | }
31 |
32 | public static JenkinsCrumb safePutCrumb(String key, JenkinsCrumb jenkinsCrumb, boolean isCacheEnable) {
33 | if (!isCacheEnable)
34 | return jenkinsCrumb;
35 | try {
36 | crumbLock.lock();
37 | crumbMap.put(key, jenkinsCrumb);
38 | return jenkinsCrumb;
39 | } finally {
40 | crumbLock.unlock();
41 | }
42 | }
43 |
44 | public static JenkinsCrumb safeGetCrumb(String key, boolean isCacheEnable) {
45 | if (!isCacheEnable)
46 | return null;
47 | try {
48 | crumbLock.lock();
49 | if (crumbMap.containsKey(key)) {
50 | return crumbMap.get(key);
51 | } else {
52 | return null;
53 | }
54 | } finally {
55 | crumbLock.unlock();
56 | }
57 | }
58 |
59 | public static JSONObject safePutJobInfo(String key, JSONObject jobInfo, boolean isCacheEnable) {
60 | if (!isCacheEnable)
61 | return jobInfo;
62 | try {
63 | jobInfoLock.lock();
64 | jobInfoMap.put(key, jobInfo);
65 | return jobInfo;
66 | } finally {
67 | jobInfoLock.unlock();
68 | }
69 | }
70 |
71 | public static JSONObject safeGetJobInfo(String key, boolean isCacheEnable) {
72 | if (!isCacheEnable)
73 | return null;
74 | try {
75 | jobInfoLock.lock();
76 | if (jobInfoMap.containsKey(key)) {
77 | return jobInfoMap.get(key);
78 | } else {
79 | return null;
80 | }
81 | } finally {
82 | jobInfoLock.unlock();
83 | }
84 | }
85 |
86 | @Override
87 | protected void doRun() throws Exception {
88 | logger.log(Level.INFO, "begin schedule clean...");
89 |
90 | try {
91 | crumbLock.lock();
92 | crumbMap.clear();
93 | } catch (Exception e) {
94 | logger.log(Level.WARNING, "Fail to clear crumb cache", e);
95 | } finally {
96 | crumbLock.unlock();
97 | }
98 |
99 | try {
100 | jobInfoLock.lock();
101 | jobInfoMap.clear();
102 | } catch (Exception e) {
103 | logger.log(Level.WARNING, "Fail to clear job info cache", e);
104 | } finally {
105 | jobInfoLock.unlock();
106 | }
107 |
108 | logger.log(Level.INFO, "end schedule clean...");
109 | }
110 |
111 | }
112 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/utils/FormValidationUtils.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.utils;
2 |
3 | import static org.apache.commons.lang.StringUtils.isEmpty;
4 | import static org.apache.commons.lang.StringUtils.trimToNull;
5 |
6 | import java.net.MalformedURLException;
7 | import java.net.URL;
8 | import java.util.Arrays;
9 |
10 | import org.kohsuke.accmod.Restricted;
11 | import org.kohsuke.accmod.restrictions.NoExternalUse;
12 |
13 | import hudson.util.FormValidation;
14 |
15 | @Restricted(NoExternalUse.class)
16 | public class FormValidationUtils
17 | {
18 |
19 | public static enum AffectedField {
20 | JOB_NAME_OR_URL, REMOTE_JENKINS_URL, REMOTE_JENKINS_NAME
21 | }
22 |
23 | public static class RemoteURLCombinationsResult {
24 |
25 | public final FormValidation formValidation;
26 | public final AffectedField[] affectedFields;
27 |
28 | public RemoteURLCombinationsResult(FormValidation formValidation, AffectedField...affectedFields) {
29 | this.formValidation = formValidation;
30 | this.affectedFields = affectedFields;
31 | }
32 |
33 | public boolean isAffected(AffectedField field) {
34 | return Arrays.asList(affectedFields).contains(field);
35 | }
36 |
37 | public static RemoteURLCombinationsResult OK()
38 | {
39 | return new RemoteURLCombinationsResult(FormValidation.ok(), AffectedField.values());
40 | }
41 |
42 | }
43 |
44 | public static RemoteURLCombinationsResult checkRemoteURLCombinations(String remoteJenkinsUrl, String remoteJenkinsName, String jobNameOrUrl) {
45 | remoteJenkinsUrl = trimToNull(remoteJenkinsUrl);
46 | remoteJenkinsName = trimToNull(remoteJenkinsName);
47 | jobNameOrUrl = trimToNull(jobNameOrUrl);
48 | boolean remoteUrl_setAndValidUrl = isEmpty(remoteJenkinsUrl) ? false : isURL(remoteJenkinsUrl);
49 | boolean remoteName_setAndValid = !isEmpty(remoteJenkinsName);
50 | boolean job_setAndValidUrl = isEmpty(jobNameOrUrl) ? false : isURL(jobNameOrUrl);
51 | boolean job_setAndNoUrl = isEmpty(jobNameOrUrl) ? false : !isURL(jobNameOrUrl);
52 | boolean job_containsVariable = isEmpty(jobNameOrUrl) ? false : jobNameOrUrl.indexOf("$") >= 0;
53 | final String TEXT_WARNING_JOB_VARIABLE = "You are using a variable in the 'Remote Job Name or URL' ('job') field. You have to make sure the value at runtime results in the full job URL";
54 | final String TEXT_ERROR_NO_URL_AT_ALL = "You have to configure either 'Select a remote host' ('remoteJenkinsName'), 'Override remote host URL' ('remoteJenkinsUrl') or specify a full job URL 'Remote Job Name or URL' ('job')";
55 |
56 | if(isEmpty(jobNameOrUrl)) {
57 | return new RemoteURLCombinationsResult(
58 | FormValidation.error("'Remote Job Name or URL' ('job') not specified"),
59 | AffectedField.JOB_NAME_OR_URL);
60 | } else if(!isEmpty(remoteJenkinsUrl) && !isURL(remoteJenkinsUrl)) {
61 | return new RemoteURLCombinationsResult(
62 | FormValidation.error("Invalid URL in 'Override remote host URL' ('remoteJenkinsUrl')"),
63 | AffectedField.REMOTE_JENKINS_URL);
64 | } else if(!remoteUrl_setAndValidUrl && !remoteName_setAndValid && !job_setAndValidUrl) {
65 | //Root URL or full job URL not specified at all
66 | if(job_containsVariable) {
67 | return new RemoteURLCombinationsResult(FormValidation.warning(TEXT_WARNING_JOB_VARIABLE), AffectedField.JOB_NAME_OR_URL);
68 | } else {
69 | return new RemoteURLCombinationsResult(FormValidation.error(TEXT_ERROR_NO_URL_AT_ALL),
70 | AffectedField.JOB_NAME_OR_URL, AffectedField.REMOTE_JENKINS_NAME, AffectedField.REMOTE_JENKINS_URL);
71 | }
72 | } else if(job_setAndValidUrl) {
73 | return RemoteURLCombinationsResult.OK();
74 | } else if(remoteUrl_setAndValidUrl && job_setAndNoUrl) {
75 | if(job_containsVariable) {
76 | return new RemoteURLCombinationsResult(FormValidation.warning(TEXT_WARNING_JOB_VARIABLE), AffectedField.JOB_NAME_OR_URL);
77 | } else {
78 | return RemoteURLCombinationsResult.OK();
79 | }
80 | } else if(remoteName_setAndValid && job_setAndNoUrl) {
81 | if(job_containsVariable) {
82 | return new RemoteURLCombinationsResult(FormValidation.warning(TEXT_WARNING_JOB_VARIABLE), AffectedField.JOB_NAME_OR_URL);
83 | } else {
84 | return RemoteURLCombinationsResult.OK();
85 | }
86 | } else {
87 | return new RemoteURLCombinationsResult(FormValidation.error(TEXT_ERROR_NO_URL_AT_ALL),
88 | AffectedField.JOB_NAME_OR_URL, AffectedField.REMOTE_JENKINS_NAME, AffectedField.REMOTE_JENKINS_URL);
89 | }
90 | }
91 |
92 | /**
93 | * Checks if a string is a valid http/https URL.
94 | *
95 | * @param string
96 | * the url to check.
97 | * @return true if parameter is a valid http/https URL.
98 | */
99 | public static boolean isURL(String string) {
100 | if(isEmpty(trimToNull(string))) return false;
101 | String stringLower = string.toLowerCase();
102 | if(stringLower.startsWith("http://") || stringLower.startsWith("https://")) {
103 | if(stringLower.indexOf("://") >= stringLower.length()-3) {
104 | return false; //URL ends after protocol
105 | }
106 | if(stringLower.indexOf("$") >= 0) {
107 | return false; //We interpret $ in URLs as variables which need to be replaced. TODO: What about URI standard which allows $?
108 | }
109 | try {
110 | new URL(string);
111 | return true;
112 | }
113 | catch (MalformedURLException e) {
114 | return false;
115 | }
116 | } else {
117 | return false;
118 | }
119 | }
120 |
121 | }
122 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/utils/NaiveTrustManager.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.utils;
2 |
3 | import javax.net.ssl.*;
4 | import java.security.cert.X509Certificate;
5 |
6 | // Trust every server
7 | public class NaiveTrustManager implements X509TrustManager {
8 | @Override
9 | public void checkClientTrusted(X509Certificate[] arg0, String arg1) {}
10 |
11 | @Override
12 | public void checkServerTrusted(X509Certificate[] arg0, String arg1) {}
13 |
14 | @Override
15 | public X509Certificate[] getAcceptedIssuers() {
16 | return null;
17 | }
18 | }
19 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/utils/OtelUtils.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.utils;
2 |
3 | import hudson.Plugin;
4 | import hudson.PluginWrapper;
5 | import hudson.model.Run;
6 | import io.jenkins.plugins.opentelemetry.job.OtelTraceService;
7 | import io.opentelemetry.api.trace.Span;
8 | import io.opentelemetry.context.Context;
9 | import jenkins.model.Jenkins;
10 | import org.jenkinsci.plugins.workflow.graph.FlowNode;
11 | import org.jenkinsci.plugins.workflow.steps.StepContext;
12 | import edu.umd.cs.findbugs.annotations.NonNull;
13 |
14 | import java.util.Optional;
15 |
16 | public class OtelUtils {
17 |
18 | private static String TRACE_PARENT_VERSION = "00";
19 | private static String TRACE_PARENT_TRACE_FLAG = "01";
20 |
21 | public static String getTraceParent() {
22 | return Optional.ofNullable(Span.fromContextOrNull(Context.current()))
23 | .map(OtelUtils::genTraceParent)
24 | .orElse(null);
25 |
26 | }
27 |
28 |
29 | public static AutoCloseable activeSpanIfAvailable(StepContext stepContext) {
30 | try {
31 | FlowNode flowNode = stepContext.get(FlowNode.class);
32 | Run run = stepContext.get(Run.class);
33 | return Optional.ofNullable(Jenkins.get().getExtensionList(OtelTraceService.class))
34 | .filter(list -> list.size()>0)
35 | .map(list -> list.get(0))
36 | .map(otelTraceServices -> otelTraceServices.getSpan(run, flowNode))
37 | .map(Span::makeCurrent)
38 | .map(AutoCloseable.class::cast)
39 | .orElseGet(OtelUtils::noop);
40 | } catch (Exception e) {
41 | throw new RuntimeException(e);
42 | }
43 | }
44 |
45 | public static AutoCloseable activeSpanIfAvailable(Run run) {
46 | return Optional.ofNullable(Jenkins.get().getExtensionList(OtelTraceService.class))
47 | .filter(list -> list.size()>0)
48 | .map(list -> list.get(0))
49 | .map(otelTraceServices -> otelTraceServices.getSpan(run))
50 | .map(Span::makeCurrent)
51 | .map(AutoCloseable.class::cast)
52 | .orElseGet(OtelUtils::noop);
53 | }
54 |
55 | @NonNull
56 | public static AutoCloseable noop() {
57 | return () -> {
58 | };
59 | }
60 |
61 | @NonNull
62 | public static boolean isOpenTelemetryAvailable() {
63 | return Optional.ofNullable(Jenkins.get().getPlugin("opentelemetry"))
64 | .map(Plugin::getWrapper)
65 | .map(PluginWrapper::isActive)
66 | .orElse(false);
67 | }
68 |
69 | @NonNull
70 | private static String genTraceParent(Span span) {
71 | return TRACE_PARENT_VERSION + "-" + span.getSpanContext().getTraceId() + "-" + span.getSpanContext().getSpanId() + "-" + TRACE_PARENT_TRACE_FLAG;
72 | }
73 |
74 |
75 | }
76 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/utils/RestUtils.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.utils;
2 |
3 | import java.io.IOException;
4 | import java.util.logging.Logger;
5 |
6 | import org.jenkinsci.plugins.ParameterizedRemoteTrigger.BuildContext;
7 | import org.jenkinsci.plugins.ParameterizedRemoteTrigger.ConnectionResponse;
8 | import org.jenkinsci.plugins.ParameterizedRemoteTrigger.RemoteBuildConfiguration;
9 | import org.jenkinsci.plugins.ParameterizedRemoteTrigger.exceptions.ExceedRetryLimitException;
10 | import org.jenkinsci.plugins.ParameterizedRemoteTrigger.pipeline.Handle;
11 | import org.jenkinsci.plugins.ParameterizedRemoteTrigger.remoteJob.RemoteBuildInfo;
12 | import org.jenkinsci.plugins.ParameterizedRemoteTrigger.remoteJob.RemoteBuildStatus;
13 |
14 | /*
15 | * Going to migrate all rest APIs to here
16 | * */
17 | public class RestUtils {
18 |
19 | private static Logger logger = Logger.getLogger(RestUtils.class.getName());
20 |
21 | public static ConnectionResponse cancelQueueItem(String rootUrl, Handle handle, BuildContext context,
22 | RemoteBuildConfiguration remoteConfig) throws IOException, InterruptedException {
23 |
24 | String cancelQueueUrl = String.format("%s/queue/cancelItem?id=%s", rootUrl, handle.getQueueId());
25 | ConnectionResponse resp = null;
26 | try {
27 | resp = HttpHelper.tryPost(cancelQueueUrl, context, null, remoteConfig.getHttpPostReadTimeout(),
28 | remoteConfig.getPollInterval(RemoteBuildStatus.QUEUED) * 2, 0,
29 | remoteConfig.getAuth2(), remoteConfig.getLock(cancelQueueUrl), remoteConfig.isUseCrumbCache());
30 | } catch (ExceedRetryLimitException e) {
31 | // Due to https://issues.jenkins-ci.org/browse/JENKINS-21311, we can't tell
32 | // whether the action was succeed,
33 | // Only try once and treat it as success
34 | logger.warning("Canceled queue item and not sure if it was succeed");
35 | }
36 | context.logger.println(String.format("Remote Queued Items:%s was canceled!", handle.getQueueId()));
37 | return resp;
38 | }
39 |
40 | public static ConnectionResponse stopRemoteJob(Handle handle, BuildContext context,
41 | RemoteBuildConfiguration remoteConfig) throws IOException, InterruptedException {
42 |
43 | RemoteBuildInfo buildInfo = handle.getBuildInfo();
44 | String stopJobUrl = String.format("%sstop", buildInfo.getBuildURL());
45 | ConnectionResponse resp = HttpHelper.tryPost(stopJobUrl, context, null, remoteConfig.getHttpPostReadTimeout(),
46 | remoteConfig.getPollInterval(buildInfo.getStatus()), remoteConfig.getConnectionRetryLimit(),
47 | remoteConfig.getAuth2(), remoteConfig.getLock(stopJobUrl), remoteConfig.isUseCrumbCache());
48 | context.logger.println(String.format("Remote Job:%s was aborted!", buildInfo.getBuildURL()));
49 | return resp;
50 | }
51 |
52 | }
53 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/utils/StringTools.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.utils;
2 |
3 | public class StringTools
4 | {
5 |
6 | /**
7 | * System specific new line character/string
8 | */
9 | public static final String NL = getSystemLineSeparator();
10 |
11 | /**
12 | * Unix/Linux specific new line character '\n'
13 | */
14 | public static final String NL_UNIX = "\n";
15 |
16 | private static String getSystemLineSeparator() {
17 | String newLine = System.getProperty("line.separator");
18 | if(newLine == null || newLine.length() <= 0) newLine = "\n";
19 | return newLine;
20 | }
21 |
22 | }
23 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/plugins/ParameterizedRemoteTrigger/utils/TokenMacroUtils.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.plugins.ParameterizedRemoteTrigger.utils;
2 |
3 | import java.io.IOException;
4 | import java.util.LinkedHashMap;
5 | import java.util.Map;
6 |
7 | import org.jenkinsci.plugins.ParameterizedRemoteTrigger.BasicBuildContext;
8 | import org.jenkinsci.plugins.tokenmacro.MacroEvaluationException;
9 | import org.jenkinsci.plugins.tokenmacro.TokenMacro;
10 |
11 | public class TokenMacroUtils {
12 |
13 | public static String applyTokenMacroReplacements(String input, BasicBuildContext context) throws IOException {
14 | try {
15 | if (isUseTokenMacro(context)) {
16 | return TokenMacro.expandAll(context.run, context.workspace, context.listener, input);
17 | }
18 | } catch (MacroEvaluationException e) {
19 | throw new IOException(e);
20 | } catch (InterruptedException e) {
21 | throw new IOException(e);
22 | }
23 | return input;
24 | }
25 |
26 | public static Map applyTokenMacroReplacements(Map input, BasicBuildContext context)
27 | throws IOException {
28 |
29 | Map output = new LinkedHashMap<>();
30 | for (Map.Entry entry : input.entrySet()) {
31 | output.put(entry.getKey(), applyTokenMacroReplacements(entry.getValue(), context));
32 | }
33 | return output;
34 | }
35 |
36 | public static boolean isUseTokenMacro(BasicBuildContext context) {
37 | return context != null && context.run != null && context.workspace != null && context.listener != null;
38 | }
39 |
40 | }
41 |
--------------------------------------------------------------------------------
/src/main/resources/index.jelly:
--------------------------------------------------------------------------------
1 |
2 |
3 | This plugin triggers a job on a remote Jenkins host
4 |
5 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/Auth/config.jelly:
--------------------------------------------------------------------------------
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 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/RemoteBuildConfiguration/config.jelly:
--------------------------------------------------------------------------------
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 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/RemoteBuildConfiguration/global.jelly:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/RemoteBuildConfiguration/help-auth2.html:
--------------------------------------------------------------------------------
1 |
2 | Using this parameter you can override the authentication used to connect to the selected remote Jenkins.
3 |
4 | - Don't Override
5 | The authentication configured in the (global) settings of the selected 'remote host' is used.
6 |
7 | - Token Authentication
8 | The specified user id and Jenkins API token is used.
9 |
10 | - Credentials Authentication
11 | The specified Jenkins Credentials are used. This can be either user/password or user/API Token.
12 |
13 | - No Authentication
14 | No Authorization header will be sent, independent of the global 'remote host' settings.
15 |
16 | - Bearer Authentication
17 | The bearer token is used.
18 |
19 |
20 |
21 |
Note: Jenkins API Tokens are recommended since, if stolen, they allow access only to a specific Jenkins
22 | while user and password typically provide access to many systems.
23 |
24 |
2 | Set this field to disable the job step instead of removing it from job configuration.
3 |
4 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/RemoteBuildConfiguration/help-enhancedLogging.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Enable Enhanced Logging
4 |
5 | If this option is enabled, the console output of the remote job is also logged.
6 |
2 |
3 | Remote Job Name or full URL.
4 |
5 | The name or URL of the job on the remote Jenkins host which you would like to trigger. If the full job URL is specified the URL of the remote Jenkins host configured above will be ignored.
6 |
2 | The max concurrent connections to the remote host, default is 1, max is 5. It'll be 5 even if you set it greater than 5.
3 | Note: Set this field with caution, too many concurrent requests will not only fail your local jobs,
4 | but also block the remote server.
5 |
6 |
7 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/RemoteBuildConfiguration/help-parameters2.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Job Parameters
4 |
5 | Parameters which will be used when triggering the remote job.
6 |
7 | If no parameters are needed, then just leave this blank.
8 |
9 | - Map parameters
10 | This is the recommended type. It allows you to provide parameters with key/value and supports multi-line parameters.
11 |
12 | - String parameters (legacy)
13 | This type allows to describe parameters within a big string like in versions 3.1.5 and lower. It does not support multi-line parameters.
14 |
15 | - File parameters (legacy)
16 | This type allows to describe parameters within a file like in versions 3.1.5 and lower. It does not support multi-line parameters.
17 |
18 |
19 |
2 | It is possible to override the Remote Jenkins URL for each Job separately.
3 |
4 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/RemoteBuildConfiguration/help-shouldNotFailBuild.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Do Not Fail If Remote Fails
4 |
5 | If this option is enabled, the build will not fail even if the remote build fails.
6 |
2 |
3 | Remote Job Token
4 |
5 | Security token which is defined on the job of the remote Jenkins host.
6 |
7 | If no job token is needed to trigger this job, then just leave it blank
8 |
2 |
3 | Trust all certificates
4 |
5 |
6 |
7 | It is possible to override/rewrite the 'Trust all certificate'-setting for each Job separately.
8 | Setting this checkbox to 'true' will result in accepting all certificates for the given Job.
9 |
10 |
11 |
12 | If your remote Jenkins host has a
13 |
14 | self-signed certificate
15 |
16 | or its certificate is not trusted, you may want to enable this option.
17 | It will accept untrusted certificates for the given host.
18 |
19 |
20 |
This is unsafe and should only be used for testing or if you trust the host.
21 |
2 | Set this field to enable cache of the crumb of remote server.
3 | It'll be more efficient for the local job execution & more stable for remote server when massive concurrent jobs are triggered.
4 | This cache will be cleared every 10 minutes.
5 |
6 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/RemoteBuildConfiguration/help-useJobInfoCache.html:
--------------------------------------------------------------------------------
1 |
2 | Set this field to enable cache of the job info of remote server.
3 | It'll be more efficient for the local job execution & more stable for remote server when massive concurrent jobs are triggered.
4 | This cache will be cleared every 10 minutes.
5 |
6 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/RemoteJenkinsServer/config.jelly:
--------------------------------------------------------------------------------
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 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/RemoteJenkinsServer/help-address.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Remote Jenkins Address
4 |
5 | Address (and optional port number) for the remote Jenkins host.
6 |
7 | i.e.: http://project.myserver.com:8888/jenkins
8 |
9 | Please note that the protocol (http, https, etc) is also required. Otherwise, the validation will fail.
10 |
2 |
3 | API Token
4 |
5 | This API token from the remote host that will be used for authentication.
6 |
7 | See the
8 | Jenkins wiki
9 |
10 | for more details.
11 |
2 | Using this parameter you can configure the authentication used to connect to the selected remote Jenkins.
3 |
4 | - No Authentication
5 | No Authorization header will be sent.
6 |
7 | - Token Authentication
8 | The specified user id and Jenkins API token is used.
9 |
10 | - Credentials Authentication
11 | The specified Jenkins Credentials are used. This can be either user/password or user/API Token.
12 |
13 | - Bearer Authentication
14 | The bearer token is used.
15 |
16 |
17 |
18 |
Note: Jenkins API Tokens are recommended since, if stolen, they allow access only to a specific Jenkins
19 | while user and password typically provide access to many systems.
20 |
21 |
2 |
3 | Display Name
4 |
5 | If a name is given, this will be visible when configuring your job.
6 |
7 | If none is given, the entered address will be displayed instead
8 |
2 |
3 | Trust all certificates
4 |
5 |
6 |
7 | If your remote Jenkins host has a
8 |
9 | self-signed certificate
10 |
11 | or its certificate is not trusted, you may want to enable this option.
12 | It will accept untrusted certificates for the given host.
13 |
14 |
15 |
This is unsafe and should only be used for testing or if you trust the host.
16 |
2 |
3 | Remote Username
4 |
5 | The username that will be utilized when opening a connection to the remote host.
6 |
2 | The name of the remote Jenkins as configured in the Jenkins global configuration (Manage Jenkins > Configure System > Parameterized Remote Trigger Configuration > Remote Hosts).
3 |
4 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/auth2/BearerTokenAuth/config.jelly:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/auth2/CredentialsAuth/config.jelly:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/auth2/TokenAuth/config.jelly:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/parameters2/FileParameters/config.jelly:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/parameters2/MapParameter/config.jelly:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/parameters2/MapParameters/config.jelly:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/parameters2/StringParameters/config.jelly:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/pipeline/RemoteBuildPipelineStep/config.jelly:
--------------------------------------------------------------------------------
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 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/pipeline/RemoteBuildPipelineStep/help-auth.html:
--------------------------------------------------------------------------------
1 |
2 | Using this parameter you can override the authentication used to connect to the selected remote Jenkins.
3 |
4 | - Don't Override
5 | The authentication configured in the (global) settings of the selected 'remote host' is used.
6 |
7 | - Token Authentication
8 | The specified user id and Jenkins API token is used.
9 |
10 | - Credentials Authentication
11 | The specified Jenkins Credentials are used. This can be either user/password or user/API Token.
12 |
13 | - No Authentication
14 | No Authorization header will be sent, independent of the global 'remote host' settings.
15 |
16 |
17 |
18 |
Note: Jenkins API Tokens are recommended since, if stolen, they allow access only to a specific Jenkins
19 | while user and password typically provide access to many systems.
20 |
21 |
2 |
3 | Wait/Block Until Remote Build Complete
4 |
5 | If enabled the remote job is called synchronously and the plugin waits until the remote job finished.
6 | If disabled the plugin triggers the remote job and returns.
7 |
8 | In both cases a
handle is returned for further tracking the remote job or getting the results (see plugin main help page).
9 |
10 | mandatory: no
11 | default: true
12 |
13 |
2 | Set this field to disable the job step instead of removing it from job configuration.
3 |
4 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/pipeline/RemoteBuildPipelineStep/help-enhancedLogging.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Enable Enhanced Logging
4 |
5 | If this option is enabled, the console output of the remote job is also logged.
6 |
7 | mandatory: no
8 | default: false
9 |
10 |
2 |
3 | Remote Job Name or full URL.
4 |
5 | The name or URL of the job on the remote Jenkins host which you would like to trigger. If the full job URL is specified the URL of the remote Jenkins host configured above will be ignored.
6 |
7 | mandatory: yes
8 |
9 |
2 | The max concurrent connections to the remote host, default is 1, max is 5. It'll be 5 even if you set it greater than 5.
3 | Note: Set this field with caution, too many concurrent requests will not only fail your local jobs,
4 | but also block the remote server.
5 |
6 |
7 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/pipeline/RemoteBuildPipelineStep/help-parameters.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Job Parameters
4 |
5 | Parameters which will be used when triggering the remote job.
6 |
7 | If no parameters are needed, then just leave this blank.
8 |
9 | In case of a String, the plugin uses String/File parameters depending on the parameter's content.
10 |
11 |
12 | - Map parameters
13 | Map<String, Object>
14 | This is the recommended type. It allows you to provide parameters with key/value and supports multi-line parameters.
15 |
16 | - String parameters (legacy)
17 | String
18 | This type allows to describe parameters within a big string like in versions 3.1.5 and lower. It does not support multi-line parameters.
19 |
20 | - File parameters (legacy)
21 | String
22 | This type allows to describe parameters within a file like in versions 3.1.5 and lower. It does not support multi-line parameters.
23 |
24 |
25 |
2 |
3 | Polling Interval
4 |
5 | The plugin identifies the status of the remote build by polling. Here you can specify how often the plugin shall poll the remote status.
6 | Be aware that polling too often might cause an increased load on the remote Jenkins.
7 |
8 | mandatory: no
9 | default: 10
10 |
11 |
2 |
3 | Prevent Remote Build Queue
4 |
5 | Wait to trigger remote builds until no other builds are running.
6 |
7 | mandatory: no
8 | default: false
9 |
10 |
2 |
3 | Remote Jenkins Name
4 |
5 | The name of the remote Jenkins as configured in the Jenkins global configuration (Manage Jenkins > Configure System > Parameterized Remote Trigger Configuration > Remote Hosts).
6 |
7 | mandatory: yes
8 |
9 |
2 | It is possible to override the Remote Jenkins URL for each Pipeline separately.
3 |
4 | mandatory: no
5 |
6 |
2 |
3 | Do Not Fail If Remote Fails
4 |
5 | If this option is enabled, the build will not fail even if the remote build fails.
6 |
7 | mandatory: no
8 | default: false
9 |
10 |
2 |
3 | Remote Job Token
4 |
5 | Security token which is defined on the job of the remote Jenkins host.
6 |
7 | If no job token is needed to trigger this job, then just leave it blank
8 |
9 | mandatory: no
10 | default: ""
11 |
12 |
2 |
3 | Trust all certificates
4 |
5 |
6 |
7 | It is possible to override/rewrite the 'Trust all certificate'-setting for each Job separately.
8 | Setting this checkbox to 'true' will result in accepting all certificates for the given Job.
9 |
10 |
11 |
12 | If your remote Jenkins host has a
13 |
14 | self-signed certificate
15 |
16 | or its certificate is not trusted, you may want to enable this option.
17 | It will accept untrusted certificates for the given host.
18 |
19 |
20 |
This is unsafe and should only be used for testing or if you trust the host.
21 |
2 | Set this field to enable cache of the crumb of remote server.
3 | It'll be more efficient for the local job execution & more stable for remote server when massive concurrent jobs are triggered.
4 | This cache will be cleared every 10 minutes.
5 |
6 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/pipeline/RemoteBuildPipelineStep/help-useJobInfoCache.html:
--------------------------------------------------------------------------------
1 |
2 | Set this field to enable cache of the job info of remote server.
3 | It'll be more efficient for the local job execution & more stable for remote server when massive concurrent jobs are triggered.
4 | This cache will be cleared every 10 minutes.
5 |
6 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/ParameterizedRemoteTrigger/pipeline/RemoteBuildPipelineStep/help.html:
--------------------------------------------------------------------------------
1 |
2 | The `triggerRemoteJob` pipeline step triggers a job on a remote Jenkins.
3 |
The full documentation is available in GitHub.
4 |
5 | Example:
6 |
7 | //Trigger remote job
8 | def handle = triggerRemoteJob(remoteJenkinsName: 'remoteJenkins', job: 'RemoteJob')
9 |
10 | //Get information from the handle
11 | def status = handle.getBuildStatus()
12 | def buildUrl = handle.getBuildUrl()
13 | echo buildUrl.toString() + " finished with " + status.toString()
14 |
15 | //Download and parse the archived "build-results.json" (if generated and archived by remote build)
16 | def results = handle.readJsonFileFromBuildArchive('build-results.json')
17 | echo results.urlToTestResults //only example
18 |
19 |
20 | //List other available methods
21 | echo handle.help()
22 |
23 |
24 |