org.eclipse.osee.ote.core/src/org/eclipse/osee/ote/core/log/record/ScriptConfigRecord.java

/*******************************************************************************
 * Copyright (c) 2004, 2007 Boeing.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Boeing - initial API and implementation
 *******************************************************************************/
package org.eclipse.osee.ote.core.log.record;

import java.net.InetAddress;
import java.net.UnknownHostException;
import java.text.DateFormat;
import java.util.Date;
import java.util.List;
import java.util.logging.Level;

import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;

import org.codehaus.jackson.annotate.JsonCreator;
import org.codehaus.jackson.annotate.JsonIgnore;
import org.codehaus.jackson.annotate.JsonProperty;
import org.eclipse.osee.framework.jdk.core.util.xml.Jaxp;
import org.eclipse.osee.framework.logging.OseeLog;
import org.eclipse.osee.ote.core.TestScript;
import org.eclipse.osee.ote.core.environment.TestEnvironment;
import org.eclipse.osee.ote.core.environment.config.ScriptVersionConfig;
import org.eclipse.osee.ote.core.log.TestLevel;
import org.eclipse.osee.ote.core.test.tags.BaseTestTags;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

/**
 * @author Ryan D. Brooks
 * @author Andrew M. Finkbeiner
 */
public class ScriptConfigRecord extends TestRecord {
    private ScriptVersionConfig scriptVersionRecord;
    private String userName;
    private String userEmail;
    private String userId;
    private static final long serialVersionUID = 6919229589873467398L;

    /**
     * ScriptConfigRecord Constructor. Constructs test script configuration log
     * message with timestamp.
     * 
     * @param script
     *            The test script who's configuration is to be recorded.
     * @param timeStamp
     *            <b>True </b> if a timestamp should be recorded, <b>False </b>
     *            if not.
     */
    public ScriptConfigRecord(TestScript script, boolean timeStamp) {
        super(script.getTestEnvironment(), TestLevel.TEST_POINT, script.getClass().getName(), timeStamp);
    }

    /**
     * ScriptConfigRecord Constructor. Constructs test script configuration log
     * message.
     * 
     * @param script
     *            The test script who's configuration is to be recorded.
     */
    public ScriptConfigRecord(TestScript script) {
        this(script, true);
    }

    /**
     * Convert an element to XML format.
     * 
     * @return XML formated config element.
     */
    @Override
    public Element toXml(Document doc) {
        Element configElement = doc.createElement(BaseTestTags.CONFIG_ENTRY);
        try {
            configElement.setAttribute("machineName", InetAddress.getLocalHost().getHostName());
        } catch (DOMException e) {
            OseeLog.log(TestEnvironment.class, Level.SEVERE, e);
        } catch (UnknownHostException e) {
            OseeLog.log(TestEnvironment.class, Level.SEVERE, e);
        }
        configElement.appendChild(Jaxp.createElement(doc, BaseTestTags.SCRIPT_NAME, getMessage()));
        Element user = doc.createElement("User");
        user.setAttribute("name", this.userName);
        user.setAttribute("email", this.userEmail);
        user.setAttribute("id", this.userId);
        configElement.appendChild(user);
        if (scriptVersionRecord != null) {
            configElement.appendChild(scriptVersionRecord.toXml(doc));
        }
        // if (executedBy != null) {
        // configElement.appendChild(executedBy.toXml(doc));
        // }
        DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG);
        configElement.appendChild(Jaxp.createElement(doc, BaseTestTags.EXECUTION_DATE, dateFormat.format(new Date()).toString()));
        TestScript script = ((TestEnvironment) this.getSource()).getTestScript();
        if (script != null) {
            configElement.appendChild(Jaxp.createElement(doc, BaseTestTags.ENVIRONMENT_FIELD, script.getType().toString()));
        } else {
            // script is null
            configElement.appendChild(Jaxp.createElement(doc, BaseTestTags.ENVIRONMENT_FIELD, "Null Script"));
        }
        return configElement;
    }

    @Override
    public void toXml(XMLStreamWriter writer) throws XMLStreamException {
        writer.writeStartElement(BaseTestTags.CONFIG_ENTRY);
        try {
            writer.writeAttribute("machineName", InetAddress.getLocalHost().getHostName());
        } catch (DOMException e) {
            OseeLog.log(TestEnvironment.class, Level.SEVERE, e);
        } catch (UnknownHostException e) {
            OseeLog.log(TestEnvironment.class, Level.SEVERE, e);
        }
        writeElement(writer, BaseTestTags.SCRIPT_NAME, getMessage());
        writer.writeStartElement("User");
        writer.writeAttribute("name", this.userName);
        writer.writeAttribute("email", this.userEmail);
        writer.writeAttribute("id", this.userId);
        writer.writeEndElement();
        if (scriptVersionRecord != null) {
            scriptVersionRecord.toXml(writer);
        }
        DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG);
        writeElement(writer, BaseTestTags.EXECUTION_DATE, dateFormat.format(new Date()).toString());
        TestScript script = ((TestEnvironment) this.getSource()).getTestScript();
        if (script != null) {
            writeElement(writer, BaseTestTags.ENVIRONMENT_FIELD, script.getType().toString());
        } else {
            // script is null
            writeElement(writer, BaseTestTags.ENVIRONMENT_FIELD, "Null Script");
        }
        writer.writeEndElement();
    }

    @JsonProperty
    public ScriptVersionConfig getScriptVersionRecord() {
        return scriptVersionRecord;
    }

    public void setScriptVersion(ScriptVersionConfig scriptVersionRecord) {
        this.scriptVersionRecord = scriptVersionRecord;
    }

    public void setExecutedBy(String name, String email, String id) {
        this.userName = name;
        this.userEmail = email;
        this.userId = id;
    }

    @JsonProperty
    public String getMachineName() {
        try {
            return InetAddress.getLocalHost().getHostName();
        } catch (UnknownHostException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return null;
    }

    @JsonProperty
    public User getUser() {
        return new User(this.userName, this.userEmail, this.userId);
    }

    public class User {
        private String name, email, id;

        @JsonCreator
        public User(final String name, final String email, final String id) {
            this.name = name;
            this.email = email;
            this.id = id;
        }

        @JsonProperty
        public String getName() {
            return nonEmptyString(name);
        }

        @JsonProperty
        public String getEmail() {
            return nonEmptyString(email);
        }

        @JsonProperty
        public String getId() {
            return nonEmptyString(id);
        }
    }

    @JsonProperty
    public String getExecutionDate() {
        DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG);
        return dateFormat.format(new Date()).toString();
    }

    @JsonProperty
    public String getEnvironment() {
        TestScript script = ((TestEnvironment) this.getSource()).getTestScript();
        if (script != null) {
            return script.getType().toString();
        } else {
            return null;
        }
    }

    @JsonIgnore
    @Override
    public List<String> getLocation() {
        return super.getLocation();
    }
}