🌱 Release Notes Generator - Test cases for main.go and ref.go

[irapandey]

What this PR does / why we need it:
This PR adds unit tests for release note generator to add more coverage to non-covered functions

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #
This PR partially fixes #11368
Will raise small PRs to make review easier

/area testing

[k8s-ci-robot]

Welcome @irapandey!

It looks like this is your first PR to kubernetes-sigs/cluster-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/cluster-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]

Hi @irapandey. 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-sigs/prow repository.

[irapandey]

@chandankumar4 - Can you take a look here please

[sbueringer]

/ok-to-test

[chandankumar4]

/assign chandankumar4

[chandankumar4]

/lgtm
Thanks

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: e0e128671fa7e8b466ea91d29b477196b8f27802

[chandankumar4]

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: chandankumar4
Once this PR has been reviewed and has the lgtm label, please assign mboersma for approval. For more information see the 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:

• hack/tools/release/OWNERS

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

[sbueringer]

You'll need an approve from a maintainer. It's in my queue, just not highest priority considering we are 2 weeks away from code freeze :)

[chrischdi]

Some improvements :-)

[chrischdi]

Let's add a case which sets branch instead of fromRef

[irapandey]

Are we talking about something on these lines?

{
  name: "Missing fromRef when newTag is set",
  args: &notesCmdConfig{
  branch: "main",
  toRef:   "ref2/tags",
  newTag:  "v1.0.0",
  },
  wantErr: false,
},

[chrischdi]

yes

[chrischdi]

But more:

{
  name: "Missing branch when newTag is set",
  args: &notesCmdConfig{
  branch: "main",
  toRef:   "ref2/tags",
  newTag:  "v1.0.0",
  },
  wantErr: false,
},

[chrischdi]

or doesn't this make sense?

[irapandey]

Yup - this does look better

[irapandey]

but if it's missing branch, we shouldn't be setting branch(leave it blank)
We already have this when branch is not set

{
  name: "Valid fromRef, toRef, and newTag",
  args: &notesCmdConfig{
    fromRef: "ref1/tags",
    toRef:   "ref2/tags",
    newTag:  "v1.0.0",
  },
  wantErr: false,
},

[irapandey]

is it expected to set branch using the toRef and fromRef?

[k8s-ci-robot]

New changes are detected. LGTM label has been removed.