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

Replace ErrorContains checks with Error checks before running upgrade downgrade #16688

Merged

Conversation

GuptaManan100
Copy link
Member

@GuptaManan100 GuptaManan100 commented Aug 30, 2024

Description

This PR replaces the ErrorContains checks to just check for an Error instead while running upgrade downgrade tests. This is required because we don't guarantee that errors will be the same across different vitess version.

The workings of the changes can be seen in the workflow run https://github.com/vitessio/vitess/actions/runs/10630690740/job/29470087067?pr=16688 in the Convert ErrorContains to Error checks step. I am copying a snippet so that it can be seen directly here -

diff --git a/go/test/endtoend/backup/vtbackup/backup_only_test.go b/go/test/endtoend/backup/vtbackup/backup_only_test.go
index 7dada7a77d..1fd6c601cf 100644
--- a/go/test/endtoend/backup/vtbackup/backup_only_test.go
+++ b/go/test/endtoend/backup/vtbackup/backup_only_test.go
@@ -74,9 +74,9 @@ func TestTabletInitialBackup(t *testing.T) {
 	// For all version at or above v17.0.0, each replica will start in super_read_only mode. Let's verify that is working correctly.
 	if vtTabletVersion >= 17 {
 		err := primary.VttabletProcess.CreateDB("testDB")
-		require.ErrorContains(t, err, "The MySQL server is running with the --super-read-only option so it cannot execute this statement")
+		require.Error(t, err, "The MySQL server is running with the --super-read-only option so it cannot execute this statement")
 		err = replica1.VttabletProcess.CreateDB("testDB")
-		require.ErrorContains(t, err, "The MySQL server is running with the --super-read-only option so it cannot execute this statement")
+		require.Error(t, err, "The MySQL server is running with the --super-read-only option so it cannot execute this statement")
 	}
 
 	// Restore the Tablet
diff --git a/go/test/endtoend/mysqlctld/mysqlctld_test.go b/go/test/endtoend/mysqlctld/mysqlctld_test.go
index 328bc56337..9877219b50 100644
--- a/go/test/endtoend/mysqlctld/mysqlctld_test.go
+++ b/go/test/endtoend/mysqlctld/mysqlctld_test.go
@@ -175,5 +175,5 @@ func TestReadBinlogFilesTimestamps(t *testing.T) {
 	client, err := mysqlctlclient.New(context.Background(), "unix", primaryTablet.MysqlctldProcess.SocketFile)
 	require.NoError(t, err)
 	_, err = client.ReadBinlogFilesTimestamps(context.Background(), &mysqlctl.ReadBinlogFilesTimestampsRequest{})
-	require.ErrorContains(t, err, "empty binlog list in ReadBinlogFilesTimestampsRequest")
+	require.Error(t, err, "empty binlog list in ReadBinlogFilesTimestampsRequest")
 }

This change is required so that we can get this CI check to work https://github.com/vitessio/vitess/actions/runs/10488116666/job/29052695413?pr=16619. This works in conjunction with #16672 that fixes some anti-patterns in the test.

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

Copy link
Contributor

vitess-bot bot commented Aug 30, 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 Aug 30, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Aug 30, 2024
@GuptaManan100 GuptaManan100 added Component: Query Serving Type: Testing 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 Aug 30, 2024
@GuptaManan100 GuptaManan100 marked this pull request as ready for review August 30, 2024 10:30
Copy link
Member

@harshit-gangal harshit-gangal left a comment

Choose a reason for hiding this comment

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

There could be a possible use of EqualError as well.
Let's discourage that for end to end test.

@GuptaManan100
Copy link
Member Author

Good point, I updated the PR to also change EqualError to Error

Copy link

codecov bot commented Sep 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.93%. Comparing base (977b9a3) to head (caaa699).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16688      +/-   ##
==========================================
- Coverage   68.95%   68.93%   -0.02%     
==========================================
  Files        1565     1565              
  Lines      201530   201556      +26     
==========================================
- Hits       138957   138943      -14     
- Misses      62573    62613      +40     

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

@GuptaManan100 GuptaManan100 merged commit caf39ed into vitessio:main Sep 2, 2024
129 checks passed
@GuptaManan100 GuptaManan100 deleted the remove-error-contains-upgdwn branch September 2, 2024 13:43
GuptaManan100 added a commit to planetscale/vitess that referenced this pull request Sep 3, 2024
GuptaManan100 added a commit to planetscale/vitess that referenced this pull request Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants