Add way to record and mock http apis #39

kwhetstone · 2016-10-19T22:01:59Z

Added support for recording & mocking http responses with Wiremock. This particular rule allows a test to serve up prerendered files which correspond to particular api responses. If a response is not saved (trying to access an unmocked url), the test will fail. You can enable a "recording" mode in which you can run your test through on a live server and save the responses for later offline testing. The recordings are saved to /src/test/resources/ of whatever project uses this rule.

While the particular constructors I've included are the ones that have been the most useful to me, they too can be expanded. Other options for the server can be found on wiremock.org

@reviewbybees

ghost · 2016-10-19T22:17:22Z

This pull request originates from a CloudBees employee. At CloudBees, we require that all pull requests be reviewed by other CloudBees employees before we seek to have the change accepted. If you want to learn more about our process please see this explanation.

stephenc

I think you can make this easier to use

stephenc · 2016-10-20T12:34:32Z

src/main/java/org/jvnet/hudson/WireMockRuleFactory.java

+ * previously recorded mocks before generating new ones is recommended. 
+ */
+public class WireMockRuleFactory {
+    private String prop = System.getProperty("toRecord");


given that this property is completely under your own control, I would have this at least include wiremock, e.g. wiremock.record and I would use the same property name both for the system property as for the pom property

stephenc · 2016-10-20T12:38:14Z

src/main/java/org/jvnet/hudson/WireMockRuleFactory.java

+        //needed for WireMockRule file location
+        private String mappingLocation = "src/test/resources";
+
+        public WireMockRecorderRule(Options options, String url){


it would seem that the logical way to do this is have the wiremock.record property value be the URL to proxy... if the property is blank then no recording... if the property is non-blank, set up the recorder for the specified url. That makes running easier...

That's a good point. This would also allow you to potentially record a couple different servers over several different iterations of your tests.

Also fix the location of the Factory file.

kwhetstone · 2016-10-25T13:10:36Z

Thanks for the review @stephenc I've addressed your comments in a followup PR. They do make it easier to use this feature.

stephenc

🐝

recena · 2016-11-02T07:58:52Z

src/main/java/org/jvnet/hudson/test/WireMockRuleFactory.java

+public class WireMockRuleFactory {
+    private String urlToMock = System.getProperty("wiremock.record");
+
+    public WireMockRule getRule(int port){


public WireMockRule getRule(int port) {

At least, we should use the same rules in the file.

I'm not sure what you mean here? Are you talking about @Rule or including all the potential implementations of WireMockRule? The most common "short" form of creating a rule is by specifying a port, and for extreme flexibility, the Options constructor is included here.

@kwhetstone space between (int port) and { in order to apply the same rules in the file

recena · 2016-11-02T07:59:02Z

src/main/java/org/jvnet/hudson/test/WireMockRuleFactory.java

+        //needed for WireMockRule file location
+        private String mappingLocation = "src/test/resources";
+
+        public WireMockRecorderRule(Options options, String url){


kwhetstone · 2016-11-03T15:06:55Z

@reviewbybees done. If no one objects, this can be merged.

jglick · 2016-11-07T18:04:40Z

I presume that this was designed to simplify jenkinsci/github-branch-source-plugin#79, right? If so, can we see that PR updated to use a SNAPSHOT version of this PR? (mvn deploy for the benefit of CI)

jglick

🐝

jglick · 2016-11-07T18:01:41Z

src/main/java/org/jvnet/hudson/test/WireMockRuleFactory.java

+ *
+ * Point your system to "http://localhost:8089/" to see mocked responses.
+ *
+ * To record mocks: {@code mvn test -wiremock.record="http://api_url"}  Clearing 


Did you forget the D in -D?

kwhetstone · 2016-11-08T17:46:41Z

@jglick yes, it is.

jglick · 2016-11-21T15:02:45Z

pom.xml

+    <dependency>
+      <groupId>com.google.guava</groupId>
+      <artifactId>guava</artifactId>
+      <version>19.0</version>


You do not want to do this. It will clash with the Guava build in Jenkins core.

I need minimally guava-18.0 and the version we're pulling in through Jenkins core is guava-11.0.1. Not 100% sure how to work around this at the moment; I might have to rethink this.

Removed; using wiremock-standalone which will include all the pieces without conflicts.

stephenc · 2016-12-01T16:10:10Z

🐛 with the guava version conflict

stephenc · 2016-12-02T16:15:53Z

<dependency>
    <groupId>com.github.tomakehurst</groupId>
    <artifactId>wiremock-standalone</artifactId>
    <version>2.4.1</version>
</dependency>

looks to have all dependencies shaded

stephenc · 2016-12-02T16:18:36Z

src/main/java/org/jvnet/hudson/test/WireMockRuleFactory.java

+        public WireMockRecorderRule(Options options, String url) {
+            super(options);
+            this.stubFor(get(urlMatching(".*")).atPriority(10).willReturn(aResponse().proxiedFrom(url)));
+            this.enableRecordMappings(new SingleRootFileSource(mappingLocation + "/mappings"), new SingleRootFileSource(mappingLocation + "/__files"));


This likely will fail for multi-module projects where new File(".") is not the same directory as pom.xml

Sure, that could be added as a new option.

Gets around the guice dependency issues.

kwhetstone · 2016-12-09T08:11:18Z

I've updated the list to cover choosing a custom folder location. The mocks can be recorded from the command line as before. Since recording and mocking will read out of the same folder, no extra configuration is needed there.

stephenc · 2016-12-09T08:31:45Z

src/main/java/org/jvnet/hudson/test/WireMockRuleFactory.java

+        }
+
+        private void finshWireMockRuleSetup(WireMockConfiguration options, String url, String mappingLocation) {
+            this.stubFor(get(urlMatching(".*")).atPriority(10).willReturn(aResponse().proxiedFrom(url)));


Spelling of "Finish"

kwhetstone · 2016-12-13T15:05:54Z

I've made the requested changes. Thanks Jesse and Stephen for the feedback.

stephenc · 2016-12-13T15:11:25Z

src/main/java/org/jvnet/hudson/test/WireMockRuleFactory.java

+            return new WireMockRecorderRule(options, urlToMock, mapLoc);
+        } else {
+            return new WireMockRule(options
+               .usingFilesUnderClasspath(mapLoc));


This will not work the way you think if mapLoc is src/test/resources/mockLoc as you provide in the example javadoc

jglick · 2017-06-05T13:05:18Z

IIUC with jenkinsci/github-api-plugin#13 the intent is to move away from WireMock.

kwhetstone added 2 commits October 19, 2016 17:36

Add a feature to record and mock http apis.

0ad1b63

Remove test scope and guava dependency.

af15dfc

stephenc suggested changes Oct 20, 2016

View reviewed changes

Make it easier to use the recording feature.

008324c

Also fix the location of the Factory file.

stephenc approved these changes Nov 1, 2016

View reviewed changes

recena reviewed Nov 2, 2016

View reviewed changes

jglick approved these changes Nov 7, 2016

View reviewed changes

jglick mentioned this pull request Nov 8, 2016

Add offline support to the API to make parsing events easier hub4j/github-api#306

Merged

kwhetstone added 2 commits November 14, 2016 15:03

Formatting

ac00d56

Fix some formatting and explicit guava-19 depenency

426ce65

kwhetstone mentioned this pull request Nov 15, 2016

Test for GitHub pull requests jenkinsci/github-branch-source-plugin#79

Closed

jglick requested changes Nov 21, 2016

View reviewed changes

stephenc added the work-in-progress label Dec 1, 2016

stephenc reviewed Dec 2, 2016

View reviewed changes

Change to standalone dependency; upgrade.

99069a8

Gets around the guice dependency issues.

kwhetstone mentioned this pull request Dec 8, 2016

[JENKINS-39355] Using new multibranch APIs jenkinsci/github-branch-source-plugin#93

Merged

Add ability to define custom locations for mocks

a937f95

stephenc reviewed Dec 9, 2016

View reviewed changes

Spelling. ...

1a7da57

stephenc suggested changes Dec 13, 2016

View reviewed changes

kwhetstone closed this Jul 27, 2017

jglick mentioned this pull request Nov 7, 2017

[JENKINS-47113] Populate the authorities after a successful authentication to Github jenkinsci/github-oauth-plugin#87

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add way to record and mock http apis #39

Add way to record and mock http apis #39

kwhetstone commented Oct 19, 2016

ghost commented Oct 19, 2016

stephenc left a comment

stephenc Oct 20, 2016

stephenc Oct 20, 2016

kwhetstone Oct 20, 2016

kwhetstone commented Oct 25, 2016

stephenc left a comment

recena Nov 2, 2016

kwhetstone Nov 2, 2016

recena Nov 7, 2016

recena Nov 2, 2016

kwhetstone commented Nov 3, 2016

jglick commented Nov 7, 2016

jglick left a comment

jglick Nov 7, 2016

kwhetstone commented Nov 8, 2016

jglick Nov 21, 2016

kwhetstone Nov 30, 2016

kwhetstone Dec 8, 2016

stephenc commented Dec 1, 2016

stephenc commented Dec 2, 2016

stephenc Dec 2, 2016

kwhetstone Dec 8, 2016

kwhetstone commented Dec 9, 2016

stephenc Dec 9, 2016

kwhetstone Dec 12, 2016

kwhetstone commented Dec 13, 2016

stephenc Dec 13, 2016

jglick commented Jun 5, 2017

Add way to record and mock http apis #39

Add way to record and mock http apis #39

Conversation

kwhetstone commented Oct 19, 2016

ghost commented Oct 19, 2016

stephenc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kwhetstone commented Oct 25, 2016

stephenc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kwhetstone commented Nov 3, 2016

jglick commented Nov 7, 2016

jglick left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kwhetstone commented Nov 8, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stephenc commented Dec 1, 2016

stephenc commented Dec 2, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kwhetstone commented Dec 9, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kwhetstone commented Dec 13, 2016

Choose a reason for hiding this comment

jglick commented Jun 5, 2017