From d1fa8ffbd445642859e67e4e176d2a8f4bcdbd0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Thu, 23 Dec 2021 21:29:01 +0800 Subject: [PATCH 01/53] feat: data-driven. --- parser.go | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/parser.go b/parser.go index 9bc0df8a..5e1dc018 100644 --- a/parser.go +++ b/parser.go @@ -492,3 +492,21 @@ func findallVariables(raw string) variableSet { return varSet } + +//func parseParameters(parameters map[string]interface{}) []map[string]interface{} { +// for k, v := range parameters { +// parameter_name_list := strings.Split(k, "-") +// rawValue := reflect.ValueOf(v) +// switch rawValue.Kind() { +// case reflect.String: +// var varList []map[string]interface{} +// +// case reflect.Slice: +// for i := 0; i < rawValue.Len(); i++ { +// rawValue.Index(i).Interface() +// } +// default: +// panic(fmt.Sprintf("parameter content should be List or Text(variables or functions call), got %v", v)) +// } +// } +//} From f43450fa6e01ead9cf1eb4396cbbba1de2b45034 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Mon, 27 Dec 2021 15:31:49 +0800 Subject: [PATCH 02/53] feat: data-driven. --- convert.go | 32 ++++++++++++ examples/demo.yaml | 7 +++ parser.go | 126 +++++++++++++++++++++++++++++++++++++-------- runner.go | 26 ++++++---- 4 files changed, 160 insertions(+), 31 deletions(-) diff --git a/convert.go b/convert.go index 7f1bc830..f7579334 100644 --- a/convert.go +++ b/convert.go @@ -2,10 +2,12 @@ package hrp import ( "bytes" + "encoding/csv" "encoding/json" "fmt" "io/ioutil" "path/filepath" + "strings" "github.com/rs/zerolog/log" "gopkg.in/yaml.v3" @@ -94,6 +96,36 @@ func loadFromYAML(path string) (*TCase, error) { return tc, err } +func loadFromCSV(path string) []map[string]string { + path, err := filepath.Abs(path) + if err != nil { + log.Error().Str("path", path).Err(err).Msg("convert absolute path failed") + return nil + } + log.Info().Str("path", path).Msg("load csv file") + + file, err := ioutil.ReadFile(path) + if err != nil { + log.Error().Err(err).Msg("load csv file failed") + return nil + } + r := csv.NewReader(strings.NewReader(string(file))) + content, err := r.ReadAll() + if err != nil { + log.Error().Err(err).Msg("parse csv file failed") + return nil + } + var result []map[string]string + for i := 1; i < len(content); i++ { + row := make(map[string]string) + for j := 0; j < len(content[i]); j++ { + row[content[0][j]] = content[i][j] + } + result = append(result, row) + } + return result +} + func (tc *TCase) ToTestCase() (*TestCase, error) { testCase := &TestCase{ Config: &Config{cfg: tc.Config}, diff --git a/examples/demo.yaml b/examples/demo.yaml index a0cee432..e0f70360 100644 --- a/examples/demo.yaml +++ b/examples/demo.yaml @@ -7,6 +7,11 @@ config: "n": 5 varFoo1: ${gen_random_string($n)} varFoo2: ${max($a, $b)} + parameters: + username-password: ${parameterize(examples/account.csv)} + user_agent: ["iOS/10.1", "iOS/10.2"] + parameters_setting: + strategy: random teststeps: - name: transaction 1 start transaction: @@ -19,6 +24,8 @@ teststeps: params: foo1: $varFoo1 foo2: $varFoo2 + foo3: $username + foo4: $password headers: User-Agent: HttpRunnerPlus variables: diff --git a/parser.go b/parser.go index e6ecc85e..10ec4a59 100644 --- a/parser.go +++ b/parser.go @@ -9,6 +9,7 @@ import ( "strings" "github.com/maja42/goval" + "github.com/pkg/errors" "github.com/rs/zerolog/log" "github.com/httprunner/hrp/internal/builtin" @@ -247,15 +248,35 @@ func mergeVariables(variables, overriddenVariables map[string]interface{}) map[s return mergedVariables } -// callFunc call function with arguments -// only support return at most one result value -func callFunc(funcName string, arguments ...interface{}) (interface{}, error) { - function, ok := builtin.Functions[funcName] - if !ok { +func contains(s []string, e string) bool { + for _, a := range s { + if strings.EqualFold(a, e) { + return true + } + } + return false +} + +func getMappingFunction(funcName string) (interface{}, error) { + if function, ok := builtin.Functions[funcName]; ok { + // function is builtin + return function, nil + } else if contains([]string{"parameterize", "P"}, funcName) { + // parameterize function + return loadFromCSV, nil + } else { // function not found return nil, fmt.Errorf("function %s is not found", funcName) } +} +// callFunc call function with arguments +// only support return at most one result value +func callFunc(funcName string, arguments ...interface{}) (interface{}, error) { + function, err := getMappingFunction(funcName) + if err != nil { + return nil, err + } funcValue := reflect.ValueOf(function) if funcValue.Kind() != reflect.Func { // function not valid @@ -494,20 +515,81 @@ func findallVariables(raw string) variableSet { return varSet } -//func parseParameters(parameters map[string]interface{}) []map[string]interface{} { -// for k, v := range parameters { -// parameter_name_list := strings.Split(k, "-") -// rawValue := reflect.ValueOf(v) -// switch rawValue.Kind() { -// case reflect.String: -// var varList []map[string]interface{} -// -// case reflect.Slice: -// for i := 0; i < rawValue.Len(); i++ { -// rawValue.Index(i).Interface() -// } -// default: -// panic(fmt.Sprintf("parameter content should be List or Text(variables or functions call), got %v", v)) -// } -// } -//} +func genCartesianProduct(params [][]map[string]interface{}) []map[string]interface{} { + var cartesianProduct []map[string]interface{} + for i := 0; i < len(params)-1; i++ { + for _, param1 := range params[i] { + for _, param2 := range params[i+1] { + cartesianProduct = append(cartesianProduct, mergeVariables(param1, param2)) + } + } + } + return cartesianProduct +} + +func parseParameters(parameters map[string]interface{}, variablesMapping map[string]interface{}) ([]map[string]interface{}, error) { + var parsedParametersList [][]map[string]interface{} + for k, v := range parameters { + parameterNameList := strings.Split(k, "-") + var parameterList []map[string]interface{} + rawValue := reflect.ValueOf(v) + switch rawValue.Kind() { + case reflect.String: + parsedParameterContent, err := parseData(rawValue.Interface(), variablesMapping) + if err != nil { + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parse parameter error") + return nil, err + } + parsedParameterRawValue := reflect.ValueOf(parsedParameterContent) + if parsedParameterRawValue.Kind() != reflect.Slice { + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be List or Text(variables or functions call), got %v") + return nil, errors.New("parameter content should be List or Text(variables or functions call)") + } + for i := 0; i < parsedParameterRawValue.Len(); i++ { + parameterMap := make(map[string]interface{}) + if parsedParameterRawValue.Index(i).Kind() == reflect.Map { + for _, key := range parameterNameList { + parameterMap[key] = parsedParameterRawValue.Index(i).MapIndex(reflect.ValueOf(key)).Interface() + } + } else if parsedParameterRawValue.Index(i).Kind() == reflect.Slice { + if len(parameterNameList) != parsedParameterRawValue.Index(i).Len() { + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter name list and parameter content list should have the same length") + return nil, errors.New("parameter name list and parameter content list should have the same length") + } + for i := 0; i < parsedParameterRawValue.Index(i).Len(); i++ { + parameterMap[parameterNameList[i]] = parsedParameterRawValue.Index(i).Index(i).Interface() + } + } else if len(parameterNameList) == 1 { + parameterMap[parameterNameList[0]] = parsedParameterRawValue.Index(i).Interface() + } else { + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be List or Text(variables or functions call), got %v") + return nil, errors.New("parameter content should be List or Text(variables or functions call)") + } + parameterList = append(parameterList, parameterMap) + } + case reflect.Slice: + for i := 0; i < rawValue.Len(); i++ { + parameterMap := make(map[string]interface{}) + if rawValue.Index(i).Kind() == reflect.Interface || rawValue.Index(i).Kind() == reflect.String { + parameterMap[parameterNameList[0]] = rawValue.Index(i).Interface() + } else if rawValue.Index(i).Kind() == reflect.Slice { + if len(parameterNameList) != rawValue.Index(i).Len() { + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter name list and parameter content list should have the same length") + return nil, errors.New("parameter name list and parameter content list should have the same length") + } + for i := 0; i < rawValue.Index(i).Len(); i++ { + parameterMap[parameterNameList[i]] = rawValue.Index(i).Index(i).Interface() + } + } else { + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be List or Text(variables or functions call), got %v") + return nil, errors.New("parameter content should be List or Text(variables or functions call)") + } + parameterList = append(parameterList, parameterMap) + } + default: + panic(fmt.Sprintf("parameter content should be List or Text(variables or functions call), got %v", v)) + } + parsedParametersList = append(parsedParametersList, parameterList) + } + return genCartesianProduct(parsedParametersList), nil +} diff --git a/runner.go b/runner.go index 9f89495a..b54dc9ba 100644 --- a/runner.go +++ b/runner.go @@ -130,15 +130,24 @@ func (r *hrpRunner) runCase(testcase *TestCase) error { } log.Info().Str("testcase", config.Name()).Msg("run testcase start") - r.startTime = time.Now() - for _, step := range testcase.TestSteps { - _, err := r.runStep(step, config) - if err != nil { - if r.failfast { - log.Error().Err(err).Msg("abort running due to failfast setting") - return err + // parse config parameters + parsedParams, err := parseParameters(config.ToStruct().Parameters, config.ToStruct().Variables) + if err != nil { + log.Error().Interface("params", config.ToStruct().Parameters).Err(err).Msg("parse config parameters failed") + return err + } + for _, parameter := range parsedParams { + config.ToStruct().Variables = mergeVariables(parameter, config.ToStruct().Variables) + r.startTime = time.Now() + for _, step := range testcase.TestSteps { + _, err := r.runStep(step, config) + if err != nil { + if r.failfast { + log.Error().Err(err).Msg("abort running due to failfast setting") + return err + } + log.Warn().Err(err).Msg("run step failed, continue next step") } - log.Warn().Err(err).Msg("run step failed, continue next step") } } @@ -465,7 +474,6 @@ func (r *hrpRunner) parseConfig(config IConfig) error { return err } cfg.Variables = parsedVariables - // parse config name parsedName, err := parseString(cfg.Name, cfg.Variables) if err != nil { From 09ff0cd9185def7ff8b1b897d343eaf7b785034e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Mon, 27 Dec 2021 22:03:16 +0800 Subject: [PATCH 03/53] feat: data-driven. --- boomer.go | 9 +++++++-- models.go | 15 ++++++++------- parser.go | 32 ++++++++++++++++++++++++++++++-- runner.go | 13 ++++--------- 4 files changed, 49 insertions(+), 20 deletions(-) diff --git a/boomer.go b/boomer.go index fb8b5d71..c70bb005 100644 --- a/boomer.go +++ b/boomer.go @@ -45,8 +45,13 @@ func (b *hrpBoomer) Run(testcases ...ITestCase) { if err != nil { panic(err) } - task := b.convertBoomerTask(testcase) - taskSlice = append(taskSlice, task) + cfg := testcase.Config.ToStruct() + parameters := getParameters(testcase.Config) + for _, parameter := range parameters { + cfg.Variables = mergeVariables(parameter, cfg.Variables) + task := b.convertBoomerTask(testcase) + taskSlice = append(taskSlice, task) + } } b.Boomer.Run(taskSlice...) } diff --git a/models.go b/models.go index cbaf4b4e..703623fc 100644 --- a/models.go +++ b/models.go @@ -13,13 +13,14 @@ const ( // TConfig represents config data structure for testcase. // Each testcase should contain one config part. 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"` - Variables map[string]interface{} `json:"variables,omitempty" yaml:"variables,omitempty"` - Parameters map[string]interface{} `json:"parameters,omitempty" yaml:"parameters,omitempty"` - Export []string `json:"export,omitempty" yaml:"export,omitempty"` - Weight int `json:"weight,omitempty" yaml:"weight,omitempty"` + 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"` + Variables map[string]interface{} `json:"variables,omitempty" yaml:"variables,omitempty"` + Parameters map[string]interface{} `json:"parameters,omitempty" yaml:"parameters,omitempty"` + ParametersSetting map[string]interface{} `json:"parameters_setting,omitempty" yaml:"parameters_setting,omitempty"` + Export []string `json:"export,omitempty" yaml:"export,omitempty"` + Weight int `json:"weight,omitempty" yaml:"weight,omitempty"` } // Request represents HTTP request data structure. diff --git a/parser.go b/parser.go index 10ec4a59..7fe8e410 100644 --- a/parser.go +++ b/parser.go @@ -3,10 +3,12 @@ package hrp import ( "encoding/json" "fmt" + "math/rand" "net/url" "reflect" "regexp" "strings" + "time" "github.com/maja42/goval" "github.com/pkg/errors" @@ -515,18 +517,44 @@ func findallVariables(raw string) variableSet { return varSet } +func shuffleCartesianProduct(slice []map[string]interface{}) { + r := rand.New(rand.NewSource(time.Now().Unix())) + for len(slice) > 0 { + n := len(slice) + randIndex := r.Intn(n) + slice[n-1], slice[randIndex] = slice[randIndex], slice[n-1] + slice = slice[:n-1] + } +} + func genCartesianProduct(params [][]map[string]interface{}) []map[string]interface{} { var cartesianProduct []map[string]interface{} + cartesianProduct = params[0] for i := 0; i < len(params)-1; i++ { - for _, param1 := range params[i] { + var tempProduct []map[string]interface{} + for _, param1 := range cartesianProduct { for _, param2 := range params[i+1] { - cartesianProduct = append(cartesianProduct, mergeVariables(param1, param2)) + tempProduct = append(tempProduct, mergeVariables(param1, param2)) } } + cartesianProduct = tempProduct } return cartesianProduct } +func getParameters(config IConfig) []map[string]interface{} { + cfg := config.ToStruct() + // parse config parameters + parsedParams, err := parseParameters(cfg.Parameters, cfg.Variables) + if err != nil { + log.Error().Interface("params", cfg.Parameters).Err(err).Msg("parse config parameters failed") + } + if cfg.ParametersSetting["strategy"] != nil && strings.ToLower(cfg.ParametersSetting["strategy"].(string)) == "random" { + shuffleCartesianProduct(parsedParams) + } + return parsedParams +} + func parseParameters(parameters map[string]interface{}, variablesMapping map[string]interface{}) ([]map[string]interface{}, error) { var parsedParametersList [][]map[string]interface{} for k, v := range parameters { diff --git a/runner.go b/runner.go index 24d77ef6..18dff670 100644 --- a/runner.go +++ b/runner.go @@ -128,16 +128,11 @@ func (r *hrpRunner) runCase(testcase *TestCase) error { if err := r.parseConfig(config); err != nil { return err } - + cfg := config.ToStruct() log.Info().Str("testcase", config.Name()).Msg("run testcase start") - // parse config parameters - parsedParams, err := parseParameters(config.ToStruct().Parameters, config.ToStruct().Variables) - if err != nil { - log.Error().Interface("params", config.ToStruct().Parameters).Err(err).Msg("parse config parameters failed") - return err - } - for _, parameter := range parsedParams { - config.ToStruct().Variables = mergeVariables(parameter, config.ToStruct().Variables) + parameters := getParameters(config) + for _, parameter := range parameters { + cfg.Variables = mergeVariables(parameter, cfg.Variables) r.startTime = time.Now() for _, step := range testcase.TestSteps { _, err := r.runStep(step, config) From 2f5afb5ffcf7bc8636ab361dd65d1c3f3e3db875 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Mon, 27 Dec 2021 22:20:29 +0800 Subject: [PATCH 04/53] feat: data-driven. --- parser.go | 46 +++++----------------------------------------- utils.go | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 41 deletions(-) create mode 100644 utils.go diff --git a/parser.go b/parser.go index 7fe8e410..eed50964 100644 --- a/parser.go +++ b/parser.go @@ -3,16 +3,13 @@ package hrp import ( "encoding/json" "fmt" - "math/rand" + "github.com/maja42/goval" + "github.com/pkg/errors" + "github.com/rs/zerolog/log" "net/url" "reflect" "regexp" "strings" - "time" - - "github.com/maja42/goval" - "github.com/pkg/errors" - "github.com/rs/zerolog/log" "github.com/httprunner/hrp/internal/builtin" ) @@ -250,15 +247,6 @@ func mergeVariables(variables, overriddenVariables map[string]interface{}) map[s return mergedVariables } -func contains(s []string, e string) bool { - for _, a := range s { - if strings.EqualFold(a, e) { - return true - } - } - return false -} - func getMappingFunction(funcName string) (interface{}, error) { if function, ok := builtin.Functions[funcName]; ok { // function is builtin @@ -517,31 +505,6 @@ func findallVariables(raw string) variableSet { return varSet } -func shuffleCartesianProduct(slice []map[string]interface{}) { - r := rand.New(rand.NewSource(time.Now().Unix())) - for len(slice) > 0 { - n := len(slice) - randIndex := r.Intn(n) - slice[n-1], slice[randIndex] = slice[randIndex], slice[n-1] - slice = slice[:n-1] - } -} - -func genCartesianProduct(params [][]map[string]interface{}) []map[string]interface{} { - var cartesianProduct []map[string]interface{} - cartesianProduct = params[0] - for i := 0; i < len(params)-1; i++ { - var tempProduct []map[string]interface{} - for _, param1 := range cartesianProduct { - for _, param2 := range params[i+1] { - tempProduct = append(tempProduct, mergeVariables(param1, param2)) - } - } - cartesianProduct = tempProduct - } - return cartesianProduct -} - func getParameters(config IConfig) []map[string]interface{} { cfg := config.ToStruct() // parse config parameters @@ -615,7 +578,8 @@ func parseParameters(parameters map[string]interface{}, variablesMapping map[str parameterList = append(parameterList, parameterMap) } default: - panic(fmt.Sprintf("parameter content should be List or Text(variables or functions call), got %v", v)) + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be List or Text(variables or functions call), got %v") + return nil, errors.New("parameter content should be List or Text(variables or functions call)") } parsedParametersList = append(parsedParametersList, parameterList) } diff --git a/utils.go b/utils.go new file mode 100644 index 00000000..455e0ff7 --- /dev/null +++ b/utils.go @@ -0,0 +1,41 @@ +package hrp + +import ( + "math/rand" + "strings" + "time" +) + +func contains(s []string, e string) bool { + for _, a := range s { + if strings.EqualFold(a, e) { + return true + } + } + return false +} + +func shuffleCartesianProduct(slice []map[string]interface{}) { + r := rand.New(rand.NewSource(time.Now().Unix())) + for len(slice) > 0 { + n := len(slice) + randIndex := r.Intn(n) + slice[n-1], slice[randIndex] = slice[randIndex], slice[n-1] + slice = slice[:n-1] + } +} + +func genCartesianProduct(params [][]map[string]interface{}) []map[string]interface{} { + var cartesianProduct []map[string]interface{} + cartesianProduct = params[0] + for i := 0; i < len(params)-1; i++ { + var tempProduct []map[string]interface{} + for _, param1 := range cartesianProduct { + for _, param2 := range params[i+1] { + tempProduct = append(tempProduct, mergeVariables(param1, param2)) + } + } + cartesianProduct = tempProduct + } + return cartesianProduct +} From 36d3e5a87772ca9ac2439c7ed2ffd5ca6b5b5374 Mon Sep 17 00:00:00 2001 From: debugtalk Date: Tue, 28 Dec 2021 14:19:07 +0800 Subject: [PATCH 05/53] Revert "Update License" --- LICENSE | 862 +++++++++++++------------------------------------------- 1 file changed, 201 insertions(+), 661 deletions(-) diff --git a/LICENSE b/LICENSE index 0815c492..186ade81 100644 --- a/LICENSE +++ b/LICENSE @@ -1,661 +1,201 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) 2021 debugtalk - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published - by the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 debugtalk + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. From 43deb78b26b42f94ec5cc37f2a72349ac15ed464 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 28 Dec 2021 18:16:02 +0800 Subject: [PATCH 06/53] feat: data-driven. --- boomer.go | 3 + convert.go | 6 +- examples/account.csv | 4 + examples/demo.yaml | 7 -- examples/parameters_test.json | 57 ++++++++++++++ examples/parameters_test.yaml | 38 +++++++++ internal/builtin/function.go | 5 ++ parser.go | 141 ++++++++++++++++++++++++---------- parser_test.go | 53 +++++++++++++ runner.go | 3 + utils.go | 41 ---------- 11 files changed, 268 insertions(+), 90 deletions(-) create mode 100644 examples/account.csv create mode 100644 examples/parameters_test.json create mode 100644 examples/parameters_test.yaml delete mode 100644 utils.go diff --git a/boomer.go b/boomer.go index c70bb005..62b8933e 100644 --- a/boomer.go +++ b/boomer.go @@ -47,6 +47,9 @@ func (b *hrpBoomer) Run(testcases ...ITestCase) { } cfg := testcase.Config.ToStruct() parameters := getParameters(testcase.Config) + if parameters == nil { + parameters = []map[string]interface{}{{}} + } for _, parameter := range parameters { cfg.Variables = mergeVariables(parameter, cfg.Variables) task := b.convertBoomerTask(testcase) diff --git a/convert.go b/convert.go index f7579334..ba3b8d15 100644 --- a/convert.go +++ b/convert.go @@ -100,20 +100,20 @@ func loadFromCSV(path string) []map[string]string { path, err := filepath.Abs(path) if err != nil { log.Error().Str("path", path).Err(err).Msg("convert absolute path failed") - return nil + panic(err) } log.Info().Str("path", path).Msg("load csv file") file, err := ioutil.ReadFile(path) if err != nil { log.Error().Err(err).Msg("load csv file failed") - return nil + panic(err) } r := csv.NewReader(strings.NewReader(string(file))) content, err := r.ReadAll() if err != nil { log.Error().Err(err).Msg("parse csv file failed") - return nil + panic(err) } var result []map[string]string for i := 1; i < len(content); i++ { diff --git a/examples/account.csv b/examples/account.csv new file mode 100644 index 00000000..67ce22c6 --- /dev/null +++ b/examples/account.csv @@ -0,0 +1,4 @@ +username,password +test1,111111 +test2,222222 +test3,333333 \ No newline at end of file diff --git a/examples/demo.yaml b/examples/demo.yaml index e0f70360..a0cee432 100644 --- a/examples/demo.yaml +++ b/examples/demo.yaml @@ -7,11 +7,6 @@ config: "n": 5 varFoo1: ${gen_random_string($n)} varFoo2: ${max($a, $b)} - parameters: - username-password: ${parameterize(examples/account.csv)} - user_agent: ["iOS/10.1", "iOS/10.2"] - parameters_setting: - strategy: random teststeps: - name: transaction 1 start transaction: @@ -24,8 +19,6 @@ teststeps: params: foo1: $varFoo1 foo2: $varFoo2 - foo3: $username - foo4: $password headers: User-Agent: HttpRunnerPlus variables: diff --git a/examples/parameters_test.json b/examples/parameters_test.json new file mode 100644 index 00000000..6ad52032 --- /dev/null +++ b/examples/parameters_test.json @@ -0,0 +1,57 @@ +{ + "config": { + "name": "request methods testcase: validate with parameters", + "parameters": { + "user_agent": [ + "iOS/10.1", + "iOS/10.2" + ], + "username-password": "${parameterize(examples/account.csv)}", + "app_version": "${getAppVersion()}" + }, + "parameters_setting": { + "strategy": "random" + }, + "variables": { + "app_version": "f1" + }, + "base_url": "https://postman-echo.com", + "verify": false + }, + "teststeps": [ + { + "name": "get with params", + "variables": { + "foo1": "$username", + "foo2": "$password", + "foo3": "$app_version" + }, + "request": { + "method": "GET", + "url": "/get", + "params": { + "foo1": "$foo1", + "foo2": "$foo2", + "foo3": "$foo3" + }, + "headers": { + "User-Agent": "$user_agent,$app_version" + } + }, + "validate": [ + { + "check": "status_code", + "assert": "equals", + "expect": 200, + "msg": "check status code" + }, + { + "check": "body.args.foo3", + "assert": "not_equal", + "expect": "f1", + "msg": "check app version" + } + ] + } + ] +} \ No newline at end of file diff --git a/examples/parameters_test.yaml b/examples/parameters_test.yaml new file mode 100644 index 00000000..7afb4252 --- /dev/null +++ b/examples/parameters_test.yaml @@ -0,0 +1,38 @@ +config: + name: "request methods testcase: validate with parameters" + parameters: + user_agent: ["iOS/10.1", "iOS/10.2"] + username-password: ${parameterize(examples/account.csv)} + app_version: ${getAppVersion()} + parameters_setting: + strategy: random + variables: + app_version: f1 + base_url: "https://postman-echo.com" + verify: False + +teststeps: +- + name: get with params + variables: + foo1: $username + foo2: $password + foo3: $app_version + request: + method: GET + url: /get + params: + foo1: $foo1 + foo2: $foo2 + foo3: $foo3 + headers: + User-Agent: $user_agent,$app_version + validate: + - check: status_code + assert: equals + expect: 200 + msg: check status code + - check: body.args.foo3 + assert: not_equal + expect: f1 + msg: check app version \ No newline at end of file diff --git a/internal/builtin/function.go b/internal/builtin/function.go index d1d3dd3b..2384d654 100644 --- a/internal/builtin/function.go +++ b/internal/builtin/function.go @@ -14,6 +14,7 @@ var Functions = map[string]interface{}{ "gen_random_string": genRandomString, // call with one argument "max": math.Max, // call with two arguments "md5": MD5, + "getAppVersion": getAppVersion, // test } func init() { @@ -44,3 +45,7 @@ func MD5(str string) string { hasher.Write([]byte(str)) return hex.EncodeToString(hasher.Sum(nil)) } + +func getAppVersion() []float64 { + return []float64{3.1, 3.3} +} diff --git a/parser.go b/parser.go index eed50964..e95946c8 100644 --- a/parser.go +++ b/parser.go @@ -3,13 +3,16 @@ package hrp import ( "encoding/json" "fmt" - "github.com/maja42/goval" - "github.com/pkg/errors" - "github.com/rs/zerolog/log" + "math/rand" "net/url" "reflect" "regexp" "strings" + "time" + + "github.com/maja42/goval" + "github.com/pkg/errors" + "github.com/rs/zerolog/log" "github.com/httprunner/hrp/internal/builtin" ) @@ -247,6 +250,15 @@ func mergeVariables(variables, overriddenVariables map[string]interface{}) map[s return mergedVariables } +func contains(s []string, e string) bool { + for _, a := range s { + if strings.EqualFold(a, e) { + return true + } + } + return false +} + func getMappingFunction(funcName string) (interface{}, error) { if function, ok := builtin.Functions[funcName]; ok { // function is builtin @@ -505,12 +517,43 @@ func findallVariables(raw string) variableSet { return varSet } +func shuffleCartesianProduct(slice []map[string]interface{}) { + if slice == nil || len(slice) == 0 { + return + } + r := rand.New(rand.NewSource(time.Now().Unix())) + for len(slice) > 0 { + n := len(slice) + randIndex := r.Intn(n) + slice[n-1], slice[randIndex] = slice[randIndex], slice[n-1] + slice = slice[:n-1] + } +} + +func genCartesianProduct(params [][]map[string]interface{}) []map[string]interface{} { + if params == nil || len(params) == 0 { + return nil + } + var cartesianProduct []map[string]interface{} + cartesianProduct = params[0] + for i := 0; i < len(params)-1; i++ { + var tempProduct []map[string]interface{} + for _, param1 := range cartesianProduct { + for _, param2 := range params[i+1] { + tempProduct = append(tempProduct, mergeVariables(param1, param2)) + } + } + cartesianProduct = tempProduct + } + return cartesianProduct +} + func getParameters(config IConfig) []map[string]interface{} { cfg := config.ToStruct() // parse config parameters parsedParams, err := parseParameters(cfg.Parameters, cfg.Variables) if err != nil { - log.Error().Interface("params", cfg.Parameters).Err(err).Msg("parse config parameters failed") + log.Error().Interface("parameters", cfg.Parameters).Err(err).Msg("parse config parameters failed") } if cfg.ParametersSetting["strategy"] != nil && strings.ToLower(cfg.ParametersSetting["strategy"].(string)) == "random" { shuffleCartesianProduct(parsedParams) @@ -519,10 +562,13 @@ func getParameters(config IConfig) []map[string]interface{} { } func parseParameters(parameters map[string]interface{}, variablesMapping map[string]interface{}) ([]map[string]interface{}, error) { - var parsedParametersList [][]map[string]interface{} + if parameters == nil || len(parameters) == 0 { + return nil, nil + } + var parsedParametersSlice [][]map[string]interface{} for k, v := range parameters { - parameterNameList := strings.Split(k, "-") - var parameterList []map[string]interface{} + parameterNameSlice := strings.Split(k, "-") + var parameterSlice []map[string]interface{} rawValue := reflect.ValueOf(v) switch rawValue.Kind() { case reflect.String: @@ -533,55 +579,72 @@ func parseParameters(parameters map[string]interface{}, variablesMapping map[str } parsedParameterRawValue := reflect.ValueOf(parsedParameterContent) if parsedParameterRawValue.Kind() != reflect.Slice { - log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be List or Text(variables or functions call), got %v") - return nil, errors.New("parameter content should be List or Text(variables or functions call)") + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parsed parameter content should be Slice, got %v") + return nil, errors.New("parsed parameter content should be Slice") } for i := 0; i < parsedParameterRawValue.Len(); i++ { parameterMap := make(map[string]interface{}) - if parsedParameterRawValue.Index(i).Kind() == reflect.Map { - for _, key := range parameterNameList { - parameterMap[key] = parsedParameterRawValue.Index(i).MapIndex(reflect.ValueOf(key)).Interface() + // e.g. + elem := reflect.ValueOf(parsedParameterRawValue.Index(i).Interface()) + if elem.Kind() == reflect.Map { + // e.g. [{"username": "test1", "password": "passwd1", "other": "111"}, {"username": "test2", "password": "passwd2", "other": ""222}] + // -> [{"username": "test1", "password": "passwd1"}, {"username": "test2", "password": "passwd2"}] (username, password in parameterNameSlice) + for _, key := range parameterNameSlice { + if _, ok := elem.Interface().(map[string]string)[key]; ok { + parameterMap[key] = elem.MapIndex(reflect.ValueOf(key)).Interface() + } else { + log.Error().Interface("parameterNameSlice", parameterNameSlice).Msg("[parseParameters] parameter name not found") + return nil, errors.New("parameter name not found") + } } - } else if parsedParameterRawValue.Index(i).Kind() == reflect.Slice { - if len(parameterNameList) != parsedParameterRawValue.Index(i).Len() { - log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter name list and parameter content list should have the same length") - return nil, errors.New("parameter name list and parameter content list should have the same length") + } else if elem.Kind() == reflect.Slice { + // e.g. [["test1", "passwd1"], ["test2", "passwd2"]] -> [{"username": "test1", "password": "passwd1"}, {"username": "test2", "password": "passwd2"}] + if len(parameterNameSlice) != elem.Len() { + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter name Slice and parameter content Slice should have the same length") + return nil, errors.New("parameter name Slice and parameter cjntent Slice should have the same length") + } else { + for j := 0; j < elem.Len(); j++ { + parameterMap[parameterNameSlice[j]] = elem.Index(j).Interface() + } } - for i := 0; i < parsedParameterRawValue.Index(i).Len(); i++ { - parameterMap[parameterNameList[i]] = parsedParameterRawValue.Index(i).Index(i).Interface() - } - } else if len(parameterNameList) == 1 { - parameterMap[parameterNameList[0]] = parsedParameterRawValue.Index(i).Interface() } else { - log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be List or Text(variables or functions call), got %v") - return nil, errors.New("parameter content should be List or Text(variables or functions call)") + // e.g. ${getAppVersion()} -> [3.1, 3.0] -> [{"app_version": 3.1}, {"app_version": 3.0}] + if len(parameterNameSlice) != 1 { + log.Error().Interface("parameterNameSlice", parameterNameSlice).Msg("[parseParameters] parameter name slice should have only one element when parameter content is string") + return nil, errors.New("parameter name slice should have only one element when parameter content is string") + } + parameterMap[parameterNameSlice[0]] = elem.Interface() } - parameterList = append(parameterList, parameterMap) + parameterSlice = append(parameterSlice, parameterMap) } case reflect.Slice: for i := 0; i < rawValue.Len(); i++ { parameterMap := make(map[string]interface{}) - if rawValue.Index(i).Kind() == reflect.Interface || rawValue.Index(i).Kind() == reflect.String { - parameterMap[parameterNameList[0]] = rawValue.Index(i).Interface() - } else if rawValue.Index(i).Kind() == reflect.Slice { - if len(parameterNameList) != rawValue.Index(i).Len() { - log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter name list and parameter content list should have the same length") - return nil, errors.New("parameter name list and parameter content list should have the same length") + elem := reflect.ValueOf(rawValue.Index(i).Interface()) + if elem.Kind() == reflect.Slice { + // e.g. username-password: [["test1", "passwd1"], ["test2", "passwd2"]] + if len(parameterNameSlice) != elem.Len() { + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter name Slice and parameter content Slice should have the same length") + return nil, errors.New("parameter name Slice and parameter content Slice should have the same length") } - for i := 0; i < rawValue.Index(i).Len(); i++ { - parameterMap[parameterNameList[i]] = rawValue.Index(i).Index(i).Interface() + for j := 0; j < elem.Len(); j++ { + parameterMap[parameterNameSlice[j]] = elem.Index(j).Interface() } } else { - log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be List or Text(variables or functions call), got %v") - return nil, errors.New("parameter content should be List or Text(variables or functions call)") + // e.g. user_agent: ["iOS/10.1", "iOS/10.2"] + if len(parameterNameSlice) != 1 { + log.Error().Interface("parameterNameSlice", parameterNameSlice).Msg("[parseParameters] parameter name slice should have only one element when parameter content is string") + return nil, errors.New("parameter name slice should have only one element when parameter content is string") + } + parameterMap[parameterNameSlice[0]] = elem.Interface() } - parameterList = append(parameterList, parameterMap) + parameterSlice = append(parameterSlice, parameterMap) } default: - log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be List or Text(variables or functions call), got %v") - return nil, errors.New("parameter content should be List or Text(variables or functions call)") + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be Slice or Text(variables or functions call)") + return nil, errors.New("parameter content should be Slice or Text(variables or functions call)") } - parsedParametersList = append(parsedParametersList, parameterList) + parsedParametersSlice = append(parsedParametersSlice, parameterSlice) } - return genCartesianProduct(parsedParametersList), nil + return genCartesianProduct(parsedParametersSlice), nil } diff --git a/parser_test.go b/parser_test.go index 33f3ae76..194f70f1 100644 --- a/parser_test.go +++ b/parser_test.go @@ -618,3 +618,56 @@ func TestFindallVariables(t *testing.T) { } } } + +func TestParseParameters(t *testing.T) { + testData := []struct { + rawVars map[string]interface{} + expectVars []map[string]interface{} + }{ + { + map[string]interface{}{"username-password": "${parameterize(examples/account.csv)}", "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + []map[string]interface{}{{"username": "test1", "password": "111111", "user_agent": "IOS/10.1"}, + {"username": "test1", "password": "111111", "user_agent": "IOS/10.2"}, + {"username": "test2", "password": "222222", "user_agent": "IOS/10.1"}, + {"username": "test2", "password": "222222", "user_agent": "IOS/10.2"}, + {"username": "test3", "password": "333333", "user_agent": "IOS/10.1"}, + {"username": "test3", "password": "333333", "user_agent": "IOS/10.2"}}, + }, + { + map[string]interface{}{}, + nil, + }, + { + nil, + nil, + }, + } + for _, data := range testData { + value, _ := parseParameters(data.rawVars, map[string]interface{}{}) + if !assert.Equal(t, data.expectVars, value) { + t.Fail() + } + } +} + +func TestParseParametersError(t *testing.T) { + testData := []struct { + rawVars map[string]interface{} + }{ + { + map[string]interface{}{"username_password": "${parameterize(examples/account.csv)}", "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + }, + { + map[string]interface{}{"username-password": "${parameterize(examples/account.csv)}", "user-agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + }, + { + map[string]interface{}{"username-password": "${param(examples/account.csv)}", "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + }, + } + for _, data := range testData { + _, err := parseParameters(data.rawVars, map[string]interface{}{}) + if !assert.Error(t, err) { + t.Fail() + } + } +} diff --git a/runner.go b/runner.go index 18dff670..fea5b69b 100644 --- a/runner.go +++ b/runner.go @@ -131,6 +131,9 @@ func (r *hrpRunner) runCase(testcase *TestCase) error { cfg := config.ToStruct() log.Info().Str("testcase", config.Name()).Msg("run testcase start") parameters := getParameters(config) + if parameters == nil { + parameters = []map[string]interface{}{{}} + } for _, parameter := range parameters { cfg.Variables = mergeVariables(parameter, cfg.Variables) r.startTime = time.Now() diff --git a/utils.go b/utils.go deleted file mode 100644 index 455e0ff7..00000000 --- a/utils.go +++ /dev/null @@ -1,41 +0,0 @@ -package hrp - -import ( - "math/rand" - "strings" - "time" -) - -func contains(s []string, e string) bool { - for _, a := range s { - if strings.EqualFold(a, e) { - return true - } - } - return false -} - -func shuffleCartesianProduct(slice []map[string]interface{}) { - r := rand.New(rand.NewSource(time.Now().Unix())) - for len(slice) > 0 { - n := len(slice) - randIndex := r.Intn(n) - slice[n-1], slice[randIndex] = slice[randIndex], slice[n-1] - slice = slice[:n-1] - } -} - -func genCartesianProduct(params [][]map[string]interface{}) []map[string]interface{} { - var cartesianProduct []map[string]interface{} - cartesianProduct = params[0] - for i := 0; i < len(params)-1; i++ { - var tempProduct []map[string]interface{} - for _, param1 := range cartesianProduct { - for _, param2 := range params[i+1] { - tempProduct = append(tempProduct, mergeVariables(param1, param2)) - } - } - cartesianProduct = tempProduct - } - return cartesianProduct -} From 60accfb8eb1b3d0708aea603b5d373f75c469814 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 29 Dec 2021 14:46:05 +0800 Subject: [PATCH 07/53] add interface request verification method. --- internal/builtin/assertion.go | 85 +++++++++++++++++++++++++++++++++-- parser_test.go | 38 ++++++++++++---- 2 files changed, 110 insertions(+), 13 deletions(-) diff --git a/internal/builtin/assertion.go b/internal/builtin/assertion.go index 31110221..a6395566 100644 --- a/internal/builtin/assertion.go +++ b/internal/builtin/assertion.go @@ -2,6 +2,7 @@ package builtin import ( "fmt" + "reflect" "strings" "github.com/stretchr/testify/assert" @@ -18,10 +19,14 @@ var Assertions = map[string]func(t assert.TestingT, expected interface{}, actual "contains": assert.Contains, "regex_match": assert.Regexp, // custom assertions - "startswith": StartsWith, // check if string starts with substring - "endswith": EndsWith, // check if string ends with substring - "length_equals": EqualLength, - "length_equal": EqualLength, // alias for length_equals + "startswith": StartsWith, // check if string starts with substring + "endswith": EndsWith, // check if string ends with substring + "length_equals": EqualLength, + "length_equal": EqualLength, // alias for length_equals + "length_less_than": LessThanLength, + "length_less_or_equals": LessOrEqualsLength, + "length_greater_than": GreaterThanLength, + "length_greater_or_equals": GreaterOrEqualsLength, } func StartsWith(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { @@ -57,6 +62,66 @@ func EqualLength(t assert.TestingT, expected, actual interface{}, msgAndArgs ... return assert.Len(t, actual, length, msgAndArgs...) } +func GreaterThanLength(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { + length, err := convertInt(expected) + if err != nil { + return assert.Fail(t, fmt.Sprintf("expected type is not int, got %#v", expected), msgAndArgs...) + } + ok, l := getLen(actual) + if !ok { + return assert.Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", actual), msgAndArgs...) + } + if l > length { + return assert.Fail(t, fmt.Sprintf("\"%s\" should be more than %d item(s), but has %d", actual, length, l), msgAndArgs...) + } + return true +} + +func GreaterOrEqualsLength(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { + length, err := convertInt(expected) + if err != nil { + return assert.Fail(t, fmt.Sprintf("expected type is not int, got %#v", expected), msgAndArgs...) + } + ok, l := getLen(actual) + if !ok { + return assert.Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", actual), msgAndArgs...) + } + if l >= length { + return assert.Fail(t, fmt.Sprintf("\"%s\" should be no less than %d item(s), but has %d", actual, length, l), msgAndArgs...) + } + return true +} + +func LessThanLength(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { + length, err := convertInt(expected) + if err != nil { + return assert.Fail(t, fmt.Sprintf("expected type is not int, got %#v", expected), msgAndArgs...) + } + ok, l := getLen(actual) + if !ok { + return assert.Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", actual), msgAndArgs...) + } + if l < length { + return assert.Fail(t, fmt.Sprintf("\"%s\" should be less than %d item(s), but has %d", actual, length, l), msgAndArgs...) + } + return true +} + +func LessOrEqualsLength(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { + length, err := convertInt(expected) + if err != nil { + return assert.Fail(t, fmt.Sprintf("expected type is not int, got %#v", expected), msgAndArgs...) + } + ok, l := getLen(actual) + if !ok { + return assert.Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", actual), msgAndArgs...) + } + if l <= length { + return assert.Fail(t, fmt.Sprintf("\"%s\" should be no more than %d item(s), but has %d", actual, length, l), msgAndArgs...) + } + return true +} + func convertInt(value interface{}) (int, error) { switch v := value.(type) { case int: @@ -83,3 +148,15 @@ func convertInt(value interface{}) (int, error) { return 0, fmt.Errorf("unsupported int convertion for %v(%T)", v, v) } } + +// getLen try to get length of object. +// return (false, 0) if impossible. +func getLen(x interface{}) (ok bool, length int) { + v := reflect.ValueOf(x) + defer func() { + if e := recover(); e != nil { + ok = false + } + }() + return true, v.Len() +} diff --git a/parser_test.go b/parser_test.go index 194f70f1..cb1bcd8f 100644 --- a/parser_test.go +++ b/parser_test.go @@ -625,8 +625,11 @@ func TestParseParameters(t *testing.T) { expectVars []map[string]interface{} }{ { - map[string]interface{}{"username-password": "${parameterize(examples/account.csv)}", "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, - []map[string]interface{}{{"username": "test1", "password": "111111", "user_agent": "IOS/10.1"}, + map[string]interface{}{ + "username-password": "${parameterize(examples/account.csv)}", + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + []map[string]interface{}{ + {"username": "test1", "password": "111111", "user_agent": "IOS/10.1"}, {"username": "test1", "password": "111111", "user_agent": "IOS/10.2"}, {"username": "test2", "password": "222222", "user_agent": "IOS/10.1"}, {"username": "test2", "password": "222222", "user_agent": "IOS/10.2"}, @@ -634,12 +637,23 @@ func TestParseParameters(t *testing.T) { {"username": "test3", "password": "333333", "user_agent": "IOS/10.2"}}, }, { - map[string]interface{}{}, - nil, + map[string]interface{}{ + "username-password": [][]interface{}{{"test1", "111111"}, {"test2", "222222"}, {"test3", "333333"}}, + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}, + "app_version": []interface{}{0.3}}, + []map[string]interface{}{ + {"username": "test1", "password": "111111", "user_agent": "IOS/10.1", "app_version": 0.3}, + {"username": "test1", "password": "111111", "user_agent": "IOS/10.2", "app_version": 0.3}, + {"username": "test2", "password": "222222", "user_agent": "IOS/10.1", "app_version": 0.3}, + {"username": "test2", "password": "222222", "user_agent": "IOS/10.2", "app_version": 0.3}, + {"username": "test3", "password": "333333", "user_agent": "IOS/10.1", "app_version": 0.3}, + {"username": "test3", "password": "333333", "user_agent": "IOS/10.2", "app_version": 0.3}}, }, { - nil, - nil, + map[string]interface{}{}, nil, + }, + { + nil, nil, }, } for _, data := range testData { @@ -655,13 +669,19 @@ func TestParseParametersError(t *testing.T) { rawVars map[string]interface{} }{ { - map[string]interface{}{"username_password": "${parameterize(examples/account.csv)}", "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + map[string]interface{}{ + "username_password": "${parameterize(examples/account.csv)}", + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, }, { - map[string]interface{}{"username-password": "${parameterize(examples/account.csv)}", "user-agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + map[string]interface{}{ + "username-password": "${parameterize(examples/account.csv)}", + "user-agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, }, { - map[string]interface{}{"username-password": "${param(examples/account.csv)}", "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + map[string]interface{}{ + "username-password": "${param(examples/account.csv)}", + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, }, } for _, data := range testData { From 83923affa871b28ea7b9ef66b4a2f1f60a324f2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 29 Dec 2021 15:02:12 +0800 Subject: [PATCH 08/53] feat: data-driven. --- convert.go | 2 +- internal/builtin/function.go | 8 +++----- parser.go | 20 ++++--------------- parser_test.go | 38 +++++++++++++++++++++++++++--------- 4 files changed, 37 insertions(+), 31 deletions(-) diff --git a/convert.go b/convert.go index ba3b8d15..3d9880eb 100644 --- a/convert.go +++ b/convert.go @@ -96,7 +96,7 @@ func loadFromYAML(path string) (*TCase, error) { return tc, err } -func loadFromCSV(path string) []map[string]string { +func LoadFromCSV(path string) []map[string]string { path, err := filepath.Abs(path) if err != nil { log.Error().Str("path", path).Err(err).Msg("convert absolute path failed") diff --git a/internal/builtin/function.go b/internal/builtin/function.go index 2384d654..be7c129e 100644 --- a/internal/builtin/function.go +++ b/internal/builtin/function.go @@ -3,6 +3,7 @@ package builtin import ( "crypto/md5" "encoding/hex" + "github.com/httprunner/hrp" "math" "math/rand" "time" @@ -14,7 +15,8 @@ var Functions = map[string]interface{}{ "gen_random_string": genRandomString, // call with one argument "max": math.Max, // call with two arguments "md5": MD5, - "getAppVersion": getAppVersion, // test + "parameterize": hrp.LoadFromCSV, + "P": hrp.LoadFromCSV, } func init() { @@ -45,7 +47,3 @@ func MD5(str string) string { hasher.Write([]byte(str)) return hex.EncodeToString(hasher.Sum(nil)) } - -func getAppVersion() []float64 { - return []float64{3.1, 3.3} -} diff --git a/parser.go b/parser.go index e95946c8..1c836f36 100644 --- a/parser.go +++ b/parser.go @@ -259,25 +259,13 @@ func contains(s []string, e string) bool { return false } -func getMappingFunction(funcName string) (interface{}, error) { - if function, ok := builtin.Functions[funcName]; ok { - // function is builtin - return function, nil - } else if contains([]string{"parameterize", "P"}, funcName) { - // parameterize function - return loadFromCSV, nil - } else { - // function not found - return nil, fmt.Errorf("function %s is not found", funcName) - } -} - // callFunc call function with arguments // only support return at most one result value func callFunc(funcName string, arguments ...interface{}) (interface{}, error) { - function, err := getMappingFunction(funcName) - if err != nil { - return nil, err + function, ok := builtin.Functions[funcName] + if !ok { + // function not found + return nil, fmt.Errorf("function %s is not found", funcName) } funcValue := reflect.ValueOf(function) if funcValue.Kind() != reflect.Func { diff --git a/parser_test.go b/parser_test.go index 194f70f1..cb1bcd8f 100644 --- a/parser_test.go +++ b/parser_test.go @@ -625,8 +625,11 @@ func TestParseParameters(t *testing.T) { expectVars []map[string]interface{} }{ { - map[string]interface{}{"username-password": "${parameterize(examples/account.csv)}", "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, - []map[string]interface{}{{"username": "test1", "password": "111111", "user_agent": "IOS/10.1"}, + map[string]interface{}{ + "username-password": "${parameterize(examples/account.csv)}", + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + []map[string]interface{}{ + {"username": "test1", "password": "111111", "user_agent": "IOS/10.1"}, {"username": "test1", "password": "111111", "user_agent": "IOS/10.2"}, {"username": "test2", "password": "222222", "user_agent": "IOS/10.1"}, {"username": "test2", "password": "222222", "user_agent": "IOS/10.2"}, @@ -634,12 +637,23 @@ func TestParseParameters(t *testing.T) { {"username": "test3", "password": "333333", "user_agent": "IOS/10.2"}}, }, { - map[string]interface{}{}, - nil, + map[string]interface{}{ + "username-password": [][]interface{}{{"test1", "111111"}, {"test2", "222222"}, {"test3", "333333"}}, + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}, + "app_version": []interface{}{0.3}}, + []map[string]interface{}{ + {"username": "test1", "password": "111111", "user_agent": "IOS/10.1", "app_version": 0.3}, + {"username": "test1", "password": "111111", "user_agent": "IOS/10.2", "app_version": 0.3}, + {"username": "test2", "password": "222222", "user_agent": "IOS/10.1", "app_version": 0.3}, + {"username": "test2", "password": "222222", "user_agent": "IOS/10.2", "app_version": 0.3}, + {"username": "test3", "password": "333333", "user_agent": "IOS/10.1", "app_version": 0.3}, + {"username": "test3", "password": "333333", "user_agent": "IOS/10.2", "app_version": 0.3}}, }, { - nil, - nil, + map[string]interface{}{}, nil, + }, + { + nil, nil, }, } for _, data := range testData { @@ -655,13 +669,19 @@ func TestParseParametersError(t *testing.T) { rawVars map[string]interface{} }{ { - map[string]interface{}{"username_password": "${parameterize(examples/account.csv)}", "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + map[string]interface{}{ + "username_password": "${parameterize(examples/account.csv)}", + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, }, { - map[string]interface{}{"username-password": "${parameterize(examples/account.csv)}", "user-agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + map[string]interface{}{ + "username-password": "${parameterize(examples/account.csv)}", + "user-agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, }, { - map[string]interface{}{"username-password": "${param(examples/account.csv)}", "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + map[string]interface{}{ + "username-password": "${param(examples/account.csv)}", + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, }, } for _, data := range testData { From 86b50e6d0d6dd8ccc589bc07281c5c934684165b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 29 Dec 2021 15:23:36 +0800 Subject: [PATCH 09/53] add interface request verification method. --- convert.go | 37 +------------- internal/builtin/assertion.go | 8 ++-- internal/builtin/assertion_test.go | 77 ++++++++++++++++++++++++++++++ internal/builtin/function.go | 40 ++++++++++++++-- validate.go | 44 +++++++++++++++++ 5 files changed, 164 insertions(+), 42 deletions(-) diff --git a/convert.go b/convert.go index 3d9880eb..7cdedfae 100644 --- a/convert.go +++ b/convert.go @@ -2,15 +2,12 @@ package hrp import ( "bytes" - "encoding/csv" "encoding/json" "fmt" - "io/ioutil" - "path/filepath" - "strings" - "github.com/rs/zerolog/log" "gopkg.in/yaml.v3" + "io/ioutil" + "path/filepath" ) func (tc *TCase) Dump2JSON(path string) error { @@ -96,36 +93,6 @@ func loadFromYAML(path string) (*TCase, error) { return tc, err } -func LoadFromCSV(path string) []map[string]string { - path, err := filepath.Abs(path) - if err != nil { - log.Error().Str("path", path).Err(err).Msg("convert absolute path failed") - panic(err) - } - log.Info().Str("path", path).Msg("load csv file") - - file, err := ioutil.ReadFile(path) - if err != nil { - log.Error().Err(err).Msg("load csv file failed") - panic(err) - } - r := csv.NewReader(strings.NewReader(string(file))) - content, err := r.ReadAll() - if err != nil { - log.Error().Err(err).Msg("parse csv file failed") - panic(err) - } - var result []map[string]string - for i := 1; i < len(content); i++ { - row := make(map[string]string) - for j := 0; j < len(content[i]); j++ { - row[content[0][j]] = content[i][j] - } - result = append(result, row) - } - return result -} - func (tc *TCase) ToTestCase() (*TestCase, error) { testCase := &TestCase{ Config: &Config{cfg: tc.Config}, diff --git a/internal/builtin/assertion.go b/internal/builtin/assertion.go index a6395566..c995e26e 100644 --- a/internal/builtin/assertion.go +++ b/internal/builtin/assertion.go @@ -71,7 +71,7 @@ func GreaterThanLength(t assert.TestingT, expected, actual interface{}, msgAndAr if !ok { return assert.Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", actual), msgAndArgs...) } - if l > length { + if l <= length { return assert.Fail(t, fmt.Sprintf("\"%s\" should be more than %d item(s), but has %d", actual, length, l), msgAndArgs...) } return true @@ -86,7 +86,7 @@ func GreaterOrEqualsLength(t assert.TestingT, expected, actual interface{}, msgA if !ok { return assert.Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", actual), msgAndArgs...) } - if l >= length { + if l < length { return assert.Fail(t, fmt.Sprintf("\"%s\" should be no less than %d item(s), but has %d", actual, length, l), msgAndArgs...) } return true @@ -101,7 +101,7 @@ func LessThanLength(t assert.TestingT, expected, actual interface{}, msgAndArgs if !ok { return assert.Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", actual), msgAndArgs...) } - if l < length { + if l >= length { return assert.Fail(t, fmt.Sprintf("\"%s\" should be less than %d item(s), but has %d", actual, length, l), msgAndArgs...) } return true @@ -116,7 +116,7 @@ func LessOrEqualsLength(t assert.TestingT, expected, actual interface{}, msgAndA if !ok { return assert.Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", actual), msgAndArgs...) } - if l <= length { + if l > length { return assert.Fail(t, fmt.Sprintf("\"%s\" should be no more than %d item(s), but has %d", actual, length, l), msgAndArgs...) } return true diff --git a/internal/builtin/assertion_test.go b/internal/builtin/assertion_test.go index 632dad30..52d8d5d0 100644 --- a/internal/builtin/assertion_test.go +++ b/internal/builtin/assertion_test.go @@ -61,3 +61,80 @@ func TestEqualLength(t *testing.T) { } } } + +func TestLessThanLength(t *testing.T) { + testData := []struct { + raw interface{} + expected int + }{ + {"", 1}, + {[]string{}, 1}, + {map[string]interface{}{}, 1}, + {"a", 2}, + {[]string{"a"}, 2}, + {map[string]interface{}{"a": 123}, 2}, + } + + for _, data := range testData { + if !assert.True(t, LessThanLength(t, data.expected, data.raw)) { + t.Fail() + } + } +} + +func TestLessOrEqualsLength(t *testing.T) { + testData := []struct { + raw interface{} + expected int + }{ + {"", 1}, + {[]string{}, 1}, + {map[string]interface{}{"A": 111}, 1}, + {"a", 1}, + {[]string{"a"}, 2}, + {map[string]interface{}{"a": 123}, 2}, + } + + for _, data := range testData { + if !assert.True(t, LessOrEqualsLength(t, data.expected, data.raw)) { + t.Fail() + } + } +} + +func TestGreaterThanLength(t *testing.T) { + testData := []struct { + raw interface{} + expected int + }{ + {"abcd", 3}, + {[]string{"a", "b", "c"}, 2}, + {map[string]interface{}{"a": 123, "b": 223, "c": 323}, 2}, + } + + for _, data := range testData { + if !assert.True(t, GreaterThanLength(t, data.expected, data.raw)) { + t.Fail() + } + } +} + +func TestGreaterOrEqualsLength(t *testing.T) { + testData := []struct { + raw interface{} + expected int + }{ + {"abcd", 3}, + {[]string{"w"}, 1}, + {map[string]interface{}{"A": 111}, 1}, + {"a", 1}, + {[]string{"a", "b", "c"}, 2}, + {map[string]interface{}{"a": 123, "b": 223, "c": 323}, 2}, + } + + for _, data := range testData { + if !assert.True(t, GreaterOrEqualsLength(t, data.expected, data.raw)) { + t.Fail() + } + } +} diff --git a/internal/builtin/function.go b/internal/builtin/function.go index be7c129e..3d5c96de 100644 --- a/internal/builtin/function.go +++ b/internal/builtin/function.go @@ -2,10 +2,14 @@ package builtin import ( "crypto/md5" + "encoding/csv" "encoding/hex" - "github.com/httprunner/hrp" + "github.com/rs/zerolog/log" + "io/ioutil" "math" "math/rand" + "path/filepath" + "strings" "time" ) @@ -15,8 +19,8 @@ var Functions = map[string]interface{}{ "gen_random_string": genRandomString, // call with one argument "max": math.Max, // call with two arguments "md5": MD5, - "parameterize": hrp.LoadFromCSV, - "P": hrp.LoadFromCSV, + "parameterize": LoadFromCSV, + "P": LoadFromCSV, } func init() { @@ -47,3 +51,33 @@ func MD5(str string) string { hasher.Write([]byte(str)) return hex.EncodeToString(hasher.Sum(nil)) } + +func LoadFromCSV(path string) []map[string]string { + path, err := filepath.Abs(path) + if err != nil { + log.Error().Str("path", path).Err(err).Msg("convert absolute path failed") + panic(err) + } + log.Info().Str("path", path).Msg("load csv file") + + file, err := ioutil.ReadFile(path) + if err != nil { + log.Error().Err(err).Msg("load csv file failed") + panic(err) + } + r := csv.NewReader(strings.NewReader(string(file))) + content, err := r.ReadAll() + if err != nil { + log.Error().Err(err).Msg("parse csv file failed") + panic(err) + } + var result []map[string]string + for i := 1; i < len(content); i++ { + row := make(map[string]string) + for j := 0; j < len(content[i]); j++ { + row[content[0][j]] = content[i][j] + } + result = append(result, row) + } + return result +} diff --git a/validate.go b/validate.go index f5d67a8a..f8113779 100644 --- a/validate.go +++ b/validate.go @@ -67,3 +67,47 @@ func (s *StepRequestValidation) AssertLengthEqual(jmesPath string, expected inte s.step.Validators = append(s.step.Validators, v) return s } + +func (s *StepRequestValidation) AssertLengthLessThan(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "length_less_than", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertLengthLessOrEquals(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "length_less_or_equals", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertLengthGreaterThan(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "length_greater_than", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertLengthGreaterOrEquals(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "length_greater_or_equals", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} From 11ea588ee29c93ff601a129d82724de12e43c669 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 29 Dec 2021 15:25:57 +0800 Subject: [PATCH 10/53] feat: data-driven. --- convert.go | 37 ++------------------------------- internal/builtin/function.go | 40 +++++++++++++++++++++++++++++++++--- 2 files changed, 39 insertions(+), 38 deletions(-) diff --git a/convert.go b/convert.go index 3d9880eb..7cdedfae 100644 --- a/convert.go +++ b/convert.go @@ -2,15 +2,12 @@ package hrp import ( "bytes" - "encoding/csv" "encoding/json" "fmt" - "io/ioutil" - "path/filepath" - "strings" - "github.com/rs/zerolog/log" "gopkg.in/yaml.v3" + "io/ioutil" + "path/filepath" ) func (tc *TCase) Dump2JSON(path string) error { @@ -96,36 +93,6 @@ func loadFromYAML(path string) (*TCase, error) { return tc, err } -func LoadFromCSV(path string) []map[string]string { - path, err := filepath.Abs(path) - if err != nil { - log.Error().Str("path", path).Err(err).Msg("convert absolute path failed") - panic(err) - } - log.Info().Str("path", path).Msg("load csv file") - - file, err := ioutil.ReadFile(path) - if err != nil { - log.Error().Err(err).Msg("load csv file failed") - panic(err) - } - r := csv.NewReader(strings.NewReader(string(file))) - content, err := r.ReadAll() - if err != nil { - log.Error().Err(err).Msg("parse csv file failed") - panic(err) - } - var result []map[string]string - for i := 1; i < len(content); i++ { - row := make(map[string]string) - for j := 0; j < len(content[i]); j++ { - row[content[0][j]] = content[i][j] - } - result = append(result, row) - } - return result -} - func (tc *TCase) ToTestCase() (*TestCase, error) { testCase := &TestCase{ Config: &Config{cfg: tc.Config}, diff --git a/internal/builtin/function.go b/internal/builtin/function.go index be7c129e..3d5c96de 100644 --- a/internal/builtin/function.go +++ b/internal/builtin/function.go @@ -2,10 +2,14 @@ package builtin import ( "crypto/md5" + "encoding/csv" "encoding/hex" - "github.com/httprunner/hrp" + "github.com/rs/zerolog/log" + "io/ioutil" "math" "math/rand" + "path/filepath" + "strings" "time" ) @@ -15,8 +19,8 @@ var Functions = map[string]interface{}{ "gen_random_string": genRandomString, // call with one argument "max": math.Max, // call with two arguments "md5": MD5, - "parameterize": hrp.LoadFromCSV, - "P": hrp.LoadFromCSV, + "parameterize": LoadFromCSV, + "P": LoadFromCSV, } func init() { @@ -47,3 +51,33 @@ func MD5(str string) string { hasher.Write([]byte(str)) return hex.EncodeToString(hasher.Sum(nil)) } + +func LoadFromCSV(path string) []map[string]string { + path, err := filepath.Abs(path) + if err != nil { + log.Error().Str("path", path).Err(err).Msg("convert absolute path failed") + panic(err) + } + log.Info().Str("path", path).Msg("load csv file") + + file, err := ioutil.ReadFile(path) + if err != nil { + log.Error().Err(err).Msg("load csv file failed") + panic(err) + } + r := csv.NewReader(strings.NewReader(string(file))) + content, err := r.ReadAll() + if err != nil { + log.Error().Err(err).Msg("parse csv file failed") + panic(err) + } + var result []map[string]string + for i := 1; i < len(content); i++ { + row := make(map[string]string) + for j := 0; j < len(content[i]); j++ { + row[content[0][j]] = content[i][j] + } + result = append(result, row) + } + return result +} From 6e9c55e93df721be0adeca4fa542a454e0c30181 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 29 Dec 2021 15:59:10 +0800 Subject: [PATCH 11/53] feat: data-driven. --- parser.go | 9 --------- 1 file changed, 9 deletions(-) diff --git a/parser.go b/parser.go index 1c836f36..7bab526d 100644 --- a/parser.go +++ b/parser.go @@ -250,15 +250,6 @@ func mergeVariables(variables, overriddenVariables map[string]interface{}) map[s return mergedVariables } -func contains(s []string, e string) bool { - for _, a := range s { - if strings.EqualFold(a, e) { - return true - } - } - return false -} - // callFunc call function with arguments // only support return at most one result value func callFunc(funcName string, arguments ...interface{}) (interface{}, error) { From c1d1d060de1a5f6d957d6bef04754cad3cad3d41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 29 Dec 2021 16:43:43 +0800 Subject: [PATCH 12/53] add interface request verification method. --- validate.go | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) diff --git a/validate.go b/validate.go index f8113779..9464ea1b 100644 --- a/validate.go +++ b/validate.go @@ -35,6 +35,83 @@ func (s *StepRequestValidation) AssertEqual(jmesPath string, expected interface{ return s } +func (s *StepRequestValidation) AssertGreater(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "greater_than", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertLess(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "less_than", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertGreaterOrEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "greater_or_equals", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertLessOrEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "less_or_equals", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertNotEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "not_equal", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertContains(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "contains", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertRegexp(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "regex_match", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + func (s *StepRequestValidation) AssertStartsWith(jmesPath string, expected interface{}, msg string) *StepRequestValidation { v := Validator{ Check: jmesPath, From 5e017a4ee789f4141b1b2cf949c99a3d5cdcb55d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 29 Dec 2021 18:48:37 +0800 Subject: [PATCH 13/53] feat: data-driven. --- parser.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/parser.go b/parser.go index 7bab526d..300293b5 100644 --- a/parser.go +++ b/parser.go @@ -553,12 +553,12 @@ func parseParameters(parameters map[string]interface{}, variablesMapping map[str case reflect.String: parsedParameterContent, err := parseData(rawValue.Interface(), variablesMapping) if err != nil { - log.Error().Interface("parameter", parameters).Msg("[parseParameters] parse parameter error") + log.Error().Interface("parameterContent", rawValue).Msg("[parseParameters] parse parameter content error") return nil, err } parsedParameterRawValue := reflect.ValueOf(parsedParameterContent) if parsedParameterRawValue.Kind() != reflect.Slice { - log.Error().Interface("parameter", parameters).Msg("[parseParameters] parsed parameter content should be Slice, got %v") + log.Error().Interface("parameterContent", parsedParameterRawValue).Msg("[parseParameters] parsed parameter content should be Slice, got %v") return nil, errors.New("parsed parameter content should be Slice") } for i := 0; i < parsedParameterRawValue.Len(); i++ { @@ -579,7 +579,7 @@ func parseParameters(parameters map[string]interface{}, variablesMapping map[str } else if elem.Kind() == reflect.Slice { // e.g. [["test1", "passwd1"], ["test2", "passwd2"]] -> [{"username": "test1", "password": "passwd1"}, {"username": "test2", "password": "passwd2"}] if len(parameterNameSlice) != elem.Len() { - log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter name Slice and parameter content Slice should have the same length") + log.Error().Interface("parameterNameSlice", parameterNameSlice).Interface("parameterContent", elem.Interface()).Msg("[parseParameters] parameter name Slice and parameter content Slice should have the same length") return nil, errors.New("parameter name Slice and parameter cjntent Slice should have the same length") } else { for j := 0; j < elem.Len(); j++ { @@ -603,7 +603,7 @@ func parseParameters(parameters map[string]interface{}, variablesMapping map[str if elem.Kind() == reflect.Slice { // e.g. username-password: [["test1", "passwd1"], ["test2", "passwd2"]] if len(parameterNameSlice) != elem.Len() { - log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter name Slice and parameter content Slice should have the same length") + log.Error().Interface("parameterNameSlice", parameterNameSlice).Interface("parameterContent", elem.Interface()).Msg("[parseParameters] parameter name Slice and parameter content Slice should have the same length") return nil, errors.New("parameter name Slice and parameter content Slice should have the same length") } for j := 0; j < elem.Len(); j++ { From 3b49d7a5fc19103346cc3dc87e5ec275aea7c73e Mon Sep 17 00:00:00 2001 From: debugtalk Date: Thu, 30 Dec 2021 11:52:07 +0800 Subject: [PATCH 14/53] revert license --- LICENSE | 862 +++++++++------------------------------ docs/cmd/hrp.md | 2 +- docs/cmd/hrp_boom.md | 2 +- docs/cmd/hrp_har2case.md | 2 +- docs/cmd/hrp_run.md | 2 +- 5 files changed, 205 insertions(+), 665 deletions(-) diff --git a/LICENSE b/LICENSE index 0815c492..186ade81 100644 --- a/LICENSE +++ b/LICENSE @@ -1,661 +1,201 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) 2021 debugtalk - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published - by the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 debugtalk + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/docs/cmd/hrp.md b/docs/cmd/hrp.md index b081b919..8b751a2d 100644 --- a/docs/cmd/hrp.md +++ b/docs/cmd/hrp.md @@ -32,4 +32,4 @@ Copyright 2021 debugtalk * [hrp har2case](hrp_har2case.md) - Convert HAR to json/yaml testcase files * [hrp run](hrp_run.md) - run API test -###### Auto generated by spf13/cobra on 28-Dec-2021 +###### Auto generated by spf13/cobra on 30-Dec-2021 diff --git a/docs/cmd/hrp_boom.md b/docs/cmd/hrp_boom.md index c707dacf..494ae8d6 100644 --- a/docs/cmd/hrp_boom.md +++ b/docs/cmd/hrp_boom.md @@ -38,4 +38,4 @@ hrp boom [flags] * [hrp](hrp.md) - One-stop solution for HTTP(S) testing. -###### Auto generated by spf13/cobra on 28-Dec-2021 +###### Auto generated by spf13/cobra on 30-Dec-2021 diff --git a/docs/cmd/hrp_har2case.md b/docs/cmd/hrp_har2case.md index 76921935..d9664517 100644 --- a/docs/cmd/hrp_har2case.md +++ b/docs/cmd/hrp_har2case.md @@ -23,4 +23,4 @@ hrp har2case harPath... [flags] * [hrp](hrp.md) - One-stop solution for HTTP(S) testing. -###### Auto generated by spf13/cobra on 28-Dec-2021 +###### Auto generated by spf13/cobra on 30-Dec-2021 diff --git a/docs/cmd/hrp_run.md b/docs/cmd/hrp_run.md index f4ab234b..9cb28dbf 100644 --- a/docs/cmd/hrp_run.md +++ b/docs/cmd/hrp_run.md @@ -31,4 +31,4 @@ hrp run path... [flags] * [hrp](hrp.md) - One-stop solution for HTTP(S) testing. -###### Auto generated by spf13/cobra on 28-Dec-2021 +###### Auto generated by spf13/cobra on 30-Dec-2021 From 345f8c0038d2a3d46d4940a79abe77a584b6ba37 Mon Sep 17 00:00:00 2001 From: debugtalk Date: Thu, 30 Dec 2021 13:14:57 +0800 Subject: [PATCH 15/53] fix: concurrent map writes in load testing --- boomer.go | 3 ++- docs/CHANGELOG.md | 6 +++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/boomer.go b/boomer.go index 5719069c..7d02078d 100644 --- a/boomer.go +++ b/boomer.go @@ -53,12 +53,13 @@ func (b *hrpBoomer) Run(testcases ...ITestCase) { func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { hrpRunner := NewRunner(nil).SetDebug(b.debug) - runner := hrpRunner.newCaseRunner(testcase) config := testcase.Config.ToStruct() return &boomer.Task{ Name: config.Name, Weight: config.Weight, Fn: func() { + runner := hrpRunner.newCaseRunner(testcase) + testcaseSuccess := true // flag whole testcase result var transactionSuccess = true // flag current transaction result diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 26a81198..9b970960 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,6 +1,10 @@ # Release History -## v0.3.0 (2021-12-22) +## v0.4.0 (2021-12-30) + +- fix: concurrent map writes in load testing + +## v0.3.0 (2021-12-24) - feat: implement `transaction` mechanism for load test - feat: continue running next step when failure occurs with `--continue-on-failure` flag, default to failfast From dbcb7f731a13c213fad01529cba4dc6c395254c7 Mon Sep 17 00:00:00 2001 From: debugtalk Date: Thu, 30 Dec 2021 13:37:02 +0800 Subject: [PATCH 16/53] change: remove duplicate error logging --- boomer.go | 2 +- runner.go | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/boomer.go b/boomer.go index 7d02078d..eda4a4f2 100644 --- a/boomer.go +++ b/boomer.go @@ -79,7 +79,7 @@ func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { transactionSuccess = false if runner.hrpRunner.failfast { - log.Error().Err(err).Msg("abort running due to failfast setting") + log.Error().Msg("abort running due to failfast setting") break } log.Warn().Err(err).Msg("run step failed, continue next step") diff --git a/runner.go b/runner.go index bca1900b..a1b9d108 100644 --- a/runner.go +++ b/runner.go @@ -148,8 +148,7 @@ func (r *caseRunner) run() error { _, err := r.runStep(index) if err != nil { if r.hrpRunner.failfast { - log.Error().Err(err).Msg("abort running due to failfast setting") - return err + return errors.Wrap(err, "abort running due to failfast setting") } log.Warn().Err(err).Msg("run step failed, continue next step") } From a1e7d0e13cee78b69c24da6fbfe305105e188306 Mon Sep 17 00:00:00 2001 From: buyuxiang Date: Thu, 30 Dec 2021 14:47:10 +0800 Subject: [PATCH 17/53] fix: contains assertion bug; feat: add type_match, contained_by, string_equals assertion methods Change-Id: Icb15fe33a58d1ff69991435bbe70c3cd53bb8dea --- examples/function_test.go | 8 +++++-- internal/builtin/assertion.go | 22 +++++++++++++++++- validate.go | 44 +++++++++++++++++++++++++++++++++++ 3 files changed, 71 insertions(+), 3 deletions(-) diff --git a/examples/function_test.go b/examples/function_test.go index cd2c2d98..44c8c590 100644 --- a/examples/function_test.go +++ b/examples/function_test.go @@ -19,14 +19,18 @@ func TestCaseCallFunction(t *testing.T) { TestSteps: []hrp.IStep{ hrp.NewStep("get with params"). GET("/get"). - WithParams(map[string]interface{}{"foo1": "${gen_random_string($n)}", "foo2": "${max($a, $b)}"}). + WithParams(map[string]interface{}{"foo1": "${gen_random_string($n)}", "foo2": "${max($a, $b)}", "foo3": "Foo3"}). WithHeaders(map[string]string{"User-Agent": "HttpRunnerPlus"}). Extract(). WithJmesPath("body.args.foo1", "varFoo1"). Validate(). AssertEqual("status_code", 200, "check status code"). AssertLengthEqual("body.args.foo1", 5, "check args foo1"). - AssertEqual("body.args.foo2", "12.3", "check args foo2"), // notice: request params value will be converted to string + AssertEqual("body.args.foo2", "12.3", "check args foo2"). + AssertTypeMatch("body.args.foo3", "str", "check args foo3 is type string"). + AssertStringEqual("body.args.foo3", "foo3", "check args foo3 case-insensitivity"). + AssertContains("body.args.foo3", "Foo", "check contains "). + AssertContainedBy("body.args.foo3", "this is Foo3 test", "check contained by"), // notice: request params value will be converted to string hrp.NewStep("post json data with functions"). POST("/post"). WithHeaders(map[string]string{"User-Agent": "HttpRunnerPlus"}). diff --git a/internal/builtin/assertion.go b/internal/builtin/assertion.go index 31110221..87e4709b 100644 --- a/internal/builtin/assertion.go +++ b/internal/builtin/assertion.go @@ -15,13 +15,16 @@ var Assertions = map[string]func(t assert.TestingT, expected interface{}, actual "greater_or_equals": assert.GreaterOrEqual, "less_or_equals": assert.LessOrEqual, "not_equal": assert.NotEqual, - "contains": assert.Contains, + "contained_by": assert.Contains, "regex_match": assert.Regexp, + "type_match": assert.IsType, // custom assertions "startswith": StartsWith, // check if string starts with substring "endswith": EndsWith, // check if string ends with substring "length_equals": EqualLength, "length_equal": EqualLength, // alias for length_equals + "contains": Contains, + "string_equals": EqualString, } func StartsWith(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { @@ -83,3 +86,20 @@ func convertInt(value interface{}) (int, error) { return 0, fmt.Errorf("unsupported int convertion for %v(%T)", v, v) } } + +// Contains assert whether actual +func Contains(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { + return assert.Contains(t, actual, expected, msgAndArgs) +} + +func EqualString(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { + if !assert.IsType(t, "string", actual, msgAndArgs) { + return false + } + if !assert.IsType(t, "string", expected, msgAndArgs) { + return false + } + actualString := actual.(string) + expectedString := expected.(string) + return assert.True(t, strings.EqualFold(actualString, expectedString), msgAndArgs) +} diff --git a/validate.go b/validate.go index f5d67a8a..9748ac05 100644 --- a/validate.go +++ b/validate.go @@ -35,6 +35,28 @@ func (s *StepRequestValidation) AssertEqual(jmesPath string, expected interface{ return s } +func (s *StepRequestValidation) AssertContains(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "contains", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertTypeMatch(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "type_match", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + func (s *StepRequestValidation) AssertStartsWith(jmesPath string, expected interface{}, msg string) *StepRequestValidation { v := Validator{ Check: jmesPath, @@ -67,3 +89,25 @@ func (s *StepRequestValidation) AssertLengthEqual(jmesPath string, expected inte s.step.Validators = append(s.step.Validators, v) return s } + +func (s *StepRequestValidation) AssertContainedBy(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "contained_by", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertStringEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "string_equals", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} \ No newline at end of file From 52d43861f357365d862c1547d6fa96eea6549886 Mon Sep 17 00:00:00 2001 From: debugtalk Date: Thu, 30 Dec 2021 15:48:17 +0800 Subject: [PATCH 18/53] feat: set ulimit to 10240 before load testing --- docs/CHANGELOG.md | 1 + hrp/cmd/boom.go | 26 ++++++++++++++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 9b970960..b6ea98a4 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -2,6 +2,7 @@ ## v0.4.0 (2021-12-30) +- feat: set ulimit to 10240 before load testing - fix: concurrent map writes in load testing ## v0.3.0 (2021-12-24) diff --git a/hrp/cmd/boom.go b/hrp/cmd/boom.go index 41c67758..0bbc25c6 100644 --- a/hrp/cmd/boom.go +++ b/hrp/cmd/boom.go @@ -1,8 +1,10 @@ package cmd import ( + "syscall" "time" + "github.com/rs/zerolog/log" "github.com/spf13/cobra" "github.com/httprunner/hrp" @@ -19,6 +21,7 @@ var boomCmd = &cobra.Command{ $ hrp boom examples/ # run testcases in specified folder`, Args: cobra.MinimumNArgs(1), PreRun: func(cmd *cobra.Command, args []string) { + setUlimit() setLogLevel("WARN") // disable info logs for load testing }, Run: func(cmd *cobra.Command, args []string) { @@ -67,3 +70,26 @@ func init() { boomCmd.Flags().StringVar(&prometheusPushgatewayURL, "prometheus-gateway", "", "Prometheus Pushgateway url.") boomCmd.Flags().BoolVar(&disableConsoleOutput, "disable-console-output", false, "Disable console output.") } + +// set resource limit +// ulimit -n 10240 +func setUlimit() { + var rLimit syscall.Rlimit + err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit) + if err != nil { + log.Error().Err(err).Msg("get ulimit failed") + return + } + log.Info().Uint64("limit", rLimit.Cur).Msg("get current ulimit") + if rLimit.Cur >= 10240 { + return + } + + rLimit.Cur = 10240 + log.Info().Uint64("limit", rLimit.Cur).Msg("set current ulimit") + err = syscall.Setrlimit(syscall.RLIMIT_NOFILE, &rLimit) + if err != nil { + log.Error().Err(err).Msg("set ulimit failed") + return + } +} From 3f709b4d71b43a25b532342e56e0321aa49436f8 Mon Sep 17 00:00:00 2001 From: debugtalk Date: Thu, 30 Dec 2021 16:22:08 +0800 Subject: [PATCH 19/53] change: skip setting ulimit for windows --- docs/CHANGELOG.md | 2 +- hrp/cmd/boom.go | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index b6ea98a4..4f2f8207 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,6 +1,6 @@ # Release History -## v0.4.0 (2021-12-30) +## v0.3.1 (2021-12-30) - feat: set ulimit to 10240 before load testing - fix: concurrent map writes in load testing diff --git a/hrp/cmd/boom.go b/hrp/cmd/boom.go index 0bbc25c6..ff3cb472 100644 --- a/hrp/cmd/boom.go +++ b/hrp/cmd/boom.go @@ -1,6 +1,7 @@ package cmd import ( + "runtime" "syscall" "time" @@ -74,6 +75,10 @@ func init() { // set resource limit // ulimit -n 10240 func setUlimit() { + if runtime.GOOS == "windows" { + log.Warn().Msg("windows does not support setting ulimit") + return + } var rLimit syscall.Rlimit err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit) if err != nil { From 2c69966c2f6ae1034ea856a93ff8cfcecf33495e Mon Sep 17 00:00:00 2001 From: debugtalk Date: Thu, 30 Dec 2021 16:30:58 +0800 Subject: [PATCH 20/53] change: add debug log --- hrp/cmd/boom.go | 1 + 1 file changed, 1 insertion(+) diff --git a/hrp/cmd/boom.go b/hrp/cmd/boom.go index ff3cb472..7cd14b07 100644 --- a/hrp/cmd/boom.go +++ b/hrp/cmd/boom.go @@ -75,6 +75,7 @@ func init() { // set resource limit // ulimit -n 10240 func setUlimit() { + log.Info().Str("runtime.GOOS", runtime.GOOS).Msg("check GOOS") if runtime.GOOS == "windows" { log.Warn().Msg("windows does not support setting ulimit") return From 025e84ff8130e9256fdd8fc6c6b39f6e97ee40e7 Mon Sep 17 00:00:00 2001 From: debugtalk Date: Thu, 30 Dec 2021 16:40:04 +0800 Subject: [PATCH 21/53] fix: skip set ulimit on windows --- hrp/cmd/boom.go | 35 ++----------------------------- internal/boomer/ulimit.go | 32 ++++++++++++++++++++++++++++ internal/boomer/ulimit_windows.go | 12 +++++++++++ 3 files changed, 46 insertions(+), 33 deletions(-) create mode 100644 internal/boomer/ulimit.go create mode 100644 internal/boomer/ulimit_windows.go diff --git a/hrp/cmd/boom.go b/hrp/cmd/boom.go index 7cd14b07..b19c239a 100644 --- a/hrp/cmd/boom.go +++ b/hrp/cmd/boom.go @@ -1,11 +1,8 @@ package cmd import ( - "runtime" - "syscall" "time" - "github.com/rs/zerolog/log" "github.com/spf13/cobra" "github.com/httprunner/hrp" @@ -22,8 +19,8 @@ var boomCmd = &cobra.Command{ $ hrp boom examples/ # run testcases in specified folder`, Args: cobra.MinimumNArgs(1), PreRun: func(cmd *cobra.Command, args []string) { - setUlimit() - setLogLevel("WARN") // disable info logs for load testing + boomer.SetUlimit(10240) // ulimit -n 10240 + setLogLevel("WARN") // disable info logs for load testing }, Run: func(cmd *cobra.Command, args []string) { var paths []hrp.ITestCase @@ -71,31 +68,3 @@ func init() { boomCmd.Flags().StringVar(&prometheusPushgatewayURL, "prometheus-gateway", "", "Prometheus Pushgateway url.") boomCmd.Flags().BoolVar(&disableConsoleOutput, "disable-console-output", false, "Disable console output.") } - -// set resource limit -// ulimit -n 10240 -func setUlimit() { - log.Info().Str("runtime.GOOS", runtime.GOOS).Msg("check GOOS") - if runtime.GOOS == "windows" { - log.Warn().Msg("windows does not support setting ulimit") - return - } - var rLimit syscall.Rlimit - err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit) - if err != nil { - log.Error().Err(err).Msg("get ulimit failed") - return - } - log.Info().Uint64("limit", rLimit.Cur).Msg("get current ulimit") - if rLimit.Cur >= 10240 { - return - } - - rLimit.Cur = 10240 - log.Info().Uint64("limit", rLimit.Cur).Msg("set current ulimit") - err = syscall.Setrlimit(syscall.RLIMIT_NOFILE, &rLimit) - if err != nil { - log.Error().Err(err).Msg("set ulimit failed") - return - } -} diff --git a/internal/boomer/ulimit.go b/internal/boomer/ulimit.go new file mode 100644 index 00000000..b83585ea --- /dev/null +++ b/internal/boomer/ulimit.go @@ -0,0 +1,32 @@ +// +build !windows + +package boomer + +import ( + "syscall" + + "github.com/rs/zerolog/log" +) + +// set resource limit +// ulimit -n 10240 +func SetUlimit(limit uint64) { + var rLimit syscall.Rlimit + err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit) + if err != nil { + log.Error().Err(err).Msg("get ulimit failed") + return + } + log.Info().Uint64("limit", rLimit.Cur).Msg("get current ulimit") + if rLimit.Cur >= limit { + return + } + + rLimit.Cur = limit + log.Info().Uint64("limit", rLimit.Cur).Msg("set current ulimit") + err = syscall.Setrlimit(syscall.RLIMIT_NOFILE, &rLimit) + if err != nil { + log.Error().Err(err).Msg("set ulimit failed") + return + } +} diff --git a/internal/boomer/ulimit_windows.go b/internal/boomer/ulimit_windows.go new file mode 100644 index 00000000..76ca69fc --- /dev/null +++ b/internal/boomer/ulimit_windows.go @@ -0,0 +1,12 @@ +// +build windows + +package boomer + +import ( + "github.com/rs/zerolog/log" +) + +// set resource limit +func SetUlimit(limit uint64) { + log.Warn().Msg("windows does not support setting ulimit") +} From fc3c9c19a29c2c226d5b1243882008c6a1344b60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Thu, 30 Dec 2021 17:31:14 +0800 Subject: [PATCH 22/53] feat: data-driven. --- examples/parameters_test.json | 7 +- examples/parameters_test.yaml | 1 - internal/builtin/function.go | 6 +- parser.go | 117 ++++++++++++++++------------------ parser_test.go | 39 ++++++++++++ 5 files changed, 102 insertions(+), 68 deletions(-) diff --git a/examples/parameters_test.json b/examples/parameters_test.json index 6ad52032..c519e928 100644 --- a/examples/parameters_test.json +++ b/examples/parameters_test.json @@ -6,8 +6,11 @@ "iOS/10.1", "iOS/10.2" ], - "username-password": "${parameterize(examples/account.csv)}", - "app_version": "${getAppVersion()}" + "username1-password1": [ + ["a", "123"], + ["b", "456"] + ], + "username-password": "${parameterize(examples/account.csv)}" }, "parameters_setting": { "strategy": "random" diff --git a/examples/parameters_test.yaml b/examples/parameters_test.yaml index 7afb4252..65c307a8 100644 --- a/examples/parameters_test.yaml +++ b/examples/parameters_test.yaml @@ -3,7 +3,6 @@ config: parameters: user_agent: ["iOS/10.1", "iOS/10.2"] username-password: ${parameterize(examples/account.csv)} - app_version: ${getAppVersion()} parameters_setting: strategy: random variables: diff --git a/internal/builtin/function.go b/internal/builtin/function.go index 3d5c96de..8d6fd87e 100644 --- a/internal/builtin/function.go +++ b/internal/builtin/function.go @@ -52,7 +52,7 @@ func MD5(str string) string { return hex.EncodeToString(hasher.Sum(nil)) } -func LoadFromCSV(path string) []map[string]string { +func LoadFromCSV(path string) []map[string]interface{} { path, err := filepath.Abs(path) if err != nil { log.Error().Str("path", path).Err(err).Msg("convert absolute path failed") @@ -71,9 +71,9 @@ func LoadFromCSV(path string) []map[string]string { log.Error().Err(err).Msg("parse csv file failed") panic(err) } - var result []map[string]string + var result []map[string]interface{} for i := 1; i < len(content); i++ { - row := make(map[string]string) + row := make(map[string]interface{}) for j := 0; j < len(content[i]); j++ { row[content[0][j]] = content[i][j] } diff --git a/parser.go b/parser.go index 300293b5..cc92fde8 100644 --- a/parser.go +++ b/parser.go @@ -497,7 +497,7 @@ func findallVariables(raw string) variableSet { } func shuffleCartesianProduct(slice []map[string]interface{}) { - if slice == nil || len(slice) == 0 { + if len(slice) == 0 { return } r := rand.New(rand.NewSource(time.Now().Unix())) @@ -510,7 +510,7 @@ func shuffleCartesianProduct(slice []map[string]interface{}) { } func genCartesianProduct(params [][]map[string]interface{}) []map[string]interface{} { - if params == nil || len(params) == 0 { + if len(params) == 0 { return nil } var cartesianProduct []map[string]interface{} @@ -541,17 +541,18 @@ func getParameters(config IConfig) []map[string]interface{} { } func parseParameters(parameters map[string]interface{}, variablesMapping map[string]interface{}) ([]map[string]interface{}, error) { - if parameters == nil || len(parameters) == 0 { + if len(parameters) == 0 { return nil, nil } var parsedParametersSlice [][]map[string]interface{} + var err error for k, v := range parameters { - parameterNameSlice := strings.Split(k, "-") var parameterSlice []map[string]interface{} rawValue := reflect.ValueOf(v) switch rawValue.Kind() { case reflect.String: - parsedParameterContent, err := parseData(rawValue.Interface(), variablesMapping) + var parsedParameterContent interface{} + parsedParameterContent, err = parseData(rawValue.Interface(), variablesMapping) if err != nil { log.Error().Interface("parameterContent", rawValue).Msg("[parseParameters] parse parameter content error") return nil, err @@ -561,69 +562,61 @@ func parseParameters(parameters map[string]interface{}, variablesMapping map[str log.Error().Interface("parameterContent", parsedParameterRawValue).Msg("[parseParameters] parsed parameter content should be Slice, got %v") return nil, errors.New("parsed parameter content should be Slice") } - for i := 0; i < parsedParameterRawValue.Len(); i++ { - parameterMap := make(map[string]interface{}) - // e.g. - elem := reflect.ValueOf(parsedParameterRawValue.Index(i).Interface()) - if elem.Kind() == reflect.Map { - // e.g. [{"username": "test1", "password": "passwd1", "other": "111"}, {"username": "test2", "password": "passwd2", "other": ""222}] - // -> [{"username": "test1", "password": "passwd1"}, {"username": "test2", "password": "passwd2"}] (username, password in parameterNameSlice) - for _, key := range parameterNameSlice { - if _, ok := elem.Interface().(map[string]string)[key]; ok { - parameterMap[key] = elem.MapIndex(reflect.ValueOf(key)).Interface() - } else { - log.Error().Interface("parameterNameSlice", parameterNameSlice).Msg("[parseParameters] parameter name not found") - return nil, errors.New("parameter name not found") - } - } - } else if elem.Kind() == reflect.Slice { - // e.g. [["test1", "passwd1"], ["test2", "passwd2"]] -> [{"username": "test1", "password": "passwd1"}, {"username": "test2", "password": "passwd2"}] - if len(parameterNameSlice) != elem.Len() { - log.Error().Interface("parameterNameSlice", parameterNameSlice).Interface("parameterContent", elem.Interface()).Msg("[parseParameters] parameter name Slice and parameter content Slice should have the same length") - return nil, errors.New("parameter name Slice and parameter cjntent Slice should have the same length") - } else { - for j := 0; j < elem.Len(); j++ { - parameterMap[parameterNameSlice[j]] = elem.Index(j).Interface() - } - } - } else { - // e.g. ${getAppVersion()} -> [3.1, 3.0] -> [{"app_version": 3.1}, {"app_version": 3.0}] - if len(parameterNameSlice) != 1 { - log.Error().Interface("parameterNameSlice", parameterNameSlice).Msg("[parseParameters] parameter name slice should have only one element when parameter content is string") - return nil, errors.New("parameter name slice should have only one element when parameter content is string") - } - parameterMap[parameterNameSlice[0]] = elem.Interface() - } - parameterSlice = append(parameterSlice, parameterMap) - } + parameterSlice, err = handleSlice(k, parsedParameterRawValue.Interface()) case reflect.Slice: - for i := 0; i < rawValue.Len(); i++ { - parameterMap := make(map[string]interface{}) - elem := reflect.ValueOf(rawValue.Index(i).Interface()) - if elem.Kind() == reflect.Slice { - // e.g. username-password: [["test1", "passwd1"], ["test2", "passwd2"]] - if len(parameterNameSlice) != elem.Len() { - log.Error().Interface("parameterNameSlice", parameterNameSlice).Interface("parameterContent", elem.Interface()).Msg("[parseParameters] parameter name Slice and parameter content Slice should have the same length") - return nil, errors.New("parameter name Slice and parameter content Slice should have the same length") - } - for j := 0; j < elem.Len(); j++ { - parameterMap[parameterNameSlice[j]] = elem.Index(j).Interface() - } - } else { - // e.g. user_agent: ["iOS/10.1", "iOS/10.2"] - if len(parameterNameSlice) != 1 { - log.Error().Interface("parameterNameSlice", parameterNameSlice).Msg("[parseParameters] parameter name slice should have only one element when parameter content is string") - return nil, errors.New("parameter name slice should have only one element when parameter content is string") - } - parameterMap[parameterNameSlice[0]] = elem.Interface() - } - parameterSlice = append(parameterSlice, parameterMap) - } + parameterSlice, err = handleSlice(k, rawValue.Interface()) default: log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be Slice or Text(variables or functions call)") return nil, errors.New("parameter content should be Slice or Text(variables or functions call)") } + if err != nil { + return nil, err + } parsedParametersSlice = append(parsedParametersSlice, parameterSlice) } return genCartesianProduct(parsedParametersSlice), nil } + +func handleSlice(parameterName string, parameterContent interface{}) ([]map[string]interface{}, error) { + parameterNameSlice := strings.Split(parameterName, "-") + var parameterSlice []map[string]interface{} + parameterContentSlice := reflect.ValueOf(parameterContent) + for i := 0; i < parameterContentSlice.Len(); i++ { + parameterMap := make(map[string]interface{}) + elem := reflect.ValueOf(parameterContentSlice.Index(i).Interface()) + switch elem.Kind() { + case reflect.Map: + // e.g. "username-password": [{"username": "test1", "password": "passwd1", "other": "111"}, {"username": "test2", "password": "passwd2", "other": ""222}] + // -> [{"username": "test1", "password": "passwd1"}, {"username": "test2", "password": "passwd2"}] + for _, key := range parameterNameSlice { + if _, ok := elem.Interface().(map[string]interface{})[key]; ok { + parameterMap[key] = elem.MapIndex(reflect.ValueOf(key)).Interface() + } else { + log.Error().Interface("parameterNameSlice", parameterNameSlice).Msg("[parseParameters] parameter name not found") + return nil, errors.New("parameter name not found") + } + } + case reflect.Slice: + // e.g. "username-password": [["test1", "passwd1"], ["test2", "passwd2"]] + // -> [{"username": "test1", "password": "passwd1"}, {"username": "test2", "password": "passwd2"}] + if len(parameterNameSlice) != elem.Len() { + log.Error().Interface("parameterNameSlice", parameterNameSlice).Interface("parameterContent", elem.Interface()).Msg("[parseParameters] parameter name Slice and parameter content Slice should have the same length") + return nil, errors.New("parameter name Slice and parameter cjntent Slice should have the same length") + } else { + for j := 0; j < elem.Len(); j++ { + parameterMap[parameterNameSlice[j]] = elem.Index(j).Interface() + } + } + default: + // e.g. "app_version": [3.1, 3.0] + // -> [{"app_version": 3.1}, {"app_version": 3.0}] + if len(parameterNameSlice) != 1 { + log.Error().Interface("parameterNameSlice", parameterNameSlice).Msg("[parseParameters] parameter name slice should have only one element when parameter content is string") + return nil, errors.New("parameter name slice should have only one element when parameter content is string") + } + parameterMap[parameterNameSlice[0]] = elem.Interface() + } + parameterSlice = append(parameterSlice, parameterMap) + } + return parameterSlice, nil +} diff --git a/parser_test.go b/parser_test.go index cb1bcd8f..c69a584d 100644 --- a/parser_test.go +++ b/parser_test.go @@ -691,3 +691,42 @@ func TestParseParametersError(t *testing.T) { } } } + +func TestHandleSlice(t *testing.T) { + testData := []struct { + rawVar1 string + rawVar2 interface{} + expect []map[string]interface{} + }{ + { + "username-password", + []map[string]interface{}{{"username": "test1", "password": 111111, "other": "111"}, {"username": "test2", "password": 222222, "other": "222"}}, + []map[string]interface{}{ + {"username": "test1", "password": 111111}, + {"username": "test2", "password": 222222}, + }, + }, + { + "username-password", + [][]string{{"test1", "111111"}, {"test2", "222222"}}, + []map[string]interface{}{ + {"username": "test1", "password": "111111"}, + {"username": "test2", "password": "222222"}, + }, + }, + { + "app_version", + []float64{3.1, 3.0}, + []map[string]interface{}{ + {"app_version": 3.1}, + {"app_version": 3.0}, + }, + }, + } + for _, data := range testData { + value, _ := handleSlice(data.rawVar1, data.rawVar2) + if !assert.Equal(t, data.expect, value) { + t.Fail() + } + } +} From 51df014c4aa1b27dd01747c5bb6661142f47414d Mon Sep 17 00:00:00 2001 From: debugtalk Date: Thu, 30 Dec 2021 18:02:15 +0800 Subject: [PATCH 23/53] change: update models --- boomer.go | 12 ++++++------ docs/CHANGELOG.md | 2 +- runner.go | 18 +++++++++--------- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/boomer.go b/boomer.go index eda4a4f2..29aa144c 100644 --- a/boomer.go +++ b/boomer.go @@ -9,27 +9,27 @@ import ( "github.com/httprunner/hrp/internal/ga" ) -func NewBoomer(spawnCount int, spawnRate float64) *hrpBoomer { - b := &hrpBoomer{ +func NewBoomer(spawnCount int, spawnRate float64) *HRPBoomer { + b := &HRPBoomer{ Boomer: boomer.NewStandaloneBoomer(spawnCount, spawnRate), debug: false, } return b } -type hrpBoomer struct { +type HRPBoomer struct { *boomer.Boomer debug bool } // SetDebug configures whether to log HTTP request and response content. -func (b *hrpBoomer) SetDebug(debug bool) *hrpBoomer { +func (b *HRPBoomer) SetDebug(debug bool) *HRPBoomer { b.debug = debug return b } // Run starts to run load test for one or multiple testcases. -func (b *hrpBoomer) Run(testcases ...ITestCase) { +func (b *HRPBoomer) Run(testcases ...ITestCase) { event := ga.EventTracking{ Category: "RunLoadTests", Action: "hrp boom", @@ -51,7 +51,7 @@ func (b *hrpBoomer) Run(testcases ...ITestCase) { b.Boomer.Run(taskSlice...) } -func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { +func (b *HRPBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { hrpRunner := NewRunner(nil).SetDebug(b.debug) config := testcase.Config.ToStruct() return &boomer.Task{ diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 4f2f8207..1f7d3a6f 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -2,7 +2,7 @@ ## v0.3.1 (2021-12-30) -- feat: set ulimit to 10240 before load testing +- fix: set ulimit to 10240 before load testing - fix: concurrent map writes in load testing ## v0.3.0 (2021-12-24) diff --git a/runner.go b/runner.go index a1b9d108..260816a1 100644 --- a/runner.go +++ b/runner.go @@ -28,11 +28,11 @@ func Run(testcases ...ITestCase) error { } // NewRunner constructs a new runner instance. -func NewRunner(t *testing.T) *hrpRunner { +func NewRunner(t *testing.T) *HRPRunner { if t == nil { t = &testing.T{} } - return &hrpRunner{ + return &HRPRunner{ t: t, failfast: true, // default to failfast debug: false, // default to turn off debug @@ -45,7 +45,7 @@ func NewRunner(t *testing.T) *hrpRunner { } } -type hrpRunner struct { +type HRPRunner struct { t *testing.T failfast bool debug bool @@ -53,21 +53,21 @@ type hrpRunner struct { } // SetFailfast configures whether to stop running when one step fails. -func (r *hrpRunner) SetFailfast(failfast bool) *hrpRunner { +func (r *HRPRunner) SetFailfast(failfast bool) *HRPRunner { log.Info().Bool("failfast", failfast).Msg("[init] SetFailfast") r.failfast = failfast return r } // SetDebug configures whether to log HTTP request and response content. -func (r *hrpRunner) SetDebug(debug bool) *hrpRunner { +func (r *HRPRunner) SetDebug(debug bool) *HRPRunner { log.Info().Bool("debug", debug).Msg("[init] SetDebug") r.debug = debug return r } // SetProxyUrl configures the proxy URL, which is usually used to capture HTTP packets for debugging. -func (r *hrpRunner) SetProxyUrl(proxyUrl string) *hrpRunner { +func (r *HRPRunner) SetProxyUrl(proxyUrl string) *HRPRunner { log.Info().Str("proxyUrl", proxyUrl).Msg("[init] SetProxyUrl") p, err := url.Parse(proxyUrl) if err != nil { @@ -82,7 +82,7 @@ func (r *hrpRunner) SetProxyUrl(proxyUrl string) *hrpRunner { } // Run starts to execute one or multiple testcases. -func (r *hrpRunner) Run(testcases ...ITestCase) error { +func (r *HRPRunner) Run(testcases ...ITestCase) error { event := ga.EventTracking{ Category: "RunAPITests", Action: "hrp run", @@ -106,7 +106,7 @@ func (r *hrpRunner) Run(testcases ...ITestCase) error { return nil } -func (r *hrpRunner) newCaseRunner(testcase *TestCase) *caseRunner { +func (r *HRPRunner) newCaseRunner(testcase *TestCase) *caseRunner { caseRunner := &caseRunner{ TestCase: testcase, hrpRunner: r, @@ -119,7 +119,7 @@ func (r *hrpRunner) newCaseRunner(testcase *TestCase) *caseRunner { // each testcase has its own caseRunner instance and share session variables. type caseRunner struct { *TestCase - hrpRunner *hrpRunner + hrpRunner *HRPRunner sessionVariables map[string]interface{} // transactions stores transaction timing info. // key is transaction name, value is map of transaction type and time, e.g. start time and end time. From e3b481a273e34f411de1d57fa219852b832160db Mon Sep 17 00:00:00 2001 From: buyuxiang Date: Thu, 30 Dec 2021 18:27:58 +0800 Subject: [PATCH 24/53] complete the comment of builtin.Contains Change-Id: I949e2ccda53960dd12f64bda3c9c69513f59d4ed --- internal/builtin/assertion.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/builtin/assertion.go b/internal/builtin/assertion.go index 87e4709b..20813392 100644 --- a/internal/builtin/assertion.go +++ b/internal/builtin/assertion.go @@ -87,7 +87,7 @@ func convertInt(value interface{}) (int, error) { } } -// Contains assert whether actual +// Contains assert whether actual element contains expected element func Contains(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { return assert.Contains(t, actual, expected, msgAndArgs) } From e5608f77581dc8e67aab1d3bc938d2ddb7fe80da Mon Sep 17 00:00:00 2001 From: buyuxiang Date: Thu, 30 Dec 2021 19:50:55 +0800 Subject: [PATCH 25/53] chore: add BUILTIN.md, append CHANGELOG.md Change-Id: I12e0c6ba3621d383fa46a811abbdcd55dbf80a17 --- docs/BUILTIN.md | 44 ++++++++++++++++++++++++++++++++++++ docs/CHANGELOG.md | 2 ++ internal/builtin/function.go | 2 +- 3 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 docs/BUILTIN.md diff --git a/docs/BUILTIN.md b/docs/BUILTIN.md new file mode 100644 index 00000000..e90b0a04 --- /dev/null +++ b/docs/BUILTIN.md @@ -0,0 +1,44 @@ +# Builtin + +## Assertion Methods + +### Usage +In "teststeps" of each json/yaml testcase, the "validate" part contains four fields: "check", "assert", "expect" and +"msg", when using assertion methods, method name should be put in "assert" field. The assertion result of "check" +element will be checked out using the regulation you put in "assert" field and compared with the element in "expect" +field. + +### Method List + +- equals: assert the element to check equals the expected element. +- equal: alias for equals. +- greater_than: assert the element to check is greater than the expected element. +- less_than: assert the element to check is less than the expected element. +- greater_or_equals: assert the element to check is greater than or equal with the expected element. +- less_or_equals: assert the element to check is less than or equal with the expected element. +- not_equal: assert the element to check is not equal with the expected element. +- contained_by: assert the expected element contains the element to check. +- regex_match: assert the element to check matches the expected element using regex. +- type_match: assert the element to check matches the expected element in type. +- startswith: assert the element to check starts with the expected element. +- endswith: assert the element to check ends with the expected element. +- length_equals: assert the length of the element to check is equal with the expected element. +- length_equal: alias for length_equals. +- contains: assert the element to check contains the expected element. +- string_equals: assert the string is equal with the expected string. + +## Common Functions + +### Usage +The common functions are useful during the variables configuration, you can use "${FUNCTION_NAME}" to call the specific +function to define variables. + +### Function List +- get_timestamp: get the thirteen-digit timestamp of current time. (call without argument) +- sleep: sleep n seconds to simulate the thinking time. (call with one argument n) +- gen_random_string: get the n-digit random string. (call with one argument n) +- max: get the maximum of two numbers m and n. (call with two argument m and n) +- md5: get the MD5 of the input string s. (call with one argument s) + + + diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 67354670..d428e4f1 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,5 +1,7 @@ # Release History +-feat: add more plentiful response assertion methods + ## v0.3.0 (2021-12-22) - feat: implement `transaction` mechanism for load test diff --git a/internal/builtin/function.go b/internal/builtin/function.go index d1d3dd3b..e11529eb 100644 --- a/internal/builtin/function.go +++ b/internal/builtin/function.go @@ -13,7 +13,7 @@ var Functions = map[string]interface{}{ "sleep": sleep, // call with one argument "gen_random_string": genRandomString, // call with one argument "max": math.Max, // call with two arguments - "md5": MD5, + "md5": MD5, // call with one argument } func init() { From 57816f504bab0ac60e057a426fb4f22dfeed3e79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Thu, 30 Dec 2021 21:28:05 +0800 Subject: [PATCH 26/53] feat: data-driven. --- boomer.go | 17 +++++---- examples/parameters_test.json | 7 +--- examples/parameters_test.yaml | 1 + models.go | 53 +++++++++++++++++++++++++- parser.go | 72 ++++++++++++++++++----------------- parser_test.go | 26 ++++++++++++- runner.go | 22 ++++++++--- 7 files changed, 141 insertions(+), 57 deletions(-) diff --git a/boomer.go b/boomer.go index 08644c6e..6e973d83 100644 --- a/boomer.go +++ b/boomer.go @@ -46,15 +46,12 @@ func (b *hrpBoomer) Run(testcases ...ITestCase) { panic(err) } cfg := testcase.Config.ToStruct() - parameters := getParameters(testcase.Config) - if parameters == nil { - parameters = []map[string]interface{}{{}} - } - for _, parameter := range parameters { - cfg.Variables = mergeVariables(parameter, cfg.Variables) - task := b.convertBoomerTask(testcase) - taskSlice = append(taskSlice, task) + err = initParameterIterator(cfg, "boomer") + if err != nil { + panic(err) } + task := b.convertBoomerTask(testcase) + taskSlice = append(taskSlice, task) } b.Boomer.Run(taskSlice...) } @@ -71,6 +68,10 @@ func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { testcaseSuccess := true // flag whole testcase result var transactionSuccess = true // flag current transaction result + cfg := testcase.Config.ToStruct() + if it := cfg.ParameterIterator; it.HasNext() { + cfg.Variables = mergeVariables(it.Next(), cfg.Variables) + } startTime := time.Now() for index, step := range testcase.TestSteps { stepData, err := runner.runStep(index) diff --git a/examples/parameters_test.json b/examples/parameters_test.json index c519e928..d61fd85f 100644 --- a/examples/parameters_test.json +++ b/examples/parameters_test.json @@ -6,14 +6,11 @@ "iOS/10.1", "iOS/10.2" ], - "username1-password1": [ - ["a", "123"], - ["b", "456"] - ], "username-password": "${parameterize(examples/account.csv)}" }, "parameters_setting": { - "strategy": "random" + "strategy": "random", + "iteration": 1 }, "variables": { "app_version": "f1" diff --git a/examples/parameters_test.yaml b/examples/parameters_test.yaml index 65c307a8..b19ddcf4 100644 --- a/examples/parameters_test.yaml +++ b/examples/parameters_test.yaml @@ -5,6 +5,7 @@ config: username-password: ${parameterize(examples/account.csv)} parameters_setting: strategy: random + iteration: 1 variables: app_version: f1 base_url: "https://postman-echo.com" diff --git a/models.go b/models.go index d587a9c0..9ded19c3 100644 --- a/models.go +++ b/models.go @@ -1,5 +1,11 @@ package hrp +import ( + "math/rand" + "strings" + "time" +) + const ( httpGET string = "GET" httpHEAD string = "HEAD" @@ -18,11 +24,56 @@ type TConfig struct { BaseURL string `json:"base_url,omitempty" yaml:"base_url,omitempty"` Variables map[string]interface{} `json:"variables,omitempty" yaml:"variables,omitempty"` Parameters map[string]interface{} `json:"parameters,omitempty" yaml:"parameters,omitempty"` - ParametersSetting map[string]interface{} `json:"parameters_setting,omitempty" yaml:"parameters_setting,omitempty"` + ParametersSetting *TParamsConfig `json:"parameters_setting,omitempty" yaml:"parameters_setting,omitempty"` + ParameterIterator *Iterator `json:"parameterIterator,omitempty" yaml:"parameterIterator,omitempty"` Export []string `json:"export,omitempty" yaml:"export,omitempty"` Weight int `json:"weight,omitempty" yaml:"weight,omitempty"` } +type TParamsConfig struct { + Strategy string `json:"strategy,omitempty" yaml:"strategy,omitempty"` + Iteration int `json:"iteration,omitempty" yaml:"iteration,omitempty"` +} + +type paramsType []map[string]interface{} + +type Iterator struct { + data paramsType + strategy string + iteration int + index int +} + +func (params paramsType) Iterator() *Iterator { + return &Iterator{ + data: params, + iteration: len(params), + index: 0, + } +} + +func (iter *Iterator) HasNext() bool { + if iter.iteration == -1 { + return true + } + return iter.index < iter.iteration +} + +func (iter *Iterator) Next() (value map[string]interface{}) { + iter.index++ + if len(iter.data) == 0 { + return map[string]interface{}{} + } + if strings.ToLower(iter.strategy) == "random" { + randSource := rand.New(rand.NewSource(time.Now().Unix())) + randIndex := randSource.Intn(len(iter.data)) + value = iter.data[randIndex] + } else { + value = iter.data[iter.index%len(iter.data)] + } + return value +} + // Request represents HTTP request data structure. // This is used for teststep. type Request struct { diff --git a/parser.go b/parser.go index cc92fde8..7f34539b 100644 --- a/parser.go +++ b/parser.go @@ -3,16 +3,13 @@ package hrp import ( "encoding/json" "fmt" - "math/rand" + "github.com/maja42/goval" + "github.com/pkg/errors" + "github.com/rs/zerolog/log" "net/url" "reflect" "regexp" "strings" - "time" - - "github.com/maja42/goval" - "github.com/pkg/errors" - "github.com/rs/zerolog/log" "github.com/httprunner/hrp/internal/builtin" ) @@ -496,19 +493,6 @@ func findallVariables(raw string) variableSet { return varSet } -func shuffleCartesianProduct(slice []map[string]interface{}) { - if len(slice) == 0 { - return - } - r := rand.New(rand.NewSource(time.Now().Unix())) - for len(slice) > 0 { - n := len(slice) - randIndex := r.Intn(n) - slice[n-1], slice[randIndex] = slice[randIndex], slice[n-1] - slice = slice[:n-1] - } -} - func genCartesianProduct(params [][]map[string]interface{}) []map[string]interface{} { if len(params) == 0 { return nil @@ -527,19 +511,6 @@ func genCartesianProduct(params [][]map[string]interface{}) []map[string]interfa return cartesianProduct } -func getParameters(config IConfig) []map[string]interface{} { - cfg := config.ToStruct() - // parse config parameters - parsedParams, err := parseParameters(cfg.Parameters, cfg.Variables) - if err != nil { - log.Error().Interface("parameters", cfg.Parameters).Err(err).Msg("parse config parameters failed") - } - if cfg.ParametersSetting["strategy"] != nil && strings.ToLower(cfg.ParametersSetting["strategy"].(string)) == "random" { - shuffleCartesianProduct(parsedParams) - } - return parsedParams -} - func parseParameters(parameters map[string]interface{}, variablesMapping map[string]interface{}) ([]map[string]interface{}, error) { if len(parameters) == 0 { return nil, nil @@ -562,9 +533,9 @@ func parseParameters(parameters map[string]interface{}, variablesMapping map[str log.Error().Interface("parameterContent", parsedParameterRawValue).Msg("[parseParameters] parsed parameter content should be Slice, got %v") return nil, errors.New("parsed parameter content should be Slice") } - parameterSlice, err = handleSlice(k, parsedParameterRawValue.Interface()) + parameterSlice, err = parseSlice(k, parsedParameterRawValue.Interface()) case reflect.Slice: - parameterSlice, err = handleSlice(k, rawValue.Interface()) + parameterSlice, err = parseSlice(k, rawValue.Interface()) default: log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be Slice or Text(variables or functions call)") return nil, errors.New("parameter content should be Slice or Text(variables or functions call)") @@ -577,10 +548,13 @@ func parseParameters(parameters map[string]interface{}, variablesMapping map[str return genCartesianProduct(parsedParametersSlice), nil } -func handleSlice(parameterName string, parameterContent interface{}) ([]map[string]interface{}, error) { +func parseSlice(parameterName string, parameterContent interface{}) ([]map[string]interface{}, error) { parameterNameSlice := strings.Split(parameterName, "-") var parameterSlice []map[string]interface{} parameterContentSlice := reflect.ValueOf(parameterContent) + if parameterContentSlice.Kind() != reflect.Slice { + return nil, errors.New("parameterContent should be Slice") + } for i := 0; i < parameterContentSlice.Len(); i++ { parameterMap := make(map[string]interface{}) elem := reflect.ValueOf(parameterContentSlice.Index(i).Interface()) @@ -620,3 +594,31 @@ func handleSlice(parameterName string, parameterContent interface{}) ([]map[stri } return parameterSlice, nil } + +func initParameterIterator(cfg *TConfig, mode string) (err error) { + var parameters paramsType + parameters, err = parseParameters(cfg.Parameters, cfg.Variables) + cfg.ParameterIterator = parameters.Iterator() + if err != nil { + return err + } + // parse config parameters setting + if cfg.ParametersSetting == nil { + cfg.ParametersSetting = &TParamsConfig{} + } + if len(cfg.ParametersSetting.Strategy) == 0 { + cfg.ParametersSetting.Strategy = "sequential" + } else { + cfg.ParametersSetting.Strategy = strings.ToLower(cfg.ParametersSetting.Strategy) + } + cfg.ParameterIterator.strategy = cfg.ParametersSetting.Strategy + if mode == "boomer" { + cfg.ParametersSetting.Iteration = -1 + cfg.ParameterIterator.iteration = cfg.ParametersSetting.Iteration + } else { + if cfg.ParametersSetting.Iteration != 0 { + cfg.ParameterIterator.iteration = cfg.ParametersSetting.Iteration + } + } + return nil +} diff --git a/parser_test.go b/parser_test.go index c69a584d..a8d4bdea 100644 --- a/parser_test.go +++ b/parser_test.go @@ -692,7 +692,7 @@ func TestParseParametersError(t *testing.T) { } } -func TestHandleSlice(t *testing.T) { +func TestParseSlice(t *testing.T) { testData := []struct { rawVar1 string rawVar2 interface{} @@ -724,9 +724,31 @@ func TestHandleSlice(t *testing.T) { }, } for _, data := range testData { - value, _ := handleSlice(data.rawVar1, data.rawVar2) + value, _ := parseSlice(data.rawVar1, data.rawVar2) if !assert.Equal(t, data.expect, value) { t.Fail() } } } + +func TestParseSliceError(t *testing.T) { + testData := []struct { + rawVar1 string + rawVar2 interface{} + }{ + { + "app_version", + 123, + }, + { + "app_version", + "123", + }, + } + for _, data := range testData { + _, err := parseSlice(data.rawVar1, data.rawVar2) + if !assert.Error(t, err) { + t.Fail() + } + } +} diff --git a/runner.go b/runner.go index b33d44d3..f568c818 100644 --- a/runner.go +++ b/runner.go @@ -141,13 +141,17 @@ func (r *caseRunner) run() error { if err := r.parseConfig(config); err != nil { return err } + cfg := config.ToStruct() log.Info().Str("testcase", config.Name()).Msg("run testcase start") - r.startTime = time.Now() - for index := range r.TestCase.TestSteps { - _, err := r.runStep(index) - if err != nil { - if r.hrpRunner.failfast { - return errors.Wrap(err, "abort running due to failfast setting") + for it := cfg.ParameterIterator; it.HasNext(); { + cfg.Variables = mergeVariables(it.Next(), cfg.Variables) + r.startTime = time.Now() + for index := range r.TestCase.TestSteps { + _, err := r.runStep(index) + if err != nil { + if r.hrpRunner.failfast { + return errors.Wrap(err, "abort running due to failfast setting") + } } } } @@ -482,6 +486,12 @@ func (r *caseRunner) parseConfig(config IConfig) error { return err } cfg.Variables = parsedVariables + // parse config parameters + err = initParameterIterator(cfg, "runner") + if err != nil { + log.Error().Interface("parameters", cfg.Parameters).Err(err).Msg("parse config parameters failed") + return err + } // parse config name parsedName, err := parseString(cfg.Name, cfg.Variables) if err != nil { From cfc46b0a63c1aff5891936d4696476ae01acdf50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Thu, 30 Dec 2021 22:31:39 +0800 Subject: [PATCH 27/53] feat: data-driven. --- boomer.go | 2 +- convert.go | 5 +++-- internal/builtin/function.go | 9 +++++---- models.go | 16 ++++++++++------ parser.go | 35 +++++++++++++++++++---------------- runner.go | 2 +- 6 files changed, 39 insertions(+), 30 deletions(-) diff --git a/boomer.go b/boomer.go index 6e973d83..48593fbd 100644 --- a/boomer.go +++ b/boomer.go @@ -69,7 +69,7 @@ func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { var transactionSuccess = true // flag current transaction result cfg := testcase.Config.ToStruct() - if it := cfg.ParameterIterator; it.HasNext() { + if it := cfg.ParametersSetting.Iterator; it.HasNext() { cfg.Variables = mergeVariables(it.Next(), cfg.Variables) } startTime := time.Now() diff --git a/convert.go b/convert.go index 7cdedfae..7f1bc830 100644 --- a/convert.go +++ b/convert.go @@ -4,10 +4,11 @@ import ( "bytes" "encoding/json" "fmt" - "github.com/rs/zerolog/log" - "gopkg.in/yaml.v3" "io/ioutil" "path/filepath" + + "github.com/rs/zerolog/log" + "gopkg.in/yaml.v3" ) func (tc *TCase) Dump2JSON(path string) error { diff --git a/internal/builtin/function.go b/internal/builtin/function.go index 8d6fd87e..f4f7aaae 100644 --- a/internal/builtin/function.go +++ b/internal/builtin/function.go @@ -4,13 +4,14 @@ import ( "crypto/md5" "encoding/csv" "encoding/hex" - "github.com/rs/zerolog/log" "io/ioutil" "math" "math/rand" "path/filepath" "strings" "time" + + "github.com/rs/zerolog/log" ) var Functions = map[string]interface{}{ @@ -19,8 +20,8 @@ var Functions = map[string]interface{}{ "gen_random_string": genRandomString, // call with one argument "max": math.Max, // call with two arguments "md5": MD5, - "parameterize": LoadFromCSV, - "P": LoadFromCSV, + "parameterize": loadFromCSV, + "P": loadFromCSV, } func init() { @@ -52,7 +53,7 @@ func MD5(str string) string { return hex.EncodeToString(hasher.Sum(nil)) } -func LoadFromCSV(path string) []map[string]interface{} { +func loadFromCSV(path string) []map[string]interface{} { path, err := filepath.Abs(path) if err != nil { log.Error().Str("path", path).Err(err).Msg("convert absolute path failed") diff --git a/models.go b/models.go index 9ded19c3..0fb93199 100644 --- a/models.go +++ b/models.go @@ -2,7 +2,6 @@ package hrp import ( "math/rand" - "strings" "time" ) @@ -25,21 +24,26 @@ type TConfig struct { Variables map[string]interface{} `json:"variables,omitempty" yaml:"variables,omitempty"` Parameters map[string]interface{} `json:"parameters,omitempty" yaml:"parameters,omitempty"` ParametersSetting *TParamsConfig `json:"parameters_setting,omitempty" yaml:"parameters_setting,omitempty"` - ParameterIterator *Iterator `json:"parameterIterator,omitempty" yaml:"parameterIterator,omitempty"` Export []string `json:"export,omitempty" yaml:"export,omitempty"` Weight int `json:"weight,omitempty" yaml:"weight,omitempty"` } type TParamsConfig struct { - Strategy string `json:"strategy,omitempty" yaml:"strategy,omitempty"` - Iteration int `json:"iteration,omitempty" yaml:"iteration,omitempty"` + Strategy string `json:"strategy,omitempty" yaml:"strategy,omitempty"` + Iteration int `json:"iteration,omitempty" yaml:"iteration,omitempty"` + Iterator *Iterator `json:"parameterIterator,omitempty" yaml:"parameterIterator,omitempty"` } +const ( + strategyRandom string = "random" + strategySequential string = "Sequential" +) + type paramsType []map[string]interface{} type Iterator struct { data paramsType - strategy string + strategy string // random, sequential iteration int index int } @@ -64,7 +68,7 @@ func (iter *Iterator) Next() (value map[string]interface{}) { if len(iter.data) == 0 { return map[string]interface{}{} } - if strings.ToLower(iter.strategy) == "random" { + if iter.strategy == strategyRandom { randSource := rand.New(rand.NewSource(time.Now().Unix())) randIndex := randSource.Intn(len(iter.data)) value = iter.data[randIndex] diff --git a/parser.go b/parser.go index 7f34539b..389111a3 100644 --- a/parser.go +++ b/parser.go @@ -3,14 +3,15 @@ package hrp import ( "encoding/json" "fmt" - "github.com/maja42/goval" - "github.com/pkg/errors" - "github.com/rs/zerolog/log" "net/url" "reflect" "regexp" "strings" + "github.com/maja42/goval" + "github.com/pkg/errors" + "github.com/rs/zerolog/log" + "github.com/httprunner/hrp/internal/builtin" ) @@ -522,23 +523,25 @@ func parseParameters(parameters map[string]interface{}, variablesMapping map[str rawValue := reflect.ValueOf(v) switch rawValue.Kind() { case reflect.String: + // e.g. username-password: ${parameterize(examples/account.csv)} -> [{"username": "test1", "password": "111111"}, {"username": "test2", "password": "222222"}] var parsedParameterContent interface{} - parsedParameterContent, err = parseData(rawValue.Interface(), variablesMapping) + parsedParameterContent, err = parseString(rawValue.String(), variablesMapping) if err != nil { log.Error().Interface("parameterContent", rawValue).Msg("[parseParameters] parse parameter content error") return nil, err } parsedParameterRawValue := reflect.ValueOf(parsedParameterContent) if parsedParameterRawValue.Kind() != reflect.Slice { - log.Error().Interface("parameterContent", parsedParameterRawValue).Msg("[parseParameters] parsed parameter content should be Slice, got %v") - return nil, errors.New("parsed parameter content should be Slice") + log.Error().Interface("parameterContent", parsedParameterRawValue).Msg("[parseParameters] parsed parameter content should be slice") + return nil, errors.New("parsed parameter content should be slice") } parameterSlice, err = parseSlice(k, parsedParameterRawValue.Interface()) case reflect.Slice: + // e.g. user_agent: ["iOS/10.1", "iOS/10.2"] -> [{"user_agent": "iOS/10.1"}, {"user_agent": "iOS/10.2"}] parameterSlice, err = parseSlice(k, rawValue.Interface()) default: - log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be Slice or Text(variables or functions call)") - return nil, errors.New("parameter content should be Slice or Text(variables or functions call)") + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be slice or text(functions call)") + return nil, errors.New("parameter content should be slice or text(functions call)") } if err != nil { return nil, err @@ -553,7 +556,7 @@ func parseSlice(parameterName string, parameterContent interface{}) ([]map[strin var parameterSlice []map[string]interface{} parameterContentSlice := reflect.ValueOf(parameterContent) if parameterContentSlice.Kind() != reflect.Slice { - return nil, errors.New("parameterContent should be Slice") + return nil, errors.New("parameterContent should be slice") } for i := 0; i < parameterContentSlice.Len(); i++ { parameterMap := make(map[string]interface{}) @@ -574,8 +577,8 @@ func parseSlice(parameterName string, parameterContent interface{}) ([]map[strin // e.g. "username-password": [["test1", "passwd1"], ["test2", "passwd2"]] // -> [{"username": "test1", "password": "passwd1"}, {"username": "test2", "password": "passwd2"}] if len(parameterNameSlice) != elem.Len() { - log.Error().Interface("parameterNameSlice", parameterNameSlice).Interface("parameterContent", elem.Interface()).Msg("[parseParameters] parameter name Slice and parameter content Slice should have the same length") - return nil, errors.New("parameter name Slice and parameter cjntent Slice should have the same length") + log.Error().Interface("parameterNameSlice", parameterNameSlice).Interface("parameterContent", elem.Interface()).Msg("[parseParameters] parameter name slice and parameter content slice should have the same length") + return nil, errors.New("parameter name slice and parameter content slice should have the same length") } else { for j := 0; j < elem.Len(); j++ { parameterMap[parameterNameSlice[j]] = elem.Index(j).Interface() @@ -598,7 +601,7 @@ func parseSlice(parameterName string, parameterContent interface{}) ([]map[strin func initParameterIterator(cfg *TConfig, mode string) (err error) { var parameters paramsType parameters, err = parseParameters(cfg.Parameters, cfg.Variables) - cfg.ParameterIterator = parameters.Iterator() + cfg.ParametersSetting.Iterator = parameters.Iterator() if err != nil { return err } @@ -607,17 +610,17 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { cfg.ParametersSetting = &TParamsConfig{} } if len(cfg.ParametersSetting.Strategy) == 0 { - cfg.ParametersSetting.Strategy = "sequential" + cfg.ParametersSetting.Strategy = strategySequential } else { cfg.ParametersSetting.Strategy = strings.ToLower(cfg.ParametersSetting.Strategy) } - cfg.ParameterIterator.strategy = cfg.ParametersSetting.Strategy + cfg.ParametersSetting.Iterator.strategy = cfg.ParametersSetting.Strategy if mode == "boomer" { cfg.ParametersSetting.Iteration = -1 - cfg.ParameterIterator.iteration = cfg.ParametersSetting.Iteration + cfg.ParametersSetting.Iterator.iteration = cfg.ParametersSetting.Iteration } else { if cfg.ParametersSetting.Iteration != 0 { - cfg.ParameterIterator.iteration = cfg.ParametersSetting.Iteration + cfg.ParametersSetting.Iterator.iteration = cfg.ParametersSetting.Iteration } } return nil diff --git a/runner.go b/runner.go index f568c818..c227064a 100644 --- a/runner.go +++ b/runner.go @@ -143,7 +143,7 @@ func (r *caseRunner) run() error { } cfg := config.ToStruct() log.Info().Str("testcase", config.Name()).Msg("run testcase start") - for it := cfg.ParameterIterator; it.HasNext(); { + for it := cfg.ParametersSetting.Iterator; it.HasNext(); { cfg.Variables = mergeVariables(it.Next(), cfg.Variables) r.startTime = time.Now() for index := range r.TestCase.TestSteps { From 6e5d8ca77a670038aa6de1d9b284a13411f41cf7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 11:03:55 +0800 Subject: [PATCH 28/53] feat: data-driven. --- parser.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/parser.go b/parser.go index 389111a3..19a866d4 100644 --- a/parser.go +++ b/parser.go @@ -607,7 +607,7 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { } // parse config parameters setting if cfg.ParametersSetting == nil { - cfg.ParametersSetting = &TParamsConfig{} + cfg.ParametersSetting = &TParamsConfig{Iterator: &Iterator{}} } if len(cfg.ParametersSetting.Strategy) == 0 { cfg.ParametersSetting.Strategy = strategySequential @@ -619,7 +619,7 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { cfg.ParametersSetting.Iteration = -1 cfg.ParametersSetting.Iterator.iteration = cfg.ParametersSetting.Iteration } else { - if cfg.ParametersSetting.Iteration != 0 { + if cfg.ParametersSetting.Iteration > 0 { cfg.ParametersSetting.Iterator.iteration = cfg.ParametersSetting.Iteration } } From e84f1367bb9fb632ce62b280bce89a704637c641 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 11:24:06 +0800 Subject: [PATCH 29/53] feat: data-driven. --- parser.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/parser.go b/parser.go index 19a866d4..395b8972 100644 --- a/parser.go +++ b/parser.go @@ -601,14 +601,14 @@ func parseSlice(parameterName string, parameterContent interface{}) ([]map[strin func initParameterIterator(cfg *TConfig, mode string) (err error) { var parameters paramsType parameters, err = parseParameters(cfg.Parameters, cfg.Variables) - cfg.ParametersSetting.Iterator = parameters.Iterator() - if err != nil { - return err - } // parse config parameters setting if cfg.ParametersSetting == nil { cfg.ParametersSetting = &TParamsConfig{Iterator: &Iterator{}} } + cfg.ParametersSetting.Iterator = parameters.Iterator() + if err != nil { + return err + } if len(cfg.ParametersSetting.Strategy) == 0 { cfg.ParametersSetting.Strategy = strategySequential } else { From 0158e9e7ba5655d3702ba45fd15013a2fac78501 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 12:02:38 +0800 Subject: [PATCH 30/53] feat: data-driven. --- parser.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/parser.go b/parser.go index 395b8972..9cd49a00 100644 --- a/parser.go +++ b/parser.go @@ -621,6 +621,8 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { } else { if cfg.ParametersSetting.Iteration > 0 { cfg.ParametersSetting.Iterator.iteration = cfg.ParametersSetting.Iteration + } else if cfg.ParametersSetting.Iterator.iteration == 0 { + cfg.ParametersSetting.Iterator.iteration = 1 } } return nil From b8e9f320eb55c4720c285110eb66c92f03331c97 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 14:24:19 +0800 Subject: [PATCH 31/53] feat: data-driven. --- parser_test.go | 33 ++++++++++++++------------------- 1 file changed, 14 insertions(+), 19 deletions(-) diff --git a/parser_test.go b/parser_test.go index a8d4bdea..b66c5f79 100644 --- a/parser_test.go +++ b/parser_test.go @@ -621,44 +621,39 @@ func TestFindallVariables(t *testing.T) { func TestParseParameters(t *testing.T) { testData := []struct { - rawVars map[string]interface{} - expectVars []map[string]interface{} + rawVars map[string]interface{} + expectLength int }{ { map[string]interface{}{ "username-password": "${parameterize(examples/account.csv)}", "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, - []map[string]interface{}{ - {"username": "test1", "password": "111111", "user_agent": "IOS/10.1"}, - {"username": "test1", "password": "111111", "user_agent": "IOS/10.2"}, - {"username": "test2", "password": "222222", "user_agent": "IOS/10.1"}, - {"username": "test2", "password": "222222", "user_agent": "IOS/10.2"}, - {"username": "test3", "password": "333333", "user_agent": "IOS/10.1"}, - {"username": "test3", "password": "333333", "user_agent": "IOS/10.2"}}, + 6, }, { map[string]interface{}{ "username-password": [][]interface{}{{"test1", "111111"}, {"test2", "222222"}, {"test3", "333333"}}, "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}, "app_version": []interface{}{0.3}}, - []map[string]interface{}{ - {"username": "test1", "password": "111111", "user_agent": "IOS/10.1", "app_version": 0.3}, - {"username": "test1", "password": "111111", "user_agent": "IOS/10.2", "app_version": 0.3}, - {"username": "test2", "password": "222222", "user_agent": "IOS/10.1", "app_version": 0.3}, - {"username": "test2", "password": "222222", "user_agent": "IOS/10.2", "app_version": 0.3}, - {"username": "test3", "password": "333333", "user_agent": "IOS/10.1", "app_version": 0.3}, - {"username": "test3", "password": "333333", "user_agent": "IOS/10.2", "app_version": 0.3}}, + 6, }, { - map[string]interface{}{}, nil, + map[string]interface{}{ + "username-password": [][]interface{}{{"test1", "111111"}, {"test2", "222222"}, {"test3", "333333"}}, + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}, + "app_version": []interface{}{0.3, 0.4, 0.5}}, + 18, }, { - nil, nil, + map[string]interface{}{}, 0, + }, + { + nil, 0, }, } for _, data := range testData { value, _ := parseParameters(data.rawVars, map[string]interface{}{}) - if !assert.Equal(t, data.expectVars, value) { + if !assert.Len(t, value, data.expectLength) { t.Fail() } } From 5d82873e1d5c52d7975e1569ea3673048a1b6840 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 15:36:01 +0800 Subject: [PATCH 32/53] fix: avoid data racing. --- boomer.go | 10 ++++++++-- runner.go | 16 +++++----------- step_test.go | 4 ++-- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/boomer.go b/boomer.go index 48593fbd..7096aee9 100644 --- a/boomer.go +++ b/boomer.go @@ -1,6 +1,7 @@ package hrp import ( + "github.com/jinzhu/copier" "time" "github.com/rs/zerolog/log" @@ -69,12 +70,17 @@ func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { var transactionSuccess = true // flag current transaction result cfg := testcase.Config.ToStruct() + testCaseVariables := &TConfig{} + // copy config to avoid data racing + if err := copier.Copy(testCaseVariables, cfg); err != nil { + log.Error().Err(err).Msg("copy config data failed") + } if it := cfg.ParametersSetting.Iterator; it.HasNext() { - cfg.Variables = mergeVariables(it.Next(), cfg.Variables) + testCaseVariables.Variables = mergeVariables(it.Next(), cfg.Variables) } startTime := time.Now() for index, step := range testcase.TestSteps { - stepData, err := runner.runStep(index) + stepData, err := runner.runStep(index, testCaseVariables) if err != nil { // step failed var elapsed int64 diff --git a/runner.go b/runner.go index c227064a..df33b966 100644 --- a/runner.go +++ b/runner.go @@ -147,7 +147,7 @@ func (r *caseRunner) run() error { cfg.Variables = mergeVariables(it.Next(), cfg.Variables) r.startTime = time.Now() for index := range r.TestCase.TestSteps { - _, err := r.runStep(index) + _, err := r.runStep(index, cfg) if err != nil { if r.hrpRunner.failfast { return errors.Wrap(err, "abort running due to failfast setting") @@ -160,8 +160,7 @@ func (r *caseRunner) run() error { return nil } -func (r *caseRunner) runStep(index int) (stepResult *stepData, err error) { - config := r.TestCase.Config +func (r *caseRunner) runStep(index int, caseConfig *TConfig) (stepResult *stepData, err error) { step := r.TestCase.TestSteps[index] // step type priority order: transaction > rendezvous > testcase > request @@ -181,23 +180,18 @@ func (r *caseRunner) runStep(index int) (stepResult *stepData, err error) { log.Error().Err(err).Msg("copy step data failed") return nil, err } - copiedConfig := &TConfig{} - if err = copier.Copy(copiedConfig, config.ToStruct()); err != nil { - log.Error().Err(err).Msg("copy config data failed") - return nil, err - } stepVariables := copiedStep.Variables // override variables // step variables > session variables (extracted variables from previous steps) stepVariables = mergeVariables(stepVariables, r.sessionVariables) // step variables > testcase config variables - stepVariables = mergeVariables(stepVariables, copiedConfig.Variables) + stepVariables = mergeVariables(stepVariables, caseConfig.Variables) // parse step variables parsedVariables, err := parseVariables(stepVariables) if err != nil { - log.Error().Interface("variables", copiedConfig.Variables).Err(err).Msg("parse step variables failed") + log.Error().Interface("variables", caseConfig.Variables).Err(err).Msg("parse step variables failed") return nil, err } copiedStep.Variables = parsedVariables // avoid data racing @@ -214,7 +208,7 @@ func (r *caseRunner) runStep(index int) (stepResult *stepData, err error) { } } else { // run request - copiedStep.Request.URL = buildURL(copiedConfig.BaseURL, copiedStep.Request.URL) // avoid data racing + copiedStep.Request.URL = buildURL(caseConfig.BaseURL, copiedStep.Request.URL) // avoid data racing stepResult, err = r.runStepRequest(copiedStep) if err != nil { log.Error().Err(err).Msg("run request step failed") diff --git a/step_test.go b/step_test.go index 5fdd3c02..d7e3ee17 100644 --- a/step_test.go +++ b/step_test.go @@ -79,10 +79,10 @@ func TestRunRequestRun(t *testing.T) { TestSteps: []IStep{stepGET, stepPOSTData}, } runner := NewRunner(t).SetDebug(true).newCaseRunner(testcase) - if _, err := runner.runStep(0); err != nil { + if _, err := runner.runStep(0, testcase.Config.ToStruct()); err != nil { t.Fatalf("tStep.Run() error: %s", err) } - if _, err := runner.runStep(1); err != nil { + if _, err := runner.runStep(1, testcase.Config.ToStruct()); err != nil { t.Fatalf("tStepPOSTData.Run() error: %s", err) } } From a60a6f6aefec2886ac457e59faed3d644c136cfa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 15:43:58 +0800 Subject: [PATCH 33/53] fix: avoid data racing. --- models.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/models.go b/models.go index 0fb93199..880d6756 100644 --- a/models.go +++ b/models.go @@ -2,6 +2,7 @@ package hrp import ( "math/rand" + "sync" "time" ) @@ -42,6 +43,7 @@ const ( type paramsType []map[string]interface{} type Iterator struct { + sync.Mutex data paramsType strategy string // random, sequential iteration int @@ -64,6 +66,8 @@ func (iter *Iterator) HasNext() bool { } func (iter *Iterator) Next() (value map[string]interface{}) { + iter.Lock() + defer iter.Unlock() iter.index++ if len(iter.data) == 0 { return map[string]interface{}{} From cd04c44a70a97f6ddde84fb415dd017e76dbadb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 15:50:21 +0800 Subject: [PATCH 34/53] feat: data-driven. --- boomer.go | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/boomer.go b/boomer.go index 7096aee9..f547938b 100644 --- a/boomer.go +++ b/boomer.go @@ -1,9 +1,10 @@ package hrp import ( - "github.com/jinzhu/copier" "time" + "github.com/jinzhu/copier" + "github.com/rs/zerolog/log" "github.com/httprunner/hrp/internal/boomer" @@ -70,17 +71,17 @@ func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { var transactionSuccess = true // flag current transaction result cfg := testcase.Config.ToStruct() - testCaseVariables := &TConfig{} + caseConfig := &TConfig{} // copy config to avoid data racing - if err := copier.Copy(testCaseVariables, cfg); err != nil { + if err := copier.Copy(caseConfig, cfg); err != nil { log.Error().Err(err).Msg("copy config data failed") } if it := cfg.ParametersSetting.Iterator; it.HasNext() { - testCaseVariables.Variables = mergeVariables(it.Next(), cfg.Variables) + caseConfig.Variables = mergeVariables(it.Next(), cfg.Variables) } startTime := time.Now() for index, step := range testcase.TestSteps { - stepData, err := runner.runStep(index, testCaseVariables) + stepData, err := runner.runStep(index, caseConfig) if err != nil { // step failed var elapsed int64 From 5d2e0c5636656797b7cb38958519d2d4d5280f7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 16:31:50 +0800 Subject: [PATCH 35/53] feat: data-driven. --- examples/parameters_test.json | 7 ++++--- examples/parameters_test.yaml | 5 +++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/examples/parameters_test.json b/examples/parameters_test.json index d61fd85f..e2325095 100644 --- a/examples/parameters_test.json +++ b/examples/parameters_test.json @@ -13,7 +13,8 @@ "iteration": 1 }, "variables": { - "app_version": "f1" + "app_version": "f1", + "user_agent": "iOS/10.3" }, "base_url": "https://postman-echo.com", "verify": false @@ -24,7 +25,7 @@ "variables": { "foo1": "$username", "foo2": "$password", - "foo3": "$app_version" + "foo3": "$user_agent" }, "request": { "method": "GET", @@ -48,7 +49,7 @@ { "check": "body.args.foo3", "assert": "not_equal", - "expect": "f1", + "expect": "iOS/10.3", "msg": "check app version" } ] diff --git a/examples/parameters_test.yaml b/examples/parameters_test.yaml index b19ddcf4..cdb4f627 100644 --- a/examples/parameters_test.yaml +++ b/examples/parameters_test.yaml @@ -8,6 +8,7 @@ config: iteration: 1 variables: app_version: f1 + user_agent: iOS/10.3 base_url: "https://postman-echo.com" verify: False @@ -17,7 +18,7 @@ teststeps: variables: foo1: $username foo2: $password - foo3: $app_version + foo3: $user_agent request: method: GET url: /get @@ -34,5 +35,5 @@ teststeps: msg: check status code - check: body.args.foo3 assert: not_equal - expect: f1 + expect: iOS/10.3 msg: check app version \ No newline at end of file From 57b6231d072e4c557dbf76be636464553ac4f054 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 17:06:03 +0800 Subject: [PATCH 36/53] feat: data-driven. --- examples/parameters_test.json | 2 +- examples/parameters_test.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/parameters_test.json b/examples/parameters_test.json index e2325095..e88cf8fb 100644 --- a/examples/parameters_test.json +++ b/examples/parameters_test.json @@ -13,7 +13,7 @@ "iteration": 1 }, "variables": { - "app_version": "f1", + "app_version": "v1", "user_agent": "iOS/10.3" }, "base_url": "https://postman-echo.com", diff --git a/examples/parameters_test.yaml b/examples/parameters_test.yaml index cdb4f627..9ef16dd1 100644 --- a/examples/parameters_test.yaml +++ b/examples/parameters_test.yaml @@ -7,7 +7,7 @@ config: strategy: random iteration: 1 variables: - app_version: f1 + app_version: v1 user_agent: iOS/10.3 base_url: "https://postman-echo.com" verify: False From 70cf171ee3de96bfeb4de1e57de06c47ca8ee4a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 17:13:17 +0800 Subject: [PATCH 37/53] fix: avoid data racing. --- boomer.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/boomer.go b/boomer.go index f547938b..d196cc75 100644 --- a/boomer.go +++ b/boomer.go @@ -77,7 +77,7 @@ func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { log.Error().Err(err).Msg("copy config data failed") } if it := cfg.ParametersSetting.Iterator; it.HasNext() { - caseConfig.Variables = mergeVariables(it.Next(), cfg.Variables) + caseConfig.Variables = mergeVariables(it.Next(), caseConfig.Variables) } startTime := time.Now() for index, step := range testcase.TestSteps { From 6fd07a438839a61602860aa4d9e3fe1369a972d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 20:34:43 +0800 Subject: [PATCH 38/53] feat: data-driven. --- boomer.go | 6 ++- examples/parameters_test.json | 7 +++- examples/parameters_test.yaml | 65 ++++++++++++++++---------------- models.go | 8 ++-- parser.go | 71 +++++++++++++++++++++++------------ runner.go | 8 +++- 6 files changed, 98 insertions(+), 67 deletions(-) diff --git a/boomer.go b/boomer.go index d196cc75..eae914ea 100644 --- a/boomer.go +++ b/boomer.go @@ -76,8 +76,10 @@ func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { if err := copier.Copy(caseConfig, cfg); err != nil { log.Error().Err(err).Msg("copy config data failed") } - if it := cfg.ParametersSetting.Iterator; it.HasNext() { - caseConfig.Variables = mergeVariables(it.Next(), caseConfig.Variables) + for _, it := range cfg.ParametersSetting.Iterator { + if it.HasNext() { + caseConfig.Variables = mergeVariables(it.Next(), caseConfig.Variables) + } } startTime := time.Now() for index, step := range testcase.TestSteps { diff --git a/examples/parameters_test.json b/examples/parameters_test.json index e88cf8fb..61bc5ead 100644 --- a/examples/parameters_test.json +++ b/examples/parameters_test.json @@ -9,8 +9,11 @@ "username-password": "${parameterize(examples/account.csv)}" }, "parameters_setting": { - "strategy": "random", - "iteration": 1 + "strategy": [ + "random", + "sequential" + ], + "iteration": 10 }, "variables": { "app_version": "v1", diff --git a/examples/parameters_test.yaml b/examples/parameters_test.yaml index 9ef16dd1..412acaab 100644 --- a/examples/parameters_test.yaml +++ b/examples/parameters_test.yaml @@ -1,39 +1,38 @@ config: - name: "request methods testcase: validate with parameters" - parameters: - user_agent: ["iOS/10.1", "iOS/10.2"] - username-password: ${parameterize(examples/account.csv)} - parameters_setting: - strategy: random - iteration: 1 - variables: - app_version: v1 - user_agent: iOS/10.3 - base_url: "https://postman-echo.com" - verify: False + name: "request methods testcase: validate with parameters" + parameters: + user_agent: [ "iOS/10.1", "iOS/10.2" ] + username-password: ${parameterize(examples/account.csv)} + parameters_setting: + strategy: ["random", "sequential"] + iteration: 10 + variables: + app_version: v1 + user_agent: iOS/10.3 + base_url: "https://postman-echo.com" + verify: False teststeps: -- - name: get with params + - name: get with params variables: - foo1: $username - foo2: $password - foo3: $user_agent + foo1: $username + foo2: $password + foo3: $user_agent request: - method: GET - url: /get - params: - foo1: $foo1 - foo2: $foo2 - foo3: $foo3 - headers: - User-Agent: $user_agent,$app_version + method: GET + url: /get + params: + foo1: $foo1 + foo2: $foo2 + foo3: $foo3 + headers: + User-Agent: $user_agent,$app_version validate: - - check: status_code - assert: equals - expect: 200 - msg: check status code - - check: body.args.foo3 - assert: not_equal - expect: iOS/10.3 - msg: check app version \ No newline at end of file + - check: status_code + assert: equals + expect: 200 + msg: check status code + - check: body.args.foo3 + assert: not_equal + expect: iOS/10.3 + msg: check app version \ No newline at end of file diff --git a/models.go b/models.go index 880d6756..839234e8 100644 --- a/models.go +++ b/models.go @@ -30,9 +30,9 @@ type TConfig struct { } type TParamsConfig struct { - Strategy string `json:"strategy,omitempty" yaml:"strategy,omitempty"` - Iteration int `json:"iteration,omitempty" yaml:"iteration,omitempty"` - Iterator *Iterator `json:"parameterIterator,omitempty" yaml:"parameterIterator,omitempty"` + Strategy interface{} `json:"strategy,omitempty" yaml:"strategy,omitempty"` + Iteration int `json:"iteration,omitempty" yaml:"iteration,omitempty"` + Iterator []*Iterator `json:"parameterIterator,omitempty" yaml:"parameterIterator,omitempty"` } const ( @@ -68,7 +68,6 @@ func (iter *Iterator) HasNext() bool { func (iter *Iterator) Next() (value map[string]interface{}) { iter.Lock() defer iter.Unlock() - iter.index++ if len(iter.data) == 0 { return map[string]interface{}{} } @@ -79,6 +78,7 @@ func (iter *Iterator) Next() (value map[string]interface{}) { } else { value = iter.data[iter.index%len(iter.data)] } + iter.index++ return value } diff --git a/parser.go b/parser.go index 9cd49a00..0a337f37 100644 --- a/parser.go +++ b/parser.go @@ -494,14 +494,14 @@ func findallVariables(raw string) variableSet { return varSet } -func genCartesianProduct(params [][]map[string]interface{}) []map[string]interface{} { +func genCartesianProduct(params []paramsType) paramsType { if len(params) == 0 { return nil } - var cartesianProduct []map[string]interface{} + var cartesianProduct paramsType cartesianProduct = params[0] for i := 0; i < len(params)-1; i++ { - var tempProduct []map[string]interface{} + var tempProduct paramsType for _, param1 := range cartesianProduct { for _, param2 := range params[i+1] { tempProduct = append(tempProduct, mergeVariables(param1, param2)) @@ -512,14 +512,14 @@ func genCartesianProduct(params [][]map[string]interface{}) []map[string]interfa return cartesianProduct } -func parseParameters(parameters map[string]interface{}, variablesMapping map[string]interface{}) ([]map[string]interface{}, error) { +func parseParameters(parameters map[string]interface{}, variablesMapping map[string]interface{}) ([]paramsType, error) { if len(parameters) == 0 { return nil, nil } - var parsedParametersSlice [][]map[string]interface{} + var parsedParametersSlice []paramsType var err error for k, v := range parameters { - var parameterSlice []map[string]interface{} + var parameterSlice paramsType rawValue := reflect.ValueOf(v) switch rawValue.Kind() { case reflect.String: @@ -548,7 +548,7 @@ func parseParameters(parameters map[string]interface{}, variablesMapping map[str } parsedParametersSlice = append(parsedParametersSlice, parameterSlice) } - return genCartesianProduct(parsedParametersSlice), nil + return parsedParametersSlice, nil } func parseSlice(parameterName string, parameterContent interface{}) ([]map[string]interface{}, error) { @@ -599,31 +599,54 @@ func parseSlice(parameterName string, parameterContent interface{}) ([]map[strin } func initParameterIterator(cfg *TConfig, mode string) (err error) { - var parameters paramsType + var parameters []paramsType parameters, err = parseParameters(cfg.Parameters, cfg.Variables) - // parse config parameters setting - if cfg.ParametersSetting == nil { - cfg.ParametersSetting = &TParamsConfig{Iterator: &Iterator{}} - } - cfg.ParametersSetting.Iterator = parameters.Iterator() if err != nil { return err } - if len(cfg.ParametersSetting.Strategy) == 0 { - cfg.ParametersSetting.Strategy = strategySequential - } else { - cfg.ParametersSetting.Strategy = strings.ToLower(cfg.ParametersSetting.Strategy) + // parse config parameters setting + if cfg.ParametersSetting == nil { + cfg.ParametersSetting = &TParamsConfig{Iterator: []*Iterator{}} } - cfg.ParametersSetting.Iterator.strategy = cfg.ParametersSetting.Strategy if mode == "boomer" { cfg.ParametersSetting.Iteration = -1 - cfg.ParametersSetting.Iterator.iteration = cfg.ParametersSetting.Iteration - } else { - if cfg.ParametersSetting.Iteration > 0 { - cfg.ParametersSetting.Iterator.iteration = cfg.ParametersSetting.Iteration - } else if cfg.ParametersSetting.Iterator.iteration == 0 { - cfg.ParametersSetting.Iterator.iteration = 1 + } + rawValue := reflect.ValueOf(cfg.ParametersSetting.Strategy) + switch rawValue.Kind() { + case reflect.String: + if len(rawValue.String()) == 0 { + cfg.ParametersSetting.Strategy = strategySequential + } else { + cfg.ParametersSetting.Strategy = strings.ToLower(rawValue.String()) + } + cfg.ParametersSetting.Iterator = append( + cfg.ParametersSetting.Iterator, + newIterator(genCartesianProduct(parameters), cfg.ParametersSetting.Strategy.(string), cfg.ParametersSetting.Iteration), + ) + case reflect.Slice: + if len(parameters) != rawValue.Len() { + return errors.New("parameters and strategy should have the same length") + } else { + for i := 0; i < rawValue.Len(); i++ { + cfg.ParametersSetting.Iterator = append( + cfg.ParametersSetting.Iterator, + newIterator(parameters[i], rawValue.Index(i).Interface().(string), cfg.ParametersSetting.Iteration), + ) + } } } return nil } + +func newIterator(parameters paramsType, strategy string, iteration int) *Iterator { + it := parameters.Iterator() + it.strategy = strategy + if iteration > 0 { + it.iteration = iteration + } else if it.iteration == 0 { + it.iteration = 1 + } else { + it.iteration = -1 + } + return it +} diff --git a/runner.go b/runner.go index df33b966..d8f7543d 100644 --- a/runner.go +++ b/runner.go @@ -143,8 +143,12 @@ func (r *caseRunner) run() error { } cfg := config.ToStruct() log.Info().Str("testcase", config.Name()).Msg("run testcase start") - for it := cfg.ParametersSetting.Iterator; it.HasNext(); { - cfg.Variables = mergeVariables(it.Next(), cfg.Variables) + for it := cfg.ParametersSetting.Iterator[0]; it.HasNext(); { + for _, it = range cfg.ParametersSetting.Iterator { + if it.HasNext() { + cfg.Variables = mergeVariables(it.Next(), cfg.Variables) + } + } r.startTime = time.Now() for index := range r.TestCase.TestSteps { _, err := r.runStep(index, cfg) From e80fa6f0a4bc5868d42e247940f7e9b4c0d1d0e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 21:01:16 +0800 Subject: [PATCH 39/53] feat: data-driven. --- examples/parameters_test.yaml | 2 +- parser.go | 26 ++++++++++++++++---------- 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/examples/parameters_test.yaml b/examples/parameters_test.yaml index 412acaab..0eff1384 100644 --- a/examples/parameters_test.yaml +++ b/examples/parameters_test.yaml @@ -4,7 +4,7 @@ config: user_agent: [ "iOS/10.1", "iOS/10.2" ] username-password: ${parameterize(examples/account.csv)} parameters_setting: - strategy: ["random", "sequential"] + strategy: "" iteration: 10 variables: app_version: v1 diff --git a/parser.go b/parser.go index 0a337f37..0d5c70e6 100644 --- a/parser.go +++ b/parser.go @@ -613,16 +613,6 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { } rawValue := reflect.ValueOf(cfg.ParametersSetting.Strategy) switch rawValue.Kind() { - case reflect.String: - if len(rawValue.String()) == 0 { - cfg.ParametersSetting.Strategy = strategySequential - } else { - cfg.ParametersSetting.Strategy = strings.ToLower(rawValue.String()) - } - cfg.ParametersSetting.Iterator = append( - cfg.ParametersSetting.Iterator, - newIterator(genCartesianProduct(parameters), cfg.ParametersSetting.Strategy.(string), cfg.ParametersSetting.Iteration), - ) case reflect.Slice: if len(parameters) != rawValue.Len() { return errors.New("parameters and strategy should have the same length") @@ -634,6 +624,22 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { ) } } + case reflect.String: + if len(rawValue.String()) == 0 { + cfg.ParametersSetting.Strategy = strategySequential + } else { + cfg.ParametersSetting.Strategy = strings.ToLower(rawValue.String()) + } + cfg.ParametersSetting.Iterator = append( + cfg.ParametersSetting.Iterator, + newIterator(genCartesianProduct(parameters), cfg.ParametersSetting.Strategy.(string), cfg.ParametersSetting.Iteration), + ) + default: + cfg.ParametersSetting.Strategy = strategySequential + cfg.ParametersSetting.Iterator = append( + cfg.ParametersSetting.Iterator, + newIterator(genCartesianProduct(parameters), cfg.ParametersSetting.Strategy.(string), cfg.ParametersSetting.Iteration), + ) } return nil } From b61b396acc49e38c230d93b533e99da4fd9ea674 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 21:14:33 +0800 Subject: [PATCH 40/53] feat: data-driven. --- models.go | 1 + 1 file changed, 1 insertion(+) diff --git a/models.go b/models.go index 839234e8..cc55d77a 100644 --- a/models.go +++ b/models.go @@ -69,6 +69,7 @@ func (iter *Iterator) Next() (value map[string]interface{}) { iter.Lock() defer iter.Unlock() if len(iter.data) == 0 { + iter.index++ return map[string]interface{}{} } if iter.strategy == strategyRandom { From c0300a6e3aba662b6b28a0dfea237727d7b1f561 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 21:19:56 +0800 Subject: [PATCH 41/53] feat: data-driven. --- parser_test.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/parser_test.go b/parser_test.go index b66c5f79..f64ef7fc 100644 --- a/parser_test.go +++ b/parser_test.go @@ -652,7 +652,8 @@ func TestParseParameters(t *testing.T) { }, } for _, data := range testData { - value, _ := parseParameters(data.rawVars, map[string]interface{}{}) + params, _ := parseParameters(data.rawVars, map[string]interface{}{}) + value := genCartesianProduct(params) if !assert.Len(t, value, data.expectLength) { t.Fail() } From 481e87f0c58a622edcca376a88956d40d497fa01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 21:38:58 +0800 Subject: [PATCH 42/53] feat: data-driven. --- examples/parameters_test.yaml | 3 +-- parser.go | 19 +++++++++++-------- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/examples/parameters_test.yaml b/examples/parameters_test.yaml index 0eff1384..0f3d8c9d 100644 --- a/examples/parameters_test.yaml +++ b/examples/parameters_test.yaml @@ -4,8 +4,7 @@ config: user_agent: [ "iOS/10.1", "iOS/10.2" ] username-password: ${parameterize(examples/account.csv)} parameters_setting: - strategy: "" - iteration: 10 + strategy: ["random", "sequential"] variables: app_version: v1 user_agent: iOS/10.3 diff --git a/parser.go b/parser.go index 0d5c70e6..7180b3f8 100644 --- a/parser.go +++ b/parser.go @@ -614,6 +614,7 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { rawValue := reflect.ValueOf(cfg.ParametersSetting.Strategy) switch rawValue.Kind() { case reflect.Slice: + // strategy: ["random", "sequential"] if len(parameters) != rawValue.Len() { return errors.New("parameters and strategy should have the same length") } else { @@ -625,6 +626,7 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { } } case reflect.String: + // strategy: "random" if len(rawValue.String()) == 0 { cfg.ParametersSetting.Strategy = strategySequential } else { @@ -635,6 +637,7 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { newIterator(genCartesianProduct(parameters), cfg.ParametersSetting.Strategy.(string), cfg.ParametersSetting.Iteration), ) default: + // default strategy: sequential cfg.ParametersSetting.Strategy = strategySequential cfg.ParametersSetting.Iterator = append( cfg.ParametersSetting.Iterator, @@ -645,14 +648,14 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { } func newIterator(parameters paramsType, strategy string, iteration int) *Iterator { - it := parameters.Iterator() - it.strategy = strategy + iter := parameters.Iterator() + iter.strategy = strategy if iteration > 0 { - it.iteration = iteration - } else if it.iteration == 0 { - it.iteration = 1 - } else { - it.iteration = -1 + iter.iteration = iteration + } else if iteration < 0 { + iter.iteration = -1 + } else if iter.iteration == 0 { + iter.iteration = 1 } - return it + return iter } From 185c891c3f104fc5d2d18c6dd3ffc92aee9d053f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 21:39:34 +0800 Subject: [PATCH 43/53] feat: data-driven. --- examples/parameters_test.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/examples/parameters_test.yaml b/examples/parameters_test.yaml index 0f3d8c9d..412acaab 100644 --- a/examples/parameters_test.yaml +++ b/examples/parameters_test.yaml @@ -5,6 +5,7 @@ config: username-password: ${parameterize(examples/account.csv)} parameters_setting: strategy: ["random", "sequential"] + iteration: 10 variables: app_version: v1 user_agent: iOS/10.3 From 659b6021223b1ad8e8b0af91b0bff3333bfa4778 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Tue, 4 Jan 2022 22:00:47 +0800 Subject: [PATCH 44/53] feat: data-driven. --- boomer.go | 3 ++- models.go | 2 +- parser.go | 21 +++++++++++---------- runner.go | 5 +++-- 4 files changed, 17 insertions(+), 14 deletions(-) diff --git a/boomer.go b/boomer.go index eae914ea..5163fce5 100644 --- a/boomer.go +++ b/boomer.go @@ -76,7 +76,8 @@ func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { if err := copier.Copy(caseConfig, cfg); err != nil { log.Error().Err(err).Msg("copy config data failed") } - for _, it := range cfg.ParametersSetting.Iterator { + // iterate through all parameter iterators and update case variables + for _, it := range cfg.ParametersSetting.Iterators { if it.HasNext() { caseConfig.Variables = mergeVariables(it.Next(), caseConfig.Variables) } diff --git a/models.go b/models.go index cc55d77a..b7c7b915 100644 --- a/models.go +++ b/models.go @@ -32,7 +32,7 @@ type TConfig struct { type TParamsConfig struct { Strategy interface{} `json:"strategy,omitempty" yaml:"strategy,omitempty"` Iteration int `json:"iteration,omitempty" yaml:"iteration,omitempty"` - Iterator []*Iterator `json:"parameterIterator,omitempty" yaml:"parameterIterator,omitempty"` + Iterators []*Iterator `json:"parameterIterator,omitempty" yaml:"parameterIterator,omitempty"` //保存参数的迭代器 } const ( diff --git a/parser.go b/parser.go index 7180b3f8..f56bf973 100644 --- a/parser.go +++ b/parser.go @@ -606,41 +606,42 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { } // parse config parameters setting if cfg.ParametersSetting == nil { - cfg.ParametersSetting = &TParamsConfig{Iterator: []*Iterator{}} + cfg.ParametersSetting = &TParamsConfig{Iterators: []*Iterator{}} } + // boomer模式下不限制迭代次数 if mode == "boomer" { cfg.ParametersSetting.Iteration = -1 } rawValue := reflect.ValueOf(cfg.ParametersSetting.Strategy) switch rawValue.Kind() { case reflect.Slice: - // strategy: ["random", "sequential"] + // strategy: ["random", "sequential"], 每个参数对应一个迭代器，每个迭代器随机、顺序选取元素互不影响 if len(parameters) != rawValue.Len() { return errors.New("parameters and strategy should have the same length") } else { for i := 0; i < rawValue.Len(); i++ { - cfg.ParametersSetting.Iterator = append( - cfg.ParametersSetting.Iterator, + cfg.ParametersSetting.Iterators = append( + cfg.ParametersSetting.Iterators, newIterator(parameters[i], rawValue.Index(i).Interface().(string), cfg.ParametersSetting.Iteration), ) } } case reflect.String: - // strategy: "random" + // strategy: random, 仅生成一个的迭代器，该迭代器在参数笛卡尔积slice中随机选取元素 if len(rawValue.String()) == 0 { cfg.ParametersSetting.Strategy = strategySequential } else { cfg.ParametersSetting.Strategy = strings.ToLower(rawValue.String()) } - cfg.ParametersSetting.Iterator = append( - cfg.ParametersSetting.Iterator, + cfg.ParametersSetting.Iterators = append( + cfg.ParametersSetting.Iterators, newIterator(genCartesianProduct(parameters), cfg.ParametersSetting.Strategy.(string), cfg.ParametersSetting.Iteration), ) default: - // default strategy: sequential + // default strategy: sequential, 仅生成一个的迭代器，该迭代器在参数笛卡尔积slice中顺序选取元素 cfg.ParametersSetting.Strategy = strategySequential - cfg.ParametersSetting.Iterator = append( - cfg.ParametersSetting.Iterator, + cfg.ParametersSetting.Iterators = append( + cfg.ParametersSetting.Iterators, newIterator(genCartesianProduct(parameters), cfg.ParametersSetting.Strategy.(string), cfg.ParametersSetting.Iteration), ) } diff --git a/runner.go b/runner.go index d8f7543d..07c32789 100644 --- a/runner.go +++ b/runner.go @@ -143,8 +143,9 @@ func (r *caseRunner) run() error { } cfg := config.ToStruct() log.Info().Str("testcase", config.Name()).Msg("run testcase start") - for it := cfg.ParametersSetting.Iterator[0]; it.HasNext(); { - for _, it = range cfg.ParametersSetting.Iterator { + for it := cfg.ParametersSetting.Iterators[0]; it.HasNext(); { + // iterate through all parameter iterators and update case variables + for _, it = range cfg.ParametersSetting.Iterators { if it.HasNext() { cfg.Variables = mergeVariables(it.Next(), cfg.Variables) } From 5a153f7ff9c360f1dd0134c9ed58e5600c55bee0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 5 Jan 2022 11:35:37 +0800 Subject: [PATCH 45/53] feat: data-driven. --- boomer.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/boomer.go b/boomer.go index 5163fce5..9b07d098 100644 --- a/boomer.go +++ b/boomer.go @@ -77,7 +77,7 @@ func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { log.Error().Err(err).Msg("copy config data failed") } // iterate through all parameter iterators and update case variables - for _, it := range cfg.ParametersSetting.Iterators { + for _, it := range caseConfig.ParametersSetting.Iterators { if it.HasNext() { caseConfig.Variables = mergeVariables(it.Next(), caseConfig.Variables) } From c3477bdcc3d341e417bde76c0b0f56bd305c29f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 5 Jan 2022 11:46:30 +0800 Subject: [PATCH 46/53] feat: data-driven. --- runner.go | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/runner.go b/runner.go index 07c32789..c321b855 100644 --- a/runner.go +++ b/runner.go @@ -98,9 +98,19 @@ func (r *hrpRunner) Run(testcases ...ITestCase) error { log.Error().Err(err).Msg("[Run] convert ITestCase interface to TestCase struct failed") return err } - if err := r.newCaseRunner(testcase).run(); err != nil { - log.Error().Err(err).Msg("[Run] run testcase failed") - return err + cfg := testcase.Config.ToStruct() + for it := cfg.ParametersSetting.Iterators[0]; it.HasNext(); { + // iterate through all parameter iterators and update case variables + // iterate through all parameter iterators and update case variables + for _, it := range cfg.ParametersSetting.Iterators { + if it.HasNext() { + cfg.Variables = mergeVariables(it.Next(), cfg.Variables) + } + } + if err := r.newCaseRunner(testcase).run(); err != nil { + log.Error().Err(err).Msg("[Run] run testcase failed") + return err + } } } return nil @@ -143,20 +153,13 @@ func (r *caseRunner) run() error { } cfg := config.ToStruct() log.Info().Str("testcase", config.Name()).Msg("run testcase start") - for it := cfg.ParametersSetting.Iterators[0]; it.HasNext(); { - // iterate through all parameter iterators and update case variables - for _, it = range cfg.ParametersSetting.Iterators { - if it.HasNext() { - cfg.Variables = mergeVariables(it.Next(), cfg.Variables) - } - } - r.startTime = time.Now() - for index := range r.TestCase.TestSteps { - _, err := r.runStep(index, cfg) - if err != nil { - if r.hrpRunner.failfast { - return errors.Wrap(err, "abort running due to failfast setting") - } + + r.startTime = time.Now() + for index := range r.TestCase.TestSteps { + _, err := r.runStep(index, cfg) + if err != nil { + if r.hrpRunner.failfast { + return errors.Wrap(err, "abort running due to failfast setting") } } } From ca43c74cadf4dec4bfe8845b188121cd4a8356df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 5 Jan 2022 11:53:14 +0800 Subject: [PATCH 47/53] feat: data-driven. --- runner.go | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/runner.go b/runner.go index c321b855..ba3dd953 100644 --- a/runner.go +++ b/runner.go @@ -99,6 +99,12 @@ func (r *hrpRunner) Run(testcases ...ITestCase) error { return err } cfg := testcase.Config.ToStruct() + // parse config parameters + err = initParameterIterator(cfg, "runner") + if err != nil { + log.Error().Interface("parameters", cfg.Parameters).Err(err).Msg("parse config parameters failed") + return err + } for it := cfg.ParametersSetting.Iterators[0]; it.HasNext(); { // iterate through all parameter iterators and update case variables // iterate through all parameter iterators and update case variables @@ -488,12 +494,6 @@ func (r *caseRunner) parseConfig(config IConfig) error { return err } cfg.Variables = parsedVariables - // parse config parameters - err = initParameterIterator(cfg, "runner") - if err != nil { - log.Error().Interface("parameters", cfg.Parameters).Err(err).Msg("parse config parameters failed") - return err - } // parse config name parsedName, err := parseString(cfg.Name, cfg.Variables) if err != nil { From 698aea30829dc1e51c28adf4b601d68878aac2ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 5 Jan 2022 14:54:07 +0800 Subject: [PATCH 48/53] add each parameter selection strategy. --- examples/parameters_test.json | 8 ++++---- examples/parameters_test.yaml | 4 +++- parser.go | 23 ++++++++++++++--------- 3 files changed, 21 insertions(+), 14 deletions(-) diff --git a/examples/parameters_test.json b/examples/parameters_test.json index 61bc5ead..a2cb957c 100644 --- a/examples/parameters_test.json +++ b/examples/parameters_test.json @@ -9,10 +9,10 @@ "username-password": "${parameterize(examples/account.csv)}" }, "parameters_setting": { - "strategy": [ - "random", - "sequential" - ], + "strategy": { + "user_agent": "sequential", + "username-password": "random" + }, "iteration": 10 }, "variables": { diff --git a/examples/parameters_test.yaml b/examples/parameters_test.yaml index 412acaab..d15d6f18 100644 --- a/examples/parameters_test.yaml +++ b/examples/parameters_test.yaml @@ -4,7 +4,9 @@ config: user_agent: [ "iOS/10.1", "iOS/10.2" ] username-password: ${parameterize(examples/account.csv)} parameters_setting: - strategy: ["random", "sequential"] + strategy: + user_agent: "sequential" + username-password: "random" iteration: 10 variables: app_version: v1 diff --git a/parser.go b/parser.go index f56bf973..cf138389 100644 --- a/parser.go +++ b/parser.go @@ -494,10 +494,14 @@ func findallVariables(raw string) variableSet { return varSet } -func genCartesianProduct(params []paramsType) paramsType { - if len(params) == 0 { +func genCartesianProduct(paramsMap map[string]paramsType) paramsType { + if len(paramsMap) == 0 { return nil } + var params []paramsType + for _, v := range paramsMap { + params = append(params, v) + } var cartesianProduct paramsType cartesianProduct = params[0] for i := 0; i < len(params)-1; i++ { @@ -512,11 +516,11 @@ func genCartesianProduct(params []paramsType) paramsType { return cartesianProduct } -func parseParameters(parameters map[string]interface{}, variablesMapping map[string]interface{}) ([]paramsType, error) { +func parseParameters(parameters map[string]interface{}, variablesMapping map[string]interface{}) (map[string]paramsType, error) { if len(parameters) == 0 { return nil, nil } - var parsedParametersSlice []paramsType + parsedParametersSlice := make(map[string]paramsType) var err error for k, v := range parameters { var parameterSlice paramsType @@ -546,7 +550,7 @@ func parseParameters(parameters map[string]interface{}, variablesMapping map[str if err != nil { return nil, err } - parsedParametersSlice = append(parsedParametersSlice, parameterSlice) + parsedParametersSlice[k] = parameterSlice } return parsedParametersSlice, nil } @@ -599,7 +603,7 @@ func parseSlice(parameterName string, parameterContent interface{}) ([]map[strin } func initParameterIterator(cfg *TConfig, mode string) (err error) { - var parameters []paramsType + var parameters map[string]paramsType parameters, err = parseParameters(cfg.Parameters, cfg.Variables) if err != nil { return err @@ -614,15 +618,16 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { } rawValue := reflect.ValueOf(cfg.ParametersSetting.Strategy) switch rawValue.Kind() { - case reflect.Slice: + case reflect.Map: // strategy: ["random", "sequential"], 每个参数对应一个迭代器，每个迭代器随机、顺序选取元素互不影响 if len(parameters) != rawValue.Len() { return errors.New("parameters and strategy should have the same length") } else { - for i := 0; i < rawValue.Len(); i++ { + for _, k := range rawValue.MapKeys() { + key := k.Convert(rawValue.Type().Key()) cfg.ParametersSetting.Iterators = append( cfg.ParametersSetting.Iterators, - newIterator(parameters[i], rawValue.Index(i).Interface().(string), cfg.ParametersSetting.Iteration), + newIterator(parameters[k.Interface().(string)], rawValue.MapIndex(key).String(), cfg.ParametersSetting.Iteration), ) } } From 406aab1dd8dcb6c764c1924cf0d2b0c66f7ef6cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 5 Jan 2022 15:12:18 +0800 Subject: [PATCH 49/53] add each parameter selection strategy. --- parser.go | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/parser.go b/parser.go index cf138389..ef10fab9 100644 --- a/parser.go +++ b/parser.go @@ -619,15 +619,19 @@ func initParameterIterator(cfg *TConfig, mode string) (err error) { rawValue := reflect.ValueOf(cfg.ParametersSetting.Strategy) switch rawValue.Kind() { case reflect.Map: - // strategy: ["random", "sequential"], 每个参数对应一个迭代器，每个迭代器随机、顺序选取元素互不影响 - if len(parameters) != rawValue.Len() { - return errors.New("parameters and strategy should have the same length") - } else { - for _, k := range rawValue.MapKeys() { - key := k.Convert(rawValue.Type().Key()) + // strategy: {"user_agent": "sequential", "username-password": "random"}, 每个参数对应一个迭代器，每个迭代器随机、顺序选取元素互不影响 + for k, v := range parameters { + if _, ok := rawValue.Interface().(map[string]interface{})[k]; ok { + // use strategy if configured cfg.ParametersSetting.Iterators = append( cfg.ParametersSetting.Iterators, - newIterator(parameters[k.Interface().(string)], rawValue.MapIndex(key).String(), cfg.ParametersSetting.Iteration), + newIterator(v, rawValue.MapIndex(reflect.ValueOf(k)).Interface().(string), cfg.ParametersSetting.Iteration), + ) + } else { + // use sequential strategy by default + cfg.ParametersSetting.Iterators = append( + cfg.ParametersSetting.Iterators, + newIterator(v, strategySequential, cfg.ParametersSetting.Iteration), ) } } From a315884b628cdeb7e9e2d87cd539b3d35916f260 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 5 Jan 2022 15:49:49 +0800 Subject: [PATCH 50/53] add each parameter selection strategy. --- boomer.go | 1 - runner.go | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/boomer.go b/boomer.go index 9b07d098..0976d134 100644 --- a/boomer.go +++ b/boomer.go @@ -4,7 +4,6 @@ import ( "time" "github.com/jinzhu/copier" - "github.com/rs/zerolog/log" "github.com/httprunner/hrp/internal/boomer" diff --git a/runner.go b/runner.go index ba3dd953..8faf84ef 100644 --- a/runner.go +++ b/runner.go @@ -105,8 +105,8 @@ func (r *hrpRunner) Run(testcases ...ITestCase) error { log.Error().Interface("parameters", cfg.Parameters).Err(err).Msg("parse config parameters failed") return err } + // 在runner模式下，指定整体策略，cfg.ParametersSetting.Iterators仅包含一个CartesianProduct的迭代器 for it := cfg.ParametersSetting.Iterators[0]; it.HasNext(); { - // iterate through all parameter iterators and update case variables // iterate through all parameter iterators and update case variables for _, it := range cfg.ParametersSetting.Iterators { if it.HasNext() { From abfea42a8f03300584f2cadcd467a41f52de8e48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=90=E8=81=AA?= Date: Wed, 5 Jan 2022 16:20:25 +0800 Subject: [PATCH 51/53] add each parameter selection strategy. --- examples/parameters_test.json | 2 +- examples/parameters_test.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/parameters_test.json b/examples/parameters_test.json index a2cb957c..1a555593 100644 --- a/examples/parameters_test.json +++ b/examples/parameters_test.json @@ -13,7 +13,7 @@ "user_agent": "sequential", "username-password": "random" }, - "iteration": 10 + "iteration": 6 }, "variables": { "app_version": "v1", diff --git a/examples/parameters_test.yaml b/examples/parameters_test.yaml index d15d6f18..e2cabc91 100644 --- a/examples/parameters_test.yaml +++ b/examples/parameters_test.yaml @@ -7,7 +7,7 @@ config: strategy: user_agent: "sequential" username-password: "random" - iteration: 10 + iteration: 6 variables: app_version: v1 user_agent: iOS/10.3 From 98a1db8daae682ff1968fde2e15526a98bc5c7b1 Mon Sep 17 00:00:00 2001 From: debugtalk Date: Wed, 5 Jan 2022 21:39:09 +0800 Subject: [PATCH 52/53] fix: change variable name --- internal/boomer/stats.go | 6 +++--- internal/boomer/stats_test.go | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/internal/boomer/stats.go b/internal/boomer/stats.go index 24141005..53b4f707 100644 --- a/internal/boomer/stats.go +++ b/internal/boomer/stats.go @@ -86,7 +86,7 @@ func (s *requestStats) logError(method, name, err string) { entry = &statsError{ name: name, method: method, - error: err, + errMsg: err, } s.errors[key] = entry } @@ -296,7 +296,7 @@ func (s *statsEntry) getStrippedReport() map[string]interface{} { type statsError struct { name string method string - error string + errMsg string occurrences int64 } @@ -308,7 +308,7 @@ func (err *statsError) toMap() map[string]interface{} { m := make(map[string]interface{}) m["method"] = err.method m["name"] = err.name - m["error"] = err.error + m["error"] = err.errMsg m["occurrences"] = err.occurrences return m } diff --git a/internal/boomer/stats_test.go b/internal/boomer/stats_test.go index 666a9636..afe0b41e 100644 --- a/internal/boomer/stats_test.go +++ b/internal/boomer/stats_test.go @@ -95,8 +95,8 @@ func TestLogError(t *testing.T) { // md5("httpfailure500 error") = 547c38e4e4742c1c581f9e2809ba4f55 err500 := newStats.errors["547c38e4e4742c1c581f9e2809ba4f55"] - if err500.error != "500 error" { - t.Error("Error message is wrong, expected: 500 error, got:", err500.error) + if err500.errMsg != "500 error" { + t.Error("Error message is wrong, expected: 500 error, got:", err500.errMsg) } if err500.occurrences != 1 { t.Error("Error occurrences is wrong, expected: 1, got:", err500.occurrences) @@ -104,8 +104,8 @@ func TestLogError(t *testing.T) { // md5("httpfailure400 error") = f391c310401ad8e10e929f2ee1a614e4 err400 := newStats.errors["f391c310401ad8e10e929f2ee1a614e4"] - if err400.error != "400 error" { - t.Error("Error message is wrong, expected: 400 error, got:", err400.error) + if err400.errMsg != "400 error" { + t.Error("Error message is wrong, expected: 400 error, got:", err400.errMsg) } if err400.occurrences != 2 { t.Error("Error occurrences is wrong, expected: 2, got:", err400.occurrences) From d984bac431d392cdc4a9e98cc09f70df61e44692 Mon Sep 17 00:00:00 2001 From: debugtalk Date: Wed, 5 Jan 2022 22:32:54 +0800 Subject: [PATCH 53/53] change: update docs --- docs/BUILTIN.md | 77 +++++++++++++++++++++++++++---------------------- docs/README.md | 4 +-- 2 files changed, 45 insertions(+), 36 deletions(-) diff --git a/docs/BUILTIN.md b/docs/BUILTIN.md index e90b0a04..19c6bff5 100644 --- a/docs/BUILTIN.md +++ b/docs/BUILTIN.md @@ -1,44 +1,53 @@ # Builtin -## Assertion Methods +## Builtin assertions -### Usage -In "teststeps" of each json/yaml testcase, the "validate" part contains four fields: "check", "assert", "expect" and -"msg", when using assertion methods, method name should be put in "assert" field. The assertion result of "check" -element will be checked out using the regulation you put in "assert" field and compared with the element in "expect" -field. +HttpRunner+ validation should follow the following format. `check`, `assert` and `expect` are required field. -### Method List +```json +{ + "check": "status_code", // target field, usually used with jmespath + "assert": "equals", // assertion method, you can use builtin method or custom defined function + "expect": 200, // expected value + "msg": "check response status code" // optional, print this message if assertion failed +} +``` -- equals: assert the element to check equals the expected element. -- equal: alias for equals. -- greater_than: assert the element to check is greater than the expected element. -- less_than: assert the element to check is less than the expected element. -- greater_or_equals: assert the element to check is greater than or equal with the expected element. -- less_or_equals: assert the element to check is less than or equal with the expected element. -- not_equal: assert the element to check is not equal with the expected element. -- contained_by: assert the expected element contains the element to check. -- regex_match: assert the element to check matches the expected element using regex. -- type_match: assert the element to check matches the expected element in type. -- startswith: assert the element to check starts with the expected element. -- endswith: assert the element to check ends with the expected element. -- length_equals: assert the length of the element to check is equal with the expected element. -- length_equal: alias for length_equals. -- contains: assert the element to check contains the expected element. -- string_equals: assert the string is equal with the expected string. +The `assert` method name will be mapped to a built-in function with the following function signature. -## Common Functions +```go +func(t assert.TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool +``` -### Usage -The common functions are useful during the variables configuration, you can use "${FUNCTION_NAME}" to call the specific -function to define variables. - -### Function List -- get_timestamp: get the thirteen-digit timestamp of current time. (call without argument) -- sleep: sleep n seconds to simulate the thinking time. (call with one argument n) -- gen_random_string: get the n-digit random string. (call with one argument n) -- max: get the maximum of two numbers m and n. (call with two argument m and n) -- md5: get the MD5 of the input string s. (call with one argument s) +Currently, HttpRunner+ has the following built-in assertion functions. +| `assert` | Description | A(check), B(expect) | examples | +| -- | -- | -- | -- | +| `eq`, `equals`, `equal` | value is equal | A == B | 9 eq 9 | +| `lt`, `less_than` | less than | A < B | 7 lt 8 | +| `le`, `less_or_equals` | less than or equals | A <= B | 7 le 8, 8 le 8 | +| `gt`, `greater_than` | greater than | A > B | 8 gt 7 | +| `ge`, `greater_or_equals` | greater than or equals | A >= B | 8 ge 7, 8 ge 8 | +| `ne`, `not_equal` | not equals | A != B | 6 ne 9 | +| `str_eq`, `string_equals` | string equals | str(A) == str(B) | 123 str_eq '123' | +| `len_eq`, `length_equals`, `length_equal` | length equals | len(A) == B | 'abc' len_eq 3, [1,2] len_eq 2 | +| `len_gt`, `count_gt` | length greater than | len(A) > B | 'abc' len_gt 2, [1,2,3] len_gt 2 | +| `len_ge`, `count_ge` | length greater than or equals | len(A) >= B | 'abc' len_ge 3, [1,2,3] len_gt 3 | +| `len_lt`, `count_lt` | length less than | len(A) < B | 'abc' len_lt 4, [1,2,3] len_lt 4 | +| `len_le`, `count_le` | length less than or equals | len(A) <= B | 'abc' len_le 3, [1,2,3] len_le 3 | +| `contains` | contains | [1, 2] contains 1 | 'abc' contains 'a', [1,2,3] len_lt 4 | +| `contained_by` | contained by | A in B | 'a' contained_by 'abc', 1 contained_by [1,2] | +| `type_match` | A and B are in the same type | type(A) == type(B) | 123 type_match 1 | +| `regex_match` | regex matches | re.match(B, A) | 'abcdef' regex 'a\w+d' | +| `startswith` | starts with | A.startswith(B) is True | 'abc' startswith 'ab' | +| `endswith` | ends with | A.endswith(B) is True | 'abc' endswith 'bc' | +## Builtin functions +| Name | Arguments | Description | +| --- | --- | --- | +| `get_timestamp` | () | get the thirteen-digit timestamp of current time. | +| `sleep` | (n int) | sleep n seconds to simulate the thinking time. | +| `gen_random_string` | (n int) | get the n-digit random string. | +| `max` | (m,n int) | get the maximum of two numbers m and n. | +| `md5` | (s string) | get the MD5 of the input string s. | diff --git a/docs/README.md b/docs/README.md index d244ed92..d2dfb861 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ - Homepage: https://httprunner.com - Docs - - English: https://httprunner.com/docs - - 中文: https://httprunner.com/zh/docs + - 中文: https://httprunner.com/docs + - English: https://httprunner.com/en/docs - [hrp command help](cmd/hrp.md) - Blog: https://httprunner.com/blog