e2e.go

/*
Copyright 2014 The Kubernetes 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 main

import (
	"fmt"
	"io/ioutil"
	"log"
	"os"
	"os/exec"
	"path/filepath"
	"regexp"
	"strings"
	"time"

	"k8s.io/test-infra/kubetest/conformance"
	"k8s.io/test-infra/kubetest/dind"
	"k8s.io/test-infra/kubetest/util"
)

// Add more default --test_args as we migrate them
func argFields(args, dump, ipRange string) []string {
	f := strings.Fields(args)
	if dump != "" {
		f = util.SetFieldDefault(f, "--report-dir", dump)
		// Disable logdump within ginkgo as it'll be done in kubetest anyway now.
		f = util.SetFieldDefault(f, "--disable-log-dump", "true")
	}
	if ipRange != "" {
		f = util.SetFieldDefault(f, "--cluster-ip-range", ipRange)
	}
	return f
}

func run(deploy deployer, o options) error {
	if o.checkSkew {
		os.Setenv("KUBECTL", "./cluster/kubectl.sh --match-server-version")
	} else {
		os.Setenv("KUBECTL", "./cluster/kubectl.sh")
	}
	os.Setenv("KUBE_CONFIG_FILE", "config-test.sh")
	os.Setenv("KUBE_RUNTIME_CONFIG", o.runtimeConfig)

	dump := o.dump
	if dump != "" {
		if !filepath.IsAbs(dump) { // Directory may change
			wd, err := os.Getwd()
			if err != nil {
				return fmt.Errorf("failed to os.Getwd(): %v", err)
			}
			dump = filepath.Join(wd, dump)
		}
	}

	if o.up {
		if o.federation {
			if err := control.XmlWrap(&suite, "Federation TearDown Previous", fedDown); err != nil {
				return fmt.Errorf("error tearing down previous federation control plane: %v", err)
			}
		}
		if err := control.XmlWrap(&suite, "TearDown Previous", deploy.Down); err != nil {
			return fmt.Errorf("error tearing down previous cluster: %s", err)
		}
	}

	var err error
	var errs []error

	// Ensures that the cleanup/down action is performed exactly once.
	var (
		downDone           = false
		federationDownDone = false
	)

	var (
		beforeResources []byte
		upResources     []byte
		downResources   []byte
		afterResources  []byte
	)

	if o.checkLeaks {
		errs = util.AppendError(errs, control.XmlWrap(&suite, "listResources Before", func() error {
			beforeResources, err = listResources()
			return err
		}))
	}

	if o.up {
		// If we tried to bring the cluster up, make a courtesy
		// attempt to bring it down so we're not leaving resources around.
		if o.down {
			defer control.XmlWrap(&suite, "Deferred TearDown", func() error {
				if !downDone {
					return deploy.Down()
				}
				return nil
			})
			// Deferred statements are executed in last-in-first-out order, so
			// federation down defer must appear after the cluster teardown in
			// order to execute that before cluster teardown.
			if o.federation {
				defer control.XmlWrap(&suite, "Deferred Federation TearDown", func() error {
					if !federationDownDone {
						return fedDown()
					}
					return nil
				})
			}
		}
		// Start the cluster using this version.
		if err := control.XmlWrap(&suite, "Up", deploy.Up); err != nil {
			if dump != "" {
				control.XmlWrap(&suite, "DumpClusterLogs (--up failed)", func() error {
					// This frequently means the cluster does not exist.
					// Thus DumpClusterLogs() typically fails.
					// Therefore always return null for this scenarios.
					// TODO(fejta): report a green E in testgrid if it errors.
					deploy.DumpClusterLogs(dump, o.logexporterGCSPath)
					return nil
				})
			}
			return fmt.Errorf("starting e2e cluster: %s", err)
		}
		if o.federation {
			if err := control.XmlWrap(&suite, "Federation Up", fedUp); err != nil {
				control.XmlWrap(&suite, "dumpFederationLogs", func() error {
					return dumpFederationLogs(dump)
				})
				return fmt.Errorf("error starting federation: %s", err)
			}
		}

		// The dind deployer checks that the control plane is healthy.
		if !o.nodeTests && o.deployment != "dind" {
			// Check that the api is reachable before proceeding with further steps.
			errs = util.AppendError(errs, control.XmlWrap(&suite, "Check APIReachability", getKubectlVersion))
			if dump != "" {
				errs = util.AppendError(errs, control.XmlWrap(&suite, "list nodes", func() error {
					return listNodes(dump)
				}))
			}
		}
	}

	if o.checkLeaks {
		errs = util.AppendError(errs, control.XmlWrap(&suite, "listResources Up", func() error {
			upResources, err = listResources()
			return err
		}))
	}

	if o.upgradeArgs != "" {
		if err := control.XmlWrap(&suite, "test setup", deploy.TestSetup); err != nil {
			errs = util.AppendError(errs, err)
		} else {
			errs = util.AppendError(errs, control.XmlWrap(&suite, "UpgradeTest", func() error {
				// upgrade tests really only run one spec
				var env []string
				for _, v := range os.Environ() {
					if !strings.HasPrefix(v, "GINKGO_PARALLEL") {
						env = append(env, v)
					}
				}
				return skewTestEnv(env, argFields(o.upgradeArgs, dump, o.clusterIPRange), "upgrade", o.checkSkew)
			}))
		}
	}

	testArgs := argFields(o.testArgs, dump, o.clusterIPRange)
	if o.test {
		if err := control.XmlWrap(&suite, "test setup", deploy.TestSetup); err != nil {
			errs = util.AppendError(errs, err)
		} else if o.nodeTests {
			nodeArgs := strings.Fields(o.nodeArgs)
			errs = util.AppendError(errs, control.XmlWrap(&suite, "Node Tests", func() error {
				return nodeTest(nodeArgs, o.testArgs, o.nodeTestArgs, o.gcpProject, o.gcpZone)
			}))
		} else if o.deployment == "dind" {
			if err := control.XmlWrap(&suite, "IsUp", deploy.IsUp); err != nil {
				errs = util.AppendError(errs, err)
			}
			dep := deploy.(*dind.DindDeployer)
			tester, err := dep.NewTester()
			if err != nil {
				return err
			}
			errs = util.AppendError(errs, control.XmlWrap(&suite, "Test", func() error {
				return tester.Test()
			}))

		} else if o.deployment == "conformance" {
			if err := control.XmlWrap(&suite, "IsUp", deploy.IsUp); err != nil {
				errs = util.AppendError(errs, err)
			}
			tester, err := conformance.NewTester("", "", o.kubecfg, "", &o.testArgs, control)
			if err != nil {
				return err
			}
			errs = util.AppendError(errs, control.XmlWrap(&suite, "Test", func() error {
				return tester.Test("", "")
			}))

		} else {
			errs = util.AppendError(errs, control.XmlWrap(&suite, "kubectl version", getKubectlVersion))
			if o.skew {
				errs = util.AppendError(errs, control.XmlWrap(&suite, "SkewTest", func() error {
					return skewTest(testArgs, "skew", o.checkSkew)
				}))
			} else {
				if err := control.XmlWrap(&suite, "IsUp", deploy.IsUp); err != nil {
					errs = util.AppendError(errs, err)
				} else {
					if o.federation {
						errs = util.AppendError(errs, control.XmlWrap(&suite, "FederationTest", func() error {
							return federationTest(testArgs)
						}))
					} else {
						errs = util.AppendError(errs, control.XmlWrap(&suite, "Test", func() error {
							return test(testArgs)
						}))
					}
				}
			}
		}
	}

	if o.testCmd != "" {
		if err := control.XmlWrap(&suite, "test setup", deploy.TestSetup); err != nil {
			errs = util.AppendError(errs, err)
		} else {
			errs = util.AppendError(errs, control.XmlWrap(&suite, o.testCmdName, func() error {
				cmdLine := os.ExpandEnv(o.testCmd)
				return control.FinishRunning(exec.Command(cmdLine, o.testCmdArgs...))
			}))
		}
	}

	// TODO(bentheelder): consider remapping charts, etc to testCmd

	if o.kubemark {
		errs = util.AppendError(errs, control.XmlWrap(&suite, "Kubemark Overall", func() error {
			return kubemarkTest(testArgs, dump, o.kubemarkNodes)
		}))
	}

	if o.charts {
		errs = util.AppendError(errs, control.XmlWrap(&suite, "Helm Charts", chartsTest))
	}

	if o.perfTests {
		errs = util.AppendError(errs, control.XmlWrap(&suite, "Perf Tests", perfTest))
	}

	if dump != "" {
		errs = util.AppendError(errs, control.XmlWrap(&suite, "DumpClusterLogs", func() error {
			return deploy.DumpClusterLogs(dump, o.logexporterGCSPath)
		}))
		if o.federation {
			errs = util.AppendError(errs, control.XmlWrap(&suite, "dumpFederationLogs", func() error {
				return dumpFederationLogs(dump)
			}))
		}
	}

	if o.checkLeaks {
		errs = util.AppendError(errs, control.XmlWrap(&suite, "listResources Down", func() error {
			downResources, err = listResources()
			return err
		}))
	}

	if o.down {
		if o.federation {
			errs = util.AppendError(errs, control.XmlWrap(&suite, "Federation TearDown", func() error {
				if !federationDownDone {
					err := fedDown()
					if err != nil {
						return err
					}
					federationDownDone = true
				}
				return nil
			}))
		}
		errs = util.AppendError(errs, control.XmlWrap(&suite, "TearDown", func() error {
			if !downDone {
				err := deploy.Down()
				if err != nil {
					return err
				}
				downDone = true
			}
			return nil
		}))
	}

	// Save the state if we upped a new cluster without downing it
	// or we are turning up federated clusters without turning up
	// the federation control plane.
	if o.save != "" && ((!o.down && o.up) || (!o.federation && o.up && o.deployment != "none")) {
		errs = util.AppendError(errs, control.XmlWrap(&suite, "Save Cluster State", func() error {
			return saveState(o.save)
		}))
	}

	if o.checkLeaks {
		log.Print("Sleeping for 30 seconds...") // Wait for eventually consistent listing
		time.Sleep(30 * time.Second)
		if err := control.XmlWrap(&suite, "listResources After", func() error {
			afterResources, err = listResources()
			return err
		}); err != nil {
			errs = append(errs, err)
		} else {
			errs = util.AppendError(errs, control.XmlWrap(&suite, "diffResources", func() error {
				return diffResources(beforeResources, upResources, downResources, afterResources, dump)
			}))
		}
	}
	if len(errs) == 0 {
		if pub, ok := deploy.(publisher); ok {
			errs = util.AppendError(errs, pub.Publish())
		}
	}
	if len(errs) == 0 && o.publish != "" {
		errs = util.AppendError(errs, control.XmlWrap(&suite, "Publish version", func() error {
			// Use plaintext version file packaged with kubernetes.tar.gz
			v, err := ioutil.ReadFile("version")
			if err != nil {
				return err
			}
			log.Printf("Set %s version to %s", o.publish, string(v))
			return gcsWrite(o.publish, v)
		}))
	}

	if len(errs) != 0 {
		return fmt.Errorf("encountered %d errors: %v", len(errs), errs)
	}
	return nil
}

func getKubectlVersion() error {
	retries := 5
	for {
		_, err := control.Output(exec.Command("./cluster/kubectl.sh", "--match-server-version=false", "version"))
		if err == nil {
			return nil
		}
		retries--
		if retries == 0 {
			return err
		}
		log.Print("Failed to reach api. Sleeping for 10 seconds before retrying...")
		time.Sleep(10 * time.Second)
	}
}

func listNodes(dump string) error {
	b, err := control.Output(exec.Command("./cluster/kubectl.sh", "--match-server-version=false", "get", "nodes", "-oyaml"))
	if err != nil {
		return err
	}
	return ioutil.WriteFile(filepath.Join(dump, "nodes.yaml"), b, 0644)
}

func listKubemarkNodes(dump string) error {
	b, err := control.Output(exec.Command("./cluster/kubectl.sh", "--match-server-version=false", "--kubeconfig=./test/kubemark/resources/kubeconfig.kubemark", "get", "nodes", "-oyaml"))
	if err != nil {
		return err
	}
	return ioutil.WriteFile(filepath.Join(dump, "kubemark_nodes.yaml"), b, 0644)
}

func diffResources(before, clusterUp, clusterDown, after []byte, location string) error {
	if location == "" {
		var err error
		location, err = ioutil.TempDir("", "e2e-check-resources")
		if err != nil {
			return fmt.Errorf("Could not create e2e-check-resources temp dir: %s", err)
		}
	}

	var mode os.FileMode = 0664
	bp := filepath.Join(location, "gcp-resources-before.txt")
	up := filepath.Join(location, "gcp-resources-cluster-up.txt")
	cdp := filepath.Join(location, "gcp-resources-cluster-down.txt")
	ap := filepath.Join(location, "gcp-resources-after.txt")
	dp := filepath.Join(location, "gcp-resources-diff.txt")

	if err := ioutil.WriteFile(bp, before, mode); err != nil {
		return err
	}
	if err := ioutil.WriteFile(up, clusterUp, mode); err != nil {
		return err
	}
	if err := ioutil.WriteFile(cdp, clusterDown, mode); err != nil {
		return err
	}
	if err := ioutil.WriteFile(ap, after, mode); err != nil {
		return err
	}

	stdout, cerr := control.Output(exec.Command("diff", "-sw", "-U0", "-F^\\[.*\\]$", bp, ap))
	if err := ioutil.WriteFile(dp, stdout, mode); err != nil {
		return err
	}
	if cerr == nil { // No diffs
		return nil
	}
	lines := strings.Split(string(stdout), "\n")
	if len(lines) < 3 { // Ignore the +++ and --- header lines
		return nil
	}
	lines = lines[2:]

	var added, report []string
	resourceTypeRE := regexp.MustCompile(`^@@.+\s(\[\s\S+\s\])$`)
	for _, l := range lines {
		if matches := resourceTypeRE.FindStringSubmatch(l); matches != nil {
			report = append(report, matches[1])
		}
		if strings.HasPrefix(l, "+") && len(strings.TrimPrefix(l, "+")) > 0 {
			added = append(added, l)
			report = append(report, l)
		}
	}
	if len(added) > 0 {
		return fmt.Errorf("Error: %d leaked resources\n%v", len(added), strings.Join(report, "\n"))
	}
	return nil
}

func listResources() ([]byte, error) {
	log.Printf("Listing resources...")
	stdout, err := control.Output(exec.Command("./cluster/gce/list-resources.sh"))
	if err != nil {
		return stdout, fmt.Errorf("Failed to list resources (%s):\n%s", err, string(stdout))
	}
	return stdout, err
}

func clusterSize(deploy deployer) (int, error) {
	if err := deploy.TestSetup(); err != nil {
		return -1, err
	}
	o, err := control.Output(exec.Command("kubectl", "get", "nodes", "--no-headers"))
	if err != nil {
		log.Printf("kubectl get nodes failed: %s\n%s", wrapError(err).Error(), string(o))
		return -1, err
	}
	stdout := strings.TrimSpace(string(o))
	log.Printf("Cluster nodes:\n%s", stdout)
	return len(strings.Split(stdout, "\n")), nil
}

// commandError will provide stderr output (if available) from structured
// exit errors
type commandError struct {
	err error
}

func wrapError(err error) *commandError {
	if err == nil {
		return nil
	}
	return &commandError{err: err}
}

func (e *commandError) Error() string {
	if e == nil {
		return ""
	}
	exitErr, ok := e.err.(*exec.ExitError)
	if !ok {
		return e.err.Error()
	}

	stderr := ""
	if exitErr.Stderr != nil {
		stderr = string(stderr)
	}
	return fmt.Sprintf("%q: %q", exitErr.Error(), stderr)
}

func isUp(d deployer) error {
	n, err := clusterSize(d)
	if err != nil {
		return err
	}
	if n <= 0 {
		return fmt.Errorf("cluster found, but %d nodes reported", n)
	}
	return nil
}

func defaultDumpClusterLogs(localArtifactsDir, logexporterGCSPath string) error {
	logDumpPath := "./cluster/log-dump/log-dump.sh"
	// cluster/log-dump/log-dump.sh only exists in the Kubernetes tree
	// post-1.3. If it doesn't exist, print a debug log but do not report an error.
	if _, err := os.Stat(logDumpPath); err != nil {
		log.Printf("Could not find %s. This is expected if running tests against a Kubernetes 1.3 or older tree.", logDumpPath)
		if cwd, err := os.Getwd(); err == nil {
			log.Printf("CWD: %v", cwd)
		}
		return nil
	}
	var cmd *exec.Cmd
	if logexporterGCSPath != "" {
		log.Printf("Dumping logs from nodes to GCS directly at path: %v", logexporterGCSPath)
		cmd = exec.Command(logDumpPath, localArtifactsDir, logexporterGCSPath)
	} else {
		log.Printf("Dumping logs locally to: %v", localArtifactsDir)
		cmd = exec.Command(logDumpPath, localArtifactsDir)
	}
	return control.FinishRunning(cmd)
}

func dumpFederationLogs(location string) error {
	// TODO(shashidharatd): Remove below logic of choosing the scripts to run from federation
	// repo once the k8s deployment in federation jobs moves to kubernetes-anywhere
	var logDumpPath string
	if useFederationRepo() {
		logDumpPath = "../federation/deploy/cluster/log-dump.sh"
	} else {
		logDumpPath = "./federation/cluster/log-dump.sh"
	}
	// federation/cluster/log-dump.sh only exists in the Kubernetes tree
	// post-1.6. If it doesn't exist, do nothing and do not report an error.
	if _, err := os.Stat(logDumpPath); err == nil {
		log.Printf("Dumping Federation logs to: %v", location)
		return control.FinishRunning(exec.Command(logDumpPath, location))
	}
	log.Printf("Could not find %s. This is expected if running tests against a Kubernetes 1.6 or older tree.", logDumpPath)
	return nil
}

func perfTest() error {
	// Run perf tests
	cmdline := util.K8s("perf-tests", "clusterloader", "run-e2e.sh")
	if err := control.FinishRunning(exec.Command(cmdline)); err != nil {
		return err
	}
	return nil
}

func chartsTest() error {
	// Run helm tests.
	cmdline := util.K8s("charts", "test", "helm-test-e2e.sh")
	return control.FinishRunning(exec.Command(cmdline))
}

func nodeTest(nodeArgs []string, testArgs, nodeTestArgs, project, zone string) error {
	// Run node e2e tests.
	// TODO(krzyzacy): remove once nodeTest is stable
	if wd, err := os.Getwd(); err == nil {
		log.Printf("cwd : %s", wd)
	}

	sshKeyPath := os.Getenv("JENKINS_GCE_SSH_PRIVATE_KEY_FILE")
	if _, err := os.Stat(sshKeyPath); err != nil {
		return fmt.Errorf("Cannot find ssh key from: %v, err : %v", sshKeyPath, err)
	}

	// prep node args
	runner := []string{
		"run",
		util.K8s("kubernetes", "test", "e2e_node", "runner", "remote", "run_remote.go"),
		"--cleanup",
		"--logtostderr",
		"--vmodule=*=4",
		"--ssh-env=gce",
		fmt.Sprintf("--results-dir=%s/_artifacts", os.Getenv("WORKSPACE")),
		fmt.Sprintf("--project=%s", project),
		fmt.Sprintf("--zone=%s", zone),
		fmt.Sprintf("--ssh-user=%s", os.Getenv("USER")),
		fmt.Sprintf("--ssh-key=%s", sshKeyPath),
		fmt.Sprintf("--ginkgo-flags=%s", testArgs),
		fmt.Sprintf("--test_args=%s", nodeTestArgs),
		fmt.Sprintf("--test-timeout=%s", timeout.String()),
	}

	runner = append(runner, nodeArgs...)

	return control.FinishRunning(exec.Command("go", runner...))
}

func kubemarkTest(testArgs []string, dump, numNodes string) error {
	// Stop previously running kubemark cluster (if any).
	if err := control.XmlWrap(&suite, "Kubemark TearDown Previous", func() error {
		return control.FinishRunning(exec.Command("./test/kubemark/stop-kubemark.sh"))
	}); err != nil {
		return err
	}
	// If we tried to bring the Kubemark cluster up, make a courtesy
	// attempt to bring it down so we're not leaving resources around.
	//
	// TODO: We should try calling stop-kubemark exactly once. Though to
	// stop the leaking resources for now, we want to be on the safe side
	// and call it explicitly in defer if the other one is not called.
	defer control.XmlWrap(&suite, "Kubemark TearDown (Deferred)", func() error {
		return control.FinishRunning(exec.Command("./test/kubemark/stop-kubemark.sh"))
	})

	// Start kubemark cluster.
	if err := control.XmlWrap(&suite, "Kubemark Up", func() error {
		return control.FinishRunning(exec.Command("./test/kubemark/start-kubemark.sh"))
	}); err != nil {
		if dump != "" {
			control.XmlWrap(&suite, "Kubemark MasterLogDump (--up failed)", func() error {
				return control.FinishRunning(exec.Command("./test/kubemark/master-log-dump.sh", dump))
			})
		}
		return err
	}

	// Check kubemark apiserver reachability by listing all nodes.
	if dump != "" {
		control.XmlWrap(&suite, "list kubemark nodes", func() error {
			return listKubemarkNodes(dump)
		})
	}

	// Run tests on the kubemark cluster.
	if err := control.XmlWrap(&suite, "Kubemark Test", func() error {
		testArgs = util.SetFieldDefault(testArgs, "--ginkgo.focus", "starting\\s30\\pods")
		return control.FinishRunning(exec.Command("./test/kubemark/run-e2e-tests.sh", testArgs...))
	}); err != nil {
		if dump != "" {
			control.XmlWrap(&suite, "Kubemark MasterLogDump (--test failed)", func() error {
				return control.FinishRunning(exec.Command("./test/kubemark/master-log-dump.sh", dump))
			})
		}
		return err
	}

	// Dump logs from kubemark master.
	control.XmlWrap(&suite, "Kubemark MasterLogDump", func() error {
		return control.FinishRunning(exec.Command("./test/kubemark/master-log-dump.sh", dump))
	})

	// Stop the kubemark cluster.
	if err := control.XmlWrap(&suite, "Kubemark TearDown", func() error {
		return control.FinishRunning(exec.Command("./test/kubemark/stop-kubemark.sh"))
	}); err != nil {
		return err
	}

	return nil
}

// Runs tests in the kubernetes_skew directory, appending --report-prefix flag to the run
func skewTest(args []string, prefix string, checkSkew bool) error {
	return skewTestEnv(nil, args, prefix, checkSkew)
}

// Runs tests in the kubernetes_skew directory, appending --report-prefix flag to the run
func skewTestEnv(env, args []string, prefix string, checkSkew bool) error {
	// TODO(fejta): run this inside this kubetest process, do not spawn a new one.
	popS, err := util.Pushd("../kubernetes_skew")
	if err != nil {
		return err
	}
	defer popS()
	args = util.AppendField(args, "--report-prefix", prefix)
	cmd := exec.Command(
		"kubetest",
		"--test",
		"--test_args="+strings.Join(args, " "),
		fmt.Sprintf("--check-version-skew=%t", checkSkew),
	)
	cmd.Env = env
	return control.FinishRunning(cmd)
}

func test(testArgs []string) error {
	return control.FinishRunning(exec.Command("./hack/ginkgo-e2e.sh", testArgs...))
}