Skip to content

test(Disclosure): revert test changes & add custom qa test #2213

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

itwillwork
Copy link
Contributor

@itwillwork itwillwork commented Apr 3, 2025

Summary by Sourcery

Update Disclosure component tests with improved test coverage and simplified test data

Tests:

  • Refactor existing tests to use a consistent QA ID
  • Add new test for custom QA attribute support
  • Remove redundant test data and simplify test setup

@itwillwork itwillwork requested a review from Raubzeug as a code owner April 3, 2025 12:25
Copy link
Contributor

sourcery-ai bot commented Apr 3, 2025

Reviewer's Guide by Sourcery

This pull request primarily focuses on improving the test suite for the Disclosure component. It introduces a custom test case for the qa prop and refactors the existing tests to use a consistent qaId for identifying elements. Additionally, it removes an unnecessary variable to improve code clarity.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a custom test case to verify the qa prop functionality.
  • Added a test case to check if the component renders with a custom qa attribute.
  • Added assertions to verify the existence of elements with the custom qa attribute.
src/components/Disclosure/__tests__/Disclosure.test.tsx
Refactored the test suite to use a consistent qaId for identifying elements.
  • Introduced a qaId constant for consistent data-qa attribute usage.
  • Updated test cases to use the qaId constant for element selection.
  • Removed redundant qaId definitions within individual test cases.
src/components/Disclosure/__tests__/Disclosure.test.tsx
Removed an unnecessary contentQaId variable.
  • Removed the contentQaId variable from the test file.
  • Replaced the contentQaId variable with the qaId variable.
src/components/Disclosure/__tests__/Disclosure.test.tsx

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @itwillwork - I've reviewed your changes - here's some feedback:

Overall Comments:

  • It looks like you're using the same qaId for multiple elements within the same test, which could lead to issues with finding the correct element.
  • Consider extracting the common rendering setup into a beforeEach block to reduce duplication across tests.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@gravity-ui-bot
Copy link
Contributor

Preview is ready.

@gravity-ui-bot
Copy link
Contributor

Visual Tests Report is ready.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants