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.

Sign up for GitHub

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

Jump to bottom

Added unit tests for the tools/releases package #15017

Merged
merged 1 commit into from
Jan 28, 2024
Merged

Added unit tests for the tools/releases package #15017

merged 1 commit into from
Jan 28, 2024

Conversation

VaibhavMalik4187
Copy link
Contributor

Description

This commit bumps the code coverage of the tools/releases package from 0% to almost 60%.

Related Issue(s)

Partially addresses: #14931

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Jan 23, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Jan 23, 2024
@github-actions github-actions bot added this to the v19.0.0 milestone Jan 23, 2024
@VaibhavMalik4187
Copy link
Contributor Author

@frouioui could you please review this PR whenever you have a moment? Thanks :)

@frouioui frouioui added Type: Testing Component: General Changes throughout the code base Backport to: release-16.0 and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required Backport to: release-16.0 labels Jan 23, 2024
@codecov Codecov
Copy link

codecov bot commented Jan 23, 2024 •
edited
Loading

Codecov Report

Attention: 435 lines in your changes are missing coverage. Please review.

Comparison is base (eddb39e) 47.29% compared to head (a6c5763) 47.45%.
Report is 55 commits behind head on main.

Files Patch % Lines
...vt/vtgate/planbuilder/operators/sharded_routing.go 0.00% 42 Missing ⚠️
go/vt/vtgate/semantics/early_rewriter.go 86.41% 23 Missing and 10 partials ⚠️
go/vt/vtgate/planbuilder/operators/delete.go 0.00% 32 Missing ⚠️
.../vtgate/planbuilder/operators/delete_with_input.go 0.00% 31 Missing ⚠️
go/vt/vtgate/engine/delete_with_input.go 53.70% 23 Missing and 2 partials ⚠️
...tgate/planbuilder/operators/aggregation_pushing.go 0.00% 25 Missing ⚠️
...vt/vtgate/planbuilder/operators/queryprojection.go 0.00% 20 Missing ⚠️
.../vt/vtgate/planbuilder/operators/query_planning.go 0.00% 19 Missing ⚠️
go/vt/vtgate/evalengine/expr_tuple_bvar.go 62.50% 14 Missing and 4 partials ⚠️
go/vt/vtgate/planbuilder/operators/phases.go 0.00% 16 Missing ⚠️
... and 45 more
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #15017      +/-   ##
==========================================
+ Coverage   47.29%   47.45%   +0.16%     
==========================================
  Files        1137     1150      +13     
  Lines      238684   239377     +693     
==========================================
+ Hits       112895   113607     +712     
- Misses     117168   117189      +21     
+ Partials     8621     8581      -40

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

frouioui
frouioui reviewed Jan 23, 2024
View reviewed changes
go/tools/releases/releases_test.go
Comment on lines +80 to +83
Path: `\./`,
},
template: "",
expectedErr: `open \./README.md: no such file or directory`,
Copy link
Member

Choose a reason for hiding this comment

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

any reason why using backticks here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just to use the \ character.

frouioui
frouioui approved these changes Jan 23, 2024
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thank you!

@frouioui frouioui added Backport This is a backport and removed Backport This is a backport labels Jan 24, 2024
@VaibhavMalik4187
Copy link
Contributor Author

Looks good to me! Thank you!

Thanks for looking into this.

@VaibhavMalik4187
Added unit tests for the tools/releases package
a6c5763 
This commit bumps the code coverage of the `tools/releases` package from
0% to almost 60%.

Partially addresses: vitessio#14931

Signed-off-by: VaibhavMalik4187 <[email protected]>
@GuptaManan100 GuptaManan100 merged commit 4d0c066 into vitessio:main Jan 28, 2024
102 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

@frouioui frouioui frouioui approved these changes

@systay systay Awaiting requested review from systay systay is a code owner

Assignees
No one assigned
Labels
Component: General Changes throughout the code base Type: Testing
Projects
None yet
Milestone
v19.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@VaibhavMalik4187 @frouioui @GuptaManan100