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

schemadiff textual annotation fix + tests #17630

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

schemadiff textual annotation fix + tests #17630

wants to merge 6 commits into from
+356 −36

Conversation

shlomi-noach
Copy link
Contributor

Description

This PR adds one fix to RENAME KEY annotation, and adds full annotation coverage in all relevant tests (thus far annotations were only tested for selected cases; from now on this is mandatory for all relevant tests).

Related Issue(s)

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

@shlomi-noach
complete annotations tests in TestDiffTables
522878d 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach
fix annotations for ALTER KEY statement
9166de5 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach
complete annotations coverage in TestCreateTableDiff
663c12d 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach
ensire full annotation coverage in TestDiffViews
f83f2f9 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach
full annotation test coverage in TestDiffSchemas
d7349f7 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach shlomi-noach added Type: Bug Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: schema management schemadiff and schema changes labels Jan 27, 2025
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Jan 27, 2025

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 27, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Jan 27, 2025
@codecov Codecov
Copy link

codecov bot commented Jan 27, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.63%. Comparing base (a6c2896) to head (1162d86).
Report is 3 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #17630      +/-   ##
==========================================
- Coverage   67.64%   67.63%   -0.01%     
==========================================
  Files        1586     1586              
  Lines      255629   255646      +17     
==========================================
+ Hits       172910   172918       +8     
- Misses      82719    82728       +9

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

@shlomi-noach shlomi-noach 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 27, 2025
@shlomi-noach shlomi-noach requested review from dbussink and a team January 27, 2025 08:19
@shlomi-noach
nicer switch statement layout
1162d86 
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
shlomi-noach
shlomi-noach commented Jan 27, 2025
View reviewed changes
go/vt/schemadiff/annotations.go
Comment on lines +94 to +103
switch {
case annotatedText.typ == AddedTextualAnnotationType:
annotatedText.text = "+" + annotatedText.text
case RemovedTextualAnnotationType:
case annotatedText.typ == RemovedTextualAnnotationType:
annotatedText.text = "-" + annotatedText.text
case a.hasAnyChanges:
// This text is unchanged, but indented to align with changes
annotatedText.text = " " + annotatedText.text
default:
// text unchanged
if a.hasAnyChanges {
// If there is absolutely no change, we don't add a space anywhere
annotatedText.text = " " + annotatedText.text
}
// If there is absolutely no change, we don't add a space anywhere
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This change here is merely beautifying the switch statement flow and there is no logic change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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

@dbussink dbussink Awaiting requested review from dbussink

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
Component: schema management schemadiff and schema changes Type: Bug Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v22.0.0
Development

Successfully merging this pull request may close these issues.
1 participant
@shlomi-noach