handlers

Documentation

Index

• func Read(cfg *config.Config, rendC RenderClient, searchC SearchClient) http.HandlerFunc
• type ClientError
• type RenderClient
• type RenderClientMock
  • func (mock *RenderClientMock) Do(in1 string, in2 []byte) ([]byte, error)
  • func (mock *RenderClientMock) DoCalls() []struct{ ... }
• type SearchClient
• type SearchClientMock
  • func (mock *SearchClientMock) GetDepartments(ctx context.Context, query url.Values) (search.Department, error)
  • func (mock *SearchClientMock) GetDepartmentsCalls() []struct{ ... }
  • func (mock *SearchClientMock) GetSearch(ctx context.Context, query url.Values) (search.Response, error)
  • func (mock *SearchClientMock) GetSearchCalls() []struct{ ... }

Functions

func Read

func Read(cfg *config.Config, rendC RenderClient, searchC SearchClient) http.HandlerFunc

Read Handler

Types

type ClientError

type ClientError interface {
	Code() int
}

ClientError is an interface that can be used to retrieve the status code if a client has errored

type RenderClient

type RenderClient interface {
	Do(string, []byte) ([]byte, error)
}

RenderClient is an interface with methods for require for rendering a template

type RenderClientMock

type RenderClientMock struct {
	// DoFunc mocks the Do method.
	DoFunc func(in1 string, in2 []byte) ([]byte, error)
	// contains filtered or unexported fields
}

RenderClientMock is a mock implementation of RenderClient.

    func TestSomethingThatUsesRenderClient(t *testing.T) {

        // make and configure a mocked RenderClient
        mockedRenderClient := &RenderClientMock{
            DoFunc: func(in1 string, in2 []byte) ([]byte, error) {
	               panic("mock out the Do method")
            },
        }

        // use mockedRenderClient in code that requires RenderClient
        // and then make assertions.

    }

func (*RenderClientMock) Do

func (mock *RenderClientMock) Do(in1 string, in2 []byte) ([]byte, error)

Do calls DoFunc.

func (*RenderClientMock) DoCalls

func (mock *RenderClientMock) DoCalls() []struct {
	In1 string
	In2 []byte
}

DoCalls gets all the calls that were made to Do. Check the length with:

len(mockedRenderClient.DoCalls())

type SearchClient

type SearchClient interface {
	GetSearch(ctx context.Context, query url.Values) (r searchC.Response, err error)
	GetDepartments(ctx context.Context, query url.Values) (d searchCli.Department, err error)
}

SearchClient is an interface with methods required for a search client

type SearchClientMock

type SearchClientMock struct {
	// GetDepartmentsFunc mocks the GetDepartments method.
	GetDepartmentsFunc func(ctx context.Context, query url.Values) (search.Department, error)

	// GetSearchFunc mocks the GetSearch method.
	GetSearchFunc func(ctx context.Context, query url.Values) (search.Response, error)
	// contains filtered or unexported fields
}

SearchClientMock is a mock implementation of SearchClient.

    func TestSomethingThatUsesSearchClient(t *testing.T) {

        // make and configure a mocked SearchClient
        mockedSearchClient := &SearchClientMock{
            GetDepartmentsFunc: func(ctx context.Context, query url.Values) (search.Department, error) {
	               panic("mock out the GetDepartments method")
            },
            GetSearchFunc: func(ctx context.Context, query url.Values) (search.Response, error) {
	               panic("mock out the GetSearch method")
            },
        }

        // use mockedSearchClient in code that requires SearchClient
        // and then make assertions.

    }

func (*SearchClientMock) GetDepartments

func (mock *SearchClientMock) GetDepartments(ctx context.Context, query url.Values) (search.Department, error)

GetDepartments calls GetDepartmentsFunc.

func (*SearchClientMock) GetDepartmentsCalls

func (mock *SearchClientMock) GetDepartmentsCalls() []struct {
	Ctx   context.Context
	Query url.Values
}

GetDepartmentsCalls gets all the calls that were made to GetDepartments. Check the length with:

len(mockedSearchClient.GetDepartmentsCalls())

func (*SearchClientMock) GetSearch

func (mock *SearchClientMock) GetSearch(ctx context.Context, query url.Values) (search.Response, error)

GetSearch calls GetSearchFunc.

func (*SearchClientMock) GetSearchCalls

func (mock *SearchClientMock) GetSearchCalls() []struct {
	Ctx   context.Context
	Query url.Values
}

GetSearchCalls gets all the calls that were made to GetSearch. Check the length with:

len(mockedSearchClient.GetSearchCalls())