mirror of
https://github.com/jlengrand/github-api.git
synced 2026-03-10 08:21:21 +00:00
287 lines
13 KiB
Java
287 lines
13 KiB
Java
package org.kohsuke.github;
|
|
|
|
import org.junit.Assume;
|
|
import org.junit.Test;
|
|
import org.kohsuke.github.authorization.AuthorizationProvider;
|
|
import org.kohsuke.github.authorization.UserAuthorizationProvider;
|
|
|
|
import java.io.IOException;
|
|
import java.lang.reflect.Field;
|
|
import java.util.Collections;
|
|
import java.util.HashMap;
|
|
import java.util.Map;
|
|
|
|
import static org.hamcrest.Matchers.*;
|
|
|
|
/**
|
|
* Unit test for {@link GitHub}.
|
|
*/
|
|
public class GitHubConnectionTest extends AbstractGitHubWireMockTest {
|
|
|
|
public GitHubConnectionTest() {
|
|
useDefaultGitHub = false;
|
|
}
|
|
|
|
@Test
|
|
public void testOffline() throws Exception {
|
|
GitHub hub = GitHub.offline();
|
|
assertThat(GitHubRequest.getApiURL(hub.getClient().getApiUrl(), "/test").toString(),
|
|
equalTo("https://api.github.invalid/test"));
|
|
assertThat(hub.isAnonymous(), is(true));
|
|
try {
|
|
hub.getRateLimit();
|
|
fail("Offline instance should always fail");
|
|
} catch (IOException e) {
|
|
assertThat(e.getMessage(), equalTo("Offline"));
|
|
}
|
|
}
|
|
|
|
@Test
|
|
public void testGitHubServerWithHttp() throws Exception {
|
|
GitHub hub = GitHub.connectToEnterprise("http://enterprise.kohsuke.org/api/v3", "bogus", "bogus");
|
|
assertThat(GitHubRequest.getApiURL(hub.getClient().getApiUrl(), "/test").toString(),
|
|
equalTo("http://enterprise.kohsuke.org/api/v3/test"));
|
|
}
|
|
|
|
@Test
|
|
public void testGitHubServerWithHttps() throws Exception {
|
|
GitHub hub = GitHub.connectToEnterprise("https://enterprise.kohsuke.org/api/v3", "bogus", "bogus");
|
|
assertThat(GitHubRequest.getApiURL(hub.getClient().getApiUrl(), "/test").toString(),
|
|
equalTo("https://enterprise.kohsuke.org/api/v3/test"));
|
|
}
|
|
|
|
@Test
|
|
public void testGitHubServerWithoutServer() throws Exception {
|
|
GitHub hub = GitHub.connectUsingPassword("kohsuke", "bogus");
|
|
assertThat(GitHubRequest.getApiURL(hub.getClient().getApiUrl(), "/test").toString(),
|
|
equalTo("https://api.github.com/test"));
|
|
}
|
|
|
|
@Test
|
|
public void testGitHubBuilderFromEnvironment() throws IOException {
|
|
// we disable this test for JDK 16+ as the current hacks in setupEnvironment() don't work with JDK 16+
|
|
Assume.assumeThat(Double.valueOf(System.getProperty("java.specification.version")), lessThan(16.0));
|
|
|
|
Map<String, String> props = new HashMap<String, String>();
|
|
|
|
props.put("endpoint", "bogus endpoint url");
|
|
props.put("oauth", "bogus oauth token string");
|
|
setupEnvironment(props);
|
|
GitHubBuilder builder = GitHubBuilder.fromEnvironment();
|
|
|
|
assertThat(builder.endpoint, equalTo("bogus endpoint url"));
|
|
|
|
assertThat(builder.authorizationProvider, instanceOf(UserAuthorizationProvider.class));
|
|
assertThat(builder.authorizationProvider.getEncodedAuthorization(), equalTo("token bogus oauth token string"));
|
|
assertThat(((UserAuthorizationProvider) builder.authorizationProvider).getLogin(), nullValue());
|
|
|
|
props.put("login", "bogus login");
|
|
setupEnvironment(props);
|
|
builder = GitHubBuilder.fromEnvironment();
|
|
|
|
assertThat(builder.authorizationProvider, instanceOf(UserAuthorizationProvider.class));
|
|
assertThat(builder.authorizationProvider.getEncodedAuthorization(), equalTo("token bogus oauth token string"));
|
|
assertThat(((UserAuthorizationProvider) builder.authorizationProvider).getLogin(), equalTo("bogus login"));
|
|
|
|
props.put("jwt", "bogus jwt token string");
|
|
setupEnvironment(props);
|
|
builder = GitHubBuilder.fromEnvironment();
|
|
|
|
assertThat(builder.authorizationProvider, not(instanceOf(UserAuthorizationProvider.class)));
|
|
assertThat(builder.authorizationProvider.getEncodedAuthorization(), equalTo("Bearer bogus jwt token string"));
|
|
|
|
props.put("password", "bogus weak password");
|
|
setupEnvironment(props);
|
|
builder = GitHubBuilder.fromEnvironment();
|
|
|
|
assertThat(builder.authorizationProvider, instanceOf(UserAuthorizationProvider.class));
|
|
assertThat(builder.authorizationProvider.getEncodedAuthorization(),
|
|
equalTo("Basic Ym9ndXMgbG9naW46Ym9ndXMgd2VhayBwYXNzd29yZA=="));
|
|
assertThat(((UserAuthorizationProvider) builder.authorizationProvider).getLogin(), equalTo("bogus login"));
|
|
|
|
}
|
|
|
|
@Test
|
|
public void testGitHubBuilderFromCustomEnvironment() throws IOException {
|
|
// we disable this test for JDK 16+ as the current hacks in setupEnvironment() don't work with JDK 16+
|
|
Assume.assumeThat(Double.valueOf(System.getProperty("java.specification.version")), lessThan(16.0));
|
|
|
|
Map<String, String> props = new HashMap<String, String>();
|
|
|
|
props.put("customEndpoint", "bogus endpoint url");
|
|
props.put("customOauth", "bogus oauth token string");
|
|
setupEnvironment(props);
|
|
GitHubBuilder builder = GitHubBuilder
|
|
.fromEnvironment("customLogin", "customPassword", "customOauth", "customEndpoint");
|
|
|
|
assertThat(builder.endpoint, equalTo("bogus endpoint url"));
|
|
|
|
assertThat(builder.authorizationProvider, instanceOf(UserAuthorizationProvider.class));
|
|
assertThat(builder.authorizationProvider.getEncodedAuthorization(), equalTo("token bogus oauth token string"));
|
|
assertThat(((UserAuthorizationProvider) builder.authorizationProvider).getLogin(), nullValue());
|
|
|
|
props.put("customLogin", "bogus login");
|
|
setupEnvironment(props);
|
|
builder = GitHubBuilder.fromEnvironment("customLogin", "customPassword", "customOauth", "customEndpoint");
|
|
|
|
assertThat(builder.authorizationProvider, instanceOf(UserAuthorizationProvider.class));
|
|
assertThat(builder.authorizationProvider.getEncodedAuthorization(), equalTo("token bogus oauth token string"));
|
|
assertThat(((UserAuthorizationProvider) builder.authorizationProvider).getLogin(), equalTo("bogus login"));
|
|
|
|
props.put("customPassword", "bogus weak password");
|
|
setupEnvironment(props);
|
|
builder = GitHubBuilder.fromEnvironment("customLogin", "customPassword", "customOauth", "customEndpoint");
|
|
|
|
assertThat(builder.authorizationProvider, instanceOf(UserAuthorizationProvider.class));
|
|
assertThat(builder.authorizationProvider.getEncodedAuthorization(),
|
|
equalTo("Basic Ym9ndXMgbG9naW46Ym9ndXMgd2VhayBwYXNzd29yZA=="));
|
|
assertThat(((UserAuthorizationProvider) builder.authorizationProvider).getLogin(), equalTo("bogus login"));
|
|
}
|
|
|
|
@Test
|
|
public void testGitHubBuilderFromCredentials() throws IOException {
|
|
// we disable this test for JDK 16+ as the current hacks in setupEnvironment() don't work with JDK 16+
|
|
Assume.assumeThat(Double.valueOf(System.getProperty("java.specification.version")), lessThan(16.0));
|
|
|
|
Map<String, String> props = new HashMap<String, String>();
|
|
|
|
props.put("endpoint", "bogus endpoint url");
|
|
props.put("oauth", "bogus oauth token string");
|
|
setupEnvironment(props);
|
|
GitHubBuilder builder = GitHubBuilder.fromCredentials();
|
|
|
|
assertThat(builder.endpoint, equalTo("bogus endpoint url"));
|
|
|
|
assertThat(builder.authorizationProvider, instanceOf(UserAuthorizationProvider.class));
|
|
assertThat(builder.authorizationProvider.getEncodedAuthorization(), equalTo("token bogus oauth token string"));
|
|
assertThat(((UserAuthorizationProvider) builder.authorizationProvider).getLogin(), nullValue());
|
|
|
|
props.put("login", "bogus login");
|
|
setupEnvironment(props);
|
|
builder = GitHubBuilder.fromCredentials();
|
|
|
|
assertThat(builder.authorizationProvider, instanceOf(UserAuthorizationProvider.class));
|
|
assertThat(builder.authorizationProvider.getEncodedAuthorization(), equalTo("token bogus oauth token string"));
|
|
assertThat(((UserAuthorizationProvider) builder.authorizationProvider).getLogin(), equalTo("bogus login"));
|
|
|
|
props.put("jwt", "bogus jwt token string");
|
|
setupEnvironment(props);
|
|
builder = GitHubBuilder.fromCredentials();
|
|
|
|
assertThat(builder.authorizationProvider, not(instanceOf(UserAuthorizationProvider.class)));
|
|
assertThat(builder.authorizationProvider.getEncodedAuthorization(), equalTo("Bearer bogus jwt token string"));
|
|
|
|
props.put("password", "bogus weak password");
|
|
setupEnvironment(props);
|
|
builder = GitHubBuilder.fromCredentials();
|
|
|
|
assertThat(builder.authorizationProvider, instanceOf(UserAuthorizationProvider.class));
|
|
assertThat(builder.authorizationProvider.getEncodedAuthorization(),
|
|
equalTo("Basic Ym9ndXMgbG9naW46Ym9ndXMgd2VhayBwYXNzd29yZA=="));
|
|
assertThat(((UserAuthorizationProvider) builder.authorizationProvider).getLogin(), equalTo("bogus login"));
|
|
}
|
|
|
|
@Test
|
|
public void testAnonymous() throws IOException {
|
|
// we disable this test for JDK 16+ as the current hacks in setupEnvironment() don't work with JDK 16+
|
|
Assume.assumeThat(Double.valueOf(System.getProperty("java.specification.version")), lessThan(16.0));
|
|
|
|
Map<String, String> props = new HashMap<String, String>();
|
|
|
|
props.put("endpoint", mockGitHub.apiServer().baseUrl());
|
|
setupEnvironment(props);
|
|
|
|
// No values present except endpoint
|
|
GitHubBuilder builder = GitHubBuilder
|
|
.fromEnvironment("customLogin", "customPassword", "customOauth", "endpoint");
|
|
|
|
assertThat(builder.endpoint, equalTo(mockGitHub.apiServer().baseUrl()));
|
|
assertThat(builder.authorizationProvider, sameInstance(AuthorizationProvider.ANONYMOUS));
|
|
}
|
|
|
|
@Test
|
|
public void testGithubBuilderWithAppInstallationToken() throws Exception {
|
|
|
|
GitHubBuilder builder = new GitHubBuilder().withAppInstallationToken("bogus app token");
|
|
assertThat(builder.authorizationProvider, instanceOf(UserAuthorizationProvider.class));
|
|
assertThat(builder.authorizationProvider.getEncodedAuthorization(), equalTo("token bogus app token"));
|
|
assertThat(((UserAuthorizationProvider) builder.authorizationProvider).getLogin(), is(emptyString()));
|
|
|
|
// test authorization header is set as in the RFC6749
|
|
GitHub github = builder.build();
|
|
// change this to get a request
|
|
assertThat(github.getClient().getEncodedAuthorization(), equalTo("token bogus app token"));
|
|
assertThat(github.getClient().login, is(emptyString()));
|
|
}
|
|
|
|
@Test
|
|
public void testGitHubIsApiUrlValid() throws IOException {
|
|
// NOTE: We cannot test connectAnonymously on a general basis because it can hang if
|
|
// rate limit is reached. We connectToEnterpriseAnonymously as the nearest equivalent.
|
|
// GitHub hub = GitHub.connectAnonymously();
|
|
|
|
GitHub hub = GitHub.connectToEnterpriseAnonymously(mockGitHub.apiServer().baseUrl());
|
|
hub.checkApiUrlValidity();
|
|
try {
|
|
hub.checkApiUrlValidity();
|
|
fail();
|
|
} catch (IOException ioe) {
|
|
assertThat(ioe.getMessage(), containsString("doesn't look like GitHub API URL"));
|
|
}
|
|
try {
|
|
hub.checkApiUrlValidity();
|
|
fail();
|
|
} catch (IOException ioe) {
|
|
assertThat(ioe.getMessage(), containsString("private mode enabled"));
|
|
}
|
|
try {
|
|
hub.getClient().requireCredential();
|
|
fail();
|
|
} catch (Exception e) {
|
|
assertThat(e.getMessage(), containsString("This operation requires a credential"));
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Copied from StackOverflow: http://stackoverflow.com/a/7201825/2336755
|
|
*
|
|
* This allows changing the in memory process environment.
|
|
*
|
|
* Its used to wire in values for the github credentials to test that the GitHubBuilder works properly to resolve
|
|
* them.
|
|
*/
|
|
private void setupEnvironment(Map<String, String> newenv) {
|
|
try {
|
|
Class<?> processEnvironmentClass = Class.forName("java.lang.ProcessEnvironment");
|
|
Field theEnvironmentField = processEnvironmentClass.getDeclaredField("theEnvironment");
|
|
theEnvironmentField.setAccessible(true);
|
|
Map<String, String> env = (Map<String, String>) theEnvironmentField.get(null);
|
|
env.putAll(newenv);
|
|
Field theCaseInsensitiveEnvironmentField = processEnvironmentClass
|
|
.getDeclaredField("theCaseInsensitiveEnvironment");
|
|
theCaseInsensitiveEnvironmentField.setAccessible(true);
|
|
Map<String, String> cienv = (Map<String, String>) theCaseInsensitiveEnvironmentField.get(null);
|
|
cienv.putAll(newenv);
|
|
} catch (NoSuchFieldException e) {
|
|
try {
|
|
Class[] classes = Collections.class.getDeclaredClasses();
|
|
Map<String, String> env = System.getenv();
|
|
for (Class cl : classes) {
|
|
if ("java.util.Collections$UnmodifiableMap".equals(cl.getName())) {
|
|
Field field = cl.getDeclaredField("m");
|
|
field.setAccessible(true);
|
|
Object obj = field.get(env);
|
|
Map<String, String> map = (Map<String, String>) obj;
|
|
map.clear();
|
|
map.putAll(newenv);
|
|
}
|
|
}
|
|
} catch (Exception e2) {
|
|
e2.printStackTrace();
|
|
}
|
|
} catch (Exception e1) {
|
|
e1.printStackTrace();
|
|
}
|
|
}
|
|
}
|