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
|
package com.jetbrains.env;
import com.google.common.collect.Lists;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.testFramework.UsefulTestCase;
import com.intellij.util.SystemProperties;
import com.intellij.util.ui.UIUtil;
import com.jetbrains.python.fixtures.PyTestCase;
import org.hamcrest.Matchers;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.junit.Assume;
import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
/**
* @author traff
*/
public abstract class PyEnvTestCase extends UsefulTestCase {
private static final Logger LOG = Logger.getInstance(PyEnvTestCase.class.getName());
private static final String TAGS_FILE = "tags.txt";
private static final String PYCHARM_PYTHON_ENVS = "PYCHARM_PYTHON_ENVS";
private static final String PYCHARM_PYTHON_VIRTUAL_ENVS = "PYCHARM_PYTHON_VIRTUAL_ENVS";
protected static final boolean IS_ENV_CONFIGURATION = System.getProperty("pycharm.env") != null;
public static final boolean RUN_REMOTE = SystemProperties.getBooleanProperty("pycharm.run_remote", false);
public static final boolean RUN_LOCAL = SystemProperties.getBooleanProperty("pycharm.run_local", true);
/**
* Tags that should exist between all tags, available on all interpreters for test to run.
* See {@link #PyEnvTestCase(String...)}
*/
@Nullable
private final String[] myRequiredTags;
/**
* @param requiredTags tags that should exist on some interpreter for this test to run.
* if some of these tags do not exist on any interpreter, all test methods would be skipped using
* {@link org.junit.Assume}.
* See <a href="http://junit.sourceforge.net/javadoc/org/junit/Assume.html">Assume manual</a>.
* Check [IDEA-122939] and [TW-25043] as well.
*/
@SuppressWarnings("JUnitTestCaseWithNonTrivialConstructors")
protected PyEnvTestCase(@NotNull final String... requiredTags) {
myRequiredTags = requiredTags.length > 0 ? requiredTags.clone() : null;
PyTestCase.initPlatformPrefix();
}
@Override
public void setUp() throws Exception {
super.setUp();
if (myRequiredTags != null) { // Ensure all tags exist between available interpreters
Assume.assumeThat(
"Can't find some tags between all available interpreter, test (all methods) will be skipped",
getAvailableTags(),
Matchers.hasItems(myRequiredTags)
);
}
}
/**
* @return all tags available between all interpreters
*/
@NotNull
private static Collection<String> getAvailableTags() {
final Collection<String> allAvailableTags = new HashSet<String>();
for (final String pythonRoot : getPythonRoots()) {
allAvailableTags.addAll(loadEnvTags(pythonRoot));
}
return allAvailableTags;
}
@Override
protected void invokeTestRunnable(@NotNull final Runnable runnable) throws Exception {
if (runInWriteAction()) {
UIUtil.invokeAndWaitIfNeeded(new Runnable() {
public void run() {
ApplicationManager.getApplication().runWriteAction(runnable);
}
});
}
else {
runnable.run();
}
}
@Override
protected boolean runInDispatchThread() {
return false;
}
protected boolean runInWriteAction() {
return false;
}
public void runPythonTest(final PyTestTask testTask) {
runTest(testTask, getTestName(false));
}
public void runTest(@NotNull PyTestTask testTask, @NotNull String testName) {
if (notEnvConfiguration()) {
fail("Running under teamcity but not by Env configuration. Skipping.");
return;
}
List<String> roots = getPythonRoots();
if (roots.size() == 0) {
String msg = testName +
": environments are not defined. Skipping. \nSpecify either " +
PYCHARM_PYTHON_ENVS +
" or " +
PYCHARM_PYTHON_VIRTUAL_ENVS +
" environment variable.";
LOG.warn(msg);
System.out.println(msg);
return;
}
doRunTests(testTask, testName, roots);
}
protected void doRunTests(PyTestTask testTask, String testName, List<String> roots) {
if (RUN_LOCAL) {
PyEnvTaskRunner taskRunner = new PyEnvTaskRunner(roots);
taskRunner.runTask(testTask, testName);
}
}
public static boolean notEnvConfiguration() {
return UsefulTestCase.IS_UNDER_TEAMCITY && !IS_ENV_CONFIGURATION;
}
public static List<String> getPythonRoots() {
List<String> roots = Lists.newArrayList();
String envs = System.getenv(PYCHARM_PYTHON_ENVS);
if (envs != null) {
roots.addAll(Lists.newArrayList(envs.split(File.pathSeparator)));
}
String virtualEnvs = System.getenv(PYCHARM_PYTHON_VIRTUAL_ENVS);
if (virtualEnvs != null) {
roots.addAll(readVirtualEnvRoots(virtualEnvs));
}
return roots;
}
protected static List<String> readVirtualEnvRoots(@NotNull String envs) {
List<String> result = Lists.newArrayList();
String[] roots = envs.split(File.pathSeparator);
for (String root : roots) {
File virtualEnvRoot = new File(root);
File[] virtualenvs = virtualEnvRoot.listFiles();
if (virtualenvs != null) {
for (File f : virtualenvs) {
result.add(f.getAbsolutePath());
}
} else {
LOG.error(root + " is not a directory of doesn't exist");
}
}
return result;
}
public static List<String> loadEnvTags(String env) {
List<String> envTags;
try {
File parent = new File(env);
if (parent.isFile()) {
parent = parent.getParentFile();
}
envTags = com.intellij.openapi.util.io.FileUtil.loadLines(new File(parent, TAGS_FILE));
}
catch (IOException e) {
envTags = Lists.newArrayList();
}
return envTags;
}
public static String joinStrings(Collection<String> roots, String rootsName) {
return roots.size() > 0 ? rootsName + StringUtil.join(roots, ", ") + "\n" : "";
}
}
|
