/*******************************************************************************
 * Copyright (c) 2010 SAP AG.
 * 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:
 *    Emil Simeonov - initial API and implementation.
 *    Dimitar Donchev - initial API and implementation.
 *    Dimitar Tenev - initial API and implementation.
 *    Nevena Manova - initial API and implementation.
 *    Georgi Konstantinov - initial API and implementation.
 *******************************************************************************/
package org.eclipse.wst.sse.sieditor.test.model.commands.wsdl;

import java.io.IOException;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.wst.sse.sieditor.test.model.commands.AbstractCommandTest;
import org.eclipse.wst.wsdl.Definition;
import org.w3c.dom.Element;

import org.eclipse.wst.sse.sieditor.command.emf.wsdl.AbstractCompositeEnsuringDefinitionNotificationOperation;
import org.eclipse.wst.sse.sieditor.model.api.IWsdlModelRoot;
import org.eclipse.wst.sse.sieditor.model.wsdl.api.IDescription;

/**
 * This test is intended to be extended by the ones, testing the functionality
 * of creating the <?xml ... > and <definitions>.. elements with the
 * first command executed on an <B>EMPTY .wsdl</B> document.
 * 
 *
 * 
 */
public abstract class AbstractEnsureDefinitionCommandTest extends AbstractCommandTest {

    private static final String EMPTY_WSDL = "empty.wsdl";
    private static final String EMPTY_WSDLS_DIR = "pub/csns/badContent/";

    public AbstractEnsureDefinitionCommandTest() {
        super();
    }

    /**
     * Add a call to the default implementation of this method in the beginning
     * of the one overriding it
     */
    @Override
    protected void assertPostUndoState(final IStatus undoStatus, final IWsdlModelRoot modelRoot) {
        final IDescription description = modelRoot.getDescription();
        final Definition component = description.getComponent();
        final Element elementFromComponent = component.getElement();
        assertNull(elementFromComponent);
        final Element elementFromDoc = component.getDocument().getDocumentElement();
        assertNull(elementFromDoc);
        assertEquals(elementFromComponent, elementFromDoc);

    }

    /**
     * Add a call to the default implementation of this method in the beginning
     * of the one overriding it
     */
    @Override
    protected void assertPostRedoState(final IStatus redoStatus, final IWsdlModelRoot modelRoot) {
        assertNotNull(modelRoot.getDescription().getComponent().getElement());

    }

    @Override
    protected String getWsdlFilename() {
        return EMPTY_WSDL;
    }

    @Override
    protected String getWsdlFoldername() {
        return EMPTY_WSDLS_DIR;
    }

    @SuppressWarnings("restriction")
    @Override
    protected IWsdlModelRoot getWSDLModelRoot(final String fileName, final String targetFileName) throws IOException,
            CoreException {
        return getWsdlModelRootViaDocumentProvider(fileName, targetFileName);
    }

    // predefine the abstract parent operation to return the specific type of
    // command
    @Override
    abstract protected AbstractCompositeEnsuringDefinitionNotificationOperation getOperation(IWsdlModelRoot modelRoot)
            throws Exception;
}