-
Notifications
You must be signed in to change notification settings - Fork 88
/
Shell.java
298 lines (276 loc) · 8.35 KB
/
Shell.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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
/*
* Copyright (c) 2014-2024, jcabi.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the jcabi.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.jcabi.ssh;
import com.jcabi.aspects.Immutable;
import com.jcabi.log.Logger;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
import java.util.logging.Level;
import lombok.EqualsAndHashCode;
import lombok.ToString;
import org.cactoos.io.DeadInput;
import org.cactoos.io.TeeOutputStream;
/**
* Shell.
*
* <p>This interface is implemented by {@link Ssh} class. In order to use
* it, just make an instance and call
* {@link #exec(String,InputStream,OutputStream,OutputStream)} exec()}:
*
* <pre> String hello = new Shell.Plain(
* new SSH(
* "ssh.example.com", 22,
* "yegor", "-----BEGIN RSA PRIVATE KEY-----..."
* )
* ).exec("echo 'Hello, world!'");</pre>
*
* @since 1.0
* @see <a href="http://www.yegor256.com/2014/09/02/java-ssh-client.html">article by Yegor Bugayenko</a>
*/
@Immutable
public interface Shell {
/**
* Execute and return exit code.
* @param command Command
* @param stdin Stdin (will be closed)
* @param stdout Stdout (will be closed)
* @param stderr Stderr (will be closed)
* @return Exit code
* @throws IOException If fails
* @checkstyle ParameterNumberCheck (5 line)
*/
int exec(String command, InputStream stdin,
OutputStream stdout, OutputStream stderr) throws IOException;
/**
* Fake shell for unit testing.
*
* <p>It doesn't do anything, but imitates the behavior of a real
* shell, returning the code and the output provided in the ctor.</p>
*
* @since 1.6
*/
@Immutable
@ToString
@EqualsAndHashCode(of = "code")
final class Fake implements Shell {
/**
* Exit code.
*/
private final int code;
/**
* Stdout to return.
*/
private final byte[] stdout;
/**
* Stderr to return.
*/
private final byte[] stderr;
/**
* Ctor.
*/
public Fake() {
this(0, "", "");
}
/**
* Ctor.
* @param exit Exit code to return
* @param out Stdout to return
* @param err Stderr to return
*/
public Fake(final int exit, final String out, final String err) {
this(exit, out.getBytes(), err.getBytes());
}
/**
* Ctor.
* @param exit Exit code to return
* @param out Stdout to return
* @param err Stderr to return
*/
public Fake(final int exit, final byte[] out, final byte[] err) {
this.code = exit;
this.stdout = out;
this.stderr = err;
}
// @checkstyle ParameterNumberCheck (5 line)
@Override
public int exec(final String command, final InputStream stdin,
final OutputStream sout, final OutputStream serr)
throws IOException {
while (true) {
if (stdin.read(new byte[2048]) < 0) {
break;
}
}
sout.write(this.stdout);
sout.close();
serr.write(this.stderr);
serr.close();
return this.code;
}
}
/**
* Safe run (throws if exit code is not zero).
*
* @since 0.1
*/
@Immutable
@ToString
@EqualsAndHashCode(of = "origin")
final class Safe implements Shell {
/**
* Original.
*/
private final transient Shell origin;
/**
* Ctor.
* @param shell Original shell
*/
public Safe(final Shell shell) {
this.origin = shell;
}
// @checkstyle ParameterNumberCheck (5 line)
@Override
public int exec(final String command, final InputStream stdin,
final OutputStream stdout, final OutputStream stderr)
throws IOException {
final int exit = this.origin.exec(command, stdin, stdout, stderr);
if (exit != 0) {
throw new IllegalArgumentException(
String.format("non-zero exit code #%d: %s", exit, command)
);
}
return exit;
}
}
/**
* Without input and output.
*
* @since 0.1
*/
@Immutable
@ToString
@EqualsAndHashCode(of = "origin")
final class Empty {
/**
* Original.
*/
private final transient Shell origin;
/**
* Ctor.
* @param shell Original shell
*/
public Empty(final Shell shell) {
this.origin = shell;
}
/**
* Just exec.
* @param cmd Command
* @return Exit code
* @throws IOException If fails
*/
public int exec(final String cmd) throws IOException {
return this.origin.exec(
cmd, new DeadInput().stream(),
Logger.stream(Level.INFO, this),
Logger.stream(Level.WARNING, this)
);
}
}
/**
* With output only.
*
* @since 0.1
*/
@Immutable
@ToString
@EqualsAndHashCode(of = "origin")
final class Plain {
/**
* Original.
*/
private final transient Shell origin;
/**
* Ctor.
* @param shell Original shell
*/
public Plain(final Shell shell) {
this.origin = shell;
}
/**
* Just exec.
* @param cmd Command
* @return Stdout
* @throws IOException If fails
*/
public String exec(final String cmd) throws IOException {
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
this.origin.exec(
cmd, new DeadInput().stream(),
baos, baos
);
return baos.toString(StandardCharsets.UTF_8.toString());
}
}
/**
* Verbose run.
*
* @since 0.1
*/
@Immutable
@ToString
@EqualsAndHashCode(of = "orgn")
final class Verbose implements Shell {
/**
* Original.
*/
private final transient Shell orgn;
/**
* Ctor.
* @param shell Original shell
*/
public Verbose(final Shell shell) {
this.orgn = shell;
}
// @checkstyle ParameterNumberCheck (5 line)
@Override
public int exec(final String command, final InputStream stdin,
final OutputStream stdout, final OutputStream stderr)
throws IOException {
return this.orgn.exec(
command, stdin,
new TeeOutputStream(stdout, Logger.stream(Level.INFO, this)),
new TeeOutputStream(stderr, Logger.stream(Level.WARNING, this))
);
}
}
}