/*
 *  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.
 *  
 *  $Rev$  $Date$
 */
package test.sdo21.tests.api.XMLHelper;

import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;

import test.sdo21.tests.TestData.StandardFactory;
import test.sdo21.tests.api.CTSConsistencyBase;
import test.sdo21.tests.util.CTSUtil;

import commonj.sdo.DataObject;
import commonj.sdo.helper.HelperContext;


public abstract class XMLHelperConsistencyBase extends CTSConsistencyBase {
	private DataObject testDO;
	private HelperContext helperContext;
  


    @Before
    public void setUp () throws Exception {
      super.setUp();
    	testDO = factory.createTestData(getScope(), StandardFactory.API_TYPE);
    	helperContext = getScope();
    }
    
    
    
    @After
    public void tearDown() throws Exception {
      super.tearDown();
    }


    /**
     * Serialize the DataObject then Deserialize the output using Java serialization. Result should be
     * equivalent to testDO.
     */
    @Test
    public void testJavaSerializeDeserialize() {
        try {
            ((StandardFactory)factory).populateFields(testDO, helperContext);
        } catch (Exception e) {
            fail("Could not populate DataObject");
        }
        DataObject tempDO = null;
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
// FIXME reintroduce
//        try {
//            ParamatizedTestUtil.serializeDataObjectJava(testDO, baos, helperContext);
//        } catch (Exception e) {
//            e.printStackTrace();
//            fail("An Exception occurred while serializing the DataObject: " + e.toString());
//        }
//
//        try {
//            ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
//            tempDO = ParamatizedTestUtil.deserializeDataObjectJava(bais, helperContext);
//        } catch (Exception e) {
//            e.printStackTrace();
//            fail("An Exception occurred while deserializing the output of the serialization: " + e.toString());
//        }
//
//        assertNotNull("Deserialization returned a null value.", tempDO);
//        assertTrue("Serialization and deserialization resulted in a nonequivalent DataObject.",
//                ParamatizedTestUtil.equalDataObjects(testDO, tempDO));
    }

    /**
     * Serialize the DataObject then Deserialize the output using the XMLHelper. Result should be
     * equivalent to testDO.
     */
    @Test
    public void testXMLHelperSerializeDeserialize() {
        try {
          ((StandardFactory)factory).populateFields(testDO, helperContext);
        } catch (Exception e) {
            fail("Could not populate DataObject");
        }
        DataObject tempDO = null;
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        try {
            CTSUtil.serializeDataObjectXML(testDO, baos, helperContext);
        } catch (Exception e) {
            e.printStackTrace();
            fail("An Exception occurred while serializing the DataObject: " + e.toString());
        }

        try {
            ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
            tempDO = CTSUtil.deserializeDataObjectXML(bais, helperContext);
        } catch (Exception e) {
            e.printStackTrace();
            fail("An Exception occurred while deserializing the output of the serialization: " + e.toString());
        }

        assertNotNull("Deserialization returned a null value.", tempDO);
        assertTrue("Serialization and deserialization resulted in a nonequivalent DataObject.",
                helperContext.getEqualityHelper().equal(testDO, tempDO));
    }

    /**
     * Verifies that appropriate exception is thrown when an
     * invalid XML document is specified. 
     */
    @Test
    public void testFaultyXML() {
        try {
           helperContext.getXMLHelper().load(XMLHelperConsistencyBase.class.getResourceAsStream("/faulty.xml"));
           fail("Attempting to load a faulty XML file should result in an Exception.");
        } catch (Exception e) {
    	   // success
        }
    }

    /**
     * Tests the condition that an XML document is in itself valid, but does not comply with the XSD.
     */
    @Test
    public void testXMLWrongXSD() {
        try {
            helperContext.getXMLHelper().load(XMLHelperConsistencyBase.class.getResourceAsStream("/wrongNamespace.xml"));
            fail("Attempting to load an XML specifying the wrong namespace file should result in an Exception.");
        } catch (Exception e) {
            // success
        }
    }
}