Merge pull request #6 from sandvikcode/develop

Updated names and improved error handling

Author: ronanbarrett

README.md

@@ -1,27 +1,51 @@
-# flames-library-mockserver-client
+# mockserver-client-go
 
 The mockserver client is a golang client for use with the fantastic http://www.mock-server.com/ HTTP mock server.
 
 Usage:
-* Import the library `import "github.com/sandvikcode/flames-library-mockserver-client/pkg/mock"`
+* Import the library `import "github.com/sandvikcode/mockserver-client-go/pkg/mockclient"`
 
-Example:
+Create an expectation example:
 ```
-mockServer := mock.Client{
+mockServer := mockclient.Client{
     T: t, 
-    BaseURL: os.Getenv("MOCKSERVER_HOST")
+    BaseURL: os.Getenv("MOCKSERVER_HOST"),
 }
 
 mockServer.AddExpectation(
-    mock.CreateExpectation(
-        mock.WhenRequestPath("/(.*)"),
-        mock.ThenResponseStatus(http.StatusOK),
+    mockclient.CreateExpectation(
+        mockclient.WhenRequestPath("/(.*)"),
+        mockclient.ThenResponseStatus(http.StatusOK),
     ))
 
 defer mockServer.Clear("/(.*)")
 ```
 
+Create a verification example:
+```
+mockServer := mockclient.Client{
+    T: t, 
+    BaseURL: os.Getenv("MOCKSERVER_HOST"),
+}
+
+mockServer.AddVerification(
+    mockclient.CreateVerification(
+        mockclient.WhenRequestPath("/v1/jobs/(.*)"),
+        mockclient.ThenAtLeastCalls(2),
+        mockclient.ThenAtMostCalls(4),
+    ))
+```
+
+Expectation Defaults:
+* unlimited calls will respond to a match
+* calls are not delayed
+* status of matched calls is 200 OK
+
+Verification Defaults:
+* matched request occurs once i.e. at 1 least call and at most 1 call 
+
 Links:
 * Expectations - http://www.mock-server.com/mock_server/creating_expectations.html
 * Verifications - http://www.mock-server.com/mock_server/verification.html
 * Clearing & Resetting http://www.mock-server.com/mock_server/clearing_and_resetting.html
+

pkg/mock/client.go pkg/mockclient/client.gopkg/mock/client.go renamed to pkg/mockclient/client.go

@@ -1,15 +1,17 @@
-package mock
+package mockclient
 
 import (
 	"encoding/json"
 	"fmt"
+	"io/ioutil"
 	"testing"
 	"time"
 
 	"net/http"
 	"net/url"
 	"strings"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
@@ -91,11 +93,18 @@ func (c *Client) callMock(mockAPI, mockReqBody string) {
 	}
 	mockRes, err := hc.Do(mockReq)
 	if err != nil {
-		require.NoError(c.T, err, "Failed to send request to mock server.")
+		require.NoError(c.T, err, "Failed to send request to MockServer.")
 	}
-	// MockServer verification returns 202 on success and 406 on failure
-	if mockRes.StatusCode != http.StatusAccepted {
-		require.NoError(c.T, err,
-			fmt.Sprintf("Mock server verification did not meet expectations and failed with status: %s", mockRes.Status))
+
+	// all went well so return (clears & /reset return 200 whilst /verify & /expectation return 201)
+	if mockRes.StatusCode >= 200 && mockRes.StatusCode <= 299 {
+		return
+	}
+
+	// something went wrong so return the error message (Note: MockServer /verify returns 406 on failure)
+	b, err := ioutil.ReadAll(mockRes.Body)
+	if err != nil {
+		assert.Fail(c.T, fmt.Sprintf("MockServer call failed with status: %s", mockRes.Status))
 	}
+	assert.Fail(c.T, fmt.Sprintf("MockServer call to /%s failed with status: %s. Error message from MockServer is: %s", mockAPI, mockRes.Status, string(b)))
 }

pkg/mock/expectations.go pkg/mockclient/expectations.gopkg/mock/expectations.go renamed to pkg/mockclient/expectations.go

@@ -1,4 +1,4 @@
-package mock
+package mockclient
 
 import (
 	"fmt"

pkg/mock/expectations_test.go pkg/mockclient/expectations_test.gopkg/mock/expectations_test.go renamed to pkg/mockclient/expectations_test.go

@@ -1,4 +1,4 @@
-package mock
+package mockclient
 
 import (
 	"encoding/json"

pkg/mock/verifications.go pkg/mockclient/verifications.gopkg/mock/verifications.go renamed to pkg/mockclient/verifications.go

@@ -1,4 +1,4 @@
-package mock
+package mockclient
 
 // VerificationSequence defines a specific sequence of calls to MockServer
 type VerificationSequence struct {
@@ -13,7 +13,7 @@ func CreateVerification(opts ...ExpectationOption) *Expectation {
 			Path: "/(.*)",
 		},
 		Times: &Times{
-			AtLeast:  1,
+			AtLeast: 1,
 			AtMost:  1,
 		},
 	}

pkg/mock/verifications_test.go pkg/mockclient/verifications_test.gopkg/mock/verifications_test.go renamed to pkg/mockclient/verifications_test.go

@@ -1,4 +1,4 @@
-package mock
+package mockclient
 
 import (
 	"encoding/json"