forked from spring-projects/spring-boot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CliTester.java
211 lines (184 loc) · 6.88 KB
/
CliTester.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
/*
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.cli;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URI;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
import org.junit.jupiter.api.Assumptions;
import org.junit.jupiter.api.extension.AfterEachCallback;
import org.junit.jupiter.api.extension.BeforeEachCallback;
import org.junit.jupiter.api.extension.Extension;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.springframework.boot.cli.command.AbstractCommand;
import org.springframework.boot.cli.command.OptionParsingCommand;
import org.springframework.boot.cli.command.archive.JarCommand;
import org.springframework.boot.cli.command.grab.GrabCommand;
import org.springframework.boot.cli.command.run.RunCommand;
import org.springframework.boot.test.system.CapturedOutput;
import org.springframework.boot.testsupport.BuildOutput;
import org.springframework.util.FileCopyUtils;
import org.springframework.util.FileSystemUtils;
import org.springframework.util.StringUtils;
/**
* JUnit 5 {@link Extension} that can be used to invoke CLI commands.
*
* @author Phillip Webb
* @author Dave Syer
* @author Andy Wilkinson
*/
public class CliTester implements BeforeEachCallback, AfterEachCallback {
private final File temp;
private final BuildOutput buildOutput = new BuildOutput(getClass());
private final CapturedOutput output;
private String previousOutput = "";
private long timeout = TimeUnit.MINUTES.toMillis(6);
private final List<AbstractCommand> commands = new ArrayList<>();
private final String prefix;
private File serverPortFile;
public CliTester(String prefix, CapturedOutput output) {
this.prefix = prefix;
try {
this.temp = Files.createTempDirectory("cli-tester").toFile();
}
catch (IOException ex) {
throw new IllegalStateException("Failed to create temp directory");
}
this.output = output;
}
public void setTimeout(long timeout) {
this.timeout = timeout;
}
public String run(String... args) throws Exception {
List<String> updatedArgs = new ArrayList<>();
boolean classpathUpdated = false;
for (String arg : args) {
if (arg.startsWith("--classpath=")) {
arg = arg + ":" + this.buildOutput.getTestClassesLocation().getAbsolutePath();
arg = arg + ":" + this.buildOutput.getTestResourcesLocation().getAbsolutePath();
classpathUpdated = true;
}
updatedArgs.add(arg);
}
if (!classpathUpdated) {
updatedArgs.add("--classpath=.:" + this.buildOutput.getTestClassesLocation().getAbsolutePath() + ":"
+ this.buildOutput.getTestResourcesLocation().getAbsolutePath());
}
Future<RunCommand> future = submitCommand(new RunCommand(), StringUtils.toStringArray(updatedArgs));
this.commands.add(future.get(this.timeout, TimeUnit.MILLISECONDS));
return getOutput();
}
public String grab(String... args) throws Exception {
Future<GrabCommand> future = submitCommand(new GrabCommand(), args);
this.commands.add(future.get(this.timeout, TimeUnit.MILLISECONDS));
return getOutput();
}
public String jar(String... args) throws Exception {
Future<JarCommand> future = submitCommand(new JarCommand(), args);
this.commands.add(future.get(this.timeout, TimeUnit.MILLISECONDS));
return getOutput();
}
public File getTemp() {
return this.temp;
}
private <T extends OptionParsingCommand> Future<T> submitCommand(T command, String... args) {
final String[] sources = getSources(args);
return Executors.newSingleThreadExecutor().submit(() -> {
ClassLoader loader = Thread.currentThread().getContextClassLoader();
System.setProperty("server.port", "0");
System.setProperty("spring.application.class.name",
"org.springframework.boot.cli.CliTesterSpringApplication");
this.serverPortFile = new File(this.temp, "server.port");
System.setProperty("portfile", this.serverPortFile.getAbsolutePath());
String userHome = System.getProperty("user.home");
System.setProperty("user.home", "src/test/resources/cli-tester");
try {
command.run(sources);
return command;
}
finally {
System.clearProperty("server.port");
System.clearProperty("spring.application.class.name");
System.clearProperty("portfile");
System.setProperty("user.home", userHome);
Thread.currentThread().setContextClassLoader(loader);
}
});
}
protected String[] getSources(String... args) {
final String[] sources = new String[args.length];
for (int i = 0; i < args.length; i++) {
String arg = args[i];
if (!arg.endsWith(".groovy") && !arg.endsWith(".xml")) {
if (new File(this.prefix + arg).isDirectory()) {
sources[i] = this.prefix + arg;
}
else {
sources[i] = arg;
}
}
else {
sources[i] = new File(arg).isAbsolute() ? arg : this.prefix + arg;
}
}
return sources;
}
private String getOutput() {
String output = this.output.toString().substring(this.previousOutput.length());
this.previousOutput = output;
return output;
}
@Override
public void beforeEach(ExtensionContext extensionContext) {
Assumptions.assumeTrue(System.getProperty("spring.profiles.active", "integration").contains("integration"),
"Not running sample integration tests because integration profile not active");
System.setProperty("disableSpringSnapshotRepos", "false");
}
@Override
public void afterEach(ExtensionContext extensionContext) {
for (AbstractCommand command : this.commands) {
if (command != null && command instanceof RunCommand) {
((RunCommand) command).stop();
}
}
System.clearProperty("disableSpringSnapshotRepos");
FileSystemUtils.deleteRecursively(this.temp);
}
public String getHttpOutput() {
return getHttpOutput("/");
}
public String getHttpOutput(String uri) {
try {
int port = Integer.parseInt(FileCopyUtils.copyToString(new FileReader(this.serverPortFile)));
InputStream stream = URI.create("http://localhost:" + port + uri).toURL().openStream();
BufferedReader reader = new BufferedReader(new InputStreamReader(stream));
return reader.lines().collect(Collectors.joining());
}
catch (Exception ex) {
throw new IllegalStateException(ex);
}
}
}