package
4.1.0+incompatible
Repository: https://github.com/openshift/origin.git
Documentation: pkg.go.dev
# Functions
ArtifactDirPath returns the value of ARTIFACT_DIR environment variable.
ArtifactPath returns the absolute path to the fix artifact fileThe path is relative to ARTIFACT_DIR.
BuildAuthConfiguration constructs a non-standard dockerClient.AuthConfiguration that can be used to communicate with the openshift internal docker registry.
CalculatePodMetrics receives an admin client and an admin.kubeconfig, and traverses a list of operator namespaces, measuring requests-per-second for each operator pod, using the overall long-running time of each pod as a base metric.
CheckBuildCancelled return true if the build was canceled.
CheckBuildFailed return true if the build failed.
CheckBuildSuccess returns true if the build succeeded.
CheckForBuildEvent will poll a build for up to 1 minute looking for an event with the specified reason and message template.
CheckImageStreamLatestTagPopulated returns true if the imagestream has a ':latest' tag filed.
CheckImageStreamTagNotFound return true if the imagestream update was not successful.
CheckPodIsReady returns true if the pod's ready probe determined that the pod is ready.
CheckPodIsRunning returns true if the pod is running.
CheckPodIsSucceeded returns true if the pod status is "Succdeded".
CheckPodNoOp always returns true.
CreateExecPodOrFail creates a simple busybox pod in a sleep loop used as a vessel for kubectl exec commands.
CreateResource creates the resources from the supplied json file (not a template); ginkgo error checking included.
DumpAndReturnTagging takes and array of tags and obtains the hex image IDs, dumps them to ginkgo for printing, and then returns them.
DumpApplicationPodLogs will dump the latest application logs for a DeploymentConfig for debug purposes.
DumpBuildLogs will dump the latest build logs for a BuildConfig for debug purposes.
DumpBuilds will dump the yaml for every build in the test namespace; remember, pipeline builds don't have build pods so a generic framework dump won't cat our pipeline builds objs in openshift.
DumpConfigMapStates dumps the state of all ConfigMaps in the CLI's current namespace.
DumpDeploymentLogs will dump the latest deployment logs for a DeploymentConfig for debug purposes.
DumpImageStreams will dump both the openshift namespace and local namespace imagestreams as part of debugging when the language imagestreams in the openshift namespace seem to disappear.
DumpPodLogsStartingWith will dump any pod starting with the name prefix provided.
DumpPodLogsStartingWith will dump any pod starting with the name prefix provided.
DumpPodsCommand runs the provided command in every pod identified by selector in the provided namespace.
DumpPodStates dumps the state of all pods in the CLI's current namespace.
DumpPodStatesInNamespace dumps the state of all pods in the provided namespace.
ExamineDiskUsage will dump df output on the testing system; leveraging this as part of diagnosing the registry's disk filling up during external tests on jenkins.
ExaminePodDiskUsage will dump df/du output on registry pod; leveraging this as part of diagnosing the registry's disk filling up during external tests on jenkins.
FatalErr exits the test in case a fatal error has occurred.
FetchURL grabs the output from the specified url and returns it.
FindImageFormatString returns a format string for components on the cluster.
FixturePath returns an absolute path to a fixture file in test/extended/testdata/, test/integration/, or examples/.
GetDockerImageReference retrieves the full Docker pull spec from the given ImageStream and tag.
GetEndpointAddress will return an "ip:port" string for the endpoint.
GetImageIDForTags will obtain the hexadecimal IDs for the array of human readible image tags IDs provided.
GetMasterThreadDump will get a golang thread stack dump.
GetPodForContainer creates a new Pod that runs specified container.
GetPodNamesByFilter looks up pods that satisfy the predicate and returns their names.
GetRouterPodTemplate finds the router pod template across different namespaces, helping to mitigate the transition from the default namespace to an operator namespace.
init initialize the extended testing suite.
ProwGCPSetup makes sure certain required env vars are available in the case that extended tests are invoked directly via calls to ginkgo/extended.test.
KubeConfigPath returns the value of KUBECONFIG environment variable.
ListImages initiates the equivalent of a `docker images`.
NewCLI initialize the upstream E2E framework and set the namespace to match with the project name.
NewCLIWithoutNamespace initialize the upstream E2E framework without adding a namespace.
NewGitRepo creates temporary test directories with local and "remote" git repo.
NewPodExecutor returns an executor capable of running commands in a Pod.
ParseLabelsOrDie turns the given string into a label selector or panics; for tests or other cases where you know the string is valid.
RemoveDeploymentConfigs deletes the given DeploymentConfigs in a namespace.
RemovePodsWithPrefixes deletes pods whose name begins with the supplied prefixes.
RemoveStatefulSets deletes the given stateful sets in a namespace.
SetupK8SNFSServerAndVolume sets up an nfs server pod with count number of persistent volumes.
StartBuild executes OC start-build with the specified arguments.
StartBuildAndWait executes OC start-build with the specified arguments on an existing buildconfig.
TimedWaitForAnImageStreamTag waits until an image stream with given name has non-empty history for given tag.
VarSubOnFile reads in srcFile, finds instances of ${key} from the map and replaces them with their associated values.
WaitForABuild waits for a Build object to match either isOK or isFailed conditions.
WaitForAnImageStream waits for an ImageStream to fulfill the isOK function.
WaitForAnImageStreamTag waits until an image stream with given name has non-empty history for given tag.
WaitForBuildResult updates result wit the state of the build.
WaitForDeploymentConfig waits for a DeploymentConfig to complete transition to a given version and report minimum availability.
WaitForNoPodsAvailable waits until there are no pods in the given namespace.
WaitForOpenShiftNamespaceImageStreams waits for the standard set of imagestreams to be imported.
WaitForPods waits until given number of pods that match the label selector and satisfy the predicate are found.
WaitForQueryOutputContains will execute the query multiple times, until the specified substring is found in the results.
WaitForQueryOutputSatisfies will execute the query multiple times, until the specified predicate function is return true.
WaitForResourceQuotaSync watches given resource quota until its usage is updated to desired level or a timeout occurs.
WaitForServiceAccount waits until the named service account gets fully provisioned.
WaitForUserBeAuthorized waits a minute until the cluster bootstrap roles are available and the provided user is authorized to perform the action on the resource.
WaitUntilAllHelpersAreUp waits until all helpers are ready to serve requests.
WaitUntilPodIsGone waits until the named Pod will disappear.
WaitUntilUp continuously waits for the server to become ready, up until timeout.
# Structs
CLI provides function to call the OpenShift CLI and Kubernetes and OpenShift clients.
# Interfaces
Database interface allows testing database images.
ReplicaSet interface allows to interact with database on multiple nodes.