MEDIUM: api consolitation- Move child resources as nested resources

Instruction for the generation of handlers/parents_xxx_generated.go can be found in CONTRIBUTING.md

Author: hdurand0710

.gitlab-ci.yml

@@ -29,6 +29,20 @@ diff:
     - make generate-native
     - test -z "$(git diff 2> /dev/null)" || exit "Specification is not generated, issue \`make generate\` and commit the result"
     - test -z "$(git ls-files --others --exclude-standard 2> /dev/null)" || exit "Specification generation created untracked files, cannot proceed"
+diff-spec-parent:
+  stage: lint
+  image:
+    name: $CI_REGISTRY_GO/golang:$GO_VERSION
+    entrypoint: [""]
+  tags:
+    - go
+  rules:
+    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
+    - if: $CI_PIPELINE_SOURCE == 'push'
+  script:
+    - make generate-parent-aliases
+    - test -z "$(git diff 2> /dev/null)" || exit "Parent aliases are not generated, issue \`make generate-parent-aliases\` and commit the result"
+    - test -z "$(git ls-files --others --exclude-standard 2> /dev/null)" || exit "Parent aliases created untracked files, cannot proceed"
 golangci-lint:
   stage: lint
   artifacts:

.golangci.yml

@@ -1,6 +1,4 @@
 linters-settings:
-  govet:
-    check-shadowing: true
   golint:
     min-confidence: 0
   gocyclo:

CONTRIBUTING.md

@@ -6,6 +6,7 @@ This document is a short guide for contributing to this project.
 
 ## API Specification - Development guide
 
+### Dataplane API generation
 Data Plane API is generated using [go-swagger](https://github.com/go-swagger/go-swagger) from the swagger spec found [here](https://github.com/haproxytech/client-native/blob/master/specification/build/haproxy_spec.yaml) using the following command.
 
 ```
@@ -21,6 +22,39 @@ make generate-native
 This command generates some of the files in this project, which are marked with // Code generated by go-swagger; DO NOT EDIT.
 comments at the top of the files. These are not to be edited, as they are overwritten when specification is changed and the above-mentioned command is run. If you want to change those files, please change the specification where necessary and then generate them again.
 
+### handlers/parents_xxx_generated.go generation
+
+Some handler files `handler/parents_xxx_generated.go` are automatically generated. For this use the following command:
+```
+make generate-parent-aliases
+```
+
+Pre-requisites: for this command to run you need to update the following files:
+- [generate/parents/main.go](./generate/parents/main.go)
+  - Update this section with the list of children for which you generate a `handler/parents_xxx_generated.go`
+```
+	children := []string{
+		cnparents.ServerChildType,
+		cnparents.HTTPAfterResponseRuleChildType,
+		cnparents.HTTPCheckChildType,
+		cnparents.HTTPErrorRuleChildType,
+		cnparents.HTTPRequestRuleChildType,
+		cnparents.HTTPResponseRuleChildType,
+		cnparents.TCPCheckChildType,
+		cnparents.TCPRequestRuleChildType,
+		cnparents.TCPResponseRuleChildType,
+		cnparents.ACLChildType,
+		cnparents.BindChildType,
+		cnparents.FilterChildType,
+		cnparents.LogTargetChildType,
+	}
+```
+
+- [generate/parents/operations.go](./generate/parents/operations.go)
+  - Contains the list of operations to generate an alias for in the `handler/parents_xxx_generated.go`.
+  - Note that the list of parents for wich an alias is generated is defined in: *client-native* (refer to client-native `specification/README.md`)
+
+
 ## Commit Messages and General Style
 
 For commit messages and general style please follow the haproxy project's [CONTRIBUTING guide](https://github.com/haproxy/haproxy/blob/master/CONTRIBUTING) and use that where applicable.

Makefile

@@ -38,6 +38,15 @@ build:
 e2e: build
 	TESTNAME=$(TESTNAME) TESTNUMBER=$(TESTNUMBER) TESTDESCRIPTION="$(TESTDESCRIPTION)" SKIP_CLEANUP=$(SKIP_CLEANUP) PREWIPE=$(PREWIPE) HAPROXY_VERSION=$(HAPROXY_VERSION) ./e2e/run.bash
 
+.PHONY: generate-parent-aliases_no_formatting
+generate-parent-aliases_no_formatting:
+	rm -f handlers/parent_*_generated.go
+	go run generate/parents/*.go
+
+.PHONY: generate-parent-aliases
+generate-parent-aliases: generate-parent-aliases_no_formatting gofumpt
+
+
 .PHONY: generate
 generate:
 	cd generate/swagger;docker build \

configure_data_plane.go

@@ -37,6 +37,6 @@ function deprecated_auth_curl() {
 }
 
 function get_version() {
-  resource_get "/services/haproxy/spoe/version" "spoe=$SPOE_FILE"
+  resource_get "/services/haproxy/spoe/$SPOE_FILE/version"
   eval VERSION="'$BODY'"
 }

e2e/libs/version_spoe.bash

@@ -25,7 +25,8 @@ load '../../libs/version'
 load 'utils/_helpers'
 
 @test "acl_runtime: Return ACL file entries list" {
-  resource_get "$_RUNTIME_ACL_FILE_ENTRIES_BASE_PATH" "acl_id=0"
+  PARENT_NAME="0"
+  resource_get "$_RUNTIME_ACL_BASE_PATH/$PARENT_NAME/entries"
   assert_equal "$SC" 200
 
   assert_equal "$(get_json_path "${BODY}" " .[0].value" )" "/static"
@@ -35,7 +36,8 @@ load 'utils/_helpers'
 }
 
 @test "acl_runtime: Return ACL file entries by their ID" {
-  resource_get "$_RUNTIME_ACL_FILE_ENTRIES_BASE_PATH" "acl_id=0"
+  PARENT_NAME="0"
+  resource_get "$_RUNTIME_ACL_BASE_PATH/$PARENT_NAME/entries"
   assert_equal "$SC" 200
 
   local list; list=$BODY
@@ -44,35 +46,37 @@ load 'utils/_helpers'
     local id; id="$(get_json_path "${list}" ".[${index}].id" )"
     local value; value="$(get_json_path "${list}" ".[${index}].value" )"
 
-    resource_get "$_RUNTIME_ACL_FILE_ENTRIES_BASE_PATH/$id" "acl_id=0"
+    resource_get "$_RUNTIME_ACL_BASE_PATH/$PARENT_NAME/entries/$id"
     assert_equal "$SC" 200
     assert_equal "$(get_json_path "${BODY}" ".value" )" "$value"
   done
 }
 
 @test "acl_runtime: Add an ACL file entry" {
-  resource_post "$_RUNTIME_ACL_FILE_ENTRIES_BASE_PATH" "data/post.json" "acl_id=0"
+  PARENT_NAME="0"
+  resource_post "$_RUNTIME_ACL_BASE_PATH/$PARENT_NAME/entries" "data/post.json"
   assert_equal "$SC" 201
   assert_equal "$(get_json_path "${BODY}" " .value" )" "/js"
 }
 
 @test "acl_runtime: Delete an ACL file entry by its ID" {
+  PARENT_NAME="1"
   if haproxy_version_ge "2.9"; then
     skip "cause: bug in HAPRoxy 2.9"
   fi
 	# checking items and retrieving first ID
-	resource_get "$_RUNTIME_ACL_FILE_ENTRIES_BASE_PATH" "acl_id=1"
+	resource_get "$_RUNTIME_ACL_BASE_PATH/$PARENT_NAME/entries"
   assert_equal "$SC" 200
 	assert_equal "$(get_json_path "$BODY" ". | length" )" "5"
 
 	local id; id="$(get_json_path "$BODY" ".[0].id")"
 
 	# deleting the entry file by its ID
-	resource_delete "$_RUNTIME_ACL_FILE_ENTRIES_BASE_PATH/$id" "acl_id=1"
+	resource_delete "$_RUNTIME_ACL_BASE_PATH/$PARENT_NAME/entries/$id"
   assert_equal "$SC" 204
 
 	# checking the file entry has been deleted counting the items
-	resource_get "$_RUNTIME_ACL_FILE_ENTRIES_BASE_PATH" "acl_id=1"
+	resource_get "$_RUNTIME_ACL_BASE_PATH/$PARENT_NAME/entries"
   assert_equal "$SC" 200
 	assert_equal "$(get_json_path "$BODY" ". | length" )" "4"
 }

e2e/tests/acl_files/acl_file_entries.bats

@@ -16,4 +16,3 @@
 #
 
 _RUNTIME_ACL_BASE_PATH="/services/haproxy/runtime/acls"
-_RUNTIME_ACL_FILE_ENTRIES_BASE_PATH="/services/haproxy/runtime/acl_file_entries"

e2e/tests/acl_files/utils/_helpers.bash

@@ -24,12 +24,24 @@ load '../../libs/resource_client'
 load 'utils/_helpers'
 
 @test "acls: Add a new ACL" {
-    resource_post "$_ACL_BASE_PATH"/2 "data/post.json" "index=2&parent_name=fe_acl&parent_type=frontend"
+    PARENT_NAME="fe_acl"
+    resource_post "$_FRONTEND_BASE_PATH/$PARENT_NAME/acls/2" "data/post.json"
     assert_equal "$SC" 202
     #
     # verify that ACL is actually added
     #
-    resource_get "$_ACL_BASE_PATH/2" "parent_name=fe_acl&parent_type=frontend"
+    resource_get "$_FRONTEND_BASE_PATH/$PARENT_NAME/acls/2"
+    assert_equal "$SC" 200
+
+    assert_equal "$(get_json_path "${BODY}" ".")" "$(cat ${BATS_TEST_DIRNAME}/data/post.json)"
+}
+
+@test "acls: Add a newACL for fcgi-app" {
+    PARENT_NAME="test_1"
+    resource_post "$_FCGIAPP_BASE_PATH/$PARENT_NAME/acls/0" "data/post.json"
+    assert_equal "$SC" 202
+
+    resource_get "$_FCGIAPP_BASE_PATH/$PARENT_NAME/acls/0"
     assert_equal "$SC" 200
 
     assert_equal "$(get_json_path "${BODY}" ".")" "$(cat ${BATS_TEST_DIRNAME}/data/post.json)"

e2e/tests/acls/add.bats

@@ -23,3 +23,9 @@ frontend fe_acl
   acl invalid_src  src          0.0.0.0/7 224.0.0.0/3
   acl invalid_src  src_port     0:1023
   acl local_dst    hdr(host) -i localhost
+
+fcgi-app test_1
+  docroot /path/to/chroot
+  index index.php
+  log-stderr global
+  acl local_dst    hdr(host) -i localhost