e2etest

Documentation

Overview

Package e2etest contains some helpers to make external E2E tests using Telegram test server.

Index

• type EchoBot
  • func NewEchoBot(suite *Suite, auth chan<- *tg.User) EchoBot
  • func (b EchoBot) Run(ctx context.Context) error
• type Suite
  • func NewSuite(tb require.TestingT, config TestOptions) *Suite
  • func (s *Suite) Authenticate(ctx context.Context, client auth.FlowClient) error
  • func (s *Suite) Client(logger *zap.Logger, handler telegram.UpdateHandler) *telegram.Client
  • func (s *Suite) RetryAuthenticate(ctx context.Context, client auth.FlowClient) error
• type TestOptions
• type User
  • func NewUser(suite *Suite, text []string, username string) User
  • func (u User) Run(ctx context.Context) error

Types

type EchoBot

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

EchoBot is a simple echo message bot.

func NewEchoBot

func NewEchoBot(suite *Suite, auth chan<- *tg.User) EchoBot

NewEchoBot creates new echo bot.

func (EchoBot) Run

func (b EchoBot) Run(ctx context.Context) error

Run setups and starts echo bot.

type Suite

type Suite struct {
	TB require.TestingT
	// contains filtered or unexported fields
}

Suite is struct which contains external E2E test parameters.

func NewSuite

func NewSuite(tb require.TestingT, config TestOptions) *Suite

NewSuite creates new Suite.

func (*Suite) Authenticate

func (s *Suite) Authenticate(ctx context.Context, client auth.FlowClient) error

Authenticate authenticates client on test server.

func (*Suite) Client

func (s *Suite) Client(logger *zap.Logger, handler telegram.UpdateHandler) *telegram.Client

Client creates new *telegram.Client using this suite.

func (*Suite) RetryAuthenticate

func (s *Suite) RetryAuthenticate(ctx context.Context, client auth.FlowClient) error

RetryAuthenticate authenticates client on test server.

type TestOptions

type TestOptions struct {
	AppID   int
	AppHash string
	DC      int
	Random  io.Reader
	Logger  *zap.Logger
}

TestOptions contains some common test server settings.

type User

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

User is a simple user bot.

func NewUser

func NewUser(suite *Suite, text []string, username string) User

NewUser creates new User bot.

func (User) Run

func (u User) Run(ctx context.Context) error

Run setups and starts user bot.