add append '.' to err message for xpolicy

Signed-off-by: shawnh2 <shawnhxh@outlook.com>
envoyproxy · Apr 29, 2024 · 9a75549 · 9a75549
1 parent 2322ef0
commit 9a75549
Show file tree

Hide file tree

Showing 33 changed files with 44 additions and 38 deletions.
diff --git a/internal/gatewayapi/testdata/backendtlspolicy-invalid-ca.out.yaml b/internal/gatewayapi/testdata/backendtlspolicy-invalid-ca.out.yaml
@@ -26,7 +26,7 @@ backendTLSPolicies:
         sectionName: http
       conditions:
       - lastTransitionTime: null
-        message: No ca found in configmap no-ca-cmap
+        message: No ca found in configmap no-ca-cmap.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/backendtlspolicy-without-referencegrant.out.yaml b/internal/gatewayapi/testdata/backendtlspolicy-without-referencegrant.out.yaml
@@ -27,7 +27,7 @@ backendTLSPolicies:
       conditions:
       - lastTransitionTime: null
         message: Target ref to Service backends/http-backend not permitted by any
-          ReferenceGrant
+          ReferenceGrant.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/backendtrafficpolicy-with-circuitbreakers-error.out.yaml b/internal/gatewayapi/testdata/backendtrafficpolicy-with-circuitbreakers-error.out.yaml
@@ -23,7 +23,7 @@ backendTrafficPolicies:
         sectionName: http
       conditions:
       - lastTransitionTime: null
-        message: 'CircuitBreaker: invalid MaxRequestsPerConnection value -1'
+        message: 'CircuitBreaker: invalid MaxRequestsPerConnection value -1.'
         reason: Invalid
         status: "False"
         type: Accepted
@@ -52,7 +52,7 @@ backendTrafficPolicies:
         sectionName: http
       conditions:
       - lastTransitionTime: null
-        message: 'CircuitBreaker: invalid MaxParallelRetries value -1'
+        message: 'CircuitBreaker: invalid MaxParallelRetries value -1.'
         reason: Invalid
         status: "False"
         type: Accepted
@@ -80,7 +80,7 @@ backendTrafficPolicies:
         namespace: envoy-gateway
       conditions:
       - lastTransitionTime: null
-        message: 'CircuitBreaker: invalid MaxConnections value -1'
+        message: 'CircuitBreaker: invalid MaxConnections value -1.'
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/...gatewayapi/testdata/backendtrafficpolicy-with-local-ratelimit-invalid-limit-unit.out.yaml b/...gatewayapi/testdata/backendtrafficpolicy-with-local-ratelimit-invalid-limit-unit.out.yaml
@@ -48,7 +48,7 @@ backendTrafficPolicies:
       conditions:
       - lastTransitionTime: null
         message: 'RateLimit: local rateLimit rule limit unit must be a multiple of
-          the default limit unit'
+          the default limit unit.'
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/...gatewayapi/testdata/backendtrafficpolicy-with-local-ratelimit-invalid-match-type.out.yaml b/...gatewayapi/testdata/backendtrafficpolicy-with-local-ratelimit-invalid-match-type.out.yaml
@@ -44,7 +44,7 @@ backendTrafficPolicies:
         namespace: envoy-gateway
       conditions:
       - lastTransitionTime: null
-        message: 'RateLimit: local rateLimit does not support distinct HeaderMatch'
+        message: 'RateLimit: local rateLimit does not support distinct HeaderMatch.'
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/...ta/backendtrafficpolicy-with-local-ratelimit-invalid-multiple-route-level-limits.out.yaml b/...ta/backendtrafficpolicy-with-local-ratelimit-invalid-multiple-route-level-limits.out.yaml
@@ -51,7 +51,7 @@ backendTrafficPolicies:
       conditions:
       - lastTransitionTime: null
         message: 'RateLimit: local rateLimit can not have more than one rule without
-          clientSelectors'
+          clientSelectors.'
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/backendtrafficpolicy-with-ratelimit-invalid-regex.out.yaml b/internal/gatewayapi/testdata/backendtrafficpolicy-with-ratelimit-invalid-regex.out.yaml
@@ -35,7 +35,7 @@ backendTrafficPolicies:
       conditions:
       - lastTransitionTime: null
         message: 'RateLimit: regex "*.illegal.regex" is invalid: error parsing regexp:
-          missing argument to repetition operator: `*`'
+          missing argument to repetition operator: `*`.'
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/backendtrafficpolicy-with-timeout-error.out.yaml b/internal/gatewayapi/testdata/backendtrafficpolicy-with-timeout-error.out.yaml
@@ -26,7 +26,7 @@ backendTrafficPolicies:
         namespace: envoy-gateway
       conditions:
       - lastTransitionTime: null
-        message: 'Timeout: invalid MaxConnectionDuration value 22mib'
+        message: 'Timeout: invalid MaxConnectionDuration value 22mib.'
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/clienttrafficpolicy-buffer-limit-with-format-error.out.yaml b/internal/gatewayapi/testdata/clienttrafficpolicy-buffer-limit-with-format-error.out.yaml
@@ -24,7 +24,7 @@ clientTrafficPolicies:
         sectionName: http-1
       conditions:
       - lastTransitionTime: null
-        message: Invalid BufferLimit value 500m
+        message: Invalid BufferLimit value 500m.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/...nal/gatewayapi/testdata/clienttrafficpolicy-buffer-limit-with-out-of-range-error.out.yaml b/...nal/gatewayapi/testdata/clienttrafficpolicy-buffer-limit-with-out-of-range-error.out.yaml
@@ -24,7 +24,7 @@ clientTrafficPolicies:
         sectionName: http-1
       conditions:
       - lastTransitionTime: null
-        message: BufferLimit value 100G is out of range, must be between 0 and 4294967295
+        message: BufferLimit value 100G is out of range, must be between 0 and 4294967295.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/clienttrafficpolicy-connection-limit-error.out.yaml b/internal/gatewayapi/testdata/clienttrafficpolicy-connection-limit-error.out.yaml
@@ -26,7 +26,7 @@ clientTrafficPolicies:
         sectionName: http-1
       conditions:
       - lastTransitionTime: null
-        message: Invalid CloseDelay value 10mib
+        message: Invalid CloseDelay value 10mib.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/clienttrafficpolicy-http10.out.yaml b/internal/gatewayapi/testdata/clienttrafficpolicy-http10.out.yaml
@@ -86,7 +86,7 @@ clientTrafficPolicies:
         sectionName: http-3
       conditions:
       - lastTransitionTime: null
-        message: Can't set http10 default host on listener with only wildcard hostnames
+        message: Can't set http10 default host on listener with only wildcard hostnames.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/clienttrafficpolicy-http2.out.yaml b/internal/gatewayapi/testdata/clienttrafficpolicy-http2.out.yaml
@@ -60,7 +60,7 @@ clientTrafficPolicies:
       - lastTransitionTime: null
         message: |-
           InitialStreamWindowSize value 1Ki is out of range, must be between 65535 and 2147483647
-          InitialConnectionWindowSize value 1Ti is out of range, must be between 65535 and 2147483647
+          InitialConnectionWindowSize value 1Ti is out of range, must be between 65535 and 2147483647.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/clienttrafficpolicy-idle-timeout-with-error.out.yaml b/internal/gatewayapi/testdata/clienttrafficpolicy-idle-timeout-with-error.out.yaml
@@ -23,7 +23,7 @@ clientTrafficPolicies:
         namespace: envoy-gateway
       conditions:
       - lastTransitionTime: null
-        message: 'Time: unknown unit "sec" in duration "10sec"'
+        message: 'Time: unknown unit "sec" in duration "10sec".'
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/clienttrafficpolicy-timeout-with-error.out.yaml b/internal/gatewayapi/testdata/clienttrafficpolicy-timeout-with-error.out.yaml
@@ -23,7 +23,7 @@ clientTrafficPolicies:
         namespace: envoy-gateway
       conditions:
       - lastTransitionTime: null
-        message: 'Time: unknown unit "sec" in duration "5sec"'
+        message: 'Time: unknown unit "sec" in duration "5sec".'
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/conflicting-policies.out.yaml b/internal/gatewayapi/testdata/conflicting-policies.out.yaml
@@ -24,7 +24,7 @@ clientTrafficPolicies:
       conditions:
       - lastTransitionTime: null
         message: ClientTrafficPolicy is being applied to multiple http (non https)
-          listeners (default/gateway-1/http) on the same port, which is not allowed
+          listeners (default/gateway-1/http) on the same port, which is not allowed.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/...l/gatewayapi/testdata/envoyextensionpolicy-with-extproc-invalid-no-matching-port.out.yaml b/...l/gatewayapi/testdata/envoyextensionpolicy-with-extproc-invalid-no-matching-port.out.yaml
@@ -24,7 +24,7 @@ envoyExtensionPolicies:
         namespace: default
       conditions:
       - lastTransitionTime: null
-        message: TCP Port 4000 not found on service default/grpc-backend
+        message: TCP Port 4000 not found on service default/grpc-backend.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/envoyextensionpolicy-with-extproc-invalid-no-port.out.yaml b/internal/gatewayapi/testdata/envoyextensionpolicy-with-extproc-invalid-no-port.out.yaml
@@ -24,7 +24,7 @@ envoyExtensionPolicies:
       conditions:
       - lastTransitionTime: null
         message: A valid port number corresponding to a port on the Service must be
-          specified
+          specified.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/...gatewayapi/testdata/envoyextensionpolicy-with-extproc-invalid-no-reference-grant.out.yaml b/...gatewayapi/testdata/envoyextensionpolicy-with-extproc-invalid-no-reference-grant.out.yaml
@@ -26,7 +26,7 @@ envoyExtensionPolicies:
       conditions:
       - lastTransitionTime: null
         message: Backend ref to Service envoy-gateway/grpc-backend not permitted by
-          any ReferenceGrant
+          any ReferenceGrant.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/envoyextensionpolicy-with-extproc-invalid-no-service.out.yaml b/internal/gatewayapi/testdata/envoyextensionpolicy-with-extproc-invalid-no-service.out.yaml
@@ -25,7 +25,7 @@ envoyExtensionPolicies:
         namespace: default
       conditions:
       - lastTransitionTime: null
-        message: Service envoy-gateway/grpc-backend not found
+        message: Service envoy-gateway/grpc-backend not found.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/httproute-and-backendtrafficpolicy-with-timeout-error.out.yaml b/internal/gatewayapi/testdata/httproute-and-backendtrafficpolicy-with-timeout-error.out.yaml
@@ -26,7 +26,7 @@ backendTrafficPolicies:
         sectionName: http
       conditions:
       - lastTransitionTime: null
-        message: 'Timeout: invalid ConnectTimeout value 20kib'
+        message: 'Timeout: invalid ConnectTimeout value 20kib.'
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/httproute-with-invalid-regex.out.yaml b/internal/gatewayapi/testdata/httproute-with-invalid-regex.out.yaml
@@ -103,7 +103,7 @@ httpRoutes:
     - conditions:
       - lastTransitionTime: null
         message: 'Regex "*.foo.bar.com" is invalid: error parsing regexp: missing
-          argument to repetition operator: `*`'
+          argument to repetition operator: `*`.'
         reason: UnsupportedValue
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/httproute-with-single-rule-with-multiple-rules.out.yaml b/internal/gatewayapi/testdata/httproute-with-single-rule-with-multiple-rules.out.yaml
@@ -93,7 +93,7 @@ httpRoutes:
     - conditions:
       - lastTransitionTime: null
         message: 'Regex "*regex*" is invalid: error parsing regexp: missing argument
-          to repetition operator: `*`'
+          to repetition operator: `*`.'
         reason: UnsupportedValue
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/merge-with-isolated-policies-2.out.yaml b/internal/gatewayapi/testdata/merge-with-isolated-policies-2.out.yaml
@@ -57,7 +57,7 @@ clientTrafficPolicies:
       conditions:
       - lastTransitionTime: null
         message: ClientTrafficPolicy is being applied to multiple http (non https)
-          listeners (default/gateway-2/http-2) on the same port, which is not allowed
+          listeners (default/gateway-2/http-2) on the same port, which is not allowed.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/securitypolicy-with-extauth-invalid-no-matching-port.out.yaml b/internal/gatewayapi/testdata/securitypolicy-with-extauth-invalid-no-matching-port.out.yaml
@@ -126,7 +126,7 @@ securityPolicies:
         namespace: default
       conditions:
       - lastTransitionTime: null
-        message: TCP Port 80 not found on service default/http-backend
+        message: TCP Port 80 not found on service default/http-backend.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/securitypolicy-with-extauth-invalid-no-port.out.yaml b/internal/gatewayapi/testdata/securitypolicy-with-extauth-invalid-no-port.out.yaml
@@ -126,7 +126,7 @@ securityPolicies:
       conditions:
       - lastTransitionTime: null
         message: A valid port number corresponding to a port on the Service must be
-          specified
+          specified.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/securitypolicy-with-extauth-invalid-no-reference-grant.out.yaml b/internal/gatewayapi/testdata/securitypolicy-with-extauth-invalid-no-reference-grant.out.yaml
@@ -127,7 +127,7 @@ securityPolicies:
       conditions:
       - lastTransitionTime: null
         message: Backend ref to Service envoy-gateway/http-backend not permitted by
-          any ReferenceGrant
+          any ReferenceGrant.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/securitypolicy-with-extauth-invalid-no-service.out.yaml b/internal/gatewayapi/testdata/securitypolicy-with-extauth-invalid-no-service.out.yaml
@@ -126,7 +126,7 @@ securityPolicies:
         namespace: default
       conditions:
       - lastTransitionTime: null
-        message: Service default/http-backend not found
+        message: Service default/http-backend not found.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/securitypolicy-with-jwt-and-invalid-oidc.out.yaml b/internal/gatewayapi/testdata/securitypolicy-with-jwt-and-invalid-oidc.out.yaml
@@ -174,7 +174,7 @@ securityPolicies:
         sectionName: http
       conditions:
       - lastTransitionTime: null
-        message: Secret default/client2-secret does not exist
+        message: Secret default/client2-secret does not exist.
         reason: Invalid
         status: "False"
         type: Accepted
@@ -219,7 +219,7 @@ securityPolicies:
         namespace: envoy-gateway
       conditions:
       - lastTransitionTime: null
-        message: Secret envoy-gateway/client1-secret does not exist
+        message: Secret envoy-gateway/client1-secret does not exist.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/securitypolicy-with-oidc-invalid-issuer.out.yaml b/internal/gatewayapi/testdata/securitypolicy-with-oidc-invalid-issuer.out.yaml
@@ -86,7 +86,7 @@ securityPolicies:
       conditions:
       - lastTransitionTime: null
         message: 'Error fetching endpoints from issuer: invalid character ''<'' looking
-          for beginning of value'
+          for beginning of value.'
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/gatewayapi/testdata/securitypolicy-with-oidc-invalid-secretref.out.yaml b/internal/gatewayapi/testdata/securitypolicy-with-oidc-invalid-secretref.out.yaml
@@ -197,7 +197,7 @@ securityPolicies:
         namespace: default
       conditions:
       - lastTransitionTime: null
-        message: Secret default/client1-secret does not exist
+        message: Secret default/client1-secret does not exist.
         reason: Invalid
         status: "False"
         type: Accepted
@@ -234,7 +234,7 @@ securityPolicies:
         namespace: default
       conditions:
       - lastTransitionTime: null
-        message: Secret ref namespace must be unspecified/empty or default
+        message: Secret ref namespace must be unspecified/empty or default.
         reason: Invalid
         status: "False"
         type: Accepted
@@ -270,7 +270,7 @@ securityPolicies:
         namespace: default
       conditions:
       - lastTransitionTime: null
-        message: Client secret not found in secret default/client3-secret
+        message: Client secret not found in secret default/client3-secret.
         reason: Invalid
         status: "False"
         type: Accepted

diff --git a/internal/status/conditions.go b/internal/status/conditions.go
@@ -142,7 +142,7 @@ func conditionChanged(a, b metav1.Condition) bool {
 
 // Error2ConditionMsg format the error string to a Status condition message.
 // * Convert the first letter to capital
-// * Append "." to the string if it doesn't exit
+// * Append "." to the string if it doesn't exist
 func Error2ConditionMsg(err error) string {
 	if err == nil {
 		return ""
@@ -161,6 +161,12 @@ func Error2ConditionMsg(err error) string {
 		runes[0] = unicode.ToUpper(runes[0])
 	}
 
+	// Check if the last rune is a punctuation '.' and append it if not
+	last := runes[len(runes)-1]
+	if !unicode.IsPunct(last) || last != '.' {
+		runes = append(runes, '.')
+	}
+
 	// Convert the rune slice back to a string
 	return string(runes)
 }
diff --git a/internal/status/conditions_test.go b/internal/status/conditions_test.go
@@ -356,7 +356,7 @@ func TestError2ConditionMsg(t *testing.T) {
 		{
 			name:   "error with message",
 			err:    errors.New("something is wrong"),
-			expect: "Something is wrong",
+			expect: "Something is wrong.",
 		},
 	}
 	for _, tt := range testCases {