keploy

Documentation

Index

• Constants
• Variables
• func PutMock(ctx context.Context, path string, mock *proto.Mock) bool
• func SetGrpcClient(c GrpcClient)
• func SetMode(m Mode) error
• func SetPath(path string)
• func SetTestMode()
• type Context
  • func GetState(ctx context.Context) (*Context, error)
• type GrpcClient
  • func GetGrpcClient() GrpcClient
• type KctxType
• type MockLib
  • func (m *MockLib) Load(name string)
  • func (m *MockLib) Unique(name string) bool
• type Mode
  • func GetMode() Mode
  • func GetModeFromContext(ctx context.Context) Mode
  • func (m Mode) Valid() bool

Constants

const (
	MODE_RECORD Mode     = "record"
	MODE_TEST   Mode     = "test"
	MODE_OFF    Mode     = "off"
	KCTX        KctxType = "KeployContext"
	KTime       KctxType = "KeployTime"
)

Variables

var (
	MockId   = MockLib{/* contains filtered or unexported fields */}
	MockPath string
)

Functions

func PutMock

func PutMock(ctx context.Context, path string, mock *proto.Mock) bool

func SetGrpcClient

func SetGrpcClient(c GrpcClient)

avoids circular dependency between mock and keploy packages

func SetMode

func SetMode(m Mode) error

SetMode sets the keploy SDK mode error is returned if the mode is invalid

func SetPath

func SetPath(path string)

func SetTestMode

func SetTestMode()

SetTestMode sets the keploy SDK mode to MODE_TEST

Types

type Context

type Context struct {
	Mode       Mode
	TestID     string
	FileExport bool
	Deps       []models.Dependency
	Mock       []*proto.Mock
	Mu         *sync.Mutex
	Remove     []string
	Replace    map[string]string
}

func GetState

func GetState(ctx context.Context) (*Context, error)

GetState returns value of "KeployContext" key-value pair which is stored in the request context.

type GrpcClient

type GrpcClient proto.RegressionServiceClient

func GetGrpcClient

func GetGrpcClient() GrpcClient

type KctxType

type KctxType string

type MockLib

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

func (*MockLib) Load

func (m *MockLib) Load(name string)

func (*MockLib) Unique

func (m *MockLib) Unique(name string) bool

To avoid creating the duplicate mock yaml file

type Mode

type Mode string

Mode represents the mode at which the SDK is operating MODE_RECORD is for recording API calls to generate testcases MODE_TEST is for testing the application on previous recorded testcases MODE_OFF disables keploy SDK automatically from the application

func GetMode

func GetMode() Mode

GetMode returns the mode of the keploy SDK

func GetModeFromContext

func GetModeFromContext(ctx context.Context) Mode

GetModeFromContext returns the mode on which SDK is configured by accessing environment variable.

func (Mode) Valid

func (m Mode) Valid() bool

Valid checks if the provided mode is valid