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

tests: add tests for go/protoutil/duration #14965

Merged
merged 3 commits into from
Jan 17, 2024

Conversation

Maniktherana
Copy link
Contributor

Description

Adds tests for DurationToProto and a nanoseconds testcase for DurationFromProto

Related Issue(s)

#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

Deployment Notes

Copy link
Contributor

vitess-bot bot commented Jan 16, 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 16, 2024
@github-actions github-actions bot added this to the v19.0.0 milestone Jan 16, 2024
@ajm188 ajm188 added Type: Testing Component: General Changes throughout the code base 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 labels Jan 16, 2024
@Maniktherana Maniktherana changed the title tests: add tests for /go/protoutil/duration tests: add tests for go/protoutil/duration Jan 16, 2024
Copy link

codecov bot commented Jan 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c1f9c80) 47.26% compared to head (3c002be) 47.25%.
Report is 1 commits behind head on main.

❗ Current head 3c002be differs from pull request most recent head 803a252. Consider uploading reports for the commit 803a252 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14965      +/-   ##
==========================================
- Coverage   47.26%   47.25%   -0.01%     
==========================================
  Files        1138     1138              
  Lines      238842   238842              
==========================================
- Hits       112880   112869      -11     
- Misses     117368   117376       +8     
- Partials     8594     8597       +3     

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

@frouioui
Copy link
Member

frouioui commented Jan 16, 2024

Code coverage report:

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.

LGTM, thank you for this contribution! However there is still one error in duration.go which is not tested:

if (d < 0) != (dpb.Nanos < 0) {
	return 0, true, fmt.Errorf("duration: %v is out of range for time.Duration", dpb)
}

Do you think you can test this condition as well?

https://app.codecov.io/gh/vitessio/vitess/blob/Maniktherana%2Fvitess%3Aadd-test-protoutil/go%2Fprotoutil%2Fduration.go

@Maniktherana
Copy link
Contributor Author

Maniktherana commented Jan 16, 2024

However there is still one error in duration.go which is not tested:

@frouioui yes, I'm aware.

Do you think you can test this condition as well?

Sure thing, I'll try my best

@@ -80,3 +90,40 @@ func TestDurationFromProto(t *testing.T) {
})
}
}

func TestDurationToProto(t *testing.T) {
t.Parallel()
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the t.Parallel() is cargo culted here from the existing tests, but these tests are so fast that I think we should just drop it everywhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed t.Parallel() from this file

@Maniktherana
Copy link
Contributor Author

LGTM, thank you for this contribution! However there is still one error in duration.go which is not tested:

if (d < 0) != (dpb.Nanos < 0) {
	return 0, true, fmt.Errorf("duration: %v is out of range for time.Duration", dpb)
}

Do you think you can test this condition as well?

https://app.codecov.io/gh/vitessio/vitess/blob/Maniktherana%2Fvitess%3Aadd-test-protoutil/go%2Fprotoutil%2Fduration.go

@frouioui done

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.

LGTM, thank you!

@frouioui frouioui merged commit b15e9f6 into vitessio:main Jan 17, 2024
99 of 100 checks passed
@Maniktherana Maniktherana deleted the add-test-protoutil branch January 19, 2024 06:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: General Changes throughout the code base Type: Testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants