Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added a new unit test case #2752

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

soravkumarsharma
Copy link

What type of PR is this?
/kind test

What this PR does / why we need it:
In the context of NewGatewayRef function, having a nil test case allows you to verify that the function correctly handles nil values for the listenerNames parameter. If function is designed to handle nil values by providing some default behavior, this test case ensures that the default behavior is working as intended.

Which issue(s) this PR fixes:
If NewGatewayRef function is expected to provide default values or behavior when the listenerNames parameter is nil, the test case helps ensure that the defaults are correctly applied.

Fixes #

Does this PR introduce a user-facing change?:
NONE


@k8s-ci-robot
Copy link
Contributor

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

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.

@k8s-ci-robot k8s-ci-robot added kind/test do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Feb 5, 2024
Copy link

linux-foundation-easycla bot commented Feb 5, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: soravkumarsharma / name: Sorav Kumar Sharma (7a5b1a1)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Feb 5, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @soravkumarsharma!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. 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/gateway-api 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 k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 5, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @soravkumarsharma. 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.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: soravkumarsharma
Once this PR has been reviewed and has the lgtm label, please assign sunjaybhatia for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

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

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Feb 5, 2024
name: "verifying the contents of a GatewayRef with nil listener names",
nsn: types.NamespacedName{Namespace: corev1.NamespaceDefault, Name: "fake-gateway"},
// nil listenerNames
listenerNames: nil,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Golang the zero value of a slice is nil, so this is equivalent to the first test case which omits the value entirely.

}

for i := 0; i < len(tests); i++ {
test := tests[i]
t.Run(test.name, func(t *testing.T) {
ref := NewGatewayRef(test.nsn, test.listenerNames...)
require.IsType(t, GatewayRef{}, ref)
if test.listenerNames == nil {
if test.listenerNames == nil || len(test.listenerNames) == 0 {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So looking through the code it does appear that we treat a nil or empty slice of listenerNames the same (by appending a single "empty" listenerName (which in retrospect I'm a little weirded out by, but for the sake of the test let's roll with it for a moment)), but in this test we treat it differently: if you were to provided a non-nil empty list of names you would get an appended "empty" name, which prior to this change would actually fail because it would jump to the next block and panic?

So I think this change makes sense, but in your test above you should provide a non-nil empty slice (e.g. []string{}) instead.

@shaneutt
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 12, 2024
@k8s-ci-robot
Copy link
Contributor

@soravkumarsharma: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-gateway-api-test 7a5b1a1 link true /test pull-gateway-api-test

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. kind/test ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants