royaleunit-ant-tasks/src/main/java/org/apache/royale/test/ant/RoyaleUnitSocketThread.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.royale.test.ant;

import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.concurrent.Callable;

import org.apache.tools.ant.BuildException;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.DocumentHelper;
import org.apache.royale.test.ant.report.Report;
import org.apache.royale.test.ant.report.Suite;

/**
 * Managing class for the RoyaleUnitSocketServer and report aggregation.
 */
public class RoyaleUnitSocketThread implements Callable<Object>
{
    // Messages from CIListener
    private static final String END_OF_SUCCESS = "status=\"success\" />";
    private static final String END_OF_FAILURE = "</testcase>";
    private static final String END_OF_IGNORE = "<skipped /></testcase>";
    private static final String END_OF_TEST_RUN = "<endOfTestRun/>";

    // XML attribute labels
    private static final String SUITE_ATTRIBUTE = "classname";

    private File reportDir;

    private IRoyaleUnitServer server;
    private Map<String, Report> reports;

    public RoyaleUnitSocketThread(IRoyaleUnitServer server, File reportDir, Map<String, Report> reports)
    {
        this.server = server;
        this.reportDir = reportDir;
        this.reports = reports;
    }

    /**
     * When excuted, the thread will start the socket server and wait for inbound data and delegate reporting
     */
    //TODO: Clean up exception handling
    public Object call() throws Exception
    {
        try
        {
            server.start();
            parseInboundMessages();
        }
        catch (IOException e)
        {
            throw new BuildException("error receiving report from royaleunit", e);
        }
        finally
        {
            try
            {
                server.stop();
            }
            catch (IOException e)
            {
                throw new BuildException("could not close client/server socket");
            }
        }

        //All done, let the process that spawned me know I've returned.
        return null;
    }

    /**
     * Used to iterate and interpret byte sent over the socket.
     */
    private void parseInboundMessages() throws IOException
    {
        while (true)
        {
            if (server.isPending())
            {
                //try again later
                try
                {
                    Thread.sleep(100);
                }
                catch(Exception e) {}
                continue;
            }

            if (server.getException() != null)
            {
                throw new BuildException(server.getException());
            }

            String request = server.readNextTokenFromSocket();
            if (request == null)
            {
                break;
            }
            else if (request.equals(END_OF_TEST_RUN))
            {
                // The client has declared that the test run is complete
                break;
            }
            else if (request.endsWith(END_OF_FAILURE) || request.endsWith(END_OF_SUCCESS) || request.endsWith(END_OF_IGNORE))
            {
                // Process all other known requests
                processTestReport(request);
            }
            else
            {
                throw new BuildException("command [" + request + "] not understood");
            }
        }
    }

    /**
     * Process the test report.
     * 
     * @param report
     *           String that represents a complete test
     */
    private void processTestReport(String xml)
    {
        // Convert the string report into an XML document
        Document test = parseReport(xml);

        // Find the name of the suite
        String suiteName = test.getRootElement().attributeValue(SUITE_ATTRIBUTE);

        // Convert all instances of :: for file support
        suiteName = suiteName.replaceAll("::", ".");

        if (!reports.containsKey(suiteName))
        {
            reports.put(suiteName, new Report(new Suite(suiteName)));
        }

        // Fetch report, add test, and write to disk
        Report report = reports.get(suiteName);
        report.addTest(test);

        report.save(reportDir);
    }

    /**
     * Parse the parameter String and returns it as a document
     * 
     * @param report
     *           String
     * @return Document
     */
    private Document parseReport(String report)
    {
        try
        {
            final Document document = DocumentHelper.parseText(report);

            return document;
        }
        catch (DocumentException e)
        {
            LoggingUtil.log(report);
            throw new BuildException("Error parsing report.", e);
        }
    }
}