client

README

Client

It's an implementation of http.Client

You can use it to make requests to the server and easy to mock in tests using client_mock package.

Example of usage

repository.go:

type Repository struct {
  client Client
}

func New(client Client) *Repository {
  return &Repository{
    client: client,
  }
}

func (repo *Repository) CustomFunction(ctx context.Context, userName string) (string, error) {
  response, err := repo.client.Post(context.Background(), "http://test.com/users", []byte(userName), map[string]string{
    "Content-Type": "application/json",
  })
  if err != nil {
    return "", fmt.Errorf("error: %v", err)
  }
  return http.StatusText(response.StatusCode), nil
}

repository_test.go:

func TestCustomFunction(t *testing.T) {
  var (
    url      = "http://test.com/users"
    body     = []byte("test")
    err      error
    response = &http.Response{
      StatusCode: http.StatusOK,
    }
    headers = map[string]string{
      "Content-Type": "application/json",
    }

    mockedClient = client_mock.New()
    mockedRepo = New(mockedClient)
  )

  mockedClient.ExpectPost(url, body, err, response, headers)

  result, err := mockedRepo.CustomFunction(context.Background(), "test")
  if err != nil {
    t.Error(err)
  }

  if result != http.StatusText(http.StatusOK) {
    t.Errorf("not equal responses, expect %s, go %s", http.StatusText(http.StatusOK), result)
  }

  if err := mockedClient.AllExpectationsDone(); err != nil {
    t.Error(err)
  }
}

Documentation

Index

• Constants
• func GetIP(req *http.Request) string
• func SetTimeout(val time.Duration)
• func Timeout() time.Duration
• type Client
  • func New() Client
• type Expecter
• type Headers
  • func NewHeaders(h map[string]string) Headers
• type HeadersStore
  • func (h HeadersStore) Get(key string) string
  • func (h HeadersStore) Keys() []string
  • func (h HeadersStore) Set(key, value string)
  • func (h HeadersStore) Value() map[string]string
• type Method
• type MockedClient
  • func (m *MockedClient) AllExpectationsDone() error
  • func (m *MockedClient) Delete(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)
  • func (m *MockedClient) Do(ctx context.Context, method Method, url string, body []byte, headers Headers) (*http.Response, error)
  • func (m *MockedClient) ExpectDelete(url string, body []byte, err error, response *http.Response, headers Headers)
  • func (m *MockedClient) ExpectDo(url string, method Method, body []byte, err error, response *http.Response, ...)
  • func (m *MockedClient) ExpectGet(url string, err error, response *http.Response, headers Headers)
  • func (m *MockedClient) ExpectPatch(url string, body []byte, err error, response *http.Response, headers Headers)
  • func (m *MockedClient) ExpectPost(url string, body []byte, err error, response *http.Response, headers Headers)
  • func (m *MockedClient) ExpectPut(url string, body []byte, err error, response *http.Response, headers Headers)
  • func (m *MockedClient) Get(ctx context.Context, url string, headers Headers) (*http.Response, error)
  • func (m *MockedClient) Patch(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)
  • func (m *MockedClient) Post(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)
  • func (m *MockedClient) Put(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)
  • func (m *MockedClient) Reset()
• type Mocker
  • func NewMock() Mocker

Constants

const (
	ERR_Unexpected_Method  = "call %q expected method %q, got %q"
	ERR_Unexpected_Url     = "call %q expected url %q, got %q"
	ERR_Unexpected_Data    = "call %q expected data %v, got %v"
	ERR_Unexpected_Headers = "call %q expected headers %v, got %v"
)

Functions

func GetIP

func GetIP(req *http.Request) string

Get IP address from request using X-Real-IP or X-Forwarded-For headers

func SetTimeout

func SetTimeout(val time.Duration)

Set request timeout

func Timeout

func Timeout() time.Duration

Get request timeout

Types

type Client

type Client interface {
	Post(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)
	Put(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)
	Patch(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)
	Delete(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)
	Get(ctx context.Context, url string, headers Headers) (*http.Response, error)

	Do(ctx context.Context, method Method, url string, body []byte, headers Headers) (*http.Response, error)
}

func New

func New() Client

Create new Client instance

type Expecter

type Expecter interface {
	ExpectPost(url string, body []byte, err error, response *http.Response, headers Headers)
	ExpectPut(url string, body []byte, err error, response *http.Response, headers Headers)
	ExpectPatch(url string, body []byte, err error, response *http.Response, headers Headers)
	ExpectDelete(url string, body []byte, err error, response *http.Response, headers Headers)
	ExpectGet(url string, err error, response *http.Response, headers Headers)
	ExpectDo(url string, method Method, body []byte, err error, response *http.Response, headers Headers)

	AllExpectationsDone() error
	Reset()
}

type Headers

type Headers interface {
	Set(key, value string)
	Keys() []string
	Get(key string) string
	Value() map[string]string
}

func NewHeaders

func NewHeaders(h map[string]string) Headers

type HeadersStore

type HeadersStore map[string]string

func (HeadersStore) Get

func (h HeadersStore) Get(key string) string

func (HeadersStore) Keys

func (h HeadersStore) Keys() []string

func (HeadersStore) Set

func (h HeadersStore) Set(key, value string)

func (HeadersStore) Value

func (h HeadersStore) Value() map[string]string

type Method

type Method string

const (
	MethodGet    Method = http.MethodGet
	MethodPost   Method = http.MethodPost
	MethodPut    Method = http.MethodPut
	MethodPatch  Method = http.MethodPatch
	MethodDelete Method = http.MethodDelete
)

type MockedClient

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

func (*MockedClient) AllExpectationsDone

func (m *MockedClient) AllExpectationsDone() error

Check if all expected calls were done

func (*MockedClient) Delete

func (m *MockedClient) Delete(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)

Check if call of Post method was expected and returning expected response and error

func (*MockedClient) Do

func (m *MockedClient) Do(ctx context.Context, method Method, url string, body []byte, headers Headers) (*http.Response, error)

func (*MockedClient) ExpectDelete

func (m *MockedClient) ExpectDelete(url string, body []byte, err error, response *http.Response, headers Headers)

Store expected call of Post method with expected data and error

func (*MockedClient) ExpectDo

func (m *MockedClient) ExpectDo(url string, method Method, body []byte, err error, response *http.Response, headers Headers)

Store expected call of Post method with expected data and error

func (*MockedClient) ExpectGet

func (m *MockedClient) ExpectGet(url string, err error, response *http.Response, headers Headers)

Store expected call of Get method with expected data and error

func (*MockedClient) ExpectPatch

func (m *MockedClient) ExpectPatch(url string, body []byte, err error, response *http.Response, headers Headers)

Store expected call of Post method with expected data and error

func (*MockedClient) ExpectPost

func (m *MockedClient) ExpectPost(url string, body []byte, err error, response *http.Response, headers Headers)

Store expected call of Post method with expected data and error

func (*MockedClient) ExpectPut

func (m *MockedClient) ExpectPut(url string, body []byte, err error, response *http.Response, headers Headers)

Store expected call of Post method with expected data and error

func (*MockedClient) Get

func (m *MockedClient) Get(ctx context.Context, url string, headers Headers) (*http.Response, error)

Check if call of Get method was expected and returning expected response and error

func (*MockedClient) Patch

func (m *MockedClient) Patch(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)

Check if call of Post method was expected and returning expected response and error

func (*MockedClient) Post

func (m *MockedClient) Post(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)

Check if call of Post method was expected and returning expected response and error

func (*MockedClient) Put

func (m *MockedClient) Put(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)

Check if call of Post method was expected and returning expected response and error

func (*MockedClient) Reset

func (m *MockedClient) Reset()

Reset all expected calls

type Mocker

type Mocker interface {
	Expecter
	Client
}

func NewMock

func NewMock() Mocker

Create new Client instance