OpenOnJsf20Test_JBIDE5382.java

/*******************************************************************************
 * Copyright (c) 2007-2009 Red Hat, Inc.
 * Distributed under license by Red Hat, Inc. All rights reserved.
 * This program is 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
 *
 * Contributor:
 *     Red Hat, Inc. - initial API and implementation
 ******************************************************************************/
package org.jboss.tools.jsf.vpe.jsf.test.jbide;

import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.PlatformUI;
import org.jboss.tools.jsf.vpe.jsf.template.JSF;
import org.jboss.tools.jsf.vpe.jsf.test.JsfAllTests;
import org.jboss.tools.jst.web.ui.internal.editor.util.NodesManagingUtil;
import org.jboss.tools.vpe.base.test.OpenOnUtil;
import org.jboss.tools.vpe.base.test.TestUtil;
import org.jboss.tools.vpe.base.test.VpeTest;
import org.jboss.tools.vpe.editor.VpeController;
import org.junit.Before;
import org.junit.Test;
import org.mozilla.interfaces.nsIDOMNode;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import static org.junit.Assert.*;

/**
 * Tests for the OpenOn actions in JSF 2.0 projects. 
 * 
 * @author Yahor Radtsevich (yradtsevich)
 */
public class OpenOnJsf20Test_JBIDE5382 extends VpeTest {
	private static final String OUTPUT_STYLESHEET_ELEMENT_ID = "outputStylesheet1"; //$NON-NLS-1$
	private static final String OUTPUT_STYLESHEET_LIB_ELEMENT_ID = "outputStylesheet2"; //$NON-NLS-1$
	private static final String OUTPUT_SCRIPT_ELEMENT_ID = "outputScript1"; //$NON-NLS-1$
	private static final String OUTPUT_SCRIPT_LIB_ELEMENT_ID = "outputScript2"; //$NON-NLS-1$
	private static final String SCRIPT_FILE_NAME = "f1.js"; //$NON-NLS-1$
	private static final String SCRIPT_LIB_FILE_NAME = "f2.js"; //$NON-NLS-1$
	private static final String STYLESHEET_FILE_NAME = "stylesRed.css"; //$NON-NLS-1$
	private static final String STYLESHEET_LIB_FILE_NAME = "stylesBlue.css"; //$NON-NLS-1$
	private static final String TEST_FILE_PATH = "JBIDE/5382/OpenOnJsf20.xhtml"; //$NON-NLS-1$
	private static final String JSF_HTML_TLD = "html_basic.tld"; //$NON-NLS-1$
	private VpeController vpeController;
	private Document sourceDocument;

	public OpenOnJsf20Test_JBIDE5382() {
	}

	@Before
	@Override
	public void setUp() throws Exception {
		super.setUp();
		vpeController = openInVpe(JsfAllTests.IMPORT_JSF_20_PROJECT_NAME,
				TEST_FILE_PATH);
		sourceDocument = getSourceDocument(vpeController);
	}
	
	////////////////////////////////////////////////////////////////////////////
	// JUNIT TESTING METHODS
	@Test
	public void testSourceOpenOnOutputStylesheet() throws Throwable {
		openOnSourceNode(getOutputStylesheetNode()
				.getAttributeNode(JSF.ATTR_NAME));
		assertActiveEditorInputNameEquals(STYLESHEET_FILE_NAME);
	}

	@Test
	public void testSourceOpenOnOutputStylesheetLib() throws Throwable {
		openOnSourceNode(getOutputStylesheetLibNode()
				.getAttributeNode(JSF.ATTR_NAME));
		assertActiveEditorInputNameEquals(STYLESHEET_LIB_FILE_NAME);
	}

	@Test
	public void testSourceOpenOnOutputScript() throws Throwable {
		openOnSourceNode(getOutputScriptNode().getAttributeNode(JSF.ATTR_NAME));
		assertActiveEditorInputNameEquals(SCRIPT_FILE_NAME);
	}

	@Test
	public void testSourceOpenOnOutputScriptLib() throws Throwable {
		openOnSourceNode(getOutputScriptLibNode().getAttributeNode(JSF.ATTR_NAME));
		assertActiveEditorInputNameEquals(SCRIPT_LIB_FILE_NAME);
	}

	@Test
	public void testVisualOpenOnOutputStylesheet() {
		showInvisibleTags();
		openOnCorrespondingVisualNode(getOutputStylesheetNode());
		/*
		 * https://issues.jboss.org/browse/JBIDE-10600
		 * OpenOn for visual nodes is not available.
		 * OpenOn will be performed on corresponding source node in any case:
		 * For this  invisible tag -- on the whole source node, but not on its attribute.
		 * For h:outputStyleSheet "html_basic.tld" will be opened.
		 */
		assertActiveEditorInputNameEquals(JSF_HTML_TLD);
	}

	@Test
	public void testVisualOpenOnOutputScript() {
		showInvisibleTags();
		openOnCorrespondingVisualNode(getOutputScriptNode());
		/*
		 * https://issues.jboss.org/browse/JBIDE-10600
		 * OpenOn for visual nodes is not available.
		 * OpenOn will be performed on corresponding source node in any case:
		 * for this invisible tag -- on the whole source node, but not on its attribute.
		 * For h:outputScript "html_basic.tld" will be opened.
		 */
		assertActiveEditorInputNameEquals(JSF_HTML_TLD);
	}

	////////////////////////////////////////////////////////////////////////////
	// PRIVATE METHODS

	private Element getOutputScriptNode() {
		return sourceDocument.getElementById(OUTPUT_SCRIPT_ELEMENT_ID);
	}

	private Element getOutputScriptLibNode() {
		return sourceDocument.getElementById(OUTPUT_SCRIPT_LIB_ELEMENT_ID);
	}
	
	private Element getOutputStylesheetNode() {
		return sourceDocument.getElementById(OUTPUT_STYLESHEET_ELEMENT_ID);
	}
	
	private Element getOutputStylesheetLibNode() {
		return sourceDocument.getElementById(OUTPUT_STYLESHEET_LIB_ELEMENT_ID);
	}
	
	private void openOnSourceNode(Node sourceNode) throws Throwable {
		int offset = NodesManagingUtil.getStartOffsetNode(sourceNode);
		OpenOnUtil.performOpenOnAction(vpeController.getSourceEditor(), offset);
	}
	
	private void openOnCorrespondingVisualNode(Node sourceNode) {
		nsIDOMNode visualNode = vpeController.getDomMapping()
				.getNearVisualNode(sourceNode);
		vpeController.getSourceBuilder().openOn(visualNode);
	}
	
	private void showInvisibleTags() {
		vpeController.getVisualBuilder().setShowInvisibleTags(true);
		vpeController.visualRefresh();
		TestUtil.waitForIdle();
	}
	
	private void assertActiveEditorInputNameEquals(String expectedName) {
		IEditorPart activeEditorPart = (IEditorPart) PlatformUI.getWorkbench()
				.getActiveWorkbenchWindow().getActivePage().getActivePart();
		String actualName = activeEditorPart.getEditorInput().getName();
		
		assertEquals("No file is opened or a wrong file "		//$NON-NLS-1$
						+ "is opened on the OpenOn action .",	//$NON-NLS-1$
		expectedName, actualName);		
	}
}