extends StepExecution {
33 |
34 | @Getter
35 | private final transient TaskListener listener;
36 | @Getter
37 | private final transient Launcher launcher;
38 | private static ExecutorService executorService;
39 | @Getter
40 | private final BasicSSHStep step;
41 |
42 | private transient volatile Future task;
43 | private transient String threadName;
44 | private transient Throwable stopCause;
45 |
46 | protected SSHStepExecution(BasicSSHStep step, @NonNull StepContext context)
47 | throws IOException, InterruptedException {
48 | super(context);
49 | listener = context.get(TaskListener.class);
50 | launcher = context.get(Launcher.class);
51 | this.step = step;
52 | }
53 |
54 | static synchronized ExecutorService getExecutorService() {
55 | if (executorService == null) {
56 | executorService = Executors.newCachedThreadPool(
57 | new NamingThreadFactory(new ClassLoaderSanityThreadFactory(new DaemonThreadFactory()),
58 | "org.jenkinsci.plugins.ssh.util.SSHStepExecution"));
59 | }
60 | return executorService;
61 | }
62 |
63 | /**
64 | * Meat of the execution.
65 | *
66 | * When this method returns, a step execution is over.
67 | */
68 | protected abstract T run() throws Exception;
69 |
70 | protected VirtualChannel getChannel() {
71 | final VirtualChannel channel = getLauncher().getChannel();
72 | if (channel == null) {
73 | throw new IllegalArgumentException(
74 | "Unable to get the channel, Perhaps you forgot to surround the code with a step that provides this, such as: node, dockerNode");
75 | }
76 | return channel;
77 | }
78 |
79 | @Override
80 | public final boolean start() {
81 | Authentication auth = Jenkins.getAuthentication2();
82 | task = getExecutorService().submit(() -> {
83 | threadName = Thread.currentThread().getName();
84 | try {
85 | MDC.put("execution.id", UUID.randomUUID().toString());
86 | T ret;
87 | try (ACLContext acl = ACL.as2(auth)) {
88 | ret = run();
89 | }
90 | getContext().onSuccess(ret);
91 | } catch (Throwable x) {
92 | if (stopCause == null) {
93 | getContext().onFailure(x);
94 | } else {
95 | stopCause.addSuppressed(x);
96 | }
97 | } finally {
98 | MDC.clear();
99 | }
100 | });
101 | return false;
102 | }
103 |
104 | /**
105 | * If the computation is going synchronously, try to cancel that.
106 | */
107 | @Override
108 | public void stop(@NonNull Throwable cause) throws Exception {
109 | if (task != null) {
110 | stopCause = cause;
111 | task.cancel(true);
112 | }
113 | super.stop(cause);
114 | }
115 |
116 | @Override
117 | public void onResume() {
118 | getContext().onFailure(
119 | new Exception("Resume after a restart not supported for non-blocking synchronous steps"));
120 | }
121 |
122 | @Override
123 | public @NonNull
124 | String getStatus() {
125 | if (threadName != null) {
126 | return "running in thread: " + threadName;
127 | } else {
128 | return "not yet scheduled";
129 | }
130 | }
131 |
132 | }
133 |
--------------------------------------------------------------------------------
/src/main/resources/index.jelly:
--------------------------------------------------------------------------------
1 |
2 |
3 | Jenkins pipeline steps which provides SSH facilities such as command execution or file transfer for continuous delivery.
4 |
5 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/sshsteps/steps/CommandStep/config.jelly:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | This is a special step. No snippet generation available. See inline help or docs on the README
8 | for more information.
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/sshsteps/steps/CommandStep/help.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Takes a remote (map) of settings and command to execute it on the remote node and
4 | returns output.
5 | See docs on the README for more information.
7 |
8 |
9 | def remote = [:]
10 | remote.name = 'test'
11 | remote.host = 'test.domain.com'
12 | remote.user = 'root'
13 | remote.password = 'password'
14 | remote.allowAnyHosts = true
15 | stage('Remote SSH') {
16 | sshCommand remote: remote, command: "ls -lrt"
17 | sshCommand remote: remote, command: "for i in {1..5}; do echo -n \"Loop \$i \"; date ; sleep 1; done"
18 | }
19 |
20 |
This is a special step. No snippet generation available. See inline help or docs on the README
8 | for more information.
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/sshsteps/steps/GetStep/help.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Takes a remote (map) of settings, local file/directory into to get the given
4 | file/directory from remote node.
5 | See docs on the README for more information.
7 |
8 |
9 | def remote = [:]
10 | remote.name = 'test'
11 | remote.host = 'test.domain.com'
12 | remote.user = 'root'
13 | remote.password = 'password'
14 | remote.allowAnyHosts = true
15 | stage('Remote SSH') {
16 | sshGet remote: remote, from: 'abc.sh', into: 'abc_get.sh', override: true
17 | }
18 |
19 |
This is a special step. No snippet generation available. See inline help or docs on the README
8 | for more information.
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/sshsteps/steps/PutStep/help.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Takes a remote (map) of settings, local file/directory from workspace and path to
4 | put this into remote node.
5 | See docs on the README for more information.
7 |
8 |
9 | def remote = [:]
10 | remote.name = 'test'
11 | remote.host = 'test.domain.com'
12 | remote.user = 'root'
13 | remote.password = 'password'
14 | remote.allowAnyHosts = true
15 | stage('Remote SSH') {
16 | writeFile file: 'abc.sh', text: 'ls -lrt'
17 | sshPut remote: remote, from: 'abc.sh', into: '.'
18 | }
19 |
20 |
This is a special step. No snippet generation available. See inline help or docs on the README
8 | for more information.
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/sshsteps/steps/RemoveStep/help.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Takes a remote (map) of settings and path (file/directory) to remove from remote
4 | node.
5 | See docs on the README for more information.
7 |
8 |
9 | def remote = [:]
10 | remote.name = 'test'
11 | remote.host = 'test.domain.com'
12 | remote.user = 'root'
13 | remote.password = 'password'
14 | remote.allowAnyHosts = true
15 | stage('Remote SSH') {
16 | sshRemove remote: remote, path: "abc.sh"
17 | }
18 |
19 |
This is a special step. No snippet generation available. See inline help or docs on the README
8 | for more information.
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/src/main/resources/org/jenkinsci/plugins/sshsteps/steps/ScriptStep/help.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Takes a remote (map) of settings and script a shell script file to execute it on the remote node
4 | and returns output.
5 | See docs on the README for more information.
7 |
8 |
9 | def remote = [:]
10 | remote.name = 'test'
11 | remote.host = 'test.domain.com'
12 | remote.user = 'root'
13 | remote.password = 'password'
14 | remote.allowAnyHosts = true
15 | stage('Remote SSH') {
16 | writeFile file: 'abc.sh', text: 'ls -lrt'
17 | sshScript remote: remote, script: "abc.sh"
18 | }
19 |
20 |