Skip to content

Commit

Permalink
Merge pull request #177 from abayer/jenkins-45198
Browse files Browse the repository at this point in the history 
[FIXED JENKINS-45198] When possible, add scm vars to environment
  • Loading branch information
@abayer
abayer committed Aug 11, 2017
2 parents 103bec1 + a5be631 commit eafc831
Show file tree
Hide file tree
Showing 6 changed files with 100 additions and 14 deletions.
16 changes: 15 additions & 1 deletion pipeline-model-definition/pom.xml
View file
Expand Up @@ -134,6 +134,14 @@
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-cps-global-lib</artifactId>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>mailer</artifactId>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>git-client</artifactId>
</dependency>
<!-- Dependency on tombstoned declarative agent plugin to make sure we don't end up with a
bad old version installed -->
<dependency>
Expand Down Expand Up @@ -201,7 +209,13 @@
<artifactId>jcabi-matchers</artifactId>
<scope>test</scope>
</dependency>


<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>ant</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>git</artifactId>
Expand Down
4 changes: 2 additions & 2 deletions ...main/java/org/jenkinsci/plugins/pipeline/modeldefinition/SyntheticStageGraphListener.java
View file
Expand Up @@ -58,7 +58,7 @@ public void onNewHead(FlowNode node) {
if (node != null && node instanceof StepStartNode &&
((StepStartNode) node).getDescriptor() instanceof StageStep.DescriptorImpl) {
if (isDeclarativeRun(node.getExecution())) {
LabelAction label = node.getPersistentAction(LabelAction.class);
LabelAction label = node.getAction(LabelAction.class);
if (label != null &&
(SyntheticStageNames.preStages().contains(label.getDisplayName()) ||
SyntheticStageNames.postStages().contains(label.getDisplayName()))) {
Expand All @@ -74,7 +74,7 @@ public void onNewHead(FlowNode node) {
}

private void attachTag(FlowNode currentNode, String syntheticContext) {
TagsAction tagsAction = currentNode.getPersistentAction(TagsAction.class);
TagsAction tagsAction = currentNode.getAction(TagsAction.class);
if (tagsAction == null) {
tagsAction = new TagsAction();
tagsAction.addTag(SyntheticStage.TAG_NAME, syntheticContext);
Expand Down
13 changes: 13 additions & 0 deletions ...ition/src/test/java/org/jenkinsci/plugins/pipeline/modeldefinition/BasicModelDefTest.java
View file
Expand Up @@ -854,4 +854,17 @@ public void parallelStagesAgentEnvWhen() throws Exception {


}

@Issue("JENKINS-45198")
@Test
public void scmEnvVars() throws Exception {
// The change to support checkout scm returning a map and that map being added to the environment works fine with
// older core etc, but just doesn't do anything, since checkout scm isn't returning anything yet. But with newer
// core, etc, it'll Just Work.
expect("scmEnvVars")
// TODO: switch to .logNotContains("GIT_COMMIT is null") once we've moved to core 2.60+,
// workflow-scm-step 2.6+, git 3.3.1+
.logContains("GIT_COMMIT is null")
.go();
}
}
37 changes: 37 additions & 0 deletions pipeline-model-definition/src/test/resources/scmEnvVars.groovy
View file
@@ -0,0 +1,37 @@
/*
* The MIT License
*
* Copyright (c) 2017, CloudBees, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/

pipeline {
agent any
stages {
stage("foo") {
steps {
echo "GIT_COMMIT is ${env.GIT_COMMIT}"
}
}
}
}



13 changes: 10 additions & 3 deletions ...main/resources/org/jenkinsci/plugins/pipeline/modeldefinition/agent/CheckoutScript.groovy
View file
Expand Up @@ -44,17 +44,24 @@ public class CheckoutScript implements Serializable {

private static Closure checkoutAndRun(CpsScript script, DeclarativeAgent agent, Closure body) {
return {
def checkoutMap
if (agent.isDoCheckout() && agent.hasScmContext(script)) {
if (!agent.inStage) {
script.stage(SyntheticStageNames.checkout()) {
script.checkout script.scm
checkoutMap = script.checkout script.scm
}
} else {
// No stage when we're in a nested stage already
script.checkout script.scm
checkoutMap = script.checkout script.scm
}
}
body.call()
if (checkoutMap) {
script.withEnv(checkoutMap.collect { k, v -> "${k}=${v}" }) {
body.call()
}
} else {
body.call()
}
}
}

Expand Down
31 changes: 23 additions & 8 deletions pom.xml
View file
Expand Up @@ -26,7 +26,7 @@
<parent>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>plugin</artifactId>
<version>2.17</version>
<version>2.29</version>
<relativePath />
</parent>

Expand Down Expand Up @@ -75,7 +75,7 @@
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-cps</artifactId>
<version>2.33</version>
<version>2.36.1</version>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
Expand All @@ -85,7 +85,7 @@
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-api</artifactId>
<version>2.16</version>
<version>2.18</version>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
Expand All @@ -95,12 +95,12 @@
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-scm-step</artifactId>
<version>2.3</version>
<version>2.4</version>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-scm-step</artifactId>
<version>2.3</version>
<version>2.4</version>
<classifier>tests</classifier>
</dependency>
<dependency>
Expand Down Expand Up @@ -142,7 +142,7 @@
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>scm-api</artifactId>
<version>1.3</version>
<version>2.0.8</version>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
Expand Down Expand Up @@ -200,12 +200,12 @@
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-step-api</artifactId>
<version>2.9</version>
<version>2.10</version>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>structs</artifactId>
<version>1.5</version>
<version>1.7</version>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
Expand All @@ -227,6 +227,21 @@
<artifactId>pipeline-input-step</artifactId>
<version>2.5</version>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>mailer</artifactId>
<version>1.17</version>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>git-client</artifactId>
<version>1.21.0</version>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>ant</artifactId>
<version>1.5</version>
</dependency>
</dependencies>
</dependencyManagement>

Expand Down

0 comments on commit eafc831

Please sign in to comment.