caching/vendor/knative.dev/pkg/test/e2e_flags.go

/*
Copyright 2018 The Knative 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.
*/

// This file contains logic to encapsulate flags which are needed to specify
// what cluster, etc. to use for e2e tests.

package test

import (
	"bytes"
	"flag"
	"fmt"
	"os"
	"os/user"
	"path"
	"sync"
	"text/template"

	_ "github.com/golang/glog" // Needed if glog and klog are to coexist
	"k8s.io/klog"
	"knative.dev/pkg/test/logging"
)

const (
	// e2eMetricExporter is the name for the metrics exporter logger
	e2eMetricExporter = "e2e-metrics"

	// The recommended default log level https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md
	klogDefaultLogLevel = "2"
)

var (
	flagsSetupOnce = &sync.Once{}
	klogFlags      = flag.NewFlagSet("klog", flag.ExitOnError)
	// Flags holds the command line flags or defaults for settings in the user's environment.
	// See EnvironmentFlags for a list of supported fields.
	Flags = initializeFlags()
)

// EnvironmentFlags define the flags that are needed to run the e2e tests.
type EnvironmentFlags struct {
	Cluster         string // K8s cluster (defaults to cluster in kubeconfig)
	Kubeconfig      string // Path to kubeconfig (defaults to ./kube/config)
	Namespace       string // K8s namespace (blank by default, to be overwritten by test suite)
	IngressEndpoint string // Host to use for ingress endpoint
	LogVerbose      bool   // Enable verbose logging
	EmitMetrics     bool   // Emit metrics
	ImageTemplate   string // Template to build the image reference (defaults to {{.Repository}}/{{.Name}}:{{.Tag}})
	DockerRepo      string // Docker repo (defaults to $KO_DOCKER_REPO)
	Tag             string // Tag for test images
}

func initializeFlags() *EnvironmentFlags {
	var f EnvironmentFlags
	flag.StringVar(&f.Cluster, "cluster", "",
		"Provide the cluster to test against. Defaults to the current cluster in kubeconfig.")

	var defaultKubeconfig string
	if usr, err := user.Current(); err == nil {
		defaultKubeconfig = path.Join(usr.HomeDir, ".kube/config")
	}

	flag.StringVar(&f.Kubeconfig, "kubeconfig", defaultKubeconfig,
		"Provide the path to the `kubeconfig` file you'd like to use for these tests. The `current-context` will be used.")

	flag.StringVar(&f.Namespace, "namespace", "",
		"Provide the namespace you would like to use for these tests.")

	flag.StringVar(&f.IngressEndpoint, "ingressendpoint", "", "Provide a static endpoint url to the ingress server used during tests.")

	flag.BoolVar(&f.LogVerbose, "logverbose", false,
		"Set this flag to true if you would like to see verbose logging.")

	flag.BoolVar(&f.EmitMetrics, "emitmetrics", false,
		"Set this flag to true if you would like tests to emit metrics, e.g. latency of resources being realized in the system.")

	flag.StringVar(&f.ImageTemplate, "imagetemplate", "{{.Repository}}/{{.Name}}:{{.Tag}}",
		"Provide a template to generate the reference to an image from the test. Defaults to `{{.Repository}}/{{.Name}}:{{.Tag}}`.")

	defaultRepo := os.Getenv("KO_DOCKER_REPO")
	flag.StringVar(&f.DockerRepo, "dockerrepo", defaultRepo,
		"Provide the uri of the docker repo you have uploaded the test image to using `uploadtestimage.sh`. Defaults to $KO_DOCKER_REPO")

	flag.StringVar(&f.Tag, "tag", "latest", "Provide the version tag for the test images.")

	klog.InitFlags(klogFlags)
	flag.Set("v", klogDefaultLogLevel)
	flag.Set("alsologtostderr", "true")

	return &f
}

func printFlags() {
	fmt.Print("Test Flags: {")
	flag.CommandLine.VisitAll(func(f *flag.Flag) {
		fmt.Printf("'%s': '%s', ", f.Name, f.Value.String())
	})
	fmt.Println("}")
}

// SetupLoggingFlags initializes the logging libraries at runtime
func SetupLoggingFlags() {
	flagsSetupOnce.Do(func() {
		// Sync the glog flags to klog
		flag.CommandLine.VisitAll(func(f1 *flag.Flag) {
			f2 := klogFlags.Lookup(f1.Name)
			if f2 != nil {
				value := f1.Value.String()
				f2.Value.Set(value)
			}
		})
		if Flags.LogVerbose {
			// If klog verbosity is not set to a non-default value (via "-args -v=X"),
			if flag.CommandLine.Lookup("v").Value.String() == klogDefaultLogLevel {
				// set up verbosity for klog so round_trippers.go prints:
				//   URL, request headers, response headers, and partial response body
				// See levels in vendor/k8s.io/client-go/transport/round_trippers.go:DebugWrappers for other options
				klogFlags.Set("v", "8")
				flag.Set("v", "8") // This is for glog, since glog=>klog sync is one-time
			}
			printFlags()
		}
		logging.InitializeLogger(Flags.LogVerbose)

		if Flags.EmitMetrics {
			logging.InitializeMetricExporter(e2eMetricExporter)
		}
	})
}

// ImagePath is a helper function to transform an image name into an image reference that can be pulled.
func ImagePath(name string) string {
	tpl, err := template.New("image").Parse(Flags.ImageTemplate)
	if err != nil {
		panic("could not parse image template: " + err.Error())
	}

	var buf bytes.Buffer
	if err := tpl.Execute(&buf, struct {
		Repository string
		Name       string
		Tag        string
	}{
		Repository: Flags.DockerRepo,
		Name:       name,
		Tag:        Flags.Tag,
	}); err != nil {
		panic("could not apply the image template: " + err.Error())
	}
	return buf.String()
}