Skip to content

Add CEL validation test for timeout in ClientSettingsPolicy #3695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 7, 2025
Merged

Add CEL validation test for timeout in ClientSettingsPolicy #3695

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34c150a
Add tests for RequestTimeout CEL validation
shaun-nx Aug 6, 2025
7862dfa
Add spacing for test consistentcy
shaun-nx Aug 6, 2025
df8541b
Merge branch 'main' into tests/cel-clientsettingspolicies-timeout
shaun-nx Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions tests/cel/clientsettingspolicy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
gatewayv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"

ngfAPIv1alpha1 "github.com/nginx/nginx-gateway-fabric/v2/apis/v1alpha1"
"github.com/nginx/nginx-gateway-fabric/v2/internal/framework/helpers"
"github.com/nginx/nginx-gateway-fabric/v2/tests/framework"
)

Expand Down Expand Up @@ -129,6 +130,66 @@ func TestClientSettingsPoliciesTargetRefGroup(t *testing.T) {
}
}

func TestClientSettingsPoliciesKeepAliveTimeout(t *testing.T) {
t.Parallel()
g := NewWithT(t)
k8sClient, err := getKubernetesClient(t)
g.Expect(err).ToNot(HaveOccurred())
tests := []struct {
policySpec ngfAPIv1alpha1.ClientSettingsPolicySpec
name string
wantErrors []string
}{
{
name: "Validate KeepAliveTimeout is not set",
policySpec: ngfAPIv1alpha1.ClientSettingsPolicySpec{
TargetRef: gatewayv1alpha2.LocalPolicyTargetReference{
Kind: gatewayKind,
Group: gatewayGroup,
},
KeepAlive: nil,
},
},
{
name: "Validate KeepAlive is set",
policySpec: ngfAPIv1alpha1.ClientSettingsPolicySpec{
TargetRef: gatewayv1alpha2.LocalPolicyTargetReference{
Kind: gatewayKind,
Group: gatewayGroup,
},
KeepAlive: &ngfAPIv1alpha1.ClientKeepAlive{
Timeout: &ngfAPIv1alpha1.ClientKeepAliveTimeout{
Server: helpers.GetPointer[ngfAPIv1alpha1.Duration]("5s"),
Header: helpers.GetPointer[ngfAPIv1alpha1.Duration]("2s"),
},
},
},
},
{
name: "Validate Header cannot be set without Server",
wantErrors: []string{expectedHeaderWithoutServerError},
policySpec: ngfAPIv1alpha1.ClientSettingsPolicySpec{
TargetRef: gatewayv1alpha2.LocalPolicyTargetReference{
Kind: gatewayKind,
Group: gatewayGroup,
},
KeepAlive: &ngfAPIv1alpha1.ClientKeepAlive{
Timeout: &ngfAPIv1alpha1.ClientKeepAliveTimeout{
Header: helpers.GetPointer[ngfAPIv1alpha1.Duration]("2s"),
},
},
},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
validateClientSettingsPolicy(t, tt, g, k8sClient)
})
}
}

func validateClientSettingsPolicy(t *testing.T, tt struct {
policySpec ngfAPIv1alpha1.ClientSettingsPolicySpec
name string
Expand Down
5 changes: 3 additions & 2 deletions tests/cel/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ const (
)

const (
expectedTargetRefKindError = `TargetRef Kind must be one of: Gateway, HTTPRoute, or GRPCRoute`
expectedTargetRefGroupError = `TargetRef Group must be gateway.networking.k8s.io.`
expectedTargetRefKindError = `TargetRef Kind must be one of: Gateway, HTTPRoute, or GRPCRoute`
expectedTargetRefGroupError = `TargetRef Group must be gateway.networking.k8s.io.`
expectedHeaderWithoutServerError = `header can only be specified if server is specified`
)

const (
Expand Down