operator/pkg/translate/strategic_port_merge_test.go

// Copyright Istio Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package translate

import (
	"testing"
)

import (
	"github.com/google/go-cmp/cmp"
	v1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/util/intstr"
)

var (
	httpsPort = &v1.ServicePort{
		Name:       "https",
		Protocol:   v1.ProtocolTCP,
		Port:       443,
		TargetPort: intstr.IntOrString{IntVal: 8443},
	}
	quicPort = &v1.ServicePort{
		Name:       "http3-quic",
		Protocol:   v1.ProtocolUDP,
		Port:       443,
		TargetPort: intstr.IntOrString{IntVal: 8443},
	}
	httpPort = &v1.ServicePort{
		Name:       "http-port",
		Protocol:   v1.ProtocolTCP,
		Port:       80,
		TargetPort: intstr.IntOrString{IntVal: 8080},
	}
	httpNoProtoPort = &v1.ServicePort{
		Name:       "http-port",
		Port:       80,
		TargetPort: intstr.IntOrString{IntVal: 8080},
	}
	mysqlPort = &v1.ServicePort{
		Name:     "mysql-port",
		Protocol: v1.ProtocolTCP,
		Port:     3306,
	}
	istioHealthcheckPort = &v1.ServicePort{
		Name:     "status-port",
		Protocol: v1.ProtocolTCP,
		Port:     15021,
	}
	istioMetricsPort = &v1.ServicePort{
		Name:     "metrics-port",
		Protocol: v1.ProtocolTCP,
		Port:     15020,
	}
	httpBaseBarPort = &v1.ServicePort{
		Name:     "http-bar-base",
		Protocol: v1.ProtocolTCP,
		Port:     9000,
	}
	httpOverlayBarPort = &v1.ServicePort{
		Name:     "http-bar-overlay",
		Protocol: v1.ProtocolTCP,
		Port:     9000,
	}
	httpOverlayDiffProtocolBarPort = &v1.ServicePort{
		Name:     "http3-bar-overlay",
		Protocol: v1.ProtocolUDP,
		Port:     9000,
	}
	httpFooPort = &v1.ServicePort{
		Name:     "http-foo",
		Protocol: v1.ProtocolTCP,
		Port:     8080,
	}
	httpFooProtocolOmittedPort = &v1.ServicePort{
		Name: "http-foo",
		Port: 8080,
	}
)

func TestStrategicPortMergeByPortAndProtocol(t *testing.T) {
	for _, tt := range []struct {
		name                string
		basePorts           []*v1.ServicePort
		overlayPorts        []*v1.ServicePort
		expectedMergedPorts []*v1.ServicePort
	}{
		{
			name:                "both base and overlay are nil",
			basePorts:           nil,
			overlayPorts:        nil,
			expectedMergedPorts: nil,
		},
		{
			name:                "overlay is nil",
			basePorts:           []*v1.ServicePort{httpPort, httpsPort, quicPort},
			overlayPorts:        nil,
			expectedMergedPorts: []*v1.ServicePort{httpPort, httpsPort, quicPort},
		},
		{
			name:                "base is nil",
			basePorts:           nil,
			overlayPorts:        []*v1.ServicePort{httpPort, httpsPort, quicPort},
			expectedMergedPorts: []*v1.ServicePort{httpPort, httpsPort, quicPort},
		},
		{
			name:                "same base and overlay",
			basePorts:           []*v1.ServicePort{httpPort, httpsPort},
			overlayPorts:        []*v1.ServicePort{httpsPort, httpPort},
			expectedMergedPorts: []*v1.ServicePort{httpPort, httpsPort},
		},
		{
			name:                "base and overlay for the same port, different protocol",
			basePorts:           []*v1.ServicePort{httpPort, httpsPort, mysqlPort},
			overlayPorts:        []*v1.ServicePort{quicPort},
			expectedMergedPorts: []*v1.ServicePort{httpPort, httpsPort, mysqlPort, quicPort},
		},
		{
			name:                "base and overlay with different ports",
			basePorts:           []*v1.ServicePort{httpPort},
			overlayPorts:        []*v1.ServicePort{httpsPort},
			expectedMergedPorts: []*v1.ServicePort{httpPort, httpsPort},
		},
		{
			name:                "implicit ports",
			basePorts:           []*v1.ServicePort{httpPort},
			overlayPorts:        []*v1.ServicePort{httpNoProtoPort},
			expectedMergedPorts: []*v1.ServicePort{httpPort},
		},
		{
			name:                "status and metrics port are present",
			basePorts:           []*v1.ServicePort{istioHealthcheckPort, istioMetricsPort, httpsPort},
			overlayPorts:        []*v1.ServicePort{httpsPort, httpPort},
			expectedMergedPorts: []*v1.ServicePort{istioHealthcheckPort, istioMetricsPort, httpsPort, httpPort},
		},
		{
			name:                "status port is present",
			basePorts:           []*v1.ServicePort{istioHealthcheckPort, httpsPort, httpPort},
			overlayPorts:        []*v1.ServicePort{httpsPort, httpPort},
			expectedMergedPorts: []*v1.ServicePort{istioHealthcheckPort, httpsPort, httpPort},
		},
		{
			name:                "metrics port is present",
			basePorts:           []*v1.ServicePort{istioMetricsPort, httpsPort, httpPort},
			overlayPorts:        []*v1.ServicePort{httpsPort, httpPort},
			expectedMergedPorts: []*v1.ServicePort{istioMetricsPort, httpsPort, httpPort},
		},
		{
			name:                "overlay with port name changed",
			basePorts:           []*v1.ServicePort{httpBaseBarPort},
			overlayPorts:        []*v1.ServicePort{httpOverlayBarPort},
			expectedMergedPorts: []*v1.ServicePort{httpOverlayBarPort},
		},
		{
			name:                "overlay with different protocol",
			basePorts:           []*v1.ServicePort{httpBaseBarPort},
			overlayPorts:        []*v1.ServicePort{httpOverlayDiffProtocolBarPort},
			expectedMergedPorts: []*v1.ServicePort{httpBaseBarPort, httpOverlayDiffProtocolBarPort},
		},
		{
			name:                "same base and overlay with protocol omitted for overlay",
			basePorts:           []*v1.ServicePort{httpFooPort},
			overlayPorts:        []*v1.ServicePort{httpFooProtocolOmittedPort},
			expectedMergedPorts: []*v1.ServicePort{httpFooPort},
		},
		{
			name:                "same base and overlay with protocol omitted for base",
			basePorts:           []*v1.ServicePort{httpFooProtocolOmittedPort},
			overlayPorts:        []*v1.ServicePort{httpFooPort},
			expectedMergedPorts: []*v1.ServicePort{httpFooPort},
		},
	} {
		t.Run(tt.name, func(t *testing.T) {
			actualMergedPorts := strategicMergePorts(tt.basePorts, tt.overlayPorts)
			if diff := cmp.Diff(actualMergedPorts, tt.expectedMergedPorts); diff != "" {
				t.Fatalf("expected differs from actual. Diff:\n%s", diff)
			}
		})
	}
}