-
Notifications
You must be signed in to change notification settings - Fork 724
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #541 from bitwiseman/wiremock-github-rule
Add GitHubApiWireMockRule
- Loading branch information
Showing
8 changed files
with
171 additions
and
91 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
94 changes: 94 additions & 0 deletions
94
src/test/java/org/kohsuke/github/junit/GitHubApiWireMockRule.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| package org.kohsuke.github.junit; | ||
|
|
||
| import com.github.tomakehurst.wiremock.common.FileSource; | ||
| import com.github.tomakehurst.wiremock.core.Options; | ||
| import com.github.tomakehurst.wiremock.core.WireMockConfiguration; | ||
| import com.github.tomakehurst.wiremock.extension.Parameters; | ||
| import com.github.tomakehurst.wiremock.extension.ResponseTransformer; | ||
| import com.github.tomakehurst.wiremock.http.Request; | ||
| import com.github.tomakehurst.wiremock.http.Response; | ||
|
|
||
| import static com.github.tomakehurst.wiremock.client.WireMock.*; | ||
| import static com.github.tomakehurst.wiremock.client.WireMock.status; | ||
|
|
||
| /** | ||
| * @author Liam Newman | ||
| */ | ||
| public class GitHubApiWireMockRule extends WireMockRule { | ||
|
|
||
| // By default the wiremock tests will run without proxy or taking a snapshot. | ||
| // The tests will use only the stubbed data and will fail if requests are made for missing data. | ||
| // You can use the proxy without taking a snapshot while writing and debugging tests. | ||
| // You cannot take a snapshot without proxying. | ||
| private final static boolean takeSnapshot = System.getProperty("test.github.takeSnapshot", "false") != "false"; | ||
| private final static boolean useProxy = takeSnapshot || System.getProperty("test.github.useProxy", "false") != "false"; | ||
|
|
||
| public GitHubApiWireMockRule(WireMockConfiguration options) { | ||
| this(options, true); | ||
| } | ||
|
|
||
| public GitHubApiWireMockRule(WireMockConfiguration options, boolean failOnUnmatchedRequests) { | ||
| super(options | ||
| .extensions( | ||
| new ResponseTransformer() { | ||
| @Override | ||
| public Response transform(Request request, Response response, FileSource files, | ||
| Parameters parameters) { | ||
| if ("application/json" | ||
| .equals(response.getHeaders().getContentTypeHeader().mimeTypePart()) | ||
| && !response.getHeaders().getHeader("Content-Encoding").containsValue("gzip")) { | ||
| return Response.Builder.like(response) | ||
| .but() | ||
| .body(response.getBodyAsString() | ||
| .replace("https://api.github.com/", | ||
| "http://localhost:" + request.getPort() + "/") | ||
| ) | ||
| .build(); | ||
| } | ||
| return response; | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return "github-api-url-rewrite"; | ||
| } | ||
| }), | ||
| failOnUnmatchedRequests); | ||
| } | ||
|
|
||
| public boolean isUseProxy() { | ||
| return GitHubApiWireMockRule.useProxy; | ||
| } | ||
|
|
||
| public boolean isTakeSnapshot() { | ||
| return GitHubApiWireMockRule.takeSnapshot; | ||
| } | ||
|
|
||
| @Override | ||
| protected void before() { | ||
| super.before(); | ||
| if(isUseProxy()) { | ||
| this.stubFor( | ||
| proxyAllTo("https://api.github.com/") | ||
| .atPriority(100) | ||
| ); | ||
| } else { | ||
| // Just to be super clear | ||
| this.stubFor( | ||
| any(urlPathMatching(".*")) | ||
| .willReturn(status(500).withBody("Stubbed data not found. Set test.github.use-proxy to have WireMock proxy to github")) | ||
| .atPriority(100)); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected void after() { | ||
| super.after(); | ||
| if (isTakeSnapshot()) { | ||
| this.snapshotRecord(recordSpec() | ||
| .forTarget("https://api.github.com") | ||
| .captureHeader("If-None-Match") | ||
| .extractTextBodiesOver(255)); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.