warnings ng plugin devenv

بيئة التنمية لمكونات جنكينز

بيئة التطوير القائمة على Docker مخصصة للمساهمين الجدد في تحذيرات Jenkins والمكونات الإضافية للتغطية لتقليل وقت الطبعة الأولية. يتكون من الأجزاء التالية:

• البرامج النصية للتحقق من جميع وحدات الإضافات Jenkins هذه من Github. اعتمادًا على الجزء الذي تريد المساهمة فيه ، عادةً ما تعمل مع واحدة فقط من هذه الوحدات النمطية. ومع ذلك ، فإنه يبسط التطور إذا كانت جميع الوحدات بالفعل جزءًا من مساحة العمل. ثم يمكنك التبديل في أي وقت إلى إحدى الوحدات الأخرى.
• وحدة تحكم Jenkins المستندة إلى Docker والتي لديها جميع الإضافات المطلوبة مثبتة لمشاهدة هذه الإضافات قيد التنفيذ. تم تكوين وحدة تحكم Jenkins هذه بالفعل بشكل صحيح باستخدام JCASC لإنشاء وحدات Java على وكيل قائم على Linux (يتم توفيره أيضًا كحاوية Docker). إنه يحتوي بالفعل على بعض الوظائف التي تستخدم كل هذه المكونات الإضافية (الاختبارات ، التغطية ، التحليل الثابت).
• مشروع Intellij الذي يقوم بتكوين هذه المكونات الإضافية كوحدات Maven. يحتوي هذا المشروع على إعدادات مسبقة لأسلوب الترميز الخاص بي وبعض التكوينات المفيدة الأخرى. على وجه الخصوص ، تم تكوين المتسابقين لتصحيح الإضافات Jenkins إما على وحدة التحكم أو الوكيل.

قدمت هذه البيئة التنموية في لقاء Jenkins عبر الإنترنت المسجل في يناير 2022.

أنظمة التشغيل المدعومة

تم اختبار بيئة التطوير على MacOS و Ubuntu Linux (في جهاز افتراضي يعمل على MacOS) و Windows. طلبات السحب دائما موضع ترحيب.

TLDR

متطلبات التثبيت

التنمية الرئيسية

أحدث إصدار من الأدوات التالية:

• Docker (لنظام التشغيل Windows و MacOS: تثبيت سطح مكتب Docker)
• Intellij Ultimate (أو المجتمع)
• مافن
• JDK 21
• غيت

اختبار واجهة المستخدم

بالإضافة إلى ذلك ، هناك حاجة إلى أحدث الإصدارات من الأدوات التالية:

• Firefox و Gecko-Driver
• كروم وكروم سائق

خطوات التثبيت

في حالة حدوث أخطاء ، لاحظ تلميحات استكشاف الأخطاء وإصلاحها أدناه. بالنسبة لمستخدمي Windows: استخدم Git Bash لتنفيذ البرامج النصية Shell.

1. استنساخ وإنشاء وحدات ./bin/clone-repos.sh المساعد باستخدام البرنامج ./bin/clone-repos-https.sh . يجب أن تنتظر حتى ينجح البناء قبل فتح Intellij ، وإلا فلن يجد Intellij جميع الفصول التي تم إنشاؤها. يحتاج مستخدمو Maven لأول مرة إلى الانتظار بضع دقائق حتى يتم تنزيل جميع التبعيات من Maven Central.
2. استيراد المشروع إلى intellij:
   1. بدء intellij
   2. حدد فتح ...
   3. حدد warnings-ng-plugin-devenv
   4. اختياري (فقط عندما يسأل Intellij): يجب استيراد مشاريع Maven تحديد تمكين الاستيراد التلقائي .
   5. اختياري (فقط عندما يسأل Intellij): Trust and Open Maven Project Project Trust Project (راجع مساعدة Intellij عبر الإنترنت)
3. قم بتشغيل قاذفات الاختبار في Intellij لمشاريع نموذج التحليل ونماذج التغطية.
4. لمستخدمي Windows: ابدأ سطح مكتب Docker إذا لم يتم ذلك بالفعل
5. بدء Jenkins مع ./bin/jenkins.sh . يقوم هذا الأمر بإنشاء صورة Jenkins Docker ، ويقوم بتنزيل جميع الإضافات المسجلة وتهيئة مساحة عمل Jenkins مع بعض الوظائف. هذا يتطلب بعض الدقائق كذلك (انظر الخطوة 9).
6. تسجيل الدخول إلى Jenkins على: http: // localhost: 8080/
7. استخدم بيانات الاعتماد التالية:
   • المستخدم: المسؤول
   • كلمة المرور: المسؤول
8. ابدأ وظائف Jenkins المقدمة التي تظهر الإضافات في العمل:
   • طراز التحليل الحر : وظيفة Jenkins Freestyle التي تبني مكتبة نموذج التحليل. هذه المجموعات الوظيفية جميع التحذيرات في تقرير Jenkins واحد ، بالإضافة إلى ذلك توضح نتائج تغطية الكود لجاكوكو.
   • خطوط الأنابيب-خطوط الأنابيب : خط أنابيب جنكينز النص الذي يبني مكتبة CodingStyle. تُظهر هذه الوظيفة نتائج فردية لتحذيرات التحذيرات المختلفة. بالإضافة إلى ذلك ، تعرض هذه المهمة تفاصيل تغطية رمز Jacoco وتغطية طفرة الحفرة.
   • طراز التاريخ-النموذج : خط أنابيب جنكينز النص الذي يبني جميع الإصدارات الحالية لمشروع نموذج التغطية. ستستغرق التصميم بعض الوقت ولكنها تظهر كيف تعمل مخططات الاتجاه وكيف يتم إجراء حسابات دلتا. تنتج الوظيفة نتائج لجميع أدوات التحليل الثابت ، وتغطية رمز Jacoco ، وتغطية طفرة الحفرة.
9. نشر الرأس الحالي للمكونات الإضافية على مثيل Jenkins باستخدام قاذفات في Intellij.

التثبيت - استكشاف الأخطاء وإصلاحها

الخطوة 1 - فشل التثبيت

إذا نجحت جميع التنزيلات ، لكن التثبيت فشل بسبب الأخطاء ، ثم إصلاحها وتنفيذ mvn -V -U -e install –DskipTests لإعادة إعادة التثبيت فقط.

الخطوة 3 - "سطر الأوامر طويل جدًا."

إذا كان الخطأ "سطر الأوامر طويلًا جدًا." يحدث ، تنفيذ الخطوات التالية:

1. انقر فوق تحرير التكوين وحدد تكوين التشغيل الفاشل (أو انقر فوق اسم قاذفة الاختبار ضمن رسالة الخطأ)
2. انقر فوق بناء وتشغيل > تعديل الخيارات > تقصير سطر الأوامر
3. ضمن سطر الأوامر القصير الحقل ، حدد @argfile (Java9+)
4. انقر فوق تطبيق وموافق وتنفيذ قاذفة الاختبار مرة أخرى
5. (ربما ، يجب إعادة تشغيل Intellij إذا لم يتم العثور على اختبارات)

الخطوة 3 - مهلة اختبار جنكينز

إذا فشلت الاختبارات بسبب مهلة اختبار Jenkins ، قم بتنفيذ الخطوات التالية:

1. انقر فوق تحرير التكوين وحدد تكوين التشغيل الفاشل
2. أضف إلى خيارات VM : -Djenkins.test.timeout=1000 . هذا يزيد من حد المهلة إلى 1000 ثانية.

استنساخ الوحدات النمطية

يمكنك استخدام برنامج نصي shell بسيط ( ./bin/clone-repos.sh ) لاستنساخ وبناء الوحدات النمطية في خطوة واحدة. يقوم البرنامج النصي بالتحقق من الوحدات النمطية التالية باستخدام بروتوكول GIT SSH. هذا يتطلب أن تكون قد قمت بتسجيل مفتاحك العام في GitHub. إذا لم يكن لديك مفاتيح في GitHub ، فيمكنك بدلاً من ذلك استخدام البرنامج النصي ./bin/clone-repos-https.sh الذي يستخدم بروتوكول HTTPS.

• CodingStyle: CodingStyle الخاص بي مع القواعد المسبقة لـ CheckStyle و PMD و Spotbugs. يمكن ربط هذه التكوينات في Intellij لضمان أن الرمز متوافق مع القواعد.
• نموذج التحليل: مكتبة لقراءة تقارير التحليل الثابت في نموذج كائن Java. هذه الوحدة لا تعتمد على جنكينز.
• التحليل-النموذج-api-plugin: غلاف بسيط لمكتبة نموذج التحليل. ويوفر فئات نموذج التحليل كمكون إضافي Jenkins. هذا النفقات العامة مطلوبة لتبسيط ترقيات وحدة التحليل في جنكينز.
• التحذيرات-NG-Plugin: مكون إضافي لقراءة تقارير التحليل الثابت وإظهار النتائج المقابلة في جنكينز.
• نموذج التغطية: مكتبة لقراءة تقارير التغطية في نموذج كائن Java. هذه الوحدة لا تعتمد على جنكينز.
• التغطية-بلوجين: مكون إضافي لقراءة تقارير التغطية وإظهار النتائج المقابلة في جنكينز.

زبدة بعض الوحدات النمطية

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

تعديل وتصحيح رمز مع intellij

Intellij (Ultimate) هي بيئة التطوير الرئيسية المدعومة للمكون من تحذيرات. يتم تخزين مشروع محدد مسبقًا في المجلد .idea الذي يشير إلى جميع وحدات البرنامج المساعد تحذير. يحتوي هذا المشروع على إعدادات مسبقة لأسلوب الترميز الخاص بي وبعض التكوينات المفيدة الأخرى.

يجب أن يكون من الممكن استخدام IDEs الأخرى (Eclipse و NetBeans و Visual Studio Code) أيضًا.

اختبارات الوحدة والتكامل

استخدم تكوينات تشغيل intellij المقدمة All in [module-name] لتشغيل الوحدة واختبارات التكامل للوحدة المقابلة. تم تكوين هذه التكوينات بالفعل لتسجيل التغطية الفرعية لحزم الوحدة النمطية المقابلة (استخدم Run with Coverage ).

تصحيح الأخطاء

قبل أن تتمكن من تصحيح التغييرات الخاصة بك ، تحتاج أولاً إلى معرفة مكان تشغيل الكود الخاص بك: على وحدة التحكم أو على الوكيل؟ إذا لم تكن متأكدًا ، فقم بتشغيل كل من Defuggers عن بُعد ، وقم بتعيين بعض نقاط التوقف وانتظر إيقاف تصحيح الأخطاء المقابل.

تصحيح مراقب جينكينز

يبدأ تكوين Docker Compose وحدة تحكم Jenkins تلقائيًا في وضع "Debug" ، أي أنه يستمع إلى طلبات التصحيح عن بُعد. إذا تم تشغيل الكود الخاص بك في وحدة التحكم ، فأنت بحاجة إلى إرفاق مصحح أخطاء عن بُعد في localhost:8000 (تم تعيينه إلى نفس المنفذ في حاوية Docker). استخدم تكوين DEBUG Jenkins Controller (Remote Debugger) لتوصيل مصحح أخطاء في Intellij.

تصحيح أخطاء وكيل جنكينز

يبدأ تكوين Docker Compose أيضًا وكيل Jenkins تلقائيًا في وضع "Debug" ، أي أنه يستمع إلى طلبات التصحيح عن بُعد. قم بإرفاق مصحح أخطاء عن بُعد في localhost:8001 (تم تعيينه بنفس المنفذ في حاوية Docker) لتصحيح رمز التصحيح الذي يتم تشغيله على الوكيل. استخدم تكوين DEBUG CONFICER Jenkins Agent (Remote Debugger) لتوصيل مصحح أخطاء في Intellij.

تشغيل اختبارات واجهة المستخدم

يمكن بدء اختبارات واجهة المستخدم باستخدام UI Tests [module] (Firefox) أو UI Tests [module] (Chrome) . لاحظ أن كلا القاذفين يتطلبان تثبيت برامج تشغيل السيلينيوم المقابلة. إذا لم يتم تثبيت برامج التشغيل هذه في /opt/bin على جهازك المحلي ، فأنت بحاجة إلى تكييف تكوينات المشغل لمطابقة الإعداد الخاص بك.

تتطلب جميع اختبارات واجهة المستخدم التشغيل ضمن موضوع معين ضمن اختبار (IE ، Jenkins قيد الاختبار ، JUT) ، راجع مشروع Harness Test Test لمزيد من التفاصيل.

بدء جنكينز

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

ابدأ وحدة تحكم Jenkins المقدمة في هذا المشروع (تحتاج إلى تثبيت Docker و Docker-Corm). افتح محطة وقم بتشغيل ./jenkins.sh في مجلد المستوى العلوي. هذا الأمر عبارة عن غلاف docker-compose up : يستخدم إعدادات المستخدم والمجموعة المناسبة بحيث يتم تعيين أذونات حجم Docker لمجلد Jenkins Home بشكل صحيح. ينشئ هذا الأمر حاوية Docker لوحدة التحكم Jenkins وواحدة لوكيل Java. سيتطلب ذلك بعض الوقت عند الاتصال بالمرة الأولى منذ أن تتألف صور Docker. بعد إنشاء الصور ، سيتم البدء في الحاوين التاليين:

• جينكينز-السيطرة: صورة Jenkins الرسمية LTS Docker Image (Alpine Linux). يتم تكوين وحدة التحكم مسبقًا باستخدام JCASC لإنشاء تطبيقات Java على الوكيل. لا يُسمح للمراقب بتشغيل الوظائف.
• Java-Agent: Ament A Java الحد الأدنى استنادًا إلى صورة OpenJDK8 Docker الرسمية (Alpine Linux). يتم توصيل وحدة التحكم والوكيل باستخدام SSH.

يمكنك بعد ذلك فتح Jenkins في عنوان URL http: // localhost: 8080/. استخدم بيانات الاعتماد التالية لتسجيل الدخول كمسؤول:

• المستخدم: المسؤول
• كلمة المرور: المسؤول

حجم Jenkins_Home

يتم تثبيت الدليل الرئيسي لوحدة تحكم Jenkins (Jenkins_Home) كمجمع Docker. أي أنه مرئي على المضيف كدليل عادي على ./docker/volumes/jenkins-controller . سوف تنجو من الجلسات ويمكن تغييرها مباشرة على المضيف ، راجع الوثائق الرسمية للحصول على التفاصيل. هذا يساعد على فحص الملفات التي تم إنشاؤها بواسطة وحدة تحكم Jenkins.

نظرًا لمشكلة الأداء في البرنامج المساعد Jenkins 'Job DSL ، فإن إعداد مثيل Jenkins الجديد بطيء للغاية. لذلك ، من المنطقي إزالة جزء تكوين المهمة من ملف jenkins.yaml بعد إنشاء الوظائف. يمكنك jenkins-no-jobs.yaml محتوى الملف ./docker/volumes/jenkins-home/jenkins.yaml

المجلدات تحت ماكوس بطيئة جدا. على جهاز MacBook الذي يدير وظيفة Jenkins المقدمة في analysis-model في حاوية Docker أبطأ من تشغيل وظيفة Jenkins نفسها في حاوية Docker التي تعمل في جهاز Virtual Linux على نفس جهاز MacBook (يبدو نوعًا من السخيف؟).

نشر الإضافات التي تم تغييرها إلى جنكينز

بمجرد الانتهاء من تغييرات التطوير المحلية الخاصة بك (أي اختبارات الوحدة كلها خضراء) ، يجب عليك اختبار التغييرات الخاصة بك في Jenkins. يساعد هذا أيضًا في إعداد اختبار التكامل أو اختبار واجهة المستخدم لتغييرك.

تغيير نموذج التحليل دون إضافة أساليب API جديدة

إذا كان لديك تغييرات فقط في وحدة analysis-model (ولم تضيف أي طرق API جديدة) ، فأنت بحاجة إلى إعادة بناء وتثبيت Maven Module analysis-model.jar وبعد ذلك إعادة بناء برنامج Jenkins Wrapper Plugin analysis-model-api-plugin . ثم يحتاج هذا البرنامج المساعد إلى نشره على جنكينز.

تم analysis-model.jar هذه العملية عن طريق تشغيل analysis-model النصي ./bin/go.sh ثم سيقوم هذا البرنامج النصي ببناء المكون الإضافي الفعلي ونشره على Jenkins.

تغيير البرنامج المساعد التحذير

إذا كان لديك تغييرات فقط في البرنامج المساعد تحذير NG ، فأنت بحاجة إلى إعادة بناء warnings-ng.jpi ونشرها على Jenkins. يمكنك استخدام واحدة من البرامج النصية Shell التالية لهذه المهمة:

• ./bin/clean.sh : يبني المكون الإضافي باستخدام mvn clean install ونشره على النجاح في مثيل Jenkins.
• ./bin/go.sh : يبني المكون الإضافي باستخدام mvn clean install -DskipITs (يتخطى اختبارات التكامل) ونشره على النجاح في Jenkins Instace.
• ./bin/skip.sh : يبني المكون الإضافي باستخدام mvn clean install -DskipTests (يتخطى جميع الاختبارات والتحليل الثابت) ونشره على النجاح في مثيل Jenkins.

تغيير نموذج التحليل عن طريق إضافة طرق API جديدة

تودو

تغيير الطب الشرعي-api-plugin و git-forensics-plugin

إذا كان لديك تغييرات في أحد الإضافات Foresics (API أو تنفيذ GIT) ، فأنت بحاجة إلى إعادة بناء هذه الإضافات Jenkins ونشرها في مثيل Jenkins.

لتبسيط هذه العملية ، قم بتشغيل البرنامج ./go.sh .

تغيير الوحدة النمطية مع كسر API

قبل إجراء تغييرات خالية ، يرجى الاتصال بي. عادة ، من الممكن إجراء تغييرات متوافقة للخلف.

قاذفات Intellij لنشر المكونات الإضافية

يمكن أيضًا بدء تشغيل البرامج النصية للبناء من القسم الأخير باستخدام أحد قاذفات Intellij Build and Deploy [module-name] . تقوم هذه القاذفات ببناء المكون الإضافي المقابل ونشره في Jenkins.

تسخير اختبار القبول

يمكن بدء اختبارات واجهة المستخدم باستخدام تكوين Launcher Intellij أو باستخدام برنامج نصي لسطر الأوامر. كما ذكرنا سابقًا ، تتطلب جميع اختبارات واجهة المستخدم الركض ضمن موضوع معين قيد الاختبار. في حالتنا ، نستخدم أحدث إصدار من Jenkins LTS ومجموعة من الإضافات المحددة مسبقًا من صورة Docker الخاصة بنا.

تشغيل اختبارات واجهة المستخدم في Intellij

يمكن بدء اختبارات واجهة المستخدم باستخدام UI Tests Warnings (Firefox) أو UI Warnings Tests (Chrome) . لاحظ أن كلا القاذفين يتطلبان تثبيت برامج تشغيل السيلينيوم المقابلة. إذا لم يتم تثبيت برامج التشغيل هذه في /opt/bin على جهازك المحلي ، فأنت بحاجة إلى تكييف تكوينات المشغل لمطابقة الإعداد الخاص بك.

تشغيل اختبارات واجهة المستخدم من وحدة التحكم

يمكنك أيضًا بدء اختبارات واجهة المستخدم باستخدام SHELL SHELL testFirefox.sh أو testChrome.sh . لاحظ أنك قد تحتاج إلى تكييف هذه البرامج النصية أيضًا (انظر القسم السابق).