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

test: add time-line UI e2e test #47

Merged
merged 2 commits into from
Sep 20, 2024
Merged

test: add time-line UI e2e test #47

merged 2 commits into from
Sep 20, 2024

Conversation

chenxi-20
Copy link
Collaborator

@chenxi-20 chenxi-20 commented Sep 20, 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
    • Introduced automated UI tests for the "timeline" component in the xdesign framework using Playwright.
    • Added test cases to validate the UI rendering and appearance of components, including screenshot comparisons for visual consistency.

@chenxi-20 chenxi-20 added the e2e playwright label Sep 20, 2024
Copy link

coderabbitai bot commented Sep 20, 2024

Walkthrough

A new test file, xdesign.spec.ts, has been added to the project, containing automated UI tests for the "timeline" component within the xdesign framework. The tests utilize Playwright to verify the UI's visual consistency by capturing screenshots of specific components under different conditions.

Changes

File Change Summary
tests/time-line/xdesign.spec.ts Introduced a new test file with two test cases for the "timeline" component, capturing UI screenshots for node status and dot appearance.

Possibly related PRs

🐰 In the garden where the timeline flows,
New tests have sprouted, as everyone knows!
With screenshots captured, in colors so bright,
The UI dances, a beautiful sight!
Hopping with glee, we cherish this change,
For every new test makes our project less strange! 🥕✨


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b9d2758 and 79d5783.

Files selected for processing (1)
  • tests/time-line/xdesign.spec.ts (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • tests/time-line/xdesign.spec.ts

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.

@chenxi-20
Copy link
Collaborator Author

image

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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2eb2752 and b9d2758.

Files ignored due to path filters (2)
  • 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 (1)
  • tests/time-line/xdesign.spec.ts (1 hunks)
Additional comments not posted (1)
tests/time-line/xdesign.spec.ts (1)

4-10: LGTM!

The test follows a clear structure and includes good practices such as checking for page errors and ensuring the demo element is in the viewport before capturing the screenshot. The screenshot name aligns with the test name, making it easy to identify.

Comment on lines +12 to +18
test('圆点外观 --UI截图', async ({ page }) => {
page.on('pageerror', (exception) => expect(exception).toBeNull())
await page.goto('time-line#shape')
const demo = page.locator('#shape .pc-demo')
await expect(demo).toBeInViewport()
await expect(demo).toHaveScreenshot('shape.png')
})
Copy link

Choose a reason for hiding this comment

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

LGTM, but consider refactoring to reduce code duplication.

The test follows the same good practices as the previous test, and the screenshot name aligns with the test name.

However, the test code is almost identical to the previous test, with only the page URL and screenshot name being different. Consider refactoring the common logic into a helper function to reduce code duplication and make the test suite easier to maintain.

Here's a suggested refactor:

async function testUIScreenshot(page, url, selector, screenshotName) {
  page.on('pageerror', (exception) => expect(exception).toBeNull())
  await page.goto(url)
  const demo = page.locator(selector)
  await expect(demo).toBeInViewport()
  await expect(demo).toHaveScreenshot(screenshotName)
}

test.describe('tabs 组件xdesign规范', () => {
  test('节点状态 --UI截图', async ({ page }) => {
    await testUIScreenshot(page, 'time-line#status', '#status .pc-demo', 'status.png')
  })

  test('圆点外观 --UI截图', async ({ page }) => {
    await testUIScreenshot(page, 'time-line#shape', '#shape .pc-demo', 'shape.png')
  })
})

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

Successfully merging this pull request may close these issues.

2 participants