Skip to content

Add support for parameterized repository URLs and tests in GitHubSCMBuilder #1557

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

Open
itsvshreyas wants to merge 2 commits into
base: master
Choose a base branch
from
+96 −1
Open

Add support for parameterized repository URLs and tests in GitHubSCMBuilder #1557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d41578
Add support for parameterized repository URLs in GitHubSCMBuilder
itsvshreyas Aug 18, 2026
7bcd963
Add tests for parameterized repository owner and name in GitHubSCMBui…
itsvshreyas Aug 18, 2026
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
13 changes: 12 additions & 1 deletion src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ public class GitHubSCMBuilder extends GitSCMBuilder<GitHubSCMBuilder> {
/** The context within which credentials should be resolved. */
@CheckForNull
private final SCMSourceOwner context;

@NonNull
private final String checkoutRepositoryUrl;

private final boolean configuredByUrl;
/** The API URL */
@NonNull
private final String apiUri;
Expand Down Expand Up @@ -99,6 +104,8 @@ public GitHubSCMBuilder(
@NonNull GitHubSCMSource source, @NonNull SCMHead head, @CheckForNull SCMRevision revision) {
super(head, revision, /*dummy value*/ guessRemote(source), source.getCredentialsId());
this.context = source.getOwner();
checkoutRepositoryUrl = source.getRepositoryUrl();
configuredByUrl = source.isConfiguredByUrl();
apiUri = StringUtils.defaultIfBlank(source.getApiUri(), GitHubServerConfig.GITHUB_URL);
repoOwner = source.getRepoOwner();
repository = source.getRepository();
Expand Down Expand Up @@ -246,7 +253,11 @@ public static RepositoryUriResolver uriResolver(
*/
@NonNull
public final GitHubSCMBuilder withGitHubRemote() {
withRemote(uriResolver().getRepositoryUri(apiUri, repoOwner, repository));
String remote = uriResolver().getRepositoryUri(apiUri, repoOwner, repository);
if (uriResolver() == HTTPS && configuredByUrl) {
remote = checkoutRepositoryUrl;
}
withRemote(remote);
final SCMHead h = head();
String repoUrl;
if (h instanceof PullRequestSCMHead) {
Expand Down
84 changes: 84 additions & 0 deletions src/test/java/org/jenkinsci/plugins/github_branch_source/GitHubSCMBuilderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@
import com.cloudbees.plugins.credentials.domains.Domain;
import com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsImpl;
import hudson.model.Descriptor;
import hudson.model.FreeStyleBuild;
import hudson.model.FreeStyleProject;
import hudson.model.ParametersAction;
import hudson.model.ParametersDefinitionProperty;
import hudson.model.StringParameterDefinition;
import hudson.model.StringParameterValue;
import hudson.plugins.git.GitSCM;
import hudson.plugins.git.Revision;
import hudson.plugins.git.UserRemoteConfig;
Expand Down Expand Up @@ -162,6 +168,38 @@ public void given__cloud_branch_rev_anon__when__build__then__scmBuilt() throws E
assertThat(revisions.iterator().next().getSha1String(), is("cafebabedeadbeefcafebabedeadbeefcafebabe"));
}

@Test
public void given__parameterized_repository_url__when__build__then__parameter_is_preserved() throws Exception {
createGitHubSCMSourceForTest(true, "https://github.com/tester/${repo}");
BranchSCMHead head = new BranchSCMHead("test-branch");
GitHubSCMBuilder instance = new GitHubSCMBuilder(source, head, null);

GitSCM actual = instance.build();

assertThat(actual.getUserRemoteConfigs().get(0).getUrl(), is("https://github.com/tester/${repo}"));
}

@Test
public void given__parameterized_repository_name__when__checkout_remote_is_expanded__then__repository_is_selected()
throws Exception {
source = new GitHubSCMSource("tester", "${repo}", null, false);
BranchSCMHead head = new BranchSCMHead("test-branch");
GitSCM scm = new GitHubSCMBuilder(source, head, null).build();
FreeStyleProject project = j.createFreeStyleProject("parameterized-repository-" + configuredByUrl);
project.addProperty(new ParametersDefinitionProperty(new StringParameterDefinition("repo", "test-repo")));

FreeStyleBuild build = project.scheduleBuild2(
0,
new hudson.model.Cause.UserIdCause(),
new ParametersAction(new StringParameterValue("repo", "test-repo")))
.waitForStart();
j.waitUntilNoActivity();

assertThat(
scm.getParamExpandedRepos(build).get(0).getURIs().get(0).toString(),
is("https://github.com/tester/test-repo.git"));
}

@Test
public void given__cloud_branch_rev_userpass__when__build__then__scmBuilt() throws Exception {
createGitHubSCMSourceForTest(false, null);
Expand Down Expand Up @@ -2666,6 +2704,52 @@ public void given__server_pullMerge_norev_userkey__when__build__then__scmBuilt()
assertThat(merge.getBaseHash(), is(nullValue()));
}

@Test
public void given__parameterized_repository_owner__when__checkout_remote_is_expanded__then__repository_is_selected()
throws Exception {
source = new GitHubSCMSource("${owner}", "test-repo", null, false);
BranchSCMHead head = new BranchSCMHead("test-branch");
GitSCM scm = new GitHubSCMBuilder(source, head, null).build();
FreeStyleProject project = j.createFreeStyleProject("parameterized-owner-" + configuredByUrl);
project.addProperty(new ParametersDefinitionProperty(new StringParameterDefinition("owner", "tester")));

FreeStyleBuild build = project.scheduleBuild2(
0,
new hudson.model.Cause.UserIdCause(),
new ParametersAction(new StringParameterValue("owner", "tester")))
.waitForStart();
j.waitUntilNoActivity();

assertThat(
scm.getParamExpandedRepos(build).get(0).getURIs().get(0).toString(),
is("https://github.com/tester/test-repo.git"));
}

@Test
public void
given__parameterized_owner_and_repository__when__checkout_remote_is_expanded__then__repository_is_selected()
throws Exception {
source = new GitHubSCMSource("${owner}", "${repo}", null, false);
BranchSCMHead head = new BranchSCMHead("test-branch");
GitSCM scm = new GitHubSCMBuilder(source, head, null).build();
FreeStyleProject project = j.createFreeStyleProject("parameterized-both-" + configuredByUrl);
project.addProperty(new ParametersDefinitionProperty(
new StringParameterDefinition("owner", "tester"), new StringParameterDefinition("repo", "test-repo")));

FreeStyleBuild build = project.scheduleBuild2(
0,
new hudson.model.Cause.UserIdCause(),
new ParametersAction(
new StringParameterValue("owner", "tester"),
new StringParameterValue("repo", "test-repo")))
.waitForStart();
j.waitUntilNoActivity();

assertThat(
scm.getParamExpandedRepos(build).get(0).getURIs().get(0).toString(),
is("https://github.com/tester/test-repo.git"));
}

private static <T extends GitSCMExtension> T getExtension(GitSCM scm, Class<T> type) {
for (GitSCMExtension e : scm.getExtensions()) {
if (type.isInstance(e)) {
Expand Down