reference-test-renderer.md

id	title	permalink	layout	category
test-renderer	Test Renderer	docs/test-renderer.html	docs	Reference

الاستيراد

import TestRenderer from 'react-test-renderer'; // ES6
const TestRenderer = require('react-test-renderer'); // ES5 with npm

لمحة عامة {#overview}

تُزوّدنا هذه الحزمة بمُصيِّر React يُمكِن استخدامه لتصيير مكوّنات React إلى كائنات JavaScript نقيّة بدون الاعتماد على DOM أو بيئة الهاتف المحمول الأصليّة.

تُسهِّل هذه الحزمة بشكل أساسي من أخذ صورة حول التسلسل الهرمي للمكوّنات (مشابه لشجرة DOM) والتي يُصيّرها React DOM أو React Native بدون استخدام المتصفح أو jsdom.

مثال:

import TestRenderer from 'react-test-renderer';

function Link(props) {
  return <a href={props.page}>{props.children}</a>;
}

const testRenderer = TestRenderer.create(
  <Link page="https://www.facebook.com/">Facebook</Link>
);

console.log(testRenderer.toJSON());
// { type: 'a',
//   props: { href: 'https://www.facebook.com/' },
//   children: [ 'Facebook' ] }

نستطيع استخدام ميزة الاختبار بالتقاط الصورة الموجودة في Jest لحفظ نسخة عن شجرة JSON بشكل تلقائي إلى ملف والتحقق في اختباراتك من أنّها لم تتغيّر. تعلّم المزيد حول ذلك.

بإمكانك أيضًا التنقل في الناتج لإيجاد عقد محددة:

import TestRenderer from 'react-test-renderer';

function MyComponent() {
  return (
    <div>
      <SubComponent foo="bar" />
      <p className="my">Hello</p>
    </div>
  )
}

function SubComponent() {
  return (
    <p className="sub">Sub</p>
  );
}

const testRenderer = TestRenderer.create(<MyComponent />);
const testInstance = testRenderer.root;

expect(testInstance.findByType(SubComponent).props.foo).toBe('bar');
expect(testInstance.findByProps({className: "sub"}).children).toEqual(['Sub']);

TestRenderer {#testrenderer}

• ()TestRenderer.create

TestRenderer instance {#testrenderer-instance}

• ()testRenderer.toJSON
• ()testRenderer.toTree
• ()testRenderer.update
• ()testRenderer.unmount
• ()testRenderer.getInstance
• testRenderer.root

TestInstance {#testinstance}

• ()testInstance.find
• ()testInstance.findByType
• ()testInstance.findByProps
• ()testInstance.findAll
• ()testInstance.findAllByType
• ()testInstance.findAllByProps
• testInstance.instance
• testInstance.type
• testInstance.props
• testInstance.parent
• testInstance.children

مرجع {#reference}

()TestRenderer.create {#testrenderercreate}

TestRenderer.create(element, options);

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

()testRenderer.toJSON {#testrenderertojson}

testRenderer.toJSON()

ن يُمثِّل الشجرة المُصيَّرة. تحتوي هذه الشجرة على عُقَد خاصّة بالمنصّة مثل <div> ن يُمثِّل الشجرة المُصيَّرة. تحتوي هذه الشجرة على عُقَد خاصّة بالمنصّة مثل <View> وخاصيّاتها، ولكنّه لا يحتوي على مكوّنات مكتوبة من قبل المستخدم. يُفيد هذا لأجلاختبار اللقطات (snapshot testing).

()testRenderer.toTree {#testrenderertotree}

testRenderer.toTree()

يُعيد كائن يُمثِّل الشجرة المُصيَّرة. وعلى النقيض من التابع toJSON()‎ يكون التمثيل أكثر تفصيلًا ويتضمّن المكوّنات المكتوبة من قبل المستخدم. لن تحتاج هذا التابع غالبًا إلّا إذا كنت تكتب مكتبتك الخاصّة بناءً على مُصيِّر الاختبار.

()testRenderer.update {#testrendererupdate}

testRenderer.update(element)

يُعيد تصيير الشجرة في الذاكرة مع عنصر جذري جديد. يُحاكي هذا تحديث React الذي يطرأ على العنصر الجذري. إن كان للعنصر الجديد نفس النوع والمفتاح للعنصر السابق فستُحدَّث الشجرة، وفيما عدا ذلك سيُعيد وصل شجرة جديدة.

()testRenderer.unmount {#testrendererunmount}

testRenderer.unmount()

يفصل الشجرة الموجودة في الذاكرة، وبذلك يُطلِق أحداث دورة الحياة المناسبة.

()testRenderer.getInstance {#testrenderergetinstance}

testRenderer.getInstance()

يُعيد النسخة الموافقة للعنصر الجذري إن كانت موجودة. لن يعمل هذا التابع إن كان العنصر الجذري عبارة عن مكوّن دالة لأنّها لا تمتلك نُسَخًا مثل مكوّنات الأصناف.

testRenderer.root {#testrendererroot}

testRenderer.root

يُعيد نسخة الاختبار للكائن الجذري والتي تفيد في إجراء استعلامات حول عقد مُحدَّدة في شجرة المكوّنات. بإمكانك استخدامه لإيجاد نُسَخ الاختبار الأخرى الموجودة في مستويات أدنى من الشجرة.

()testInstance.find {#testinstancefind}

testInstance.find(test)

إيجاد نسخة الاختبار الوحيدة المنحدرة التي يُعيد فيها التابع test(testInstance)‎ القيمة true. إن كان التابع test(testInstance)‎‎ لا يُعيد القيمة true لنسخة اختبار وحيدة بالضبط فسيرمي هذا التابع خطأً.

()testInstance.findByType {#testinstancefindbytype}

testInstance.findByType(type)

إيجاد نسخة اختبار وحيدة منحدرة من النوع المُعطى ضمن الوسيط type. إن لم يكن هنالك بالضبط نسخة اختبار وحيدة فسيرمي هذا التابع خطأً.

()testInstance.findByProps {#testinstancefindbyprops}

testInstance.findByProps(props)

إيجاد نسخة اختبار وحيدة منحدرة التي تمتلك الخاصيّات المُزوَّدة عن طريق الوسيط props. إن لم يكن هنالك بالضبط نسخة اختبار وحيدة تمتلك الخاصيّات المطلوبة فسيرمي هذا التابع خطأً.

()testInstance.findAll {#testinstancefindall}

testInstance.findAll(test)

إيجاد جميع نسخ الاختبار المنحدرة والتي يُعيد فيها التابع test(testInstance) القيمة true.

()testInstance.findAllByType {#testinstancefindallbytype}

testInstance.findAllByType(type)

إيجاد جميع نسخ الاختبار المنحدرة التي تمتلك النوع type.

testInstance.findAllByProps() {#testinstancefindallbyprops}

testInstance.findAllByProps(props)

إيجاد جميع نسخ الاختبار المنحدرة التي تمتلك الخاصيّات props.

testInstance.instance {#testinstanceinstance}

testInstance.instance

نسخة المكوّن المطابقة لنسخة الاختبار هذه. متوفّر فقط من أجل مكوّنات الأصناف، بسبب عدم امتلاك مكوّنات الدوال للنسخ. يُطابِق قيمة this بداخل المكوّن المُعطى.

testInstance.type {#testinstancetype}

testInstance.type

نوع المكوّن المُطابِق لنسخة الاختبار هذه. على سبيل المثال يمتلك المكوّن <Button /> النوع Button.

testInstance.props {#testinstanceprops}

testInstance.props

الخاصيّات المطابقة لنسخة الاختبار هذه. على سبيل المثال يمتلك المكوّن <Button size="small" /> الخاصيّة {size: 'small'} as props.

testInstance.parent {#testinstanceparent}

testInstance.parent

نسخة الاختبار الأب لنسخة الاختبار هذه.

testInstance.children {#testinstancechildren}

testInstance.children

نسخة الاختبار الابن لنسخة الاختبار هذه.

بعض الأفكار {#ideas}

بإمكانك تمرير الدالة createNodeMock إلى التابع TestRenderer.create كخيار، والذي يسمح بالمراجع المخصصة للمحاكاة. يقبل createNodeMock العنصر الحالي ويجب أن يُعيد كائن مرجع محاكي. يفيد هذا عند اختبار المكوّنات التي تعتمد على المراجع:

import TestRenderer from 'react-test-renderer';

class MyComponent extends React.Component {
  constructor(props) {
    super(props);
    this.input = null;
  }
  componentDidMount() {
    this.input.focus();
  }
  render() {
    return <input type="text" ref={el => this.input = el} />
  }
}

let focused = false;
TestRenderer.create(
  <MyComponent />,
  {
    createNodeMock: (element) => {
      if (element.type === 'input') {
        // mock a focus function
        return {
          focus: () => {
            focused = true;
          }
        };
      }
      return null;
    }
  }
);
expect(focused).toBe(true);