feat: add playwright e2e testing framework

anncwb commented 1 week ago

Description

Type of change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update
[ ] Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

[ ] If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
[ ] Run the tests with pnpm test.
[ ] Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
[ ] My code follows the style guidelines of this project
[ ] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have made corresponding changes to the documentation
[ ] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes
[ ] Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

Release Notes

New Features
- Added "Star History" section to the README files, showcasing the repository's star count over time.
- Introduced end-to-end testing scripts for authentication functionalities using Playwright.
Accessibility Improvements
- Enhanced accessibility for buttons in authentication components by adding aria-label attributes.
Development Environment Updates
- Updated initialization command for the development environment.
- Streamlined dependency installation and testing commands.
Testing Enhancements
- Added new Playwright configuration for end-to-end testing.
- Introduced new end-to-end test scripts and login automation functions.
- Added a new entry for end-to-end testing in the configuration files.

changeset-bot[bot] commented 1 week ago

⚠️ No Changeset found

Latest commit: 0651a889a90fdec9704ff7e97e6c0faa51fc183e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai[bot] commented 1 week ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several changes across multiple files, primarily focusing on enhancing the development environment and improving user verification features. Key modifications include updating commands in the .gitpod.yml file, adding sections for "Star History" in various README files, and implementing new testing scripts and configurations for Playwright. Additionally, accessibility improvements have been made in several Vue components, and new end-to-end tests have been created to ensure the proper functioning of the authentication process.

Changes

File/Directory	Change Summary
`.gitpod.yml`	Command updated from `pnpm run dev` to `pnpm run dev:play`.
`README.ja-JP.md`, `README.md`, `README.zh-CN.md`	New section "Star History" added with an image link for star history charts.
`docs/src/en/guide/essentials/development.md`	Scripts modified: removed `bootstrap`, updated `reinstall` to use `pnpm install`, and changed `test:unit` to `vitest run --dom`.
`internal/lint-configs/eslint-config/src/configs/node.ts`	Added `@playwright/test` to dependencies in ESLint configuration.
`internal/lint-configs/eslint-config/src/custom-config.ts`	New ESLint rules added for `playwright.config.ts` files, disabling specific rules.
`package.json`	Multiple changes: removed `bootstrap`, updated `reinstall` and `test:unit`, added `test:e2e`, and modified `devDependencies` to include `@playwright/test`, `happy-dom`, and `playwright`.
`packages/@core/ui-kit/shadcn-ui/package.json`	Updated `main` and `module` fields to point to source files instead of distribution files, and added new fields `#main` and `#module`.
`packages/effects/common-ui/src/components/captcha/slider-captcha/slider-captcha-action.vue`	Added `name="captcha-action"` attribute to root element.
`packages/effects/common-ui/src/ui/authentication/*.vue`	Added `aria-label` attributes to buttons in `forget-password`, `login`, and `register` components for accessibility improvements.
`playground/__tests__/e2e/auth-login.spec.ts`	New end-to-end test file for the authentication login page using Playwright.
`playground/__tests__/e2e/common/auth.ts`	New function `authLogin` added for automating the login process with slider captcha.
`playground/package.json`	Added scripts for end-to-end testing: `test:e2e`, `test:e2e-ui`, and `test:e2e-codegen`.
`playground/playwright.config.ts`	New Playwright configuration file introduced with various test settings.
`pnpm-workspace.yaml`	Added and removed several packages including `@playwright/test`, `happy-dom`, and removed `@types/jsdom` and `jsdom`.
`turbo.json`	New entry for end-to-end testing added under the `stub` section.
`vitest.config.ts`	Updated test environment from `jsdom` to `happy-dom`.

Possibly related PRs

#4276: Introduces the axios-retry library, which enhances the functionality of HTTP requests, possibly relating to the development environment setup.
#4389: Includes changes to the login.vue file, relevant as it modifies the login process affected by the changes in .gitpod.yml.
#4461: Adds a sliding verification feature to the login form, directly related to the changes in the main PR involving the development environment setup.
#4468: Introduces the Playwright e2e testing framework, directly relevant to the changes in .gitpod.yml affecting the development environment and testing setup.

Poem

🐰 In the meadow where code does play,
Changes bloom like flowers in May.
With stars that twinkle in README bright,
And captchas sliding, oh what a sight!
Let's hop along with tests that run,
Celebrating changes, oh what fun! 🌼

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

vbenjs / vue-vben-admin