إنشاء تقارير تغطية كود دول مجلس التعاون الخليجي
الموقع والوثائق • bugtracker • جيثب
يوفر Gcovr أداة مساعدة لإدارة استخدام الأداة المساعدة GNU gcov وإنشاء نتائج تغطية التعليمات البرمجية المختصرة. هذا الأمر مستوحى من حزمة Python Cover.py، التي توفر أداة مساعدة مماثلة لـ Python.
يمكن للأمر gcovr
إنتاج أنواع مختلفة من تقارير التغطية:
خيار سطر الأوامر | دليل المستخدم | وصف |
---|---|---|
الافتراضي، --txt | إخراج النص | ملخصات مدمجة يمكن قراءتها بواسطة الإنسان |
--html | إخراج HTML | نظرة عامة على جميع الملفات |
--html-details | إخراج HTML | ملفات المصدر المشروحة |
--html-template-dir | إخراج HTML | استخدم مجموعة مخصصة من قوالب Jinja2 |
--csv | إخراج CSV | تقرير CSV يلخص تغطية كل ملف |
--json | إخراج جسون | تقرير JSON مع بنية الملف المصدر وتغطيته |
--json-summary | إخراج جسون | تقرير تغطية ملخص JSON |
--clover | البرسيم إخراج XML | تقارير XML قابلة للقراءة آليًا بتنسيق Clover |
--cobertura | مخرجات Cobertura XML | تقارير XML قابلة للقراءة آليًا بتنسيق Cobertura |
--coveralls | المآزر إخراج JSON | تقرير JSON مقروء آليًا بتنسيق Coveralls |
--jacoco | إخراج JaCoCo XML | تقارير XML قابلة للقراءة آليًا بتنسيق JaCoCo |
--lcov | إخراج معلومات LCOV | تقرير يمكن قراءته آليًا بتنسيق معلومات LCOV |
--sonarqube | إخراج SonarQube XML | تقارير XML قابلة للقراءة آليًا بتنسيق SonarQube |
وبالتالي، يمكن النظر إلى gcovr كبديل لسطر الأوامر للأداة المساعدة lcov، التي تقوم بتشغيل gcov وإنشاء تقرير بتنسيق HTML. كان الدافع وراء تطوير gcovr هو الحاجة إلى ملخصات نصية وتقارير XML.
مثال لملخص HTML:
مثال على تفاصيل HTML:
يتوفر Gcovr كحزمة Python التي يمكن تثبيتها عبر النقطة.
قم بتثبيت أحدث إصدار ثابت gcovr
من PyPI:
pip install gcovr
تثبيت إصدار التطوير من GitHub (يحتاج إلى الإصدار 21.3 من النقطة على الأقل):
pip install git+https://github.com/gcovr/gcovr.git
يمكن لدول مجلس التعاون الخليجي أن تقوم بتجهيز الملفات التنفيذية لإصدار بيانات التغطية. تحتاج إلى إعادة ترجمة التعليمات البرمجية الخاصة بك باستخدام العلامات التالية:
--التغطية -g -O0
بعد ذلك، قم بتشغيل مجموعة الاختبار الخاصة بك. سيؤدي هذا إلى إنشاء ملفات التغطية الأولية.
وأخيرا، استدعاء gcovr. سيؤدي هذا إلى طباعة تقرير جدولي على وحدة التحكم.
com.gcovr
يمكنك أيضًا إنشاء تقارير HTML مفصلة أو متداخلة:
gcovr --html-تفاصيل التغطية.html gcovr --html-تغطية متداخلة.html
سيقوم Gcovr بإنشاء تقرير HTML واحد لكل ملف مصدر ولـ --html-nested
أيضًا لكل دليل بجوار ملخص Cover.html.
يجب عليك تشغيل gcovr من دليل البناء. يجب أن يشير الخيار -r
إلى جذر مشروعك. هذا مهم فقط إذا كان لديك دليل بناء منفصل. على سبيل المثال:
بناء القرص المضغوط؛ جيكوفر -r ..
للحصول على التوثيق الكامل، اقرأ الدليل.
إذا كنت تريد الإبلاغ عن خطأ ما أو المساهمة في تطوير gcovr، يرجى قراءة إرشادات المساهمة أولاً: https://gcovr.com/en/latest/contributing.html
يتم توزيع هذا البرنامج بموجب ترخيص BSD المكون من 3 فقرات. راجع https://gcovr.com/en/latest/license.html#license-terms للحصول على التفاصيل. راجع https://gcovr.com/en/latest/license.html#acknowledgements للحصول على القائمة الكاملة للمساهمين.