platform

README

Platform Package Documentation

This package exposes a set of interfaces and methods for common data store operations such as creating, reading, updating, and deleting (CRUD) records.

Implementations for different types of data stores can be added here, all in one place. These implementations are abstracted from other logic using interface methods.

This package depends on the models package, using its structs to perform the CRUD operations.

Documentation

Index

• type KindSpecifier
• type TestCaseDB
• type TestReportDB

Types

type KindSpecifier

type KindSpecifier interface {
	GetKind() string
}

type TestCaseDB

type TestCaseDB interface {
	WriteTestcase(tc KindSpecifier, ctx context.Context, filters KindSpecifier) error
	WriteMock(tc KindSpecifier, ctx context.Context) error

	ReadTestcase(path string, lastSeenId KindSpecifier, options KindSpecifier) ([]KindSpecifier, error)
	ReadTcsMocks(tc KindSpecifier, path string) ([]KindSpecifier, error)
	ReadConfigMocks(path string) ([]KindSpecifier, error)
}

type TestReportDB

type TestReportDB interface {
	Lock()
	Unlock()
	SetResult(runId string, test KindSpecifier)
	GetResults(runId string) ([]KindSpecifier, error)
	Read(ctx context.Context, path, name string) (KindSpecifier, error)
	Write(ctx context.Context, path string, doc KindSpecifier) error
}