使用 Cypress 部署和测试微服务

php中文网 2024-10-15 12:02:49

介绍

随着软件架构转向微服务，确保众多独立服务之间的无缝集成和功能变得越来越重要。有效地测试微服务需要强大、可靠且全面的方法。 cypress以其强大的端到端测试能力而闻名，是在面向微服务的架构（msa）环境中测试微服务的绝佳选择。

在这篇文章中，我们将探索使用 cypress 测试微服务的过程，并介绍将 cypress 集成到您的

中的最佳实践

微服务部署管道。

什么是微服务？
微服务是一种软件开发架构风格，它将应用程序构建为小型、松散耦合且可独立部署的服务的集合。每个微服务通常专注于特定的业务功能，并通过 api 或消息队列与其他微服务进行通信。

微服务架构旨在通过提供以下功能来克服传统单体应用程序的局限性：

可扩展性
灵活性
独立开发和部署服务
弹性和故障隔离

但是，由于服务数量增加以及需要有效的 api 测试、服务到服务通信和端到端验证，测试微服务可能比测试整体应用程序更复杂。

为什么选择赛普拉斯进行微服务测试？

cypress 以其端到端测试能力而闻名，尤其是在 web 应用程序中。但在用于测试微服务时，尤其是涉及 api 和 ui 组件时，它也带来了显着的优势。这就是为什么 cypress 是微服务测试的绝佳选择：

端到端测试：cypress 擅长测试不同微服务如何交互，并确保跨多个服务的整个用户流按预期工作。
api 测试： 微服务严重依赖 api 进行通信，而 cypress 支持强大的 api 测试和验证。
实时测试：cypress 可以模拟真实世界的用户交互并断言微服务的响应，使其成为以用户为中心的测试的理想选择。
模拟和存根：cypress 允许模拟外部服务，从而更容易隔离测试各个微服务。

使用 cypress 部署和测试微服务的关键策略

微服务部署和环境设置在测试微服务之前，我们需要一个正确部署的环境。通常，微服务使用 docker 等工具或 kubernetes 等编排器部署在容器化环境中。每个微服务独立运行并通过定义的 api 进行通信。

设置步骤：

使用 docker 将您的服务容器化。每个服务都应该有自己的 docker 文件。
使用 kubernetes 进行容器编排，确保每个微服务都正确配置为与其他微服务交互。
对于本地测试或较小的环境，使用 docker compose 来管理多个微服务及其依赖项。

微服务的 docker compose 设置示例：

version: '3'
services:
  service-a:
    image: service-a-image
    ports:
      - "8080:8080"
    environment:
      - db_host=db
  service-b:
    image: service-b-image
    ports:
      - "8081:8081"
    environment:
      - db_host=db
  db:
    image: postgres
    environment:
      postgres_user: user
      postgres_password: pass
      postgres_db: mydb

此配置允许使用 docker 本地部署两个微服务，共享数据库。

2。使用 cypress 进行 api 测试
在微服务环境中，api 是服务之间通信的支柱。因此，api 测试对于验证微服务之间是否正确交互至关重要。

cypress 允许您发出 api 请求、验证响应并断言服务之间交换的数据。例如，如果 service-a 向 service-b 发送请求，cypress 可以验证请求和响应流。
api 测试示例：

describe('api testing for service a', () =&gt; {
  it('should return data from service a', () =&gt; {
    cy.request('get', 'http://localhost:8080/api/service-a/data')
      .then((response) =&gt; {
        expect(response.status).to.eq(200);
        expect(response.body).to.have.property('data');
      });
  });

  it('should interact with service b and return the correct response', () =&gt; {
    cy.request('post', 'http://localhost:8080/api/service-a/interact', {
      servicebdata: "sample data"
    })
      .then((response) =&gt; {
        expect(response.status).to.eq(200);
        expect(response.body).to.have.property('result');
      });
  });
});

在此测试中，cypress 向 service-a 发送请求，service-a 与 service-b 进行交互。来自 service-b 的响应在测试中得到验证。

3。跨多个微服务的端到端测试
cypress 还可用于端到端测试，其中涉及测试跨多个微服务的用户旅程。例如，典型的电子商务应用程序可能具有用于身份验证、产品管理和订单处理的单独服务。 cypress 可以模拟用户导航 ui 并向这些服务发出请求。

用户身份验证和产品购买的 e2e 测试示例：

describe('end-to-end test for e-commerce microservices', () =&gt; {
  it('should log in and purchase a product', () =&gt; {
    // test authentication microservice
    cy.visit('/login');
    cy.get('input[name="email"]').type('user@example.com');
    cy.get('input[name="password"]').type('password123');
    cy.get('button[type="submit"]').click();

    // test product listing microservice
    cy.contains('products').click();
    cy.get('.product-card').first().click();

    // test order service
    cy.get('button.add-to-cart').click();
    cy.get('button.checkout').click();

    // assert the successful purchase
    cy.contains('order confirmation').should('exist');
  });
});

在此示例中，cypress 模拟用户登录、浏览产品、将产品添加到购物车并完成购买。此流程测试多个微服务之间的集成，确保它们无缝协作。

4。使用 cypress 模拟和存根微服务
微服务面临的挑战之一是测试期间对其他服务的依赖。如果一项服务关闭或未准备好，则可能会阻止测试过程。 cypress 提供模拟和存根功能来模拟来自依赖服务的响应。这样，您就可以单独测试每个微服务，而无需依赖其他微服务的可用性。

示例：模拟 cypress 中的服务：

cy.intercept('get', '/api/service-b/data', {
  statuscode: 200,
  body: { result: 'mocked response' }
}).as('getservicebdata');

// test with mocked service
cy.request('get', '/api/service-a/uses-service-b').then((response) =&gt; {
  expect(response.body).to.have.property('result', 'mocked response');
});

在这个测试中，cypress 模拟了 service-b 的响应，确保 service-a 仍然可以被测试，而不需要真正的 service-b 在线。

5。使用 cypress 测试微服务弹性
微服务通常需要处理故障场景，例如超时或服务不可用。 cypress 可用于通过模拟网络延迟或服务不可用等错误来测试服务在故障情况下的反应。

示例：测试服务超时：

cy.intercept('POST', '/api/service-b/interact', {
  statusCode: 504,  // Simulate gateway timeout
  body: { error: 'Service Unavailable' }
}).as('interactWithServiceB');

// Test service resilience
cy.request({
  method: 'POST',
  url: '/api/service-a/interact',
  failOnStatusCode: false  // Prevent failure on 504 status code
}).then((response) =&gt; {
  expect(response.status).to.eq(504);
  expect(response.body).to.have.property('error', 'Service Unavailable');
});

此测试模拟 service-b 上的网络超时，并检查 service-a 如何优雅地处理错误。