Skip to content

Refactor codebase using generic GetPointer function #1006

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.

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 5 commits into from
Aug 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 0 additions & 41 deletions internal/framework/helpers/helpers.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import (

"github.com/google/go-cmp/cmp"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"sigs.k8s.io/gateway-api/apis/v1beta1"
)

// Diff prints the diff between two structs.
Expand All @@ -21,46 +20,6 @@ func Diff(want, got any) string {
return r
}

// GetStringPointer takes a string and returns a pointer to it.
func GetStringPointer(s string) *string {
return &s
}

// GetIntPointer takes an int and returns a pointer to it.
func GetIntPointer(i int) *int {
return &i
}

// GetInt32Pointer takes an int32 and returns a pointer to it.
func GetInt32Pointer(i int32) *int32 {
return &i
}

// GetHTTPMethodPointer takes an HTTPMethod and returns a pointer to it.
func GetHTTPMethodPointer(m v1beta1.HTTPMethod) *v1beta1.HTTPMethod {
return &m
}

// GetHeaderMatchTypePointer takes an HeaderMatchType and returns a pointer to it.
func GetHeaderMatchTypePointer(t v1beta1.HeaderMatchType) *v1beta1.HeaderMatchType {
return &t
}

// GetQueryParamMatchTypePointer takes an QueryParamMatchType and returns a pointer to it.
func GetQueryParamMatchTypePointer(t v1beta1.QueryParamMatchType) *v1beta1.QueryParamMatchType {
return &t
}

// GetTLSModePointer takes a TLSModeType and returns a pointer to it.
func GetTLSModePointer(t v1beta1.TLSModeType) *v1beta1.TLSModeType {
return &t
}

// GetBoolPointer takes a bool and returns a pointer to it.
func GetBoolPointer(b bool) *bool {
return &b
}

// GetPointer takes a value of any type and returns a pointer to it.
func GetPointer[T any](v T) *T {
return &v
Expand Down
4 changes: 2 additions & 2 deletions internal/framework/status/updater_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -210,9 +210,9 @@ var _ = Describe("Updater", func() {
{
ControllerName: v1beta1.GatewayController(gatewayCtrlName),
ParentRef: v1beta1.ParentReference{
Namespace: (*v1beta1.Namespace)(helpers.GetStringPointer("test")),
Namespace: (*v1beta1.Namespace)(helpers.GetPointer("test")),
Name: "gateway",
SectionName: (*v1beta1.SectionName)(helpers.GetStringPointer("http")),
SectionName: (*v1beta1.SectionName)(helpers.GetPointer("http")),
},
Conditions: status.CreateExpectedAPIConditions("Test", 5, fakeClockTime),
},
Expand Down
24 changes: 12 additions & 12 deletions internal/mode/static/state/dataplane/configuration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ func TestBuildConfiguration(t *testing.T) {
Matches: []v1beta1.HTTPRouteMatch{
{
Path: &v1beta1.HTTPPathMatch{
Value: helpers.GetStringPointer(p.path),
Value: helpers.GetPointer(p.path),
Type: helpers.GetPointer(p.pathType),
},
},
Expand All @@ -48,9 +48,9 @@ func TestBuildConfiguration(t *testing.T) {
CommonRouteSpec: v1beta1.CommonRouteSpec{
ParentRefs: []v1beta1.ParentReference{
{
Namespace: (*v1beta1.Namespace)(helpers.GetStringPointer("test")),
Namespace: (*v1beta1.Namespace)(helpers.GetPointer("test")),
Name: "gateway",
SectionName: (*v1beta1.SectionName)(helpers.GetStringPointer(listenerName)),
SectionName: (*v1beta1.SectionName)(helpers.GetPointer(listenerName)),
},
},
},
Expand Down Expand Up @@ -218,7 +218,7 @@ func TestBuildConfiguration(t *testing.T) {
redirect := v1beta1.HTTPRouteFilter{
Type: v1beta1.HTTPRouteFilterRequestRedirect,
RequestRedirect: &v1beta1.HTTPRequestRedirectFilter{
Hostname: (*v1beta1.PreciseHostname)(helpers.GetStringPointer("foo.example.com")),
Hostname: (*v1beta1.PreciseHostname)(helpers.GetPointer("foo.example.com")),
},
}
addFilters(hr5, []v1beta1.HTTPRouteFilter{redirect})
Expand Down Expand Up @@ -347,10 +347,10 @@ func TestBuildConfiguration(t *testing.T) {
Port: 443,
Protocol: v1beta1.HTTPSProtocolType,
TLS: &v1beta1.GatewayTLSConfig{
Mode: helpers.GetTLSModePointer(v1beta1.TLSModeTerminate),
Mode: helpers.GetPointer(v1beta1.TLSModeTerminate),
CertificateRefs: []v1beta1.SecretObjectReference{
{
Kind: (*v1beta1.Kind)(helpers.GetStringPointer("Secret")),
Kind: (*v1beta1.Kind)(helpers.GetPointer("Secret")),
Namespace: helpers.GetPointer(v1beta1.Namespace(secret1NsName.Namespace)),
Name: v1beta1.ObjectName(secret1NsName.Name),
},
Expand All @@ -364,10 +364,10 @@ func TestBuildConfiguration(t *testing.T) {
Port: 8443,
Protocol: v1beta1.HTTPSProtocolType,
TLS: &v1beta1.GatewayTLSConfig{
Mode: helpers.GetTLSModePointer(v1beta1.TLSModeTerminate),
Mode: helpers.GetPointer(v1beta1.TLSModeTerminate),
CertificateRefs: []v1beta1.SecretObjectReference{
{
Kind: (*v1beta1.Kind)(helpers.GetStringPointer("Secret")),
Kind: (*v1beta1.Kind)(helpers.GetPointer("Secret")),
Namespace: helpers.GetPointer(v1beta1.Namespace(secret2NsName.Namespace)),
Name: v1beta1.ObjectName(secret2NsName.Name),
},
Expand All @@ -383,10 +383,10 @@ func TestBuildConfiguration(t *testing.T) {
Port: 443,
Protocol: v1beta1.HTTPSProtocolType,
TLS: &v1beta1.GatewayTLSConfig{
Mode: helpers.GetTLSModePointer(v1beta1.TLSModeTerminate),
Mode: helpers.GetPointer(v1beta1.TLSModeTerminate),
CertificateRefs: []v1beta1.SecretObjectReference{
{
Kind: (*v1beta1.Kind)(helpers.GetStringPointer("Secret")),
Kind: (*v1beta1.Kind)(helpers.GetPointer("Secret")),
Namespace: helpers.GetPointer(v1beta1.Namespace(secret2NsName.Namespace)),
Name: v1beta1.ObjectName(secret2NsName.Name),
},
Expand Down Expand Up @@ -1506,7 +1506,7 @@ func TestGetPath(t *testing.T) {
msg string
}{
{
path: &v1beta1.HTTPPathMatch{Value: helpers.GetStringPointer("/abc")},
path: &v1beta1.HTTPPathMatch{Value: helpers.GetPointer("/abc")},
expected: "/abc",
msg: "normal case",
},
Expand All @@ -1521,7 +1521,7 @@ func TestGetPath(t *testing.T) {
msg: "nil value",
},
{
path: &v1beta1.HTTPPathMatch{Value: helpers.GetStringPointer("")},
path: &v1beta1.HTTPPathMatch{Value: helpers.GetPointer("")},
expected: "/",
msg: "empty value",
},
Expand Down
36 changes: 18 additions & 18 deletions internal/mode/static/state/graph/gateway_listener_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,22 +49,22 @@ func TestValidateHTTPSListener(t *testing.T) {
secretNs := "secret-ns"

validSecretRef := v1beta1.SecretObjectReference{
Kind: (*v1beta1.Kind)(helpers.GetStringPointer("Secret")),
Kind: (*v1beta1.Kind)(helpers.GetPointer("Secret")),
Name: "secret",
Namespace: (*v1beta1.Namespace)(helpers.GetStringPointer(secretNs)),
Namespace: (*v1beta1.Namespace)(helpers.GetPointer(secretNs)),
}

invalidSecretRefGroup := v1beta1.SecretObjectReference{
Group: (*v1beta1.Group)(helpers.GetStringPointer("some-group")),
Kind: (*v1beta1.Kind)(helpers.GetStringPointer("Secret")),
Group: (*v1beta1.Group)(helpers.GetPointer("some-group")),
Kind: (*v1beta1.Kind)(helpers.GetPointer("Secret")),
Name: "secret",
Namespace: (*v1beta1.Namespace)(helpers.GetStringPointer(secretNs)),
Namespace: (*v1beta1.Namespace)(helpers.GetPointer(secretNs)),
}

invalidSecretRefKind := v1beta1.SecretObjectReference{
Kind: (*v1beta1.Kind)(helpers.GetStringPointer("ConfigMap")),
Kind: (*v1beta1.Kind)(helpers.GetPointer("ConfigMap")),
Name: "secret",
Namespace: (*v1beta1.Namespace)(helpers.GetStringPointer(secretNs)),
Namespace: (*v1beta1.Namespace)(helpers.GetPointer(secretNs)),
}

tests := []struct {
Expand All @@ -76,7 +76,7 @@ func TestValidateHTTPSListener(t *testing.T) {
l: v1beta1.Listener{
Port: 443,
TLS: &v1beta1.GatewayTLSConfig{
Mode: helpers.GetTLSModePointer(v1beta1.TLSModeTerminate),
Mode: helpers.GetPointer(v1beta1.TLSModeTerminate),
CertificateRefs: []v1beta1.SecretObjectReference{validSecretRef},
},
},
Expand All @@ -87,7 +87,7 @@ func TestValidateHTTPSListener(t *testing.T) {
l: v1beta1.Listener{
Port: 0,
TLS: &v1beta1.GatewayTLSConfig{
Mode: helpers.GetTLSModePointer(v1beta1.TLSModeTerminate),
Mode: helpers.GetPointer(v1beta1.TLSModeTerminate),
CertificateRefs: []v1beta1.SecretObjectReference{validSecretRef},
},
},
Expand All @@ -98,7 +98,7 @@ func TestValidateHTTPSListener(t *testing.T) {
l: v1beta1.Listener{
Port: 443,
TLS: &v1beta1.GatewayTLSConfig{
Mode: helpers.GetTLSModePointer(v1beta1.TLSModeTerminate),
Mode: helpers.GetPointer(v1beta1.TLSModeTerminate),
CertificateRefs: []v1beta1.SecretObjectReference{validSecretRef},
Options: map[v1beta1.AnnotationKey]v1beta1.AnnotationValue{"key": "val"},
},
Expand All @@ -110,7 +110,7 @@ func TestValidateHTTPSListener(t *testing.T) {
l: v1beta1.Listener{
Port: 443,
TLS: &v1beta1.GatewayTLSConfig{
Mode: helpers.GetTLSModePointer(v1beta1.TLSModePassthrough),
Mode: helpers.GetPointer(v1beta1.TLSModePassthrough),
CertificateRefs: []v1beta1.SecretObjectReference{validSecretRef},
},
},
Expand All @@ -123,7 +123,7 @@ func TestValidateHTTPSListener(t *testing.T) {
l: v1beta1.Listener{
Port: 443,
TLS: &v1beta1.GatewayTLSConfig{
Mode: helpers.GetTLSModePointer(v1beta1.TLSModeTerminate),
Mode: helpers.GetPointer(v1beta1.TLSModeTerminate),
CertificateRefs: []v1beta1.SecretObjectReference{invalidSecretRefGroup},
},
},
Expand All @@ -136,7 +136,7 @@ func TestValidateHTTPSListener(t *testing.T) {
l: v1beta1.Listener{
Port: 443,
TLS: &v1beta1.GatewayTLSConfig{
Mode: helpers.GetTLSModePointer(v1beta1.TLSModeTerminate),
Mode: helpers.GetPointer(v1beta1.TLSModeTerminate),
CertificateRefs: []v1beta1.SecretObjectReference{invalidSecretRefKind},
},
},
Expand All @@ -149,7 +149,7 @@ func TestValidateHTTPSListener(t *testing.T) {
l: v1beta1.Listener{
Port: 443,
TLS: &v1beta1.GatewayTLSConfig{
Mode: helpers.GetTLSModePointer(v1beta1.TLSModeTerminate),
Mode: helpers.GetPointer(v1beta1.TLSModeTerminate),
CertificateRefs: []v1beta1.SecretObjectReference{validSecretRef, validSecretRef},
},
},
Expand Down Expand Up @@ -184,22 +184,22 @@ func TestValidateListenerHostname(t *testing.T) {
name: "nil hostname",
},
{
hostname: (*v1beta1.Hostname)(helpers.GetStringPointer("")),
hostname: (*v1beta1.Hostname)(helpers.GetPointer("")),
expectErr: false,
name: "empty hostname",
},
{
hostname: (*v1beta1.Hostname)(helpers.GetStringPointer("foo.example.com")),
hostname: (*v1beta1.Hostname)(helpers.GetPointer("foo.example.com")),
expectErr: false,
name: "valid hostname",
},
{
hostname: (*v1beta1.Hostname)(helpers.GetStringPointer("*.example.com")),
hostname: (*v1beta1.Hostname)(helpers.GetPointer("*.example.com")),
expectErr: false,
name: "wildcard hostname",
},
{
hostname: (*v1beta1.Hostname)(helpers.GetStringPointer("example$com")),
hostname: (*v1beta1.Hostname)(helpers.GetPointer("example$com")),
expectErr: true,
name: "invalid hostname",
},
Expand Down
14 changes: 7 additions & 7 deletions internal/mode/static/state/graph/graph_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ func TestBuildGraph(t *testing.T) {
CommonRouteSpec: v1beta1.CommonRouteSpec{
ParentRefs: []v1beta1.ParentReference{
{
Namespace: (*v1beta1.Namespace)(helpers.GetStringPointer("test")),
Namespace: (*v1beta1.Namespace)(helpers.GetPointer("test")),
Name: v1beta1.ObjectName(gatewayName),
SectionName: (*v1beta1.SectionName)(helpers.GetStringPointer(listenerName)),
SectionName: (*v1beta1.SectionName)(helpers.GetPointer(listenerName)),
},
},
},
Expand All @@ -55,18 +55,18 @@ func TestBuildGraph(t *testing.T) {
{
Path: &v1beta1.HTTPPathMatch{
Type: helpers.GetPointer(v1beta1.PathMatchPathPrefix),
Value: helpers.GetStringPointer("/"),
Value: helpers.GetPointer("/"),
},
},
},
BackendRefs: []v1beta1.HTTPBackendRef{
{
BackendRef: v1beta1.BackendRef{
BackendObjectReference: v1beta1.BackendObjectReference{
Kind: (*v1beta1.Kind)(helpers.GetStringPointer("Service")),
Kind: (*v1beta1.Kind)(helpers.GetPointer("Service")),
Name: "foo",
Namespace: (*v1beta1.Namespace)(helpers.GetStringPointer("service")),
Port: (*v1beta1.PortNumber)(helpers.GetInt32Pointer(80)),
Namespace: (*v1beta1.Namespace)(helpers.GetPointer("service")),
Port: (*v1beta1.PortNumber)(helpers.GetPointer[int32](80)),
},
},
},
Expand Down Expand Up @@ -134,7 +134,7 @@ func TestBuildGraph(t *testing.T) {
Hostname: nil,
Port: 443,
TLS: &v1beta1.GatewayTLSConfig{
Mode: helpers.GetTLSModePointer(v1beta1.TLSModeTerminate),
Mode: helpers.GetPointer(v1beta1.TLSModeTerminate),
CertificateRefs: []v1beta1.SecretObjectReference{
{
Kind: helpers.GetPointer[v1beta1.Kind]("Secret"),
Expand Down
2 changes: 1 addition & 1 deletion internal/mode/static/state/graph/httproute_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -540,7 +540,7 @@ func TestBindRouteToListeners(t *testing.T) {
return &Listener{
Source: v1beta1.Listener{
Name: v1beta1.SectionName(name),
Hostname: (*v1beta1.Hostname)(helpers.GetStringPointer("foo.example.com")),
Hostname: (*v1beta1.Hostname)(helpers.GetPointer("foo.example.com")),
},
Valid: true,
Routes: map[types.NamespacedName]*Route{},
Expand Down
4 changes: 2 additions & 2 deletions internal/mode/static/state/relationship/capturer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ func createBackendRefs(backendNames ...v1beta1.ObjectName) []v1beta1.HTTPBackend
refs = append(refs, v1beta1.HTTPBackendRef{
BackendRef: v1beta1.BackendRef{
BackendObjectReference: v1beta1.BackendObjectReference{
Kind: (*v1beta1.Kind)(helpers.GetStringPointer("Service")),
Kind: (*v1beta1.Kind)(helpers.GetPointer("Service")),
Name: name,
Namespace: (*v1beta1.Namespace)(helpers.GetStringPointer("test")),
Namespace: (*v1beta1.Namespace)(helpers.GetPointer("test")),
},
},
})
Expand Down
16 changes: 8 additions & 8 deletions internal/mode/static/state/relationship/relationships_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ func TestGetBackendServiceNamesFromRoute(t *testing.T) {
{
BackendRef: v1beta1.BackendRef{
BackendObjectReference: v1beta1.BackendObjectReference{
Kind: (*v1beta1.Kind)(helpers.GetStringPointer("Service")),
Kind: (*v1beta1.Kind)(helpers.GetPointer("Service")),
Name: svcName,
Namespace: (*v1beta1.Namespace)(helpers.GetStringPointer("test")),
Port: (*v1beta1.PortNumber)(helpers.GetInt32Pointer(80)),
Namespace: (*v1beta1.Namespace)(helpers.GetPointer("test")),
Port: (*v1beta1.PortNumber)(helpers.GetPointer[int32](80)),
},
},
},
Expand Down Expand Up @@ -48,7 +48,7 @@ func TestGetBackendServiceNamesFromRoute(t *testing.T) {
BackendRefs: getModifiedRefs(
"invalid-kind",
func(refs []v1beta1.HTTPBackendRef) []v1beta1.HTTPBackendRef {
refs[0].Kind = (*v1beta1.Kind)(helpers.GetStringPointer("Invalid"))
refs[0].Kind = (*v1beta1.Kind)(helpers.GetPointer("Invalid"))
return refs
},
),
Expand All @@ -67,7 +67,7 @@ func TestGetBackendServiceNamesFromRoute(t *testing.T) {
"diff-namespace",
func(refs []v1beta1.HTTPBackendRef) []v1beta1.HTTPBackendRef {
refs[0].Namespace = (*v1beta1.Namespace)(
helpers.GetStringPointer("not-test"),
helpers.GetPointer("not-test"),
)
return refs
},
Expand All @@ -87,14 +87,14 @@ func TestGetBackendServiceNamesFromRoute(t *testing.T) {
BackendRef: v1beta1.BackendRef{
BackendObjectReference: v1beta1.BackendObjectReference{
Kind: (*v1beta1.Kind)(
helpers.GetStringPointer("Service"),
helpers.GetPointer("Service"),
),
Name: "multiple-refs2",
Namespace: (*v1beta1.Namespace)(
helpers.GetStringPointer("test"),
helpers.GetPointer("test"),
),
Port: (*v1beta1.PortNumber)(
helpers.GetInt32Pointer(80),
helpers.GetPointer[int32](80),
),
},
},
Expand Down
Loading