steps

Documentation

Index

• Constants
• Variables
• type Component
  • func NewComponent(_ *testing.T) *Component
  • func (c *Component) Close()
  • func (c *Component) GetKafkaConsumer(ctx context.Context, cfg *config.Kafka, topic string) (kafka.IConsumerGroup, error)
  • func (c *Component) GetKafkaProducer(_ context.Context, cfg *config.Kafka) (kafka.IProducer, error)
  • func (c *Component) RegisterSteps(ctx *godog.ScenarioContext)
  • func (c *Component) Reset() error

Constants

const ContentUpdatedTopic = "content-updated"

const SearchContentUpdatedTopic = "search-content-updated"

const (
	WaitEventTimeout = 5 * time.Second // maximum time that the component test consumer will wait for a kafka event
)

Variables

var (
	BuildTime = "1625046891"
	GitCommit = "7434fe334d9f51b7239f978094ea29d10ac33b16"
	Version   = ""
)

Types

type Component

type Component struct {
	componenttest.ErrorFeature
	DatasetAPI               *httpfake.HTTPFake  // Dataset API mock at HTTP level
	Zebedee                  *httpfake.HTTPFake  // Zebedee mock at HTTP level
	KafkaProducer            *kafkatest.Producer // Mock for service kafka producer
	ContentPublishedConsumer *kafkatest.Consumer // Mock for service kafka consumer
	SearchContentConsumer    *kafkatest.Consumer // Mock for service kafka consumer
	// contains filtered or unexported fields
}

func NewComponent

func NewComponent(_ *testing.T) *Component

func (*Component) Close

func (c *Component) Close()

Close kills the application under test and waits for it to complete the graceful shutdown, or timeout

func (*Component) GetKafkaConsumer

func (c *Component) GetKafkaConsumer(ctx context.Context, cfg *config.Kafka, topic string) (kafka.IConsumerGroup, error)

GetKafkaConsumer creates a new kafkatest consumer based on the topic and stores it in the Component struct. It returns the appropriate mock for the service under test. If there is any error creating the mock, it is returned.

func (*Component) GetKafkaProducer

func (c *Component) GetKafkaProducer(_ context.Context, cfg *config.Kafka) (kafka.IProducer, error)

GetKafkaProducer creates a new kafkatest producer and stores it to the caller Component struct It returns the mock, so it can be used by the service under test. If there is any error creating the mock, it is also returned to the service.

func (*Component) RegisterSteps

func (c *Component) RegisterSteps(ctx *godog.ScenarioContext)

func (*Component) Reset

func (c *Component) Reset() error

Reset re-initialises the service under test and the api mocks. Note that the service under test should not be started yet to prevent race conditions if it tries to call un-initialised dependencies (steps)