mockhttp

README

gomockhttp

A fluent testing library for mocking http apis.

• Mock the external http apis your code is calling.
• Verify/assert the calls your code performed

Getting started

Create the API mock

func TestApiCall(t *testing.T) {
  api := mockhttp.Api(t)
  defer func() { api.Close() }()
  //...
}

Stub endpoints

api.
  Stub(http.MethodGet, "/endpoint").
  WithJson(http.StatusOK, jsonStub).

  Stub(http.MethodPost, "/endpoint").
  WithStatusCode(http.StatusCreated)

Call the mocked API

resultBasedOnMockedResponses, err := codeCallingTheApi(api.GetUrl())

Verify the API invocations

calls := api.
  Verify(http.MethodPost, "/endpoint").
  HasBeenCalled(2)

expectCall1 := calls[0]
expectCall1.WithPayload(expectedPayload1)

expectCall2 := calls[1]
expectCall2.WithPayload(expectedPayload2)

Example

package main

import (
  "github.com/le-yams/gomockhttp"
  "fmt"
  "net/http"
  "testing"
)

type FooDto struct {
  Foo string `json:"foo"`
}

func TestApiCall(t *testing.T) {
  // Arrange
  api := mockhttp.Api(t)
  defer func() { api.Close() }()

  api.
    Stub(http.MethodGet, "/foo").
    WithJson(http.StatusOK, &FooDto{Foo: "bar"})
  token := "testToken"

  //Act
  fooService := NewFooService(api.GetUrl(), token)
  foo := fooService.GetFoo() // the code actually making the http call to the api endpoint

  // Assert
  if foo != "bar" {
    t.Errorf("unexpected value: %s\n", foo)
  }

  api.
    Verify(http.MethodGet, "/foo").
    HasBeenCalledOnce().
    WithHeader("Authorization", fmt.Sprintf("Bearer %s", token))
}

Documentation

Index

• type APIMock
  • func API(testState TestingT) *APIMock
  • func (mockedAPI *APIMock) Close()
  • func (mockedAPI *APIMock) GetHost() string
  • func (mockedAPI *APIMock) GetURL() *url.URL
  • func (mockedAPI *APIMock) Stub(method string, path string) *StubBuilder
  • func (mockedAPI *APIMock) Verify(method string, path string) *CallVerifier
• type CallVerifier
  • func (verifier *CallVerifier) HasBeenCalled(expectedCallsCount int) []*Invocation
  • func (verifier *CallVerifier) HasBeenCalledOnce() *Invocation
• type HTTPCall
• type Invocation
  • func (call *Invocation) GetPayload() []byte
  • func (call *Invocation) GetRequest() *http.Request
  • func (call *Invocation) ReadJSONPayload(obj any)
  • func (call *Invocation) WithHeader(name string, expectedValues ...string) *Invocation
  • func (call *Invocation) WithPayload(expected []byte) *Invocation
  • func (call *Invocation) WithStringPayload(expected string) *Invocation
  • func (call *Invocation) WithUrlEncodedFormPayload() *InvocationRequestForm
  • func (call *Invocation) WithoutHeader(name string) *Invocation
• type InvocationRequestForm
  • func (form InvocationRequestForm) WithValues(expectedValues map[string]string)
  • func (form InvocationRequestForm) WithValuesExactly(expectedValues map[string]string)
• type StubBuilder
  • func (stub *StubBuilder) With(handler http.HandlerFunc) *APIMock
  • func (stub *StubBuilder) WithBody(statusCode int, body []byte, contentType string) *APIMock
  • func (stub *StubBuilder) WithJSON(statusCode int, content interface{}) *APIMock
  • func (stub *StubBuilder) WithStatusCode(statusCode int) *APIMock
• type TestingT

Types

type APIMock

type APIMock struct {
	// contains filtered or unexported fields
}

func API

func API(testState TestingT) *APIMock

func (*APIMock) Close

func (mockedAPI *APIMock) Close()

func (*APIMock) GetHost

func (mockedAPI *APIMock) GetHost() string

func (*APIMock) GetURL

func (mockedAPI *APIMock) GetURL() *url.URL

func (*APIMock) Stub

func (mockedAPI *APIMock) Stub(method string, path string) *StubBuilder

func (*APIMock) Verify

func (mockedAPI *APIMock) Verify(method string, path string) *CallVerifier

type CallVerifier

type CallVerifier struct {
	// contains filtered or unexported fields
}

func (*CallVerifier) HasBeenCalled

func (verifier *CallVerifier) HasBeenCalled(expectedCallsCount int) []*Invocation

func (*CallVerifier) HasBeenCalledOnce

func (verifier *CallVerifier) HasBeenCalledOnce() *Invocation

type HTTPCall

type HTTPCall struct {
	Method string
	Path   string
}

type Invocation

type Invocation struct {
	// contains filtered or unexported fields
}

func (*Invocation) GetPayload

func (call *Invocation) GetPayload() []byte

func (*Invocation) GetRequest

func (call *Invocation) GetRequest() *http.Request

func (*Invocation) ReadJSONPayload

func (call *Invocation) ReadJSONPayload(obj any)

func (*Invocation) WithHeader

func (call *Invocation) WithHeader(name string, expectedValues ...string) *Invocation

func (*Invocation) WithPayload

func (call *Invocation) WithPayload(expected []byte) *Invocation

func (*Invocation) WithStringPayload

func (call *Invocation) WithStringPayload(expected string) *Invocation

func (*Invocation) WithUrlEncodedFormPayload

func (call *Invocation) WithUrlEncodedFormPayload() *InvocationRequestForm

func (*Invocation) WithoutHeader

func (call *Invocation) WithoutHeader(name string) *Invocation

type InvocationRequestForm

type InvocationRequestForm struct {
	// contains filtered or unexported fields
}

func (InvocationRequestForm) WithValues

func (form InvocationRequestForm) WithValues(expectedValues map[string]string)

func (InvocationRequestForm) WithValuesExactly

func (form InvocationRequestForm) WithValuesExactly(expectedValues map[string]string)

type StubBuilder

type StubBuilder struct {
	// contains filtered or unexported fields
}

func (*StubBuilder) With

func (stub *StubBuilder) With(handler http.HandlerFunc) *APIMock

func (*StubBuilder) WithBody

func (stub *StubBuilder) WithBody(statusCode int, body []byte, contentType string) *APIMock

func (*StubBuilder) WithJSON

func (stub *StubBuilder) WithJSON(statusCode int, content interface{}) *APIMock

func (*StubBuilder) WithStatusCode

func (stub *StubBuilder) WithStatusCode(statusCode int) *APIMock

type TestingT

type TestingT interface {
	Error(args ...any)
	Errorf(format string, args ...any)
	Fatal(args ...any)
	Fatalf(format string, args ...any)
}

TestingT is an interface wrapper around *testing.T.