cypress-realworld-app

cypress-realworld-app

Cypress全栈支付应用展示端到端测试实践

cypress-realworld-app是一个基于React、XState和Express的全栈支付应用,展示了Cypress测试在实际场景中的应用。该项目集成了本地认证、数据库种子和CI/CD等功能,为开发者提供了一个完整的应用测试学习环境。它包含API、UI、组件和单元测试,并提供详细的代码覆盖率报告,是学习和实践现代Web应用测试的理想选择。

Cypress测试React全栈应用持续集成Github开源项目
<p align="center"> <!-- 我们在这里使用两个SVG,以便在Github上正确显示。 这在其他Markdown预览器中可能看起来不正确。 --> <img alt="Cypress真实世界应用程序标志" src="https://raw.githubusercontent.com/cypress-io/cypress-realworld-app/develop/src/svgs/rwa-logo-light.svg#gh-dark-mode-only" /> <img alt="Cypress真实世界应用程序标志" src="https://raw.githubusercontent.com/cypress-io/cypress-realworld-app/develop/src/svgs/rwa-logo.svg#gh-light-mode-only" /> </p> <p align="center"> <a href="https://cypress.io"> <img width="140" alt="Cypress标志" src="https://yellow-cdn.veclightyear.com/2b54e442/77d618a2-0031-44fe-af87-b4ecb376de12.svg" /> </a> </p> <p align="center"> <a href="https://cloud.cypress.io/projects/7s5okt/runs"> <img src="https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/detailed/7s5okt/develop&style=flat&logo=cypress" /> </a> <a href="https://codecov.io/gh/cypress-io/cypress-realworld-app"> <img src="https://yellow-cdn.veclightyear.com/2b54e442/bcbffce2-e9ae-42c6-9d43-b8d9566492b5.svg" /> </a> <a href="https://percy.io/cypress-io/cypress-realworld-app"> <img src="https://yellow-cdn.veclightyear.com/2b54e442/bb4e6934-0fd9-40d7-96c9-f947034f8c52.svg" /> </a> <a href="#contributors-"> <img src="https://yellow-cdn.veclightyear.com/2b54e442/4034e150-67e0-4363-90f4-0dbea9607652.svg?style=flat" /> </a> </p> <p align="center"> 一个支付应用程序,用于展示<a href="https://cypress.io">Cypress</a>测试方法、模式和工作流程的<strong>真实世界</strong>使用。 </p> <p align="center"> <img style='width: 70%' alt="Cypress真实世界应用程序" src="https://yellow-cdn.veclightyear.com/2b54e442/6cf0cd52-31ae-4252-b2cd-c26135e0a2ef.png" /> </p>

💬 维护者注

这个应用程序纯粹用于演示和教育目的。它的设置和配置类似于典型的真实世界应用程序,但它不是一个完整的生产系统。使用这个应用程序来学习、实验、修改和练习使用Cypress进行应用程序测试。

祝测试愉快!


特性

🛠 使用ReactXStateExpresslowdbMaterial-UITypeScript构建 ⚡️ 零数据库依赖 🚀 具有真实世界功能和测试的全栈Express/React应用程序 👮‍♂️ 本地认证 🔥 具有端到端测试的数据库种子 💻 CI/CD + Cypress Cloud

入门

Cypress真实世界应用程序(RWA)是一个由本地JSON数据库(lowdb)支持的全栈Express/React应用程序。

该应用程序捆绑了示例数据(data/database.json),其中包含开箱即用所需的一切,可以立即开始使用该应用程序并运行测试。

🚩 注意

您可以使用任何示例应用程序用户登录应用程序。所有用户的默认密码是s3cret。 可以通过运行yarn list:dev:users查看示例用户。

先决条件

此项目需要在您的机器上安装Node.js。请参考.node-version文件了解确切版本。

还需要Yarn Classic。安装Node.js后,执行以下命令全局安装npm模块yarn(Classic - 版本1)。

npm install yarn@latest -g

如果您已启用Node.js的实验性Corepack功能,则应跳过npm install yarn@latest -g步骤来全局安装Yarn Classic。RWA项目已针对Corepack本地配置使用Yarn Classic(版本1)。

Yarn Modern

此项目与Yarn Modern(版本2及更高版本)不兼容。

安装

要将存储库克隆到本地系统并安装依赖项,请执行以下命令:

git clone https://github.com/cypress-io/cypress-realworld-app cd cypress-realworld-app yarn

使用M系列芯片的Mac用户需要在前面加上PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true

PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true yarn install

运行应用程序

yarn dev

🚩 注意

默认情况下,应用程序将在端口3000(前端)和3001(API后端)上运行。请确保这两个端口上没有其他应用程序或服务在运行。 如果要更改默认端口,可以通过修改.env文件中的PORTVITE_BACKEND_PORT变量来实现。 但是,请确保修改后的端口号未提交到Git中,因为CI环境仍然期望应用程序在默认端口上运行。

启动Cypress

yarn cypress:open

🚩 注意

如果您已更改默认端口,则需要在本地更新Cypress配置文件(cypress.config.ts)。 您需要在cypress.config.ts中更新三个属性:e2e.baseUrlenv.apiUrlenv.urle2e.baseUrl中的端口号对应.env文件中的PORT变量。同样,env.apiUrlenv.url中的端口号对应VITE_BACKEND_PORT。 例如,如果您在.env文件中将PORT更改为13000,将VITE_BACKEND_PORT更改为13001,则您的cypress.config.ts应类似于以下代码片段:

{ env: { apiUrl: "http://localhost:13001", codeCoverage: { url: "http://localhost:13001/__coverage__" }, }, e2e: { baseUrl: "http://localhost:13000" } }

避免将修改后的cypress.config.ts提交到Git中,因为CI环境仍然期望应用程序在默认端口上运行。

测试

类型位置
apicypress/tests/api
uicypress/tests/ui
componentsrc/(靠近组件)
unitsrc/__tests__

数据库

其他NPM脚本

脚本描述
dev以监视模式启动后端和前端
dev:coverage以监视模式启动后端和前端,并启用插桩代码覆盖率
dev:auth0以监视模式启动后端和前端;使用Auth0进行身份验证 > 阅读指南
dev:okta以监视模式启动后端和前端;使用Okta进行身份验证 > 阅读指南
dev:cognito以监视模式启动后端和前端;使用Cognito进行身份验证 > 阅读指南
dev:google以监视模式启动后端和前端;使用Google进行身份验证 > 阅读指南
start启动后端和前端
types验证类型
db:seed为/data中的json文件生成新的数据库种子
start:empty使用空数据库种子启动后端、前端和Cypress
tsnode自定义ts-node命令,以绕过react-scripts限制
list:dev:users提供开发数据库中用户的id和用户名

完整的脚本列表请参见package.json

代码覆盖率报告

Cypress真实世界应用程序使用@cypress/code-coverage插件为应用程序前端和后端生成代码覆盖率报告。

要生成代码覆盖率报告:

  1. 通过运行yarn dev:coverage启动启用覆盖率的开发服务器。
  2. 运行yarn cypress:run --env coverage=true并等待测试运行完成。
  3. 测试运行完成后,您可以在coverage/index.html查看报告。

第三方身份验证提供商

应用程序支持第三方身份验证,以演示使用第三方提供商登录的概念。

该应用程序为每个提供商包含不同的入口点。每个提供商都有一个单独的index文件,要使用其中一个,您必须用所需的文件替换当前的index.tsx文件。支持以下提供商:

Auth0

Auth0测试已重写,以利用我们的cy.sessioncy.origin命令。

先决条件包括一个Auth0账户和一个为SPA配置的租户。来自Auth0的环境变量应放置在.env中。有关更多详细信息,请参阅Auth0应用程序设置在Cypress中设置Auth0应用程序凭据

要使用Auth0启动应用程序,请用src/index.auth0.tsx文件替换当前的src/index.tsx文件,然后使用yarn dev:auth0启动应用程序,并使用yarn cypress:open运行Cypress。 在此分支上,唯一通过的规范将是 auth0 规范;其他所有规范都会失败。请注意,在测试通过之前,您的测试用户需要授权您的 Auth0 应用程序。

Okta

已经编写了一个指南,详细介绍了如何调整 RWA以使用 Okta,并解释了用于 Cypress 测试的编程命令。

先决条件包括一个 Okta 账户和为 SPA 配置的应用程序。来自 Okta 的环境变量要放在 .env 中。

要使用 Okta 启动应用程序,请用 src/index.okta.tsx 文件替换当前的 src/index.tsx 文件,并使用 yarn dev:okta 启动应用程序,然后用 yarn cypress:open 运行 Cypress。

此分支上唯一通过的规范将是 okta 规范;其他所有规范都会失败。

Amazon Cognito

已经编写了一个指南,详细介绍了如何调整 RWA以使用 Amazon Cognito 作为身份验证解决方案,并解释了用于 Cypress 测试的编程命令。

先决条件包括一个 Amazon Cognito 账户。来自 Amazon Cognito 的环境变量由 AWS Amplify CLI 提供。

  • 需要一个用户池(此处不使用身份池)
    • 用户池必须配置托管 UI 域,该域必须:
      • 允许回调和注销 URL 为 http://localhost:3000/,
      • 允许隐式授权 OAuth 授权类型,
      • 允许以下 OpenID Connect 作用域:
        • aws.cognito.signin.user.admin
        • email
        • openid
    • 用户池必须配置一个应用程序客户端,具有:
      • 启用的身份验证流程 ALLOW_USER_PASSWORD_AUTH,仅用于程序化登录风格的测试。
      • cy.origin() 风格的测试只需要身份验证流程 ALLOW_USER_SRP_AUTH,不需要 ALLOW_USER_PASSWORD_AUTH
    • 用户池必须有一个与下面提到的 AWS_COGNITO 环境变量相对应的用户,并且该用户的确认状态必须为 Confirmed。如果是 Force Reset Password,则在运行 yarn dev:cognito 时使用浏览器在 http://localhost:3000 登录一次以重置密码。

测试旋钮位于几个地方:

  • .env 文件中有 VITE_AUTH_TOKEN_NAME 和以 AWS_COGNITO 开头的变量。注意不要提交任何机密信息。
  • scripts/mock-aws-exports.jsscripts/mock-aws-exports-es5.js 必须具有相同的数据;只有它们的导出语句不同。这些文件可以手动编辑或从 amplify CLI 导出。
  • cypress.config.ts 中有 cognito_programmatic_login 来控制测试的风格。

要使用 Cognito 启动应用程序,请用 src/index.cognito.tsx 文件替换当前的 src/index.tsx 文件,并使用 yarn dev:cognito 启动应用程序,然后用 yarn cypress:open 运行 Cypress。可能需要先运行一次 yarn dev

此分支上唯一通过的规范将是 cognito 规范;其他所有规范都会失败。

Google

已经编写了一个指南,详细介绍了如何调整 RWA以使用 Google 作为身份验证解决方案,并解释了用于 Cypress 测试的编程命令。

先决条件包括一个 Google 账户。来自 Google 的环境变量要放在 .env 中。

要使用 Google 启动应用程序,请用 src/index.google.tsx 文件替换当前的 src/index.tsx 文件,并使用 yarn dev:google 启动应用程序,然后用 yarn cypress:open 运行 Cypress。

使用 yarn dev:google 运行时,唯一通过的规范将是 google 规范;其他所有规范都会失败。

许可证

license

本项目根据 MIT 许可证 的条款获得许可。

贡献者 ✨

感谢这些优秀的人(表情符号说明):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="http://www.kevinold.com"><img src="https://avatars0.githubusercontent.com/u/21967?v=4" width="100px;" alt=""/><br /><sub><b>Kevin Old</b></sub></a></td> <td align="center"><a href="https://twitter.com/amirrustam"><img src="https://avatars0.githubusercontent.com/u/334337?v=4" width="100px;" alt=""/><br /><sub><b>Amir Rustamzadeh</b></sub></a></td> <td align="center"><a href="https://twitter.com/be_mann"><img src="https://avatars2.githubusercontent.com/u/1268976?v=4" width="100px;" alt=""/><br /><sub><b>Brian Mann</b></sub></a></td> <td align="center"><a href="https://glebbahmutov.com/"><img src="https://avatars1.githubusercontent.com/u/2212006?v=4" width="100px;" alt=""/><br /><sub><b>Gleb Bahmutov</b></sub></a></td> <td align="center"><a href="http://www.bencodezen.io"><img src="https://avatars0.githubusercontent.com/u/4836334?v=4" width="100px;" alt=""/><br /><sub><b>Ben Hong</b></sub></a></td> <td align="center"><a href="https://github.com/davidkpiano"><img src="https://avatars2.githubusercontent.com/u/1093738?v=4" width="100px;" alt=""/><br /><sub><b>David Khourshid</b></sub></a></td> </tr> </table> <!-- markdownlint-enable --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->

本项目遵循 all-contributors 规范。欢迎任何形式的贡献!!

编辑推荐精选

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

热门AI工具AI办公办公工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

模型训练热门AI工具内容创作智能问答AI开发讯飞星火大模型多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

热门AI工具生产力协作转型TraeAI IDE
咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

AI助手热门AI工具AI创作AI辅助写作讯飞绘文内容运营个性化文章多平台分发
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

Hunyuan3D-2

Hunyuan3D-2

高分辨率纹理 3D 资产生成

Hunyuan3D-2 是腾讯开发的用于 3D 资产生成的强大工具,支持从文本描述、单张图片或多视角图片生成 3D 模型,具备快速形状生成能力,可生成带纹理的高质量 3D 模型,适用于多个领域,为 3D 创作提供了高效解决方案。

3FS

3FS

一个具备存储、管理和客户端操作等多种功能的分布式文件系统相关项目。

3FS 是一个功能强大的分布式文件系统项目,涵盖了存储引擎、元数据管理、客户端工具等多个模块。它支持多种文件操作,如创建文件和目录、设置布局等,同时具备高效的事件循环、节点选择和协程池管理等特性。适用于需要大规模数据存储和管理的场景,能够提高系统的性能和可靠性,是分布式存储领域的优质解决方案。

下拉加载更多