Package org.kohsuke.github

Class GHRateLimitTest

java.lang.Object

org.kohsuke.github.AbstractGitHubWireMockTest

org.kohsuke.github.GHRateLimitTest

public class GHRateLimitTest
extends AbstractGitHubWireMockTest

Test showing the behavior of OkHttpConnector with and without cache.

Key take aways:

• These tests are artificial and intended to highlight the differences in behavior between scenarios. However, the differences they indicate are stark.
• Caching reduces rate limit consumption by at least a factor of two in even the simplest case.
• The OkHttp cache is pretty smart and will often connect read and write requests made on the same client and invalidate caches.
• Changes made outside the current client cause the OkHttp cache to return stale data. This is expected and correct behavior.
• "max-age=0" addresses the problem of external changes by revalidating caches for each request. This produces the same number of requests as OkHttp without caching, but those requests only count towards the GitHub rate limit if data has changes.

Author:

Liam Newman

Nested Class Summary

Nested classes/interfaces inherited from class org.kohsuke.github.AbstractGitHubWireMockTest

AbstractGitHubWireMockTest.TemplatingHelper

Field Summary

Fields inherited from class org.kohsuke.github.AbstractGitHubWireMockTest

baseFilesClassPath, baseRecordPath, gitHub, mockGitHub, tempGitHubRepositories, templating, useDefaultGitHub

Constructor Summary

Constructors

Constructor	Description
GHRateLimitTest()

Method Summary

Modifier and Type	Method	Description
protected com.github.tomakehurst.wiremock.core.WireMockConfiguration	getWireMockOptions()
void	testGitHubEnterpriseDoesNotHaveRateLimit()
void	testGitHubRateLimit()
void	testGitHubRateLimitExpirationServerFiveMinutesAhead()
void	testGitHubRateLimitExpirationServerFiveMinutesBehind()
void	testGitHubRateLimitWithBadData()

Methods inherited from class org.kohsuke.github.AbstractGitHubWireMockTest

assertThat, assertThat, assertThat, cleanupRepository, cleanupTempRepositories, fail, fail, getGitHubBuilder, getNonRecordingGitHub, getTempRepository, getTempRepository, getUser, getUser, kohsuke, requireProxy, snapshotNotAllowed, verifyAuthenticated, wireMockSetup

Methods inherited from class java.lang.Object

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

Constructor Detail

GHRateLimitTest

public GHRateLimitTest()

Method Detail

getWireMockOptions

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

Overrides:

getWireMockOptions in class AbstractGitHubWireMockTest

testGitHubRateLimit

public void testGitHubRateLimit()
                         throws Exception

Throws:

Exception

testGitHubEnterpriseDoesNotHaveRateLimit

public void testGitHubEnterpriseDoesNotHaveRateLimit()
                                              throws Exception

Throws:

Exception

testGitHubRateLimitWithBadData

public void testGitHubRateLimitWithBadData()
                                    throws Exception

Throws:

Exception

testGitHubRateLimitExpirationServerFiveMinutesAhead

public void testGitHubRateLimitExpirationServerFiveMinutesAhead()
                                                         throws Exception

Throws:

Exception

testGitHubRateLimitExpirationServerFiveMinutesBehind

public void testGitHubRateLimitExpirationServerFiveMinutesBehind()
                                                          throws Exception

Throws:

Exception