steps

Documentation

Overview

Package steps is used to define the steps that are used in the component test, which is written in godog (Go's version of cucumber).

Index

• func DoGetKafkaProducerChecker(ctx context.Context, state *healthcheck.CheckState) error
• type ErrorFeature
  • func (t *ErrorFeature) Errorf(format string, args ...interface{})
  • func (t *ErrorFeature) Helper()
  • func (t *ErrorFeature) Log(args ...interface{})
  • func (t *ErrorFeature) Logf(format string, args ...interface{})
  • func (t *ErrorFeature) Name() string
  • func (t *ErrorFeature) StepError() error
• type FakeAPI
  • func NewFakeSearchAPI() *FakeAPI
  • func (f *FakeAPI) Close()
  • func (f *FakeAPI) Reset()
  • func (f *FakeAPI) Restart()
• type SearchReindexAPIFeature
  • func NewSearchReindexAPIFeature(mongoFeature *componentTest.MongoFeature, ...) (*SearchReindexAPIFeature, error)
  • func (f *SearchReindexAPIFeature) CallGetJobByID(version, id string) error
  • func (f *SearchReindexAPIFeature) Close() error
  • func (f *SearchReindexAPIFeature) DoGetAuthorisationHandlers(ctx context.Context, cfg *config.Config) api.AuthHandler
  • func (f *SearchReindexAPIFeature) DoGetHTTPServer(bindAddr string, router http.Handler) service.HTTPServer
  • func (f *SearchReindexAPIFeature) DoGetHealthcheckOk(cfg *config.Config, curTime, commit, version string) (service.HealthChecker, error)
  • func (f *SearchReindexAPIFeature) DoGetKafkaProducer(ctx context.Context, cfg *config.Config) (service.KafkaProducer, error)
  • func (f *SearchReindexAPIFeature) DoGetMongoDB(ctx context.Context, mgoCfg config.MongoConfig) (service.MongoDataStorer, error)
  • func (f *SearchReindexAPIFeature) GetTaskForJob(version, jobID, taskName string) error
  • func (f *SearchReindexAPIFeature) InitAPIFeature() *componentTest.APIFeature
  • func (f *SearchReindexAPIFeature) InitialiseService() (http.Handler, error)
  • func (f *SearchReindexAPIFeature) PostTaskForJob(version, jobID string, requestBody *godog.DocString) error
  • func (f *SearchReindexAPIFeature) PutNumberOfDocs(version, id, taskName, countStr string) error
  • func (f *SearchReindexAPIFeature) PutNumberOfTasks(version, id, countStr string) error
  • func (f *SearchReindexAPIFeature) RegisterSteps(ctx *godog.ScenarioContext)
  • func (f *SearchReindexAPIFeature) Reset(mongoFail bool) error

Functions

func DoGetKafkaProducerChecker

func DoGetKafkaProducerChecker(ctx context.Context, state *healthcheck.CheckState) error

DoGetKafkaProducerChecker is used to mock the kafka producer CheckerFunc

Types

type ErrorFeature

type ErrorFeature struct {
	testing.TB
	// contains filtered or unexported fields
}

func (*ErrorFeature) Errorf

func (t *ErrorFeature) Errorf(format string, args ...interface{})

func (*ErrorFeature) Helper

func (t *ErrorFeature) Helper()

func (*ErrorFeature) Log

func (t *ErrorFeature) Log(args ...interface{})

func (*ErrorFeature) Logf

func (t *ErrorFeature) Logf(format string, args ...interface{})

func (*ErrorFeature) Name

func (t *ErrorFeature) Name() string

func (*ErrorFeature) StepError

func (t *ErrorFeature) StepError() error

type FakeAPI

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

func NewFakeSearchAPI

func NewFakeSearchAPI() *FakeAPI

func (*FakeAPI) Close

func (f *FakeAPI) Close()

func (*FakeAPI) Reset

func (f *FakeAPI) Reset()

func (*FakeAPI) Restart

func (f *FakeAPI) Restart()

type SearchReindexAPIFeature

type SearchReindexAPIFeature struct {
	APIFeature  *componentTest.APIFeature
	AuthFeature *componentTest.AuthorizationFeature
	Config      *config.Config

	ErrorFeature  componentTest.ErrorFeature
	HTTPServer    *http.Server
	KafkaProducer service.KafkaProducer

	KafkaMessageProducer kafka.IProducer
	MongoClient          *mongo.JobStore
	MongoFeature         *componentTest.MongoFeature

	ServiceRunning bool
	// contains filtered or unexported fields
}

SearchReindexAPIFeature is a type that contains all the requirements for running a godog (cucumber) feature that tests the SearchReindexAPIFeature endpoints.

func NewSearchReindexAPIFeature

func NewSearchReindexAPIFeature(mongoFeature *componentTest.MongoFeature,
	authFeature *componentTest.AuthorizationFeature,
	fakeSearchAPI *FakeAPI) (*SearchReindexAPIFeature, error)

NewSearchReindexAPIFeature returns a pointer to a new SearchReindexAPIFeature, which can then be used for testing the SearchReindexAPIFeature endpoints.

func (*SearchReindexAPIFeature) CallGetJobByID

func (f *SearchReindexAPIFeature) CallGetJobByID(version, id string) error

CallGetJobByID can be called by a feature step in order to call the GET /search-reindex-jobs/{id} endpoint.

func (*SearchReindexAPIFeature) Close

func (f *SearchReindexAPIFeature) Close() error

Close stops the *service.Service, which is pointed to from within the specific SearchReindexAPIFeature, from running.

func (*SearchReindexAPIFeature) DoGetAuthorisationHandlers

func (f *SearchReindexAPIFeature) DoGetAuthorisationHandlers(ctx context.Context, cfg *config.Config) api.AuthHandler

DoGetAuthorisationHandlers returns the mock AuthHandler that was created in the NewSearchReindexAPIFeature function.

func (*SearchReindexAPIFeature) DoGetHTTPServer

func (f *SearchReindexAPIFeature) DoGetHTTPServer(bindAddr string, router http.Handler) service.HTTPServer

DoGetHTTPServer takes a bind Address (string) and a router (http.Handler), which are used to set up an HTTPServer. The HTTPServer is in a specific SearchReindexAPIFeature and is returned.

func (*SearchReindexAPIFeature) DoGetHealthcheckOk

func (f *SearchReindexAPIFeature) DoGetHealthcheckOk(cfg *config.Config, curTime, commit, version string) (service.HealthChecker, error)

DoGetHealthcheckOk returns a mock HealthChecker service for a specific SearchReindexAPIFeature.

func (*SearchReindexAPIFeature) DoGetKafkaProducer

func (f *SearchReindexAPIFeature) DoGetKafkaProducer(ctx context.Context, cfg *config.Config) (service.KafkaProducer, error)

DoGetKafkaProducer returns a mock kafka producer.

func (*SearchReindexAPIFeature) DoGetMongoDB

func (f *SearchReindexAPIFeature) DoGetMongoDB(ctx context.Context, mgoCfg config.MongoConfig) (service.MongoDataStorer, error)

DoGetMongoDB returns a MongoDB, for the component test, which has a random database name and different URI to the one used by the API under test.

func (*SearchReindexAPIFeature) GetTaskForJob

func (f *SearchReindexAPIFeature) GetTaskForJob(version, jobID, taskName string) error

GetTaskForJob can be called by a feature step in order to call the GET /search-reindex-jobs/{id}/tasks/{task name} endpoint

func (*SearchReindexAPIFeature) InitAPIFeature

func (f *SearchReindexAPIFeature) InitAPIFeature() *componentTest.APIFeature

InitAPIFeature initialises the APIFeature that's contained within a specific SearchReindexAPIFeature.

func (*SearchReindexAPIFeature) InitialiseService

func (f *SearchReindexAPIFeature) InitialiseService() (http.Handler, error)

InitialiseService returns the http.Handler that's contained within a specific SearchReindexAPIFeature.

func (*SearchReindexAPIFeature) PostTaskForJob

func (f *SearchReindexAPIFeature) PostTaskForJob(version, jobID string, requestBody *godog.DocString) error

PostTaskForJob can be called by a feature step in order to call the POST /search-reindex-jobs/{id}/tasks endpoint

func (*SearchReindexAPIFeature) PutNumberOfDocs

func (f *SearchReindexAPIFeature) PutNumberOfDocs(version, id, taskName, countStr string) error

PutNumberOfTasks can be called by a feature step in order to call the PUT /search-reindex-jobs/{id}/number-of-tasks/{count} endpoint

func (*SearchReindexAPIFeature) PutNumberOfTasks

func (f *SearchReindexAPIFeature) PutNumberOfTasks(version, id, countStr string) error

PutNumberOfTasks can be called by a feature step in order to call the PUT /search-reindex-jobs/{id}/number-of-tasks/{count} endpoint

func (*SearchReindexAPIFeature) RegisterSteps

func (f *SearchReindexAPIFeature) RegisterSteps(ctx *godog.ScenarioContext)

RegisterSteps defines the steps within a specific SearchReindexAPIFeature cucumber test.

func (*SearchReindexAPIFeature) Reset

func (f *SearchReindexAPIFeature) Reset(mongoFail bool) error

Reset sets the resources within a specific SearchReindexAPIFeature back to their default values.