Skip to content

JENKINS-60630: Add GitSCMFileSystem support for EnvVar expansion #1040

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

Closed
rayvincent2 wants to merge 3 commits into from
Closed

JENKINS-60630: Add GitSCMFileSystem support for EnvVar expansion #1040

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
00317b4
JENKINS-60630: Add GitSCMFileSystem support for EnvVar expansion
rayvincent2 Feb 7, 2021
07b777b
JENKINS-60630: Small Code Coverage Improvement
rayvincent2 Feb 9, 2021
c68769e
Cleanup tests for deprecation of submodule config
rayvincent2 Feb 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 66 additions & 28 deletions src/main/java/jenkins/plugins/git/GitSCMFileSystem.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
import hudson.EnvVars;
import hudson.Extension;
import hudson.model.Item;
import hudson.model.Job;
import hudson.model.Run;
import hudson.model.TaskListener;
import hudson.plugins.git.BranchSpec;
import hudson.plugins.git.GitException;
Expand Down Expand Up @@ -252,19 +254,29 @@ public static class BuilderImpl extends SCMFileSystem.Builder {

@Override
public boolean supports(SCM source) {
return source instanceof GitSCM
&& ((GitSCM) source).getUserRemoteConfigs().size() == 1
&& ((GitSCM) source).getBranches().size() == 1
&& !((GitSCM) source).getBranches().get(0).getName().equals("*") // JENKINS-57587
&& (
((GitSCM) source).getBranches().get(0).getName().matches(
"^((\\Q" + Constants.R_HEADS + "\\E.*)|([^/]+)|(\\*/[^/*]+(/[^/*]+)*))$"
)
|| ((GitSCM) source).getBranches().get(0).getName().matches(
"^((\\Q" + Constants.R_TAGS + "\\E.*)|([^/]+)|(\\*/[^/*]+(/[^/*]+)*))$"
if (source instanceof GitSCM) {
for (BranchSpec branchSpec : ((GitSCM) source).getBranches()) {
String branch = branchSpec.getName();

// we only support where the branch spec is obvious and not a wildcard
if (!(
!branch.equals("*") // JENKINS-57587
&& (
branch.matches(
"^((\\Q" + Constants.R_HEADS + "\\E.*)|([^/]+)|(\\*/[^/*]+(/[^/*]+)*))$"
)
|| branch.matches(
"^((\\Q" + Constants.R_TAGS + "\\E.*)|([^/]+)|(\\*/[^/*]+(/[^/*]+)*))$"
)
)
);
// we only support where the branch spec is obvious and not a wildcard
)) {
return false;
}
}
return true;
} else {
return false;
}
}

@Override
Expand Down Expand Up @@ -293,7 +305,6 @@ public SCMFileSystem build(@NonNull Item owner, @NonNull SCM scm, @CheckForNull
}
GitSCM gitSCM = (GitSCM) scm;
UserRemoteConfig config = gitSCM.getUserRemoteConfigs().get(0);
BranchSpec branchSpec = gitSCM.getBranches().get(0);
String remote = config.getUrl();
TaskListener listener = new LogTaskListener(LOGGER, Level.FINE);
if (remote == null) {
Expand Down Expand Up @@ -343,26 +354,53 @@ public SCMFileSystem build(@NonNull Item owner, @NonNull SCM scm, @CheckForNull
} catch (URISyntaxException ex) {
listener.getLogger().println("URI syntax exception for '" + remoteName + "' " + ex);
}
String prefix = Constants.R_HEADS;
if(branchSpec.getName().startsWith(Constants.R_TAGS)){
prefix = Constants.R_TAGS;
}
String headName;
// Initialize to master before overriding
// It will always be overridden since at least once branch must be provided
String headName = "master";
String prefix = Constants.R_HEADS;
if (rev != null) {
headName = rev.getHead().getName();
client.fetch_().prune(true).from(remoteURI, Arrays.asList(new RefSpec(
"+" + prefix + headName + ":" + Constants.R_REMOTES + remoteName + "/"
+ headName))).execute();
} else {
if (branchSpec.getName().startsWith(prefix)){
headName = branchSpec.getName().substring(prefix.length());
} else if (branchSpec.getName().startsWith("*/")) {
headName = branchSpec.getName().substring(2);
} else {
headName = branchSpec.getName();
EnvVars env = new EnvVars();
if (owner instanceof Job
&& ((Job<?,?>) owner).getLastBuild() != null
&& ((Job<?,?>) owner).getLastBuild().isBuilding()
) {
Run<?,?> run = ((Job<?,?>) owner).getLastBuild();
env = run.getEnvironment(listener);
}

for (BranchSpec branchSpec : gitSCM.getBranches()) {
if (branchSpec.getName().startsWith(Constants.R_HEADS)){
prefix = Constants.R_HEADS;
headName = branchSpec.getName().substring(prefix.length());
} else if (branchSpec.getName().startsWith(Constants.R_TAGS)){
prefix = Constants.R_TAGS;
headName = branchSpec.getName().substring(prefix.length());
} else if (branchSpec.getName().startsWith("*/")) {
headName = branchSpec.getName().substring(2);
} else {
headName = branchSpec.getName();
}
headName = env.expand(headName);
headName = headName.replaceAll("\\$\\{[^\\}]+\\}", "");

// If the EnvVar expaned branch name is not empty, then break
if (!headName.equals("")) {
try {
client.fetch_().prune(true).from(remoteURI, Arrays.asList(new RefSpec(
"+" + prefix + headName + ":" + Constants.R_REMOTES + remoteName + "/"
+ headName))).execute();
break;
} catch(Exception exc) {
continue;
}
}
}
}
client.fetch_().prune(true).from(remoteURI, Arrays
.asList(new RefSpec(
"+" + prefix + headName + ":" + Constants.R_REMOTES + remoteName + "/"
+ headName))).execute();
listener.getLogger().println("Done.");
return new GitSCMFileSystem(client, remote, Constants.R_REMOTES + remoteName + "/" +headName, (AbstractGitSCMSource.SCMRevisionImpl) rev);
} finally {
Expand Down
160 changes: 160 additions & 0 deletions src/test/java/jenkins/plugins/git/GitSCMFileSystemTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,19 @@
package jenkins.plugins.git;

import hudson.EnvVars;
import hudson.model.FreeStyleBuild;
import hudson.model.FreeStyleProject;
import hudson.model.TaskListener;
import hudson.plugins.git.BranchSpec;
import hudson.plugins.git.GitSCM;
import hudson.plugins.git.extensions.GitSCMExtension;
import hudson.plugins.git.GitException;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import jenkins.scm.api.SCMFile;
Expand All @@ -52,6 +56,7 @@
import org.junit.Test;
import org.jvnet.hudson.test.Issue;
import org.jvnet.hudson.test.JenkinsRule;
import org.mockito.Mockito;

import static org.hamcrest.Matchers.containsInAnyOrder;
import static org.hamcrest.Matchers.containsString;
Expand All @@ -65,6 +70,7 @@
import static org.junit.Assert.assertFalse;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;

/**
* Tests for {@link AbstractGitSCMSource}
Expand Down Expand Up @@ -195,6 +201,160 @@ public void slashyBranches() throws Exception {
assertThat(file.contentAsString(), is("modified"));
}

@Issue("JENKINS-60630")
@Test
public void envVarBranchFromLastBuild() throws Exception {
EnvVars env = new EnvVars();
env.put("BRANCH_SOURCE", "bug/envBranch");

FreeStyleProject project = r.createFreeStyleProject();
FreeStyleProject projectSpy = Mockito.spy(project);
FreeStyleBuild buildSpy = Mockito.spy(new FreeStyleBuild(project));
Mockito.when(buildSpy.isBuilding()).thenReturn(true);
Mockito.when(buildSpy.getEnvironment(any())).thenReturn(env);
Mockito.when(projectSpy.getLastBuild()).thenReturn(buildSpy);

sampleRepo.init();
sampleRepo.git("checkout", "-b", "bug/envBranch");
sampleRepo.write("file", "modified");
sampleRepo.git("commit", "--all", "--message=dev");
SCMFileSystem fs = SCMFileSystem.of(projectSpy, new GitSCM(GitSCM.createRepoList(sampleRepo.toString(), null), Collections.singletonList(new BranchSpec("*/${BRANCH_SOURCE}")), null, null, Collections.<GitSCMExtension>emptyList()));
assertThat(fs, notNullValue());
SCMFile root = fs.getRoot();
assertThat(root, notNullValue());
assertTrue(root.isRoot());
Iterable<SCMFile> children = root.children();
Iterator<SCMFile> iterator = children.iterator();
assertThat(iterator.hasNext(), is(true));
SCMFile file = iterator.next();
assertThat(iterator.hasNext(), is(false));
assertThat(file.getName(), is("file"));
assertThat(file.contentAsString(), is("modified"));
}

@Issue("JENKINS-60630")
@Test
public void firstEnvVarBranchEmpty() throws Exception {
EnvVars env = new EnvVars();
env.put("BRANCH_TARGET", "bug/envBranch");

FreeStyleProject project = r.createFreeStyleProject();
FreeStyleProject projectSpy = Mockito.spy(project);
FreeStyleBuild buildSpy = Mockito.spy(new FreeStyleBuild(project));
Mockito.when(buildSpy.isBuilding()).thenReturn(true);
Mockito.when(buildSpy.getEnvironment(any())).thenReturn(env);
Mockito.when(projectSpy.getLastBuild()).thenReturn(buildSpy);

sampleRepo.init();
sampleRepo.git("checkout", "-b", "bug/envBranch");
sampleRepo.write("file", "modified");
sampleRepo.git("commit", "--all", "--message=dev");
List<BranchSpec> branches = new ArrayList<BranchSpec>();
branches.add(new BranchSpec("*/${BRANCH_SOURCE}"));
branches.add(new BranchSpec("*/${BRANCH_TARGET}"));
SCMFileSystem fs = SCMFileSystem.of(projectSpy, new GitSCM(GitSCM.createRepoList(sampleRepo.toString(), null), branches, null, null, Collections.<GitSCMExtension>emptyList()));
assertThat(fs, notNullValue());
SCMFile root = fs.getRoot();
assertThat(root, notNullValue());
assertTrue(root.isRoot());
Iterable<SCMFile> children = root.children();
Iterator<SCMFile> iterator = children.iterator();
assertThat(iterator.hasNext(), is(true));
SCMFile file = iterator.next();
assertThat(iterator.hasNext(), is(false));
assertThat(file.getName(), is("file"));
assertThat(file.contentAsString(), is("modified"));
}

@Issue("JENKINS-60630")
@Test
public void firstEnvVarBranchValid() throws Exception {
EnvVars env = new EnvVars();
env.put("BRANCH_SOURCE", "bug/envBranch");

FreeStyleProject project = r.createFreeStyleProject();
FreeStyleProject projectSpy = Mockito.spy(project);
FreeStyleBuild buildSpy = Mockito.spy(new FreeStyleBuild(project));
Mockito.when(buildSpy.isBuilding()).thenReturn(true);
Mockito.when(buildSpy.getEnvironment(any())).thenReturn(env);
Mockito.when(projectSpy.getLastBuild()).thenReturn(buildSpy);

sampleRepo.init();
sampleRepo.git("checkout", "-b", "bug/envBranch");
sampleRepo.write("file", "modified");
sampleRepo.git("commit", "--all", "--message=dev");
List<BranchSpec> branches = new ArrayList<BranchSpec>();
branches.add(new BranchSpec("*/${BRANCH_SOURCE}"));
branches.add(new BranchSpec("*/${BRANCH_TARGET}"));
SCMFileSystem fs = SCMFileSystem.of(projectSpy, new GitSCM(GitSCM.createRepoList(sampleRepo.toString(), null), branches, null, null, Collections.<GitSCMExtension>emptyList()));
assertThat(fs, notNullValue());
SCMFile root = fs.getRoot();
assertThat(root, notNullValue());
assertTrue(root.isRoot());
Iterable<SCMFile> children = root.children();
Iterator<SCMFile> iterator = children.iterator();
assertThat(iterator.hasNext(), is(true));
SCMFile file = iterator.next();
assertThat(iterator.hasNext(), is(false));
assertThat(file.getName(), is("file"));
assertThat(file.contentAsString(), is("modified"));
}

@Issue("JENKINS-60630")
@Test
public void firstEnvVarBranchNotFoundSecondBranchValid() throws Exception {
EnvVars env = new EnvVars();
env.put("BRANCH_SOURCE", "bug/deletedBranch");
env.put("BRANCH_TARGET", "bug/envBranch");

FreeStyleProject project = r.createFreeStyleProject();
FreeStyleProject projectSpy = Mockito.spy(project);
FreeStyleBuild buildSpy = Mockito.spy(new FreeStyleBuild(project));
Mockito.when(buildSpy.isBuilding()).thenReturn(true);
Mockito.when(buildSpy.getEnvironment(any())).thenReturn(env);
Mockito.when(projectSpy.getLastBuild()).thenReturn(buildSpy);

sampleRepo.init();
sampleRepo.git("checkout", "-b", "bug/envBranch");
sampleRepo.write("file", "modified");
sampleRepo.git("commit", "--all", "--message=dev");
List<BranchSpec> branches = new ArrayList<BranchSpec>();
branches.add(new BranchSpec("*/${BRANCH_SOURCE}"));
branches.add(new BranchSpec("*/${BRANCH_TARGET}"));
SCMFileSystem fs = SCMFileSystem.of(projectSpy, new GitSCM(GitSCM.createRepoList(sampleRepo.toString(), null), branches, null, null, Collections.<GitSCMExtension>emptyList()));
assertThat(fs, notNullValue());
SCMFile root = fs.getRoot();
assertThat(root, notNullValue());
assertTrue(root.isRoot());
Iterable<SCMFile> children = root.children();
Iterator<SCMFile> iterator = children.iterator();
assertThat(iterator.hasNext(), is(true));
SCMFile file = iterator.next();
assertThat(iterator.hasNext(), is(false));
assertThat(file.getName(), is("file"));
assertThat(file.contentAsString(), is("modified"));
}

@Test
public void branchSpecRefHeads() throws Exception {
sampleRepo.init();
sampleRepo.git("checkout", "-b", "dev");
sampleRepo.write("file", "modified");
sampleRepo.git("commit", "--all", "--message=dev");
SCMFileSystem fs = SCMFileSystem.of(r.createFreeStyleProject(), new GitSCM(GitSCM.createRepoList(sampleRepo.toString(), null), Collections.singletonList(new BranchSpec("refs/heads/dev")), null, null, Collections.<GitSCMExtension>emptyList()));
assertThat(fs, notNullValue());
SCMFile root = fs.getRoot();
assertThat(root, notNullValue());
assertTrue(root.isRoot());
Iterable<SCMFile> children = root.children();
Iterator<SCMFile> iterator = children.iterator();
assertThat(iterator.hasNext(), is(true));
SCMFile file = iterator.next();
assertThat(iterator.hasNext(), is(false));
assertThat(file.getName(), is("file"));
assertThat(file.contentAsString(), is("modified"));
}

@Issue("JENKINS-57587")
@Test
public void wildcardBranchNameCausesNPE() throws Exception {
Expand Down