hrp

package
v0.0.0-...-dd20c9c Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 16, 2022 License: Apache-2.0 Imports: 50 Imported by: 0

README

代码阅读指南（golang 部分）

核心数据结构

HttpRunner 以 TestCase 为核心，将任意测试场景抽象为有序步骤的集合。

type TestCase struct {
	Config    *TConfig
	TestSteps []IStep
}

其中，测试步骤 IStep 采用了 go interface 的设计理念，支持进行任意拓展；步骤内容统一在 Run 方法中进行实现。

type IStep interface {
	Name() string
	Type() StepType
	Struct() *TStep
	Run(*SessionRunner) (*StepResult, error)
}

我们只需遵循 IStep 的接口定义，即可实现各种类型的测试步骤类型。当前 hrp 已支持的步骤类型包括：

  • request：发起单次 HTTP 请求
  • api：引用执行其它 API 文件
  • testcase：引用执行其它测试用例文件
  • thinktime：思考时间，按照配置的逻辑进行等待
  • transaction：事务机制，用于压测
  • rendezvous：集合点机制，用于压测

基于该机制，我们可以扩展支持新的协议类型，例如 HTTP2/WebSocket/RPC 等；同时也可以支持新的测试类型，例如 UI 自动化。甚至我们还可以在一个测试用例中混合调用多种不同的 Step 类型，例如实现 HTTP/RPC/UI 混合场景。

运行主流程

整体控制器 HRPRunner

执行接口测试时，会初始化一个 HRPRunner，用于控制测试的执行策略。

type HRPRunner struct {
	t             *testing.T
	failfast      bool
	requestsLogOn bool
	pluginLogOn   bool
	saveTests     bool
	genHTMLReport bool
	client        *http.Client
}

func (r *HRPRunner) Run(testcases ...ITestCase) error
func (r *HRPRunner) NewSessionRunner(testcase *TestCase) *SessionRunner

重点关注两个方法：

  • Run：测试执行的主入口，支持运行一个或多个测试用例
  • NewSessionRunner：针对给定的测试用例初始化一个 SessionRunner
用例执行器 SessionRunner

测试用例的具体执行都由 SessionRunner 完成，每个 TestCase 对应一个实例，在该实例中除了包含测试用例自身内容外，还会包含测试过程的 session 数据和最终测试结果 summary。

type SessionRunner struct {
	testCase         *TestCase
	hrpRunner        *HRPRunner
	parser           *Parser
	sessionVariables map[string]interface{}
	transactions map[string]map[transactionType]time.Time
	startTime    time.Time        // record start time of the testcase
	summary      *TestCaseSummary // record test case summary
}

重点关注一个方法：

  • Start：启动执行用例，依次执行所有测试步骤
func (r *SessionRunner) Start() error {
    ...
    // run step in sequential order
	for _, step := range r.testCase.TestSteps {
		_, err := step.Run(r)
		if err != nil && r.hrpRunner.failfast {
			return errors.Wrap(err, "abort running due to failfast setting")
		}
	}
    ...
}

在主流程中，SessionRunner 并不需要关注 step 的具体类型，统一都是调用 step.Run(r)，具体实现逻辑都在对应 step 的 Run(*SessionRunner) 方法中。

Documentation

Index

Constants

View Source 
const (
	PluginGoBuiltFile          = "debugtalk.so"      // built from go official plugin
	PluginHashicorpGoBuiltFile = "debugtalk.bin"     // built from hashicorp go plugin
	PluginGoSourceFile         = "debugtalk.go"      // golang function plugin source file
	PluginGoSourceGenFile      = "debugtalk_gen.go"  // generated for hashicorp go plugin
	PluginPySourceFile         = "debugtalk.py"      // python function plugin source file
	PluginPySourceGenFile      = ".debugtalk_gen.py" // generated for hashicorp python plugin
)

Variables

This section is empty.

Functions

func BuildPlugin 

func BuildPlugin(path string, output string) (err error)

func GetProjectRootDirPath 

func GetProjectRootDirPath(path string) (rootDir string, err error)

func Run 

func Run(testcases ...ITestCase) error

Run starts to run API test with default configs.

Types

type API 

type API struct {
	Name          string                 `json:"name" yaml:"name"` // required
	Request       *Request               `json:"request,omitempty" yaml:"request,omitempty"`
	Variables     map[string]interface{} `json:"variables,omitempty" yaml:"variables,omitempty"`
	SetupHooks    []string               `json:"setup_hooks,omitempty" yaml:"setup_hooks,omitempty"`
	TeardownHooks []string               `json:"teardown_hooks,omitempty" yaml:"teardown_hooks,omitempty"`
	Extract       map[string]string      `json:"extract,omitempty" yaml:"extract,omitempty"`
	Validators    []interface{}          `json:"validate,omitempty" yaml:"validate,omitempty"`
	Export        []string               `json:"export,omitempty" yaml:"export,omitempty"`
	Path          string
}

func (*API) GetPath 

func (api *API) GetPath() string

func (*API) ToAPI 

func (api *API) ToAPI() (*API, error)

type APIPath 

type APIPath string

APIPath implements IAPI interface.

func (*APIPath) GetPath 

func (path *APIPath) GetPath() string

func (*APIPath) ToAPI 

func (path *APIPath) ToAPI() (*API, error)

type ActionType 

type ActionType string

type Address 

type Address struct {
	ClientIP   string `json:"client_ip,omitempty" yaml:"client_ip,omitempty"`
	ClientPort string `json:"client_port,omitempty" yaml:"client_port,omitempty"`
	ServerIP   string `json:"server_ip,omitempty" yaml:"server_ip,omitempty"`
	ServerPort string `json:"server_port,omitempty" yaml:"server_port,omitempty"`
}

type HRPBoomer 

type HRPBoomer struct {
	*boomer.Boomer
	// contains filtered or unexported fields
}

func NewBoomer 

func NewBoomer(spawnCount int, spawnRate float64) *HRPBoomer

func (*HRPBoomer) Quit 

func (b *HRPBoomer) Quit()

func (*HRPBoomer) Run 

func (b *HRPBoomer) Run(testcases ...ITestCase)

Run starts to run load test for one or multiple testcases.

func (*HRPBoomer) SetClientTransport 

func (b *HRPBoomer) SetClientTransport() *HRPBoomer

func (*HRPBoomer) SetPython3Venv 

func (b *HRPBoomer) SetPython3Venv(venv string) *HRPBoomer

SetPython3Venv specifies python3 venv.

type HRPRunner 

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

func NewRunner 

func NewRunner(t *testing.T) *HRPRunner

NewRunner constructs a new runner instance.

func (*HRPRunner) GenHTMLReport 

func (r *HRPRunner) GenHTMLReport() *HRPRunner

GenHTMLReport configures whether to gen html report of api tests.

func (*HRPRunner) NewSessionRunner 

func (r *HRPRunner) NewSessionRunner(testcase *TestCase) (*SessionRunner, error)

NewSessionRunner creates a new session runner for testcase. each testcase has its own session runner

func (*HRPRunner) Run 

func (r *HRPRunner) Run(testcases ...ITestCase) error

Run starts to execute one or multiple testcases.

func (*HRPRunner) SetClientTransport 

func (r *HRPRunner) SetClientTransport(maxConns int, disableKeepAlive bool, disableCompression bool) *HRPRunner

SetClientTransport configures transport of http client for high concurrency load testing

func (*HRPRunner) SetFailfast 

func (r *HRPRunner) SetFailfast(failfast bool) *HRPRunner

SetFailfast configures whether to stop running when one step fails.

func (*HRPRunner) SetHTTPStatOn 

func (r *HRPRunner) SetHTTPStatOn() *HRPRunner

SetHTTPStatOn turns on HTTP latency stat.

func (*HRPRunner) SetPluginLogOn 

func (r *HRPRunner) SetPluginLogOn() *HRPRunner

SetPluginLogOn turns on plugin logging.

func (*HRPRunner) SetProxyUrl 

func (r *HRPRunner) SetProxyUrl(proxyUrl string) *HRPRunner

SetProxyUrl configures the proxy URL, which is usually used to capture HTTP packets for debugging.

func (*HRPRunner) SetPython3Venv 

func (r *HRPRunner) SetPython3Venv(venv string) *HRPRunner

SetPython3Venv specifies python3 venv.

func (*HRPRunner) SetRequestsLogOn 

func (r *HRPRunner) SetRequestsLogOn() *HRPRunner

SetRequestsLogOn turns on request & response details logging.

func (*HRPRunner) SetSaveTests 

func (r *HRPRunner) SetSaveTests(saveTests bool) *HRPRunner

SetSaveTests configures whether to save summary of tests.

type HTTPMethod 

type HTTPMethod string

type IAPI 

type IAPI interface {
	GetPath() string
	ToAPI() (*API, error)
}

IAPI represents interface for api, includes API and APIPath.

type IStep 

type IStep interface {
	Name() string
	Type() StepType
	Struct() *TStep
	Run(*SessionRunner) (*StepResult, error)
}

IStep represents interface for all types for teststeps, includes: StepRequest, StepRequestWithOptionalArgs, StepRequestValidation, StepRequestExtraction, StepTestCaseWithOptionalArgs, StepTransaction, StepRendezvous, StepWebSocket.

type ITestCase 

type ITestCase interface {
	GetPath() string
	ToTestCase() (*TestCase, error)
}

ITestCase represents interface for testcases, includes TestCase and TestCasePath.

type MessageType 

type MessageType int

type Parameters 

type Parameters []map[string]interface{}

[ 

{"username": "test1", "password": "111111"},
{"username": "test2", "password": "222222"},

]

type ParametersIterator 

type ParametersIterator struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*ParametersIterator) HasNext 

func (iter *ParametersIterator) HasNext() bool

func (*ParametersIterator) Next 

func (iter *ParametersIterator) Next() map[string]interface{}

func (*ParametersIterator) SetUnlimitedMode 

func (iter *ParametersIterator) SetUnlimitedMode()

SetUnlimitedMode is used for load testing

type Parser 

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

func (*Parser) CallFunc 

func (p *Parser) CallFunc(funcName string, arguments ...interface{}) (interface{}, error)

CallFunc calls function with arguments only support return at most one result value

func (*Parser) Parse 

func (p *Parser) Parse(raw interface{}, variablesMapping map[string]interface{}) (interface{}, error)

func (*Parser) ParseHeaders 

func (p *Parser) ParseHeaders(rawHeaders map[string]string, variablesMapping map[string]interface{}) (map[string]string, error)

func (*Parser) ParseString 

func (p *Parser) ParseString(raw string, variablesMapping map[string]interface{}) (interface{}, error)

ParseString parse string with variables

func (*Parser) ParseVariables 

func (p *Parser) ParseVariables(variables map[string]interface{}) (map[string]interface{}, error)

type Platform 

type Platform struct {
	HttprunnerVersion string `json:"httprunner_version" yaml:"httprunner_version"`
	GoVersion         string `json:"go_version" yaml:"go_version"`
	Platform          string `json:"platform" yaml:"platform"`
}

type Rendezvous 

type Rendezvous struct {
	Name    string  `json:"name" yaml:"name"`                           // required
	Percent float32 `json:"percent,omitempty" yaml:"percent,omitempty"` // default to 1(100%)
	Number  int64   `json:"number,omitempty" yaml:"number,omitempty"`
	Timeout int64   `json:"timeout,omitempty" yaml:"timeout,omitempty"` // milliseconds
	// contains filtered or unexported fields
}

type ReqResps 

type ReqResps struct {
	Request  interface{} `json:"request" yaml:"request"`
	Response interface{} `json:"response" yaml:"response"`
}

type Request 

type Request struct {
	Method         HTTPMethod             `json:"method" yaml:"method"` // required
	URL            string                 `json:"url" yaml:"url"`       // required
	HTTP2          bool                   `json:"http2,omitempty" yaml:"http2,omitempty"`
	Params         map[string]interface{} `json:"params,omitempty" yaml:"params,omitempty"`
	Headers        map[string]string      `json:"headers,omitempty" yaml:"headers,omitempty"`
	Cookies        map[string]string      `json:"cookies,omitempty" yaml:"cookies,omitempty"`
	Body           interface{}            `json:"body,omitempty" yaml:"body,omitempty"`
	Json           interface{}            `json:"json,omitempty" yaml:"json,omitempty"`
	Data           interface{}            `json:"data,omitempty" yaml:"data,omitempty"`
	Timeout        float32                `json:"timeout,omitempty" yaml:"timeout,omitempty"`
	AllowRedirects bool                   `json:"allow_redirects,omitempty" yaml:"allow_redirects,omitempty"`
	Verify         bool                   `json:"verify,omitempty" yaml:"verify,omitempty"`
}

Request represents HTTP request data structure. This is used for teststep.

type SessionData 

type SessionData struct {
	Success    bool                `json:"success" yaml:"success"`
	ReqResps   *ReqResps           `json:"req_resps" yaml:"req_resps"`
	Address    *Address            `json:"address,omitempty" yaml:"address,omitempty"` // TODO
	Validators []*ValidationResult `json:"validators,omitempty" yaml:"validators,omitempty"`
}

type SessionRunner 

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

SessionRunner is used to run testcase and its steps. each testcase has its own SessionRunner instance and share session variables.

func (*SessionRunner) GetConfig 

func (r *SessionRunner) GetConfig() *TConfig

func (*SessionRunner) GetParser 

func (r *SessionRunner) GetParser() *Parser

func (*SessionRunner) GetSummary 

func (r *SessionRunner) GetSummary() *TestCaseSummary

func (*SessionRunner) HTTPStatOn 

func (r *SessionRunner) HTTPStatOn() bool

func (*SessionRunner) LogOn 

func (r *SessionRunner) LogOn() bool

func (*SessionRunner) MergeStepVariables 

func (r *SessionRunner) MergeStepVariables(vars map[string]interface{}) (map[string]interface{}, error)

MergeStepVariables merges step variables with config variables and session variables

func (*SessionRunner) Start 

func (r *SessionRunner) Start(givenVars map[string]interface{}) error

Start runs the test steps in sequential order. givenVars is used for data driven

type Stat 

type Stat struct {
	TestCases TestCaseStat `json:"testcases" yaml:"test_cases"`
	TestSteps TestStepStat `json:"teststeps" yaml:"test_steps"`
}

type StepAPIWithOptionalArgs 

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

StepAPIWithOptionalArgs implements IStep interface.

func (*StepAPIWithOptionalArgs) Export 

func (s *StepAPIWithOptionalArgs) Export(names ...string) *StepAPIWithOptionalArgs

Export specifies variable names to export from referenced api for current step.

func (*StepAPIWithOptionalArgs) Name 

func (s *StepAPIWithOptionalArgs) Name() string

func (*StepAPIWithOptionalArgs) Run 

func (s *StepAPIWithOptionalArgs) Run(r *SessionRunner) (*StepResult, error)

func (*StepAPIWithOptionalArgs) Struct 

func (s *StepAPIWithOptionalArgs) Struct() *TStep

func (*StepAPIWithOptionalArgs) TeardownHook 

func (s *StepAPIWithOptionalArgs) TeardownHook(hook string) *StepAPIWithOptionalArgs

TeardownHook adds a teardown hook for current teststep.

func (*StepAPIWithOptionalArgs) Type 

func (s *StepAPIWithOptionalArgs) Type() StepType

type StepRendezvous 

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

StepRendezvous implements IStep interface.

func (*StepRendezvous) Name 

func (s *StepRendezvous) Name() string

func (*StepRendezvous) Run 

func (s *StepRendezvous) Run(r *SessionRunner) (*StepResult, error)

func (*StepRendezvous) Struct 

func (s *StepRendezvous) Struct() *TStep

func (*StepRendezvous) Type 

func (s *StepRendezvous) Type() StepType

func (*StepRendezvous) WithTimeout 

func (s *StepRendezvous) WithTimeout(timeout int64) *StepRendezvous

WithTimeout sets the timeout of duration between each user arriving at the current rendezvous

func (*StepRendezvous) WithUserNumber 

func (s *StepRendezvous) WithUserNumber(number int64) *StepRendezvous

WithUserNumber sets the user number needed to release the current rendezvous

func (*StepRendezvous) WithUserPercent 

func (s *StepRendezvous) WithUserPercent(percent float32) *StepRendezvous

WithUserPercent sets the user percent needed to release the current rendezvous

type StepRequest 

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

func NewStep 

func NewStep(name string) *StepRequest

NewStep returns a new constructed teststep with specified step name.

func (*StepRequest) CallRefAPI 

func (s *StepRequest) CallRefAPI(api IAPI) *StepAPIWithOptionalArgs

CallRefAPI calls a referenced api.

func (*StepRequest) CallRefCase 

func (s *StepRequest) CallRefCase(tc ITestCase) *StepTestCaseWithOptionalArgs

CallRefCase calls a referenced testcase.

func (*StepRequest) DELETE 

func (s *StepRequest) DELETE(url string) *StepRequestWithOptionalArgs

DELETE makes a HTTP DELETE request.

func (*StepRequest) EndTransaction 

func (s *StepRequest) EndTransaction(name string) *StepTransaction

EndTransaction ends a transaction.

func (*StepRequest) GET 

func (s *StepRequest) GET(url string) *StepRequestWithOptionalArgs

GET makes a HTTP GET request.

func (*StepRequest) HEAD 

func (s *StepRequest) HEAD(url string) *StepRequestWithOptionalArgs

HEAD makes a HTTP HEAD request.

func (*StepRequest) HTTP2 

func (s *StepRequest) HTTP2() *StepRequest

HTTP2 enables HTTP/2 protocol

func (*StepRequest) OPTIONS 

func (s *StepRequest) OPTIONS(url string) *StepRequestWithOptionalArgs

OPTIONS makes a HTTP OPTIONS request.

func (*StepRequest) PATCH 

func (s *StepRequest) PATCH(url string) *StepRequestWithOptionalArgs

PATCH makes a HTTP PATCH request.

func (*StepRequest) POST 

func (s *StepRequest) POST(url string) *StepRequestWithOptionalArgs

POST makes a HTTP POST request.

func (*StepRequest) PUT 

func (s *StepRequest) PUT(url string) *StepRequestWithOptionalArgs

PUT makes a HTTP PUT request.

func (*StepRequest) SetRendezvous 

func (s *StepRequest) SetRendezvous(name string) *StepRendezvous

SetRendezvous creates a new rendezvous

func (*StepRequest) SetThinkTime 

func (s *StepRequest) SetThinkTime(time float64) *StepThinkTime

SetThinkTime sets think time.

func (*StepRequest) SetupHook 

func (s *StepRequest) SetupHook(hook string) *StepRequest

SetupHook adds a setup hook for current teststep.

func (*StepRequest) StartTransaction 

func (s *StepRequest) StartTransaction(name string) *StepTransaction

StartTransaction starts a transaction.

func (*StepRequest) WebSocket 

func (s *StepRequest) WebSocket() *StepWebSocket

WebSocket creates a new websocket action

func (*StepRequest) WithVariables 

func (s *StepRequest) WithVariables(variables map[string]interface{}) *StepRequest

WithVariables sets variables for current teststep.

type StepRequestExtraction 

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

StepRequestExtraction implements IStep interface.

func (*StepRequestExtraction) Name 

func (s *StepRequestExtraction) Name() string

func (*StepRequestExtraction) Run 

func (s *StepRequestExtraction) Run(r *SessionRunner) (*StepResult, error)

func (*StepRequestExtraction) Struct 

func (s *StepRequestExtraction) Struct() *TStep

func (*StepRequestExtraction) Type 

func (s *StepRequestExtraction) Type() StepType

func (*StepRequestExtraction) Validate 

func (s *StepRequestExtraction) Validate() *StepRequestValidation

Validate switches to step validation.

func (*StepRequestExtraction) WithJmesPath 

func (s *StepRequestExtraction) WithJmesPath(jmesPath string, varName string) *StepRequestExtraction

WithJmesPath sets the JMESPath expression to extract from the response.

type StepRequestValidation 

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

StepRequestValidation implements IStep interface.

func (*StepRequestValidation) AssertContainedBy 

func (s *StepRequestValidation) AssertContainedBy(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertContains 

func (s *StepRequestValidation) AssertContains(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertEndsWith 

func (s *StepRequestValidation) AssertEndsWith(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertEqual 

func (s *StepRequestValidation) AssertEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertEqualFold 

func (s *StepRequestValidation) AssertEqualFold(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertGreater 

func (s *StepRequestValidation) AssertGreater(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertGreaterOrEqual 

func (s *StepRequestValidation) AssertGreaterOrEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertLengthEqual 

func (s *StepRequestValidation) AssertLengthEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertLengthGreaterOrEquals 

func (s *StepRequestValidation) AssertLengthGreaterOrEquals(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertLengthGreaterThan 

func (s *StepRequestValidation) AssertLengthGreaterThan(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertLengthLessOrEquals 

func (s *StepRequestValidation) AssertLengthLessOrEquals(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertLengthLessThan 

func (s *StepRequestValidation) AssertLengthLessThan(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertLess 

func (s *StepRequestValidation) AssertLess(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertLessOrEqual 

func (s *StepRequestValidation) AssertLessOrEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertNotEqual 

func (s *StepRequestValidation) AssertNotEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertRegexp 

func (s *StepRequestValidation) AssertRegexp(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertStartsWith 

func (s *StepRequestValidation) AssertStartsWith(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertStringEqual 

func (s *StepRequestValidation) AssertStringEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) AssertTypeMatch 

func (s *StepRequestValidation) AssertTypeMatch(jmesPath string, expected interface{}, msg string) *StepRequestValidation

func (*StepRequestValidation) Name 

func (s *StepRequestValidation) Name() string

func (*StepRequestValidation) Run 

func (s *StepRequestValidation) Run(r *SessionRunner) (*StepResult, error)

func (*StepRequestValidation) Struct 

func (s *StepRequestValidation) Struct() *TStep

func (*StepRequestValidation) Type 

func (s *StepRequestValidation) Type() StepType

type StepRequestWithOptionalArgs 

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

StepRequestWithOptionalArgs implements IStep interface.

func (*StepRequestWithOptionalArgs) Extract 

func (s *StepRequestWithOptionalArgs) Extract() *StepRequestExtraction

Extract switches to step extraction.

func (*StepRequestWithOptionalArgs) Name 

func (s *StepRequestWithOptionalArgs) Name() string

func (*StepRequestWithOptionalArgs) Run 

func (s *StepRequestWithOptionalArgs) Run(r *SessionRunner) (*StepResult, error)

func (*StepRequestWithOptionalArgs) SetAllowRedirects 

func (s *StepRequestWithOptionalArgs) SetAllowRedirects(allowRedirects bool) *StepRequestWithOptionalArgs

SetAllowRedirects sets whether to allow redirects for current HTTP request.

func (*StepRequestWithOptionalArgs) SetAuth 

func (s *StepRequestWithOptionalArgs) SetAuth(auth map[string]string) *StepRequestWithOptionalArgs

SetAuth sets auth for current HTTP request.

func (*StepRequestWithOptionalArgs) SetProxies 

func (s *StepRequestWithOptionalArgs) SetProxies(proxies map[string]string) *StepRequestWithOptionalArgs

SetProxies sets proxies for current HTTP request.

func (*StepRequestWithOptionalArgs) SetTimeout 

func (s *StepRequestWithOptionalArgs) SetTimeout(timeout float32) *StepRequestWithOptionalArgs

SetTimeout sets timeout for current HTTP request.

func (*StepRequestWithOptionalArgs) SetVerify 

func (s *StepRequestWithOptionalArgs) SetVerify(verify bool) *StepRequestWithOptionalArgs

SetVerify sets whether to verify SSL for current HTTP request.

func (*StepRequestWithOptionalArgs) Struct 

func (s *StepRequestWithOptionalArgs) Struct() *TStep

func (*StepRequestWithOptionalArgs) TeardownHook 

func (s *StepRequestWithOptionalArgs) TeardownHook(hook string) *StepRequestWithOptionalArgs

TeardownHook adds a teardown hook for current teststep.

func (*StepRequestWithOptionalArgs) Type 

func (s *StepRequestWithOptionalArgs) Type() StepType

func (*StepRequestWithOptionalArgs) Validate 

func (s *StepRequestWithOptionalArgs) Validate() *StepRequestValidation

Validate switches to step validation.

func (*StepRequestWithOptionalArgs) WithBody 

func (s *StepRequestWithOptionalArgs) WithBody(body interface{}) *StepRequestWithOptionalArgs

WithBody sets HTTP request body for current step.

func (*StepRequestWithOptionalArgs) WithCookies 

func (s *StepRequestWithOptionalArgs) WithCookies(cookies map[string]string) *StepRequestWithOptionalArgs

WithCookies sets HTTP request cookies for current step.

func (*StepRequestWithOptionalArgs) WithHeaders 

func (s *StepRequestWithOptionalArgs) WithHeaders(headers map[string]string) *StepRequestWithOptionalArgs

WithHeaders sets HTTP request headers for current step.

func (*StepRequestWithOptionalArgs) WithParams 

func (s *StepRequestWithOptionalArgs) WithParams(params map[string]interface{}) *StepRequestWithOptionalArgs

WithParams sets HTTP request params for current step.

type StepResult 

type StepResult struct {
	Name        string                 `json:"name" yaml:"name"`                                   // step name
	StepType    StepType               `json:"step_type" yaml:"step_type"`                         // step type, testcase/request/transaction/rendezvous
	Success     bool                   `json:"success" yaml:"success"`                             // step execution result
	Elapsed     int64                  `json:"elapsed_ms" yaml:"elapsed_ms"`                       // step execution time in millisecond(ms)
	HttpStat    map[string]int64       `json:"httpstat,omitempty" yaml:"httpstat,omitempty"`       // httpstat in millisecond(ms)
	Data        interface{}            `json:"data,omitempty" yaml:"data,omitempty"`               // session data or slice of step data
	ContentSize int64                  `json:"content_size" yaml:"content_size"`                   // response body length
	ExportVars  map[string]interface{} `json:"export_vars,omitempty" yaml:"export_vars,omitempty"` // extract variables
	Attachment  string                 `json:"attachment,omitempty" yaml:"attachment,omitempty"`   // step error information
}

type StepTestCaseWithOptionalArgs 

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

StepTestCaseWithOptionalArgs implements IStep interface.

func (*StepTestCaseWithOptionalArgs) Export 

func (s *StepTestCaseWithOptionalArgs) Export(names ...string) *StepTestCaseWithOptionalArgs

Export specifies variable names to export from referenced testcase for current step.

func (*StepTestCaseWithOptionalArgs) Name 

func (s *StepTestCaseWithOptionalArgs) Name() string

func (*StepTestCaseWithOptionalArgs) Run 

func (s *StepTestCaseWithOptionalArgs) Run(r *SessionRunner) (*StepResult, error)

func (*StepTestCaseWithOptionalArgs) Struct 

func (s *StepTestCaseWithOptionalArgs) Struct() *TStep

func (*StepTestCaseWithOptionalArgs) TeardownHook 

func (s *StepTestCaseWithOptionalArgs) TeardownHook(hook string) *StepTestCaseWithOptionalArgs

TeardownHook adds a teardown hook for current teststep.

func (*StepTestCaseWithOptionalArgs) Type 

func (s *StepTestCaseWithOptionalArgs) Type() StepType

type StepThinkTime 

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

StepThinkTime implements IStep interface.

func (*StepThinkTime) Name 

func (s *StepThinkTime) Name() string

func (*StepThinkTime) Run 

func (s *StepThinkTime) Run(r *SessionRunner) (*StepResult, error)

func (*StepThinkTime) Struct 

func (s *StepThinkTime) Struct() *TStep

func (*StepThinkTime) Type 

func (s *StepThinkTime) Type() StepType

type StepTransaction 

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

StepTransaction implements IStep interface.

func (*StepTransaction) Name 

func (s *StepTransaction) Name() string

func (*StepTransaction) Run 

func (s *StepTransaction) Run(r *SessionRunner) (*StepResult, error)

func (*StepTransaction) Struct 

func (s *StepTransaction) Struct() *TStep

func (*StepTransaction) Type 

func (s *StepTransaction) Type() StepType

type StepType 

type StepType string

type StepWebSocket 

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

StepWebSocket implements IStep interface.

func (*StepWebSocket) CloseConnection 

func (s *StepWebSocket) CloseConnection(url string) *StepWebSocket

func (*StepWebSocket) Extract 

func (s *StepWebSocket) Extract() *StepRequestExtraction

Extract switches to step extraction.

func (*StepWebSocket) Name 

func (s *StepWebSocket) Name() string

func (*StepWebSocket) NewConnection 

func (s *StepWebSocket) NewConnection() *StepWebSocket

func (*StepWebSocket) OpenConnection 

func (s *StepWebSocket) OpenConnection(url string) *StepWebSocket

func (*StepWebSocket) PingPong 

func (s *StepWebSocket) PingPong(url string) *StepWebSocket

func (*StepWebSocket) Read 

func (s *StepWebSocket) Read(url string) *StepWebSocket

func (*StepWebSocket) Run 

func (s *StepWebSocket) Run(r *SessionRunner) (*StepResult, error)

func (*StepWebSocket) Struct 

func (s *StepWebSocket) Struct() *TStep

func (*StepWebSocket) Type 

func (s *StepWebSocket) Type() StepType

func (*StepWebSocket) Validate 

func (s *StepWebSocket) Validate() *StepRequestValidation

Validate switches to step validation.

func (*StepWebSocket) WithBinaryMessage 

func (s *StepWebSocket) WithBinaryMessage(message interface{}) *StepWebSocket

func (*StepWebSocket) WithCloseStatus 

func (s *StepWebSocket) WithCloseStatus(closeStatus int64) *StepWebSocket

func (*StepWebSocket) WithHeaders 

func (s *StepWebSocket) WithHeaders(headers map[string]string) *StepWebSocket

func (*StepWebSocket) WithParams 

func (s *StepWebSocket) WithParams(params map[string]interface{}) *StepWebSocket

func (*StepWebSocket) WithTextMessage 

func (s *StepWebSocket) WithTextMessage(message interface{}) *StepWebSocket

func (*StepWebSocket) WithTimeout 

func (s *StepWebSocket) WithTimeout(timeout int64) *StepWebSocket

func (*StepWebSocket) Write 

func (s *StepWebSocket) Write(url string) *StepWebSocket

func (*StepWebSocket) WriteAndRead 

func (s *StepWebSocket) WriteAndRead(url string) *StepWebSocket

type Summary 

type Summary struct {
	Success  bool               `json:"success" yaml:"success"`
	Stat     *Stat              `json:"stat" yaml:"stat"`
	Time     *TestCaseTime      `json:"time" yaml:"time"`
	Platform *Platform          `json:"platform" yaml:"platform"`
	Details  []*TestCaseSummary `json:"details" yaml:"details"`
	// contains filtered or unexported fields
}

Summary stores tests summary for current task execution, maybe include one or multiple testcases

type TCase 

type TCase struct {
	Config    *TConfig `json:"config" yaml:"config"`
	TestSteps []*TStep `json:"teststeps" yaml:"teststeps"`
}

TCase represents testcase data structure. Each testcase includes one public config and several sequential teststeps.

func (*TCase) MakeCompat 

func (tc *TCase) MakeCompat() (err error)

MakeCompat converts TCase compatible with Golang engine style

type TConfig 

type TConfig struct {
	Name              string                 `json:"name" yaml:"name"` // required
	Verify            bool                   `json:"verify,omitempty" yaml:"verify,omitempty"`
	BaseURL           string                 `json:"base_url,omitempty" yaml:"base_url,omitempty"`   // deprecated in v4.1, moved to env
	Headers           map[string]string      `json:"headers,omitempty" yaml:"headers,omitempty"`     // public request headers
	Environs          map[string]string      `json:"environs,omitempty" yaml:"environs,omitempty"`   // environment variables
	Variables         map[string]interface{} `json:"variables,omitempty" yaml:"variables,omitempty"` // global variables
	Parameters        map[string]interface{} `json:"parameters,omitempty" yaml:"parameters,omitempty"`
	ParametersSetting *TParamsConfig         `json:"parameters_setting,omitempty" yaml:"parameters_setting,omitempty"`
	ThinkTimeSetting  *ThinkTimeConfig       `json:"think_time,omitempty" yaml:"think_time,omitempty"`
	WebSocketSetting  *WebSocketConfig       `json:"websocket,omitempty" yaml:"websocket,omitempty"`
	Export            []string               `json:"export,omitempty" yaml:"export,omitempty"`
	Weight            int                    `json:"weight,omitempty" yaml:"weight,omitempty"`
	Path              string                 `json:"path,omitempty" yaml:"path,omitempty"` // testcase file path
}

TConfig represents config data structure for testcase. Each testcase should contain one config part.

func NewConfig 

func NewConfig(name string) *TConfig

NewConfig returns a new constructed testcase config with specified testcase name.

func (*TConfig) ExportVars 

func (c *TConfig) ExportVars(vars ...string) *TConfig

ExportVars specifies variable names to export for current testcase.

func (*TConfig) SetBaseURL 

func (c *TConfig) SetBaseURL(baseURL string) *TConfig

SetBaseURL sets base URL for current testcase.

func (*TConfig) SetHeaders 

func (c *TConfig) SetHeaders(headers map[string]string) *TConfig

SetHeaders sets global headers for current testcase.

func (*TConfig) SetThinkTime 

func (c *TConfig) SetThinkTime(strategy thinkTimeStrategy, cfg interface{}, limit float64) *TConfig

SetThinkTime sets think time config for current testcase.

func (*TConfig) SetVerifySSL 

func (c *TConfig) SetVerifySSL(verify bool) *TConfig

SetVerifySSL sets whether to verify SSL for current testcase.

func (*TConfig) SetWebSocket 

func (c *TConfig) SetWebSocket(times, interval, timeout, size int64)

func (*TConfig) SetWeight 

func (c *TConfig) SetWeight(weight int) *TConfig

SetWeight sets weight for current testcase, which is used in load testing.

func (*TConfig) WithParameters 

func (c *TConfig) WithParameters(parameters map[string]interface{}) *TConfig

WithParameters sets parameters for current testcase.

func (*TConfig) WithVariables 

func (c *TConfig) WithVariables(variables map[string]interface{}) *TConfig

WithVariables sets variables for current testcase.

type TParamsConfig 

type TParamsConfig struct {
	PickOrder  iteratorPickOrder           `json:"pick_order,omitempty" yaml:"pick_order,omitempty"` // overall pick-order strategy
	Strategies map[string]iteratorStrategy `json:"strategies,omitempty" yaml:"strategies,omitempty"` // individual strategies for each parameters
	Limit      int                         `json:"limit,omitempty" yaml:"limit,omitempty"`
}

type TStep 

type TStep struct {
	Name          string                 `json:"name" yaml:"name"` // required
	Request       *Request               `json:"request,omitempty" yaml:"request,omitempty"`
	API           interface{}            `json:"api,omitempty" yaml:"api,omitempty"`           // *APIPath or *API
	TestCase      interface{}            `json:"testcase,omitempty" yaml:"testcase,omitempty"` // *TestCasePath or *TestCase
	Transaction   *Transaction           `json:"transaction,omitempty" yaml:"transaction,omitempty"`
	Rendezvous    *Rendezvous            `json:"rendezvous,omitempty" yaml:"rendezvous,omitempty"`
	ThinkTime     *ThinkTime             `json:"think_time,omitempty" yaml:"think_time,omitempty"`
	WebSocket     *WebSocketAction       `json:"websocket,omitempty" yaml:"websocket,omitempty"`
	Variables     map[string]interface{} `json:"variables,omitempty" yaml:"variables,omitempty"`
	SetupHooks    []string               `json:"setup_hooks,omitempty" yaml:"setup_hooks,omitempty"`
	TeardownHooks []string               `json:"teardown_hooks,omitempty" yaml:"teardown_hooks,omitempty"`
	Extract       map[string]string      `json:"extract,omitempty" yaml:"extract,omitempty"`
	Validators    []interface{}          `json:"validate,omitempty" yaml:"validate,omitempty"`
	Export        []string               `json:"export,omitempty" yaml:"export,omitempty"`
}

TStep represents teststep data structure. Each step maybe three different types: make one request or reference another api/testcase.

type TestCase 

type TestCase struct {
	Config    *TConfig
	TestSteps []IStep
}

TestCase is a container for one testcase, which is used for testcase runner. TestCase implements ITestCase interface.

func LoadTestCases 

func LoadTestCases(iTestCases ...ITestCase) ([]*TestCase, error)

func (*TestCase) GetPath 

func (tc *TestCase) GetPath() string

func (*TestCase) ToTCase 

func (tc *TestCase) ToTCase() *TCase

func (*TestCase) ToTestCase 

func (tc *TestCase) ToTestCase() (*TestCase, error)

type TestCaseInOut 

type TestCaseInOut struct {
	ConfigVars map[string]interface{} `json:"config_vars" yaml:"config_vars"`
	ExportVars map[string]interface{} `json:"export_vars" yaml:"export_vars"`
}

type TestCasePath 

type TestCasePath string

TestCasePath implements ITestCase interface.

func (*TestCasePath) GetPath 

func (path *TestCasePath) GetPath() string

func (*TestCasePath) ToTestCase 

func (path *TestCasePath) ToTestCase() (*TestCase, error)

ToTestCase loads testcase path and convert to *TestCase

type TestCaseStat 

type TestCaseStat struct {
	Total   int `json:"total" yaml:"total"`
	Success int `json:"success" yaml:"success"`
	Fail    int `json:"fail" yaml:"fail"`
}

type TestCaseSummary 

type TestCaseSummary struct {
	Name    string         `json:"name" yaml:"name"`
	Success bool           `json:"success" yaml:"success"`
	CaseId  string         `json:"case_id,omitempty" yaml:"case_id,omitempty"` // TODO
	Stat    *TestStepStat  `json:"stat" yaml:"stat"`
	Time    *TestCaseTime  `json:"time" yaml:"time"`
	InOut   *TestCaseInOut `json:"in_out" yaml:"in_out"`
	Log     string         `json:"log,omitempty" yaml:"log,omitempty"` // TODO
	Records []*StepResult  `json:"records" yaml:"records"`
	RootDir string         `json:"root_dir" yaml:"root_dir"`
}

TestCaseSummary stores tests summary for one testcase

type TestCaseTime 

type TestCaseTime struct {
	StartAt  time.Time `json:"start_at,omitempty" yaml:"start_at,omitempty"`
	Duration float64   `json:"duration,omitempty" yaml:"duration,omitempty"`
}

type TestStepStat 

type TestStepStat struct {
	Total     int `json:"total" yaml:"total"`
	Successes int `json:"successes" yaml:"successes"`
	Failures  int `json:"failures" yaml:"failures"`
}

type ThinkTime 

type ThinkTime struct {
	Time float64 `json:"time" yaml:"time"`
}

type ThinkTimeConfig 

type ThinkTimeConfig struct {
	Strategy thinkTimeStrategy `json:"strategy,omitempty" yaml:"strategy,omitempty"` // default、random、limit、multiply、ignore
	Setting  interface{}       `json:"setting,omitempty" yaml:"setting,omitempty"`   // random(map): {"min_percentage": 0.5, "max_percentage": 1.5}; 10、multiply(float64): 1.5
	Limit    float64           `json:"limit,omitempty" yaml:"limit,omitempty"`       // limit think time no more than specific time, ignore if value <= 0
}

type Transaction 

type Transaction struct {
	Name string          `json:"name" yaml:"name"`
	Type transactionType `json:"type" yaml:"type"`
}

type ValidationResult 

type ValidationResult struct {
	Validator
	CheckValue  interface{} `json:"check_value" yaml:"check_value"`
	CheckResult string      `json:"check_result" yaml:"check_result"`
}

type Validator 

type Validator struct {
	Check   string      `json:"check" yaml:"check"` // get value with jmespath
	Assert  string      `json:"assert" yaml:"assert"`
	Expect  interface{} `json:"expect" yaml:"expect"`
	Message string      `json:"msg,omitempty" yaml:"msg,omitempty"` // optional
}

Validator represents validator for one HTTP response.

type WebSocketAction 

type WebSocketAction struct {
	Type            ActionType             `json:"type" yaml:"type"`
	URL             string                 `json:"url" yaml:"url"`
	Params          map[string]interface{} `json:"params,omitempty" yaml:"params,omitempty"`
	Headers         map[string]string      `json:"headers,omitempty" yaml:"headers,omitempty"`
	NewConnection   bool                   `json:"new_connection,omitempty" yaml:"new_connection,omitempty"` // TODO support
	TextMessage     interface{}            `json:"text,omitempty" yaml:"text,omitempty"`
	BinaryMessage   interface{}            `json:"binary,omitempty" yaml:"binary,omitempty"`
	CloseStatusCode int64                  `json:"close_status,omitempty" yaml:"close_status,omitempty"`
	Timeout         int64                  `json:"timeout,omitempty" yaml:"timeout,omitempty"`
}

type WebSocketConfig 

type WebSocketConfig struct {
	ReconnectionTimes    int64 `json:"reconnection_times,omitempty" yaml:"reconnection_times,omitempty"`       // maximum reconnection times when the connection closed by remote server
	ReconnectionInterval int64 `json:"reconnection_interval,omitempty" yaml:"reconnection_interval,omitempty"` // interval between each reconnection in milliseconds
	MaxMessageSize       int64 `json:"max_message_size,omitempty" yaml:"max_message_size,omitempty"`           // maximum message size during writing/reading
}

WebSocketConfig TODO: support reconnection ability

Source Files

View all Source files

Directories

Path Synopsis
cmd
cli
internal
boomer
builtin
convert
httpstat
Package httpstat traces HTTP latency infomation (DNSLookup, TCP Connection and so on) on any golang HTTP request.
 Package httpstat traces HTTP latency infomation (DNSLookup, TCP Connection and so on) on any golang HTTP request.
json
pytest
scaffold
scaffold/templates/plugin
NOTE: Generated By hrp v4.1.3, DO NOT EDIT!
 NOTE: Generated By hrp v4.1.3, DO NOT EDIT!
sdk
version
wiki

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.