Skip to content

[JENKINS-42971] GitSCMFileSystem consumes environment and expands branch name #1305

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

Merged
MarkEWaite merged 18 commits into from
Nov 23, 2022
+95 −19
Merged

[JENKINS-42971] GitSCMFileSystem consumes environment and expands branch name #1305

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
cc02c2f
[JENKINS-42971] GitSCMFileSystem consumes environment and expands bra…
Aug 2, 2022
a69a857
Raised jenkins.version in POM 2
Aug 2, 2022
27aa68e
Update pom.xml
MartinKosicky Aug 2, 2022
b04e8f7
Added testing of GitSCMFileSystem branch expansion using env vars
Aug 3, 2022
d7159dc
Removed unnecesary plugin incrementals in pom.xml .
Aug 3, 2022
6111ed5
Apply suggestions from code review (code format cleanup)
MartinKosicky Aug 5, 2022
5f84f6b
HeadNameResult refactor
Aug 5, 2022
2b17a1c
Changed BOM and removed accidental test
Aug 5, 2022
ac7e38c
Merge branch 'master' into lightweight_checkout_expand_params
MarkEWaite Aug 8, 2022
c678a26
Merge remote-tracking branch 'upstream/master' into lightweight_check…
Aug 9, 2022
0fad6ba
Apply suggestions from code review. POM dependency of scm-api require…
MartinKosicky Aug 9, 2022
33d96e0
Bumped jenkins version
Aug 11, 2022
c61fbc4
Revert "Bumped jenkins version"
Aug 11, 2022
b05d4ce
Merge branch 'master' into lightweight_checkout_expand_params
MarkEWaite Nov 14, 2022
99eb6a2
Get scm-api version from bom
MarkEWaite Nov 14, 2022
5e77775
Intentionally vary expected value in test
MarkEWaite Nov 14, 2022
686cc2a
Merge branch 'master' into lightweight_checkout_expand_params
MarkEWaite Nov 22, 2022
54af228
Retain API compatibilty by including previous signature
MarkEWaite Nov 23, 2022
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
4 changes: 3 additions & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
<revision>4.11.5</revision>
<changelist>-SNAPSHOT</changelist>
<gitHubRepo>jenkinsci/${project.artifactId}-plugin</gitHubRepo>
<jenkins.version>2.303.3</jenkins.version>
<jenkins.version>2.319.3</jenkins.version>
Copy link
Member

@jglick jglick Aug 5, 2022

Choose a reason for hiding this comment

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

Update

git-plugin/pom.xml

Line 78 in d7159dc

<artifactId>bom-2.303.x</artifactId>
accordingly.

Copy link
Contributor Author

@MartinKosicky MartinKosicky Aug 5, 2022

Choose a reason for hiding this comment

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

Ok i updated it, I hope correctly

<no-test-jar>false</no-test-jar>
<useBeta>true</useBeta>
<linkXRef>false</linkXRef>
Expand Down Expand Up @@ -102,6 +102,7 @@
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<version>625.va_c59c48ce36f</version> <!-- TODO: https://github.com/jenkinsci/scm-api-plugin/pull/160 -->
<artifactId>scm-api</artifactId>
</dependency>
<dependency>
Expand Down Expand Up @@ -191,6 +192,7 @@
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>scm-api</artifactId>
<version>625.va_c59c48ce36f</version> <!-- TODO: https://github.com/jenkinsci/scm-api-plugin/pull/160 -->
<classifier>tests</classifier>
<scope>test</scope>
</dependency>
Expand Down
86 changes: 66 additions & 20 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,7 @@
import hudson.EnvVars;
import hudson.Extension;
import hudson.model.Item;
import hudson.model.Run;
import hudson.model.TaskListener;
import hudson.plugins.git.BranchSpec;
import hudson.plugins.git.GitException;
Expand Down Expand Up @@ -283,15 +284,66 @@ public boolean supportsDescriptor(SCMSourceDescriptor descriptor) {
return AbstractGitSCMSource.class.isAssignableFrom(descriptor.clazz);
}

public static class HeadNameResult
Copy link
Member

@jglick jglick Aug 5, 2022

Choose a reason for hiding this comment

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

Suggested change
public static class HeadNameResult
static class HeadNameResult

Not used outside this class and the test, right?

(In which case you could also simplify a bit by dropping private from the fields and removing the getters—this is just an internal struct, no need for accessors.)

{
private final String headName;
private final String prefix;

public HeadNameResult(String headName, String prefix) {
Copy link
Member

@jglick jglick Aug 5, 2022

Choose a reason for hiding this comment

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

Stylistically I would recommend

Suggested change
public HeadNameResult(String headName, String prefix) {
private HeadNameResult(String headName, String prefix) {

and then moving calculateHeadName inside this nested class, and renaming it accordingly (to simply calculate, or create, or make, or of, etc.).

this.headName = headName;
this.prefix = prefix;
}

public String getHeadName() {
return headName;
}

public String getPrefix() {
return prefix;
}
}

public static HeadNameResult calculateHeadName(@NonNull BranchSpec branchSpec,
@CheckForNull SCMRevision rev,
@CheckForNull EnvVars env)
{
String branchSpecExpandedName = branchSpec.getName();
if (env != null) {
branchSpecExpandedName = env.expand(branchSpecExpandedName);
}

String prefix = Constants.R_HEADS;
if(branchSpecExpandedName.startsWith(Constants.R_TAGS)){
prefix = Constants.R_TAGS;
}

String headName;
if (rev != null) {
headName = env.expand(rev.getHead().getName());
} else {
if (branchSpecExpandedName.startsWith(prefix)){
headName = branchSpecExpandedName.substring(prefix.length());
} else if (branchSpecExpandedName.startsWith("*/")) {
headName = branchSpecExpandedName.substring(2);
} else {
headName = branchSpecExpandedName;
}
}

return new HeadNameResult(headName, prefix);
}

@Override
public SCMFileSystem build(@NonNull Item owner, @NonNull SCM scm, @CheckForNull SCMRevision rev)
public SCMFileSystem build(@NonNull Item owner, @NonNull SCM scm, @CheckForNull SCMRevision rev,
@CheckForNull Run<?,?> _build)
throws IOException, InterruptedException {
if (rev != null && !(rev instanceof AbstractGitSCMSource.SCMRevisionImpl)) {
return null;
}
if (!(scm instanceof GitSCM)) {
return null; // Spotbugs warns about unchecked cast without this check
}

GitSCM gitSCM = (GitSCM) scm;
UserRemoteConfig config = gitSCM.getUserRemoteConfigs().get(0);
BranchSpec branchSpec = gitSCM.getBranches().get(0);
Expand All @@ -301,6 +353,13 @@ public SCMFileSystem build(@NonNull Item owner, @NonNull SCM scm, @CheckForNull
listener.getLogger().println("Git remote url is null");
return null;
}

EnvVars env = null;
if (_build != null)
{
env = _build.getEnvironment(listener);
}

String cacheEntry = AbstractGitSCMSource.getCacheEntry(remote);
Lock cacheLock = AbstractGitSCMSource.getCacheLock(cacheEntry);
cacheLock.lock();
Expand Down Expand Up @@ -345,28 +404,15 @@ 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;
if (rev != null) {
headName = rev.getHead().getName();
} 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();
}
}

HeadNameResult headNameResult = calculateHeadName(branchSpec, rev, env);

client.fetch_().prune(true).from(remoteURI, Arrays
.asList(new RefSpec(
"+" + prefix + headName + ":" + Constants.R_REMOTES + remoteName + "/"
+ headName))).execute();
"+" + headNameResult.getPrefix() + headNameResult.getHeadName() + ":" + Constants.R_REMOTES + remoteName + "/"
+ headNameResult.getHeadName()))).execute();
listener.getLogger().println("Done.");
return new GitSCMFileSystem(client, remote, Constants.R_REMOTES + remoteName + "/" +headName, (AbstractGitSCMSource.SCMRevisionImpl) rev);
return new GitSCMFileSystem(client, remote, Constants.R_REMOTES + remoteName + "/" + headNameResult.getHeadName(), (AbstractGitSCMSource.SCMRevisionImpl) rev);
} finally {
cacheLock.unlock();
}
Expand Down
39 changes: 39 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 @@ -43,6 +43,8 @@
import jenkins.scm.api.SCMRevision;
import jenkins.scm.api.SCMSource;
import jenkins.scm.api.SCMSourceDescriptor;

import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.ObjectId;
import org.jenkinsci.plugins.gitclient.Git;
import org.jenkinsci.plugins.gitclient.GitClient;
Expand Down Expand Up @@ -427,6 +429,43 @@ public void filesystem_supports_descriptor() throws Exception {
assertTrue(SCMFileSystem.supports(descriptor));
}

@Issue("JENKINS-42971")
@Test
Copy link
Member

@jglick jglick Aug 5, 2022

Choose a reason for hiding this comment

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

May also want to assert behavior with a null env, undefined variable, etc.

Copy link
Contributor Author

@MartinKosicky MartinKosicky Aug 5, 2022

Choose a reason for hiding this comment

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

there is one for null env, but this is internal method, and there are many checks already in the calling method

public void calculate_head_name_with_env() throws Exception
{
Copy link
Member

@jglick jglick Aug 5, 2022

Choose a reason for hiding this comment

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

Suggested change
public void calculate_head_name_with_env() throws Exception
{
public void calculate_head_name_with_env() throws Exception {

GitSCMFileSystem.BuilderImpl.HeadNameResult result1 = GitSCMFileSystem.BuilderImpl.calculateHeadName(new BranchSpec("${BRANCH}"), null,
new EnvVars("BRANCH","master"));
assertEquals(result1.getHeadName(),"master");
assertEquals(result1.getPrefix(), Constants.R_HEADS);

GitSCMFileSystem.BuilderImpl.HeadNameResult result2 = GitSCMFileSystem.BuilderImpl.calculateHeadName(new BranchSpec("${BRANCH}"), null,
new EnvVars("BRANCH","refs/heads/master"));
assertEquals("master", result2.getHeadName());
assertEquals(Constants.R_HEADS, result2.getPrefix());

GitSCMFileSystem.BuilderImpl.HeadNameResult result3 = GitSCMFileSystem.BuilderImpl.calculateHeadName(new BranchSpec("refs/heads/${BRANCH}"), null,
new EnvVars("BRANCH","master"));
assertEquals("master", result3.getHeadName());
assertEquals(Constants.R_HEADS, result3.getPrefix());

GitSCMFileSystem.BuilderImpl.HeadNameResult result4 = GitSCMFileSystem.BuilderImpl.calculateHeadName(new BranchSpec("${BRANCH}"), null,
null);
assertEquals(result4.getHeadName(),"${BRANCH}");
assertEquals(result4.getPrefix(), Constants.R_HEADS);

GitSCMFileSystem.BuilderImpl.HeadNameResult result5 = GitSCMFileSystem.BuilderImpl.calculateHeadName(new BranchSpec("*/${BRANCH}"), null,
new EnvVars("BRANCH","master"));
assertEquals("master", result5.getHeadName());
assertEquals(Constants.R_HEADS, result5.getPrefix());

GitSCMFileSystem.BuilderImpl.HeadNameResult result6 = GitSCMFileSystem.BuilderImpl.calculateHeadName(new BranchSpec("*/master"), null,
new EnvVars("BRANCH","dummy"));
assertEquals("master", result6.getHeadName());
assertEquals(Constants.R_HEADS, result6.getPrefix());


}

/** inline ${@link hudson.Functions#isWindows()} to prevent a transient remote classloader issue */
private boolean isWindows() {
return java.io.File.pathSeparatorChar==';';
Expand Down