Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[JENKINS-30412] Offering a sandbox-friendly RunWrapper.changeSets property #5

Merged
merged 6 commits into from
Jul 11, 2016
Merged

[JENKINS-30412] Offering a sandbox-friendly RunWrapper.changeSets property #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5724c96
[FIXED JENKINS-30412] Offering a sandbox-friendly RunWrapper.changeSe…
jglick Jun 28, 2016
ae0eb88
Noting why I am not using https://github.com/hamcrest/JavaHamcrest/pu…
jglick Jun 28, 2016
64b264b
Merge branch 'master' into RunWrapper.getChangeSets-JENKINS-30412
jglick Jul 11, 2016
7c30710
script-security 1.21
jglick Jul 11, 2016
499bc58
Need newer workflow-scm-step to avoid clash with git.
jglick Jul 11, 2016
bacf069
Needed to tweak test deps some more.
jglick Jul 11, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
49 changes: 41 additions & 8 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@
<parent>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>plugin</artifactId>
<version>2.5</version>
<relativePath />
<version>2.11</version>
<relativePath/>
</parent>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-support</artifactId>
Expand All @@ -52,23 +52,24 @@
<repositories>
<repository>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
<url>https://repo.jenkins-ci.org/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
<url>https://repo.jenkins-ci.org/public/</url>
</pluginRepository>
</pluginRepositories>
<properties>
<jenkins.version>1.642.3</jenkins.version>
<jenkins-test-harness.version>2.11</jenkins-test-harness.version>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need getLog fixed to be plain text.

</properties>
<dependencies>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>workflow-step-api</artifactId>
<version>1.15</version>
<version>2.2</version>
</dependency>
<dependency>
<groupId>${project.groupId}</groupId>
Expand All @@ -78,7 +79,7 @@
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>script-security</artifactId>
<version>1.16</version>
<version>1.21</version>
</dependency>
<dependency>
<groupId>org.jboss.marshalling</groupId>
Expand All @@ -88,7 +89,7 @@
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>workflow-step-api</artifactId>
<version>1.15</version>
<version>2.2</version>
<classifier>tests</classifier>
<scope>test</scope>
</dependency>
Expand All @@ -113,7 +114,19 @@
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-cps</artifactId>
<version>1.15</version>
<version>2.9</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-scm-step</artifactId>
<version>2.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-durable-task-step</artifactId>
<version>2.3</version>
<scope>test</scope>
</dependency>
<dependency>
Expand All @@ -128,6 +141,26 @@
<version>1.15</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>git</artifactId>
<version>2.5.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>git</artifactId>
<version>2.5.0</version>
<classifier>tests</classifier>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitSampleRepoRule

<scope>test</scope>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-scm-step</artifactId>
<version>2.2</version>
<classifier>tests</classifier>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
Expand Down
12 changes: 12 additions & 0 deletions src/main/java/org/jenkinsci/plugins/workflow/support/steps/build/RunWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@
import hudson.model.AbstractBuild;
import hudson.model.Result;
import hudson.model.Run;
import hudson.scm.ChangeLogSet;
import hudson.security.ACL;
import java.io.IOException;
import java.io.Serializable;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
Expand Down Expand Up @@ -182,4 +184,14 @@ public String getId() throws AbortException {
return build().getAbsoluteUrl();
}

@Whitelisted
public List<ChangeLogSet<? extends ChangeLogSet.Entry>> getChangeSets() throws Exception {
Run<?,?> build = build();
try { // TODO JENKINS-24141 should not need to use reflection here
return (List) build.getClass().getMethod("getChangeSets").invoke(build);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

currently this will work on AbstractBuild and WorkflowRun

} catch (NoSuchMethodException x) {
return Collections.emptyList();
}
}

}
61 changes: 61 additions & 0 deletions src/test/java/org/jenkinsci/plugins/workflow/support/steps/build/RunWrapperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
package org.jenkinsci.plugins.workflow.support.steps.build;

import hudson.model.Result;
import java.util.regex.Pattern;
import jenkins.plugins.git.GitSampleRepoRule;
import org.hamcrest.Matcher;
import org.hamcrest.core.SubstringMatcher;
import org.jenkinsci.plugins.scriptsecurity.scripts.ScriptApproval;
import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
import org.jenkinsci.plugins.workflow.job.WorkflowJob;
Expand All @@ -37,13 +41,16 @@
import org.junit.runners.model.Statement;
import org.jvnet.hudson.test.BuildWatcher;
import org.jvnet.hudson.test.Issue;
import org.jvnet.hudson.test.JenkinsRule;
import org.jvnet.hudson.test.RestartableJenkinsRule;

@Issue("JENKINS-26834")
public class RunWrapperTest {

@ClassRule public static BuildWatcher buildWatcher = new BuildWatcher();
@Rule public RestartableJenkinsRule r = new RestartableJenkinsRule();
@Rule public GitSampleRepoRule sampleRepo1 = new GitSampleRepoRule();
@Rule public GitSampleRepoRule sampleRepo2 = new GitSampleRepoRule();

@Test public void historyAndPickling() {
r.addStep(new Statement() {
Expand Down Expand Up @@ -99,4 +106,58 @@ public class RunWrapperTest {
});
}

@Issue("JENKINS-30412")
@Test public void getChangeSets() {
r.addStep(new Statement() {
@Override public void evaluate() throws Throwable {
sampleRepo1.init();
sampleRepo2.init();
WorkflowJob p = r.j.jenkins.createProject(WorkflowJob.class, "p");
p.setDefinition(new CpsFlowDefinition(
"node {dir('1') {git($/" + sampleRepo1 + "/$)}; dir('2') {git($/" + sampleRepo2 + "/$)}}\n" +
"echo(/changeSets: ${summarize currentBuild}/)\n" +
"@NonCPS def summarize(b) {\n" +
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possible to iterate without iterators or Groovy helpers but this is more concise. Chose a script which could be represented in the test without " so that it could be copied verbatim.

" b.changeSets.collect {cs ->\n" +
" /kind=${cs.kind}; entries=/ + cs.collect {entry ->\n" +
" /${entry.commitId} by ${entry.author.id} ~ ${entry.author.fullName} on ${new Date(entry.timestamp)}: ${entry.msg}: / + entry.affectedFiles.collect {file ->\n" +
" /${file.editType.name} ${file.path}/\n" +
" }.join('; ')\n" +
" }.join(', ')\n" +
" }.join(' & ')\n" +
"}", true));
r.j.assertLogContains("changeSets: ", r.j.assertBuildStatusSuccess(p.scheduleBuild2(0)));
sampleRepo1.write("onefile", "stuff");
sampleRepo1.git("add", "onefile");
sampleRepo1.git("commit", "--message=stuff");
assertThat(JenkinsRule.getLog(r.j.assertBuildStatusSuccess(p.scheduleBuild2(0))), containsRegexp(
"changeSets: kind=git; entries=[a-f0-9]{40} by .+ ~ .+ on .+: stuff: add onefile"));
sampleRepo1.write("onefile", "more stuff");
sampleRepo1.write("anotherfile", "stuff");
sampleRepo1.git("add", "onefile", "anotherfile");
sampleRepo1.git("commit", "--message=more stuff");
sampleRepo1.write("onefile", "amended");
sampleRepo1.git("add", "onefile");
sampleRepo1.git("commit", "--message=amended");
sampleRepo2.write("elsewhere", "stuff");
sampleRepo2.git("add", "elsewhere");
sampleRepo2.git("commit", "--message=second repo");
assertThat(JenkinsRule.getLog(r.j.assertBuildStatusSuccess(p.scheduleBuild2(0))), containsRegexp(
"changeSets: kind=git; entries=[a-f0-9]{40} by .+ ~ .+ on .+: more stuff: (edit onefile; add anotherfile|add anotherfile; edit onefile), " +
"[a-f0-9]{40} by .+ ~ .+ on .+: amended: edit onefile & " +
"kind=git; entries=[a-f0-9]{40} by .+ ~ .+ on .+: second repo: add elsewhere"));
}
});
}
// Like org.hamcrest.text.MatchesPattern.matchesPattern(String) but doing a substring, not whole-string, match:
private static Matcher<String> containsRegexp(final String rx) {
return new SubstringMatcher(rx) {
@Override protected boolean evalSubstringOf(String string) {
return Pattern.compile(rx).matcher(string).find();
}
@Override protected String relationship() {
return "containing the regexp";
}
};
}

}