Module org.kohsuke.github.api

Package org.kohsuke.github.extras.okhttp3

Class OkHttpGitHubConnectorTest

java.lang.Object

org.kohsuke.github.AbstractGitHubWireMockTest

org.kohsuke.github.extras.okhttp3.OkHttpGitHubConnectorTest

public class OkHttpGitHubConnectorTest
extends AbstractGitHubWireMockTest

Test showing the behavior of OkHttpGitHubConnector 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
OkHttpGitHubConnectorTest()	Instantiates a new ok http git hub connector test.

Method Summary

Modifier and Type	Method	Description
void	DefaultConnector()	Default connector.
void	deleteCache()	Delete cache.
protected com.github.tomakehurst.wiremock.core.WireMockConfiguration	getWireMockOptions()	Gets the wire mock options.
void	OkHttpConnector_Cache_MaxAge_Three()	Ok http connector cache max age three.
void	OkHttpConnector_Cache_MaxAgeDefault_Zero()	Ok http connector cache max age default zero.
void	OkHttpConnector_Cache_MaxAgeNone()	Ok http connector cache max age none.
void	OkHttpConnector_NoCache()	Ok http connector no cache.
void	setupRepo()	Setup repo.

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 Details

OkHttpGitHubConnectorTest

public OkHttpGitHubConnectorTest()

Instantiates a new ok http git hub connector test.

Method Details

getWireMockOptions

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

Gets the wire mock options.

Overrides:

getWireMockOptions in class AbstractGitHubWireMockTest

Returns:

the wire mock options

setupRepo

public void setupRepo()
               throws Exception

Setup repo.

Throws:

Exception - the exception

deleteCache

public void deleteCache()
                 throws IOException

Delete cache.

Throws:

IOException - Signals that an I/O exception has occurred.

DefaultConnector

public void DefaultConnector()
                      throws Exception

Default connector.

Throws:

Exception - the exception

OkHttpConnector_NoCache

public void OkHttpConnector_NoCache()
                             throws Exception

Ok http connector no cache.

Throws:

Exception - the exception

OkHttpConnector_Cache_MaxAgeNone

public void OkHttpConnector_Cache_MaxAgeNone()
                                      throws Exception

Ok http connector cache max age none.

Throws:

Exception - the exception

OkHttpConnector_Cache_MaxAge_Three

public void OkHttpConnector_Cache_MaxAge_Three()
                                        throws Exception

Ok http connector cache max age three.

Throws:

Exception - the exception

OkHttpConnector_Cache_MaxAgeDefault_Zero

public void OkHttpConnector_Cache_MaxAgeDefault_Zero()
                                              throws Exception

Ok http connector cache max age default zero.

Throws:

Exception - the exception