الدرس السابق: Developing Discourse Plugins - Part 5 - Add an admin interface
هل كنت تعلم أن Discourse يحتوي على مجموعتي اختبار كبيرتين لقاعدة الكود الخاصة به؟ على جانب الخادم، يحتوي كود Ruby الخاص بنا على مجموعة اختبار تستخدم rspec. بالنسبة لتطبيق المتصفح، لدينا مجموعة qunit تتضمن ember-testing.
بافتراض أنك قمت بإعداد بيئة تطوير، إذا قمت بزيارة الرابط http://localhost:3000/tests، ستبدأ في تشغيل مجموعة اختبار JavaScript في متصفحك. أحد الجوانب الممتعة هو أنه يمكنك رؤية التطبيق قيد الاختبار في نافذة مصغرة في الزاوية السفلية اليمنى:
تم بناء تطبيق Discourse مع كثير جداً من الاختبارات التي ستبدأ في التشغيل عند زيارتك للرابط /tests. لذا قد يكون من المفيد تصفية اختباراتك حسب الإضافي (plugin) الذي تعمل عليه. يمكنك فعل ذلك من الواجهة عبر النقر على قائمة Plugin المنسدلة وتحديد الإضافة الخاصة بك:
إضافة اختبار قبول (Acceptance Test) في إضافتك
أولاً، تأكد من أنك حصلت على أحدث إصدار من Discourse. القدرة على تشغيل اختبارات القبول من الإضافات هي ميزة جديدة نسبياً، وإذا لم تقم بالحصول على أحدث إصدار، فلن تظهر اختباراتك.
في هذه المقالة، سأكتب اختبار قبول للإضافة purple-tentacle التي أنشأناها في الجزء 5 من هذه السلسلة.
إضافة اختبار قبول سهلة تماماً كإضافة ملف واحد إلى إضافتك. أنشئ الملف التالي:
test/javascripts/acceptance/purple-tentacle-test.js
import { acceptance, exists } from "discourse/tests/helpers/qunit-helpers";
import { click, visit } from "@ember/test-helpers";
import { test } from "qunit";
acceptance("Purple Tentacle", function (needs) {
needs.settings({ purple_tentacle_enabled: true });
needs.user();
test("Purple tentacle button works", async function (assert) {
await visit("/admin/plugins/purple-tentacle");
assert.ok(exists("#show-tentacle"), "it shows the purple tentacle button");
assert.ok(!exists(".tentacle"), "the tentacle is not shown yet");
await click("#show-tentacle");
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
});
});
حاولت كتابة الاختبار بطريقة واضحة، لكن قد يكون الأمر محيراً قليلاً إذا لم تسبق لك كتابة اختبار قبول من قبل. أنصحك بقوة بـ قراءة وثائق Ember حول اختبارات القبول لأنها تحتوي على الكثير من المعلومات القيمة.
في كل اختبار نكتبه، نحتاج إلى assert (التحقق من) شيء ما. في اختبارنا، نريد إجراء بعض التحقق للتأكد مما إذا كان اللسان (tentacle) مخفياً في البداية ثم يظهر فقط بعد النقر على الزر.
نريد تعريف مجموعة من الإجراءات التي يجب اتخاذها قبل إجراء التحقق. للقيام بذلك، نستخدم كلمة المفتاح await. باستخدام هذه الكلمة، ننتظر حتى ينتهي تنفيذ كل مساعد غير متزامن أولاً.
أول إجراء مهم لدينا هو: await visit("/admin/plugins/purple-tentacle");. هذا يخبر الاختبار الخاص بنا بالانتقال إلى هذا الرابط في تطبيقنا. كان هذا الرابط هو الذي يعرض اللسان.
بعد زيارة الصفحة التي يظهر فيها زر اللسان الأرجواني، نريد التحقق مما إذا كان الزر موجوداً على الصفحة وأن صورة اللسان غير موجودة بعد.
يتم ذلك عن طريق التحقق التالي:
assert.ok(exists("#show-tentacle"), "it shows the purple tentacle button");
assert.ok(!exists(".tentacle"), "the tentacle is not shown yet");
ملاحظة (P.S.): الإصدار السابق من إضافة purple-tentacle لم يكن يحتوي على عنصر المعرف #show-tentacle في قالب handlebars. راجع أحدث إصدار لمتابعة الشرح!
بمجرد نجاح تلك الاختبارات، حان وقت اختبار التفاعل.
الأمر التالي هو await click('#show-tentacle'); الذي يخبر إطار الاختبار الخاص بنا أننا نريد النقر على الزر وإظهار اللسان.
بعد محاكاة النقر على الزر، يمكننا التحقق مما إذا كان اللسان يظهر عن طريق التحقق:
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
ليس سيئاً أليس كذلك؟ يمكنك تجربة الاختبار بنفسك من خلال زيارة http://localhost:3000/tests?target=purple-tentacle على جهاز التطوير الخاص بك. يجب أن ترى اللسان الأرجواني يظهر بسرعة جداً وستنجح جميع الاختبارات.
إذا كنت ترغب في تشغيل اختبارات qunit للإضافة من سطر الأوامر، يمكنك تشغيل
bin/qunit --target purple-tentacle
(أضف --standalone إذا كان خادم التطوير الخاص بك لا يعمل)
(حيث purple-tentacle هو اسم مجلد الإضافة الخاص بك)
تصحيح أخطاء اختباراتك
أثناء كتابة إضافاتك، يمكن أن تساعدك اختباراتك في تحديد المشكلات في الإضافة. عند تطوير اختباراتك أو عند إجراء تغييرات على كود الإضافة، قد تفشل الاختبارات. للمساعدة في فهم السبب، يحتوي Ember على بعض المساعدات المفيدة: pauseTest() و resumeTest().
لاستخدامها، أضف await pauseTest() داخل كود الاختبار حيث تريد أن يتوقف الاختبار. الآن، عند تشغيل الاختبار في المتصفح، سيتوقف الاختبار تلقائياً عند النقطة التي أضفت فيها `pauseTest(). هذا سيمنحك فرصة لفحص الصفحة أو عرض أي أخطاء للمساعدة في تصحيح المشكلات.
أين تذهب من هنا
أكره أن أبدو كالمسجل المكسور، لكن وثائق Ember الخاصة بالاختبار ممتازة. قد ترغب أيضاً في رؤية كيفية اختبار Discourse لوظائف مختلفة من خلال تصفح الاختبارات في مجلد اختبارات JavaScript الخاص بنا. لدينا العديد من الأمثلة هناك يمكنك التعلم منها.
اختبارات سعيدة!
المزيد في هذه السلسلة
الجزء 1: أساسيات الإضافة
الجزء 2: مخارج الإضافة
الجزء 3: إعدادات الموقع
الجزء 4: إعداد git
الجزء 5: واجهات المشرف
الجزء 6: هذا الموضوع
الجزء 7: نشر إضافتك
هذا المستند يخضع للتحكم في الإصدارات - اقترح التغييرات على github.


