Add condition for checking if a deployment is available

[ryankwilliams]

Change

This PR adds a new condition to check if a deployment is available. The wait condition only requires the user to provide the deployment name and namespace and the condition method will handle building the deployment object/checking the deployment condition for a match.

With this new condition, it will remove the need for the user to build the deployment object and call deployment condition match condition in their code bases.

Before

import (
    "os"
    appsv1 "k8s.io/api/apps/v1"
    metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    "sigs.k8s.io/e2e-framework/klient/wait"
    "sigs.k8s.io/e2e-framework/klient/wait/conditions"
)

deployment := &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Name: "deployment", Namespace: "namespace"}}
err = wait.For(conditions.New(client).DeploymentConditionMatch(deployment, appsv1.DeploymentAvailable, v1.ConditionTrue))
if err != nil {
    fmt.Printf("error waiting for deployment to become available: %v", err)
    os.Exit(1)
}

After

import (
    "os"
    "sigs.k8s.io/e2e-framework/klient/wait"
    "sigs.k8s.io/e2e-framework/klient/wait/conditions"
)

err = wait.For(conditions.New(client).DeploymentAvailable("deployment", "namespace"))
if err != nil {
    fmt.Printf("error waiting for deployment to become available: %v", err)
    os.Exit(1)
}

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: ryankwilliams / name: Ryan Williams (3d55e45)

[k8s-ci-robot]

Welcome @ryankwilliams!

It looks like this is your first PR to kubernetes-sigs/e2e-framework 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/e2e-framework has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @ryankwilliams. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[ShwethaKumbla]

@ryankwilliams Thanks for simplifying the usage.

[ShwethaKumbla]

/ok-to-test

[ShwethaKumbla]

LGTM.
/cc @vladimirvivien

[ShwethaKumbla]

/approve

[vladimirvivien]

Thanks @ryankwilliams for the contribution.
While this is a helper, I am concerned it too much of a one-of. My issue is that it is specific to a single API resource. If we have one for Deployment, should we not have one for, say Pod, or Service, etc.

Now, if you can figure out a way to make the helper more generic, then I think that would be better for the e2e-framework API usability. For instance, you could do something that creates a condition for any resource

err = wait.For(conditions.New(client).ResourceAvailable(corev1.ObjectMeta{Name:"my-deployment", Namespace:"my-ns"}, schema.GroupVersionResource{Group: "apps", Version: "v1", Resource: "deployment"}))
if err != nil {
    fmt.Printf("error waiting for deployment to become available: %v", err)
    os.Exit(1)
}

Or, follow the options api pattern that is already used in the e2e-framework

err = wait.For(conditions.New(client).ResourceAvailable(
    conditions.WithObjectName("my-deployment"),
    conditions.WithNamespace("Namespace"), 
    conditions.WithObjectGVR("apps", "v1", "deployment"),
))
if err != nil {
    fmt.Printf("error waiting for deployment to become available: %v", err)
    os.Exit(1)
}

[ryankwilliams]

Thank you @vladimirvivien for your reply!

I was following in the same steps as lines 269 -> 294 where helper functions existed to see if a pod was ready, containers ready, pod running, job completed or job failed.

Thank you for sharing the code examples, I will rethink on this to see about making it into a more generic helper.

[vladimirvivien]

@ryankwilliams you were absolutely right to think this was the proper direction to take originally (based on the code link in your last comment). I should have made that point in the original PR.

Nevertheless, if you have time to do a generic version of wait, then you are welcome to. If not, we can accept the original changes since there is precedence.

[ryankwilliams]

Hi @vladimirvivien, Thank you for your response. My apologies on the delayed follow up. I have not had time to work on a generic version of wait yet. For now, if you would like to accept my original change, please feel free to else I can close this.

[vladimirvivien]

Thank you for your contribution.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ryankwilliams, ShwethaKumbla, vladimirvivien

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [ShwethaKumbla,vladimirvivien]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment