fix: assign rule priority automatically to routing rule (#1390) (#1391)

akshaysngupta · alxyzc · web-flow · commit 78cb4021122c · 2022-05-06T13:56:04.000+05:30
* assign rule priority

* skip rule with priority

* adding non-working tests

* find next free priority

* adjust jump; fix test

* remove comment

* add buffer to sig channel

Co-authored-by: Alex Z. Yang &lt;alxyzc@gmail.com&gt;

Co-authored-by: Alex Z. Yang &lt;alxyzc@gmail.com&gt;
diff --git a/cmd/appgw-ingress/main.go b/cmd/appgw-ingress/main.go
@@ -224,7 +224,7 @@ func main() {
 		klog.Fatal(errorLine)
 	}
 
-	sigChan := make(chan os.Signal)
+	sigChan := make(chan os.Signal, 1)
 	signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)
 	<-sigChan
 
diff --git a/docs/setup/install-new.md b/docs/setup/install-new.md
@@ -236,7 +236,7 @@ Values:
 - `rbac.enabled`: Make sure to set this to true if you have a AKS cluster that is RBAC enabled.
 
    Note on Identity: The `identityResourceID` and `identityClientID` are values that were created
-   during the [Create an Identity](https://github.com/Azure/application-gateway-kubernetes-ingress/blob/072626cb4e37f7b7a1b0c4578c38d1eadc3e8701/docs/setup/install-new.md#create-an-identity)
+   during the [Create an Identity](#create-an-identity)
    steps, and could be obtained again using the following command:
 
    ```bash
diff --git a/functional_tests/cookie_name.json b/functional_tests/cookie_name.json
@@ -207,6 +207,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-e1903c8aa3446b7b3207aec6d6ecba8a"
                     },
+                    "priority": 19500,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-e1903c8aa3446b7b3207aec6d6ecba8a"
diff --git a/functional_tests/duplicate_ports.json b/functional_tests/duplicate_ports.json
@@ -198,6 +198,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-08ba2bb7da9df5927d900fca8ce96ba5"
                     },
+                    "priority": 19000,
                     "redirectConfiguration": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/redirectConfigurations/sslr-fl-175bc9385b96d7116527143f35cdfdea"
                     },
@@ -217,6 +218,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-175bc9385b96d7116527143f35cdfdea"
                     },
+                    "priority": 19005,
                     "ruleType": "Basic"
                 }
             }
diff --git a/functional_tests/empty_cluster_with_private_ip.json b/functional_tests/empty_cluster_with_private_ip.json
@@ -116,6 +116,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-ac133916d522c571f2d9ef8f3b8a25d3"
                     },
+                    "priority": 19500,
                     "ruleType": "Basic"
                 }
             }
diff --git a/functional_tests/health_probes_same_labels_different_namespaces.json b/functional_tests/health_probes_same_labels_different_namespaces.json
@@ -244,6 +244,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-08ba2bb7da9df5927d900fca8ce96ba5"
                     },
+                    "priority": 19000,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-08ba2bb7da9df5927d900fca8ce96ba5"
@@ -263,6 +264,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-175bc9385b96d7116527143f35cdfdea"
                     },
+                    "priority": 19005,
                     "ruleType": "Basic"
                 }
             }
diff --git a/functional_tests/one_ingress_https_backend.json b/functional_tests/one_ingress_https_backend.json
@@ -199,6 +199,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-c61dda7ff9748ec5f51989767db5afd0"
                     },
+                    "priority": 19500,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-c61dda7ff9748ec5f51989767db5afd0"
@@ -212,6 +213,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-e1903c8aa3446b7b3207aec6d6ecba8a"
                     },
+                    "priority": 19505,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-e1903c8aa3446b7b3207aec6d6ecba8a"
diff --git a/functional_tests/one_ingress_https_backend_without_backend_protocol.json b/functional_tests/one_ingress_https_backend_without_backend_protocol.json
@@ -159,6 +159,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-c61dda7ff9748ec5f51989767db5afd0"
                     },
+                    "priority": 19500,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-c61dda7ff9748ec5f51989767db5afd0"
diff --git a/functional_tests/one_ingress_slash_nothing.json b/functional_tests/one_ingress_slash_nothing.json
@@ -162,6 +162,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-e1903c8aa3446b7b3207aec6d6ecba8a"
                     },
+                    "priority": 19500,
                     "ruleType": "Basic"
                 }
             }
diff --git a/functional_tests/one_ingress_slash_slashnothing.json b/functional_tests/one_ingress_slash_slashnothing.json
@@ -202,6 +202,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-e1903c8aa3446b7b3207aec6d6ecba8a"
                     },
+                    "priority": 19500,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-e1903c8aa3446b7b3207aec6d6ecba8a"
diff --git a/functional_tests/one_ingress_with_multiple_path_rules.json b/functional_tests/one_ingress_with_multiple_path_rules.json
@@ -248,6 +248,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-e1903c8aa3446b7b3207aec6d6ecba8a"
                     },
+                    "priority": 19500,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-e1903c8aa3446b7b3207aec6d6ecba8a"
diff --git a/functional_tests/three_ingresses.json b/functional_tests/three_ingresses.json
@@ -305,6 +305,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-08ba2bb7da9df5927d900fca8ce96ba5"
                     },
+                    "priority": 19000,
                     "redirectConfiguration": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/redirectConfigurations/sslr-fl-175bc9385b96d7116527143f35cdfdea"
                     },
@@ -324,6 +325,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-175bc9385b96d7116527143f35cdfdea"
                     },
+                    "priority": 19005,
                     "ruleType": "Basic"
                 }
             },
@@ -334,6 +336,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-e1903c8aa3446b7b3207aec6d6ecba8a"
                     },
+                    "priority": 19500,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-e1903c8aa3446b7b3207aec6d6ecba8a"
diff --git a/functional_tests/two_ingresses_same_domain_tls_notls.json b/functional_tests/two_ingresses_same_domain_tls_notls.json
@@ -244,6 +244,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-08ba2bb7da9df5927d900fca8ce96ba5"
                     },
+                    "priority": 19000,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-08ba2bb7da9df5927d900fca8ce96ba5"
@@ -263,6 +264,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-175bc9385b96d7116527143f35cdfdea"
                     },
+                    "priority": 19005,
                     "ruleType": "Basic"
                 }
             }
diff --git a/functional_tests/two_ingresses_same_hostname_value_different_locations.json b/functional_tests/two_ingresses_same_hostname_value_different_locations.json
@@ -187,6 +187,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-08ba2bb7da9df5927d900fca8ce96ba5"
                     },
+                    "priority": 19000,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-08ba2bb7da9df5927d900fca8ce96ba5"
diff --git a/functional_tests/two_ingresses_slash_slashsomething.json b/functional_tests/two_ingresses_slash_slashsomething.json
@@ -202,6 +202,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-e1903c8aa3446b7b3207aec6d6ecba8a"
                     },
+                    "priority": 19500,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-e1903c8aa3446b7b3207aec6d6ecba8a"
diff --git a/functional_tests/two_ingresses_with_and_without_extended_hostname.json b/functional_tests/two_ingresses_with_and_without_extended_hostname.json
@@ -220,6 +220,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-ac80e40addbf0c0bac6b5c79b565a989"
                     },
+                    "priority": 19000,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-ac80e40addbf0c0bac6b5c79b565a989"
@@ -233,6 +234,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-e1903c8aa3446b7b3207aec6d6ecba8a"
                     },
+                    "priority": 19500,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-e1903c8aa3446b7b3207aec6d6ecba8a"
diff --git a/functional_tests/waf_annotation.json b/functional_tests/waf_annotation.json
@@ -205,6 +205,7 @@
                     "httpListener": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-e1903c8aa3446b7b3207aec6d6ecba8a"
                     },
+                    "priority": 19500,
                     "ruleType": "PathBasedRouting",
                     "urlPathMap": {
                         "id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/urlPathMaps/url-e1903c8aa3446b7b3207aec6d6ecba8a"
diff --git a/go.mod b/go.mod
@@ -13,7 +13,7 @@ require (
 	github.com/knative/pkg v0.0.0-20190619032946-d90a9bc97dde
 	github.com/kylelemons/godebug v1.1.0
 	github.com/onsi/ginkgo v1.16.4
-	github.com/onsi/gomega v1.14.0
+	github.com/onsi/gomega v1.19.0
 	github.com/prometheus/client_golang v1.11.0
 	github.com/spf13/pflag v1.0.5
 	gopkg.in/yaml.v2 v2.4.0
diff --git a/go.sum b/go.sum
diff --git a/pkg/appgw/configbuilder_test.go b/pkg/appgw/configbuilder_test.go
diff --git a/pkg/appgw/frontend_listeners.go b/pkg/appgw/frontend_listeners.go
diff --git a/pkg/appgw/frontend_listeners_test.go b/pkg/appgw/frontend_listeners_test.go
diff --git a/pkg/appgw/requestroutingrules.go b/pkg/appgw/requestroutingrules.go
diff --git a/pkg/appgw/requestroutingrules_test.go b/pkg/appgw/requestroutingrules_test.go

Original file line number	Diff line number	Diff line change
`@@ -224,7 +224,7 @@ func main() {`
`224`	`224`	`klog.Fatal(errorLine)`
`225`	`225`	`}`
`226`	`226`
`227`		`- sigChan := make(chan os.Signal)`
	`227`	`+ sigChan := make(chan os.Signal, 1)`
`228`	`228`	`signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)`
`229`	`229`	`<-sigChan`
`230`	`230`
Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,7 @@`
`116`	`116`	`"httpListener": {`
`117`	`117`	`"id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-ac133916d522c571f2d9ef8f3b8a25d3"`
`118`	`118`	`},`
	`119`	`+ "priority": 19500,`
`119`	`120`	`"ruleType": "Basic"`
`120`	`121`	`}`
`121`	`122`	`}`
Original file line number	Diff line number	Diff line change
`@@ -162,6 +162,7 @@`
`162`	`162`	`"httpListener": {`
`163`	`163`	`"id": "/subscriptions/--subscription--/resourceGroups/--resource-group--/providers/Microsoft.Network/applicationGateways/--app-gw-name--/httpListeners/fl-e1903c8aa3446b7b3207aec6d6ecba8a"`
`164`	`164`	`},`
	`165`	`+ "priority": 19500,`
`165`	`166`	`"ruleType": "Basic"`
`166`	`167`	`}`
`167`	`168`	`}`