Merge pull request #6 from FortnoxAB/bugfix/prettier-logging

Make logoutput more helpful

Author: tsfcode

go.mod

@@ -1,6 +1,6 @@
 module github.com/fortnoxab/gohtmock
 
-go 1.24
+go 1.21
 
 require github.com/stretchr/testify v1.8.0
 

mock.go

@@ -6,6 +6,7 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"slices"
+	"strings"
 	"sync"
 	"testing"
 
@@ -32,6 +33,7 @@ func New() *Mock {
 func (m *Mock) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	method := r.Method
 	path := r.URL.Path
+	mapKey := method + " " + path
 	var mr *mockResponse
 	m.Lock()
 	defer m.Unlock()
@@ -65,7 +67,7 @@ func (m *Mock) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	if mr == nil {
 		w.WriteHeader(http.StatusNotFound)
 		fmt.Fprintf(w, "%s not found", path)
-		m.unmockedRequests[method+path]++
+		m.unmockedRequests[mapKey]++
 		return
 	}
 
@@ -283,6 +285,7 @@ func (m *Mock) AssertCallCountAsserted(tb testing.TB) {
 	for _, mr := range m.mockResponses {
 		if !mr.asserted {
 			tb.Errorf("url: %s is mocked but never asserted. It was called %d times", mr.path, mr.callCount)
+			tb.Errorf(`create a mock with: .AssertCallCount(t, "%s", "%s", %d)`, mr.method, mr.path, mr.callCount)
 		}
 	}
 }
@@ -293,8 +296,17 @@ func (m *Mock) AssertNoMissingMocks(tb testing.TB) {
 	m.Lock()
 	defer m.Unlock()
 
-	for url, cnt := range m.unmockedRequests {
-		tb.Errorf("url: %s is called but not mocked. It was called %d times", url, cnt)
+	for request, cnt := range m.unmockedRequests {
+		method := strings.Split(request, " ")[0]
+		url := strings.Split(request, " ")[1]
+		tb.Errorf("url: %s is called but not mocked. It was called %d times", request, cnt)
+		if method == "GET" {
+			tb.Errorf(`create a mock with: .Mock("%s", "response")`, url)
+			continue
+
+		}
+		tb.Errorf(`create a mock with: .Mock("%s", "response").SetMethod("%s")`, url, method)
+
 	}
 }
 

mock_test.go

@@ -96,9 +96,9 @@ func TestMockResponderWithFilters(t *testing.T) {
 		return r.URL.Query().Get("id") == "2"
 	})
 
-	assertGetResults(t, mock.URL()+"/test?id=1", "user 1", http.StatusOK)
-	assertGetResults(t, mock.URL()+"/test?id=3", "user not found", http.StatusNotFound)
-	assertGetResults(t, mock.URL()+"/test?id=2", "user 2", http.StatusOK)
+	assertBodyAndStatus(t, mock.URL()+"/test?id=1", "user 1", http.StatusOK)
+	assertBodyAndStatus(t, mock.URL()+"/test?id=3", "user not found", http.StatusNotFound)
+	assertBodyAndStatus(t, mock.URL()+"/test?id=2", "user 2", http.StatusOK)
 	mock.AssertCallCount(t, http.MethodGet, "/test", 3)
 	mock.AssertCallCountAsserted(t)
 }
@@ -127,9 +127,9 @@ func TestMockResponderWithFiltersAsserts(t *testing.T) {
 		w.Write([]byte("user not found"))
 	})
 
-	assertGetResults(t, mock.URL()+"/test?id=1", "user 1", http.StatusOK)
-	assertGetResults(t, mock.URL()+"/test?id=3", "user not found", http.StatusNotFound)
-	assertGetResults(t, mock.URL()+"/test?id=2", "user 2", http.StatusOK)
+	assertBodyAndStatus(t, mock.URL()+"/test?id=1", "user 1", http.StatusOK)
+	assertBodyAndStatus(t, mock.URL()+"/test?id=3", "user not found", http.StatusNotFound)
+	assertBodyAndStatus(t, mock.URL()+"/test?id=2", "user 2", http.StatusOK)
 	mr1.AssertCallCount(t, 1)
 	mr2.AssertCallCount(t, 1)
 	mr3.AssertCallCount(t, 1)
@@ -143,9 +143,9 @@ func TestAllMocksLimits(t *testing.T) {
 	mock.Mock("/test", "once").Once()
 	mock.Mock("/test", "times").Times(2)
 
-	assertGetResults(t, mock.URL()+"/test", "once", http.StatusOK)
-	assertGetResults(t, mock.URL()+"/test", "times", http.StatusOK)
-	assertGetResults(t, mock.URL()+"/test", "times", http.StatusOK)
+	assertBodyAndStatus(t, mock.URL()+"/test", "once", http.StatusOK)
+	assertBodyAndStatus(t, mock.URL()+"/test", "times", http.StatusOK)
+	assertBodyAndStatus(t, mock.URL()+"/test", "times", http.StatusOK)
 	mock.AssertCallCount(t, "GET", "/test", 3)
 	mock.AssertCallCountAsserted(t)
 	mock.AssertNoMissingMocks(t)
@@ -192,18 +192,14 @@ func TestNotAssertNoMissingMocks(t *testing.T) {
 	assert.True(t, newT.Failed())
 }
 
-func assertGetResults(t *testing.T, path, expBody string, expStatus int) bool {
+func assertBodyAndStatus(t *testing.T, path, expBody string, expStatus int) bool {
 	resp, err := http.Get(path)
 	assert.NoError(t, err)
-	if !assert.Equal(t, expStatus, resp.StatusCode) {
-		return assert.Fail(t, "Expected status %s but got %s", expStatus, resp.StatusCode)
-	}
+	assert.Equal(t, expStatus, resp.StatusCode, "Expected status %d but got %d", expStatus, resp.StatusCode)
 
 	body, err := io.ReadAll(resp.Body)
 	assert.NoError(t, err)
-	if !assert.Equal(t, expBody, string(body)) {
-		return assert.Fail(t, "Expected body %s but got %s", expBody, string(body))
-	}
+	assert.Equal(t, expBody, string(body), "Expected body %s but got %s", expBody, string(body))
 
 	return true
 }