介绍

Dojo 的 @dojo/cli-test-intern 提供了一个健壮的测试框架。它能高效地测试小部件的输出并确认是否如你所愿。

功能描述
极简 API用于测试和断言 Dojo 部件预期的虚拟 DOM 和行为的精简 API。
单元测试单元测试是指运行在 node 和浏览器上的测试,用于测试独立的代码块。
功能测试功能测试通过 Selenium 运行在浏览器中,模拟用户与软件的交互来测试整体功能。
断言模板断言模板能构建期望的渲染函数,以验证部件的输出。

基本用法

测试 Dojo 应用程序

  • 运行项目的测试套件
  1. dojo test

Dojo 使用 @dojo/cli-test-intern 运行 tests 文件夹下的单元测试和功能测试。

运行特定的测试套件

Dojo 支持两种类型的测试方法:单元测试和功能测试。单元测试是运行在 node 和本地 Selenium 通道上的测试,用于测试独立的代码块。功能测试通过 Selenium 运行在浏览器中,模拟用户与软件的交互来测试整体功能。在 Selenium 上运行单元测试和功能测试时,必须先使用 @dojo/cli-build-app 进行适当的构建。

  • 运行项目的单元测试套件

命令行

  1. dojo test --unit --config local
  • 使用 Selenium 在本地的 headless Chrome 实例中运行功能测试。
  1. dojo test --functional --config local

编写单元测试

  • 使用 Dojo 的 harness API API 为部件编写单元测试。

src/widgets/Home.tsx

  1. import { create, tsx } from '@dojo/framework/core/vdom';
  2. import * as css from './Home.m.css';
  3. const factory = create();
  4. const Home = factory(function Home() {
  5. return <h1 classes={[css.root]}>Home Page</h1>;
  6. });
  7. export default Home;

tests/unit/widgets/Home.tsx

  1. const { describe, it } = intern.getInterface('bdd');
  2. import { tsx } from '@dojo/framework/core/vdom';
  3. import harness from '@dojo/framework/testing/harness';
  4. import assertionTemplate from '@dojo/framework/testing/assertionTemplate';
  5. import Home from '../../../src/widgets/Home';
  6. import * as css from '../../../src/widgets/Home.m.css';
  7. const baseTemplate = assertionTemplate(() => <h1 classes={[css.root]}>Home Page</h1>);
  8. describe('Home', () => {
  9. it('default renders correctly', () => {
  10. const h = harness(() => <Home />);
  11. h.expect(baseTemplate);
  12. });
  13. });

harness API 能让你核实渲染部件的输出是否如你所愿。

  • 它是否按预期渲染?
  • 事件处理器是否按预期工作?

编写功能测试

功能测试允许你在真正的浏览器上加载一个 UI 页面并执行其中的代码,以更好的测试部件的行为。

编写功能测试就是详细描述用户在页面中的交互,如点击元素,然后验证生成的页面内容。

tests/functional/main.ts

  1. describe('routing', () => {
  2. it('profile page correctly loads', ({ remote }) => {
  3. return (
  4. remote
  5. // 在本地的 node 服务器中加载 HTML 文件
  6. .get('../../output/dev/index.html')
  7. // 根据 id 找到超链接标签
  8. .findById('profile')
  9. // 单击链接
  10. .click()
  11. // 结束此操作
  12. .end()
  13. // 找到 h1 标签
  14. .findByTagName('h1')
  15. // 获取 h1 标签中的文本
  16. .getVisibleText()
  17. .then((text) => {
  18. // 核实 profile 页面中 h1 标签中的内容
  19. assert.equal(text, 'Welcome Dojo User!');
  20. })
  21. );
  22. });
  23. });

使用断言模板

断言模板提供了一种创建基本断言的方法,该方法允许你在每个测试间修改期望输出中的部分内容。

  • 一个部件可根据属性值的不同渲染不同的内容:

src/widgets/Profile.tsx

  1. import { create, tsx } from '@dojo/framework/core/vdom';
  2. import * as css from './Profile.m.css';
  3. export interface ProfileProperties {
  4. username?: string;
  5. }
  6. const factory = create().properties<ProfileProperties>();
  7. const Profile = factory(function Profile({ properties }) {
  8. const { username } = properties();
  9. return <h1 classes={[css.root]}>{`Welcome ${username || 'Stranger'}!`}</h1>;
  10. });
  11. export default Profile;
  • 使用 @dojo/framework/testing/assertionTemplate 创建一个断言模板

tests/unit/widgets/Profile.tsx

  1. const { describe, it } = intern.getInterface('bdd');
  2. import { tsx } from '@dojo/framework/core/vdom';
  3. import assertionTemplate from '@dojo/framework/testing/assertionTemplate';
  4. import harness from '@dojo/framework/testing/harness';
  5. import Profile from '../../../src/widgets/Profile';
  6. import * as css from '../../../src/widgets/Profile.m.css';
  7. // 创建一个断言
  8. const profileAssertion = assertionTemplate(() => (
  9. <h1 classes={[css.root]} assertion-key="welcome">
  10. Welcome Stranger!
  11. </h1>
  12. ));
  13. describe('Profile', () => {
  14. it('default renders correctly', () => {
  15. const h = harness(() => <Profile />);
  16. // 基于基本断言测试
  17. h.expect(profileAssertion);
  18. });
  19. });

使用在断言模板中定义的 assertion-key 属性,可为任何要测试的虚拟 DOM 提供一个值。注意:当使用的是 @dojo/framework/core/vdom 中的 v()w() 时,~key 属性可实现相同功能。

tests/unit/widgets/Profile.tsx

  1. describe('Profile', () => {
  2. it('default renders correctly', () => {
  3. const h = harness(() => <Profile />);
  4. // 重新测试基本断言
  5. h.expect(profileAssertion);
  6. });
  7. it('renders given username correctly', () => {
  8. // 使用给定的用户名更新期望的结果
  9. const namedAssertion = profileAssertion.setChildren('~welcome', () => ['Welcome Kel Varnsen!']);
  10. const h = harness(() => <Profile username="Kel Varnsen" />);
  11. h.expect(namedAssertion);
  12. });
  13. });

使用断言模板的 setChildren 方法,传入指定的 assertion-key 来定位一个虚拟 DOM(在本示例中是 ~welcome)并修改该虚拟 DOM 的结构,然后返回更新的断言模板。就可以使用返回的断言模板测试部件的输出。