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

Added missing tests for the go/streamlog package #15064

Merged
merged 1 commit into from
Feb 13, 2024

Conversation

VaibhavMalik4187
Copy link
Contributor

Description

This commit increased the code coverage of the go/streamlog package to 93%.

Related Issue(s)

Partially addresses: #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

Copy link
Contributor

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

The following change has to be made to the tests.

@@ -260,3 +264,152 @@ func TestFile(t *testing.T) {
t.Errorf("streamlog file: want %q got %q", want, got)
}
}

func TestSetAndGetMethods(t *testing.T) {
SetRedactDebugUIQueries(false)
Copy link
Member

Choose a reason for hiding this comment

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

Whenever we change the global state in a test, we should ensure we set it back in a defer function call.

So, we should add this code to the test -

originalVal := GetRedactDebugUIQueries()
defer func() {
    SetRedactDebugUIQueries(originalVal)
}()

We should do this for all the tests that change any state.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, thanks for the pointer.

Copy link

codecov bot commented Jan 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (cd40589) 70.60% compared to head (cd1f73d) 70.62%.
Report is 14 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15064      +/-   ##
==========================================
+ Coverage   70.60%   70.62%   +0.01%     
==========================================
  Files        1376     1376              
  Lines      182302   182302              
==========================================
+ Hits       128721   128749      +28     
+ Misses      53581    53553      -28     

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

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.

TestRegisterStreamLogFlags and TestSetAndGetMethods don't seem very useful. Please remove those two tests, and we can merge the remaining two.

@VaibhavMalik4187
Copy link
Contributor Author

TestRegisterStreamLogFlags and TestSetAndGetMethods don't seem very useful. Please remove those two tests, and we can merge the remaining two.

Alright, I'll update the code soon.

@VaibhavMalik4187
Copy link
Contributor Author

TestSetAndGetMethods

Done

@frouioui frouioui modified the milestones: v19.0.0, v20.0.0 Feb 6, 2024
@GuptaManan100 GuptaManan100 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 Feb 7, 2024
@harshit-gangal harshit-gangal merged commit 696fe0e into vitessio:main Feb 13, 2024
102 of 103 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.

4 participants