mockhttp

README

gomockhttp

• 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 := httpmock.Api(t)
  //...
}

Stub endpoints

api.
  Stub(http.MethodGet, "/endpoint").
  WithOkJson(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)

Examples

package main

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

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

func TestApiCall(t *testing.T) {
	api := httpmock.Api(t)
	foo := NewFoo(api.GetUrl())

	api.Stub(http.MethodGet, "/foo").
		WithJson(http.StatusOK, &Foo{Bar: "bar"})

	bar := foo.GetBar() // the code to be tested calling the api endpoint to rerieve the value

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

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) WithoutHeader(name string) *Invocation
• type StubBuilder
  • func (stub *StubBuilder) With(handler http.HandlerFunc) *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) WithoutHeader

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

type StubBuilder

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

func (*StubBuilder) With

func (stub *StubBuilder) With(handler http.HandlerFunc) *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