React/test utils

استيراد الأدوات

import ReactTestUtils from 'react-dom/test-utils'; // ES6
var ReactTestUtils = require('react-dom/test-utils'); // ES5 with npm

لمحة عامة

تسهل أدوات ReactTestUtils اختبار مكوّنات React في إطار عمل الاختبار الذي تريده. يستخدم Facebook الأداة Jest لاختبار JavaScript بسهولة. تعلم كيفية البدء مع Jest عبر درس React في موقع Jest.

ملاحظة: هنالك أداة بديلة أخرى تُدعى react-testing-library نوصي باستعمالها، إذ صُمِّمَت لتمكين وتشجيع كتابة اختبارات لاستخدامها مع مكوّناتك بينما يستخدمها المستخدم النهائي.

أطلقت Airbnb أداة اختبار تُدعى Enzyme والتي تجعل من السهل التعامل مع ناتج مكوّناتك. إن قرّرت استخدام أداة اختبار أخرى مع Jest فقد تستحق تجربتها من هنا.

مرجع

act()‎

إن أردت تحضير مكون لإجراء عمليات اختبار عليه، فغلِّف الشيفرة التي تصيّره ونفِّذ التحديثات داخل الاستدعاء act()‎. يؤدي ذلك إلى تنفيذ عمليات الاختبار بشكل مشابه لكيفية عمل React في المتصفح.

ملاحظة: إن كنت تستعمل react-test-renderer، فإنَّها توفر التصدير act الذي يسلك نفس السلوك.

على سبيل المثال، ليكن لدينا المكون Counter التالي:

class Counter extends React.Component {
  constructor(props) {
    super(props);
    this.state = {count: 0};
    this.handleClick = this.handleClick.bind(this);
  }
  componentDidMount() {
    document.title = `You clicked ${this.state.count} times`;
  }
  componentDidUpdate() {
    document.title = `You clicked ${this.state.count} times`;
  }
  handleClick() {
    this.setState(state => ({
      count: state.count + 1,
    }));
  }
  render() {
    return (
      <div>
        <p>You clicked {this.state.count} times</p>
        <button onClick={this.handleClick}>
          Click me
        </button>
      </div>
    );
  }
}

إليك كيف يمكن اختباره:

import React from 'react';
import ReactDOM from 'react-dom';
import { act } from 'react-dom/test-utils';
import Counter from './Counter';

let container;

beforeEach(() => {
  container = document.createElement('div');
  document.body.appendChild(container);
});

afterEach(() => {
  document.body.removeChild(container);
  container = null;
});

it('can render and update a counter', () => {
  // componentDidMount و render اختبر أولًا
  act(() => {
    ReactDOM.render(<Counter />, container);
  });
  const button = container.querySelector('button');
  const label = container.querySelector('p');
  expect(label.textContent).toBe('You clicked 0 times');
  expect(document.title).toBe('You clicked 0 times');

  // componentDidUpdate و render اختبر ثانيًا
  act(() => {
    button.dispatchEvent(new MouseEvent('click', {bubbles: true}));
  });
  expect(label.textContent).toBe('You clicked 1 times');
  expect(document.title).toBe('You clicked 1 times');
});

لا تنسَ أنَّ إرسال أحداث DOM يعمل عند إضافة حاوية DOM إلى document فقط. تستطيع استعمال مساعد مثل react-testing-library لتقليل الشيفرة المتداولة (boilerplate code).

يحتوي توثيق recipes على مزيد من التفاصيل حول سلوك act()‎، مع أمثلة على كيفية الاستخدام.

mockComponent()‎

mockComponent(
  componentClass,
  [mockTagName]
)

تمرير وحدة المكوّن المحاكي إلى هذا التابع لتزويد المكوّن بتوابع مفيدة، فبدلًا من التصيير الاعتيادي سيصبح المكوّن عنصر div بسيط (أو أي عنصر آخر ندخله ضمن الوسيط mockTagName) يحتوي على أي مكوّن ابن نعطيه له.

ملاحظة: mockComponent()‎ هي واجهة برمجة تطبيق قديمة. نوصي باستخدام jest.mock()‎ بدلًا من ذلك.

isElement()‎

isElement(element)

يُعيد القيمة true إن كان الوسيط element عبارة عن عنصر React.

isElementOfType()‎

isElementOfType(
  element,
  componentClass
)

يُعيد القيمة true إن كان الوسيط element عبارة عن عنصر React نوعه هو componentClass.

isDOMComponent()‎

isDOMComponent(instance)

يُعيد القيمة true إن كان الوسيط instance هو مكوّن DOM (مثل div أو span).

isCompositeComponent()‎

isCompositeComponent(instance)

يُعيد القيمة true إن كان الوسيط instance عبارة عن مكوّن مُعرَّف من قبل المستخدم كالأصناف أو الدوال.

isCompositeComponentWithType()‎

isCompositeComponentWithType(
  instance,
  componentClass
)

يُعيد القيمة true إن كان الوسيط instance عبارة عن مكوّن من النوع componentClass.

findAllInRenderedTree()‎

findAllInRenderedTree(
  tree,
  test
)

التنقل عبر مكوّنات شجرة المكوّنات وجمع كل المكوّنات حيث يكون test(component)‎ قيمته true. لا يكون هذا مفيدًا بحد ذاته ولكنّه يُستخدَم كبداية لأدوات اختبار أخرى.

scryRenderedDOMComponentsWithClass()‎

scryRenderedDOMComponentsWithClass(
  tree,
  className
)

إيجاد جميع مكوّنات عناصر DOM في الشجرة المُصيَّرة والتي هي مكوّنات DOM لها اسم صنف يُطابِق المذكور في الوسيط className.

findRenderedDOMComponentWithClass()‎

findRenderedDOMComponentWithClass(
  tree,
  className
)

مثل scryRenderedDOMComponentsWithClass()‎ ولكن يتوقّع وجود نتيجة واحدة، ويُعيد تلك النتيجة، أو يرمي استثناء إن كان عدد المكوّنات المطابقة أكثر من واحد.

scryRenderedDOMComponentsWithTag()‎

scryRenderedDOMComponentsWithTag(	
  tree,
  tagName
)

إيجاد جميع مكوّنات عناصر DOM في الشجرة المُصيَّرة والتي هي مكوّنات DOM لها اسم للوسم يُطابِق المذكور في الوسيط tagName.

findRenderedDOMComponentWithTag()‎

findRenderedDOMComponentWithTag(
  tree,
  tagName
)

مثل scryRenderedDOMComponentsWithTag()‎ ولكن يتوقّع وجود نتيجة واحدة، ويُعيد تلك النتيجة، أو يرمي استثناء إن كان عدد المكوّنات المطابقة أكثر من واحد.

scryRenderedComponentsWithType()‎

scryRenderedComponentsWithType(
  tree,
  componentClass
)

إيجاد جميع نسخ المكوّنات التي نوعها يُساوي componentClass.

findRenderedComponentWithType()‎

findRenderedComponentWithType(
  tree,
  componentClass
)

مثل scryRenderedComponentsWithType()‎‎ ولكن يتوقّع وجود نتيجة واحدة، ويُعيد تلك النتيجة، أو يرمي استثناء إن كان عدد المكوّنات المطابقة أكثر من واحد.

renderIntoDocument()‎

renderIntoDocument(element)

تصيير عنصر React في عقدة DOM منفصلة في المستند. تتطلّب هذه الدالة قابلية الوصول إلى DOM. وهي مكافئة لما يلي:

const domContainer = document.createElement('div');
ReactDOM.render(element, domContainer);

ملاحظة: تحتاج إلى أن تكون window، و window.document، و window.document.createElement متوفرة لديك بشكل عام (global) قبل استيراد React، وإلّا ستعتقد React أنّها لا تستطيع الوصول إلى DOM ولن تعمل توابع مثل setState.

أدوات أخرى

Simulate

Simulate.{eventName}(
  element,
  [eventData]
)

محاكاة حدث في عقدة DOM مع خيار إضافي لبيانات الأحداث eventData.

تمتلك الأداة Simulate تابعًا لكل حدث تفهمه React.

الضغط على عنصر:

// <button ref={(node) => this.button = node}>...</button>
const node = this.button;
ReactTestUtils.Simulate.click(node);

تغيير القيمة لحقل الإدخال ثمّ الضغط على ENTER:

// <input ref={(node) => this.textInput = node} />
const node = this.textInput;
node.value = 'giraffe';
ReactTestUtils.Simulate.change(node);
ReactTestUtils.Simulate.keyDown(node, {key: "Enter", keyCode: 13, which: 13});

ملاحظة: يجب عليك تزويد أي خاصيّة حدث تستخدمها في مكوّنك (مثل KeyCode، و Which، إلخ...) لأنّ React لا تُنشِئ أي من هذه الخاصيّات لأجلك.

انظر أيضًا

• واجهة برمجة التطبيق (API) ذات المستوى الأعلى في React
• الصنف React.Component
• الكائن ReactDOM
• الكائن ReactDOMServer
• عناصر DOM
• الأحداث المصطنعة (Synthetic Events)
• التصيير السطحي (Shallow Rendering)
• مصير الاختبار (Test Renderer)
• متطلبات بيئة JavaScript

مصادر

• صفحة أدوات الاختبار في توثيق React الرسمي.