util

package
v0.0.0-...-8729a88 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 26, 2022 License: Apache-2.0 Imports: 29 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// NodePortServiceType NodePort type of Kubernetes Service
	NodePortServiceType = "NodePort"

	// LoadBalancerServiceType LoadBalancer type of Kubernetes Service
	LoadBalancerServiceType = "LoadBalancer"
)

Variables

This section is empty.

Functions

func Backoff 

func Backoff(baseDelay, maxDelay time.Duration, retries int) time.Duration

Backoff returns a random value in [0, maxDelay] that increases exponentially with retries, starting from baseDelay. It is the Go equivalent to C++'s //util/time/backoff.cc.

func CheckAppDeployment 

func CheckAppDeployment(namespace, deployment string, timeout time.Duration, kubeconfig string) error

CheckAppDeployment checks whether or not an app in a namespace is ready

func CheckDeployment 

func CheckDeployment(ctx context.Context, namespace, deployment string, kubeconfig string) error

CheckDeployment gets status of a deployment from a namespace

func CheckDeploymentRemoved 

func CheckDeploymentRemoved(namespace, deployment string, kubeconfig string) error

CheckDeploymentRemoved waits until a deployment is removed or times out

func CheckDeployments 

func CheckDeployments(namespace string, timeout time.Duration, kubeconfig string) error

CheckDeployments checks whether all deployments in a given namespace are ready

func CheckDeploymentsReady 

func CheckDeploymentsReady(ns string, kubeconfig string) (int, error)

CheckDeploymentsReady checks if deployment resources are ready. get podsReady() sometimes gets pods created by the "Job" resource which never reach the "Running" steady state.

func CheckPodRunning 

func CheckPodRunning(n, name string, kubeconfig string) error

CheckPodRunning return if a given pod with labeled name in a namespace are in "Running" status

func CheckPodsRunning 

func CheckPodsRunning(n string, kubeconfig string) (ready bool)

CheckPodsRunning returns readiness of all pods within a namespace. It will wait for upto 2 mins. use WithMaxDuration to specify a duration.

func CheckPodsRunningWithMaxDuration 

func CheckPodsRunningWithMaxDuration(n string, maxDuration time.Duration, kubeconfig string) (ready bool)

CheckPodsRunningWithMaxDuration returns if all pods in a namespace are in "Running" status Also check container status to be running.

func CheckStatefulsetReady 

func CheckStatefulsetReady(ns string, kubeconfig string) (int, error)

CheckStatefulsetReady checks if statefulset resources are ready. get podsReady() sometimes gets pods created by the "Job" resource which never reach the "Running" steady state.

func ClusterNameFromKubeConfig 

func ClusterNameFromKubeConfig(kubeconfig string) string

ClusterNameFromKubeConfig generates the cluster name from the kubeconfig file path

func CopyFile 

func CopyFile(src, dst string) error

CopyFile create a new file to src based on dst

func CreateAndFill 

func CreateAndFill(outDir, templateFile string, values interface{}) (string, error)

CreateAndFill fills in the given yaml template with the values and generates a temp file for the completed yaml.

func CreateMultiClusterSecret 

func CreateMultiClusterSecret(namespace string, remoteKubeConfig string, localKubeConfig string) error

CreateMultiClusterSecret will create the secret associated with the remote cluster

func CreateNamespace 

func CreateNamespace(n string, kubeconfig string) error

CreateNamespace create a kubernetes namespace

func CreateTLSSecret 

func CreateTLSSecret(secretName, n, keyFile, certFile string, kubeconfig string) (string, error)

CreateTLSSecret creates a secret from the provided cert and key files

func CreateTempfile 

func CreateTempfile(tmpDir, prefix, suffix string) (string, error)

CreateTempfile creates a tempfile string.

func DeleteDeployment 

func DeleteDeployment(d string, n string, kubeconfig string) error

DeleteDeployment deletes deployment from the specified namespace

func DeleteMultiClusterSecret 

func DeleteMultiClusterSecret(namespace string, remoteKubeConfig string, localKubeConfig string) error

DeleteMultiClusterSecret delete the remote cluster secret

func DeleteNamespace 

func DeleteNamespace(n string, kubeconfig string) error

DeleteNamespace delete a kubernetes namespace

func DownloadRelease 

func DownloadRelease(version, tmpDir string) (string, error)

DownloadRelease gets the specified release from istio repo to tmpDir.

func ExtractTarGz 

func ExtractTarGz(gzippedStream io.Reader, dir string) error

ExtractTarGz extracts a .tar.gz file into current dir.

func FetchAndSaveClusterLogs 

func FetchAndSaveClusterLogs(namespace string, tempDir string, kubeconfig string) error

FetchAndSaveClusterLogs will dump the logs for a cluster.

func Fill 

func Fill(outFile, inFile string, values interface{}) error

Fill complete a template with given values and generate a new output file

func GetAppPods 

func GetAppPods(n string, kubeconfig string) (map[string][]string, error)

GetAppPods gets a map of app names to the pods for the app, for the given namespace

func GetAppPodsInfo 

func GetAppPodsInfo(n string, kubeconfig string, label string) ([]string, map[string][]string, error)

GetAppPodsInfo returns a map of a list of PodInfo

func GetClusterSubnet 

func GetClusterSubnet(kubeconfig string) (string, error)

GetClusterSubnet returns the subnet (in CIDR form, e.g. "24") for the nodes in the cluster.

func GetConfigs 

func GetConfigs(kubeconfig string, names ...string) (string, error)

GetConfigs retrieves the configurations for the list of resources.

func GetHeadCommitSHA 

func GetHeadCommitSHA(org, repo, branch string) (string, error)

GetHeadCommitSHA finds the SHA of the commit to which the HEAD of branch points

func GetIngress 

func GetIngress(serviceName, podLabel, namespace, kubeconfig string, serviceType string, sanityCheck bool) (string, error)

GetIngress get istio ingress ip and port. Could relate to either Istio Ingress or to Istio Ingress Gateway, by serviceName and podLabel. Handles two cases: when the Ingress/Ingress Gateway Kubernetes Service is a LoadBalancer or NodePort (for tests within the cluster, including for minikube)

func GetIngressPodNames 

func GetIngressPodNames(n string, kubeconfig string) ([]string, error)

GetIngressPodNames get the pod names for the Istio ingress deployment.

func GetKubeConfig 

func GetKubeConfig(filename string) error

GetKubeConfig will create a kubeconfig file based on the active environment the test is run in

func GetKubeMasterIP 

func GetKubeMasterIP(kubeconfig string) (string, error)

GetKubeMasterIP returns the IP address of the kubernetes master service.

func GetOsExt 

func GetOsExt() (string, error)

GetOsExt returns the current OS tag.

func GetPodLabelValues 

func GetPodLabelValues(n, label string, kubeconfig string) (map[string]string, error)

GetPodLabelValues gets a map of pod name to label value for the given label and namespace

func GetPodLogs 

func GetPodLogs(n, pod, container string, tail, alsoShowPreviousPodLogs bool, kubeconfig string) string

GetPodLogs retrieves the logs for the given namespace, pod and container.

func GetPodLogsForLabel 

func GetPodLogsForLabel(n, labelSelector string, container string, tail, alsoShowPreviousPodLogs bool, kubeconfig string) string

GetPodLogsForLabel gets the logs for the given label selector and container

func GetPodName 

func GetPodName(n, labelSelector string, kubeconfig string) (pod string, err error)

GetPodName gets the pod name for the given namespace and label selector

func GetPodNames 

func GetPodNames(n string) (pods []string, kubeconfig string)

GetPodNames gets names of all pods in specific namespace and return in a slice

func GetPodStatus 

func GetPodStatus(n, pod string, kubeconfig string) string

GetPodStatus gets status of a pod from a namespace Note: It is not enough to check pod phase, which only implies there is at least one container running. Use kubectl CLI to get status so that we can ensure that all containers are running.

func GetResourcePath 

func GetResourcePath(p string) string

GetResourcePath give "path from WORKSPACE", return absolute path at runtime

func GetServiceIP 

func GetServiceIP(serviceName, namespace, kubeconfig string) (string, error)

GetServiceIP get the service clusterIP.

func GitRootDir 

func GitRootDir() (string, error)

GitRootDir returns the absolute path to the root directory of the git repo where this function is called

func HTTPDownload 

func HTTPDownload(dst string, src string) error

HTTPDownload download from src(url) and store into dst(local file)

func IsJobSucceeded 

func IsJobSucceeded(n, name string, kubeconfig string) (bool, error)

IsJobSucceeded checks whether a job for the given namespace succeeded

func KubeApply 

func KubeApply(namespace, yamlFileName string, kubeconfig string) error

KubeApply kubectl apply from file

func KubeApplyContentSilent 

func KubeApplyContentSilent(namespace, yamlContents string, kubeconfig string) error

KubeApplyContentSilent kubectl apply from contents silently

func KubeApplyContents 

func KubeApplyContents(namespace, yamlContents string, kubeconfig string) error

KubeApplyContents kubectl apply from contents

func KubeApplySilent 

func KubeApplySilent(namespace, yamlFileName string, kubeconfig string) error

KubeApplySilent kubectl apply from file silently

func KubeCommand 

func KubeCommand(command, namespace, yamlFileName string, kubeconfig string) error

KubeCommand executes the given kubectl command with the given yaml file

func KubeDelete 

func KubeDelete(namespace, yamlFileName string, kubeconfig string) error

KubeDelete kubectl delete from file

func KubeDeleteContents 

func KubeDeleteContents(namespace, yamlContents string, kubeconfig string) error

KubeDeleteContents kubectl apply from contents

func KubeGetYaml 

func KubeGetYaml(namespace, resource, name string, kubeconfig string) (string, error)

KubeGetYaml kubectl get yaml content for given resource.

func KubeScale 

func KubeScale(namespace, typeName string, replicaCount int, kubeconfig string) error

KubeScale kubectl scale a pod specified using typeName

func LabelNamespace 

func LabelNamespace(n, label, kubeconfig string) error

LabelNamespace will add a label to the kubernetes namespace

func NamespaceDeleted 

func NamespaceDeleted(n string, kubeconfig string) (bool, error)

NamespaceDeleted check if a kubernete namespace is deleted

func PodExec 

func PodExec(n, pod, container, command string, muteOutput bool, kubeconfig string) (string, error)

PodExec runs the specified command on the container for the specified namespace and pod

func Poll 

func Poll(interval time.Duration, numTrials int, do func() (bool, error)) error

Poll executes do() after time interval for a max of numTrials times. The bool returned by do() indicates if polling succeeds in that trial

func RandomString 

func RandomString(n int) string

RandomString returns a random string of size n (letters only)

func Record 

func Record(command, record string) error

Record run command and record output into a file

func ReplaceInConfigMap 

func ReplaceInConfigMap(namespace string, configmapName string, sedExpression string, kubeconfig string) error

ReplaceInConfigMap will modify an existing configmap with the provided sed expression

func RunBackground 

func RunBackground(format string, args ...interface{}) (*os.Process, error)

RunBackground starts a background process and return the Process if succeed

func Shell 

func Shell(format string, args ...interface{}) (string, error)

Shell run command on shell and get back output and error if get one

func ShellContext 

func ShellContext(ctx context.Context, format string, args ...interface{}) (string, error)

ShellContext run command on shell and get back output and error if get one

func ShellMuteOutput 

func ShellMuteOutput(format string, args ...interface{}) (string, error)

ShellMuteOutput run command on shell and get back output and error if get one without logging the output

func ShellMuteOutputError 

func ShellMuteOutputError(format string, args ...interface{}) (string, error)

ShellMuteOutputError run command on shell and get back output and error if get one without logging the output or errors

func ShellSilent 

func ShellSilent(format string, args ...interface{}) (string, error)

ShellSilent runs command on shell and get back output and error if get one without logging the command or output.

func ValidatingWebhookConfigurationExists 

func ValidatingWebhookConfigurationExists(name string, kubeconfig string) bool

ValidatingWebhookConfigurationExists check if a kubernetes ValidatingWebhookConfiguration is deleted

func WaitForDeploymentsReady 

func WaitForDeploymentsReady(ns string, timeout time.Duration, kubeconfig string) error

WaitForDeploymentsReady wait up to 'timeout' duration return an error if deployments are not ready

func WaitForStatefulsetReady 

func WaitForStatefulsetReady(ns string, timeout time.Duration, kubeconfig string) error

WaitForStatefulsetReady wait up to 'timeout' duration return an error if statefulsets are not ready

func WriteTempfile 

func WriteTempfile(tmpDir, prefix, suffix, contents string) (string, error)

WriteTempfile creates a tempfile with the specified contents.

func WriteTextFile 

func WriteTextFile(filePath, content string) error

WriteTextFile overwrites the file on the given path with content

Types

type Break 

type Break struct {
	Err error
}

Break the retry loop if the error returned is of this type.

func (Break) Error 

func (e Break) Error() string

type PodInfo 

type PodInfo struct {
	// Name is the pod's name
	Name string
	// IPAddr is the pod's IP
	IPAddr string
}

PodInfo contains pod's information such as name and IP address

func GetPodsInfo 

func GetPodsInfo(n string, kubeconfig string, label string) (pods []PodInfo, err error)

GetPodsInfo get pods info.

type Retrier 

type Retrier struct {
	// BaseDelay is the minimum delay between retry attempts.
	BaseDelay time.Duration
	// MaxDelay is the maximum delay allowed between retry attempts.
	MaxDelay time.Duration
	// MaxDuration is the maximum cumulative duration allowed for all retries
	MaxDuration time.Duration
	// Retries defines number of retry attempts
	Retries int
}

Retrier contains the retry configuration parameters.

func (Retrier) Retry 

func (r Retrier) Retry(ctx context.Context, fn func(ctx context.Context, retryIndex int) error) (int, error)

Retry calls the given function a number of times, unless it returns a nil or a Break

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.