detector

Documentation

Index

• type Adapter
• type CurlTestAdapter
  • func (d CurlTestAdapter) GetSecretVariables(data string) (map[string]testkube.Variable, error)
  • func (d CurlTestAdapter) GetType() string
  • func (d CurlTestAdapter) Is(options apiClient.UpsertTestOptions) (name string, ok bool)
  • func (d CurlTestAdapter) IsEnvName(filename string) (string, string, bool)
  • func (d CurlTestAdapter) IsSecretEnvName(filename string) (string, string, bool)
  • func (d CurlTestAdapter) IsTestName(filename string) (string, bool)
• type Detector
  • func NewDefaultDetector() Detector
  • func (d *Detector) Add(adapter Adapter)
  • func (d *Detector) Detect(options client.UpsertTestOptions) (name string, found bool)
  • func (d *Detector) DetectEnvName(filename string) (name, env, testType string, found bool)
  • func (d *Detector) DetectSecretEnvName(filename string) (name, env, testType string, found bool)
  • func (d *Detector) DetectTestName(filename string) (name, testType string, found bool)
  • func (d *Detector) GetAdapter(testType string) Adapter
• type EnvFile
• type K6Adapter
  • func (d K6Adapter) GetSecretVariables(data string) (map[string]testkube.Variable, error)
  • func (d K6Adapter) GetType() string
  • func (d K6Adapter) Is(options apiClient.UpsertTestOptions) (name string, ok bool)
  • func (d K6Adapter) IsEnvName(filename string) (string, string, bool)
  • func (d K6Adapter) IsSecretEnvName(filename string) (string, string, bool)
  • func (d K6Adapter) IsTestName(filename string) (string, bool)
• type PostmanCollectionAdapter
  • func (d PostmanCollectionAdapter) GetSecretVariables(data string) (map[string]testkube.Variable, error)
  • func (d PostmanCollectionAdapter) GetType() string
  • func (d PostmanCollectionAdapter) Is(options apiClient.UpsertTestOptions) (name string, ok bool)
  • func (d PostmanCollectionAdapter) IsEnvName(filename string) (string, string, bool)
  • func (d PostmanCollectionAdapter) IsSecretEnvName(filename string) (string, string, bool)
  • func (d PostmanCollectionAdapter) IsTestName(filename string) (string, bool)
• type Value

Types

type Adapter

type Adapter interface {
	// Is detects based on upsert test options what kind of test it is
	Is(options apiClient.UpsertTestOptions) (string, bool)
	// IsTestName detecs if filename has a conventional test name
	IsTestName(filename string) (string, bool)
	// IsEnvName detecs if filename has a conventional env name
	IsEnvName(filename string) (string, string, bool)
	// IsSecretEnvName detecs if filename has a conventional secret env name
	IsSecretEnvName(filename string) (string, string, bool)
	// GetSecretVariables retuns secret variables
	GetSecretVariables(data string) (map[string]testkube.Variable, error)
	// GetType returns test type
	GetType() string
}

Adapter defines methods for test detection

type CurlTestAdapter

type CurlTestAdapter struct {
}

CurlTestAdapter is detector adapter for CURL like tests

func (CurlTestAdapter) GetSecretVariables

func (d CurlTestAdapter) GetSecretVariables(data string) (map[string]testkube.Variable, error)

GetSecretVariables retuns secret variables

func (CurlTestAdapter) GetType

func (d CurlTestAdapter) GetType() string

GetType returns test type

func (CurlTestAdapter) Is

func (d CurlTestAdapter) Is(options apiClient.UpsertTestOptions) (name string, ok bool)

Is detects based on upsert test options what kind of test it is

func (CurlTestAdapter) IsEnvName

func (d CurlTestAdapter) IsEnvName(filename string) (string, string, bool)

IsEnvName detecs if filename has a conventional env name

func (CurlTestAdapter) IsSecretEnvName

func (d CurlTestAdapter) IsSecretEnvName(filename string) (string, string, bool)

IsSecretEnvName detecs if filename has a conventional secret env name

func (CurlTestAdapter) IsTestName

func (d CurlTestAdapter) IsTestName(filename string) (string, bool)

IsTestName detecs if filename has a conventional test name

type Detector

type Detector struct {
	Adapters map[string]Adapter
}

Detector is detection orchestrator for possible detectors

func NewDefaultDetector

func NewDefaultDetector() Detector

func (*Detector) Add

func (d *Detector) Add(adapter Adapter)

Add adds adapter

func (*Detector) Detect

func (d *Detector) Detect(options client.UpsertTestOptions) (name string, found bool)

Detect detects test type

func (*Detector) DetectEnvName

func (d *Detector) DetectEnvName(filename string) (name, env, testType string, found bool)

DetectEnvName detects env name

func (*Detector) DetectSecretEnvName

func (d *Detector) DetectSecretEnvName(filename string) (name, env, testType string, found bool)

DetectSecretEnvName detecs secret env name

func (*Detector) DetectTestName

func (d *Detector) DetectTestName(filename string) (name, testType string, found bool)

DetectTestName detects test name

func (*Detector) GetAdapter

func (d *Detector) GetAdapter(testType string) Adapter

GetAdapter return adapter by test type

type EnvFile

type EnvFile struct {
	ID                   string    `json:"id"`
	Name                 string    `json:"name"`
	Values               []Value   `json:"values"`
	PostmanVariableScope string    `json:"_postman_variable_scope"`
	PostmanExportedAt    time.Time `json:"_postman_exported_at"`
	PostmanExportedUsing string    `json:"_postman_exported_using"`
}

EnvFile contains env file structure

type K6Adapter

type K6Adapter struct{}

K6Adapter is detector adapter for Postman collection saved as JSON content

func (K6Adapter) GetSecretVariables

func (d K6Adapter) GetSecretVariables(data string) (map[string]testkube.Variable, error)

GetSecretVariables retuns secret variables

func (K6Adapter) GetType

func (d K6Adapter) GetType() string

GetType returns test type

func (K6Adapter) Is

func (d K6Adapter) Is(options apiClient.UpsertTestOptions) (name string, ok bool)

Is detects based on upsert test options what kind of test it is

func (K6Adapter) IsEnvName

func (d K6Adapter) IsEnvName(filename string) (string, string, bool)

IsEnvName detecs if filename has a conventional env name

func (K6Adapter) IsSecretEnvName

func (d K6Adapter) IsSecretEnvName(filename string) (string, string, bool)

IsSecretEnvName detecs if filename has a conventional secret env name

func (K6Adapter) IsTestName

func (d K6Adapter) IsTestName(filename string) (string, bool)

IsTestName detecs if filename has a conventional test name

type PostmanCollectionAdapter

type PostmanCollectionAdapter struct {
}

PostmanCollectionAdapter is detector adapter for Postman collection saved as JSON content

func (PostmanCollectionAdapter) GetSecretVariables

func (d PostmanCollectionAdapter) GetSecretVariables(data string) (map[string]testkube.Variable, error)

GetSecretVariables retuns secret variables

func (PostmanCollectionAdapter) GetType

func (d PostmanCollectionAdapter) GetType() string

GetType returns test type

func (PostmanCollectionAdapter) Is

func (d PostmanCollectionAdapter) Is(options apiClient.UpsertTestOptions) (name string, ok bool)

Is detects based on upsert test options what kind of test it is

func (PostmanCollectionAdapter) IsEnvName

func (d PostmanCollectionAdapter) IsEnvName(filename string) (string, string, bool)

IsEnvName detecs if filename has a conventional env name

func (PostmanCollectionAdapter) IsSecretEnvName

func (d PostmanCollectionAdapter) IsSecretEnvName(filename string) (string, string, bool)

IsSecretEnvName detecs if filename has a conventional secret env name

func (PostmanCollectionAdapter) IsTestName

func (d PostmanCollectionAdapter) IsTestName(filename string) (string, bool)

IsTestName detecs if filename has a conventional test name

type Value

type Value struct {
	Key     string `json:"key"`
	Value   string `json:"value"`
	Enabled bool   `json:"enabled"`
}

Value contains value structure