compat_otp

func AddAnnotationsToSpecificResource ¶

func AddAnnotationsToSpecificResource(oc *exutil.CLI, resourceKindAndName, resourceNamespace string, annotations ...string) (string, error)

AddAnnotationsToSpecificResource adds the custom annotations to the specific resource

func AddLabelToNode ¶

func AddLabelToNode(oc *exutil.CLI, node string, label string, value string) (string, error)

AddLabelToNode add the custom label to the node

func AddLabelsToSpecificResource ¶

func AddLabelsToSpecificResource(oc *exutil.CLI, resourceKindAndName string, resourceNamespace string, labels ...string) (string, error)

AddLabelsToSpecificResource adds the custom labels to the specific resource

func AnnotateTestSuite ¶

func AnnotateTestSuite()

func ApplyClusterResourceFromTemplate ¶

func ApplyClusterResourceFromTemplate(oc *exutil.CLI, parameters ...string)

ApplyClusterResourceFromTemplate apply the changes to the cluster resource. For ex: ApplyClusterResourceFromTemplate(oc, "--ignore-unknown-parameters=true", "-f", "TEMPLATE LOCATION")

func ApplyClusterResourceFromTemplateWithError ¶

func ApplyClusterResourceFromTemplateWithError(oc *exutil.CLI, parameters ...string) error

ApplyClusterResourceFromTemplateWithError apply the changes to the cluster resource and return error if happned. For ex: ApplyClusterResourceFromTemplateWithError(oc, "--ignore-unknown-parameters=true", "-f", "TEMPLATE LOCATION")

func ApplyNsResourceFromTemplate ¶

func ApplyNsResourceFromTemplate(oc *exutil.CLI, namespace string, parameters ...string)

ApplyNsResourceFromTemplate apply changes to the ns resource. No need to add a namespace parameter in the template file as it can be provided as a function argument. For ex: ApplyNsResourceFromTemplate(oc, "NAMESPACE", "--ignore-unknown-parameters=true", "-f", "TEMPLATE LOCATION")

func ApplyOperatorResourceByYaml ¶

func ApplyOperatorResourceByYaml(oc *exutil.CLI, namespace string, yamlfile string)

ApplyOperatorResourceByYaml - It's not a template yaml file, the yaml shouldn't include namespace, we specify namespace by parameter.

func ApplyResourceFromTemplateWithNonAdminUser ¶

func ApplyResourceFromTemplateWithNonAdminUser(oc *exutil.CLI, parameters ...string) error

ApplyResourceFromTemplateWithNonAdminUser to as normal user to create resource from template

func ArchiveMustGatherFile ¶

func ArchiveMustGatherFile(oc *exutil.CLI, addExtraContent func(*exutil.CLI, string) error) error

ArchiveMustGatherFile creates a must-gather file to be archived by the CI prow job The addExtraContent function can be provided to add extra content to the must-gather file. Set it to nil if no extra content is needed. Conditions to generate a must-gather file: - The QE_MUST_GATHER_DIR environment variable must be defined and pointing to a valid directory. - The directory defined in the QE_MUST_GATHER_DIR env var must not contain more than 500M, including the must-gather file that is being generated. - A maximum of 2 must-gather files are allowed per prow job execution. If more that 2 test cases try to create a must-gather file in a the same prow job execution, only 2 must-gather files will be created and the rest will be ignored. - One test case can only create one must-gather file

func ArtifactDirPath ¶

func ArtifactDirPath() string

ArtifactDirPath returns the value of ARTIFACT_DIR environment variable

func ArtifactPath ¶

func ArtifactPath(elem ...string) string

ArtifactPath returns the absolute path to the fix artifact file The path is relative to ARTIFACT_DIR

func AssertAllNonJobPodsToBeReadyWithPollerParams ¶

func AssertAllNonJobPodsToBeReadyWithPollerParams(oc *exutil.CLI, namespace string, interval, timeout time.Duration)

AssertAllNonJobPodsToBeReadyWithPollerParams assert all non-Job pods in NS are in ready state until timeout in a given namespace Exclude transient Job pods ('job-name') from readiness: build Job pods are short‑lived and not expected to be Ready=True, so including them causes false failure we validate the Job via logs/conditions separately, and this gate only asserts persistent controller pods (e.g., machine‑os‑builder) are Ready.

func AssertAllPodsToBeReady ¶

func AssertAllPodsToBeReady(oc *exutil.CLI, namespace string)

AssertAllPodsToBeReady assert all pods in NS are in ready state until timeout in a given namespace

func AssertAllPodsToBeReadyWithPollerParams ¶

func AssertAllPodsToBeReadyWithPollerParams(oc *exutil.CLI, namespace string, interval, timeout time.Duration)

AssertAllPodsToBeReadyWithPollerParams assert all pods in NS are in ready state until timeout in a given namespace Pros: allow user to customize poller parameters

func AssertIfMCPChangesAppliedByName ¶

func AssertIfMCPChangesAppliedByName(oc *exutil.CLI, mcpName string, timeDurationSec int)

AssertIfMCPChangesAppliedByName checks the MCP of a given oc client and determines if the machine counts are as expected

func AssertIfNodePoolIsReadyByName ¶

func AssertIfNodePoolIsReadyByName(oc *exutil.CLI, nodePoolName string, timeDurationSec int, clustersNS string)

AssertIfNodePoolIsReadyByName checks if the Nodepool is ready

func AssertIfNodePoolUpdatingConfigByName ¶

func AssertIfNodePoolUpdatingConfigByName(oc *exutil.CLI, nodePoolName string, timeDurationSec int, clustersNS string)

AssertIfNodePoolUpdatingConfigByName checks if the Nodepool is ready

func AssertOprPodLogsbyFilter ¶

func AssertOprPodLogsbyFilter(oc *exutil.CLI, podName string, namespace string, filter string, minimalMatch int) bool

AssertOprPodLogsbyFilter trunct pods logs by filter

func AssertOprPodLogsbyFilterWithDuration ¶

func AssertOprPodLogsbyFilterWithDuration(oc *exutil.CLI, podName string, namespace string, filter string, timeDurationSec int, minimalMatch int)

AssertOprPodLogsbyFilterWithDuration used for truncting pods logs by filter

func AssertOrCheckMCP ¶

func AssertOrCheckMCP(oc *exutil.CLI, mcp string, interval, timeout time.Duration, skip bool) error

func AssertPodToBeReady ¶

func AssertPodToBeReady(oc *exutil.CLI, podName string, namespace string)

AssertPodToBeReady poll pod status to determine it is ready

func AssertWaitPollNoErr ¶

func AssertWaitPollNoErr(e error, msg string)

func AssertWaitPollWithErr ¶

func AssertWaitPollWithErr(e error, msg string)

func AzureCredentialsStructToString ¶

func AzureCredentialsStructToString[T any](s T) string

func BASE64DecodeStr ¶

func BASE64DecodeStr(src string) string

BASE64DecodeStr Base64 Decode

func By ¶

func By(text string)

when 4.14 synch with k1.27, there is gingkgo upgrade from 2.4 to 26 By method changes and it does not print "STEP:" information. some tester want to use it. so, make this wrapper to print if you want to get "STEP:", you need to change g.By to exutil.By text is the string you want to describe the step.

func CPUManagerStatebyNode ¶

func CPUManagerStatebyNode(oc *exutil.CLI, namespace string, nodeName string, ContainerName string) (string, string)

func CalculatePodMetrics ¶

func CalculatePodMetrics(adminClient kubernetes.Interface, adminConfig *restclient.Config) error

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.

func CanArchiveMustGather ¶

func CanArchiveMustGather() (float64, error)

CanArchiveMustGather returns the number of megas in the artifacts directory and and error if the must-gather file cannot be created

func CheckAKSCluster ¶

func CheckAKSCluster(ctx context.Context, oc *exutil.CLI) bool

func CheckAllNodepoolReadyByHostedClusterName ¶

func CheckAllNodepoolReadyByHostedClusterName(oc *exutil.CLI, nodePoolName, hostedClusterNS string, timeDurationSec int) bool

CheckAllNodepoolReadyByHostedClusterName used for checking if all nodepool is ready eg. CheckAllNodepoolReadyByHostedClusterName(oc, psap-qe-hcluster01,clusters,3600)

func CheckAppearance ¶

func CheckAppearance(oc *exutil.CLI, interval, timeout time.Duration, immediately, asAdmin, withoutNamespace, appear bool, parameters ...string) bool

CheckAppearance check if the resource appears or not. interval and timeout is the inveterl and timeout of Poll immediately means if it wait first interval and then check asAdmin means oc.AsAdmin() or not withoutNamespace means oc.WithoutNamespace() or not. appear means expect appear or not for example, expect pod in ns appear CheckAppearance(oc, 4*time.Second, 200*time.Second, exutil.NotImmediately, exutil.AsAdmin, exutil.WithoutNamespace, exutil.Appear, "-n", ns, "pod" name) if you expect pod in ns disappear, could be CheckAppearance(oc, 4*time.Second, 200*time.Second, exutil.NotImmediately, exutil.AsAdmin, exutil.WithoutNamespace, exutil.Disappear, "-n", ns, "pod" name)

func CheckBuildCancelled ¶

func CheckBuildCancelled(b *buildv1.Build) bool

CheckBuildCancelled return true if the build was canceled

func CheckBuildFailed ¶

func CheckBuildFailed(b *buildv1.Build) bool

CheckBuildFailed return true if the build failed

func CheckBuildSuccess ¶

func CheckBuildSuccess(b *buildv1.Build) bool

CheckBuildSuccess returns true if the build succeeded

func CheckForBuildEvent ¶

func CheckForBuildEvent(client corev1client.CoreV1Interface, build *buildv1.Build, reason, message string)

CheckForBuildEvent will poll a build for up to 1 minute looking for an event with the specified reason and message template.

func CheckHypershiftOperatorExistence ¶

func CheckHypershiftOperatorExistence(mgmtOC *exutil.CLI) (bool, error)

func CheckImageStreamLatestTagPopulated ¶

func CheckImageStreamLatestTagPopulated(i *imagev1.ImageStream) bool

CheckImageStreamLatestTagPopulated returns true if the imagestream has a ':latest' tag filed

func CheckImageStreamTagNotFound ¶

func CheckImageStreamTagNotFound(i *imagev1.ImageStream) bool

CheckImageStreamTagNotFound return true if the imagestream update was not successful

func CheckNetworkOperatorStatus ¶

func CheckNetworkOperatorStatus(oc *exutil.CLI) error

check until CNO operator status reports True, False, False for Available, Progressing, Degraded status,

func CheckNetworkType ¶

func CheckNetworkType(oc *exutil.CLI) string

func CheckPlatform ¶

func CheckPlatform(oc *exutil.CLI) string

CheckPlatform check the cluster's platform

func CheckPodIsReady ¶

func CheckPodIsReady(pod kapiv1.Pod) bool

CheckPodIsReady returns true if the pod's ready probe determined that the pod is ready.

func CheckPodIsRunning ¶

func CheckPodIsRunning(pod kapiv1.Pod) bool

CheckPodIsRunning returns true if the pod is running

func CheckPodIsSucceeded ¶

func CheckPodIsSucceeded(pod kapiv1.Pod) bool

CheckPodIsSucceeded returns true if the pod status is "Succdeded"

func CheckPodNoOp ¶

func CheckPodNoOp(pod kapiv1.Pod) bool

CheckPodNoOp always returns true

func CleanupOperatorResourceByYaml ¶

func CleanupOperatorResourceByYaml(oc *exutil.CLI, namespace string, yamlfile string)

CleanupOperatorResourceByYaml - It's not a template yaml file, the yaml shouldn't include namespace, we specify namespace by parameter.

func CleanupResource ¶

func CleanupResource(oc *exutil.CLI, interval, timeout time.Duration, asAdmin, withoutNamespace bool, parameters ...string)

CleanupResource cleanup one resouce and check if it is not found. interval and timeout is the inveterl and timeout of Poll to check if it is not found asAdmin means oc.AsAdmin() or not withoutNamespace means oc.WithoutNamespace() or not. for example, cleanup cluster level resource CleanupResource(oc, 4*time.Second, 160*time.Second, exutil.AsAdmin, exutil.WithoutNamespace, "operator.operators.operatorframework.io", operator.Name) cleanup ns resource CleanupResource(oc, 4*time.Second, 160*time.Second, exutil.AsAdmin, exutil.WithoutNamespace, "-n", ns, "pod" name)

func CompareMachineCreationTime ¶

func CompareMachineCreationTime(oc *exutil.CLI, ms1 string, ms2 string) bool

func ContainsAll ¶

func ContainsAll(big, small map[string]interface{}) bool

ContainsAll checks if all keys and values in small are also in the big map.

func ConvertStrToJson ¶

func ConvertStrToJson(str string) (map[string]interface{}, error)

ConvertStrToJson converts a JSON format string to data structure of map[string]interface{}

func CountLinuxWorkerNodeNumByOS ¶

func CountLinuxWorkerNodeNumByOS(oc *exutil.CLI) (linuxNum int)

CountNodeNumByOS used for count how many worker node by windows or linux

func CountNodeNumByOS ¶

func CountNodeNumByOS(oc *exutil.CLI) (linuxNum int, windowsNum int)

CountNodeNumByOS used for count how many worker node by windows or linux

func CreateAzureContainerRegistry ¶

func CreateAzureContainerRegistry(sess *AzureSession, registryName string, resourceGroupName string, location string) error

CreateAzureContainerRegistry create azure container registry

func CreateAzureStorageBlobContainer ¶

func CreateAzureStorageBlobContainer(container azblob.ContainerURL) error

CreateAzureStorageBlobContainer creates azure storage container

func CreateCentosExecPodOrFail ¶

func CreateCentosExecPodOrFail(client kubernetes.Interface, ns, generateName string, tweak func(*v1.Pod)) *v1.Pod

CreateCentosExecPodOrFail creates a centos:7 pause pod used as a vessel for kubectl exec commands. Pod name is uniquely generated.

func CreateClusterResourceFromTemplate ¶

func CreateClusterResourceFromTemplate(oc *exutil.CLI, parameters ...string)

CreateClusterResourceFromTemplate create resource from the template. For ex: CreateClusterResourceFromTemplate(oc, "--ignore-unknown-parameters=true", "-f", "TEMPLATE LOCATION")

func CreateClusterResourceFromTemplateWithError ¶

func CreateClusterResourceFromTemplateWithError(oc *exutil.CLI, parameters ...string) error

CreateClusterResourceFromTemplateWithError create resource from the template and return error if happened. For ex: CreateClusterResourceFromTemplateWithError(oc, "--ignore-unknown-parameters=true", "-f", "TEMPLATE LOCATION")

func CreateCustomNodePoolInHypershift ¶

func CreateCustomNodePoolInHypershift(oc *exutil.CLI, cloudProvider, guestClusterName, nodePoolName, nodeCount, instanceType, upgradeType, clustersNS, defaultNodePoolName string)

CreateCustomNodePoolInHypershift retrun custom nodepool yaml

func CreateExecPodOrFail ¶

func CreateExecPodOrFail(client corev1client.CoreV1Interface, ns, name string) string

CreateExecPodOrFail creates a simple busybox pod in a sleep loop used as a vessel for kubectl exec commands. Returns the name of the created pod. TODO: expose upstream

func CreateGCSBucket ¶

func CreateGCSBucket(projectID, bucketName string) error

CreateGCSBucket creates a GCS bucket in a project

func CreateLDAPTestServer ¶

func CreateLDAPTestServer(oc *exutil.CLI) (string, []byte, error)

CreateLDAPTestServer deploys an LDAP server on the service network and then confirms StartTLS connectivity with an ldapsearch against it. It returns the ldapserver host and the ldap CA, or an error.

func CreateMachinesetbyInstanceType ¶

func CreateMachinesetbyInstanceType(oc *exutil.CLI, machinesetName string, instanceType string)

CreateMachinesetbyInstanceType used to create a machineset with specified machineset name and instance type

func CreateNFDInstance ¶

func CreateNFDInstance(oc *exutil.CLI, namespace string)

CreateNFDInstance used for create NFD Instance in different namespace

func CreateNsResourceFromTemplate ¶

func CreateNsResourceFromTemplate(oc *exutil.CLI, namespace string, parameters ...string)

CreateNsResourceFromTemplate create ns resource from the template. No need to add a namespace parameter in the template file as it can be provided as a function argument. For ex: CreateNsResourceFromTemplate(oc, "NAMESPACE", "--ignore-unknown-parameters=true", "-f", "TEMPLATE LOCATION")

func CreateOpenStackContainer ¶

func CreateOpenStackContainer(client *gophercloud.ServiceClient, name string) error

CreateOpenStackContainer creates a storage container in openstack

func CreateResource ¶

func CreateResource(jsonFilePath string, oc *exutil.CLI) error

CreateResource creates the resources from the supplied json file (not a template); ginkgo error checking included

func CreateServiceAccount ¶

func CreateServiceAccount(oc *exutil.CLI, account string, clusterRole string) (token string, err error)

CreateServiceAccount @Description Create a service account when it does not exist @Create jianl Jul 2 2025 @Param oc exCLI oc client instance @Param account string The service account name @Param clusterRole string The cluster role that the service account will be added to @Return (account token, error)

func DebugNode ¶

func DebugNode(oc *exutil.CLI, nodeName string, cmd ...string) (string, error)

DebugNode creates a debugging session of the node

func DebugNodeRetryWithOptionsAndChroot ¶

func DebugNodeRetryWithOptionsAndChroot(oc *exutil.CLI, nodeName string, options []string, cmd ...string) (string, error)

DebugNodeRetryWithOptionsAndChroot launches debug container using chroot and with options And waitPoll to avoid "error: unable to create the debug pod" and do retry

func DebugNodeRetryWithOptionsAndChrootWithStdErr ¶

func DebugNodeRetryWithOptionsAndChrootWithStdErr(oc *exutil.CLI, nodeName string, options []string, cmd ...string) (string, string, error)

DebugNodeRetryWithOptionsAndChroot launches debug container using chroot and with options And waitPoll to avoid "error: unable to create the debug pod" and do retry Separate the Warning from Output: metadata.name: this is used in the Pod's hostname, which can result in surprising behavior; a DNS label is recommended: [must be no more than 63 characters]\ndevice name 'Warning: metadata.name: this is used in the Pod's hostname, which can result in surprising behavior; a DNS label is recommended: [must be no more than 63 characters]' longer than 127 characters\nerror: non-zero exit code from debug container

func DebugNodeWithChroot ¶

func DebugNodeWithChroot(oc *exutil.CLI, nodeName string, cmd ...string) (string, error)

DebugNodeWithChroot creates a debugging session of the node with chroot

func DebugNodeWithOptions ¶

func DebugNodeWithOptions(oc *exutil.CLI, nodeName string, options []string, cmd ...string) (string, error)

DebugNodeWithOptions launches debug container with options e.g. --image

func DebugNodeWithOptionsAndChroot ¶

func DebugNodeWithOptionsAndChroot(oc *exutil.CLI, nodeName string, options []string, cmd ...string) (string, error)

DebugNodeWithOptionsAndChroot launches debug container using chroot and with options e.g. --image

func DebugNodeWithOptionsAndChrootWithoutRecoverNsLabel ¶

func DebugNodeWithOptionsAndChrootWithoutRecoverNsLabel(oc *exutil.CLI, nodeName string, options []string, cmd ...string) (stdOut string, stdErr string, err error)

DebugNodeWithOptionsAndChrootWithoutRecoverNsLabel launches debug container using chroot and with options e.g. --image WithoutRecoverNsLabel which will not recover the labels that added for debug node container adapt the podSecurity changed on 4.12+ test clusters "security.openshift.io/scc.podSecurityLabelSync=false" And "pod-security.kubernetes.io/enforce=privileged"

func DeleteAzureContainerRegistry ¶

func DeleteAzureContainerRegistry(sess *AzureSession, registryName string, resourceGroupName string) error

DeleteAzureContainerRegistry deletes azure container registry

func DeleteAzureStorageBlobContainer ¶

func DeleteAzureStorageBlobContainer(container azblob.ContainerURL) error

DeleteAzureStorageBlobContainer deletes azure storage container

func DeleteGCSBucket ¶

func DeleteGCSBucket(bucketName string) error

DeleteGCSBucket deletes the GCS bucket

func DeleteLabelFromNode ¶

func DeleteLabelFromNode(oc *exutil.CLI, node string, label string) (string, error)

DeleteLabelFromNode delete the custom label from the node

func DeleteLabelsFromSpecificResource ¶

func DeleteLabelsFromSpecificResource(oc *exutil.CLI, resourceKindAndName string, resourceNamespace string, labelNames ...string) (string, error)

DeleteLabelsFromSpecificResource deletes the custom labels from the specific resource

func DeleteMCAndMCPByName ¶

func DeleteMCAndMCPByName(oc *exutil.CLI, mcName string, mcpName string, timeDurationSec int)

DeleteMCAndMCPByName used for checking if node return to worker machine config pool and the specified mcp is zero, then delete mc and mcp

func DeleteOpenStackContainer ¶

func DeleteOpenStackContainer(client *gophercloud.ServiceClient, name string) error

DeleteOpenStackContainer deletes the storage container from openstack

func DeletePVCsForDeployment ¶

func DeletePVCsForDeployment(client clientset.Interface, oc *exutil.CLI, deploymentPrefix string)

func DeleteRoleAssignments ¶

func DeleteRoleAssignments(sess *AzureSession, roleAssignmentName string, scope string) error

DeleteRoleAssignments deletes role assignments

func DumpAndReturnTagging ¶

func DumpAndReturnTagging(tags []string) ([]string, error)

DumpAndReturnTagging takes and array of tags and obtains the hex image IDs, dumps them to ginkgo for printing, and then returns them

func DumpApplicationPodLogs ¶

func DumpApplicationPodLogs(dcName string, oc *exutil.CLI)

DumpApplicationPodLogs will dump the latest application logs for a DeploymentConfig for debug purposes

func DumpBuildLogs ¶

func DumpBuildLogs(bc string, oc *exutil.CLI)

DumpBuildLogs will dump the latest build logs for a BuildConfig for debug purposes

func DumpBuilds ¶

func DumpBuilds(oc *exutil.CLI)

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

func DumpConfigMapStates ¶

func DumpConfigMapStates(oc *exutil.CLI)

DumpConfigMapStates dumps the state of all ConfigMaps in the exutil.CLI's current namespace.

func DumpDeploymentLogs ¶

func DumpDeploymentLogs(dcName string, version int64, oc *exutil.CLI)

DumpDeploymentLogs will dump the latest deployment logs for a DeploymentConfig for debug purposes

func DumpImageStreams ¶

func DumpImageStreams(oc *exutil.CLI)

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

func DumpPersistentVolumeInfo ¶

func DumpPersistentVolumeInfo(oc *exutil.CLI)

func DumpPodLogs ¶

func DumpPodLogs(pods []kapiv1.Pod, oc *exutil.CLI)

func DumpPodLogsStartingWith ¶

func DumpPodLogsStartingWith(prefix string, oc *exutil.CLI)

DumpPodLogsStartingWith will dump any pod starting with the name prefix provided

func DumpPodLogsStartingWithInNamespace ¶

func DumpPodLogsStartingWithInNamespace(prefix, namespace string, oc *exutil.CLI)

DumpPodLogsStartingWith will dump any pod starting with the name prefix provided

func DumpPodStates ¶

func DumpPodStates(oc *exutil.CLI)

DumpPodStates dumps the state of all pods in the exutil.CLI's current namespace.

func DumpPodStatesInNamespace ¶

func DumpPodStatesInNamespace(namespace string, oc *exutil.CLI)

DumpPodStatesInNamespace dumps the state of all pods in the provided namespace.

func DumpPodsCommand ¶

func DumpPodsCommand(c kubernetes.Interface, ns string, selector labels.Selector, cmd string)

DumpPodsCommand runs the provided command in every pod identified by selector in the provided namespace.

func DumpSampleOperator ¶

func DumpSampleOperator(oc *exutil.CLI)

func DuplicateFileToPath ¶

func DuplicateFileToPath(srcPath string, destPath string)

DuplicateFileToPath copies the file at srcPath to destPath.

func DuplicateFileToTemp ¶

func DuplicateFileToTemp(srcPath string, destPrefix string) string

DuplicateFileToTemp creates a temporary duplicate of the file at srcPath using destPattern for naming, returning the path of the duplicate.

func EmptyAzureBlobContainer ¶

func EmptyAzureBlobContainer(container azblob.ContainerURL) error

EmptyAzureBlobContainer removes all the files in azure storage container

func EmptyGCSBucket ¶

func EmptyGCSBucket(client storage.Client, bucketName string) error

EmptyGCSBucket removes all the objects in the bucket

func EmptyOpenStackContainer ¶

func EmptyOpenStackContainer(client *gophercloud.ServiceClient, name string) error

EmptyOpenStackContainer clear all the objects in storage container

func ExamineDiskUsage ¶

func ExamineDiskUsage()

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

func ExaminePodDiskUsage ¶

func ExaminePodDiskUsage(oc *exutil.CLI)

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

func ExtendedCheckPlatform ¶

func ExtendedCheckPlatform(ctx context.Context, oc *exutil.CLI) string

func ExtractCcoctl ¶

func ExtractCcoctl(oc *exutil.CLI, releaseImage, ccoctlTarget string) string

ExtractCcotl extracts the specified version of the ccoctl binary from the given release image. It supports different versions of ccoctl for RHEL environments, including:

• "ccoctl"
• "ccoctl.rhel8" (RHEL 8 version)
• "ccoctl.rhel9" (RHEL 9 version)

Usage example:

ccoctlTarget := "ccoctl.rhel8"
ccoctlPath := exutil.ExtractCcotl(oc, testOCPImage, ccoctlTarget, true)
defer os.Remove(filepath.Dir(ccoctlPath))

Parameters:

• oc: exutil.CLI object to interact with OpenShift commands.
• releaseImage: The OpenShift release image from which to extract the ccoctl binary.
• ccoctlTarget: The target ccoctl version to extract (e.g., "ccoctl"(default), "ccoctl.rhel8", "ccoctl.rhel9").

Returns:

• A string containing the file path of the extracted ccoctl binary.

func ExtractCoreOSBootImagesConfigMap ¶

func ExtractCoreOSBootImagesConfigMap(oc *exutil.CLI, releaseImage, pullSecretFile string) (*corev1.ConfigMap, error)

ExtractCoreOSBootImagesConfigMap extracts the CoreOS boot images ConfigMap from the given release image

func ExtractSpecifiedValueFromMetricData4MemRSS ¶

func ExtractSpecifiedValueFromMetricData4MemRSS(oc *exutil.CLI, metricResult string) (string, int)

ExtractSpecifiedValueFromMetricData4MemRSS extracts the value of the container_memory_rss metric from the result of a Prometheus query

func ExtractVPCIDFromBaseDomain ¶

func ExtractVPCIDFromBaseDomain(oc *exutil.CLI, vpcs []vpcv1.VPC, baseDomain string) (string, error)

ExtractVPCIDFromBaseDomain extracts the VPC ID based on the DNS base domain.

func FatalErr ¶

func FatalErr(msg interface{})

FatalErr prints the error and exits the process

func FetchURL ¶

func FetchURL(oc *exutil.CLI, url string, retryTimeout time.Duration) (string, error)

FetchURL grabs the output from the specified url and returns it. It will retry once per second for duration retryTimeout if an error occurs during the request.

func FindCLIImage ¶

func FindCLIImage(oc *exutil.CLI) (string, bool)

func FindImageFormatString ¶

func FindImageFormatString(oc *exutil.CLI) (string, bool)

FindImageFormatString returns a format string for components on the cluster. It returns false if no format string could be inferred from the cluster. OpenShift 4.0 clusters will not be able to infer an image format string, so you must wrap this method in one that can locate your specific image.

func FindRouterImage ¶

func FindRouterImage(oc *exutil.CLI) (string, error)

func FixturePath ¶

func FixturePath(elem ...string) string

FixturePath returns an absolute path to a fixture file in test/extended/testdata/, test/integration/, or examples/.

func GenerateManifestFile ¶

func GenerateManifestFile(oc *exutil.CLI, baseDir string, manifestFile string, replacement ...map[string]string) (string, error)

This function accept key value replacement in multiple formats manifestFile, err := GenerateManifestFile(oc, "config-map.yaml", "myDir", map[string]string{"<address>": address, "<username>": user}) manifestFile, err := GenerateManifestFile(oc, "namespace.yaml", "myDir", map[string]string{"<namespace>": namespace})

func GetAWSClusterRegion ¶

func GetAWSClusterRegion(oc *exutil.CLI) (string, error)

GetAWSClusterRegion returns AWS region of the cluster

func GetAllNodes ¶

func GetAllNodes(oc *exutil.CLI) ([]string, error)

GetAllNodes returns a list of the names of all nodes in the cluster

func GetAllNodesByNodePoolNameInHostedCluster ¶

func GetAllNodesByNodePoolNameInHostedCluster(oc *exutil.CLI, nodePoolName string) ([]string, error)

GetAllNodesByNodePoolNameInHostedCluster return all node names of specified nodepool in hosted cluster.

func GetAllNodesbyOSType ¶

func GetAllNodesbyOSType(oc *exutil.CLI, ostype string) ([]string, error)

GetAllNodesbyOSType returns a list of the names of all linux/windows nodes in the cluster have both linux and windows node

func GetAllPods ¶

func GetAllPods(oc *exutil.CLI, namespace string) ([]string, error)

GetAllPods returns a list of the names of all pods in the cluster in a given namespace

func GetAllPodsWithLabel ¶

func GetAllPodsWithLabel(oc *exutil.CLI, namespace string, label string) ([]string, error)

GetAllPodsWithLabel get array of all pods for a given namespace and label

func GetAllWorkerNodesByOSID ¶

func GetAllWorkerNodesByOSID(oc *exutil.CLI, osID string) ([]string, error)

GetAllWorkerNodesByOSID returns list of worker nodes by OS ID

func GetAllocatableResourcesNodesMap ¶

func GetAllocatableResourcesNodesMap(nodes []v1.Node) map[string]NodeResources

GetAllocatableResourcesNodesMap returns the total allocatable CPU and Memory in each node

func GetAnnotationsFromSpecificResource ¶

func GetAnnotationsFromSpecificResource(oc *exutil.CLI, resourceKindAndName, resourceNamespace string) ([]string, error)

GetAnnotationsFromSpecificResource gets the annotations from the specific resource

func GetApplicationPods ¶

func GetApplicationPods(oc *exutil.CLI, dcName string) (*kapiv1.PodList, error)

func GetAuthenticatedUserID ¶

func GetAuthenticatedUserID(providerClient *gophercloud.ProviderClient) (string, error)

GetAuthenticatedUserID gets current user ID some users don't have permission to list users, so here extract user ID from auth response

func GetAzureContainerRepositoryCredential ¶

func GetAzureContainerRepositoryCredential(sess *AzureSession, registryName string, resourceGroupName string) (string, string, error)

GetAzureContainerRepositoryCredential get azure container repository credential

func GetAzureCredentialFromCluster ¶

func GetAzureCredentialFromCluster(oc *exutil.CLI) (string, error)

GetAzureCredentialFromCluster gets Azure credentials from cluster and loads them as environment variables

func GetAzureCredsLocation ¶

func GetAzureCredsLocation() (string, error)

func GetAzureStackVMStatus ¶

func GetAzureStackVMStatus(resourceGroupName, vmName string) (string, error)

GetAzureStackVMStatus gets the status of the virtual machine with the given name in the specified resource group using Azure exutil.CLI

func GetAzureStorageAccount ¶

func GetAzureStorageAccount(sess *AzureSession, resourceGroupName string) (string, error)

GetAzureStorageAccount get Azure Storage Account

func GetAzureStorageAccountFromCluster ¶

func GetAzureStorageAccountFromCluster(oc *exutil.CLI) (string, string, error)

GetAzureStorageAccountFromCluster gets azure storage accountName and accountKey from image registry TODO: create a storage account and use that accout to manage azure container

func GetAzureVMInstance ¶

func GetAzureVMInstance(sess *AzureSession, vmName string, resourceGroupName string) (string, error)

GetAzureVMInstance get vm instance

func GetAzureVMInstanceState ¶

func GetAzureVMInstanceState(sess *AzureSession, vmName string, resourceGroupName string) (string, error)

GetAzureVMInstanceState get vm instance state

func GetAzureVMPrivateIP ¶

func GetAzureVMPrivateIP(sess *AzureSession, rg, vmName string) (string, error)

GetAzureVMPrivateIP get Azure vm private IP

func GetAzureVMPublicIP ¶

func GetAzureVMPublicIP(sess *AzureSession, rg, vmName string) (string, error)

GetAzureVMPublicIP get azure vm public IP

func GetAzureVMPublicIPByNameRegex ¶

func GetAzureVMPublicIPByNameRegex(sess *AzureSession, rg, publicIPNameRegex string) (string, error)

GetAzureVMPublicIPByNameRegex returns the first public IP whose name matches the given regex

func GetClusterNodesBy ¶

func GetClusterNodesBy(oc *exutil.CLI, role string) ([]string, error)

GetClusterNodesBy returns the cluster nodes by role

func GetClusterNodesByRoleInHostedCluster ¶

func GetClusterNodesByRoleInHostedCluster(oc *exutil.CLI, role string) ([]string, error)

GetClusterNodesByRoleInHostedCluster returns the cluster nodes by role

func GetClusterPrefixName ¶

func GetClusterPrefixName(oc *exutil.CLI) string

GetClusterPrefixName return Cluster Prefix Name

func GetClusterVersion ¶

func GetClusterVersion(oc *exutil.CLI) (string, string, error)

GetClusterVersion returns the cluster version as string value (Ex: 4.8) and cluster build (Ex: 4.8.0-0.nightly-2021-09-28-165247)

func GetContainerIDByPODName ¶

func GetContainerIDByPODName(oc *exutil.CLI, podName string, namespace string) string

func GetCurrentTestPolarionIDNumber ¶

func GetCurrentTestPolarionIDNumber() string

GetCurrentTestPolarionIDNumber inspects the name of the test case and return the number of the polarion ID linked to this automated test case. It returns an empty string if no ID found.

func GetDeploymentConfigPods ¶

func GetDeploymentConfigPods(oc *exutil.CLI, dcName string, version int64) (*kapiv1.PodList, error)

func GetDockerImageReference ¶

func GetDockerImageReference(c imagev1typedclient.ImageStreamInterface, name, tag string) (string, error)

GetDockerImageReference retrieves the full Docker pull spec from the given ImageStream and tag

func GetEndpointAddress ¶

func GetEndpointAddress(oc *exutil.CLI, name string) (string, error)

GetEndpointAddress will return an "ip:port" string for the endpoint.

func GetFieldWithJsonpath ¶

func GetFieldWithJsonpath(oc *exutil.CLI, interval, timeout time.Duration, immediately, allowEmpty, asAdmin, withoutNamespace bool, parameters ...string) (string, error)

GetFieldWithJsonpath gets the field of the resource per jsonpath interval and timeout is the inveterl and timeout of Poll immediately means if it wait first interval and then get allowEmpty means if the result allow empty string asAdmin means oc.AsAdmin() or not withoutNamespace means oc.WithoutNamespace() or not. for example, it is to get clusterresource GetFieldWithJsonpath(oc, 3*time.Second, 150*time.Second, exutil.NotImmediately, exutil.NotAllowEmpty, exutil.AsAdmin, exutil.WithoutNamespace, "operator", name, "-o", "jsonpath={.status}") if you want to get ns resource, could be GetFieldWithJsonpath(oc, 3*time.Second, 150*time.Second, exutil.NotImmediately, exutil.NotAllowEmpty, exutil.AsAdmin, exutil.WithoutNamespace, "-n", ns, "pod", name, "-o", "jsonpath={.status}") or if the ns is same to oc.Namespace, could be GetFieldWithJsonpath(oc, 3*time.Second, 150*time.Second, exutil.NotImmediately, exutil.AllowEmpty, exutil.AsAdmin, exutil.WithoutNamespace, "pod", name, "-o", "jsonpath={.status}")

func GetFileContent ¶

func GetFileContent(baseDir string, name string) (fileContent string)

Get file content in test/extended/testdata/<basedir>/<name>

func GetFirstCoreOsWorkerNode ¶

func GetFirstCoreOsWorkerNode(oc *exutil.CLI) (string, error)

GetFirstCoreOsWorkerNode returns the first CoreOS worker node

func GetFirstLinuxMachineSets ¶

func GetFirstLinuxMachineSets(oc *exutil.CLI) string

GetFirstLinuxMachineSets used for getting first linux worker nodes name

func GetFirstLinuxWorkerNode ¶

func GetFirstLinuxWorkerNode(oc *exutil.CLI) (string, error)

GetFirstLinuxWorkerNode returns the first linux worker node in the cluster

func GetFirstLinuxWorkerNodeInHostedCluster ¶

func GetFirstLinuxWorkerNodeInHostedCluster(oc *exutil.CLI) (string, error)

GetFirstLinuxWorkerNodeInHostedCluster returns the first linux worker node in the cluster

func GetFirstMasterNode ¶

func GetFirstMasterNode(oc *exutil.CLI) (string, error)

GetFirstMasterNode returns a first master node

func GetFirstRhelWorkerNode ¶

func GetFirstRhelWorkerNode(oc *exutil.CLI) (string, error)

GetFirstRhelWorkerNode returns the first rhel worker node

func GetFirstWorkerNode ¶

func GetFirstWorkerNode(oc *exutil.CLI) (string, error)

GetFirstWorkerNode returns a first worker node

func GetFirstWorkerNodeByNodePoolNameInHostedCluster ¶

func GetFirstWorkerNodeByNodePoolNameInHostedCluster(oc *exutil.CLI, nodePoolName string) (string, error)

GetFirstWorkerNodeByNodePoolNameInHostedCluster returns the first linux worker node in the cluster

func GetGcpProjectID ¶

func GetGcpProjectID(oc *exutil.CLI) (string, error)

GetGcpProjectID returns the gcp project id

func GetHostedClusterVersion ¶

func GetHostedClusterVersion(mgmtOc *exutil.CLI, hostedClusterName, hostedClusterNs string) semver.Version

GetHostedClusterVersion gets a HostedCluster's version from the management cluster.

func GetHyperShiftHostedClusterNameSpace ¶

func GetHyperShiftHostedClusterNameSpace(oc *exutil.CLI) string

GetHyperShiftHostedClusterNameSpace get hypershift hostedcluster namespace if not exist, it will return empty string. If more than one exists, it will return the first one.

func GetHyperShiftOperatorNameSpace ¶

func GetHyperShiftOperatorNameSpace(oc *exutil.CLI) string

GetHyperShiftOperatorNameSpace get hypershift operator namespace if not exist, it will return empty string.

func GetIBMCredentialFromCluster ¶

func GetIBMCredentialFromCluster(oc *exutil.CLI) (string, string, string, error)

GetIBMCredentialFromCluster gets IBM credentials like ibmapikey, ibmvpc, and ibmregion from the cluster

func GetIBMInstanceID ¶

func GetIBMInstanceID(session *IBMSession, oc *exutil.CLI, region string, vpcName string, instanceID string, baseDomain string) (string, error)

GetIBMInstanceID get IBM instance id

func GetIBMInstanceStatus ¶

func GetIBMInstanceStatus(session *IBMSession, instanceID string) (string, error)

GetIBMInstanceStatus check IBM instance running status

func GetIBMPowerVsCloudID ¶

func GetIBMPowerVsCloudID(oc *exutil.CLI, nodeName string) string

GetIBMPowerVsCloudID get powervsCloud Id

func GetIBMPowerVsInstanceInfo ¶

func GetIBMPowerVsInstanceInfo(powerClient *IBMPowerVsSession, instanceName string) (string, string, error)

GetInstanceInfo retrieves information for the specified instance name

func GetIBMRegion ¶

func GetIBMRegion(oc *exutil.CLI) (string, error)

GetIBMRegion gets IBM cluster region

func GetIBMResourceGrpName ¶

func GetIBMResourceGrpName(oc *exutil.CLI) (string, error)

GetIBMResourceGrpName get IBM cluster resource group name

func GetIPVersionStackType ¶

func GetIPVersionStackType(oc *exutil.CLI) (ipvStackType string)

GetIPVersionStackType gets IP-version Stack type of the cluster

func GetImageIDForTags ¶

func GetImageIDForTags(comps []string) ([]string, error)

GetImageIDForTags will obtain the hexadecimal IDs for the array of human readible image tags IDs provided

func GetImagestreamImageName ¶

func GetImagestreamImageName(oc *exutil.CLI, imagestreamName string) string

GetImagestreamImageName Return an imagestream's image repository name

func GetInfraID ¶

func GetInfraID(oc *exutil.CLI) (string, error)

GetInfraID returns the infra id

func GetLastLinuxWorkerNode ¶

func GetLastLinuxWorkerNode(oc *exutil.CLI) (string, error)

GetLastLinuxWorkerNode return last worker node

func GetLatest4StableImage ¶

func GetLatest4StableImage() (string, error)

GetLatest4StableImage to get the latest 4-stable OCP image from releasestream link Return OCP image for sample quay.io/openshift-release-dev/ocp-release:4.11.0-fc.0-x86_64

func GetLatest4StableImageByStream ¶

func GetLatest4StableImageByStream(arch string, stream string) (latestImage string, err error)

GetLatest4StableImageByStream to get the latest 4-stable OCP image from a specifed releasestream link GetLatest4StableImageByStream("multi", "4-stable-multi/latest?in=>4.16.0-0+<4.17.0-0") GetLatest4StableImageByStream("amd64", "4-stable/latest")

func GetLatestImage ¶

func GetLatestImage(arch, product, stream string) (string, error)

GetLatestImage retrieves the pull spec of the latest image satisfying the arch - product - stream combination. arch = "amd64", "arm64", "ppc64le", "s390x", "multi" product = "ocp", "origin" (i.e. okd, which only supports the amd64 architecture) Possible values for the stream parameter depend on arch and product. See https://docs.ci.openshift.org/docs/getting-started/useful-links/#services for relevant release status pages.

Examples: GetLatestImage("amd64", "ocp", "4.14.0-0.nightly") GetLatestImage("arm64", "ocp", "4.14.0-0.nightly-arm64") GetLatestImage("amd64", "origin", "4.14.0-0.okd")

func GetLatestNightlyImage ¶

func GetLatestNightlyImage(release string) (string, error)

GetLatestNightlyImage to get the latest nightly OCP image from releasestream link Input parameter release: OCP release version such as 4.11, 4.9, ..., 4.6 Return OCP image

func GetLatestReleaseImageFromEnv ¶

func GetLatestReleaseImageFromEnv() string

func GetMachineSetInstanceType ¶

func GetMachineSetInstanceType(oc *exutil.CLI) string

GetMachineSetInstanceType used to get first machineset instance type

func GetMasterThreadDump ¶

func GetMasterThreadDump(oc *exutil.CLI)

GetMasterThreadDump will get a golang thread stack dump

func GetMirrorRegistry ¶

func GetMirrorRegistry(oc *exutil.CLI) (registry string, err error)

GetMirrorRegistry returns mirror registry from icsp

func GetMustGatherFileName ¶

func GetMustGatherFileName() string

GetMustGatherFileName Get the name of the must-gather file for the current test case

func GetNFDInstanceImage ¶

func GetNFDInstanceImage(oc *exutil.CLI, namespace string) string

GetNFDInstanceImage return correct image name in manifest channel

func GetNFDVersionbyPackageManifest ¶

func GetNFDVersionbyPackageManifest(oc *exutil.CLI, namespace string) string

GetNFDVersionbyPackageManifest return NFD version

func GetNodeArchByName ¶

func GetNodeArchByName(oc *exutil.CLI, nodeName string) string

GetNodeArchByName gets the node arch by its name

func GetNodeHostname ¶

func GetNodeHostname(oc *exutil.CLI, node string) (string, error)

GetNodeHostname returns the cluster node hostname

func GetNodeListByLabel ¶

func GetNodeListByLabel(oc *exutil.CLI, labelKey string) []string

GetNodeListByLabel gets the node list by label

func GetNodeNameByMachineset ¶

func GetNodeNameByMachineset(oc *exutil.CLI, machinesetName string) string

GetNodeNameByMachineset used for get node name by machineset name

func GetNodePoolNamesbyHostedClusterName ¶

func GetNodePoolNamesbyHostedClusterName(oc *exutil.CLI, hostedClusterName, hostedClusterNS string) []string

GetNodePoolNamesbyHostedClusterName gets the nodepools names of the hosted cluster

func GetNutanixCredFromCluster ¶

func GetNutanixCredFromCluster(oc *exutil.CLI) (string, error)

GetNutanixCredentialFromCluster gets nutanix credentials from cluster

func GetNutanixCredentialFromCluster ¶

func GetNutanixCredentialFromCluster(oc *exutil.CLI) (string, string, string, error)

GetNutanixCredentialFromCluster gets credentials like username, password, and endpoint URL from the cluster

func GetNutanixHostromCluster ¶

func GetNutanixHostromCluster(oc *exutil.CLI) (string, error)

GetNutanixHostromCluster Gets nutanix [Host]:port from cluster

func GetOIDCProvider ¶

func GetOIDCProvider(oc *exutil.CLI) (string, error)

GetOIDCProvider returns the OIDC provider for current cluster

func GetOpenStackUserIDAndDomainID ¶

func GetOpenStackUserIDAndDomainID(cred *OpenstackCredentials) (string, string)

GetOpenStackUserIDAndDomainID returns the user ID and domain ID

func GetOperatorPKGManifestDefaultChannel ¶

func GetOperatorPKGManifestDefaultChannel(oc *exutil.CLI, pkgManifestName, namespace string) (string, error)

GetOperatorPKGManifestDefaultChannel to getting operator Packagemanifest default channel

func GetOperatorPKGManifestSource ¶

func GetOperatorPKGManifestSource(oc *exutil.CLI, pkgManifestName, namespace string) (string, error)

GetOperatorPKGManifestSource used for getting operator Packagemanifest source name

func GetPODCPUSet ¶

func GetPODCPUSet(oc *exutil.CLI, namespace string, nodeName string, containerID string) string

func GetPodForContainer ¶

func GetPodForContainer(container kapiv1.Container) *kapiv1.Pod

GetPodForContainer creates a new Pod that runs specified container

func GetPodLogs ¶

func GetPodLogs(oc *exutil.CLI, pod, container, since string) (string, error)

GetPodLogs retrieves logs from a pod

func GetPodName ¶

func GetPodName(oc *exutil.CLI, namespace string, podLabel string, node string) (string, error)

GetPodName returns the pod name

func GetPodNameInHostedCluster ¶

func GetPodNameInHostedCluster(oc *exutil.CLI, namespace string, podLabel string, node string) (string, error)

GetPodNameInHostedCluster returns the pod name in hosted cluster of hypershift

func GetPodNamesByFilter ¶

func GetPodNamesByFilter(c corev1client.PodInterface, label labels.Selector, predicate func(kapiv1.Pod) bool) (podNames []string, err error)

GetPodNamesByFilter looks up pods that satisfy the predicate and returns their names.

func GetPodNodeName ¶

func GetPodNodeName(oc *exutil.CLI, namespace string, podName string) (string, error)

GetPodNodeName returns the name of the node the given pod is running on

func GetPodsNodesMap ¶

func GetPodsNodesMap(oc *exutil.CLI, nodes []v1.Node) map[string][]v1.Pod

GetPodsNodesMap returns all the running pods in each node

func GetPrivateKey ¶

func GetPrivateKey() (string, error)

func GetPublicKey ¶

func GetPublicKey() (string, error)

func GetPullSec ¶

func GetPullSec(oc *exutil.CLI, dirname string) (err error)

Extract pull secrect from cluster

func GetRDU2HostsList ¶

func GetRDU2HostsList() (map[string]*RDU2Host, error)

GetRDU2HostsList returns the singleton instance of RDU2Hosts map It initializes the singleton on first call by reading the hosts.yaml file Returns a copy of the map to prevent external modifications

func GetRHCOSImageURLForAzureDisk ¶

func GetRHCOSImageURLForAzureDisk(oc *exutil.CLI, releaseImage string, pullSecretFile string, arch CoreOSImageArch) (string, error)

GetRHCOSImageURLForAzureDisk retrieves the RHCOS URL for the specified architecture's Azure disk image

func GetROSAClusterID ¶

func GetROSAClusterID() string

Get cluster ID for ROSA created cluster

func GetRandomString ¶

func GetRandomString() string

GetRandomString to create random string

func GetReleaseImage ¶

func GetReleaseImage(oc *exutil.CLI) (string, error)

GetReleaseImage returns the release image as string value (Ex: registry.ci.openshift.org/ocp/release@sha256:b13971e61312f5dddd6435ccf061ac1a8447285a85828456edcd4fc2504cfb8f)

func GetRelicasByMachinesetName ¶

func GetRelicasByMachinesetName(oc *exutil.CLI, machinesetName string) string

GetRelicasByMachinesetName used for get replicas number by machineset name

func GetRemainingResourcesNodesMap ¶

func GetRemainingResourcesNodesMap(oc *exutil.CLI, nodes []v1.Node) map[string]NodeResources

GetRemainingResourcesNodesMap returns the total remaning CPU and Memory in each node

func GetRequestedResourcesNodesMap ¶

func GetRequestedResourcesNodesMap(oc *exutil.CLI, nodes []v1.Node) map[string]NodeResources

GetRequestedResourcesNodesMap returns the total requested CPU and Memory in each node

func GetResourceSpecificLabelValue ¶

func GetResourceSpecificLabelValue(oc *exutil.CLI, resourceKindAndName string, resourceNamespace string, labelName string) (string, error)

GetResourceSpecificLabelValue gets the specified label value from the resource and label name

func GetRouterPodTemplate ¶

func GetRouterPodTemplate(oc *exutil.CLI) (*corev1.PodTemplateSpec, string, error)

GetRouterPodTemplate finds the router pod template across different namespaces, helping to mitigate the transition from the default namespace to an operator namespace.

func GetSAToken ¶

func GetSAToken(oc *exutil.CLI) (string, error)

GetSAToken get a token assigned to prometheus-k8s from openshift-monitoring namespace According to 2093780, the secret prometheus-k8s-token is removed from sa prometheus-k8s. So from 4.11, command <oc sa get-token prometheus-k8s -n openshift-monitoring> won't work Please install oc client and cluster with same major version.

func GetSchedulableLinuxWorkerNodes ¶

func GetSchedulableLinuxWorkerNodes(oc *exutil.CLI) ([]v1.Node, error)

GetSchedulableLinuxWorkerNodes returns a group of nodes that match the requirements: os: linux, role: worker, status: ready, schedulable

func GetSpecificPodLogs ¶

func GetSpecificPodLogs(oc *exutil.CLI, namespace string, container string, podName string, filter string) (string, error)

GetSpecificPodLogs returns the pod logs by the specific filter

func GetSpecificPodLogsCombinedOrNot ¶

func GetSpecificPodLogsCombinedOrNot(oc *exutil.CLI, namespace string, container string, podName string, filter string, combined bool) (string, error)

GetSpecificPodLogsCombinedOrNot returns the pod logs by the specific filter with combining stderr or not

func GetStatefulSetPods ¶

func GetStatefulSetPods(oc *exutil.CLI, setName string) (*kapiv1.PodList, error)

func GetSystemctlServiceUnitTimestampByPropertyNameWithMonotonic ¶

func GetSystemctlServiceUnitTimestampByPropertyNameWithMonotonic(propertyValue string) int

func GetUserAssignedIdentityPrincipalID ¶

func GetUserAssignedIdentityPrincipalID(sess *AzureSession, resourceGroup string, identityName string) (string, error)

GetUserAssignedIdentityPrincipalID get user assigned identity PrincipalID

func GetUserCAToFile ¶

func GetUserCAToFile(oc *exutil.CLI, filename string) (err error)

GetUserCA dump user certificate from user-ca-bundle configmap to File

func GrantRoleToPrincipalIDByResourceGroup ¶

func GrantRoleToPrincipalIDByResourceGroup(sess *AzureSession, principalID string, resourceGroup string, roleId string) (roleAssignmentName string, scope string)

GrantRoleToPrincipalIDByResourceGroup grant role to principalID by resource group

func ImplStringArrayContains ¶

func ImplStringArrayContains(stringArray []string, name string) bool

fuction to check given string is in array or not

func InitDefaultEnvironmentVariables ¶

func InitDefaultEnvironmentVariables()

ProwGCPSetup makes sure certain required env vars are available in the case that extended tests are invoked directly via calls to ginkgo/extended.test

func InitStandardFlags ¶

func InitStandardFlags()

func InitTest ¶

func InitTest(dryRun bool) error

func InstallNFD ¶

func InstallNFD(oc *exutil.CLI, nfdNamespace string)

InstallNFD attempts to install the Node Feature Discovery operator and verify that it is running

func InstallPAO ¶

func InstallPAO(oc *exutil.CLI, paoNamespace string)

InstallPAO attempts to install the Performance Add-On operator and verify that it is running

func Is3MasterNoDedicatedWorkerNode ¶

func Is3MasterNoDedicatedWorkerNode(oc *exutil.CLI) bool

Is3MasterNoDedicatedWorkerNode reture if the OCP have three master/worker node, but no dedicated worker node.

func IsAKSCluster ¶

func IsAKSCluster(ctx context.Context, oc *exutil.CLI) (bool, error)

IsAKSCluster checks if the active cluster is an AKS (Azure Kubernetes Service) cluster or not

func IsArbiterCluster ¶

func IsArbiterCluster(oc *exutil.CLI) bool

A two-node-arbiter OpenShift cluster is a special type of high availability (HA) deployment designed to run in edge environments

func IsBase64Encoded ¶

func IsBase64Encoded(s string) bool

IsBase64Encoded checks if the input string is likely base64-encoded.

func IsClusterOperated ¶

func IsClusterOperated(oc *exutil.CLI) bool

func IsDefaultNodeSelectorEnabled ¶

func IsDefaultNodeSelectorEnabled(oc *exutil.CLI) bool

IsDefaultNodeSelectorEnabled judges whether the test cluster enabled the defaultNodeSelector

func IsDeploymentReady ¶

func IsDeploymentReady(deploy *appsv1.Deployment) bool

IsDeploymentReady checks if an *appsv1.Deployment is ready

func IsExternalOIDCCluster ¶

func IsExternalOIDCCluster(oc *exutil.CLI) (bool, error)

IsExternalOIDCCluster checks if the cluster is using external OIDC.

func IsHypershiftHostedCluster ¶

func IsHypershiftHostedCluster(oc *exutil.CLI) bool

IsHypershiftHostedCluster

func IsInfrastructuresHighlyAvailable ¶

func IsInfrastructuresHighlyAvailable(oc *exutil.CLI) bool

IsInfrastructuresHighlyAvailable check if it is HighlyAvailable for infrastructures. Available for both classic OCP and the hosted cluster.

func IsKeycloakExtOIDCCluster ¶

func IsKeycloakExtOIDCCluster() bool

IsKeycloakExtOIDCCluster assumes the cluster uses external oidc auth but checks if the oidc issuer is Keycloak.

func IsMachineSetExist ¶

func IsMachineSetExist(oc *exutil.CLI) bool

IsMachineSetExist check if machineset exist in OCP

func IsNamespacePrivileged ¶

func IsNamespacePrivileged(oc *exutil.CLI, namespace string) (bool, error)

IsNamespacePrivileged checks if a namespace has privileged SCC

func IsNodeLabeledByNFD ¶

func IsNodeLabeledByNFD(oc *exutil.CLI) bool

IsNodeLabeledByNFD Check if NFD Installed base on the cluster labels

func IsOneMasterWithNWorkerNodes ¶

func IsOneMasterWithNWorkerNodes(oc *exutil.CLI) bool

func IsOpenShiftCluster ¶

func IsOpenShiftCluster(ctx context.Context, c corev1client.NamespaceInterface) (bool, error)

IsOpenShiftCluster checks if the active cluster is OpenShift or a derivative

func IsPAOInOperatorHub ¶

func IsPAOInOperatorHub(oc *exutil.CLI) bool

IsPAOInOperatorHub used for checking if PAO exist in OperatorHub

func IsPAOInstalled ¶

func IsPAOInstalled(oc *exutil.CLI) bool

IsPAOInstalled used for deploying Performance Add-on Operator

func IsROSA ¶

func IsROSA() bool

IsROSA Determine whether it is a ROSA env, now only support prow

func IsROSACluster ¶

func IsROSACluster(oc *exutil.CLI) bool

IsROSACluster checks if the cluster is running on ROSA

func IsRosaCluster ¶

func IsRosaCluster(oc *exutil.CLI) bool

IsRosaCluster

func IsSNOCluster ¶

func IsSNOCluster(oc *exutil.CLI) bool

IsSNOCluster will check if OCP is a single node cluster

func IsSTSCluster ¶

func IsSTSCluster(oc *exutil.CLI) bool

IsSTSCluster determines if an AWS cluster is using STS

func IsSpecifiedAnnotationKeyExist ¶

func IsSpecifiedAnnotationKeyExist(oc *exutil.CLI, resourceKindAndName, resourceNamespace, annotationKey string) bool

IsSpecifiedAnnotationKeyExist judges whether the specified annotationKey exist on the resource

func IsTechPreviewNoUpgrade ¶

func IsTechPreviewNoUpgrade(oc *exutil.CLI) bool

IsTechPreviewNoUpgrade checks if a cluster is a TechPreviewNoUpgrade cluster

func IsWorkerNode ¶

func IsWorkerNode(oc *exutil.CLI, nodeName string) bool

IsWorkerNode judges whether the node has the worker role

func IsWorkloadIdentityCluster ¶

func IsWorkloadIdentityCluster(oc *exutil.CLI) bool

IsWorkloadIdentityCluster judges whether the Azure/GCP cluster is using the Workload Identity

func KubeConfigPath ¶

func KubeConfigPath() string

KubeConfigPath returns the value of KUBECONFIG environment variable

func LDAPClientMounts ¶

func LDAPClientMounts() ([]corev1.VolumeMount, []corev1.Volume)

func LabelPod ¶

func LabelPod(oc *exutil.CLI, namespace string, podName string, label string) error

LabelPod labels a given pod with a given label in a given namespace

func LaunchWebserverPod ¶

func LaunchWebserverPod(f *e2e.Framework, podName, nodeName string) (ip string)

LaunchWebserverPod launches a pod serving http on port 8080 to act as the target for networking connectivity checks. The ip address of the created pod will be returned if the pod is launched successfully.

func ListGCSBuckets ¶

func ListGCSBuckets(client storage.Client, projectID string) ([]string, error)

ListGCSBuckets gets all the bucket names under the projectID

func ListImages ¶

func ListImages() ([]string, error)

ListImages initiates the equivalent of a `docker images`

func ListServersByName ¶

func ListServersByName(client *gophercloud.ServiceClient, instanceName string) ([]servers.Server, error)

ListServersByName retrieves a list of servers matching the given instance name.

func ModifyYamlFileContent ¶

func ModifyYamlFileContent(file string, replacements []YamlReplace)

ModifyYamlFileContent modify the content of YAML file given the file path and a list of YamlReplace struct. Example: ModifyYamlFileContent(file, []YamlReplace {

	{
		Path: 'spec.template.spec.imagePullSecrets',
		Value: '- name: notmatch-secret',
	},
})

func MoveFileToPath ¶

func MoveFileToPath(srcPath string, destPath string)

MoveFileToPath attempts to move a file from srcPath to destPath.

func MustGetAzureCredsLocation ¶

func MustGetAzureCredsLocation() string

func NewAzureContainerClient ¶

func NewAzureContainerClient(oc *exutil.CLI, accountName, accountKey, azContainerName string) (azblob.ContainerURL, error)

NewAzureContainerClient initializes a new azure blob container client

func NewCLI ¶

func NewCLI(project, adminConfigPath string) *exutil.CLI

NewCLI initialize the upstream E2E framework and set the namespace to match with the project name. Note that this function does not initialize the project role bindings for the namespace.

func NewCLIForKube ¶

func NewCLIForKube(basename string) *exutil.CLI

NewCLIForKube initializes the exutil.CLI for tests against pure Kubernetes environments

func NewCLIForKubeOpenShift ¶

func NewCLIForKubeOpenShift(basename string) *exutil.CLI

NewCLIForKubeOpenShift provides a exutil.CLI that detects Kubernetes or OpenShift

func NewCLIWithoutNamespace ¶

func NewCLIWithoutNamespace(project string) *exutil.CLI

NewCLIWithoutNamespace initializes the upstream E2E framework in a non-namespaced context. Most commonly used for global object (non-namespaced) tests.

func NewOpenStackClient ¶

func NewOpenStackClient(cred *OpenstackCredentials, serviceType string) *gophercloud.ServiceClient

func NewPodExecutor ¶

func NewPodExecutor(oc *exutil.CLI, name, image string) (*podExecutor, error)

NewPodExecutor returns an executor capable of running commands in a Pod.

func NewRuleResolver ¶

func NewRuleResolver(informers rbacinformers.Interface) rbacregistryvalidation.AuthorizationRuleResolver

func OrFail ¶

func OrFail[T any](vals ...any) T

OrFail function will process another function's return values and fail if any of those returned values is ane error != nil and returns the first value example: if we have: func getValued() (string, error)

we can do:  value := OrFail[string](getValue())

func ParameterizedTemplateByReplaceToFile ¶

func ParameterizedTemplateByReplaceToFile(oc *exutil.CLI, parameters ...string) string

ParameterizedTemplateByReplaceToFile parameterize template to new file

func ParseLabelsOrDie ¶

func ParseLabelsOrDie(str string) labels.Selector

ParseLabelsOrDie turns the given string into a label selector or panics; for tests or other cases where you know the string is valid. TODO: Move this to the upstream labels package.

func PathExists ¶

func PathExists(path string) (bool, error)

PathExists @Description Check if a file exists @Create jianl Jan 22 2025 @Param path string the file path @Return (bool, error)

func PerformInstanceActionOnPowerVs ¶

func PerformInstanceActionOnPowerVs(powerClient *IBMPowerVsSession, instanceID, action string) error

PerformInstanceActionOnPowerVs performs start or stop action on the instance

func PreDetermineExternalOIDCCluster ¶

func PreDetermineExternalOIDCCluster() (bool, error)

PreDetermineExternalOIDCCluster checks if the cluster is using external OIDC preflight to avoid to check it everytime.

func PreDetermineK8sCluster ¶

func PreDetermineK8sCluster() (isK8s bool, err error)

PreDetermineK8sCluster checks if the active cluster is a Kubernetes cluster (as opposed to OpenShift).

func PreSetEnvK8s ¶

func PreSetEnvK8s() (res string)

func PreSetEnvOIDCCluster ¶

func PreSetEnvOIDCCluster() (res string)

func PreTestDump ¶

func PreTestDump()

func ProcessAzurePages ¶

func ProcessAzurePages[T any](ctx context.Context, pager *runtime.Pager[T], handlePage func(page T) error) error

func ProcessTemplate ¶

func ProcessTemplate(oc *exutil.CLI, parameters ...string) string

ProcessTemplate process template given file path and parameters

func ROSALogin ¶

func ROSALogin()

ROSALogin rosa login, If the login fails then skip

func ROSAValidHypershiftAndGetGuestKubeConf ¶

func ROSAValidHypershiftAndGetGuestKubeConf(oc *exutil.CLI) (string, string, string)

ROSAValidHypershiftAndGetGuestKubeConf check if it is ROSA-hypershift env and get kubeconf of the hosted cluster, only support prow the first return is hosted cluster name the second return is the file of kubeconfig of the hosted cluster the third return is the hostedcluster namespace in mgmt cluster which contains the generated resources if it is not hypershift env, it will skip test.

func RandStr ¶

func RandStr(n int) string

RandStr This is a utility function for random strings n: random strings' length

func RandStrCustomize ¶

func RandStrCustomize(s string, n int) string

RandStrCustomize This is a utility function for random strings n: random strings' length, s: Customizable String Sets

func RandStrDefault ¶

func RandStrDefault() string

RandStrDefault This is a utility function for random strings random strings' length=8

func ReadFixture ¶

func ReadFixture(path string) (runtime.Object, error)

func ReadFixtureOrFail ¶

func ReadFixtureOrFail(path string) runtime.Object

func ReadLDAPServerTestData ¶

func ReadLDAPServerTestData() (*app.Deployment, *corev1.Service, *corev1.ConfigMap, *corev1.ConfigMap)

func RecoverNamespaceRestricted ¶

func RecoverNamespaceRestricted(oc *exutil.CLI, namespace string) error

RecoverNamespaceRestricted recovers a namespace to restricted mode

func RemoteShContainer ¶

func RemoteShContainer(oc *exutil.CLI, namespace string, podName string, container string, cmd ...string) (string, error)

RemoteShContainer creates a remote shell of the given container inside the pod

func RemoteShPod ¶

func RemoteShPod(oc *exutil.CLI, namespace string, podName string, cmd ...string) (string, error)

RemoteShPod creates a remote shell of the pod

func RemoteShPodWithBash ¶

func RemoteShPodWithBash(oc *exutil.CLI, namespace string, podName string, cmd ...string) (string, error)

RemoteShPodWithBash creates a remote shell of the pod with bash

func RemoteShPodWithBashSpecifyContainer ¶

func RemoteShPodWithBashSpecifyContainer(oc *exutil.CLI, namespace string, podName string, containerName string, cmd ...string) (string, error)

RemoteShPodWithBashSpecifyContainer creates a remote shell of the pod with bash specifying container name

func RemoteShPodWithChroot ¶

func RemoteShPodWithChroot(oc *exutil.CLI, namespace string, podName string, cmd ...string) (string, error)

RemoteShPodWithChroot creates a remote shell of the pod with chroot

func RemoveAnnotationFromSpecificResource ¶

func RemoveAnnotationFromSpecificResource(oc *exutil.CLI, resourceKindAndName, resourceNamespace string, annotationName string) (string, error)

RemoveAnnotationFromSpecificResource removes the specified annotation from the resource

func RemoveDeploymentConfigs ¶

func RemoveDeploymentConfigs(oc *exutil.CLI, dcs ...string) error

RemoveDeploymentConfigs deletes the given DeploymentConfigs in a namespace

func RemovePodsWithPrefixes ¶

func RemovePodsWithPrefixes(oc *exutil.CLI, prefixes ...string) error

RemovePodsWithPrefixes deletes pods whose name begins with the supplied prefixes

func RemoveStatefulSets ¶

func RemoveStatefulSets(oc *exutil.CLI, sets ...string) error

RemoveStatefulSets deletes the given stateful sets in a namespace

func RunOneShotCommandPod ¶

func RunOneShotCommandPod(
	oc *exutil.CLI,
	name, image, command string,
	volumeMounts []corev1.VolumeMount,
	volumes []corev1.Volume,
	env []corev1.EnvVar,
	timeout time.Duration,
) (string, []error)

RunOneShotCommandPod runs the given command in a pod and waits for completion and log output for the given timeout duration, returning the command output or an error. TODO: merge with the PodExecutor above

func Secure ¶

func Secure(securedMatcher types.GomegaMatcher) types.GomegaMatcher

func SetNamespacePrivileged ¶

func SetNamespacePrivileged(oc *exutil.CLI, namespace string) error

SetNamespacePrivileged sets a namespace to use privileged SCC

func SetVPCServiceURLForRegion ¶

func SetVPCServiceURLForRegion(session *IBMSession, region string) error

SetVPCServiceURLForRegion will set the VPC Service URL to a specific IBM Cloud Region, in order to access Region scoped resources

func SetupK8SNFSServerAndVolume ¶

func SetupK8SNFSServerAndVolume(oc *exutil.CLI, count int) (*kapiv1.Pod, []*kapiv1.PersistentVolume, error)

SetupK8SNFSServerAndVolume sets up an nfs server pod with count number of persistent volumes

func ShowSystemctlPropertyValueOfServiceUnitByName ¶

func ShowSystemctlPropertyValueOfServiceUnitByName(oc *exutil.CLI, tunedNodeName string, ntoNamespace string, serviceUnit string, propertyName string) string

func SkipBaselineCaps ¶

func SkipBaselineCaps(oc *exutil.CLI, sets string)

SkipBaselineCaps skip the test if cluster has no required resources. sets is comma separated list of baselineCapabilitySets to skip. for example: "None, v4.11"

func SkipForSNOCluster ¶

func SkipForSNOCluster(oc *exutil.CLI)

SkipForSNOCluster skip for SNO cluster

func SkipIfCapEnabled ¶

func SkipIfCapEnabled(oc *exutil.CLI, capability string)

SkipIfCapEnabled skips the test if a capability is enabled

func SkipIfDisableDefaultCatalogsource ¶

func SkipIfDisableDefaultCatalogsource(oc *exutil.CLI)

Skip the test if default catsrc is disable

func SkipIfPlatformType ¶

func SkipIfPlatformType(oc *exutil.CLI, platforms string)

skip platform

func SkipIfPlatformTypeNot ¶

func SkipIfPlatformTypeNot(oc *exutil.CLI, platforms string)

SkipIfPlatformTypeNot skips all platforms other than supported platforms is comma separated list of allowed platforms for example: "gcp, aws"

func SkipMissingQECatalogsource ¶

func SkipMissingQECatalogsource(oc *exutil.CLI)

Skip the test if there is not catalogsource/qe-app-registry in the cluster

func SkipNoBuild ¶

func SkipNoBuild(oc *exutil.CLI)

SkipNoBuild skip the test if the cluster has no Build component

func SkipNoCapabilities ¶

func SkipNoCapabilities(oc *exutil.CLI, capability string)

SkipNoCapabilities skip the test if the cluster has no one capability

func SkipNoDefaultSC ¶

func SkipNoDefaultSC(oc *exutil.CLI)

SkipNoDefaultSC skip the test if cluster has no default storageclass or has more than 1 default storageclass

func SkipNoDeploymentConfig ¶

func SkipNoDeploymentConfig(oc *exutil.CLI)

SkipNoDeploymentConfig skip the test if the cluster has no DeploymentConfig component

func SkipNoImageRegistry ¶

func SkipNoImageRegistry(oc *exutil.CLI)

SkipNoImageRegistry skip the test if the cluster has no ImageRegistry component

func SkipNoOLMCore ¶

func SkipNoOLMCore(oc *exutil.CLI)

SkipNoOLMCore skip the test if the cluster has no OLM component from 4.15, OLM become optional core component. it means there is no OLM component for some profiles. so, the OLM case and optioinal operator case can not run on such cluster.

func SkipNoOLMv1Core ¶

func SkipNoOLMv1Core(oc *exutil.CLI)

func SkipOnAKSNess ¶

func SkipOnAKSNess(ctx context.Context, oc *exutil.CLI, expectAKS bool)

func SkipOnHypershiftOperatorExistence ¶

func SkipOnHypershiftOperatorExistence(mgmtOC *exutil.CLI, expectHO bool)

func SkipOnOpenShiftNess ¶

func SkipOnOpenShiftNess(expectOpenShift bool)

SkipOnOpenShiftNess skips the test if the cluster type doesn't match the expected type.

func SkipOnProxyCluster ¶

func SkipOnProxyCluster(oc *exutil.CLI)

Skip for proxy platform

func SpecifyMachinesetWithDifferentInstanceType ¶

func SpecifyMachinesetWithDifferentInstanceType(oc *exutil.CLI) string

SpecifyMachinesetWithDifferentInstanceType used for specify cpu type that different from default one

func StartAzureStackVM ¶

func StartAzureStackVM(resourceGroupName, vmName string) error

StartAzureStackVM starts the virtual machine with the given name in the specified resource group using Azure exutil.CLI

func StartAzureVM ¶

func StartAzureVM(sess *AzureSession, vmName string, resourceGroupName string) (osr autorest.Response, err error)

StartAzureVM starts the selected VM

func StartBuild ¶

func StartBuild(oc *exutil.CLI, args ...string) (stdout, stderr string, err error)

StartBuild executes OC start-build with the specified arguments. StdOut and StdErr from the process are returned as separate strings.

func StartIBMInstance ¶

func StartIBMInstance(session *IBMSession, instanceID string) error

StartIBMInstance start the IBM instance

func StopAzureStackVM ¶

func StopAzureStackVM(resourceGroupName, vmName string) error

StopAzureStackVM stops the virtual machine with the given name in the specified resource group using Azure exutil.CLI

func StopAzureVM ¶

func StopAzureVM(sess *AzureSession, vmName string, resourceGroupName string) (osr autorest.Response, err error)

StopAzureVM stops the selected VM

func StopIBMInstance ¶

func StopIBMInstance(session *IBMSession, instanceID string) error

StopIBMInstance stop the IBM instance

func StringToBASE64 ¶

func StringToBASE64(src string) string

StringToBASE64 Base64 Encode

func StringsSliceContains ¶

func StringsSliceContains(stringsSlice []string, element string) (bool, int)

StringsSliceContains judges whether the strings Slice contains specific element, return bool and the first matched index If no matched return (false, 0)

func StringsSliceElementsAddSuffix ¶

func StringsSliceElementsAddSuffix(stringsSlice []string, suffix string) []string

StringsSliceElementsAddSuffix returns a new string slice all elements with the specific suffix added

func StringsSliceElementsHasPrefix ¶

func StringsSliceElementsHasPrefix(stringsSlice []string, elementPrefix string, sequentialFlag bool) (bool, int)

StringsSliceElementsHasPrefix judges whether the strings Slice contains an element which has the specific prefix returns bool and the first matched index sequential order: -> sequentialFlag: "true" reverse order: -> sequentialFlag: "false" If no matched return (false, 0)

func TimedWaitForAnImageStreamTag ¶

func TimedWaitForAnImageStreamTag(oc *exutil.CLI, namespace, name, tag string, waitTimeout time.Duration) error

TimedWaitForAnImageStreamTag waits until an image stream with given name has non-empty history for given tag. Gives up waiting after the specified waitTimeout

func UpdateFile ¶

func UpdateFile(filePath string, stringPairs []StringPairs) (err error)

updateFile @Description Replace oldString in a given file by newString @Create jianl Jan 22 2025 @Param filePath string the file path @Param stringPairs StringPairs a list of struct of old string and new string @Return nil

func ValidHypershiftAndGetGuestKubeConf ¶

func ValidHypershiftAndGetGuestKubeConf(oc *exutil.CLI) (string, string, string)

ValidHypershiftAndGetGuestKubeConf check if it is hypershift env and get kubeconf of the hosted cluster the first return is hosted cluster name the second return is the file of kubeconfig of the hosted cluster the third return is the hostedcluster namespace in mgmt cluster which contains the generated resources if it is not hypershift env, it will skip test.

func ValidHypershiftAndGetGuestKubeConf4SecondHostedCluster ¶

func ValidHypershiftAndGetGuestKubeConf4SecondHostedCluster(oc *exutil.CLI) (string, string, string)

ValidHypershiftAndGetGuestKubeConf4SecondHostedCluster check if it is hypershift env and get kubeconf of the hosted cluster the first return is hosted cluster name the second return is the file of kubeconfig of the hosted cluster the third return is the hostedcluster namespace in mgmt cluster which contains the generated resources if it is not hypershift env, it will skip test.

func ValidHypershiftAndGetGuestKubeConfWithNoSkip ¶

func ValidHypershiftAndGetGuestKubeConfWithNoSkip(oc *exutil.CLI) (string, string, string)

ValidHypershiftAndGetGuestKubeConfWithNoSkip check if it is hypershift env and get kubeconf of the hosted cluster the first return is hosted cluster name the second return is the file of kubeconfig of the hosted cluster the third return is the hostedcluster namespace in mgmt cluster which contains the generated resources if it is not hypershift env, it will not skip the testcase and return null string.

func VarSubOnFile ¶

func VarSubOnFile(srcFile string, destFile string, vars map[string]string) error

VarSubOnFile reads in srcFile, finds instances of ${key} from the map and replaces them with their associated values.

func WaitAndGetSpecificPodLogs ¶

func WaitAndGetSpecificPodLogs(oc *exutil.CLI, namespace string, container string, podName string, filter string) (string, error)

WaitAndGetSpecificPodLogs wait and return the pod logs by the specific filter

func WaitForABuild ¶

func WaitForABuild(c buildv1clienttyped.BuildInterface, name string, isOK, isFailed, isCanceled func(*buildv1.Build) bool) error

WaitForABuild waits for a Build object to match either isOK or isFailed conditions.

func WaitForAJob ¶

func WaitForAJob(c batchv1client.JobInterface, name string, timeout time.Duration) error

func WaitForAnImageStream ¶

func WaitForAnImageStream(client imagev1typedclient.ImageStreamInterface,
	name string,
	isOK, isFailed func(*imagev1.ImageStream) bool) error

WaitForAnImageStream waits for an ImageStream to fulfill the isOK function

func WaitForAnImageStreamTag ¶

func WaitForAnImageStreamTag(oc *exutil.CLI, namespace, name, tag string) error

WaitForAnImageStreamTag waits until an image stream with given name has non-empty history for given tag. Defaults to waiting for 300 seconds

func WaitForBuildResult ¶

func WaitForBuildResult(c buildv1clienttyped.BuildInterface, result *BuildResult) error

WaitForBuildResult updates result wit the state of the build

func WaitForDeploymentConfig ¶

func WaitForDeploymentConfig(kc kubernetes.Interface, dcClient appsv1clienttyped.DeploymentConfigsGetter, namespace, name string, version int64, enforceNotProgressing bool, cli *exutil.CLI) error

WaitForDeploymentConfig waits for a DeploymentConfig to complete transition to a given version and report minimum availability.

func WaitForDeploymentsReady ¶

func WaitForDeploymentsReady(ctx context.Context, listDeployments func(ctx context.Context) (*appsv1.DeploymentList, error),
	isDeploymentReady func(*appsv1.Deployment) bool, timeout, interval time.Duration, printDebugInfo bool)

WaitForDeploymentsReady polls listDeployments() until deployments obtained are ready

func WaitForEndpoint ¶

func WaitForEndpoint(c kclientset.Interface, ns, name string) error

func WaitForEndpointsAvailable ¶

func WaitForEndpointsAvailable(oc *exutil.CLI, serviceName string) error

func WaitForHypershiftHostedClusterReady ¶

func WaitForHypershiftHostedClusterReady(oc *exutil.CLI, hostedClusterName, hostedClusterNS string)

WaitForHypershiftHostedClusterReady waits for the hostedCluster ready

func WaitForInternalRegistryHostname ¶

func WaitForInternalRegistryHostname(oc *exutil.CLI) (string, error)

WaitForInternalRegistryHostname waits for the internal registry hostname to be made available to the cluster.

func WaitForNoPodsAvailable ¶

func WaitForNoPodsAvailable(oc *exutil.CLI) error

WaitForNoPodsAvailable waits until there are no pods in the given namespace

func WaitForNoPodsAvailableByKind ¶

func WaitForNoPodsAvailableByKind(oc *exutil.CLI, kind string, name string, namespace string)

WaitForNoPodsAvailableByKind used for checking no pods in a certain namespace

func WaitForNodeToDisappear ¶

func WaitForNodeToDisappear(oc *exutil.CLI, nodeName string, timeout, interval time.Duration)

func WaitForOpenShiftNamespaceImageStreams ¶

func WaitForOpenShiftNamespaceImageStreams(oc *exutil.CLI) error

WaitForOpenShiftNamespaceImageStreams waits for the standard set of imagestreams to be imported

func WaitForPods ¶

func WaitForPods(c corev1client.PodInterface, label labels.Selector, predicate func(kapiv1.Pod) bool, count int, timeout time.Duration) ([]string, error)

WaitForPods waits until given number of pods that match the label selector and satisfy the predicate are found

func WaitForQueryOutputContains ¶

func WaitForQueryOutputContains(oc *exutil.CLI, d Database, timeout time.Duration, admin bool, query, resultSubstr string) error

WaitForQueryOutputContains will execute the query multiple times, until the specified substring is found in the results. This function should be used for testing replication, since it might take some time until the data is propagated to slaves.

func WaitForQueryOutputSatisfies ¶

func WaitForQueryOutputSatisfies(oc *exutil.CLI, d Database, timeout time.Duration, admin bool, query string, predicate func(string) bool) error

WaitForQueryOutputSatisfies will execute the query multiple times, until the specified predicate function is return true.

func WaitForResourceQuotaSync ¶

func WaitForResourceQuotaSync(
	client corev1client.ResourceQuotaInterface,
	name string,
	expectedUsage corev1.ResourceList,
	expectedIsUpperLimit bool,
	timeout time.Duration,
) (corev1.ResourceList, error)

WaitForResourceQuotaSync watches given resource quota until its usage is updated to desired level or a timeout occurs. If successful, used quota values will be returned for expected resources. Otherwise an ErrWaitTimeout will be returned. If expectedIsUpperLimit is true, given expected usage must compare greater or equal to quota's usage, which is useful for expected usage increment. Otherwise expected usage must compare lower or equal to quota's usage, which is useful for expected usage decrement.

func WaitForResourceUpdate ¶

func WaitForResourceUpdate(ctx context.Context, oc *exutil.CLI, interval, timeout time.Duration, kindAndName, namespace, oldResourceVersion string) error

WaitForResourceUpdate waits for the resourceVersion of a resource to be updated

func WaitForRouterInternalIP ¶

func WaitForRouterInternalIP(oc *exutil.CLI) (string, error)

func WaitForRouterServiceIP ¶

func WaitForRouterServiceIP(oc *exutil.CLI) (string, error)

func WaitForSelfSAR ¶

func WaitForSelfSAR(interval, timeout time.Duration, c kclientset.Interface, selfSAR authorizationapiv1.SelfSubjectAccessReviewSpec) error

func WaitForServiceAccount ¶

func WaitForServiceAccount(c corev1client.ServiceAccountInterface, name string, checkSecret bool) error

WaitForServiceAccount waits until the named service account gets fully provisioned

func WaitForUserBeAuthorized ¶

func WaitForUserBeAuthorized(oc *exutil.CLI, user, verb, resource string) error

WaitForUserBeAuthorized waits a minute until the cluster bootstrap roles are available and the provided user is authorized to perform the action on the resource.

func WaitOprResourceReady ¶

func WaitOprResourceReady(oc *exutil.CLI, kind, name, namespace string, islongduration bool, excludewinnode bool)

WaitOprResourceReady used for checking if deployment/daemonset/statefulset is ready

func WaitUntilAllHelpersAreUp ¶

func WaitUntilAllHelpersAreUp(oc *exutil.CLI, helpers []Database) error

WaitUntilAllHelpersAreUp waits until all helpers are ready to serve requests.

func WaitUntilPodIsGone ¶

func WaitUntilPodIsGone(c corev1client.PodInterface, podName string, timeout time.Duration) error

WaitUntilPodIsGone waits until the named Pod will disappear

func WaitUntilUp ¶

func WaitUntilUp(oc *exutil.CLI, d Database, timeout time.Duration) error

WaitUntilUp continuously waits for the server to become ready, up until timeout.

func Yaml2Json ¶

func Yaml2Json(s string) (string, error)

Yaml2Json converts yaml file to json format. Example:

util.Yaml2Json(string(yamlFile))