Skip to content

Commit ad44cc7

Browse files
cstarnercstarner
authored
Merge pull request #2 from jenkinsci/dev
Fixes #1
2 parents 783d36b + e5c5f43 commit ad44cc7

File tree

5 files changed

+157
-22
lines changed

5 files changed

+157
-22
lines changed

‎pom.xml

+34-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@
1616
<jenkins.version>1.651.2</jenkins.version>
1717
<jenkins-test-harness.version>2.1</jenkins-test-harness.version>
1818
</properties>
19-
19+
<issueManagement>
20+
<system>GitHub</system>
21+
<url>https://github.com/jenkinsci/pyenv-pipeline-plugin/issues</url>
22+
</issueManagement>
2023
<name>Pyenv Pipeline Plugin</name>
2124
<description>Exposes a step in Jenkins Pipeline DSL for executing commands within a specified Python virtualenv</description>
2225
<url>https://wiki.jenkins.io/display/JENKINS/Pyenv+Pipeline+Plugin</url>
@@ -40,7 +43,7 @@
4043
<connection>scm:git:git://github.com/jenkinsci/pyenv-pipeline-plugin.git</connection>
4144
<developerConnection>scm:git:[email protected]:jenkinsci/pyenv-pipeline-plugin.git</developerConnection>
4245
<url>https://github.com/jenkinsci/pyenv-pipeline-plugin</url>
43-
<tag>pyenv-pipeline-1.0.0</tag>
46+
<tag>pyenv-pipeline-1.0.1</tag>
4447
</scm>
4548
<repositories>
4649
<repository>
@@ -53,6 +56,11 @@
5356
<id>repo.jenkins-ci.org</id>
5457
<url>https://repo.jenkins-ci.org/public/</url>
5558
</pluginRepository>
59+
<pluginRepository>
60+
<id>central</id>
61+
<name>Maven Plugin Repository</name>
62+
<url>http://repo1.maven.org/maven2</url>
63+
</pluginRepository>
5664
</pluginRepositories>
5765

5866
<dependencies>
@@ -96,5 +104,29 @@
96104
<version>2.24</version>
97105
<scope>test</scope>
98106
</dependency>
107+
<dependency>
108+
<groupId>junit</groupId>
109+
<artifactId>junit</artifactId>
110+
<version>4.12</version>
111+
<scope>test</scope>
112+
</dependency>
113+
<dependency>
114+
<groupId>org.powermock</groupId>
115+
<artifactId>powermock-module-junit4</artifactId>
116+
<version>1.6.3</version>
117+
<scope>test</scope>
118+
</dependency>
119+
<dependency>
120+
<groupId>org.powermock</groupId>
121+
<artifactId>powermock-api-mockito</artifactId>
122+
<version>1.6.3</version>
123+
<scope>test</scope>
124+
</dependency>
125+
<dependency>
126+
<groupId>org.mockito</groupId>
127+
<artifactId>mockito-all</artifactId>
128+
<version>1.10.19</version>
129+
<scope>test</scope>
130+
</dependency>
99131
</dependencies>
100132
</project>

‎src/main/java/com/github/pyenvpipeline/jenkins/steps/WithPythonEnvStep.java

+31-13
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,10 @@
4747
public class WithPythonEnvStep extends Step implements Serializable{
4848

4949
private static final Logger LOGGER = Logger.getLogger(WithPythonEnvStep.class.getName());
50-
private String pythonInstallation;
5150
private static final String DEFAULT_DIR_PREFIX = ".pyenv";
5251

52+
private String pythonInstallation;
53+
5354
@DataBoundConstructor
5455
public WithPythonEnvStep(String pythonInstallation){
5556
this.pythonInstallation = pythonInstallation;
@@ -77,7 +78,9 @@ public String getRelativePythonEnvDirectory(){
7778
return DEFAULT_DIR_PREFIX + postfix;
7879
}
7980

80-
private static class Execution extends StepExecution {
81+
protected static class Execution extends StepExecution {
82+
83+
private boolean usingShiningPanda;
8184

8285
public String getFullyQualifiedPythonEnvDirectoryName(StepContext stepContext, boolean isUnix, String relativeDir) throws Exception{
8386
EnvVars envVars = stepContext.get(EnvVars.class);
@@ -90,9 +93,9 @@ public String getFullyQualifiedPythonEnvDirectoryName(StepContext stepContext, b
9093
}
9194
}
9295

93-
private String getBaseToolDirectory() {
96+
private String getBaseToolDirectory(DescriptorExtensionList<ToolInstallation, ToolDescriptor<?>> descriptors) {
9497
List<String> validToolDescriptors = Arrays.asList(VALID_TOOL_DESCRIPTOR_IDS);
95-
for (ToolDescriptor<?> desc : ToolInstallation.all()) {
98+
for (ToolDescriptor<?> desc : descriptors) {
9699

97100
if (!validToolDescriptors.contains(desc.getId())) {
98101
LOGGER.info("Skipping ToolDescriptor: "+ desc.getId());
@@ -105,6 +108,7 @@ private String getBaseToolDirectory() {
105108
String notification = "Matched ShiningPanda tool name: " + installation.getName();
106109
logger().println(notification);
107110
LOGGER.info(notification);
111+
usingShiningPanda = true;
108112
return installation.getHome();
109113
} else {
110114
LOGGER.info("Skipping ToolInstallation: "+step.getPythonInstallation());
@@ -125,30 +129,44 @@ private<T extends ToolInstallation> T[] unboxToolInstallations(ToolDescriptor<T>
125129
protected Execution(final WithPythonEnvStep step, final StepContext context){
126130
super(context);
127131
this.step = step;
132+
usingShiningPanda = false;
128133
}
129134

130-
private void createPythonEnv(StepContext stepContext, boolean isUnix, String relativeDir) throws Exception{
131-
String fullQualifiedDirectoryName = getFullyQualifiedPythonEnvDirectoryName(stepContext, isUnix, relativeDir);
132-
String baseToolDirectory = getBaseToolDirectory();
135+
protected String getCommandPath(boolean isUnix, DescriptorExtensionList<ToolInstallation, ToolDescriptor<?>> descriptors) throws Exception {
133136

134-
LOGGER.info("Creating virtualenv at " + fullQualifiedDirectoryName + " using Python installation " +
135-
"found at " + baseToolDirectory);
137+
String baseToolDirectory = getBaseToolDirectory(descriptors);
136138

137-
String commandPath = "";
139+
String commandPath;
138140

139141
if (!baseToolDirectory.equals("")) {
140142

141143
// ShiningPanda returns actual Python instances for Linux, but only returns folders for Windows
142-
if (!isUnix) {
143-
commandPath = baseToolDirectory + "\\python";
144+
if (usingShiningPanda && !isUnix) {
145+
146+
if (!baseToolDirectory.endsWith("\\")) {
147+
baseToolDirectory += "\\";
148+
}
149+
150+
baseToolDirectory += "python";
144151
}
152+
153+
commandPath = baseToolDirectory;
154+
} else {
155+
commandPath = step.getPythonInstallation();
145156
}
146157

147158
if (!commandPath.contains("python")) {
148159
commandPath += "python";
149160
}
150161

151-
LOGGER.info("Using \"" + commandPath + "\" as python executable");
162+
return commandPath;
163+
}
164+
165+
private void createPythonEnv(StepContext stepContext, boolean isUnix, String relativeDir) throws Exception{
166+
String fullQualifiedDirectoryName = getFullyQualifiedPythonEnvDirectoryName(stepContext, isUnix, relativeDir);
167+
String commandPath = getCommandPath(isUnix, ToolInstallation.all());
168+
LOGGER.info("Creating virtualenv at " + fullQualifiedDirectoryName + " using Python installation " +
169+
"found at " + commandPath);
152170

153171
ArgumentListBuilder command = new ArgumentListBuilder();
154172

‎src/test/java/com/github/pyenvpipeline/jenkins/steps/WithPythonEnvGetCommandPathTest.java

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
package com.github.pyenvpipeline.jenkins.steps;
2+
3+
import hudson.DescriptorExtensionList;
4+
import hudson.model.TaskListener;
5+
import hudson.tools.ToolDescriptor;
6+
import hudson.tools.ToolInstallation;
7+
import jenkins.plugins.shiningpanda.tools.PythonInstallation;
8+
import org.jenkinsci.plugins.workflow.steps.StepContext;
9+
import org.junit.Assert;
10+
import org.junit.Before;
11+
import org.junit.Rule;
12+
import org.junit.Test;
13+
import org.junit.runner.RunWith;
14+
import org.jvnet.hudson.test.JenkinsRule;
15+
import org.mockito.Mock;
16+
import org.powermock.api.mockito.PowerMockito;
17+
import org.powermock.core.classloader.annotations.PowerMockIgnore;
18+
import org.powermock.modules.junit4.PowerMockRunner;
19+
20+
import java.io.PrintStream;
21+
22+
@RunWith(PowerMockRunner.class)
23+
@PowerMockIgnore({"javax.crypto.*" })
24+
public class WithPythonEnvGetCommandPathTest {
25+
26+
@Mock
27+
StepContext mockStepContext;
28+
29+
@Mock
30+
TaskListener mockTaskListener;
31+
32+
@Mock
33+
PrintStream mockPrintStream;
34+
35+
@Rule
36+
public JenkinsRule j = new JenkinsRule();
37+
38+
@Before
39+
public void setUp() throws Exception {
40+
PowerMockito.when(mockStepContext.get(TaskListener.class)).thenReturn(mockTaskListener);
41+
PowerMockito.when(mockTaskListener.getLogger()).thenReturn(mockPrintStream);
42+
}
43+
44+
@Test
45+
public void testGetCommandPath() throws Exception {
46+
47+
// Here we mock the ShiningPanda installations. For these, we need a StepContext that actually "works".
48+
49+
PythonInstallation.DescriptorImpl descriptor = j.jenkins.getDescriptorByType(PythonInstallation.DescriptorImpl.class);
50+
PythonInstallation linuxInstallation = new PythonInstallation("CPython-2.7-Unix", "/usr/bin/python27", null);
51+
PythonInstallation windowsInstallation = new PythonInstallation("CPython-2.7-Windows", "C:\\Python27\\", null);
52+
53+
// This crashes when it tries to persist the new installations to file. We swallow the exception and move on
54+
try {
55+
descriptor.setInstallations(linuxInstallation, windowsInstallation);
56+
} catch (Exception e) {
57+
58+
}
59+
60+
DescriptorExtensionList<ToolInstallation, ToolDescriptor<?>> list =
61+
DescriptorExtensionList.createDescriptorList(j.jenkins, ToolInstallation.class);
62+
list.add(descriptor);
63+
64+
WithPythonEnvStep pathExecutable = new WithPythonEnvStep("python3");
65+
66+
WithPythonEnvStep.Execution execution =
67+
new WithPythonEnvStep.Execution(pathExecutable, null);
68+
Assert.assertEquals("python3", execution.getCommandPath(true, list));
69+
70+
WithPythonEnvStep linuxLiteralLocation = new WithPythonEnvStep("/usr/bin/python2.7");
71+
execution = new WithPythonEnvStep.Execution(linuxLiteralLocation, null);
72+
Assert.assertEquals("/usr/bin/python2.7", execution.getCommandPath(true, list));
73+
74+
WithPythonEnvStep windowsLiteralLocation = new WithPythonEnvStep("C:\\Python34\\python");
75+
execution = new WithPythonEnvStep.Execution(windowsLiteralLocation, null);
76+
Assert.assertEquals("C:\\Python34\\python", execution.getCommandPath(false, list));
77+
78+
// Linux ShiningPanda named plugin
79+
WithPythonEnvStep linuxShiningPanda = new WithPythonEnvStep("CPython-2.7-Unix");
80+
execution = new WithPythonEnvStep.Execution(linuxShiningPanda, mockStepContext);
81+
Assert.assertEquals("/usr/bin/python27", execution.getCommandPath(true, list));
82+
83+
WithPythonEnvStep windowsShiningPanda = new WithPythonEnvStep("CPython-2.7-Windows");
84+
execution = new WithPythonEnvStep.Execution(windowsShiningPanda, mockStepContext);
85+
// Here we assure that a ShiningPanda tool on a Windows system automatically appends the executable name at the
86+
// end
87+
Assert.assertEquals("C:\\Python27\\python", execution.getCommandPath(false, list));
88+
}
89+
}

‎src/test/java/com/github/pyenvpipeline/jenkins/steps/WithPythonEnvStepIntegrationTest.java

+3-6
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,9 @@
3838
import org.junit.Test;
3939
import org.jvnet.hudson.test.JenkinsRule;
4040
import org.jvnet.hudson.test.LoggerRule;
41-
42-
import java.awt.*;
4341
import java.util.List;
4442
import java.util.logging.Level;
4543
import java.util.regex.Pattern;
46-
4744
import static org.junit.Assert.assertTrue;
4845

4946
public class WithPythonEnvStepIntegrationTest {
@@ -74,11 +71,11 @@ private String formatOSSpecificNodeScipts(String osAgnosticScript) {
7471
public void shouldSetEnvVar() throws Exception {
7572
// We only test the relative dir name here, since we can't easily predict the full directory name
7673
WorkflowJob job = j.jenkins.createProject(WorkflowJob.class, "p");
77-
job.setDefinition(new CpsFlowDefinition("node { withPythonEnv('python3') { echo \"current virtualenv " +
74+
job.setDefinition(new CpsFlowDefinition("node { withPythonEnv('python') { echo \"current virtualenv " +
7875
"relative dir: ${" + PyEnvConstants.VIRTUALENV_RELATIVE_DIRECTORY_NAME_ENV_VAR_KEY + "}\" } }",
7976
true));
8077
WorkflowRun run = j.assertBuildStatusSuccess(job.scheduleBuild2(0));
81-
j.assertLogContains("current virtualenv relative dir: .pyenv-python3", run);
78+
j.assertLogContains("current virtualenv relative dir: .pyenv-python", run);
8279
}
8380

8481
private PythonInstallation findSinglePythonInstallation(ToolDescriptor descriptor) throws Exception {
@@ -163,7 +160,7 @@ public void shouldUseShiningPanda() throws Exception {
163160
// system (i.e. findable via the PythonFinder class provided by the ShiningPanda plugin).
164161
PythonInstallation installation = findFirstPythonInstallation();
165162

166-
String workflowScript = "node { withPythonEnv('python3') { echo \"current virtualenv relative dir: ${" +
163+
String workflowScript = "node { withPythonEnv('python') { echo \"current virtualenv relative dir: ${" +
167164
PyEnvConstants.VIRTUALENV_RELATIVE_DIRECTORY_NAME_ENV_VAR_KEY + "}\" }";
168165

169166
if (installation!=null) {

‎src/test/java/com/github/pyenvpipeline/jenkins/steps/WithPythonEnvTest.java

-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
*/
2525

2626
package com.github.pyenvpipeline.jenkins.steps;
27-
2827
import org.junit.Assert;
2928
import org.junit.Test;
3029

0 commit comments

Comments
 (0)