دمج روابط كود المصدر في JUnit XML Stack Traces

إضافة روابط التعليمات البرمجية المصدر في تقارير JUnit XML

استخدام Java مع مشروع Maven ونهج مستمع JUnit المخصص

import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.TestExecutionExceptionHandler;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;

شرح: دمج الروابط المخصصة في JUnit XML مع Java

يعدل هذا المثال مخرجات JUnit XML بروابط إلى كود مصدر GitHub، باستخدام ملحق مستمع JUnit.

public class CustomJUnitListener implements TestExecutionExceptionHandler {
    private static final String BASE_URL = "https://github.com/your-repo-name/";
    private static final String SOURCE_FOLDER = "src/main/java/";

    @Override
    public void handleTestExecutionException(ExtensionContext context, Throwable throwable) {
        try {
            String className = context.getTestClass().orElseThrow().getName();
            int lineNumber = extractLineNumber(throwable);
            String url = BASE_URL + SOURCE_FOLDER + className.replace(".", "/") + ".java#L" + lineNumber;
            addLinkToXml(context.getDisplayName(), throwable.getMessage(), url);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private int extractLineNumber(Throwable throwable) {
        return throwable.getStackTrace()[0].getLineNumber();
    }

    private void addLinkToXml(String testName, String message, String url) {
        try {
            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
            DocumentBuilder builder = factory.newDocumentBuilder();
            Document document = builder.newDocument();

            Element root = document.createElement("testcase");
            root.setAttribute("name", testName);
            root.setAttribute("message", message);
            root.setAttribute("link", url);
            document.appendChild(root);

            TransformerFactory transformerFactory = TransformerFactory.newInstance();
            Transformer transformer = transformerFactory.newTransformer();
            DOMSource source = new DOMSource(document);
            StreamResult result = new StreamResult("junit-report.xml");
            transformer.transform(source, result);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

الحل البديل: استخدام Python لتحليل وتعديل JUnit XML

يتضمن هذا الأسلوب برنامج نصي بلغة Python لمعالجة ملفات JUnit XML بعد المعالجة، وإضافة روابط GitHub لتتبعات المكدس.

import xml.etree.ElementTree as ET

BASE_URL = "https://github.com/your-repo-name/"
SOURCE_FOLDER = "src/main/java/"

def add_links_to_xml(file_path):
    tree = ET.parse(file_path)
    root = tree.getroot()

    for testcase in root.findall(".//testcase"):  # Loop through test cases
        error = testcase.find("failure")
        if error is not None:
            message = error.text
            class_name = testcase.get("classname").replace(".", "/")
            line_number = extract_line_number(message)
            link = f"{BASE_URL}{SOURCE_FOLDER}{class_name}.java#L{line_number}"
            error.set("link", link)

    tree.write(file_path)

def extract_line_number(stack_trace):
    try:
        return int(stack_trace.split(":")[-1])
    except ValueError:
        return 0

add_links_to_xml("junit-report.xml")

أسئلة شائعة حول ربط تتبعات المكدس بكود المصدر

1. ما هي أفضل طريقة لإنشاء روابط لكود المصدر في تقارير JUnit؟
2. يمكنك استخدام مستمع JUnit مخصص في Java لإضافة روابط قابلة للنقر لتكديس التتبعات، أو ملفات JUnit XML بعد المعالجة باستخدام برنامج نصي مثل Python ElementTree.
3. هل يمكن لهذه الطريقة أن تعمل مع أي مستودع، مثل GitHub أو GitLab؟
4. نعم، يمكنك تعديل عنوان URL الأساسي في البرامج النصية ليتوافق مع المستودع المحدد الذي تستخدمه. على سبيل المثال، استبدال https://github.com/your-repo-name/ باستخدام عنوان URL الخاص بالمستودع الخاص بك.
5. كيف تتعامل مع مشاريع الريبو المتعددة أو المونوريبو؟
6. استخدم مسار الملف في تتبع المكدس وألحقه بعنوان URL الأساسي للمستودع المناسب. تضمن هذه الطريقة قابلية التوسع للمشاريع الكبيرة.
7. هل توجد مكونات إضافية موجودة لـ JUnit توفر هذه الوظيفة؟
8. في حين أن بعض الأدوات مثل SpecFlow تقدم ميزات مشابهة، بالنسبة لـ JUnit، عادةً ما تكون البرمجة النصية المخصصة أو حلول الجهات الخارجية مطلوبة لتحقيق هذه الوظيفة المحددة.
9. ما هي أفضل الممارسات لتحسين هذه العملية؟
10. تأكد من أن البرامج النصية الخاصة بك تتحقق من صحة الإدخال (على سبيل المثال، مسارات الملفات) وتتضمن معالجة الأخطاء لتحقيق أداء قوي. قم بتكوين التعليمات البرمجية الخاصة بك لإعادة الاستخدام.

تبسيط عملية حل الأخطاء باستخدام روابط التعليمات البرمجية

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

سواء كنت تستخدم برامج نصية أو أدوات مخصصة، فإن الحل قابل للتطوير وقابل للتكيف مع أنواع المشاريع المختلفة. يضمن الجمع بين تقارير الاختبار الغنية وخطوط أنابيب CI/CD أقصى قدر من الإنتاجية ويقلل وقت التوقف عن العمل، مما يجعله يغير قواعد اللعبة بالنسبة لفرق البرامج الحديثة. 🚀