fix: executors documentation and remove timeHuman everywhere

Signed-off-by: francois samin <francois.samin@corp.ovh.com>
ovh · Nov 20, 2020 · 410851d · 410851d
1 parent db93a36
commit 410851d
Show file tree

Hide file tree

Showing 18 changed files with 13 additions and 46 deletions.
diff --git a/executors/exec/README.md b/executors/exec/README.md
@@ -35,21 +35,22 @@ testcases:
 ## Output
 
 ```yaml
-executor
 systemout
+systemoutjson
 systemerr
+systemerrjson
 err
 code
 timeseconds
-timehuman
 ```
 
-- result.timeseconds & result.timehuman: time of execution
-- result.executor.executor.script: script executed
+- result.timeseconds: time of execution
 - result.err: if exists, this field contains error
 - result.systemout: Standard Output of executed script
-- result.systemerr: Error Output of executed script
-- result.code: Exit Code
+- result.systemoutjson: Standard Output of executed script parsed as a JSON object
+- result.systemerr: Error output of executed script
+- result.systemerrjson: Error output of executed script parsed as a JSON object
+- result.code: Exit code
 
 ## Default assertion
 

diff --git a/executors/exec/exec.go b/executors/exec/exec.go
@@ -42,7 +42,6 @@ type Result struct {
 	Err           string      `json:"err,omitempty" yaml:"err,omitempty"`
 	Code          string      `json:"code,omitempty" yaml:"code,omitempty"`
 	TimeSeconds   float64     `json:"timeseconds,omitempty" yaml:"timeseconds,omitempty"`
-	TimeHuman     string      `json:"timehuman,omitempty" yaml:"timehuman,omitempty"`
 }
 
 // ZeroValueResult return an empty implemtation of this executor result
@@ -201,7 +200,6 @@ func (Executor) Run(ctx context.Context, step venom.TestStep, workdir string) (i
 
 	elapsed := time.Since(start)
 	result.TimeSeconds = elapsed.Seconds()
-	result.TimeHuman = elapsed.String()
 
 	result.Systemout = venom.RemoveNotPrintableChar(strings.TrimRight(result.Systemout, "\n"))
 	result.Systemerr = venom.RemoveNotPrintableChar(strings.TrimRight(result.Systemerr, "\n"))

diff --git a/executors/grpc/README.md b/executors/grpc/README.md
@@ -62,10 +62,9 @@ systemerr
 err
 code
 timeseconds
-timehuman
 ```
 
-- result.timeseconds & result.timehuman: time of execution
+- result.timeseconds: execution duration
 - result.executor.executor.script: script executed
 - result.err: if exists, this field contains error
 - result.systemout: Standard Output of executed script

diff --git a/executors/grpc/grpc.go b/executors/grpc/grpc.go
@@ -52,7 +52,6 @@ type Result struct {
 	Err           string      `json:"err,omitempty" yaml:"err,omitempty"`
 	Code          string      `json:"code,omitempty" yaml:"code,omitempty"`
 	TimeSeconds   float64     `json:"timeseconds,omitempty" yaml:"timeseconds,omitempty"`
-	TimeHuman     string      `json:"timehuman,omitempty" yaml:"timehuman,omitempty"`
 }
 
 type customHandler struct {
@@ -189,7 +188,6 @@ func (Executor) Run(ctx context.Context, step venom.TestStep, workdir string) (i
 
 	elapsed := time.Since(start)
 	result.TimeSeconds = elapsed.Seconds()
-	result.TimeHuman = elapsed.String()
 
 	if handle.err != nil {
 		result.Err = handle.err.Error()

diff --git a/executors/http/README.md b/executors/http/README.md
@@ -92,14 +92,13 @@ testcases:
 ```
 result.request
 result.timeseconds
-result.timehuman
 result.statuscode
 result.body
 result.bodyjson
 result.headers
 result.err
 ```
-- result.timeseconds & result.timehuman: time of execution
+- result.timeseconds: execution duration
 - result.request.method: HTTP method of the request
 - result.request.url: HTTP URL of the request
 - result.request.body: body content as string

diff --git a/executors/http/http.go b/executors/http/http.go
@@ -54,7 +54,6 @@ type Executor struct {
 // Result represents a step result. Json and yaml descriptor are used for json output
 type Result struct {
 	TimeSeconds float64     `json:"timeseconds,omitempty" yaml:"timeseconds,omitempty"`
-	TimeHuman   string      `json:"timehuman,omitempty" yaml:"timehuman,omitempty"`
 	StatusCode  int         `json:"statuscode,omitempty" yaml:"statuscode,omitempty"`
 	Request     HTTPRequest `json:"request,omitempty" yaml:"request,omitempty"`
 	Body        string      `json:"body,omitempty" yaml:"body,omitempty"`
@@ -161,7 +160,6 @@ func (Executor) Run(ctx context.Context, step venom.TestStep, workdir string) (i
 	}
 	elapsed := time.Since(start)
 	r.TimeSeconds = elapsed.Seconds()
-	r.TimeHuman = elapsed.String()
 
 	var bb []byte
 	if resp.Body != nil {

diff --git a/executors/imap/imap.go b/executors/imap/imap.go
@@ -55,7 +55,6 @@ type Result struct {
 	Subject     string  `json:"subject,omitempty" yaml:"subject,omitempty"`
 	Body        string  `json:"body,omitempty" yaml:"body,omitempty"`
 	TimeSeconds float64 `json:"timeSeconds,omitempty" yaml:"timeSeconds,omitempty"`
-	TimeHuman   string  `json:"timeHuman,omitempty" yaml:"timeHuman,omitempty"`
 }
 
 // ZeroValueResult return an empty implemtation of this executor result
@@ -91,7 +90,6 @@ func (Executor) Run(ctx context.Context, step venom.TestStep, workdir string) (i
 
 	elapsed := time.Since(start)
 	result.TimeSeconds = elapsed.Seconds()
-	result.TimeHuman = elapsed.String()
 
 	return result, nil
 }

diff --git a/executors/kafka/kafka.go b/executors/kafka/kafka.go
@@ -29,10 +29,8 @@ func New() venom.Executor {
 	return &Executor{}
 }
 
-
-
 type (
-  // Message represents the object sended or received from kafka
+	// Message represents the object sended or received from kafka
 	Message struct {
 		Topic          string `json:"topic" yaml:"topic"`
 		Key            string `json:"key" yaml:"key"`
@@ -94,7 +92,6 @@ type (
 	// Result represents a step result.
 	Result struct {
 		TimeSeconds  float64       `json:"timeSeconds,omitempty" yaml:"timeSeconds,omitempty"`
-		TimeHuman    string        `json:"timeHuman,omitempty" yaml:"timeHuman,omitempty"`
 		Messages     []Message     `json:"messages,omitempty" yaml:"messages,omitempty"`
 		MessagesJSON []interface{} `json:"messagesJSON,omitempty" yaml:"messagesJSON,omitempty"`
 		Err          string        `json:"error" yaml:"error"`
@@ -150,7 +147,6 @@ func (Executor) Run(ctx context.Context, step venom.TestStep, workdir string) (i
 
 	elapsed := time.Since(start)
 	result.TimeSeconds = elapsed.Seconds()
-	result.TimeHuman = elapsed.String()
 
 	return result, nil
 }

diff --git a/executors/ovhapi/README.md b/executors/ovhapi/README.md
@@ -50,13 +50,12 @@ testcases:
 ```
 result.executor
 result.timeseconds
-result.timehuman
 result.statuscode
 result.body
 result.bodyjson
 result.error
 ```
-- result.timeseconds & result.timehuman: time of execution
+- result.timeseconds: execution duration
 - result.err: if exists, this field contains error
 - result.body: body of HTTP response
 - result.bodyjson: body of HTTP response if it's a json. You can access json data as result.bodyjson.yourkey for example

diff --git a/executors/ovhapi/ovhapi.go b/executors/ovhapi/ovhapi.go
@@ -41,7 +41,6 @@ type Executor struct {
 // Result represents a step result. Json and yaml descriptor are used for json output
 type Result struct {
 	TimeSeconds float64     `json:"timeseconds,omitempty" yaml:"timeseconds,omitempty"`
-	TimeHuman   string      `json:"timehuman,omitempty" yaml:"timehuman,omitempty"`
 	StatusCode  int         `json:"statuscode,omitempty" yaml:"statuscode,omitempty"`
 	Body        string      `json:"body,omitempty" yaml:"body,omitempty"`
 	BodyJSON    interface{} `json:"bodyjson,omitempty" yaml:"bodyjson,omitempty"`
@@ -148,7 +147,6 @@ func (Executor) Run(ctx context.Context, step venom.TestStep, workdir string) (i
 
 	elapsed := time.Since(start)
 	r.TimeSeconds = elapsed.Seconds()
-	r.TimeHuman = elapsed.String()
 
 	// Add response to result body
 	if res != nil {

diff --git a/executors/rabbitmq/rabbitmq.go b/executors/rabbitmq/rabbitmq.go
@@ -63,7 +63,6 @@ type Executor struct {
 // Result represents a step result.
 type Result struct {
 	TimeSeconds float64       `json:"timeSeconds" yaml:"timeSeconds"`
-	TimeHuman   string        `json:"timeHuman" yaml:"timeHuman"`
 	Body        []string      `json:"body" yaml:"body"`
 	Messages    []interface{} `json:"messages" yaml:"messages"`
 	BodyJSON    []interface{} `json:"bodyJSON" yaml:"bodyJSON"`
@@ -122,7 +121,6 @@ func (Executor) Run(ctx context.Context, step venom.TestStep, workdir string) (i
 
 	elapsed := time.Since(start)
 	result.TimeSeconds = elapsed.Seconds()
-	result.TimeHuman = elapsed.String()
 
 	return result, nil
 }

diff --git a/executors/readfile/README.md b/executors/readfile/README.md
@@ -32,8 +32,6 @@ testcases:
 
 ```yaml
   result.timeseconds
-  result.timehuman
-  result.executor.executor.path
   result.content
   result.contentjson
   result.size.filename
@@ -42,8 +40,7 @@ testcases:
   result.mod.filename
 ```
 
-- result.timeseconds & result.timehuman: time for read file
-- result.executor.path: executor condition with file path
+- result.timeseconds: execution duration
 - result.err: if exist, this field contains error
 - result.content: content of readed file
 - result.contentjson: content of readed file if it's a json. You can access json data as result.contentjson.yourkey for example

diff --git a/executors/readfile/readfile.go b/executors/readfile/readfile.go
@@ -37,7 +37,6 @@ type Result struct {
 	ContentJSON interface{}       `json:"contentjson,omitempty" yaml:"contentjson,omitempty"`
 	Err         string            `json:"error" yaml:"error"`
 	TimeSeconds float64           `json:"timeSeconds,omitempty" yaml:"timeSeconds,omitempty"`
-	TimeHuman   string            `json:"timeHuman,omitempty" yaml:"timeHuman,omitempty"`
 	Md5sum      map[string]string `json:"md5sum,omitempty" yaml:"md5sum,omitempty"`
 	Size        map[string]int64  `json:"size,omitempty" yaml:"size,omitempty"`
 	ModTime     map[string]int64  `json:"modtime,omitempty" yaml:"modtime,omitempty"`
@@ -80,7 +79,6 @@ func (Executor) Run(ctx context.Context, step venom.TestStep, workdir string) (i
 
 	elapsed := time.Since(start)
 	result.TimeSeconds = elapsed.Seconds()
-	result.TimeHuman = elapsed.String()
 
 	return result, nil
 }

diff --git a/executors/smtp/smtp.go b/executors/smtp/smtp.go
@@ -39,7 +39,6 @@ type Executor struct {
 type Result struct {
 	Err         string  `json:"error,omitempty" yaml:"error"`
 	TimeSeconds float64 `json:"timeSeconds,omitempty" yaml:"timeSeconds,omitempty"`
-	TimeHuman   string  `json:"timeHuman,omitempty" yaml:"timeHuman,omitempty"`
 }
 
 // ZeroValueResult return an empty implemtation of this executor result
@@ -70,7 +69,6 @@ func (Executor) Run(ctx context.Context, step venom.TestStep, workdir string) (i
 
 	elapsed := time.Since(start)
 	result.TimeSeconds = elapsed.Seconds()
-	result.TimeHuman = elapsed.String()
 
 	return result, nil
 }

diff --git a/executors/ssh/README.md b/executors/ssh/README.md
@@ -35,17 +35,14 @@ testcases:
 ## Output
 
 ```yaml
-executor
 systemout
 systemerr
 err
 code
 timeseconds
-timehuman
 ```
 
-- result.timeseconds & result.timehuman: time of execution
-- result.executor.executor.script: script executed
+- result.timeseconds: time of execution
 - result.err: if exists, this field contains error
 - result.systemout: Standard Output of executed script
 - result.systemerr: Error Output of executed script

diff --git a/executors/ssh/ssh.go b/executors/ssh/ssh.go
@@ -42,7 +42,6 @@ type Result struct {
 	Err         string  `json:"err,omitempty" yaml:"err,omitempty"`
 	Code        string  `json:"code,omitempty" yaml:"code,omitempty"`
 	TimeSeconds float64 `json:"timeseconds,omitempty" yaml:"timeseconds,omitempty"`
-	TimeHuman   string  `json:"timehuman,omitempty" yaml:"timehuman,omitempty"`
 }
 
 // ZeroValueResult return an empty implemtation of this executor result
@@ -100,7 +99,6 @@ func (Executor) Run(ctx context.Context, step venom.TestStep, workdir string) (i
 
 	elapsed := time.Since(start)
 	result.TimeSeconds = elapsed.Seconds()
-	result.TimeHuman = elapsed.String()
 
 	return result, nil
 }

diff --git a/executors/web/README.md b/executors/web/README.md
@@ -268,7 +268,6 @@ testcases:
 
 * result.url
 * result.timeseconds
-* result.timehuman
 * result.title
 * result.find
 

diff --git a/executors/web/web.go b/executors/web/web.go
@@ -46,7 +46,6 @@ type Result struct {
 	Find        int     `json:"find,omitempty" yaml:"find,omitempty"`
 	HTML        string  `json:"html,omitempty" yaml:"html,omitempty"`
 	TimeSeconds float64 `json:"timeseconds,omitempty" yaml:"timeseconds,omitempty"`
-	TimeHuman   string  `json:"timehuman,omitempty" yaml:"timehuman,omitempty"`
 	Title       string  `json:"title,omitempty" yaml:"title,omitempty"`
 	URL         string  `json:"url,omitempty" yaml:"url,omitempty"`
 	Text        string  `json:"text,omitempty" yaml:"text,omitempty"`
@@ -177,7 +176,6 @@ func (Executor) Run(ctx context.Context, step venom.TestStep, workdir string) (i
 
 	elapsed := time.Since(start)
 	result.TimeSeconds = elapsed.Seconds()
-	result.TimeHuman = elapsed.String()
 
 	return result, nil
 }