handlers

package
v1.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 8, 2023 License: MIT Imports: 15 Imported by: 0

Documentation

Overview

Package handlers is a generated GoMock package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GeographyStart added in v1.2.0 

func GeographyStart(ctx context.Context, cfg config.Config, c Clients) http.HandlerFunc

GeographyStart Handler

func GetArea added in v1.3.0 

func GetArea(ctx context.Context, cfg config.Config, c Clients) http.HandlerFunc

GetArea Handler

func GetAreaViewHandler added in v1.4.0 

func GetAreaViewHandler(w http.ResponseWriter, req *http.Request, ctx context.Context, c Clients, cfg config.Config, lang, collectionID, accessToken string)

Types

type AreaApiClient added in v1.4.0 

type AreaApiClient interface {
	GetArea(ctx context.Context, userAuthToken string, serviceAuthToken string, collectionID string, areaID string, acceptLang string) (areaDetails areas.AreaDetails, err error)
	GetRelations(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, areaID, acceptLang string) (relations []areas.Relation, err error)
	Checker(ctx context.Context, check *health.CheckState) error
}

AreaApiClient is an interface for requesting area profile specific data

type AreaApiClientMock added in v1.4.0 

type AreaApiClientMock struct {
	// CheckerFunc mocks the Checker method.
	CheckerFunc func(ctx context.Context, check *healthcheck.CheckState) error

	// GetAreaFunc mocks the GetArea method.
	GetAreaFunc func(ctx context.Context, userAuthToken string, serviceAuthToken string, collectionID string, areaID string, acceptLang string) (areas.AreaDetails, error)

	// GetRelationsFunc mocks the GetRelations method.
	GetRelationsFunc func(ctx context.Context, userAuthToken string, serviceAuthToken string, collectionID string, areaID string, acceptLang string) ([]areas.Relation, error)
	// contains filtered or unexported fields
}

AreaApiClientMock is a mock implementation of AreaApiClient. 

func TestSomethingThatUsesAreaApiClient(t *testing.T) {

	// make and configure a mocked AreaApiClient
	mockedAreaApiClient := &AreaApiClientMock{
		CheckerFunc: func(ctx context.Context, check *healthcheck.CheckState) error {
			panic("mock out the Checker method")
		},
		GetAreaFunc: func(ctx context.Context, userAuthToken string, serviceAuthToken string, collectionID string, areaID string, acceptLang string) (areas.AreaDetails, error) {
			panic("mock out the GetArea method")
		},
		GetRelationsFunc: func(ctx context.Context, userAuthToken string, serviceAuthToken string, collectionID string, areaID string, acceptLang string) ([]areas.Relation, error) {
			panic("mock out the GetRelations method")
		},
	}

	// use mockedAreaApiClient in code that requires AreaApiClient
	// and then make assertions.

}

func (*AreaApiClientMock) Checker added in v1.4.0 

func (mock *AreaApiClientMock) Checker(ctx context.Context, check *healthcheck.CheckState) error

Checker calls CheckerFunc.

func (*AreaApiClientMock) CheckerCalls added in v1.4.0 

func (mock *AreaApiClientMock) CheckerCalls() []struct {
	Ctx   context.Context
	Check *healthcheck.CheckState
}

CheckerCalls gets all the calls that were made to Checker. Check the length with: 

len(mockedAreaApiClient.CheckerCalls())

func (*AreaApiClientMock) GetArea added in v1.4.0 

func (mock *AreaApiClientMock) GetArea(ctx context.Context, userAuthToken string, serviceAuthToken string, collectionID string, areaID string, acceptLang string) (areas.AreaDetails, error)

GetArea calls GetAreaFunc.

func (*AreaApiClientMock) GetAreaCalls added in v1.4.0 

func (mock *AreaApiClientMock) GetAreaCalls() []struct {
	Ctx              context.Context
	UserAuthToken    string
	ServiceAuthToken string
	CollectionID     string
	AreaID           string
	AcceptLang       string
}

GetAreaCalls gets all the calls that were made to GetArea. Check the length with: 

len(mockedAreaApiClient.GetAreaCalls())

func (*AreaApiClientMock) GetRelations added in v1.4.0 

func (mock *AreaApiClientMock) GetRelations(ctx context.Context, userAuthToken string, serviceAuthToken string, collectionID string, areaID string, acceptLang string) ([]areas.Relation, error)

GetRelations calls GetRelationsFunc.

func (*AreaApiClientMock) GetRelationsCalls added in v1.4.0 

func (mock *AreaApiClientMock) GetRelationsCalls() []struct {
	Ctx              context.Context
	UserAuthToken    string
	ServiceAuthToken string
	CollectionID     string
	AreaID           string
	AcceptLang       string
}

GetRelationsCalls gets all the calls that were made to GetRelations. Check the length with: 

len(mockedAreaApiClient.GetRelationsCalls())

type CacheHelper added in v1.13.0 

type CacheHelper interface {
	RunUpdates(ctx context.Context, svcErrors chan error)
	GetMappedNavigationContent(ctx context.Context, lang string) (content []coreModel.NavigationItem, err error)
}

type CacheHelperMock added in v1.13.0 

type CacheHelperMock struct {
	// GetMappedNavigationContentFunc mocks the GetMappedNavigationContent method.
	GetMappedNavigationContentFunc func(ctx context.Context, lang string) ([]model.NavigationItem, error)

	// RunUpdatesFunc mocks the RunUpdates method.
	RunUpdatesFunc func(ctx context.Context, svcErrors chan error)
	// contains filtered or unexported fields
}

CacheHelperMock is a mock implementation of CacheHelper. 

func TestSomethingThatUsesCacheHelper(t *testing.T) {

	// make and configure a mocked CacheHelper
	mockedCacheHelper := &CacheHelperMock{
		GetMappedNavigationContentFunc: func(ctx context.Context, lang string) ([]model.NavigationItem, error) {
			panic("mock out the GetMappedNavigationContent method")
		},
		RunUpdatesFunc: func(ctx context.Context, svcErrors chan error)  {
			panic("mock out the RunUpdates method")
		},
	}

	// use mockedCacheHelper in code that requires CacheHelper
	// and then make assertions.

}

func (*CacheHelperMock) GetMappedNavigationContent added in v1.13.0 

func (mock *CacheHelperMock) GetMappedNavigationContent(ctx context.Context, lang string) ([]model.NavigationItem, error)

GetMappedNavigationContent calls GetMappedNavigationContentFunc.

func (*CacheHelperMock) GetMappedNavigationContentCalls added in v1.13.0 

func (mock *CacheHelperMock) GetMappedNavigationContentCalls() []struct {
	Ctx  context.Context
	Lang string
}

GetMappedNavigationContentCalls gets all the calls that were made to GetMappedNavigationContent. Check the length with: 

len(mockedCacheHelper.GetMappedNavigationContentCalls())

func (*CacheHelperMock) RunUpdates added in v1.13.0 

func (mock *CacheHelperMock) RunUpdates(ctx context.Context, svcErrors chan error)

RunUpdates calls RunUpdatesFunc.

func (*CacheHelperMock) RunUpdatesCalls added in v1.13.0 

func (mock *CacheHelperMock) RunUpdatesCalls() []struct {
	Ctx       context.Context
	SvcErrors chan error
}

RunUpdatesCalls gets all the calls that were made to RunUpdates. Check the length with: 

len(mockedCacheHelper.RunUpdatesCalls())

type ClientError 

type ClientError interface {
	Error() string
	Code() int
}

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

type Clients added in v1.4.0 

type Clients struct {
	HealthCheckHandler func(w http.ResponseWriter, req *http.Request)
	Render             RenderClient
	AreasSDKClient     AreaApiClient
	Renderer           RendererClient
	CacheHelper        CacheHelper
}

Clients - struct containing all the clients for the controller

type MockAreaApiClient added in v1.4.0 

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

MockAreaApiClient is a mock of AreaApiClient interface.

func NewMockAreaApiClient added in v1.4.0 

func NewMockAreaApiClient(ctrl *gomock.Controller) *MockAreaApiClient

NewMockAreaApiClient creates a new mock instance.

func (*MockAreaApiClient) Checker added in v1.4.0 

func (m *MockAreaApiClient) Checker(ctx context.Context, check *healthcheck.CheckState) error

Checker mocks base method.

func (*MockAreaApiClient) EXPECT added in v1.4.0 

func (m *MockAreaApiClient) EXPECT() *MockAreaApiClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockAreaApiClient) GetArea added in v1.4.0 

func (m *MockAreaApiClient) GetArea(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, areaID, acceptLang string) (areas.AreaDetails, error)

GetArea mocks base method.

func (*MockAreaApiClient) GetRelations added in v1.4.0 

func (m *MockAreaApiClient) GetRelations(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, areaID, acceptLang string) ([]areas.Relation, error)

GetRelations mocks base method.

type MockAreaApiClientMockRecorder added in v1.4.0 

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

MockAreaApiClientMockRecorder is the mock recorder for MockAreaApiClient.

func (*MockAreaApiClientMockRecorder) Checker added in v1.4.0 

func (mr *MockAreaApiClientMockRecorder) Checker(ctx, check interface{}) *gomock.Call

Checker indicates an expected call of Checker.

func (*MockAreaApiClientMockRecorder) GetArea added in v1.4.0 

func (mr *MockAreaApiClientMockRecorder) GetArea(ctx, userAuthToken, serviceAuthToken, collectionID, areaID, acceptLang interface{}) *gomock.Call

GetArea indicates an expected call of GetArea.

func (*MockAreaApiClientMockRecorder) GetRelations added in v1.4.0 

func (mr *MockAreaApiClientMockRecorder) GetRelations(ctx, userAuthToken, serviceAuthToken, collectionID, areaID, acceptLang interface{}) *gomock.Call

GetRelations indicates an expected call of GetRelations.

type MockCacheHelper added in v1.13.0 

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

MockCacheHelper is a mock of CacheHelper interface.

func NewMockCacheHelper added in v1.13.0 

func NewMockCacheHelper(ctrl *gomock.Controller) *MockCacheHelper

NewMockCacheHelper creates a new mock instance.

func (*MockCacheHelper) EXPECT added in v1.13.0 

func (m *MockCacheHelper) EXPECT() *MockCacheHelperMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockCacheHelper) GetMappedNavigationContent added in v1.13.0 

func (m *MockCacheHelper) GetMappedNavigationContent(ctx context.Context, lang string) ([]model.NavigationItem, error)

GetMappedNavigationContent mocks base method.

func (*MockCacheHelper) RunUpdates added in v1.13.0 

func (m *MockCacheHelper) RunUpdates(ctx context.Context, svcErrors chan error)

RunUpdates mocks base method.

type MockCacheHelperMockRecorder added in v1.13.0 

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

MockCacheHelperMockRecorder is the mock recorder for MockCacheHelper.

func (*MockCacheHelperMockRecorder) GetMappedNavigationContent added in v1.13.0 

func (mr *MockCacheHelperMockRecorder) GetMappedNavigationContent(ctx, lang interface{}) *gomock.Call

GetMappedNavigationContent indicates an expected call of GetMappedNavigationContent.

func (*MockCacheHelperMockRecorder) RunUpdates added in v1.13.0 

func (mr *MockCacheHelperMockRecorder) RunUpdates(ctx, svcErrors interface{}) *gomock.Call

RunUpdates indicates an expected call of RunUpdates.

type MockClientError added in v1.4.0 

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

MockClientError is a mock of ClientError interface.

func NewMockClientError added in v1.4.0 

func NewMockClientError(ctrl *gomock.Controller) *MockClientError

NewMockClientError creates a new mock instance.

func (*MockClientError) Code added in v1.4.0 

func (m *MockClientError) Code() int

Code mocks base method.

func (*MockClientError) EXPECT added in v1.4.0 

func (m *MockClientError) EXPECT() *MockClientErrorMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockClientError) Error added in v1.4.0 

func (m *MockClientError) Error() string

Error mocks base method.

type MockClientErrorMockRecorder added in v1.4.0 

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

MockClientErrorMockRecorder is the mock recorder for MockClientError.

func (*MockClientErrorMockRecorder) Code added in v1.4.0 

func (mr *MockClientErrorMockRecorder) Code() *gomock.Call

Code indicates an expected call of Code.

func (*MockClientErrorMockRecorder) Error added in v1.4.0 

func (mr *MockClientErrorMockRecorder) Error() *gomock.Call

Error indicates an expected call of Error.

type MockRenderClient added in v1.2.0 

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

MockRenderClient is a mock of RenderClient interface.

func NewMockRenderClient added in v1.2.0 

func NewMockRenderClient(ctrl *gomock.Controller) *MockRenderClient

NewMockRenderClient creates a new mock instance.

func (*MockRenderClient) BuildPage added in v1.2.0 

func (m *MockRenderClient) BuildPage(w io.Writer, pageModel interface{}, templateName string)

BuildPage mocks base method.

func (*MockRenderClient) EXPECT added in v1.2.0 

func (m *MockRenderClient) EXPECT() *MockRenderClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockRenderClient) NewBasePageModel added in v1.2.0 

func (m *MockRenderClient) NewBasePageModel() model.Page

NewBasePageModel mocks base method.

type MockRenderClientMockRecorder added in v1.2.0 

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

MockRenderClientMockRecorder is the mock recorder for MockRenderClient.

func (*MockRenderClientMockRecorder) BuildPage added in v1.2.0 

func (mr *MockRenderClientMockRecorder) BuildPage(w, pageModel, templateName interface{}) *gomock.Call

BuildPage indicates an expected call of BuildPage.

func (*MockRenderClientMockRecorder) NewBasePageModel added in v1.2.0 

func (mr *MockRenderClientMockRecorder) NewBasePageModel() *gomock.Call

NewBasePageModel indicates an expected call of NewBasePageModel.

type MockRendererClient added in v1.4.0 

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

MockRendererClient is a mock of RendererClient interface.

func NewMockRendererClient added in v1.4.0 

func NewMockRendererClient(ctrl *gomock.Controller) *MockRendererClient

NewMockRendererClient creates a new mock instance.

func (*MockRendererClient) Checker added in v1.4.0 

func (m *MockRendererClient) Checker(ctx context.Context, check *healthcheck.CheckState) error

Checker mocks base method.

func (*MockRendererClient) Do added in v1.4.0 

func (m *MockRendererClient) Do(arg0 string, arg1 []byte) ([]byte, error)

Do mocks base method.

func (*MockRendererClient) EXPECT added in v1.4.0 

func (m *MockRendererClient) EXPECT() *MockRendererClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

type MockRendererClientMockRecorder added in v1.4.0 

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

MockRendererClientMockRecorder is the mock recorder for MockRendererClient.

func (*MockRendererClientMockRecorder) Checker added in v1.4.0 

func (mr *MockRendererClientMockRecorder) Checker(ctx, check interface{}) *gomock.Call

Checker indicates an expected call of Checker.

func (*MockRendererClientMockRecorder) Do added in v1.4.0 

func (mr *MockRendererClientMockRecorder) Do(arg0, arg1 interface{}) *gomock.Call

Do indicates an expected call of Do.

type RenderClient added in v1.1.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 v1.4.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 v1.4.0 

func (mock *RenderClientMock) BuildPage(w io.Writer, pageModel interface{}, templateName string)

BuildPage calls BuildPageFunc.

func (*RenderClientMock) BuildPageCalls added in v1.4.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 v1.4.0 

func (mock *RenderClientMock) NewBasePageModel() model.Page

NewBasePageModel calls NewBasePageModelFunc.

func (*RenderClientMock) NewBasePageModelCalls added in v1.4.0 

func (mock *RenderClientMock) NewBasePageModelCalls() []struct {
}

NewBasePageModelCalls gets all the calls that were made to NewBasePageModel. Check the length with: 

len(mockedRenderClient.NewBasePageModelCalls())

type RendererClient added in v1.4.0 

type RendererClient interface {
	Do(string, []byte) ([]byte, error)
	Checker(ctx context.Context, check *health.CheckState) error
}

RendererClient is an interface with methods for rending frontend assets

type RendererClientMock added in v1.4.0 

type RendererClientMock struct {
	// CheckerFunc mocks the Checker method.
	CheckerFunc func(ctx context.Context, check *healthcheck.CheckState) error

	// DoFunc mocks the Do method.
	DoFunc func(s string, bytes []byte) ([]byte, error)
	// contains filtered or unexported fields
}

RendererClientMock is a mock implementation of RendererClient. 

func TestSomethingThatUsesRendererClient(t *testing.T) {

	// make and configure a mocked RendererClient
	mockedRendererClient := &RendererClientMock{
		CheckerFunc: func(ctx context.Context, check *healthcheck.CheckState) error {
			panic("mock out the Checker method")
		},
		DoFunc: func(s string, bytes []byte) ([]byte, error) {
			panic("mock out the Do method")
		},
	}

	// use mockedRendererClient in code that requires RendererClient
	// and then make assertions.

}

func (*RendererClientMock) Checker added in v1.4.0 

func (mock *RendererClientMock) Checker(ctx context.Context, check *healthcheck.CheckState) error

Checker calls CheckerFunc.

func (*RendererClientMock) CheckerCalls added in v1.4.0 

func (mock *RendererClientMock) CheckerCalls() []struct {
	Ctx   context.Context
	Check *healthcheck.CheckState
}

CheckerCalls gets all the calls that were made to Checker. Check the length with: 

len(mockedRendererClient.CheckerCalls())

func (*RendererClientMock) Do added in v1.4.0 

func (mock *RendererClientMock) Do(s string, bytes []byte) ([]byte, error)

Do calls DoFunc.

func (*RendererClientMock) DoCalls added in v1.4.0 

func (mock *RendererClientMock) DoCalls() []struct {
	S     string
	Bytes []byte
}

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

len(mockedRendererClient.DoCalls())

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.