linkerd2/test/integration/upgrade-stable/upgrade_stable_test.go

495 lines
16 KiB
Go

package stableupgradetest
import (
"bytes"
"context"
"errors"
"fmt"
"os"
"runtime"
"strings"
"testing"
"text/template"
"time"
"github.com/go-test/deep"
"github.com/linkerd/linkerd2/pkg/flags"
"github.com/linkerd/linkerd2/pkg/healthcheck"
"github.com/linkerd/linkerd2/pkg/k8s"
"github.com/linkerd/linkerd2/pkg/tree"
"github.com/linkerd/linkerd2/pkg/version"
"github.com/linkerd/linkerd2/testutil"
)
//////////////////////
/// TEST SETUP ///
//////////////////////
var (
TestHelper *testutil.TestHelper
configMapUID string
linkerdSvcStable = []testutil.Service{
{Namespace: "linkerd", Name: "linkerd-dst"},
{Namespace: "linkerd", Name: "linkerd-identity"},
{Namespace: "linkerd", Name: "linkerd-dst-headless"},
{Namespace: "linkerd", Name: "linkerd-identity-headless"},
}
// skippedInboundPorts lists some ports to be marked as skipped, which will
// be verified in test/integration/inject
skippedInboundPorts = "1234,5678"
skippedOutboundPorts = "1234,5678"
linkerdBaseStableVersion string
)
func TestMain(m *testing.M) {
TestHelper = testutil.NewTestHelper()
os.Exit(m.Run())
}
//////////////////////
/// TEST EXECUTION ///
//////////////////////
func TestInstallResourcesPreUpgrade(t *testing.T) {
versions, err := TestHelper.GetReleaseChannelVersions()
if err != nil {
testutil.AnnotatedFatal(t, "failed to get the latest release channels versions", err)
}
linkerdBaseStableVersion = versions["stable"]
tmpDir, err := os.MkdirTemp("", "upgrade-cli")
if err != nil {
testutil.AnnotatedFatal(t, "failed to create temp dir", err)
}
defer os.RemoveAll(tmpDir)
cliPath := fmt.Sprintf("%s/linkerd2-cli-%s-%s-%s", tmpDir, linkerdBaseStableVersion, runtime.GOOS, runtime.GOARCH)
if err := TestHelper.DownloadCLIBinary(cliPath, linkerdBaseStableVersion); err != nil {
testutil.AnnotatedFatal(t, "failed to fetch cli executable", err)
}
// Nest all pre-upgrade tests here so they can install and check resources
// using the latest stable CLI
t.Run(fmt.Sprintf("installing Linkerd %s control plane", linkerdBaseStableVersion), func(t *testing.T) {
args := []string{
"install",
"--controller-log-level", "debug",
"--set", "proxyInit.ignoreInboundPorts=1234\\,5678",
}
// Pipe cmd & args to `linkerd`
out, err := TestHelper.CmdRun(cliPath, args...)
if err != nil {
testutil.AnnotatedFatalf(t, "'linkerd install' command failed", "'linkerd install' command failed:\n%v", err)
}
out, err = TestHelper.KubectlApply(out, "")
if err != nil {
testutil.AnnotatedFatalf(t, "'kubectl apply' command failed",
"'kubectl apply' command failed\n%s", out)
}
TestHelper.WaitRollout(t, testutil.LinkerdDeployReplicasStable)
})
// TestInstallViz will install the viz extension to be used by the rest of the
// tests in the viz suite
t.Run(fmt.Sprintf("installing Linkerd %s viz extension", linkerdBaseStableVersion), func(t *testing.T) {
args := []string{
"viz",
"install",
"--set", fmt.Sprintf("namespace=%s", TestHelper.GetVizNamespace()),
}
out, err := TestHelper.CmdRun(cliPath, args...)
if err != nil {
testutil.AnnotatedFatal(t, "'linkerd viz install' command failed", err)
}
out, err = TestHelper.KubectlApplyWithArgs(out)
if err != nil {
testutil.AnnotatedFatalf(t, "'kubectl apply' command failed",
"'kubectl apply' command failed\n%s", out)
}
TestHelper.WaitRollout(t, testutil.LinkerdVizDeployReplicas)
TestHelper.AddInstalledExtension("viz")
})
// Check client and server versions are what we expect them to be
t.Run(fmt.Sprintf("check version is %s pre-upgrade", linkerdBaseStableVersion), func(t *testing.T) {
out, err := TestHelper.CmdRun(cliPath, "version")
if err != nil {
testutil.AnnotatedFatalf(t, "'linkerd version' command failed", "'linkerd version' command failed\n%s", err.Error())
}
if !strings.Contains(out, fmt.Sprintf("Client version: %s", linkerdBaseStableVersion)) {
testutil.AnnotatedFatalf(t, "'linkerd version' command failed", "'linkerd version' command failed\nexpected client version: %s, got: %s", linkerdBaseStableVersion, out)
}
if !strings.Contains(out, fmt.Sprintf("Server version: %s", linkerdBaseStableVersion)) {
testutil.AnnotatedFatalf(t, "'linkerd version' command failed", "'linkerd version' command failed\nexpected server version: %s, got: %s", linkerdBaseStableVersion, out)
}
})
}
func TestUpgradeTestAppWorksBeforeUpgrade(t *testing.T) {
ctx := context.Background()
testAppNamespace := "upgrade-test"
// create namespace and install test app
if err := TestHelper.CreateDataPlaneNamespaceIfNotExists(ctx, testAppNamespace, map[string]string{k8s.ProxyInjectAnnotation: "enabled"}); err != nil {
testutil.AnnotatedFatalf(t, "failed to create namespace", "failed to create namespace %s: %s", testAppNamespace, err)
}
if _, err := TestHelper.Kubectl("", "apply", "-f", "./testdata/emoji.yaml", "-n", testAppNamespace); err != nil {
testutil.AnnotatedFatalf(t, "'kubectl' apply failed", "'kubectl apply' failed: %s", err)
}
// make sure app is running
for _, deploy := range []string{"emoji", "voting", "web"} {
if err := TestHelper.CheckPods(ctx, testAppNamespace, deploy, 1); err != nil {
var rce *testutil.RestartCountError
if errors.As(err, &rce) {
testutil.AnnotatedWarn(t, "CheckPods timed-out", rce)
} else {
testutil.AnnotatedError(t, "CheckPods timed-out", err)
}
}
}
if err := testutil.ExerciseTestAppEndpoint("/api/list", testAppNamespace, TestHelper); err != nil {
testutil.AnnotatedFatalf(t, "error exercising test app endpoint before upgrade",
"error exercising test app endpoint before upgrade %s", err)
}
}
func TestRetrieveUidPreUpgrade(t *testing.T) {
var err error
configMapUID, err = TestHelper.KubernetesHelper.GetConfigUID(context.Background(), TestHelper.GetLinkerdNamespace())
if err != nil || configMapUID == "" {
testutil.AnnotatedFatalf(t, "error retrieving linkerd-config's uid",
"error retrieving linkerd-config's uid: %s", err)
}
}
func TestUpgradeCli(t *testing.T) {
cmd := "upgrade"
// Start by upgrading CRDs
args := []string{
"--crds",
"--controller-log-level", "debug",
"--set", "proxyInit.ignoreInboundPorts=1234\\,5678",
"--set", "heartbeatSchedule=1 2 3 4 5",
"--set", "proxyInit.ignoreOutboundPorts=1234\\,5678",
}
exec := append([]string{cmd}, args...)
out, err := TestHelper.LinkerdRun(exec...)
if err != nil {
testutil.AnnotatedFatal(t, "'linkerd upgrade --crds' command failed", err)
}
cmdOut, err := TestHelper.KubectlApply(out, "")
if err != nil {
testutil.AnnotatedFatalf(t, "'kubectl apply' command failed",
"'kubectl apply' command failed\n%s", cmdOut)
}
// Upgrade control plane.
args = []string{
"--controller-log-level", "debug",
"--set", "proxyInit.ignoreInboundPorts=1234\\,5678",
"--set", "heartbeatSchedule=1 2 3 4 5",
"--set", "proxyInit.ignoreOutboundPorts=1234\\,5678",
}
exec = append([]string{cmd}, args...)
out, err = TestHelper.LinkerdRun(exec...)
if err != nil {
testutil.AnnotatedFatal(t, "'linkerd upgrade' command failed", err)
}
// Limit the pruning only to known resources
// that we intend to be delete in this stage to prevent it
// from deleting other resources that have the
// label
cmdOut, err = TestHelper.KubectlApplyWithArgs(out, []string{
"--prune",
"-l", "linkerd.io/control-plane-ns=linkerd",
"--prune-whitelist", "apps/v1/deployment",
"--prune-whitelist", "core/v1/service",
"--prune-whitelist", "core/v1/configmap",
}...)
if err != nil {
testutil.AnnotatedFatalf(t, "'kubectl apply' command failed",
"'kubectl apply' command failed\n%s", cmdOut)
}
TestHelper.WaitRollout(t, testutil.LinkerdDeployReplicasStable)
// It is necessary to clone LinkerdVizDeployReplicas so that we do not
// mutate its original value.
expectedDeployments := make(map[string]testutil.DeploySpec)
for k, v := range testutil.LinkerdVizDeployReplicas {
expectedDeployments[k] = v
}
// Install Linkerd Viz Extension
vizCmd := []string{
"viz",
"install",
"--set", fmt.Sprintf("namespace=%s", TestHelper.GetVizNamespace()),
}
out, err = TestHelper.LinkerdRun(vizCmd...)
if err != nil {
testutil.AnnotatedFatal(t, "'linkerd viz install' command failed", err)
}
out, err = TestHelper.KubectlApplyWithArgs(out, []string{
"--prune",
"-l", "linkerd.io/extension=viz",
}...)
if err != nil {
testutil.AnnotatedFatalf(t, "'kubectl apply' command failed",
"'kubectl apply' command failed\n%s", out)
}
TestHelper.WaitRollout(t, expectedDeployments)
}
func TestControlPlaneResourcesPostInstall(t *testing.T) {
expectedDeployments := testutil.LinkerdDeployReplicasStable
expectedServices := linkerdSvcStable
vizServices := []testutil.Service{
{Namespace: "linkerd-viz", Name: "web"},
{Namespace: "linkerd-viz", Name: "tap"},
{Namespace: "linkerd-viz", Name: "prometheus"},
}
expectedServices = append(expectedServices, vizServices...)
expectedDeployments["prometheus"] = testutil.DeploySpec{Namespace: "linkerd-viz", Replicas: 1}
testutil.TestResourcesPostInstall(TestHelper.GetLinkerdNamespace(), expectedServices, expectedDeployments, TestHelper, t)
}
func TestRetrieveUidPostUpgrade(t *testing.T) {
newConfigMapUID, err := TestHelper.KubernetesHelper.GetConfigUID(context.Background(), TestHelper.GetLinkerdNamespace())
if err != nil || newConfigMapUID == "" {
testutil.AnnotatedFatalf(t, "error retrieving linkerd-config's uid",
"error retrieving linkerd-config's uid: %s", err)
}
if configMapUID != newConfigMapUID {
testutil.AnnotatedFatalf(t, "linkerd-config's uid after upgrade doesn't match its value before the upgrade",
"linkerd-config's uid after upgrade [%s] doesn't match its value before the upgrade [%s]",
newConfigMapUID, configMapUID,
)
}
}
func TestOverridesSecret(t *testing.T) {
configOverridesSecret, err := TestHelper.KubernetesHelper.GetSecret(context.Background(), TestHelper.GetLinkerdNamespace(), "linkerd-config-overrides")
if err != nil {
testutil.AnnotatedFatalf(t, "could not retrieve linkerd-config-overrides",
"could not retrieve linkerd-config-overrides\n%s", err)
}
overrides := configOverridesSecret.Data["linkerd-config-overrides"]
overridesTree, err := tree.BytesToTree(overrides)
if err != nil {
testutil.AnnotatedFatalf(t, "could not retrieve linkerd-config-overrides",
"could not retrieve linkerd-config-overrides\n%s", err)
}
// Check for fields that were added during install
testCases := []struct {
path []string
value string
}{
{
[]string{"controllerLogLevel"},
"debug",
},
{
[]string{"proxyInit", "ignoreInboundPorts"},
skippedInboundPorts,
},
{
[]string{"proxyInit", "ignoreOutboundPorts"},
skippedOutboundPorts,
},
}
for _, tc := range testCases {
tc := tc // pin
t.Run(fmt.Sprintf("%s: %s", strings.Join(tc.path, "/"), tc.value), func(t *testing.T) {
finalValue, err := overridesTree.GetString(tc.path...)
if err != nil {
testutil.AnnotatedFatalf(t, "could not perform tree.GetString",
"could not perform tree.GetString\n%s", err)
}
if tc.value != finalValue {
testutil.AnnotatedFatalf(t, fmt.Sprintf("Values at path %s do not match", strings.Join(tc.path, "/")),
"Expected value at [%s] to be [%s] but received [%s]",
strings.Join(tc.path, "/"), tc.value, finalValue)
}
})
}
extractValue := func(t *testing.T, path ...string) string {
val, err := overridesTree.GetString(path...)
if err != nil {
testutil.AnnotatedFatalf(t, "error calling overridesTree.GetString()",
"error calling overridesTree.GetString(): %s", err)
return ""
}
return val
}
t.Run("Check if any unknown fields snuck in", func(t *testing.T) {
knownKeys := tree.Tree{
"controllerLogLevel": "debug",
"heartbeatSchedule": "1 2 3 4 5",
"identity": tree.Tree{
"issuer": tree.Tree{
"tls": tree.Tree{
"crtPEM": extractValue(t, "identity", "issuer", "tls", "crtPEM"),
"keyPEM": extractValue(t, "identity", "issuer", "tls", "keyPEM"),
},
},
},
"identityTrustAnchorsPEM": extractValue(t, "identityTrustAnchorsPEM"),
"proxyInit": tree.Tree{
"ignoreInboundPorts": skippedInboundPorts,
"ignoreOutboundPorts": skippedOutboundPorts,
},
}
if reg := os.Getenv(flags.EnvOverrideDockerRegistry); reg != "" {
knownKeys["controllerImage"] = reg + "/controller"
knownKeys["debugContainer"] = tree.Tree{
"image": tree.Tree{
"name": reg + "/debug",
},
}
knownKeys["policyController"] = tree.Tree{
"image": tree.Tree{
"name": reg + "/policy-controller",
},
}
knownKeys["proxy"] = tree.Tree{
"image": tree.Tree{
"name": reg + "/proxy",
},
}
knownKeys["proxyInit"].(tree.Tree)["image"] = tree.Tree{
"name": reg + "/proxy-init",
}
}
// Check if the keys in overridesTree match with knownKeys
if diff := deep.Equal(overridesTree.String(), knownKeys.String()); diff != nil {
testutil.AnnotatedFatalf(t, "Overrides and knownKeys are different", "%+v", diff)
}
})
}
func TestVersionPostInstall(t *testing.T) {
err := TestHelper.CheckVersion(TestHelper.GetVersion())
if err != nil {
testutil.AnnotatedFatalf(t, "Version command failed",
"Version command failed\n%s", err.Error())
}
}
func TestCheckProxyPostUpgrade(t *testing.T) {
cmd := []string{
"check", "--proxy", "-n", TestHelper.GetLinkerdNamespace(),
"--expected-version", TestHelper.GetVersion(),
"--wait=60m",
}
expected := getCheckOutput(t, "check.upgrade.golden", TestHelper.GetVizNamespace())
// Check output is non-deterministic for proxies that are not running the
// current version. This tends to cause a mismatch between the expected
// output (which is templated) and the actual output. We add a retry to "eventually"
// get a match
err := TestHelper.RetryFor(5*time.Minute, func() error {
out, err := TestHelper.LinkerdRun(cmd...)
if err != nil {
return fmt.Errorf("%w\n%s", err, out)
}
if !strings.Contains(out, expected) {
return fmt.Errorf("expected: %s\nactual: %s", expected, out)
}
return nil
})
if err != nil {
testutil.AnnotatedFatalf(t, "'linkerd check' command timed-out", "'linkerd check' command timed-out\n%v", err)
}
}
func TestUpgradeTestAppWorksAfterUpgrade(t *testing.T) {
testAppNamespace := "upgrade-test"
// Restart pods after upgrade to make sure they're re-injected with the
// latest proxy
if _, err := TestHelper.Kubectl("", "rollout", "restart", "deploy", "-n", testAppNamespace); err != nil {
testutil.AnnotatedFatalf(t, "'kubectl rollout' failed", "'kubectl rollout' failed: %s", err)
}
// make sure app is running before proceeding
ctx := context.Background()
for _, deploy := range []string{"emoji", "voting", "web"} {
if err := TestHelper.CheckPods(ctx, testAppNamespace, deploy, 1); err != nil {
var rce *testutil.RestartCountError
if errors.As(err, &rce) {
testutil.AnnotatedWarn(t, "CheckPods timed-out", rce)
} else {
testutil.AnnotatedError(t, "CheckPods timed-out", err)
}
}
}
if err := testutil.ExerciseTestAppEndpoint("/api/vote?choice=:policeman:", testAppNamespace, TestHelper); err != nil {
testutil.AnnotatedFatalf(t, "error exercising test app endpoint after upgrade",
"error exercising test app endpoint after upgrade %s", err)
}
}
func getCheckOutput(t *testing.T, goldenFile string, namespace string) string {
pods, err := TestHelper.KubernetesHelper.GetPods(context.Background(), namespace, nil)
if err != nil {
testutil.AnnotatedFatal(t, fmt.Sprintf("failed to retrieve pods: %s", err), err)
}
proxyVersionErr := ""
err = healthcheck.CheckProxyVersionsUpToDate(pods, version.Channels{})
if err != nil {
proxyVersionErr = err.Error()
}
tpl := template.Must(template.ParseFiles("testdata" + "/" + goldenFile))
vars := struct {
ProxyVersionErr string
HintURL string
}{
proxyVersionErr,
healthcheck.HintBaseURL(TestHelper.GetVersion()),
}
var expected bytes.Buffer
if err := tpl.Execute(&expected, vars); err != nil {
testutil.AnnotatedFatal(t, fmt.Sprintf("failed to parse %s template: %s", goldenFile, err), err)
}
return expected.String()
}