/*

  * Copyright 1999-2001,2004 The Apache Software Foundation.

  * 

  * 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 org.apache.commons.latka;

 // java imports

 import java.io.IOException;

 import java.io.PrintWriter;

 import java.io.StringWriter;

 // latka imports

 import org.apache.commons.latka.event.LatkaEventListener;

 import org.apache.commons.latka.event.ReportMessageEvent;

 import org.apache.commons.latka.event.RequestErrorEvent;

 import org.apache.commons.latka.event.RequestEvent;

 import org.apache.commons.latka.event.RequestFailedEvent;

 import org.apache.commons.latka.event.SuiteEvent;

 import org.apache.commons.latka.http.Request;

 // dom4j imports

 import org.dom4j.Document;

 import org.dom4j.DocumentFactory;

 import org.dom4j.Element;

 import org.dom4j.io.OutputFormat;

 import org.dom4j.io.XMLWriter;

 /**

  * This LatkaEventListener will generate an XML report

  * of all tests run during an Latka XML suite.  XMLReporter

  * instances are NOT reusable for multiple invocations

  * of the {@link 

  * org.apache.commons.latka.Latka#runTests(org.apache.commons.latka.Suite,

  * org.apache.commons.latka.event.LatkaEventInfo) 

  * Latka#runTests(Suite, LatkaEventInfo)} method.

  *

  * @author Morgan Delagrange

  * @author dIon Gillard

  * @version $Id: XMLReporter.java 155424 2005-02-26 13:09:29Z dirkv $

  */

 public class XMLReporter extends AbstractReporter implements LatkaEventListener {

     /** dom4j document produced as output */

     protected Document _doc         = null;

     /** top level element of dom4j document, a <report> element*/

     protected Element  _rootElement = null;

     /** used for output as tests run */                   

     protected PrintWriter _printWriter = new PrintWriter(System.out);

     protected boolean _didSuiteSucceed = true;

     protected DocumentFactory _factory = new DocumentFactory();

     /**

      * Create an XML Reporter, initialising document property, as a new empty

      * report with an unsuccessful suite

      */

     public XMLReporter() {

         _rootElement = _factory.createElement("report");

         //defaults to false, until a SuiteSuccess event occurs

         _doc = _factory.createDocument(_rootElement);

         _rootElement.addAttribute("suiteSuccess", "false");

     }

     /**

      * Returns the XML Document produced by this listener

      *

      * @return dom4j representation of the test report

      */

     public Document getDocument() {

         return _doc;

     }

     /**

      * Returns the test report converted from dom4j to a

      * text string.

      *

      * @return the test report as an XML string

      * @throws IOException if the XML formatter cannot convert the dom4j object

      *                     to text

      */

     public String getDocumentAsString() throws IOException {

         // get the xml string from the listener

         StringWriter writer = new StringWriter();

         XMLWriter outputter = new XMLWriter(writer, new OutputFormat("  ", true));

         outputter.write(getDocument());

         String xmlDocument = writer.toString();

         return xmlDocument;

     }

     /**

      * @see AbstractReporter#requestError(RequestEvent) 

      * @param event the event detailing the request in error

      */

     public void requestError(RequestEvent event) {

         _didSuiteSucceed = false;

         _printWriter.print("E");

         _printWriter.flush();

         RequestErrorEvent errorEvent = (RequestErrorEvent) event;

         // <root><request><requestError><label>errortext</label>

         // </requestError></request></root>

         Element label = _factory.createElement("label")

                             .addText(errorEvent.getError().toString());

         Element requestError = _factory.createElement("requestError");

         requestError.add(label);

         Element requestElement = createRequestElement(event);

         requestElement.add(requestError);

         _rootElement.add(requestElement);

     }

     /**

      * @see AbstractReporter#requestSucceeded(RequestEvent)

      * @param event the event detailing the request that succeeded

      */

     public void requestSucceeded(RequestEvent event) {

         _printWriter.print(".");

         _printWriter.flush();

         Element requestElement = createRequestElement(event);

         requestElement.add(_factory.createElement("requestSuccess"));

         _rootElement.add(requestElement);

     }

     /**

      * @see AbstractReporter#requestFailed(RequestEvent)

      * @param event the event detailing the request that failed

      */

     public void requestFailed(RequestEvent event) {

         _didSuiteSucceed = false;

         _printWriter.print("F");

         _printWriter.flush();

         RequestFailedEvent failedEvent = (RequestFailedEvent) event;

         // <root><request><requestFailure responseId="xxx"><label>XXX</label>

         // </requestFailure></request></root>

         Element label = _factory.createElement("label")

                             .addText(failedEvent.getValidationException()

                                                    .getMessage()

                                                    .toString());

         Element requestFailure = _factory.createElement("requestFailure")

                                     .addAttribute("responseId",

                                                   event.getResponse().toString()

                                                  );

         requestFailure.add(label);

         Element requestElement = createRequestElement(event);

         requestElement.add(requestFailure);

         _rootElement.add(requestElement);

   }

     /**

      * @see AbstractReporter#requestSkipped(RequestEvent)

      * @param event the event detailing the request that was skipped

      */

     public void requestSkipped(RequestEvent event) {

         _didSuiteSucceed = false;

         _printWriter.print("S");

         _printWriter.flush();

         Request request = event.getRequest();

         // <root><request><requestSkipped/></request></root>

         Element requestElement = createRequestElement(event);

         requestElement.add(_factory.createElement("requestSkipped"));

         _rootElement.add(requestElement);

     }

     /**

      * Add the {@link ReportMessageEvent#getMessage() message} of the provided

      * event to the XML document as a <reportMessage> element with text

      *

      * @param event a {@link ReportMessageEvent}

      */

     public void reportMessage(ReportMessageEvent event) {

         Element messageElement = _factory.createElement("reportMessage")

           .addAttribute("message", event.getMessage());

         _rootElement.add(messageElement);

     }

     /**

      * @see AbstractReporter#suiteCompleted(SuiteEvent)

      * @param event the event detailing the completing Suite

      */

     public void suiteCompleted(SuiteEvent event) {

         _rootElement.addAttribute("suiteSuccess",

             String.valueOf(_didSuiteSucceed));

     }

     /**

      * Utility method that converts a RequestEvent object to its

      * corresponding element in the dom4j object.

      *

      * @param event the request event sent to the listener

      * @return the dom4j Element equivalent

      */

     protected Element createRequestElement(RequestEvent event) {

         // the request object

         Request request = event.getRequest();

         Element requestElement = _factory.createElement("request")

             .addAttribute("requestTime",

                           String.valueOf(request.getRequestTiming()))

             .addAttribute("url", request.getURL().toString());

         String label = request.getLabel();

         if (label != null) {

             requestElement.addAttribute("label", label);

         }

         return requestElement;

     }

     /**

      * During the execution, any diagnostic ouput will be sent

      * to the stream designated here.  If no PrintWriter

      * is set, output will be sent to standard out.

      * 

      * @param writer PrintWriter that will receive output generated during

      *               the test

      */

     public void setPrintWriter(PrintWriter writer) {

         _printWriter = writer;

     }

 }