[installer]: move proxy loadbalancer annotations

Author: Simon Emms

install/installer/pkg/components/proxy/service.go

@@ -81,10 +81,10 @@ func service(ctx *common.RenderContext) ([]runtime.Object, error) {
 		service.Spec.Type = serviceType
 		if serviceType == corev1.ServiceTypeLoadBalancer {
 			service.Spec.LoadBalancerIP = loadBalancerIP
-		}
 
-		service.Annotations["external-dns.alpha.kubernetes.io/hostname"] = fmt.Sprintf("%s,*.%s,*.ws.%s", ctx.Config.Domain, ctx.Config.Domain, ctx.Config.Domain)
-		service.Annotations["cloud.google.com/neg"] = `{"exposed_ports": {"80":{},"443": {}}}`
+			service.Annotations["external-dns.alpha.kubernetes.io/hostname"] = fmt.Sprintf("%s,*.%s,*.ws.%s", ctx.Config.Domain, ctx.Config.Domain, ctx.Config.Domain)
+			service.Annotations["cloud.google.com/neg"] = `{"exposed_ports": {"80":{},"443": {}}}`
+		}
 
 		for k, v := range annotations {
 			service.Annotations[k] = v

install/installer/pkg/components/proxy/service_test.go

@@ -4,6 +4,7 @@
 package proxy
 
 import (
+	"fmt"
 	"testing"
 
 	"github.com/gitpod-io/gitpod/installer/pkg/common"
@@ -12,11 +13,12 @@ import (
 	"github.com/gitpod-io/gitpod/installer/pkg/config/versions"
 	"github.com/stretchr/testify/require"
 	corev1 "k8s.io/api/core/v1"
+	"k8s.io/utils/pointer"
 )
 
 func TestServiceLoadBalancerIP(t *testing.T) {
 	const loadBalancerIP = "123.456.789.0"
-	ctx := renderContextWithProxyConfig(t, &experimental.ProxyConfig{StaticIP: loadBalancerIP})
+	ctx := renderContextWithProxyConfig(t, &experimental.ProxyConfig{StaticIP: loadBalancerIP}, nil)
 
 	objects, err := service(ctx)
 	require.NoError(t, err)
@@ -28,24 +30,98 @@ func TestServiceLoadBalancerIP(t *testing.T) {
 }
 
 func TestServiceAnnotations(t *testing.T) {
-	annotations := map[string]string{"hello": "world"}
+	testCases := []struct {
+		Name        string
+		Annotations map[string]string
+		Components  *config.Components
+		Expect      func(ctx *common.RenderContext, svc *corev1.Service, annotations map[string]string)
+	}{
+		{
+			Name:        "Default to LoadBalancer",
+			Annotations: map[string]string{"hello": "world"},
+			Expect: func(ctx *common.RenderContext, svc *corev1.Service, annotations map[string]string) {
+				// Check standard load balancer annotations
+				annotations = loadBalancerAnnotations(ctx, annotations)
 
-	ctx := renderContextWithProxyConfig(t, &experimental.ProxyConfig{ServiceAnnotations: annotations})
+				for k, v := range annotations {
+					require.Equalf(t, annotations[k], svc.Annotations[k],
+						"expected to find annotation %q:%q on proxy service, but found %q:%q", k, v, k, svc.Annotations[k])
+				}
+			},
+		},
+		{
+			Name: "Set to LoadBalancer",
+			Components: &config.Components{
+				Proxy: &config.ProxyComponent{
+					Service: &config.ComponentTypeService{
+						ServiceType: (*corev1.ServiceType)(pointer.String(string(corev1.ServiceTypeLoadBalancer))),
+					},
+				},
+			},
+			Annotations: map[string]string{"hello": "world", "hello2": "world2"},
+			Expect: func(ctx *common.RenderContext, svc *corev1.Service, annotations map[string]string) {
+				// Check standard load balancer annotations
+				annotations = loadBalancerAnnotations(ctx, annotations)
 
-	objects, err := service(ctx)
-	require.NoError(t, err)
+				for k, v := range annotations {
+					require.Equalf(t, annotations[k], svc.Annotations[k],
+						"expected to find annotation %q:%q on proxy service, but found %q:%q", k, v, k, svc.Annotations[k])
+				}
+			},
+		},
+		{
+			Name: "Set to ClusterIP",
+			Components: &config.Components{
+				Proxy: &config.ProxyComponent{
+					Service: &config.ComponentTypeService{
+						ServiceType: (*corev1.ServiceType)(pointer.String(string(corev1.ServiceTypeClusterIP))),
+					},
+				},
+			},
+			Annotations: map[string]string{"hello": "world"},
+			Expect: func(ctx *common.RenderContext, svc *corev1.Service, annotations map[string]string) {
+				// Check standard load balancer annotations not present
+				lbAnnotations := loadBalancerAnnotations(ctx, make(map[string]string, 0))
 
-	require.Len(t, objects, 1, "must render only one object")
+				for k := range lbAnnotations {
+					require.NotContains(t, annotations, k)
+				}
 
-	svc := objects[0].(*corev1.Service)
-	for k, v := range annotations {
-		require.Equalf(t, annotations[k], svc.Annotations[k],
-			"expected to find annotation %q:%q on proxy service, but found %q:%q", k, v, k, svc.Annotations[k])
+				for k, v := range annotations {
+					require.Equalf(t, annotations[k], svc.Annotations[k],
+						"expected to find annotation %q:%q on proxy service, but found %q:%q", k, v, k, svc.Annotations[k])
+				}
+			},
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.Name, func(t *testing.T) {
+			ctx := renderContextWithProxyConfig(t, &experimental.ProxyConfig{ServiceAnnotations: testCase.Annotations}, testCase.Components)
+
+			objects, err := service(ctx)
+			require.NoError(t, err)
+
+			require.Len(t, objects, 1, "must render only one object")
+
+			svc := objects[0].(*corev1.Service)
+
+			testCase.Expect(ctx, svc, testCase.Annotations)
+		})
 	}
 }
 
-func renderContextWithProxyConfig(t *testing.T, proxyConfig *experimental.ProxyConfig) *common.RenderContext {
+func loadBalancerAnnotations(ctx *common.RenderContext, annotations map[string]string) map[string]string {
+	annotations["external-dns.alpha.kubernetes.io/hostname"] = fmt.Sprintf("%s,*.%s,*.ws.%s", ctx.Config.Domain, ctx.Config.Domain, ctx.Config.Domain)
+	annotations["cloud.google.com/neg"] = `{"exposed_ports": {"80":{},"443": {}}}`
+
+	return annotations
+}
+
+func renderContextWithProxyConfig(t *testing.T, proxyConfig *experimental.ProxyConfig, components *config.Components) *common.RenderContext {
 	ctx, err := common.NewRenderContext(config.Config{
+		Domain:     "some-domain",
+		Components: components,
 		Experimental: &experimental.Config{
 			WebApp: &experimental.WebAppConfig{
 				ProxyConfig: proxyConfig,