feature: WEOS-1133 Generate and Ensure BDD Test

api.yaml

@@ -147,6 +147,15 @@ paths:
       operationId: Get Blogs
       summary: Get List of Blogs
       parameters:
+        - in: query
+          name: page
+          schema:
+            type: integer
+        - in: query
+          name: l
+          x-alias: limit
+          schema:
+            type: integer
         - in: query
           name: filters
           schema:

controllers/rest/controller_standard.go

@@ -460,8 +460,8 @@ func (c *StandardControllers) List(app model.Service, spec *openapi3.Swagger, pa
 			})
 		}
 		//gets the limit and page from context
-		limit := newContext.Value("limit").(int)
-		page := newContext.Value("page").(int)
+		limit, _ := newContext.Value("limit").(int)
+		page, _ := newContext.Value("page").(int)
 		if page == 0 {
 			page = 1
 		}

controllers/rest/middleware_context.go

@@ -55,14 +55,14 @@ func parseParams(c echo.Context, cc context.Context, parameter *openapi3.Paramet
 				return nil, err
 			}
 		}
-		var val interface{}
 		//if there is an alias name specified use that instead. The value is a json.RawMessage (not a string)
 		if tcontextName, ok := parameter.Value.ExtensionProps.Extensions[AliasExtension]; ok {
 			err := json.Unmarshal(tcontextName.(json.RawMessage), &contextName)
 			if err != nil {
 				return nil, err
 			}
 		}
+		var val interface{}
 		switch strings.ToLower(parameter.Value.In) {
 		//parameter values stored as strings
 		case "header":

controllers/rest/middleware_initialize.go

@@ -238,17 +238,19 @@ func AddStandardController(e *echo.Echo, pathData *openapi3.PathItem, method str
 				//check for identifiers
 				if identifiers != nil && len(identifiers) > 0 {
 					for _, identifier := range identifiers {
+						foundIdentifier := false
 						//check the parameters for the identifiers
 						for _, param := range pathData.Put.Parameters {
 							cName := param.Value.ExtensionProps.Extensions[ContextNameExtension]
 							if identifier == param.Value.Name || (cName != nil && identifier == cName.(string)) {
+								foundIdentifier = true
 								break
 							}
-							if !(identifier == param.Value.Name) && !(cName != nil && identifier == cName.(string)) {
-								allParam = false
-								e.Logger.Warnf("unexpected error: a parameter for each part of the identifier must be set")
-								return autoConfigure, nil
-							}
+						}
+						if !foundIdentifier {
+							allParam = false
+							e.Logger.Warnf("unexpected error: a parameter for each part of the identifier must be set")
+							return autoConfigure, nil
 						}
 					}
 					if allParam {
@@ -356,17 +358,19 @@ func AddStandardController(e *echo.Echo, pathData *openapi3.PathItem, method str
 					var contextName string
 					if identifiers != nil && len(identifiers) > 0 {
 						for _, identifier := range identifiers {
+							foundIdentifier := false
 							//check the parameters
 							for _, param := range pathData.Get.Parameters {
 								cName := param.Value.ExtensionProps.Extensions[ContextNameExtension]
 								if identifier == param.Value.Name || (cName != nil && identifier == cName.(string)) {
+									foundIdentifier = true
 									break
 								}
-								if !(identifier == param.Value.Name) && !(cName != nil && identifier == cName.(string)) {
-									allParam = false
-									e.Logger.Warnf("unexpected error: a parameter for each part of the identifier must be set")
-									return autoConfigure, nil
-								}
+							}
+							if !foundIdentifier {
+								allParam = false
+								e.Logger.Warnf("unexpected error: a parameter for each part of the identifier must be set")
+								return autoConfigure, nil
 							}
 						}
 					}

end2end_test.go

@@ -30,7 +30,6 @@ var e *echo.Echo
 var API api.RESTAPI
 var openAPI string
 var Developer *User
-var Content *ContentType
 var errs error
 var buf bytes.Buffer
 var payload ContentType
@@ -48,6 +47,10 @@ var binary string
 var dockerFile string
 var binaryMount string
 var esContainer testcontainers.Container
+var limit int
+var page int
+var contentType string
+var result api.ListApiResponse
 
 type User struct {
 	Name      string
@@ -73,6 +76,7 @@ func InitializeSuite(ctx *godog.TestSuiteContext) {
 	requests = map[string]map[string]interface{}{}
 	contentTypeID = map[string]bool{}
 	Developer = &User{}
+	result = api.ListApiResponse{}
 	e = echo.New()
 	e.Logger.SetOutput(&buf)
 	os.Remove("e2e.db")
@@ -122,6 +126,7 @@ func reset(ctx context.Context, sc *godog.Scenario) (context.Context, error) {
 	requests = map[string]map[string]interface{}{}
 	contentTypeID = map[string]bool{}
 	Developer = &User{}
+	result = api.ListApiResponse{}
 	errs = nil
 	header = make(http.Header)
 	rec = httptest.NewRecorder()
@@ -769,6 +774,83 @@ func sojournerIsUpdatingWithId(contentType, id string) error {
 	return nil
 }
 
+func isOnTheListScreen(user, content string) error {
+	contentType = content
+	requests[strings.ToLower(contentType+"_list")] = map[string]interface{}{}
+	currScreen = strings.ToLower(contentType + "_list")
+	return nil
+}
+
+func theItemsPerPageAre(pageLimit int) error {
+	limit = pageLimit
+	return nil
+}
+
+func theListResultsShouldBe(details *godog.Table) error {
+	head := details.Rows[0].Cells
+	compare := map[string]interface{}{}
+	compareArray := []map[string]interface{}{}
+
+	for i := 1; i < len(details.Rows); i++ {
+		for n, cell := range details.Rows[i].Cells {
+			compare[head[n].Value] = cell.Value
+		}
+		compareArray = append(compareArray, compare)
+		compare = map[string]interface{}{}
+	}
+	foundItems := 0
+
+	json.NewDecoder(rec.Body).Decode(&result)
+	for i, entity := range compareArray {
+		foundEntity := true
+		for key, value := range entity {
+			if result.Items[i][key] != value {
+				foundEntity = false
+				break
+			}
+		}
+		if foundEntity {
+			foundItems++
+		}
+	}
+	if foundItems != len(compareArray) {
+		return fmt.Errorf("expected to find %d, got %d", len(compareArray), foundItems)
+	}
+
+	return nil
+}
+
+func thePageInTheResultShouldBe(pageResult int) error {
+	if result.Page != pageResult {
+		return fmt.Errorf("expect page to be %d, got %d", pageResult, result.Page)
+	}
+	return nil
+}
+
+func thePageNoIs(pageNo int) error {
+	page = pageNo
+	return nil
+}
+
+func theSearchButtonIsHit() error {
+	var request *http.Request
+	request = httptest.NewRequest("GET", "/"+strings.ToLower(contentType)+"?limit="+strconv.Itoa(limit)+"&page="+strconv.Itoa(page), nil)
+	request = request.WithContext(context.TODO())
+	header.Set(echo.HeaderContentType, echo.MIMEApplicationJSON)
+	request.Header = header
+	request.Close = true
+	rec = httptest.NewRecorder()
+	e.ServeHTTP(rec, request)
+	return nil
+}
+
+func theTotalResultsShouldBe(totalResult int) error {
+	if result.Total != int64(totalResult) {
+		return fmt.Errorf("expect page to be %d, got %d", totalResult, result.Total)
+	}
+	return nil
+}
+
 func InitializeScenario(ctx *godog.ScenarioContext) {
 	ctx.Before(reset)
 	//add context steps
@@ -811,7 +893,13 @@ func InitializeScenario(ctx *godog.ScenarioContext) {
 	ctx.Step(`^the service is running$`, theServiceIsRunning)
 	ctx.Step(`^is run on the operating system "([^"]*)" as "([^"]*)"$`, isRunOnTheOperatingSystemAs)
 	ctx.Step(`^a warning should be output because the endpoint is invalid$`, aWarningShouldBeOutputBecauseTheEndpointIsInvalid)
-
+	ctx.Step(`^"([^"]*)" is on the "([^"]*)" list screen$`, isOnTheListScreen)
+	ctx.Step(`^the items per page are (\d+)$`, theItemsPerPageAre)
+	ctx.Step(`^the list results should be$`, theListResultsShouldBe)
+	ctx.Step(`^the page in the result should be (\d+)$`, thePageInTheResultShouldBe)
+	ctx.Step(`^the page no\. is (\d+)$`, thePageNoIs)
+	ctx.Step(`^the search button is hit$`, theSearchButtonIsHit)
+	ctx.Step(`^the total results should be (\d+)$`, theTotalResultsShouldBe)
 }
 
 func TestBDD(t *testing.T) {