istio.io/istio@v0.0.0-20240520182934-d79c90f27776/pkg/test/framework/components/echo/kube/deployment_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 kube

import (
	"testing"

	"istio.io/api/annotation"
	testutil "istio.io/istio/pilot/test/util"
	"istio.io/istio/pkg/config/protocol"
	"istio.io/istio/pkg/test/framework/components/cluster"
	"istio.io/istio/pkg/test/framework/components/cluster/clusterboot"
	"istio.io/istio/pkg/test/framework/components/echo"
	"istio.io/istio/pkg/test/framework/components/namespace"
	"istio.io/istio/pkg/test/framework/config"
	"istio.io/istio/pkg/test/framework/resource"
)

func TestDeploymentYAML(t *testing.T) {
	testCase := []struct {
		name          string
		wantFilePath  string
		config        echo.Config
		revVerMap     resource.RevVerMap
		settings      func(*resource.Settings)
		compatibility bool
	}{
		{
			name:         "basic",
			wantFilePath: "testdata/basic.yaml",
			config: echo.Config{
				Service: "foo",
				Version: "bar",
				Ports: []echo.Port{
					{
						Name:         "http",
						Protocol:     protocol.HTTP,
						WorkloadPort: 8090,
						ServicePort:  8090,
					},
				},
			},
		},
		{
			name:         "two-workloads-one-nosidecar",
			wantFilePath: "testdata/two-workloads-one-nosidecar.yaml",
			config: echo.Config{
				Service: "foo",
				Ports: []echo.Port{
					{
						Name:         "http",
						Protocol:     protocol.HTTP,
						WorkloadPort: 8090,
						ServicePort:  8090,
					},
				},
				Subsets: []echo.SubsetConfig{
					{
						Version: "v1",
					},
					{
						Version:     "nosidecar",
						Annotations: map[string]string{annotation.SidecarInject.Name: "false"},
					},
				},
			},
		},
		{
			name:         "healthcheck-rewrite",
			wantFilePath: "testdata/healthcheck-rewrite.yaml",
			config: echo.Config{
				Service: "healthcheck",
				Ports: []echo.Port{{
					Name:         "http-8080",
					Protocol:     protocol.HTTP,
					ServicePort:  8080,
					WorkloadPort: 8080,
				}},
				Subsets: []echo.SubsetConfig{
					{
						Annotations: map[string]string{annotation.SidecarRewriteAppHTTPProbers.Name: "true"},
					},
				},
			},
		},
		{
			name:         "multiversion",
			wantFilePath: "testdata/multiversion.yaml",
			config: echo.Config{
				Service: "multiversion",
				Subsets: []echo.SubsetConfig{
					{
						Version: "v-istio",
					},
					{
						Version:     "v-legacy",
						Annotations: map[string]string{annotation.SidecarInject.Name: "false"},
					},
				},
				Ports: []echo.Port{
					{
						Name:         "http",
						Protocol:     protocol.HTTP,
						WorkloadPort: 8090,
						ServicePort:  8090,
					},
					{
						Name:         "tcp",
						Protocol:     protocol.TCP,
						WorkloadPort: 9000,
						ServicePort:  9000,
					},
					{
						Name:         "grpc",
						Protocol:     protocol.GRPC,
						WorkloadPort: 9090,
						ServicePort:  9090,
					},
				},
			},
		},
		{
			name:         "multiple-istio-versions",
			wantFilePath: "testdata/multiple-istio-versions.yaml",
			config: echo.Config{
				Service: "foo",
				Version: "bar",
				Ports: []echo.Port{
					{
						Name:         "http",
						Protocol:     protocol.HTTP,
						WorkloadPort: 8090,
						ServicePort:  8090,
					},
				},
			},
			revVerMap: resource.RevVerMap{
				"rev-a": resource.IstioVersion("1.9.0"),
				"rev-b": resource.IstioVersion("1.10.0"),
			},
			compatibility: true,
		},
		{
			name:         "multiple-istio-versions-no-proxy",
			wantFilePath: "testdata/multiple-istio-versions-no-proxy.yaml",
			config: echo.Config{
				Service: "foo",
				Version: "bar",
				Ports: []echo.Port{
					{
						Name:         "http",
						Protocol:     protocol.HTTP,
						WorkloadPort: 8090,
						ServicePort:  8090,
					},
				},
			},
			revVerMap: resource.RevVerMap{
				"rev-a": resource.IstioVersion("1.8.2"),
				"rev-b": resource.IstioVersion("1.9.0"),
			},
			compatibility: true,
		},
		{
			name:         "proxyless",
			wantFilePath: "testdata/proxyless.yaml",
			config: echo.Config{
				Service: "foo",
				Version: "bar",
				Subsets: []echo.SubsetConfig{{
					Annotations: map[string]string{annotation.InjectTemplates.Name: "grpc-agent"},
				}},
				Ports: []echo.Port{
					{
						Name:         "grpc",
						Protocol:     protocol.GRPC,
						WorkloadPort: 7070,
						ServicePort:  7070,
					},
				},
			},
		},
		{
			name:         "proxyless-custom-image",
			wantFilePath: "testdata/proxyless-custom-image.yaml",
			settings: func(s *resource.Settings) {
				s.CustomGRPCEchoImage = "grpc/echo:cpp"
			},
			config: echo.Config{
				Service: "foo",
				Version: "bar",
				Subsets: []echo.SubsetConfig{{
					Annotations: map[string]string{annotation.InjectTemplates.Name: "grpc-agent"},
				}},
				Ports: []echo.Port{
					{
						Name:         "grpc",
						Protocol:     protocol.GRPC,
						WorkloadPort: 7070,
						ServicePort:  7070,
					},
				},
			},
		},
		{
			name:         "disable-automount-sa",
			wantFilePath: "testdata/disable-automount-sa.yaml",
			config: echo.Config{
				Service: "foo",
				Version: "bar",
				Ports: []echo.Port{
					{
						Name:         "http",
						Protocol:     protocol.HTTP,
						WorkloadPort: 8090,
						ServicePort:  8090,
					},
				},
				ServiceAccount:          true,
				DisableAutomountSAToken: true,
			},
		},
	}
	for _, tc := range testCase {
		t.Run(tc.name, func(t *testing.T) {
			clusters, err := clusterboot.NewFactory().With(cluster.Config{
				Kind: cluster.Fake, Name: "cluster-0",
				Meta: config.Map{"majorVersion": 1, "minorVersion": 16},
			}).Build()
			if err != nil {
				t.Fatal(err)
			}
			tc.config.Cluster = clusters[0]
			if tc.config.Namespace == nil {
				tc.config.Namespace = namespace.Static("echo-ns")
			}
			if err := tc.config.FillDefaults(nil); err != nil {
				t.Errorf("failed filling in defaults: %v", err)
			}
			if !config.Parsed() {
				config.Parse()
			}
			settings := &resource.Settings{
				Revisions:     tc.revVerMap,
				Compatibility: tc.compatibility,
				Image: resource.ImageSettings{
					Hub:        "testing.hub",
					Tag:        "latest",
					PullPolicy: "Always",
					PullSecret: "testdata/secret.yaml",
				},
			}
			if tc.settings != nil {
				tc.settings(settings)
			}
			serviceYAML, err := GenerateService(tc.config)
			if err != nil {
				t.Errorf("failed to generate service %v", err)
			}
			deploymentYAML, err := GenerateDeployment(nil, tc.config, settings)
			if err != nil {
				t.Errorf("failed to generate deployment %v", err)
			}
			gotBytes := []byte(serviceYAML + "---" + deploymentYAML)
			wantedBytes := testutil.ReadGoldenFile(t, gotBytes, tc.wantFilePath)

			wantBytes := testutil.StripVersion(wantedBytes)
			gotBytes = testutil.StripVersion(gotBytes)

			testutil.RefreshGoldenFile(t, gotBytes, tc.wantFilePath)

			testutil.CompareBytes(t, gotBytes, wantBytes, tc.wantFilePath)
		})
	}
}