lib

Documentation

Index

• type AllParsedSecrets
• type AuthCfg
• type BasicAuthCfg
• type BearerAuthCfg
• type EnvironmentCfg
• type EnvironmentCfgs
• type EvalContext
  • func LoadEvalCtx(env string, execCtx *ExecutionContext) (*EvalContext, error)
• type ExecutionContext
• type ExternalFunctionCfg
• type ExternalFunctionCfgs
• type GofakeitFunc
• type ParsedSecret
• type Request
  • func LoadOnlyRequest(name string, evCtx *EvalContext, execCtx *ExecutionContext) (request *Request, err error)
  • func LoadWhole(name, env string, execCtx *ExecutionContext) (request *Request, err error)
  • func (request *Request) Exec() error
• type RequestAsVars
• type RequestCfg
• type RequestCfgs
• type RequestTiming
• type Requests
• type Response
• type RootCfg
• type SecretCfg
• type SecretCfgs
• type VariableCfg
• type VariableCfgs

Types

type AllParsedSecrets

type AllParsedSecrets map[string]ParsedSecret

type AuthCfg

type AuthCfg struct {
	BasicAuth  *BasicAuthCfg  `hcl:"basic,block"`
	BearerAuth *BearerAuthCfg `hcl:"bearer,block"`
}

type BasicAuthCfg

type BasicAuthCfg struct {
	Body hcl.Body `hcl:",remain"`
}

type BearerAuthCfg

type BearerAuthCfg struct {
	Body hcl.Body `hcl:",remain"`
}

type EnvironmentCfg

type EnvironmentCfg struct {
	Name      string     `hcl:"name,label"`
	Default   bool       `hcl:"default,optional"`
	Secrets   SecretCfgs `hcl:"secrets,block"`
	Variables hcl.Body   `hcl:",remain"`
}

type EnvironmentCfgs

type EnvironmentCfgs []*EnvironmentCfg

type EvalContext

type EvalContext struct {
	Functions     *map[string]function.Function
	Variables     *map[string]cty.Value
	Environment   *cty.Value
	RequestAsVars RequestAsVars
	RawRequests   RequestCfgs
	RawDynamics   VariableCfgs
}

func LoadEvalCtx

func LoadEvalCtx(env string, execCtx *ExecutionContext) (*EvalContext, error)

Get all internal functions Parse external functions Parse environment variables Parse variables Create EvalContext

type ExecutionContext

type ExecutionContext struct {
	Version string
	Debug   bool
}

type ExternalFunctionCfg

type ExternalFunctionCfg struct {
	Name        string   `hcl:"name,label"`
	Interpreter string   `hcl:"interpreter,attr"`
	Script      string   `hcl:"script,attr"`
	Args        []string `hcl:"args,optional"`
}

type ExternalFunctionCfgs

type ExternalFunctionCfgs []*ExternalFunctionCfg

type GofakeitFunc

type GofakeitFunc struct {
	Params []function.Parameter
	Type   function.TypeFunc
	Impl   function.ImplFunc
}

type ParsedSecret

type ParsedSecret map[string]string

type Request

type Request struct {
	Method  string
	Url     string
	Headers map[string]string
	Body    string
	EvalContext
	PrecedingRequests []*Response
	*Response
	*ExecutionContext
	RoundTripper http.RoundTripper
}

func LoadOnlyRequest

func LoadOnlyRequest(name string, evCtx *EvalContext, execCtx *ExecutionContext) (request *Request, err error)

Load only request with given EvalContext

func LoadWhole

func LoadWhole(name, env string, execCtx *ExecutionContext) (request *Request, err error)

Gather EvalContext and load given request

func (*Request) Exec

func (request *Request) Exec() error

type RequestAsVars

type RequestAsVars map[string]cty.Value

type RequestCfg

type RequestCfg struct {
	Name      string   `hcl:"name,label"`
	DependsOn []string `hcl:"depends_on,optional"`
	Body      hcl.Body `hcl:",remain"`
	Auth      *AuthCfg `hcl:"auth,block"`
}

type RequestCfgs

type RequestCfgs []*RequestCfg

type RequestTiming

type RequestTiming struct {
	// DNS resolve time
	Dns time.Duration
	// Time to establish connection
	Conn time.Duration
	// TLS handshake time
	Tls time.Duration
	// Time to first byte
	FirstByte time.Duration
	// Total request duration
	Total time.Duration
}

type Requests

type Requests map[string]map[string]cty.Value

type Response

type Response struct {
	Method     string
	Url        string
	StatusCode int
	Proto      string
	Body       []byte
	Headers    http.Header
	Timing     RequestTiming
	Request    *Request
}

type RootCfg

type RootCfg struct {
	Requests          RequestCfgs          `hcl:"request,block"`
	Variables         VariableCfgs         `hcl:"variable,block"`
	Dynamics          VariableCfgs         `hcl:"dynamic,block"`
	Environments      EnvironmentCfgs      `hcl:"env,block"`
	ExternalFunctions ExternalFunctionCfgs `hcl:"external-function,block"`
	Version           string               `hcl:"version,optional"`
}

type SecretCfg

type SecretCfg struct {
	Name  string            `hcl:"name,label"`
	Type  string            `hcl:"type,attr"`
	Paths map[string]string `hcl:"paths,attr"`
}

type SecretCfgs

type SecretCfgs []*SecretCfg

type VariableCfg

type VariableCfg struct {
	Name  string   `hcl:"name,label"`
	Value hcl.Body `hcl:"value,remain"`
}

type VariableCfgs

type VariableCfgs []*VariableCfg