com.seleniumtests.connectors.extools.uftreports.UftReport1 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grid-extensions-selenium4 Show documentation
There is a newer version: 5.1.15
Show newest version
package com.seleniumtests.connectors.extools.uftreports;

import java.io.IOException;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.List;

import org.jdom2.DataConversionException;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.JDOMException;
import org.jdom2.input.SAXBuilder;
import org.jsoup.Jsoup;
import org.testng.Reporter;
import org.xml.sax.InputSource;

import com.seleniumtests.reporter.logger.TestAction;
import com.seleniumtests.reporter.logger.TestStep;

/**
 * Class for analyzing HTML report XML file (run_results.xml) file
 * @author S047432
 *
 */
public class UftReport1 extends IUftReport {
	
	private static final String ATTRIBUTE_TYPE = "type";
	private static final String TAG_DATA = "Data";
	private static final String TAG_DESCRIPTION = "Description";
	private static final String TAG_REPORT_NODE = "ReportNode";

	public UftReport1(String xmlReport, String scriptName) {
		super(xmlReport, scriptName);
	}

	public List readXmlResult() {
        Document document;
        SAXBuilder builder = new SAXBuilder();

        List listStep = new ArrayList<>();

        try {
            String xml = xmlReport.substring(xmlReport.indexOf("<"));
            String xml10pattern = "[^"
                    + "\u0009\r\n"
                    + "\u0020-\uD7FF"
                    + "\uE000-\uFFFD"
                    + "\ud800\udc00-\udbff\udfff"
                    + "]";
            xml = xml.replaceAll(xml10pattern, "");

            document = builder.build(new InputSource(new StringReader(xml))); // we skip BOM by searching the first "<" character
            Element docElement = document.getRootElement().getChild(TAG_REPORT_NODE);
            Element elementToIterate = docElement.getChild(TAG_REPORT_NODE);
            Element iterationChild = elementToIterate.getChild(TAG_REPORT_NODE);

            if (!iterationChild.getChildren(TAG_REPORT_NODE).isEmpty()) {
                elementToIterate = iterationChild;
            }

            for (Element element : elementToIterate.getChildren()) {
                if (TAG_REPORT_NODE.equals(element.getName())) {
                    TestStep readStep = readAction(element);
                    listStep.add(readStep);
                }

            }
        } catch (IndexOutOfBoundsException e) {
            addStepWithoutXml(scriptName, listStep, "Invalid XML data: ", e);
        } catch (JDOMException | IOException e) {
            addStepWithoutXml(scriptName, listStep, "Could not read UFT report: ", e);
        }

        return listStep;
    }
	
	/**
     * Read an action element
     * 
     * // * @param parentStep
     *
     * @param actionElement
     * @throws DataConversionException
     */
    private TestStep readAction(Element actionElement) throws DataConversionException {
        Element data = actionElement.getChild(TAG_DATA);
        
        TestStep actionStep = new TestStep("UFT: " + data.getChild("Name").getValue().trim(), Reporter.getCurrentTestResult(), new ArrayList<>(), false);

        if (data != null && data.getChild("Result").getValue().contains("Failed")) {
            actionStep.setFailed(true);
        }

        for (Element element : actionElement.getChildren()) {
                if (TAG_DATA.equals(element.getName())) { }
                else if (element.getAttributeValue(ATTRIBUTE_TYPE).equals("Action")
                		|| element.getAttributeValue(ATTRIBUTE_TYPE).equals("Context")
                		|| element.getAttributeValue(ATTRIBUTE_TYPE).equals("User")) {
                    TestStep readStep = readAction(element);
                    actionStep.addStep(readStep);
                } else if (element.getAttributeValue(ATTRIBUTE_TYPE).equals("Step")) {
                    TestAction readAction = readStep(element);
                    actionStep.addAction(readAction);
                } 
        }
        return actionStep;
    }

    /**
     * Read a step element
     * 
     * // * @param parentStep
     *
     * @param stepElement
     */
    private TestAction readStep(Element stepElement) {
        String stepDescription = "";

        TestAction stepAction;
        List stepList = stepElement.getChildren(TAG_REPORT_NODE);

        if (stepElement.getChild(TAG_DATA).getChild(TAG_DESCRIPTION) != null) {
            if (!stepElement.getChild(TAG_DATA).getChild(TAG_DESCRIPTION).getContent().isEmpty()) {
                org.jsoup.nodes.Document htmlDoc = Jsoup.parseBodyFragment(stepElement.getChild(TAG_DATA).getChildText(TAG_DESCRIPTION));
                String details = htmlDoc.text();
                stepDescription = String.format("%s: %s", stepElement.getChild(TAG_DATA).getChildText("Name"), details).trim();
            }
        } else {
            stepDescription = String.format(stepElement.getChild(TAG_DATA).getChildText("Name")).trim();
        }

        if (stepList.isEmpty()) {
            stepAction = new TestAction(stepDescription, false, new ArrayList<>());
        } else {
            stepAction = new TestStep(stepDescription, Reporter.getCurrentTestResult(), new ArrayList<>(), false);
            for (Element subStepElement : stepElement.getChildren(TAG_REPORT_NODE)) {
                TestAction readAction = readStep(subStepElement);
                ((TestStep) stepAction).addAction(readAction);
            }
        }
        return stepAction;
    }

	@Override
	public boolean appliesTo() {
		return xmlReport.contains("");
	}

}