com.hp.application.automation.tools.octane.tests.xml.TestResultXmlWriter.java Source code

Introduction

Here is the source code for com.hp.application.automation.tools.octane.tests.xml.TestResultXmlWriter.java

Source

/*
 *     Copyright 2017 Hewlett-Packard Development Company, L.P.
 *     Licensed under the Apache License, Version 2.0 (the "License");
 *     you may not use this file except in compliance with the License.
 *     You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *     Unless required by applicable law or agreed to in writing, software
 *     distributed under the License is distributed on an "AS IS" BASIS,
 *     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *     See the License for the specific language governing permissions and
 *     limitations under the License.
 *
 */

package com.hp.application.automation.tools.octane.tests.xml;

import com.hp.application.automation.tools.octane.configuration.ConfigurationService;
import com.hp.application.automation.tools.octane.tests.TestResultContainer;
import com.hp.application.automation.tools.octane.tests.build.BuildDescriptor;
import com.hp.application.automation.tools.octane.tests.build.BuildHandlerUtils;
import com.hp.application.automation.tools.octane.tests.detection.ResultFields;
import com.hp.application.automation.tools.octane.tests.testResult.TestResult;
import hudson.FilePath;
import hudson.model.Run;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;

import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Iterator;

@SuppressWarnings("all")
public class TestResultXmlWriter {

    private FilePath targetPath;
    //private Run build;
    private BuildDescriptor buildDescriptor;

    private XMLStreamWriter writer;
    private OutputStream outputStream;

    public TestResultXmlWriter(FilePath targetPath, BuildDescriptor buildDescriptor) {
        this.targetPath = targetPath;
        this.buildDescriptor = buildDescriptor;
    }

    public TestResultXmlWriter(FilePath targetPath, Run build) {
        this.targetPath = targetPath;
        //this.build = build;
        this.buildDescriptor = BuildHandlerUtils.getBuildType(build);
    }

    public void writeResults(TestResultContainer testResultContainer)
            throws InterruptedException, XMLStreamException, IOException {
        if (testResultContainer != null) {
            ResultFields resultFields = testResultContainer.getResultFields();
            initialize(resultFields);

            Iterator<TestResult> testResults = testResultContainer.getIterator();
            while (testResults.hasNext()) {
                TestResult testResult = testResults.next();
                testResult.writeXmlElement(writer);
            }
        }
    }

    public void close() throws XMLStreamException {
        if (outputStream != null) {
            writer.writeEndElement(); // test_runs
            writer.writeEndElement(); // test_result
            writer.writeEndDocument();
            writer.close();
            IOUtils.closeQuietly(outputStream);
        }
    }

    private void initialize(ResultFields resultFields)
            throws IOException, InterruptedException, XMLStreamException {
        if (outputStream == null) {
            outputStream = targetPath.write();
            writer = possiblyCreateIndentingWriter(
                    XMLOutputFactory.newInstance().createXMLStreamWriter(outputStream));
            writer.writeStartDocument();

            writer.writeStartElement("test_result");
            writer.writeStartElement("build");
            writer.writeAttribute("server_id", ConfigurationService.getModel().getIdentity());
            BuildDescriptor descriptor = this.buildDescriptor;
            writer.writeAttribute("job_id", descriptor.getJobId());
            writer.writeAttribute("job_name", descriptor.getJobName());
            writer.writeAttribute("build_id", descriptor.getBuildId());
            writer.writeAttribute("build_name", descriptor.getBuildName());
            if (!StringUtils.isEmpty(descriptor.getSubType())) {
                writer.writeAttribute("sub_type", descriptor.getSubType());
            }
            writer.writeEndElement(); // build
            writeFields(resultFields);
            writer.writeStartElement("test_runs");
        }
    }

    private void writeFields(ResultFields resultFields) throws XMLStreamException {
        if (resultFields != null) {
            writer.writeStartElement("test_fields");
            writeField("Framework", resultFields.getFramework());
            writeField("Test_Level", resultFields.getTestLevel());
            writeField("Testing_Tool_Type", resultFields.getTestingTool());
            writer.writeEndElement();
        }
    }

    private void writeField(String type, String value) throws XMLStreamException {
        if (value != null) {
            writer.writeStartElement("test_field");
            writer.writeAttribute("type", type);
            writer.writeAttribute("value", value);
            writer.writeEndElement();
        }
    }

    // TODO: check if there is public mechanism yet
    private XMLStreamWriter possiblyCreateIndentingWriter(XMLStreamWriter writer) {
        try {
            Class<?> clazz = Class.forName("com.sun.xml.txw2.output.IndentingXMLStreamWriter");
            XMLStreamWriter xmlStreamWriter = (XMLStreamWriter) clazz.getConstructor(XMLStreamWriter.class)
                    .newInstance(writer);
            clazz.getMethod("setIndentStep", String.class).invoke(xmlStreamWriter, " ");
            return xmlStreamWriter;
        } catch (Exception e) {
            // do without indentation
            return writer;
        }
    }
}