Skip to content

ci(e2e): remove the limit on the number of E2E test case components in git-action #2725

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

Merged
merged 1 commit into from
Jan 2, 2025

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented Jan 2, 2025

ci(e2e): 解除git-action对于E2E测试用例组件个数的限制

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

  • Chores
    • Updated GitHub Actions workflow for end-to-end testing
    • Improved component parsing logic in pull request testing process

Copy link

coderabbitai bot commented Jan 2, 2025

Walkthrough

The pull request modifies the GitHub Actions workflow for end-to-end (E2E) testing, specifically adjusting the parse-components job. The key change removes the previous limitation on the number of unique components extracted from the pull request title, allowing all identified components to be processed. The workflow maintains its core functionality of parsing components from PR titles and preparing them for testing, with a more flexible component extraction approach.

Changes

File Change Summary
.github/workflows/test-e2e-pr.yml Removed component count limitation, enabling parsing of all unique components from PR title

Possibly related PRs

Suggested labels

e2e-test

Suggested reviewers

  • kagol

Poem

🐰 Hopping through GitHub's green lane,
Testing workflows, breaking the chain
Components parsed, no limits in sight
E2E tests now shine so bright!
A rabbit's code dance, pure delight 🧪


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

Walkthrough

此PR移除了GitHub Actions中对E2E测试用例组件数量的限制,允许在CI环境中运行更多的E2E测试。

Changes

文件 概要
.github/workflows/test-e2e-pr.yml 移除了对E2E测试用例组件数量的限制

@Issues-translate-bot
Copy link

Bot detected the issue body's language is not English, translate it automatically.


Walkthrough

This PR removes the limit on the number of E2E test case components in GitHub Actions, allowing more E2E tests to be run in a CI environment.

Changes

Documentation Summary
.github/workflows/test-e2e-pr.yml Removed the limit on the number of E2E test case components

Copy link

github-actions bot commented Jan 2, 2025

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

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

🧹 Nitpick comments (1)
.github/workflows/test-e2e-pr.yml (1)

33-33: LGTM! Consider adding a reasonable upper limit.

The removal of the component limit allows for more comprehensive testing, which aligns with the PR objectives. However, consider adding a reasonable upper limit (e.g., 10-15 components) to prevent potential workflow timeouts or excessive resource usage.

-              components = [...new Set(components)].join(' ')
+              const MAX_COMPONENTS = 15
+              components = [...new Set(components)]
+              if (components.length > MAX_COMPONENTS) {
+                core.warning(`Number of components (${components.length}) exceeds maximum limit of ${MAX_COMPONENTS}. Only the first ${MAX_COMPONENTS} will be tested.`)
+                components = components.slice(0, MAX_COMPONENTS)
+              }
+              components = components.join(' ')
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 269aa65 and e9fc3ea.

📒 Files selected for processing (1)
  • .github/workflows/test-e2e-pr.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/test-e2e-pr.yml (1)

Line range hint 91-91: Verify test execution time limits.

With the removal of component limits, we should verify that the test execution stays within GitHub Actions time limits, especially with the current retry and worker configuration.

Also applies to: 108-108

✅ Verification successful

Test execution times are within acceptable limits

Based on the recent workflow runs:

  • Successful runs completed in ~13-16 seconds
  • The longest run (failure case) took ~4 minutes
  • The workflow has built-in optimizations:
    • Concurrency control with cancel-in-progress: true
    • Caching for Playwright and pnpm dependencies
    • Limited retries (--retries=1) and workers (--workers=2)

These execution times are well within GitHub Actions' 6-hour timeout limit for workflows. The removal of component limits should not cause significant timing issues given these constraints and the observed performance.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check workflow run times to assess impact of unlimited components

# Get recent workflow run times for this workflow
gh api -X GET /repos/opentiny/tiny-vue/actions/workflows/test-e2e-pr.yml/runs \
  --jq '.workflow_runs[0:5] | .[] | {conclusion: .conclusion, duration: (.updated_at | fromdateiso8601 - (.created_at | fromdateiso8601))/60}'

Length of output: 566


Script:

#!/bin/bash
# Description: Check workflow run times to assess impact of unlimited components
# Using simpler jq expression and manual calculation

gh api -X GET /repos/opentiny/tiny-vue/actions/workflows/test-e2e-pr.yml/runs \
  --jq '.workflow_runs[0:5] | .[] | {conclusion: .conclusion, created_at: .created_at, updated_at: .updated_at}'

# Also check the workflow file for any existing timeout settings
cat .github/workflows/test-e2e-pr.yml

Length of output: 4917

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