tools

Documentation

Overview

Package tools provides utility functions for the service package.

Index

• Variables
• func RenderIfTemplatized(val interface{}) (bool, interface{}, error)
• type Service
  • func NewTools(logger *zap.Logger, testsetConfig TestSetConfig, testDB TestDB, ...) Service
• type TestDB
• type TestSetConfig
• type Tools
  • func (t *Tools) CreateConfig(_ context.Context, filePath string, configData string) error
  • func (t *Tools) Export(ctx context.Context) error
  • func (t *Tools) IgnoreTestSet(_ context.Context, _ string) error
  • func (t *Tools) IgnoreTests(_ context.Context, _ string, _ []string) error
  • func (t *Tools) Import(ctx context.Context, path, basePath string) error
  • func (t *Tools) Login(ctx context.Context) bool
  • func (t *Tools) ProcessTestCases(ctx context.Context, tcs []*models.TestCase, testSetID string) error
  • func (t *Tools) SendTelemetry(event string, output ...*sync.Map)
  • func (t *Tools) Templatize(ctx context.Context) error
  • func (t *Tools) Update(ctx context.Context) error

Variables

var ErrGitHubAPIUnresponsive = errors.New("GitHub API is unresponsive")

Functions

func RenderIfTemplatized

func RenderIfTemplatized(val interface{}) (bool, interface{}, error)

Types

type Service

type Service interface {
	Update(ctx context.Context) error
	CreateConfig(ctx context.Context, filePath string, config string) error
	SendTelemetry(event string, output ...*sync.Map)
	Login(ctx context.Context) bool
	Export(ctx context.Context) error
	Import(ctx context.Context, path, basePath string) error
	Templatize(ctx context.Context) error
}

func NewTools

func NewTools(logger *zap.Logger, testsetConfig TestSetConfig, testDB TestDB, telemetry teleDB, auth service.Auth, config *config.Config) Service

type TestDB

type TestDB interface {
	GetAllTestSetIDs(ctx context.Context) ([]string, error)
	GetTestCases(ctx context.Context, testSetID string) ([]*models.TestCase, error)
	UpdateTestCase(ctx context.Context, testCase *models.TestCase, testSetID string, enableLog bool) error
	DeleteTests(ctx context.Context, testSetID string, testCaseIDs []string) error
	DeleteTestSet(ctx context.Context, testSetID string) error
}

type TestSetConfig

type TestSetConfig interface {
	Read(ctx context.Context, testSetID string) (*models.TestSet, error)
	Write(ctx context.Context, testSetID string, testSet *models.TestSet) error
}

type Tools

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

func (*Tools) CreateConfig

func (t *Tools) CreateConfig(_ context.Context, filePath string, configData string) error

func (*Tools) Export

func (t *Tools) Export(ctx context.Context) error

func (*Tools) IgnoreTestSet

func (t *Tools) IgnoreTestSet(_ context.Context, _ string) error

func (*Tools) IgnoreTests

func (t *Tools) IgnoreTests(_ context.Context, _ string, _ []string) error

func (*Tools) Import

func (t *Tools) Import(ctx context.Context, path, basePath string) error

func (*Tools) Login

func (t *Tools) Login(ctx context.Context) bool

func (*Tools) ProcessTestCases

func (t *Tools) ProcessTestCases(ctx context.Context, tcs []*models.TestCase, testSetID string) error

func (*Tools) SendTelemetry

func (t *Tools) SendTelemetry(event string, output ...*sync.Map)

func (*Tools) Templatize

func (t *Tools) Templatize(ctx context.Context) error

func (*Tools) Update

func (t *Tools) Update(ctx context.Context) error

Update initiates the tools process for the Keploy binary file.