Skip to content

Commit 1c78933

Browse files
jonesbusyjonesbusy
authored
Merge pull request #76 from jonesbusy/bugfix/fix-pipeline-extra-vars
Regression: Fix extra vars in pipeline and add minimal pipeline tests
2 parents a008a4b + 5ab5c88 commit 1c78933

File tree

6 files changed

+188
-5
lines changed

6 files changed

+188
-5
lines changed

‎pom.xml

+27-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<properties>
2222
<changelist>999999-SNAPSHOT</changelist>
2323
<gitHubRepo>jenkinsci/ansible-plugin</gitHubRepo>
24-
<jenkins.version>2.387.2</jenkins.version>
24+
<jenkins.version>2.387.3</jenkins.version>
2525
</properties>
2626
<licenses>
2727
<license>
@@ -81,6 +81,32 @@
8181
<artifactId>mockito-core</artifactId>
8282
<scope>test</scope>
8383
</dependency>
84+
<!-- Test plugins -->
85+
<dependency>
86+
<groupId>org.jenkins-ci.plugins.workflow</groupId>
87+
<artifactId>workflow-job</artifactId>
88+
<scope>test</scope>
89+
</dependency>
90+
<dependency>
91+
<groupId>org.jenkins-ci.plugins.workflow</groupId>
92+
<artifactId>workflow-cps</artifactId>
93+
<scope>test</scope>
94+
</dependency>
95+
<dependency>
96+
<groupId>org.jenkins-ci.plugins</groupId>
97+
<artifactId>pipeline-utility-steps</artifactId>
98+
<scope>test</scope>
99+
</dependency>
100+
<dependency>
101+
<groupId>org.jenkins-ci.plugins.workflow</groupId>
102+
<artifactId>workflow-basic-steps</artifactId>
103+
<scope>test</scope>
104+
</dependency>
105+
<dependency>
106+
<groupId>org.jenkinsci.plugins</groupId>
107+
<artifactId>pipeline-model-definition</artifactId>
108+
<scope>test</scope>
109+
</dependency>
84110
</dependencies>
85111
<repositories>
86112
<repository>

‎src/main/java/org/jenkinsci/plugins/ansible/workflow/AnsiblePlaybookStep.java

+9-4
Original file line numberDiff line numberDiff line change
@@ -378,17 +378,22 @@ private List<ExtraVar> convertExtraVars(Map<String, Object> extraVars) {
378378
if (extraVars == null) {
379379
return null;
380380
}
381-
List<ExtraVar> extraVarList = new ArrayList<ExtraVar>();
381+
List<ExtraVar> extraVarList = new ArrayList<>();
382382
for (Map.Entry<String, Object> entry: extraVars.entrySet()) {
383383
ExtraVar var = new ExtraVar();
384384
var.setKey(entry.getKey());
385385
Object o = entry.getValue();
386386
if (o instanceof Map) {
387-
var.setSecretValue((Secret)((Map)o).get("value"));
387+
var.setSecretValue(Secret.fromString((String)((Map)o).get("value")));
388388
var.setHidden((Boolean)((Map)o).get("hidden"));
389-
} else {
389+
}
390+
else if (o instanceof String) {
391+
var.setSecretValue(Secret.fromString((String)o));
392+
var.setHidden(true);
393+
}
394+
else if (o instanceof Secret) {
390395
var.setSecretValue((Secret)o);
391-
var.setHidden(false);
396+
var.setHidden(true);
392397
}
393398
extraVarList.add(var);
394399
}

‎src/test/java/org/jenkinsci/plugins/ansible/PipelineTest.java

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
package org.jenkinsci.plugins.ansible;
2+
3+
import java.nio.charset.StandardCharsets;
4+
import org.apache.commons.io.IOUtils;
5+
import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
6+
import org.jenkinsci.plugins.workflow.job.WorkflowJob;
7+
import org.jenkinsci.plugins.workflow.job.WorkflowRun;
8+
import org.junit.BeforeClass;
9+
import org.junit.ClassRule;
10+
import org.junit.Test;
11+
import org.jvnet.hudson.test.JenkinsRule;
12+
13+
import hudson.model.Label;
14+
import hudson.slaves.DumbSlave;
15+
16+
import static org.hamcrest.MatcherAssert.assertThat;
17+
import static org.hamcrest.Matchers.*;
18+
19+
public class PipelineTest {
20+
21+
@ClassRule
22+
public static JenkinsRule jenkins = new JenkinsRule();
23+
24+
private static DumbSlave agent;
25+
26+
@BeforeClass
27+
public static void startAgent() throws Exception {
28+
agent = jenkins.createSlave(Label.get("test-agent"));
29+
}
30+
31+
@Test
32+
public void testMinimalPipeline() throws Exception {
33+
String pipeline = IOUtils.toString(PipelineTest.class.getResourceAsStream("/pipelines/minimal.groovy"), StandardCharsets.UTF_8);
34+
WorkflowJob workflowJob = jenkins.createProject(WorkflowJob.class);
35+
workflowJob.setDefinition(new CpsFlowDefinition(pipeline, true));
36+
WorkflowRun run1 = workflowJob.scheduleBuild2(0).waitForStart();
37+
jenkins.waitForCompletion(run1);
38+
assertThat(run1.getLog(), allOf(
39+
containsString("ansible-playbook playbook.yml")
40+
));
41+
}
42+
43+
@Test
44+
public void testExtraVarsHiddenString() throws Exception {
45+
String pipeline = IOUtils.toString(PipelineTest.class.getResourceAsStream("/pipelines/extraVarsHiddenString.groovy"), StandardCharsets.UTF_8);
46+
WorkflowJob workflowJob = jenkins.createProject(WorkflowJob.class);
47+
workflowJob.setDefinition(new CpsFlowDefinition(pipeline, true));
48+
WorkflowRun run1 = workflowJob.scheduleBuild2(0).waitForStart();
49+
jenkins.waitForCompletion(run1);
50+
assertThat(run1.getLog(), allOf(
51+
containsString("ansible-playbook playbook.yml -e ********")
52+
));
53+
}
54+
55+
@Test
56+
public void testExtraVarsMap() throws Exception {
57+
String pipeline = IOUtils.toString(PipelineTest.class.getResourceAsStream("/pipelines/extraVarsMap.groovy"), StandardCharsets.UTF_8);
58+
WorkflowJob workflowJob = jenkins.createProject(WorkflowJob.class);
59+
workflowJob.setDefinition(new CpsFlowDefinition(pipeline, true));
60+
WorkflowRun run1 = workflowJob.scheduleBuild2(0).waitForStart();
61+
jenkins.waitForCompletion(run1);
62+
assertThat(run1.getLog(), allOf(
63+
containsString("ansible-playbook playbook.yml -e foo1=bar1"),
64+
containsString("ansible-playbook playbook.yml -e ********")
65+
));
66+
}
67+
68+
}

‎src/test/resources/pipelines/extraVarsHiddenString.groovy

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
pipeline {
2+
agent {
3+
label('test-agent')
4+
}
5+
stages {
6+
stage('Create playbook') {
7+
steps {
8+
writeFile(encoding: 'UTF-8', file: 'playbook.yml', text: '''- hosts: localhost
9+
connection: local
10+
gather_facts: no
11+
tasks:
12+
- debug: msg=test
13+
''')
14+
}
15+
}
16+
stage('Ansible playbook') {
17+
steps {
18+
warnError(message: 'ansible command not found?') {
19+
ansiblePlaybook(
20+
playbook: 'playbook.yml',
21+
extraVars: [foo: 'bar'],
22+
)
23+
}
24+
}
25+
}
26+
}
27+
}

‎src/test/resources/pipelines/extraVarsMap.groovy

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
pipeline {
2+
agent {
3+
label('test-agent')
4+
}
5+
stages {
6+
stage('Create playbook') {
7+
steps {
8+
writeFile(encoding: 'UTF-8', file: 'playbook.yml', text: '''- hosts: localhost
9+
connection: local
10+
gather_facts: no
11+
tasks:
12+
- debug: msg=test
13+
''')
14+
}
15+
}
16+
stage('Ansible playbook') {
17+
steps {
18+
warnError(message: 'ansible command not found?') {
19+
ansiblePlaybook(
20+
playbook: 'playbook.yml',
21+
extraVars: [foo1: [value: 'bar1', hidden: false]],
22+
)
23+
}
24+
warnError(message: 'ansible command not found?') {
25+
ansiblePlaybook(
26+
playbook: 'playbook.yml',
27+
extraVars: [foo2: [value: 'bar2', hidden: true]],
28+
)
29+
}
30+
}
31+
}
32+
}
33+
}

‎src/test/resources/pipelines/minimal.groovy

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
pipeline {
2+
agent {
3+
label('test-agent')
4+
}
5+
stages {
6+
stage('Create playbook') {
7+
steps {
8+
writeFile(encoding: 'UTF-8', file: 'playbook.yml', text: '''- hosts: localhost
9+
connection: local
10+
gather_facts: no
11+
tasks:
12+
- debug: msg=test
13+
''')
14+
}
15+
}
16+
stage('Ansible playbook') {
17+
steps {
18+
warnError(message: 'ansible command not found?') {
19+
ansiblePlaybook(playbook: 'playbook.yml')
20+
}
21+
}
22+
}
23+
}
24+
}

0 commit comments

Comments
 (0)