Skip to content

Commit 2798ac1

Browse files
KevFanKevFan
committed
refactor: AuthPolicyCommonSpec
1 parent 5a572be commit 2798ac1

File tree

6 files changed

+79
-79
lines changed

6 files changed

+79
-79
lines changed

‎api/v1beta2/authpolicy_types.go

+10-10
Original file line numberDiff line numberDiff line change
@@ -153,17 +153,17 @@ type AuthPolicySpec struct {
153153
TargetRef gatewayapiv1alpha2.PolicyTargetReference `json:"targetRef"`
154154

155155
// Defaults define explicit default values for this policy and for policies inheriting this policy.
156-
// Defaults are mutually exclusive with implicit defaults defined by CommonSpec.
156+
// Defaults are mutually exclusive with implicit defaults defined by AuthPolicyCommonSpec.
157157
// +optional
158-
Defaults *CommonSpec `json:"defaults,omitempty"`
158+
Defaults *AuthPolicyCommonSpec `json:"defaults,omitempty"`
159159

160-
// CommonSpec defines implicit default values for this policy and for policies inheriting this policy.
161-
// CommonSpec is mutually exclusive with explicit defaults defined by Defaults.
162-
CommonSpec `json:""`
160+
// AuthPolicyCommonSpec defines implicit default values for this policy and for policies inheriting this policy.
161+
// AuthPolicyCommonSpec is mutually exclusive with explicit defaults defined by Defaults.
162+
AuthPolicyCommonSpec `json:""`
163163
}
164164

165-
// CommonSpec contains common shared fields for defaults and overrides
166-
type CommonSpec struct {
165+
// AuthPolicyCommonSpec contains common shared fields for defaults and overrides
166+
type AuthPolicyCommonSpec struct {
167167
// Top-level route selectors.
168168
// If present, the elements will be used to select HTTPRoute rules that, when activated, trigger the external authorization service.
169169
// At least one selected HTTPRoute rule must match to trigger the AuthPolicy.
@@ -279,7 +279,7 @@ func (ap *AuthPolicy) GetRulesHostnames() (ruleHosts []string) {
279279
}
280280
}
281281

282-
appendCommonSpecRuleHosts := func(c CommonSpec) {
282+
appendCommonSpecRuleHosts := func(c AuthPolicyCommonSpec) {
283283
if c.AuthScheme == nil {
284284
return
285285
}
@@ -324,12 +324,12 @@ func (ap *AuthPolicy) DirectReferenceAnnotationName() string {
324324
return AuthPolicyDirectReferenceAnnotationName
325325
}
326326

327-
func (ap *AuthPolicy) GetCommonSpec() CommonSpec {
327+
func (ap *AuthPolicy) GetCommonSpec() AuthPolicyCommonSpec {
328328
if ap.Spec.Defaults != nil {
329329
return *ap.Spec.Defaults
330330
}
331331

332-
return ap.Spec.CommonSpec
332+
return ap.Spec.AuthPolicyCommonSpec
333333
}
334334

335335
func (ap *AuthPolicy) GetNamedPatterns() map[string]authorinoapi.PatternExpressions {

‎api/v1beta2/authpolicy_types_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ func TestAuthPolicyValidate(t *testing.T) {
262262
Name: "my-route",
263263
Namespace: ptr.To(gatewayapiv1.Namespace("other-namespace")),
264264
},
265-
CommonSpec: CommonSpec{
265+
AuthPolicyCommonSpec: AuthPolicyCommonSpec{
266266
AuthScheme: &AuthSchemeSpec{
267267
Authentication: map[string]AuthenticationSpec{
268268
"my-rule": {

‎api/v1beta2/zz_generated.deepcopy.go

+52-52
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎bundle/manifests/kuadrant.io_authpolicies.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ spec:
7373
defaults:
7474
description: |-
7575
Defaults define explicit default values for this policy and for policies inheriting this policy.
76-
Defaults are mutually exclusive with implicit defaults defined by CommonSpec.
76+
Defaults are mutually exclusive with implicit defaults defined by AuthPolicyCommonSpec.
7777
properties:
7878
patterns:
7979
additionalProperties:

‎config/crd/bases/kuadrant.io_authpolicies.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ spec:
7272
defaults:
7373
description: |-
7474
Defaults define explicit default values for this policy and for policies inheriting this policy.
75-
Defaults are mutually exclusive with implicit defaults defined by CommonSpec.
75+
Defaults are mutually exclusive with implicit defaults defined by AuthPolicyCommonSpec.
7676
properties:
7777
patterns:
7878
additionalProperties:

‎controllers/authpolicy_controller_test.go

+14-14
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ var _ = Describe("AuthPolicy controller", func() {
6666
Name: testHTTPRouteName,
6767
Namespace: ptr.To(gatewayapiv1.Namespace(testNamespace)),
6868
},
69-
Defaults: &api.CommonSpec{
69+
Defaults: &api.AuthPolicyCommonSpec{
7070
AuthScheme: testBasicAuthScheme(),
7171
},
7272
},
@@ -1336,7 +1336,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
13361336

13371337
It("Valid when only explicit defaults are used", func(ctx SpecContext) {
13381338
policy := policyFactory(func(policy *api.AuthPolicy) {
1339-
policy.Spec.Defaults = &api.CommonSpec{
1339+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{
13401340
AuthScheme: testBasicAuthScheme(),
13411341
}
13421342
})
@@ -1345,7 +1345,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
13451345

13461346
It("Invalid when both implicit and explicit defaults are used - authScheme", func(ctx SpecContext) {
13471347
policy := policyFactory(func(policy *api.AuthPolicy) {
1348-
policy.Spec.Defaults = &api.CommonSpec{}
1348+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{}
13491349
policy.Spec.AuthScheme = testBasicAuthScheme()
13501350
})
13511351
err := k8sClient.Create(ctx, policy)
@@ -1355,7 +1355,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
13551355

13561356
It("Invalid when both implicit and explicit defaults are used - routeSelectors", func(ctx SpecContext) {
13571357
policy := policyFactory(func(policy *api.AuthPolicy) {
1358-
policy.Spec.Defaults = &api.CommonSpec{}
1358+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{}
13591359
policy.Spec.RouteSelectors = []api.RouteSelector{
13601360
{
13611361
Hostnames: []gatewayapiv1.Hostname{"*.foo.io"},
@@ -1376,7 +1376,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
13761376

13771377
It("Invalid when both implicit and explicit defaults are used - namedPatterns", func(ctx SpecContext) {
13781378
policy := policyFactory(func(policy *api.AuthPolicy) {
1379-
policy.Spec.Defaults = &api.CommonSpec{}
1379+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{}
13801380
policy.Spec.NamedPatterns = map[string]authorinoapi.PatternExpressions{
13811381
"internal-source": []authorinoapi.PatternExpression{
13821382
{
@@ -1394,7 +1394,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
13941394

13951395
It("Invalid when both implicit and explicit defaults are used - conditions", func(ctx SpecContext) {
13961396
policy := policyFactory(func(policy *api.AuthPolicy) {
1397-
policy.Spec.Defaults = &api.CommonSpec{}
1397+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{}
13981398
policy.Spec.Conditions = []authorinoapi.PatternExpressionOrRef{
13991399
{
14001400
PatternRef: authorinoapi.PatternRef{
@@ -1464,7 +1464,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
14641464

14651465
It("invalid usage of top-level route selectors with a gateway targetRef - defaults", func() {
14661466
policy := policyFactory(func(policy *api.AuthPolicy) {
1467-
policy.Spec.Defaults = &api.CommonSpec{}
1467+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{}
14681468
policy.Spec.Defaults.RouteSelectors = routeSelectors
14691469
})
14701470

@@ -1496,7 +1496,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
14961496

14971497
It("invalid usage of config-level route selectors with a gateway targetRef - authentication - defaults", func() {
14981498
policy := policyFactory(func(policy *api.AuthPolicy) {
1499-
policy.Spec.Defaults = &api.CommonSpec{}
1499+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{}
15001500
policy.Spec.Defaults.AuthScheme = &api.AuthSchemeSpec{
15011501
Authentication: map[string]api.AuthenticationSpec{
15021502
"my-rule": {
@@ -1534,7 +1534,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
15341534

15351535
It("invalid usage of config-level route selectors with a gateway targetRef - metadata - defaults", func() {
15361536
policy := policyFactory(func(policy *api.AuthPolicy) {
1537-
policy.Spec.Defaults = &api.CommonSpec{}
1537+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{}
15381538
policy.Spec.Defaults.AuthScheme = &api.AuthSchemeSpec{
15391539
Metadata: map[string]api.MetadataSpec{
15401540
"my-metadata": {
@@ -1567,7 +1567,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
15671567

15681568
It("invalid usage of config-level route selectors with a gateway targetRef - authorization - defaults", func() {
15691569
policy := policyFactory(func(policy *api.AuthPolicy) {
1570-
policy.Spec.Defaults = &api.CommonSpec{}
1570+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{}
15711571
policy.Spec.Defaults.AuthScheme = &api.AuthSchemeSpec{
15721572
Authorization: map[string]api.AuthorizationSpec{
15731573
"my-authZ": {
@@ -1606,7 +1606,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
16061606

16071607
It("invalid usage of config-level route selectors with a gateway targetRef - response success headers - defaults", func() {
16081608
policy := policyFactory(func(policy *api.AuthPolicy) {
1609-
policy.Spec.Defaults = &api.CommonSpec{}
1609+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{}
16101610
policy.Spec.Defaults.AuthScheme = &api.AuthSchemeSpec{
16111611
Response: &api.ResponseSpec{
16121612
Success: api.WrappedSuccessResponseSpec{
@@ -1629,7 +1629,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
16291629

16301630
It("invalid usage of config-level route selectors with a gateway targetRef - response success dynamic metadata", func() {
16311631
policy := policyFactory(func(policy *api.AuthPolicy) {
1632-
policy.Spec.Defaults = &api.CommonSpec{}
1632+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{}
16331633
policy.Spec.Defaults.AuthScheme = &api.AuthSchemeSpec{
16341634
Response: &api.ResponseSpec{
16351635
Success: api.WrappedSuccessResponseSpec{
@@ -1650,7 +1650,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
16501650

16511651
It("invalid usage of config-level route selectors with a gateway targetRef - response success dynamic metadata - defaults", func() {
16521652
policy := policyFactory(func(policy *api.AuthPolicy) {
1653-
policy.Spec.Defaults = &api.CommonSpec{}
1653+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{}
16541654
policy.Spec.Defaults.AuthScheme = &api.AuthSchemeSpec{
16551655
Response: &api.ResponseSpec{
16561656
Success: api.WrappedSuccessResponseSpec{
@@ -1694,7 +1694,7 @@ var _ = Describe("AuthPolicy CEL Validations", func() {
16941694

16951695
It("invalid usage of config-level route selectors with a gateway targetRef - callbacks - defaults", func() {
16961696
policy := policyFactory(func(policy *api.AuthPolicy) {
1697-
policy.Spec.Defaults = &api.CommonSpec{}
1697+
policy.Spec.Defaults = &api.AuthPolicyCommonSpec{}
16981698
policy.Spec.Defaults.AuthScheme = &api.AuthSchemeSpec{
16991699
Callbacks: map[string]api.CallbackSpec{
17001700
"callback": {

0 commit comments

Comments
 (0)