Skip to content

fix: expand env vars & token macros in manually entered repo urls for commit status #317

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
jwbrandon wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix: expand env vars & token macros in manually entered repo urls for commit status #317

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
5b9781f
fix: expand env vars & token macros in manually entered repo urls for…
jwbrandon Dec 7, 2022
830ded9
revert un-needed change, fix compilation
jwbrandon Dec 7, 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
14 changes: 13 additions & 1 deletion ...ain/java/org/jenkinsci/plugins/github/status/sources/ManuallyEnteredRepositorySource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@
import hudson.model.Descriptor;
import hudson.model.Run;
import hudson.model.TaskListener;
import org.jenkinsci.plugins.github.common.ExpandableMessage;
import org.jenkinsci.plugins.github.extension.status.GitHubReposSource;
import org.jenkinsci.plugins.github.util.misc.NullSafeFunction;
import org.kohsuke.github.GHRepository;
import org.kohsuke.stapler.DataBoundConstructor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Collections;
Expand All @@ -18,6 +21,7 @@
import static org.jenkinsci.plugins.github.util.FluentIterableWrapper.from;

public class ManuallyEnteredRepositorySource extends GitHubReposSource {
private static final Logger LOG = LoggerFactory.getLogger(ManuallyEnteredRepositorySource.class);
private String url;

@DataBoundConstructor
Expand All @@ -36,7 +40,15 @@ GitHubRepositoryName createName(String url) {

@Override
public List<GHRepository> repos(@NonNull Run<?, ?> run, @NonNull final TaskListener listener) {
List<String> urls = Collections.singletonList(url);
String expandedUrl = url;

try {
expandedUrl = new ExpandableMessage(url).expandAll(run, listener);
} catch (Exception e) {
LOG.debug("Can't expand context, using as is", e);
}

List<String> urls = Collections.singletonList(expandedUrl);
return from(urls).transformAndConcat(new NullSafeFunction<String, Iterable<GHRepository>>() {
@Override
protected Iterable<GHRepository> applyNullSafe(@NonNull String url) {
Expand Down
18 changes: 18 additions & 0 deletions ...java/org/jenkinsci/plugins/github/status/sources/ManuallyEnteredRepositorySourceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package org.jenkinsci.plugins.github.status.sources;

import hudson.EnvVars;
import hudson.model.Run;
import hudson.model.TaskListener;
import org.junit.Test;
Expand All @@ -12,6 +13,7 @@
import java.io.PrintStream;
import java.util.List;

import org.mockito.ArgumentMatchers;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.collection.IsCollectionWithSize.hasSize;
import static org.mockito.Mockito.doReturn;
Expand All @@ -21,6 +23,8 @@

@RunWith(MockitoJUnitRunner.class)
public class ManuallyEnteredRepositorySourceTest {

public static final String EXPANDED = "expanded";
@Mock(answer = Answers.RETURNS_MOCKS)
private Run run;

Expand All @@ -30,6 +34,9 @@ public class ManuallyEnteredRepositorySourceTest {
@Mock(answer = Answers.RETURNS_MOCKS)
private PrintStream logger;

@Mock(answer = Answers.RETURNS_MOCKS)
private EnvVars env;

@Test
public void nullName() {
ManuallyEnteredRepositorySource instance = spy(new ManuallyEnteredRepositorySource("a"));
Expand All @@ -39,4 +46,15 @@ public void nullName() {
verify(listener).getLogger();
verify(logger).printf(eq("Unable to match %s with a GitHub repository.%n"), eq("a"));
}

@Test
public void shouldExpandRepositorySource() {
when(run.getEnvironment(listener)).thenReturn(env);
when(env.expand(ArgumentMatchers.anyString())).thenReturn(EXPANDED);

List<String> repos = new ManuallyEnteredRepositorySource("").repos(run, listener);
assertThat("size", repos.size(), 1);
assertThat("size", repos[0], EXPANDED);
}

}
2 changes: 1 addition & 1 deletion src/test/java/org/jenkinsci/plugins/github/status/sources/ManuallyEnteredSourcesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ public void shouldExpandBackref() throws Exception {
String context = new ManuallyEnteredBackrefSource("").get(run, listener);
assertThat(context, equalTo(EXPANDED));
}
}
}