Package org.kohsuke.github

Class AbstractGitHubWireMockTest

java.lang.Object

org.kohsuke.github.AbstractGitHubWireMockTest

Direct Known Subclasses:

AbstractGHAppInstallationTest, AbuseLimitHandlerTest, AppTest, CommitTest, EnumTest, GHAppTest, GHBranchProtectionTest, GHBranchTest, GHContentIntegrationTest, GHDeploymentTest, GHDiscussionTest, GHEventPayloadTest, GHGistTest, GHGistUpdaterTest, GHIssueEventAttributeTest, GHIssueEventTest, GHLicenseTest, GHMarketplacePlanTest, GHMilestoneTest, GHObjectTest, GHOrganizationTest, GHPersonTest, GHProjectCardTest, GHProjectColumnTest, GHProjectTest, GHPullRequestTest, GHRateLimitTest, GHReleaseTest, GHRepositoryStatisticsTest, GHRepositoryTest, GHTagTest, GHTeamBuilderTest, GHTeamTest, GHTreeBuilderTest, GHUserTest, GHVerificationReasonTest, GHWorkflowRunTest, GHWorkflowTest, Github2faTest, GitHubCachingTest, GitHubCachingTest, GitHubConnectionTest, GitHubStaticTest, GitHubTest, JWTTokenProviderTest, LifecycleTest, OkHttpConnectorTest, OkHttpConnectorTest, RateLimitCheckerTest, RateLimitHandlerTest, RepositoryTrafficTest, RequesterRetryTest, WireMockStatusReporterTest

public abstract class AbstractGitHubWireMockTest
extends Object

Author:

Liam Newman

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractGitHubWireMockTest.TemplatingHelper

Field Summary

Fields

Modifier and Type	Field	Description
protected String	baseFilesClassPath
protected String	baseRecordPath
protected GitHub	gitHub	GitHub instance for use during test.
GitHubWireMockRule	mockGitHub
protected Set<String>	tempGitHubRepositories
protected AbstractGitHubWireMockTest.TemplatingHelper	templating
protected boolean	useDefaultGitHub

Constructor Summary

Constructors

Constructor	Description
AbstractGitHubWireMockTest()

Method Summary

Modifier and Type	Method	Description
static void	assertThat(String reason, boolean assertion)
static <T> void	assertThat(String reason, T actual, org.hamcrest.Matcher<? super T> matcher)
static <T> void	assertThat(T actual, org.hamcrest.Matcher<? super T> matcher)
protected void	cleanupRepository(String fullName)
void	cleanupTempRepositories()
static void	fail()
static void	fail(String reason)
protected GitHubBuilder	getGitHubBuilder()
GitHub	getNonRecordingGitHub()	GitHub instance for use before/after test.
protected GHRepository	getTempRepository()	Creates a temporary repository that will be deleted at the end of the test.
protected GHRepository	getTempRepository(String name)	Creates a temporary repository that will be deleted at the end of the test.
protected GHUser	getUser()
protected static GHUser	getUser(GitHub gitHub)
protected com.github.tomakehurst.wiremock.core.WireMockConfiguration	getWireMockOptions()
protected void	kohsuke()
protected void	requireProxy(String reason)
protected void	snapshotNotAllowed()
protected void	verifyAuthenticated(GitHub instance)
void	wireMockSetup()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

useDefaultGitHub

protected boolean useDefaultGitHub

tempGitHubRepositories

protected final Set<String> tempGitHubRepositories

gitHub

protected GitHub gitHub

GitHub instance for use during test. Traffic will be part of snapshot when taken.

baseFilesClassPath

protected final String baseFilesClassPath

baseRecordPath

protected final String baseRecordPath

mockGitHub

public final GitHubWireMockRule mockGitHub

templating

protected final AbstractGitHubWireMockTest.TemplatingHelper templating

Constructor Detail

AbstractGitHubWireMockTest

public AbstractGitHubWireMockTest()

Method Detail

getWireMockOptions

protected com.github.tomakehurst.wiremock.core.WireMockConfiguration getWireMockOptions()

getGitHubBuilder

protected GitHubBuilder getGitHubBuilder()

wireMockSetup

public void wireMockSetup()
                   throws Exception

Throws:

Exception

snapshotNotAllowed

protected void snapshotNotAllowed()

requireProxy

protected void requireProxy(String reason)

verifyAuthenticated

protected void verifyAuthenticated(GitHub instance)

getUser

protected GHUser getUser()

getUser

protected static GHUser getUser(GitHub gitHub)

getTempRepository

protected GHRepository getTempRepository()
                                  throws IOException

Creates a temporary repository that will be deleted at the end of the test. Repository name is based on the current test method.

Returns:

a temporary repository

Throws:

IOException - if repository could not be created or retrieved.

getTempRepository

protected GHRepository getTempRepository(String name)
                                  throws IOException

Creates a temporary repository that will be deleted at the end of the test.

Parameters:

name - string name of the the repository

Returns:

a temporary repository

Throws:

IOException - if repository could not be created or retrieved.

cleanupTempRepositories

public void cleanupTempRepositories()
                             throws IOException

Throws:

IOException

cleanupRepository

protected void cleanupRepository(String fullName)
                          throws IOException

Throws:

IOException

getNonRecordingGitHub

public GitHub getNonRecordingGitHub()

GitHub instance for use before/after test. Traffic will not be part of snapshot when taken. Should only be used when isUseProxy() or isTakeSnapShot().

Returns:

a github instance after checking Authentication

kohsuke

protected void kohsuke()

fail

public static void fail()

fail

public static void fail(String reason)

assertThat

public static <T> void assertThat(T actual,
                                  org.hamcrest.Matcher<? super T> matcher)

assertThat

public static <T> void assertThat(String reason,
                                  T actual,
                                  org.hamcrest.Matcher<? super T> matcher)

assertThat

public static void assertThat(String reason,
                              boolean assertion)