Documentation
¶
Index ¶
- func Read(cfg *config.Config, rend RenderClient, searchC SearchClient) http.HandlerFunc
- type ClientError
- type RenderClient
- type RenderClientMock
- type SearchClient
- type SearchClientMock
- func (mock *SearchClientMock) GetDepartments(ctx context.Context, userAuthToken string, serviceAuthToken string, ...) (search.Department, error)
- func (mock *SearchClientMock) GetDepartmentsCalls() []struct{ ... }
- func (mock *SearchClientMock) GetSearch(ctx context.Context, userAuthToken string, serviceAuthToken string, ...) (search.Response, error)
- func (mock *SearchClientMock) GetSearchCalls() []struct{ ... }
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Read ¶ added in v0.2.0
func Read(cfg *config.Config, rend 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 ¶ added in v0.2.0
type RenderClient interface {
BuildPage(w io.Writer, pageModel interface{}, templateName string)
NewBasePageModel() coreModel.Page
}
RenderClient is an interface with methods for require for rendering a template
type RenderClientMock ¶ added in v0.2.0
type RenderClientMock struct {
// BuildPageFunc mocks the BuildPage method.
BuildPageFunc func(w io.Writer, pageModel interface{}, templateName string)
// NewBasePageModelFunc mocks the NewBasePageModel method.
NewBasePageModelFunc func() model.Page
// 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{
BuildPageFunc: func(w io.Writer, pageModel interface{}, templateName string) {
panic("mock out the BuildPage method")
},
NewBasePageModelFunc: func() model.Page {
panic("mock out the NewBasePageModel method")
},
}
// use mockedRenderClient in code that requires RenderClient
// and then make assertions.
}
func (*RenderClientMock) BuildPage ¶ added in v0.11.0
func (mock *RenderClientMock) BuildPage(w io.Writer, pageModel interface{}, templateName string)
BuildPage calls BuildPageFunc.
func (*RenderClientMock) BuildPageCalls ¶ added in v0.11.0
func (mock *RenderClientMock) BuildPageCalls() []struct { W io.Writer PageModel interface{} TemplateName string }
BuildPageCalls gets all the calls that were made to BuildPage. Check the length with:
len(mockedRenderClient.BuildPageCalls())
func (*RenderClientMock) NewBasePageModel ¶ added in v0.11.0
func (mock *RenderClientMock) NewBasePageModel() model.Page
NewBasePageModel calls NewBasePageModelFunc.
func (*RenderClientMock) NewBasePageModelCalls ¶ added in v0.11.0
func (mock *RenderClientMock) NewBasePageModelCalls() []struct { }
NewBasePageModelCalls gets all the calls that were made to NewBasePageModel. Check the length with:
len(mockedRenderClient.NewBasePageModelCalls())
type SearchClient ¶ added in v0.2.0
type SearchClient interface {
GetSearch(ctx context.Context, userAuthToken, serviceAuthToken, collectionID string, query url.Values) (r searchCli.Response, err error)
GetDepartments(ctx context.Context, userAuthToken, serviceAuthToken, collectionID string, query url.Values) (d searchCli.Department, err error)
}
SearchClient is an interface with methods required for a search client
type SearchClientMock ¶ added in v0.2.0
type SearchClientMock struct {
// GetDepartmentsFunc mocks the GetDepartments method.
GetDepartmentsFunc func(ctx context.Context, userAuthToken string, serviceAuthToken string, collectionID string, query url.Values) (search.Department, error)
// GetSearchFunc mocks the GetSearch method.
GetSearchFunc func(ctx context.Context, userAuthToken string, serviceAuthToken string, collectionID string, 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, userAuthToken string, serviceAuthToken string, collectionID string, query url.Values) (search.Department, error) {
panic("mock out the GetDepartments method")
},
GetSearchFunc: func(ctx context.Context, userAuthToken string, serviceAuthToken string, collectionID string, 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 ¶ added in v0.7.0
func (mock *SearchClientMock) GetDepartments(ctx context.Context, userAuthToken string, serviceAuthToken string, collectionID string, query url.Values) (search.Department, error)
GetDepartments calls GetDepartmentsFunc.
func (*SearchClientMock) GetDepartmentsCalls ¶ added in v0.7.0
func (mock *SearchClientMock) GetDepartmentsCalls() []struct { Ctx context.Context UserAuthToken string ServiceAuthToken string CollectionID string Query url.Values }
GetDepartmentsCalls gets all the calls that were made to GetDepartments. Check the length with:
len(mockedSearchClient.GetDepartmentsCalls())
func (*SearchClientMock) GetSearch ¶ added in v0.2.0
func (mock *SearchClientMock) GetSearch(ctx context.Context, userAuthToken string, serviceAuthToken string, collectionID string, query url.Values) (search.Response, error)
GetSearch calls GetSearchFunc.
func (*SearchClientMock) GetSearchCalls ¶ added in v0.2.0
func (mock *SearchClientMock) GetSearchCalls() []struct { Ctx context.Context UserAuthToken string ServiceAuthToken string CollectionID string Query url.Values }
GetSearchCalls gets all the calls that were made to GetSearch. Check the length with:
len(mockedSearchClient.GetSearchCalls())