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/json2 #14964

Merged
merged 6 commits into from
Jan 17, 2024
Merged

Conversation

Maniktherana
Copy link
Contributor

@Maniktherana Maniktherana commented Jan 16, 2024

Description

Add TestMarshalIndentPB to cover marshal.go
Add TestUnmarshalProto, TestAnnotate to cover unmarshal.go

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

@Maniktherana Maniktherana requested a review from deepthi as a code owner January 16, 2024 14:57
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 previously requested changes Jan 16, 2024
go/json2/marshal_test.go Outdated Show resolved Hide resolved
@frouioui frouioui 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
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 (4b1bb2b) 47.26%.
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14964   +/-   ##
=======================================
  Coverage   47.26%   47.26%           
=======================================
  Files        1138     1138           
  Lines      238842   238842           
=======================================
+ Hits       112880   112897   +17     
+ Misses     117368   117348   -20     
- Partials     8594     8597    +3     

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

@frouioui
Copy link
Member

Coverage report for this package:

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.

Asides from the conversation with @ajm188, the changes in go/json2/marshal_test.go look good to me. The file went to 100% of code coverage.

I see in the same package there is the unmarshal.go file, do you think you can cover this file too?

@Maniktherana
Copy link
Contributor Author

@frouioui sure thing, I can give it a shot

@Maniktherana Maniktherana changed the title tests: add tests for go/json2/marshal.go tests: add tests for go/json2 Jan 17, 2024
Copy link
Contributor

@ajm188 ajm188 left a comment

Choose a reason for hiding this comment

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

one minor issue and then i think we're good to go!

go/json2/marshal_test.go Outdated Show resolved Hide resolved
@ajm188 ajm188 dismissed their stale review January 17, 2024 13:09

requested changes made

@Maniktherana Maniktherana requested a review from ajm188 January 17, 2024 15:19
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 perfect to me! Thanks a bunch

@frouioui frouioui merged commit 8b7188a into vitessio:main Jan 17, 2024
102 checks passed
@Maniktherana Maniktherana deleted the add-test-json2 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.

3 participants