记一下cypress,端到端测试(End-to-end Testing)

cypress基本介绍

Cypress是一个现代的端到端前端测试框架。它专注于简化测试流程,提供了直观的API和开箱即用的功能,可以进行可靠、高效和可维护的前端测试。

Cypress的主要特点包括:

  1. 可视化测试运行器:Cypress提供了一个可视化测试运行器,用于实时查看测试用例的执行情况、断言结果和DOM状态。这使得测试过程更直观、易于调试和故障排查。
  2. 自动等待机制:Cypress会自动等待页面上的各种操作完成,无需手动添加显式的等待时间。它会等待XHR、异步操作、动画效果等自动完成,从而提高测试的稳定性和可靠性。
  3. 强大的选择器:Cypress支持强大的DOM元素选择器,包括CSS选择器和自定义选择器,使得测试用例能够轻松定位DOM元素和与之交互。
  4. 易于编写和理解的语法:Cypress使用简洁的语法,易于编写和理解。它提供了丰富的API,用于模拟用户行为、进行断言、处理网络请求等,使得测试用例的编写变得简单而富有表达力。
  5. 内置的Mock和Stub功能:Cypress提供了内置的Mock和Stub功能,可以轻松地模拟和篡改服务器响应、网络请求等,方便进行集成测试和单元测试。
  6. 跨浏览器支持:Cypress支持多种常见的浏览器,包括Chrome、Firefox、Edge等,使得开发人员能够在不同的浏览器环境中运行和验证测试用例。

总体而言,Cypress旨在提供一个友好、高效且现代化的前端测试框架,帮助开发人员编写稳定可靠的端到端测试,并提高应用程序的质量和可靠性。

项目文件介绍

当使用Cypress进行测试时,以下是关于fixturesi18nintegrationpluginsupport的一些具体介绍和代码示例:

  1. Fixtures(测试数据)

    Fixtures用于提供测试中所需的静态数据。可以将数据保存在独立的文件中,并在测试中使用。常见的格式包括JSON和CSV等。

    示例:假设有一个JSON格式的fixture文件user.json,包含用户的信息:

    // user.json
    {
      "id": 1,
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
    

    在测试中可以使用cy.fixture()命令加载fixture数据:

    cy.fixture('user.json').then((user) => {
      cy.log(user.name); // 输出 User's name: John Doe
    });
    
  2. i18n(国际化)

    Cypress支持处理国际化(i18n)的测试。可以使用不同的语言环境配置进行测试,并验证应用程序在不同语言环境下的行为。

    示例:假设有一个i18n插件负责提供不同的语言翻译。在测试中可以使用插件来设置不同的语言环境:

    // cypress/plugins/index.js
    module.exports = (on, config) => {
      on('task', {
        changeLanguage(language) {
          // 根据语言设置应用程序的语言环境
          // 这个是一个示例,实际操作取决于应用程序的实现
          if (language === 'en') {
            // 设置为英文
          } else if (language === 'fr') {
            // 设置为法文
          }
          return null;
        }
      })
    };
    
    // 在测试中使用
    cy.task('changeLanguage', 'fr'); // 设置语言为法文
    cy.get('.title').should('contain', 'Bienvenue'); // 验证文本是否为法语 "Bienvenue"
    
  3. Integration(集成测试)

    在Cypress中,可以使用integration文件夹来组织测试文件,并组织测试套件。

    示例:在integration文件夹中创建一个名为login.spec.js的测试文件:

    // integration/login.spec.js
    describe('Login', () => {
      it('displays login form', () => {
        cy.visit('/login');
        cy.get('form').should('be.visible');
      });
    
      it('allows user to login', () => {
        cy.visit('/login');
        cy.get('input[name="email"]').type('john.doe@example.com');
        cy.get('input[name="password"]').type('password');
        cy.get('form').submit();
        cy.url().should('eq', '/dashboard');
      });
    });
    

    在这个例子中,我们创建了两个测试用例来验证登录页面的行为。

  4. Plugins(插件)

    Cypress插件可以扩展Cypress的功能,添加新命令、自定义报告、处理文件上传、模拟网络请求等等。

    示例:创建一个插件来添加自定义命令customCommand

    // cypress/plugins/index.js
    module.exports = (on, config) => {
      on('task', {
        customCommand() {
          // 模拟执行自定义的命令
          // 这个是一个示例,实际操作取决于应用程序的实现
          return 'Command executed';
        }
      });
    };
    
    // 在测试中使用
    cy.task('customCommand').then((result) => {
      cy.log(result); // 输出 "Command executed"
    });
    
  5. Support(支持)

    在Cypress中,可以使用support文件夹来存放测试中所需的辅助文件,例如自定义命令、页面对象等。

    示例:在support/commands.js中定义一个自定义命令:

    // support/commands.js
    Cypress.Commands.add('login', (email, password) => {
      cy.visit('/login');
      cy.get('input[name="email"]').type(email
    

其中,在integration文件中又包括了commoncomponentTestsi18nTestspage-objects,以下是对具体文件的介绍:

  1. common(通用)

    common文件夹用于存放在多个测试套件中共享的通用测试辅助函数、数据或逻辑。这些文件可以被其他测试文件引用和重用,避免了重复编写相似的代码。

    示例:在common/utils.js中定义一个通用的测试辅助函数:

    // common/utils.js
    export const formatName = (name) => {
      return name.toUpperCase();
    };
    

    在测试中可以导入和使用这个通用函数:

    // integration/componentTests/myComponent.spec.js
    import { formatName } from '../../common/utils.js';
    
    describe('MyComponent', () => {
      it('formats name correctly', () => {
        const name = formatName('John');
        expect(name).to.be.equal('JOHN');
      });
    });
    
  2. componentTests(组件测试)

    componentTests文件夹用于存放针对单个组件的测试。它通常包含针对特定组件的各种场景和交互的测试用例,以确保组件在各种情况下的行为符合预期。

    示例:在componentTests/myComponent.spec.js中编写一个组件测试用例:

    // integration/componentTests/myComponent.spec.js
    describe('MyComponent', () => {
      it('renders correctly', () => {
        cy.visit('/my-component');
        cy.get('.my-component').should('be.visible');
      });
    
      it('handles click event', () => {
        cy.visit('/my-component');
        cy.get('.my-component').click();
        cy.get('.my-component').should('have.class', 'expanded');
      });
    });
    

    在这个例子中,我们测试了MyComponent组件的渲染和点击事件处理。

  3. i18nTests(国际化测试)

    i18nTests文件夹用于存放与国际化相关的测试。在这里,你可以编写验证应用程序在不同语言环境下的翻译和显示的测试用例。

    示例:在i18nTests/login.spec.js中编写一个国际化测试用例:

    // integration/i18nTests/login.spec.js
    describe('Login', () => {
      it('displays login form in different languages', () => {
        cy.task('changeLanguage', 'en'); // 设置语言为英文
        cy.visit('/login');
        cy.get('form').should('contain', 'Username');
        
        cy.task('changeLanguage', 'fr'); // 设置语言为法文
        cy.visit('/login');
        cy.get('form').should('contain', 'Nom d'utilisateur');
      });
    });
    

    在这个例子中,我们验证了登录表单在英文和法文环境下的显示。

  4. page-objects(页面对象)

    page-objects文件夹用于存放定义和封装页面对象的文件。这些页面对象代表应用程序中的不同页面或组件,并提供了操作和断言页面元素的方法,使测试代码更模块化和可维护。

    示例:在page-objects/homePage.js中定义一个HomePage页面对象:

// page-objects/homePage.js
 export default class HomePage {
   visit() {
     cy.visit('/home');
   }

   getTitle() {
     return cy.get('.title');
   }
 }

 // integration/componentTests/homePage.spec.js
 import HomePage from '../../page-objects/homePage';

 describe('Home Page', () => {
   const homePage = new HomePage();

   beforeEach(() => {
     homePage.visit();
   });

   it('displays welcome message', () => {
     homePage.getTitle().should('contain', 'Welcome');
   });
 });

 // integration/login.spec.js
 import HomePage from '../page-objects/homePage';

 describe('Login', () => {
   const homePage = new HomePage();

   beforeEach(() => {
     homePage.visit();
   });

   it('displays login form', () => {
     cy.get('form').should('be.visible');
   });

   it('allows user to login', () => {
     cy.get('input[name="email"]').type('john.doe@example.com');
     cy.get('input[name="password"]').type('password');
     cy.get('form').submit();

     // 使用页面对象进行断言
     homePage.getTitle().should('contain', 'Dashboard');
   });
 });

在这个例子中,我们创建了一个HomePage页面对象,用于封装访问首页和断言标题的方法。在不同的测试文件中,我们实例化了这个页面对象并使用它来操作和断言页面元素。

componentTests/homePage.spec.js中,我们测试首页是否显示了欢迎信息。

login.spec.js中,我们测试登录页面是否显示登录表单,并验证用户能否成功登录,然后使用HomePage页面对象进行断言来验证登录后的导航标题。

补充:当涉及到复杂的Cypress测试时,以下是一些常见场景的示例:

  1. 使用cy.intercept()模拟网络请求

    // 在测试之前设置拦截
    cy.intercept('GET', '/api/user', {
      statusCode: 200,
      body: {
        id: 1,
        name: 'John Doe'
      }
    }).as('getUser');
    
    // 执行触发网络请求的操作
    cy.get('.btn').click();
    
    // 等待拦截的请求完成
    cy.wait('@getUser').then((xhr) => {
      expect(xhr.response.statusCode).to.equal(200);
      expect(xhr.response.body.name).to.equal('John Doe');
    });
    

    在这个例子中,我们通过cy.intercept()拦截了一个GET请求,并模拟了一个成功的响应。然后,我们通过点击按钮来触发该请求并使用cy.wait()等待请求完成,以进行验证。

  2. 使用cy.task()执行自定义任务

    // 在plugins文件中定义一个自定义任务
    module.exports = (on, config) => {
      on('task', {
        calculateSum(numbers) {
          const sum = numbers.reduce((total, num) => total + num, 0);
          return sum;
        }
      });
    };
    
    // 在测试中执行自定义任务
    cy.task('calculateSum', [2, 4, 6]).then((sum) => {
      expect(sum).to.equal(12);
    });
    

    在这个例子中,我们在plugins文件中定义了一个自定义任务calculateSum,用于计算给定数组的总和。然后,我们在测试中执行该自定义任务,并验证计算结果是否正确。

  3. 使用cy.wrap()封装异步操作

    // 封装异步操作
    const waitForElement = () => {
      return new Promise((resolve) => {
        setTimeout(() => {
          resolve(true);
        }, 3000);
      });
    };
    
    // 使用cy.wrap()等待异步操作完成
    cy.wrap(waitForElement()).should('be.true');
    

    在这个例子中,我们封装了一个异步操作waitForElement,返回一个延迟3秒后解析为true的Promise。然后使用cy.wrap()包装该异步操作,并使用should()断言来验证其结果是否为true

这些示例展示了一些更复杂的Cypress测试场景,涉及到了网络请求的模拟、自定义任务的执行和封装异步操作。通过利用Cypress丰富的API和功能,我们可以编写出更强大、灵活和可靠的测试用例。

原文链接:https://juejin.cn/post/7257516901826773029 作者:少七水水水

(0)
上一篇 2023年7月20日 上午10:10
下一篇 2023年7月20日 上午10:20

相关推荐

发表回复

登录后才能评论