Document -skip flag in go test

[reetasingh]

Fixes #200

Go 1.20 introduces the -skip flag for go test command to skip tests.
Document how to use this flag in examples/skip_flags

[k8s-ci-robot]

Welcome @reetasingh!

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 @reetasingh. 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.

[cpanato]

lgtm
/ok-to-test
/assign @vladimirvivien

[vladimirvivien]

@reetasingh Thank you for your contribution. This is a good start. Can you also add an example that shows using both the new -skip flag and existing e2e-framework --skip-xxx flags? That way readers can see that they are different and impact the tests differently.

[harshanarayana]

Can you also add an example that shows using both the new -skip flag and existing e2e-framework --skip-xxx flags?

@reetasingh @vladimirvivien @cpanato Should we also not document what happens to the frameworks Setup and teardown handlers when used in conjunction with -skip provided by the go test infra ?

[reetasingh]

@reetasingh Thank you for your contribution. This is a good start. Can you also add an example that shows using both the new -skip flag and existing e2e-framework --skip-xxx flags? That way readers can see that they are different and impact the tests differently.

Hi @vladimirvivien I have added some examples

[reetasingh]

Can you also add an example that shows using both the new -skip flag and existing e2e-framework --skip-xxx flags?

@reetasingh @vladimirvivien @cpanato Should we also not document what happens to the frameworks Setup and teardown handlers when used in conjunction with -skip provided by the go test infra ?

Hi @harshanarayana by this you mean what happens when we skip the TestMain itself?

Looks like that is not possibel

reeta@Reetas-MacBook-Pro e2e-framework % go test -v  ./examples/skip_flags -skip TestMain/
=== RUN   TestSkipFlags
=== RUN   TestSkipFlags/pod_list
=== RUN   TestSkipFlags/pod_list/pods_from_kube-system
    k8s_test.go:43: found 8 pods
=== RUN   TestSkipFlags/appsv1/deployment
=== RUN   TestSkipFlags/appsv1/deployment/deployment_creation
    k8s_test.go:77: deployment found: test-deployment
--- PASS: TestSkipFlags (2.01s)
    --- PASS: TestSkipFlags/pod_list (0.01s)
        --- PASS: TestSkipFlags/pod_list/pods_from_kube-system (0.01s)
    --- PASS: TestSkipFlags/appsv1/deployment (2.01s)
        --- PASS: TestSkipFlags/appsv1/deployment/deployment_creation (0.00s)
PASS
ok  	sigs.k8s.io/e2e-framework/examples/skip_flags	30.287s

[cpanato]

lgtm

thanks!

[vladimirvivien]

I think the doc is in a good place now.
@harshanarayana take a look and let us know if you are Ok with current state.

[harshanarayana]

/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: harshanarayana, reetasingh

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 [harshanarayana]

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

[harshanarayana]

@vladimirvivien adding an LGTM from my end.