Šaltinio kodo nuorodų integravimas į JUnit XML Stack Traces

Šaltinio kodo nuorodų pridėjimas JUnit XML ataskaitose

„Java“ naudojimas su „Maven“ projektu ir pasirinktiniu „JUnit“ klausytojo metodu

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;

Paaiškinimas: tinkintų nuorodų integravimas į JUnit XML su Java

Šis pavyzdys modifikuoja JUnit XML išvestį su nuorodomis į GitHub šaltinio kodą, naudojant JUnit klausytojo plėtinį.

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();
        }
    }
}

Alternatyvus sprendimas: naudokite Python JUnit XML analizei ir modifikavimui

Šis metodas apima Python scenarijų, skirtą JUnit XML failams apdoroti, pridedant GitHub nuorodas į krūvos pėdsakus.

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")

Dažniausiai užduodami klausimai apie kamino pėdsakų susiejimą su šaltinio kodu

1. Koks yra geriausias būdas sugeneruoti nuorodas į šaltinio kodą JUnit ataskaitose?
2. Galite naudoti tinkintą „Java“ JUnit klausytoją, kad pridėtumėte spustelėjamų nuorodų, kad galėtumėte kaupti pėdsakus arba apdoroti JUnit XML failus naudodami tokį scenarijų kaip Python. ElementTree.
3. Ar šis metodas gali veikti su bet kokia saugykla, pvz., „GitHub“ ar „GitLab“?
4. Taip, galite pritaikyti pagrindinį URL scenarijuose, kad jis atitiktų konkrečią jūsų naudojamą saugyklą. Pavyzdžiui, pakeiskite https://github.com/your-repo-name/ su savo saugyklos URL.
5. Kaip tvarkote kelių atpirkimo ar monorepo projektus?
6. Naudokite failo kelią kamino takelyje ir pridėkite jį prie atitinkamo saugyklos bazinio URL. Šis metodas užtikrina mastelį dideliems projektams.
7. Ar yra JUnit papildinių, teikiančių šią funkciją?
8. Nors kai kurie įrankiai, pvz., SpecFlow, siūlo panašias funkcijas, JUnit, norint pasiekti šią konkrečią funkciją, paprastai reikalingi pasirinktiniai scenarijai arba trečiųjų šalių sprendimai.
9. Kokios yra geriausios šio proceso optimizavimo praktikos?
10. Įsitikinkite, kad jūsų scenarijai patvirtina įvestį (pvz., failų kelius) ir įtraukė klaidų tvarkymą, kad būtų užtikrintas patikimas veikimas. Modulizuokite kodą, kad jį būtų galima naudoti pakartotinai.

Klaidų sprendimo supaprastinimas naudojant kodo nuorodas

Kamino pėdsakų susiejimas su šaltinio kodu yra veiksmingas būdas optimizuoti derinimo darbo eigą. Automatizuodami šį procesą, kūrėjai įgyja tiesioginę prieigą prie probleminių eilučių savo saugykloje. Šis metodas skatina nuoseklumą ir pagreitina klaidų sprendimą. 🔗

Nesvarbu, ar naudojate pasirinktinius scenarijus ar įrankius, sprendimas yra keičiamo dydžio ir pritaikomas įvairiems projektų tipams. Patobulintų bandymų ataskaitų derinimas su CI / CD vamzdynais užtikrina maksimalų našumą ir sumažina prastovų laiką, todėl šiuolaikinėms programinės įrangos komandoms tai gali pakeisti žaidimą. 🚀