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/sqlescape #14987

Merged
merged 8 commits into from
Jan 29, 2024

Conversation

Maniktherana
Copy link
Contributor

@Maniktherana Maniktherana commented Jan 18, 2024

Description

Adds tests for go/sqlescape

Question: if EscapeID for the string a`a returns `a``a`, should UnescapeID reverse it? Because currently it simply returns a``a, removing the outer backticks without halving the ones inside the string

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 18, 2024 13:31
Copy link
Contributor

vitess-bot bot commented Jan 18, 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 18, 2024
@github-actions github-actions bot added this to the v19.0.0 milestone Jan 18, 2024
Copy link

codecov bot commented Jan 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f751c83) 47.49% compared to head (d94be33) 47.49%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14987   +/-   ##
=======================================
  Coverage   47.49%   47.49%           
=======================================
  Files        1149     1149           
  Lines      239475   239475           
=======================================
+ Hits       113730   113749   +19     
+ Misses     117138   117121   -17     
+ Partials     8607     8605    -2     

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

@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 18, 2024
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

Thanks, @Maniktherana ! We can see that the package's code coverage went from 61.29% on main to 100% in the PR branch:

Regarding your question... I think that Escape followed by Unescape should produce that same string that we started with. You're right that currently it does not as EscapeID escapes inner backticks but UnescapeID does not do the reverse. I think that's a bug. What do you think @rohit-nayak-ps ?

@Maniktherana
Copy link
Contributor Author

@mattlord if this is the case, I'd be happy to raise an issue and follow it up with a fix

@rohit-nayak-ps
Copy link
Contributor

Regarding your question... I think that Escape followed by Unescape should produce that same string that we started with.

You're right that currently it does not as EscapeID escapes inner backticks but UnescapeID does not do the reverse. I think that's a bug. What do you think @rohit-nayak-ps ?

Yes, this is a bug. Unescape(Escape()) should exactly reverse.

@Maniktherana
Copy link
Contributor Author

going to keep this as draft until #14992 is resolved

@GuptaManan100
Copy link
Member

GuptaManan100 commented Jan 25, 2024

@Maniktherana Do you want to take a stab at fixing the issue as well, given that you're the one who uncovered it? If you don't want to, that's fine as well, in that case, I shall pick it up.

@Maniktherana
Copy link
Contributor Author

@GuptaManan100 I'm already on it :)
refer to #15009

Maniktherana and others added 3 commits January 27, 2024 19:32
@Maniktherana Maniktherana marked this pull request as ready for review January 27, 2024 14:06
Signed-off-by: Manik Rana <[email protected]>
Copy link
Member

@GuptaManan100 GuptaManan100 left a comment

Choose a reason for hiding this comment

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

Excellent work, both on finding the bug, and also on the fix.

@GuptaManan100 GuptaManan100 merged commit 68f6922 into vitessio:main Jan 29, 2024
102 checks passed
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.

5 participants