Merge pull request #151 from Mania-c/issues-147

issues-147: add description to tests

README.md

@@ -334,6 +334,7 @@ Also, "?" in query is optional
 You can use variables in the description of the test, the following fields are supported:
 
 - method
+- description
 - path
 - query
 - headers
@@ -349,6 +350,7 @@ Example:
 
 ```yaml
 - method: "{{ $method }}"
+  description: "{{ $description }}"
   path: "/some/path/{{ $pathPart }}"
   query: "{{ $query }}"
   headers:

models/test.go

@@ -19,6 +19,7 @@ type TestInterface interface {
 	GetResponse(code int) (string, bool)
 	GetResponseHeaders(code int) (map[string]string, bool)
 	GetName() string
+	GetDescription() string
 	GetStatus() string
 	SetStatus(string)
 	Fixtures() []string

output/allure_report/allure_report.go

@@ -33,7 +33,9 @@ func NewOutput(suiteName, reportLocation string) *AllureReportOutput {
 
 func (o *AllureReportOutput) Process(t models.TestInterface, result *models.Result) error {
 	testCase := o.allure.StartCase(t.GetName(), time.Now())
+	testCase.SetDescriptionOrDefaultValue(t.GetDescription(), "No description")
 	testCase.AddLabel("story", result.Path)
+
 	o.allure.AddAttachment(
 		*bytes.NewBufferString("Request"),
 		*bytes.NewBufferString(fmt.Sprintf(`Query: %s \n Body: %s`, result.Query, result.RequestBody)),

output/allure_report/beans/test.go

@@ -49,6 +49,14 @@ func (t *TestCase) SetDescription(desc string) {
 	t.Desc = desc
 }
 
+func (t *TestCase) SetDescriptionOrDefaultValue(desc string, defVal string) {
+	if desc == "" {
+		t.Desc = defVal
+	} else {
+		t.Desc = desc
+	}
+}
+
 func (t *TestCase) AddLabel(name, value string) {
 	t.addLabel(&Label{
 		Name:  name,

output/console_colored/console_colored.go

@@ -43,6 +43,8 @@ func (o *ConsoleColoredOutput) Process(t models.TestInterface, result *models.Re
 func renderResult(result *models.Result) (string, error) {
 	text := `
        Name: {{ green .Test.GetName }}
+       Description: 
+{{- if .Test.GetDescription }}{{ green .Test.GetDescription }}{{ else }}{{ green " No description" }}{{ end }}
        File: {{ green .Test.GetFileName }}
 
 Request:

output/testing/testing.go

@@ -28,6 +28,8 @@ func (o *TestingOutput) Process(t models.TestInterface, result *models.Result) e
 func renderResult(result *models.Result) (string, error) {
 	text := `
        Name: {{ .Test.GetName }}
+       Description:
+{{- if .Test.GetDescription }}{{ .Test.GetDescription }}{{ else }}{{ " No description" }}{{ end }}
        File: {{ .Test.GetFileName }}
 
 Request:

testloader/yaml_file/parser.go

@@ -84,6 +84,7 @@ func makeTestFromDefinition(filePath string, testDefinition TestDefinition) ([]T
 	// test definition has no cases, so using request/response as is
 	if len(testDefinition.Cases) == 0 {
 		test := Test{TestDefinition: testDefinition, Filename: filePath}
+		test.Description = testDefinition.Description
 		test.Request = testDefinition.RequestTmpl
 		test.Responses = testDefinition.ResponseTmpls
 		test.ResponseHeaders = testDefinition.ResponseHeaders
@@ -121,7 +122,11 @@ func makeTestFromDefinition(filePath string, testDefinition TestDefinition) ([]T
 	// produce as many tests as cases defined
 	for caseIdx, testCase := range testDefinition.Cases {
 		test := Test{TestDefinition: testDefinition, Filename: filePath}
-		test.Name = fmt.Sprintf("%s #%d", test.Name, caseIdx)
+		test.Name = fmt.Sprintf("%s #%d", test.Name, caseIdx+1)
+
+		if testCase.Description != "" {
+			test.Description = testCase.Description
+		}
 
 		// substitute RequestArgs to different parts of request
 		test.RequestURL, err = substituteArgs(requestURLTmpl, testCase.RequestArgs)

testloader/yaml_file/test.go

@@ -76,6 +76,10 @@ func (t *Test) GetName() string {
 	return t.Name
 }
 
+func (t *Test) GetDescription() string {
+	return t.Description
+}
+
 func (t *Test) GetStatus() string {
 	return t.Status
 }

testloader/yaml_file/test_definition.go

@@ -7,6 +7,7 @@ import (
 
 type TestDefinition struct {
 	Name                     string                    `json:"name" yaml:"name"`
+	Description              string                    `json:"description" yaml:"description"`
 	Status                   string                    `json:"status" yaml:"status"`
 	Variables                map[string]string         `json:"variables" yaml:"variables"`
 	VariablesToSet           VariablesToSet            `json:"variables_to_set" yaml:"variables_to_set"`
@@ -39,6 +40,7 @@ type CaseData struct {
 	DbQueryArgs            map[string]interface{}         `json:"dbQueryArgs" yaml:"dbQueryArgs"`
 	DbResponseArgs         map[string]interface{}         `json:"dbResponseArgs" yaml:"dbResponseArgs"`
 	DbResponse             []string                       `json:"dbResponse" yaml:"dbResponse"`
+	Description            string                         `json:"description" yaml:"description"`
 	Variables              map[string]interface{}         `json:"variables" yaml:"variables"`
 }