如何在 Cypress 中处理 iframe

介绍

在 web 应用程序中测试 iframe 通常很棘手，尤其是在使用现代测试自动化工具时。 cypress 凭借其直观的设计和强大的 api，简化了许多测试挑战​​。然而，在 cypress 中处理 iframe 需要一些额外的设置，因为 cypress 不直接支持访问 iframe 内的内容。

在这篇博文中，我们将探讨如何在 cypress 中处理 iframe，并提供实际示例和高效 iframe 测试的技巧。

什么是 iframe？

iframe（内联框架的缩写）是一种在当前网页中嵌入另一个文档的 html 元素。它通常用于将广告、视频或小部件等外部内容加载到页面中，而无需刷新整个页面。

为什么 iframe 在 cypress 中具有挑战性

cypress 在浏览器上下文中运行，该上下文对于跨源访问具有严格的安全限制。由于 iframe 实质上是在父页面中加载另一个网页，因此由于这些浏览器安全限制，cypress 无法使用 .get() 或 .find() 等标准命令直接访问 iframe 内的元素。

在 cypress 中处理 iframe：基础知识

要在 cypress 中使用 iframe，我们需要：

1. 访问 iframe 的内容。
2. 使用 cypress 命令与 iframe 内的元素进行交互。

方法：使用 jquery 和 cypress

cypress 在底层使用 jquery，它提供了一种访问 iframe 内容的方法。使用 jquery，我们可以访问 iframe 的文档，然后从那里我们可以定位 iframe 内的元素。

分步示例

让我们看一个与网页上的 iframe 交互的示例。在此示例中，我们将：

• 加载包含 iframe 的网页。
• 访问 iframe。
• 与 iframe 内的元素交互。

1。加载页面并访问 iframe
以下是带有 iframe 的 html 结构示例：

  <title>iframe example</title><h1>welcome to the iframe example</h1>
  <iframe id="myiframe" src="https://example.com/iframe-content"></iframe>

在此示例中，我们有一个 id="myiframe" 的 iframe。我们将使用 cypress 访问此 iframe 并与其中的内容进行交互。

2。用于处理 iframe 的 cypress 自定义命令
由于处理 iframe 是一项常见任务，因此创建自定义 cypress 命令可以简化该过程。让我们创建一个检索 iframe 主体的自定义命令：

cypress.commands.add('getiframebody', (iframeselector) => {
  // wait for the iframe to load
  cy.get(iframeselector)
    .its('0.contentdocument.body').should('not.be.empty')
    .then(cy.wrap);
});

3。与 iframe 内的元素交互
现在我们有了访问 iframe 主体的自定义命令，我们可以与 iframe 内的元素进行交互。以下是如何在测试中使用它的示例：

describe('iframe test', () => {
  it('should access and interact with an element inside an iframe', () => {
    cy.visit('http://localhost:8080/iframe-page');

    // use the custom command to get the iframe body
    cy.getiframebody('#myiframe').within(() => {
      // now we can interact with elements inside the iframe
      cy.get('h1').should('contain.text', 'iframe content title');
      cy.get('button#submit').click();
    });
  });
});

在此测试中：

• 我们使用 iframe 访问页面。
• 我们使用自定义的 getiframebody 命令来访问 iframe 内容。
• 我们与 iframe 内的元素进行交互，例如断言 h1 元素的文本并单击按钮。

处理跨源 iframe

由于浏览器安全策略的原因，使用跨源 iframe（从不同域加载内容的 iframe）会带来额外的挑战。由于同源政策，cypress 无法直接访问跨源 iframe 内的元素或与之交互。

以下是 cypress 中处理跨域 iframe 的一些策略：

1. 模拟 iframe 内容： 不要加载实际的跨域内容，而是在测试中模拟 iframe 内容。
2. 使用 api 测试：如果您在 iframe 内处理外部服务，请考虑使用 api 测试来直接测试服务而不是 ui。
3. 使用 cy.origin(): 如果 cypress 和浏览器支持，则可以使用 cy.origin() 命令来处理跨源 iframe 内容。但是，请注意，这是实验性的，可能需要额外的设置。

示例：使用 cy.origin() 处理跨源 iframe

describe('Cross-Origin Iframe Test', () => {
  it('should handle a cross-origin iframe', () => {
    cy.visit('http://localhost:8080/cross-origin-iframe-page');

    cy.origin('https://example-iframe.com', () => {
      cy.get('#iframe-element').should('contain.text', 'Cross-Origin Content');
    });
  });
});

在此测试中，cy.origin() 命令允许我们与跨源 iframe 内的元素进行交互，前提是域设置允许这样做。

在 cypress 中处理 iframe 的最佳实践

以下是在 cypress 中使用 iframe 时需要记住的一些最佳实践：

1. 使用自定义命令：将 iframe 处理逻辑封装在自定义命令中，例如 getiframebody，使您的测试更清晰、更易于维护。
2. 避免跨源 iframe： 尽可能避免依赖跨源 iframe。如果必须测试跨源 iframe，请考虑使用 cy.origin() 或 api 测试。
3. 等待 iframe 加载： 在尝试与其交互之前，始终确保 iframe 内容已完全加载。使用 .should('not.be.empty') 或 .its('contentdocument.body') 验证 iframe 内容是否可访问。
4. 模块化测试：如果您的应用程序使用多个 iframe，请模块化地构建您的测试以分别处理每个 iframe 交互。

结论

在 cypress 中处理 iframe 需要一些额外的工作，但是通过创建自定义命令并使用 jquery 方法，您可以有效地与 iframe 内的元素进行交互。对于跨源 iframe，请考虑在可能的情况下使用 cy.origin() 或 api 测试。通过正确的方法和可靠的测试策略，您可以自信地测试依赖 iframe 的 web 应用程序。