Plots2: أضف المزيد من الاختبارات الوظيفية لكل طريقة في واجهة برمجة تطبيقات البحث

مرحبًا ، هذه مشكلة لأول مرة فقط. هذا يعني أننا عملنا على جعله أكثر وضوحًا للأشخاص الذين لم يساهموا في قاعدة الرموز الخاصة بنا من قبل أو حتى الأشخاص الذين لم يساهموا في المصدر المفتوح من قبل.

إذا كان الأمر كذلك ، فنحن مهتمون بمساعدتك على اتخاذ الخطوة الأولى ويمكننا الإجابة على الأسئلة ومساعدتك كما تفعل. لاحظ أننا مهتمون بشكل خاص بالمساهمات من أشخاص من مجموعات ممثلة تمثيلا ناقصا في البرامج المجانية ومفتوحة المصدر!

إذا كنت قد ساهمت من قبل ، ففكر في ترك هذا لشخص جديد ، وابحث عن المشكلات المطلوبة للمساعدة العامة. شكرا!

المشكلة

تساعدنا الاختبارات على ضمان تصرف الموقع بالشكل الذي نتوقعه - وأنه عند إضافة ميزات جديدة ، فإنها لا تكسر الوظائف الحالية. نحن نعمل على الوصول إلى ما يقرب من 100٪ "تغطية" - مما يعني أن جميع التعليمات البرمجية الخاصة بنا مغطاة بالاختبارات.
لدينا اختبارات جيدة مكتوبة لواجهة برمجة تطبيقات رأس الطباعة ، هنا: https://github.com/publiclab/plots2/blob/master/test/functional/typeahead_api_test.rb

يختبر هذا كل طريقة في: https://github.com/publiclab/plots2/blob/master/app/api/srch/typeahead.rb

ولكن يجب أن يكون لدينا طرق مماثلة لواجهة برمجة تطبيقات البحث ، لكل طريقة من الطرق الموجودة في: https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb

(لاحظ أن هذه تعتمد بشكل كبير على هذا الملف ، بدورها - في حالة رغبتك في معرفة كيفية إنشائها: https://github.com/publiclab/plots2/blob/master/app/services/search_service.rb)

المحلول

في # 1409 ، أنشأ أحد المساهمين لأول مرة ملف اختبار جديدًا ، واختبارًا واحدًا ، يمكنك العثور عليه في test / Functional / search_api_test.rb:

اختبار "وظائف ملاحظات البحث" تفعل
الحصول على '/ api / srch / notes؟ srchString = مدونة'
تأكيد last_response.ok؟
# أشياء أخرى بعد ذلك
هذا اختبار أساسي على أن الاستجابة "جيدة" ثم يتابع لاختبار ما هو موجود في الاستجابة. تعرف على كيفية استخدام عنوان URL للوصول إلى طريقة الملاحظات على هذا السطر:

لذا ، انسخه واتبع أمثلة URL المتوفرة في search.rb لإنشاء اختبار جديد لطريقة مختلفة. على سبيل المثال ، الملفات الشخصية: https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb#L30

ابدأ فقط بتأكيد last_response.ok؟ على النحو الوارد أعلاه؛ يمكننا إضافة المزيد من الاختبارات الموضوعية لاحقًا.

يمكنك تجربة تشغيل هذا باستخدام اختبار أشعل النار أو (فقط لإجراء الاختبارات الوظيفية فقط) اختبار أشعل النار TEST = test / Functional / search_api_test.rb - آمل أن ينجح!

ولكن يمكنك أيضًا فتح طلب سحب (انظر أدناه) وسيقوم نظام الاختبار الآلي لدينا بتشغيله ، وستتمكن من رؤية الإخراج هناك.

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

خطوات الإصلاح

ادعي هذه المشكلة بتعليق هنا ، أدناه ، واسأل أي أسئلة توضيحية تحتاجها
قم بإعداد مستودع محليًا باتباع إرشادات README ، وتأكد من اجتياز جميع الاختبارات
حاول إصلاح المشكلة باتباع الخطوات المذكورة أعلاه ، ولكن حتى قبل الانتهاء ، يمكنك:
قم بتنفيذ التغييرات وابدأ طلب سحب (انظر المساهمة في برنامج Public Lab) ولكن ضع علامة "قيد التقدم" إذا كانت لديك أسئلة أو إذا لم تكن قد انتهيت
تنبيه شخص ما عبر قائمة المطورين (انظر أدناه) لدمج طلب السحب الخاص بك. قد يستغرق هذا بضع خطوات إضافية اعتمادًا على وقت القيام بذلك ، لكننا سنساعدك!
يرجى إرسال بريد إلكتروني إلى قائمة المطورين (راجع https://publiclab.org/wiki/developers) أو انتقل إلى غرفة الدردشة إذا كانت لديك أسئلة ، وألق نظرة على الصفحة المقصودة لأول مرة للحصول على مزيد من المعلومات!