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

fix(steps): After the global style is changed, the UI screenshots of steps and timeline are incorrect. #79

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

Conversation

chenxi-20
Copy link
Collaborator

@chenxi-20 chenxi-20 commented Oct 14, 2024

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Tests
    • Added a new test case for the steps component to capture UI screenshots.
    • Updated the demo element locator in the timeline component test for improved accuracy.

@chenxi-20 chenxi-20 added the bug Something isn't working label Oct 14, 2024
Copy link

coderabbitai bot commented Oct 14, 2024

Walkthrough

The changes introduce a new test case in the tests/steps/xdesign.spec.ts file for the steps component, specifically designed to capture a UI screenshot. Additionally, the test suite for the timeline component in tests/time-line/xdesign.spec.ts is modified to refine the locator for a demo element, enhancing the specificity of the test. These updates aim to improve the coverage and accuracy of the UI tests.

Changes

File Change Summary
tests/steps/xdesign.spec.ts Added a new test case '条形和高级向导型--UI截图' that navigates to steps#advanced-steps, checks demo visibility, and takes a screenshot.
tests/time-line/xdesign.spec.ts Updated the locator in the second test case from '#shape .pc-demo' to '#shape .pc-demo .tiny-timeline' for better specificity.

Possibly related PRs

  • test: add steps UI e2e test #43: This PR adds end-to-end tests for the steps UI component, which is directly related to the main PR that introduces a new test case for the steps component in the xdesign specification.
  • test: add time-line UI e2e test #47: This PR introduces end-to-end tests for the timeline UI component, which is relevant as the main PR modifies a test case in the timeline component's test suite.

Suggested reviewers

  • zzcr

Poem

🐇 In the garden of tests, we hop and play,
New cases sprout, bright as the day.
With screenshots captured, our work is done,
Timelines refined, oh what fun!
So let’s celebrate, with a joyful cheer,
For every new test brings us near! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
tests/steps/xdesign.spec.ts (1)

20-26: LGTM! Consider minor adjustment for consistency.

The new test case for '条形和高级向导型--UI截图' (Bar and Advanced Wizard Type--UI Screenshot) is well-structured and follows the pattern of existing test cases. It correctly handles page errors, navigates to the appropriate URL, checks viewport visibility, and captures a screenshot.

For consistency with other test cases, consider using '.pc-demo' instead of '.pc-demo-container' in the locator:

-    const demo = page.locator('#advanced-steps .pc-demo-container')
+    const demo = page.locator('#advanced-steps .pc-demo')

This change would align the new test case more closely with the existing ones, unless there's a specific reason for using '.pc-demo-container' in this case.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6fcf6a9 and 8422378.

⛔ Files ignored due to path filters (8)
  • tests/steps/xdesign.spec.ts-snapshots/advanced-chromium-win32.png is excluded by !**/*.png
  • tests/steps/xdesign.spec.ts-snapshots/line-dot-chromium-win32.png is excluded by !**/*.png
  • tests/steps/xdesign.spec.ts-snapshots/line-horizontal-chromium-win32.png is excluded by !**/*.png
  • tests/steps/xdesign.spec.ts-snapshots/size-chromium-win32.png is excluded by !**/*.png
  • tests/steps/xdesign.spec.ts-snapshots/slot-item-footer-chromium-win32.png is excluded by !**/*.png
  • tests/steps/xdesign.spec.ts-snapshots/slot-item-footer-hover-chromium-win32.png is excluded by !**/*.png
  • tests/time-line/xdesign.spec.ts-snapshots/shape-chromium-win32.png is excluded by !**/*.png
  • tests/time-line/xdesign.spec.ts-snapshots/status-chromium-win32.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • tests/steps/xdesign.spec.ts (1 hunks)
  • tests/time-line/xdesign.spec.ts (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
tests/time-line/xdesign.spec.ts (1)

15-15: LGTM! Consider verifying the test stability.

The change to the locator makes it more specific, which should improve the precision of the test. This aligns well with the PR objective of fixing UI screenshots after global style changes.

To ensure this change doesn't introduce any instability, please run the following verification:

This script will search for the new locator structure in the HTML and Vue files. If it returns results, it confirms that the new locator exists in the HTML structure. If it doesn't return any results, you may want to double-check the HTML structure to ensure the new locator is correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant