AbstractSeam2FacetInstallDelegateTest.java

/******************************************************************************* 
 * Copyright (c) 2007 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 
 * 
 * Contributors: 
 * Red Hat, Inc. - initial API and implementation 
 ******************************************************************************/
package org.jboss.tools.seam.core.test.project.facet;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashSet;
import java.util.Set;

import org.eclipse.core.resources.IContainer;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceChangeEvent;
import org.eclipse.core.resources.IResourceProxy;
import org.eclipse.core.resources.IResourceProxyVisitor;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.Path;
import org.eclipse.wst.common.frameworks.datamodel.IDataModel;
import org.eclipse.wst.common.project.facet.core.IFacetedProject;
import org.eclipse.wst.common.project.facet.core.IProjectFacet;
import org.eclipse.wst.common.project.facet.core.IProjectFacetVersion;
import org.eclipse.wst.common.project.facet.core.ProjectFacetsManager;
import org.eclipse.wst.validation.ValidationFramework;
import org.eclipse.wst.validation.internal.EventManager;
import org.jboss.tools.seam.core.SeamProjectsSet;
import org.jboss.tools.seam.core.project.facet.SeamRuntimeManager;
import org.jboss.tools.seam.core.project.facet.SeamVersion;
import org.jboss.tools.seam.internal.core.project.facet.ISeamFacetDataModelProperties;

public abstract class AbstractSeam2FacetInstallDelegateTest extends AbstractSeamFacetTest {

	public static final String SEAM_2_0_0 = "Seam 2.0.0";
	public static final String SEAM_2_3_0 = "Seam 2.3.0";
	protected IFacetedProject warProject;
	protected IFacetedProject earProject;

	protected IProjectFacet seam2Facet;
	protected IProjectFacetVersion seam2FacetVersion;
	protected boolean suspendAllValidation;

	public AbstractSeam2FacetInstallDelegateTest(String name) {
		super(name);
	}

	@Override
	protected void setUp() throws Exception {
		suspendAllValidation = ValidationFramework.getDefault().isSuspended();
		ValidationFramework.getDefault().suspendAllValidation(true);

		ResourcesPlugin.getWorkspace().removeResourceChangeListener(
				EventManager.getManager());
		// commented to run tests on wtp 3.0.4 build
		// ws.removeResourceChangeListener( ValManager.getDefault() );
		// EventManager.getManager().shutdown();

		assertSeamHomeAvailable();

		seam2Facet = ProjectFacetsManager.getProjectFacet("jst.seam");
		seam2FacetVersion = seam2Facet.getVersion("2.0");

		File folder = getSeamHomeFolder();

		SeamRuntimeManager.getInstance().addRuntime(SEAM_2_0_0,
				folder.getAbsolutePath(), SeamVersion.SEAM_2_0, true);
		SeamRuntimeManager.getInstance().findRuntimeByName(SEAM_2_0_0);
		IProject war = (IProject) ResourcesPlugin.getWorkspace().getRoot()
				.findMember("warprj");
		warProject = (war != null ? ProjectFacetsManager.create(war, false,
				null) : createSeamWarProject("warprj"));
		IProject ear = (IProject) ResourcesPlugin.getWorkspace().getRoot()
				.findMember("earprj");
		earProject = (ear != null ? ProjectFacetsManager.create(ear, false,
				null) : createSeamEarProject("earprj"));

		// warProject.getProject().getWorkspace().getRoot().refreshLocal(IResource.DEPTH_INFINITE,
		// null);
	}

	@Override
	protected void tearDown() throws Exception {
		super.tearDown();
		ValidationFramework.getDefault().suspendAllValidation(
				suspendAllValidation);

		ResourcesPlugin.getWorkspace().addResourceChangeListener(
				EventManager.getManager(),
				IResourceChangeEvent.PRE_CLOSE
						| IResourceChangeEvent.PRE_DELETE
						| IResourceChangeEvent.POST_BUILD
						| IResourceChangeEvent.PRE_BUILD
						| IResourceChangeEvent.POST_CHANGE);
		// ws.addResourceChangeListener(ValOperationManager.getDefault(),
		// IResourceChangeEvent.POST_BUILD | IResourceChangeEvent.PRE_BUILD);

	}

	public static final String SEAM_201GA_HOME_PROPERY = "jbosstools.test.seam.2.0.1.GA.home";

	protected String getSystemPropertyName() {
		return SEAM_201GA_HOME_PROPERY;
	}

	@Override
	protected IDataModel createSeamDataModel(String deployType) {

		IDataModel dataModel = super.createSeamDataModel(deployType);
		dataModel.setStringProperty(
				ISeamFacetDataModelProperties.SEAM_RUNTIME_NAME, SEAM_2_0_0);
		dataModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_RUNTIME_LIBRARIES_COPYING, true);

		return dataModel;
	}

	protected Set<String> getWarLibs() {
		Set<String> seamgenlibs = new HashSet<String>();

		seamgenlibs.add("antlr-runtime.jar");
		seamgenlibs.add("commons-beanutils.jar");
		seamgenlibs.add("commons-digester.jar");
		seamgenlibs.add("drools-compiler.jar");
		seamgenlibs.add("drools-core.jar");
		seamgenlibs.add("core.jar");
		seamgenlibs.add("jboss-el.jar");
		seamgenlibs.add("jboss-seam-debug.jar");
		seamgenlibs.add("jboss-seam-ioc.jar");
		seamgenlibs.add("jboss-seam.jar");
		seamgenlibs.add("jboss-seam-mail.jar");
		seamgenlibs.add("jboss-seam-pdf.jar");
		seamgenlibs.add("jboss-seam-remoting.jar");
		seamgenlibs.add("jboss-seam-ui.jar");
		seamgenlibs.add("jbpm-jpdl.jar");
		seamgenlibs.add("jsf-facelets.jar");
		seamgenlibs.add("mvel14.jar");
		seamgenlibs.add("richfaces-api.jar");
		seamgenlibs.add("richfaces-impl.jar");
		seamgenlibs.add("richfaces-ui.jar");
		seamgenlibs.add("itext.jar");
		seamgenlibs.add("jfreechart.jar");
		seamgenlibs.add("jcommon.jar");

		return seamgenlibs;
	}

	public void testWarLibs() throws CoreException {

		Set<String> seamgenlibs = getWarLibs();

		final IContainer warLibs = (IContainer) warProject.getProject()
				.findMember("WebContent/WEB-INF/lib").getAdapter(
						IContainer.class);
		assertOnlyContainsTheseFiles(seamgenlibs, warLibs);
	}
	
	
	/**
	 * if(SEAM_TEMPLATES_AND_LIBRARIES_COPYING){
	 * 
	 * 		COPY_TEMPLATES();
	 * 
	 *  	if(SEAM_RUNTIME_LIBRARIES_COPYING){
	 *  		COPY_LIBRARIES();
	 *  	}
	 * }
	 * 
	 * Case 1. Add Seam Facet to new project + "Copy libraries From Seam Runtime to the project" option 
	 * 
	 * SEAM_TEMPLATES_AND_LIBRARIES_COPYING - true
	 * SEAM_RUNTIME_LIBRARIES_COPYING       - true
	 * 
	 * Case 2. Add Seam Facet to new project + "Configure Later" option
	 *
  	 * SEAM_TEMPLATES_AND_LIBRARIES_COPYING - true
	 * SEAM_RUNTIME_LIBRARIES_COPYING       - false
	 * 
	 * Case 3. Add Seam Facet to existing project
	 * 
  	 * SEAM_TEMPLATES_AND_LIBRARIES_COPYING - false
	 * SEAM_RUNTIME_LIBRARIES_COPYING       - false
	 * 
	 */
	
	private final static int CASE_1 = 1;
	private final static int CASE_2 = 2;
	private final static int CASE_3 = 3;
	
	public void testWarTemplatesAndLibrariesCopying() throws CoreException{
		checkWarLibrariesInSeamProject(CASE_1, "warTemplLibPrj");
	}

	public void testWarTemplatesAndLibrariesNotCopying() throws CoreException{
		checkWarLibrariesInSeamProject(CASE_3, "warNoTemplLibPrj");
	}

	public void testEarTemplatesAndLibrariesCopying() throws CoreException{
		checkEarLibrariesInSeamProject(CASE_1, "earTemplLibPrj");
	}

	public void testWarLibrariesCopying() throws CoreException{
		checkWarLibrariesInSeamProject(CASE_1, "warLibPrj");
	}

	public void testWarLibrariesNotCopying() throws CoreException{
		checkWarLibrariesInSeamProject(CASE_2, "warNoLibPrj");
	}

	public void testEarLibrariesCopying() throws CoreException{
		checkEarLibrariesInSeamProject(CASE_1, "earLibPrj");
	}

	public void testEarLibrariesNotCopying() throws CoreException{
		checkEarLibrariesInSeamProject(CASE_2, "earNoLibPrj");
	}

	protected void checkWarLibrariesInSeamProject(int caseNumber, String warName) throws CoreException{
		IDataModel warModel = createSeamDataModel("war");
		
		boolean copyTemplate = false;
		boolean copyLibraries = false;
		switch(caseNumber){
		case CASE_1:
			warModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_TEMPLATES_AND_LIBRARIES_COPYING, true);
			warModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_RUNTIME_LIBRARIES_COPYING, true);
			copyTemplate = true;
			copyLibraries = true;
			break;
		case CASE_2:
			warModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_TEMPLATES_AND_LIBRARIES_COPYING, true);
			warModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_RUNTIME_LIBRARIES_COPYING, false);
			copyTemplate = true;
			break;
		case CASE_3:
			warModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_TEMPLATES_AND_LIBRARIES_COPYING, false);
			warModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_RUNTIME_LIBRARIES_COPYING, false);
			break;
		}

		IFacetedProject wProject = createSeamProject(warName, warModel);
		IProject war = wProject.getProject();
		
		Set<String> onlyInWar = getWarLibs();

		final IContainer warLibs = (IContainer) war.findMember("WebContent/WEB-INF/lib");

		if(copyLibraries){
			assertOnlyContainsTheseFiles(onlyInWar, warLibs);
		}else{
			assertContainsNoneOfTheseFiles(onlyInWar, warLibs);
		}
	}

	protected boolean shouldCheckJBossAppXML() {
		return true;
	}

	protected void checkEarLibrariesInSeamProject(int caseNumber, String earName) throws CoreException{
		IDataModel earModel = createSeamDataModel("ear");
		
		boolean copyTemplate = false;
		boolean copyLibraries = false;
		switch(caseNumber){
		case CASE_1:
			earModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_TEMPLATES_AND_LIBRARIES_COPYING, true);
			earModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_RUNTIME_LIBRARIES_COPYING, true);
			copyTemplate = true;
			copyLibraries = true;
			break;
		case CASE_2:
			earModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_TEMPLATES_AND_LIBRARIES_COPYING, true);
			earModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_RUNTIME_LIBRARIES_COPYING, false);
			copyTemplate = true;
			break;
		case CASE_3:
			earModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_TEMPLATES_AND_LIBRARIES_COPYING, false);
			earModel.setBooleanProperty(ISeamFacetDataModelProperties.SEAM_RUNTIME_LIBRARIES_COPYING, false);
			break;
		}
		
		IFacetedProject eProject = createSeamProject(earName, earModel);
		IProject war = eProject.getProject();
		
		SeamProjectsSet seamProjectsSet = new SeamProjectsSet(war);
		
		assertTrue(seamProjectsSet.getWarProject().exists());
		assertTrue(!shouldCheckTestProject() || seamProjectsSet.getTestProject().exists());
		assertTrue(seamProjectsSet.getEjbProject().exists());
		assertTrue(seamProjectsSet.getEarProject().exists());

		IProject ear = seamProjectsSet.getEarProject();
		IProject ejb = seamProjectsSet.getEjbProject();
		IProject test = seamProjectsSet.getTestProject();
		
		Set<String> onlyInWar = getEarWarLibs();
		Set<String> onlyInEar = getEarLibs();
		Set<String> onlyInTest = getTestLibs();
		Set<String> onlyInEarSeam = new HashSet<String>();
		Set<String> onlyInEjbSrc = new HashSet<String>();
		Set<String> onlyInEarMeta = new HashSet<String>();
		
		if(caseNumber == CASE_1 || caseNumber == CASE_3){
			onlyInEarMeta = getOnlyInEarMeta();
	
			onlyInEjbSrc.add("security.drl");
			onlyInEjbSrc.add("seam.properties");
			onlyInEjbSrc.add("import.sql");
			onlyInEjbSrc.add("components.properties");
		}

		onlyInEarSeam.add("jboss-seam.jar");
		
		if(copyLibraries){
			onlyInEarSeam.add("lib");
			onlyInEarSeam.add("META-INF");
			onlyInEjbSrc.add("META-INF");
			onlyInEjbSrc.add("org");
			
		}
		
		final IContainer earMeta = (IContainer) ear.findMember("EarContent/META-INF");

		final IContainer warLibs = (IContainer) war.findMember("WebContent/WEB-INF/lib");

		final IContainer earLibsSeam = (IContainer) ear.findMember("EarContent");

		final IContainer earLibs = (IContainer) ear.findMember("EarContent/lib");
		
		final IContainer ejbSrc = (IContainer) ejb.findMember("ejbModule");

		final IContainer testLibs = shouldCheckTestProject()?(IContainer) test.findMember("lib"):null;

		if(copyLibraries){
			assertOnlyContainsTheseFiles(onlyInEjbSrc, ejbSrc);
			
			assertOnlyContainsTheseFiles(onlyInEarMeta, earMeta);
			
			assertOnlyContainsTheseFiles(onlyInEarSeam, earLibsSeam);

			assertOnlyContainsTheseFiles(onlyInEar, earLibs);

			assertOnlyContainsTheseFiles(onlyInWar, warLibs);

			if(shouldCheckTestProject()) {
				assertOnlyContainsTheseFiles(onlyInTest, testLibs);
			}
		}else{
			assertContainsNoneOfTheseFiles(onlyInEjbSrc, ejbSrc);
			
			assertContainsNoneOfTheseFiles(onlyInEarMeta, earMeta);
			
			assertContainsNoneOfTheseFiles(onlyInEarSeam, earLibsSeam);

			assertContainsNoneOfTheseFiles(onlyInEar, earLibs);

			assertContainsNoneOfTheseFiles(onlyInWar, warLibs);

			if(shouldCheckTestProject()) {
				assertContainsNoneOfTheseFiles(onlyInTest, testLibs);
			}
		}
	}

	protected Set<String> getOnlyInEarMeta() {
		Set<String> onlyInEarMeta = new HashSet<String>();
		if(shouldCheckJBossAppXML()) {
			onlyInEarMeta.add("jboss-app.xml");
		}
		onlyInEarMeta.add("application.xml");

		return onlyInEarMeta;
	}

	protected Set<String> getTestLibs() {
		Set<String> libs = new HashSet<String>();
		return libs;
	}

	protected Set<String> getEarLibs() {
		Set<String> onlyInEar = new HashSet<String>();

		onlyInEar.add("commons-beanutils.jar");
		onlyInEar.add("antlr-runtime.jar");
		onlyInEar.add("drools-compiler.jar");
		onlyInEar.add("drools-core.jar");
		onlyInEar.add("jboss-el.jar");
		onlyInEar.add("jboss-seam-remoting.jar");
		onlyInEar.add("mvel14.jar");
		onlyInEar.add("richfaces-api.jar");
		onlyInEar.add("jbpm-jpdl.jar");

		return onlyInEar;
	}

	protected Set<String> getEarWarLibs() {
		Set<String> onlyInWar = new HashSet<String>();

		onlyInWar.add("commons-digester.jar");
		onlyInWar.add("jboss-seam-debug.jar");
		onlyInWar.add("jboss-seam-ioc.jar");
		onlyInWar.add("jboss-seam-mail.jar");
		onlyInWar.add("jboss-seam-pdf.jar");
		onlyInWar.add("jboss-seam-ui.jar");
		onlyInWar.add("jsf-facelets.jar");
		onlyInWar.add("richfaces-impl.jar");
		onlyInWar.add("richfaces-ui.jar");
		onlyInWar.add("itext.jar");
		onlyInWar.add("jfreechart.jar");
		onlyInWar.add("jcommon.jar");

		return onlyInWar;
	}

	public void testEarLibs() throws CoreException {
		IProject war = earProject.getProject();

		SeamProjectsSet seamProjectsSet = new SeamProjectsSet(earProject
				.getProject());

		IProject ear = seamProjectsSet.getEarProject();

		Set<String> onlyInWar = getEarWarLibs();
		Set<String> onlyInEar = getEarLibs();
		Set<String> onlyInEarSeam = new HashSet<String>();
		Set<String> onlyInEjbSrc = new HashSet<String>();

		onlyInEarSeam.add("jboss-seam.jar");
		onlyInEarSeam.add("lib");
		onlyInEarSeam.add("META-INF");

		final IContainer earLibsSeam = (IContainer) ear.findMember(
				new Path("EarContent")).getAdapter(IContainer.class);

		assertOnlyContainsTheseFiles(onlyInEarSeam, earLibsSeam);

		final IContainer earLibs = (IContainer) ear.findMember(
				new Path("EarContent").append("lib")).getAdapter(
				IContainer.class);

		assertOnlyContainsTheseFiles(onlyInEar, earLibs);

		final IContainer earMeta = (IContainer) ear.findMember(
				"EarContent/META-INF").getAdapter(IContainer.class);

		Set<String> onlyInEarMeta = getOnlyInEarMeta();

		assertOnlyContainsTheseFiles(onlyInEarMeta, earMeta);

		assertOnlyContainsTheseFiles(onlyInWar, (IContainer) war.findMember(
				"WebContent/WEB-INF/lib").getAdapter(IContainer.class));

		IProject ejb = seamProjectsSet.getEjbProject();

		onlyInEjbSrc.add("security.drl");
		onlyInEjbSrc.add("seam.properties");
		onlyInEjbSrc.add("import.sql");
		onlyInEjbSrc.add("components.properties");
		onlyInEjbSrc.add("META-INF"); // JBIDE-2431: META-INF dir is always
										// created by Seam 2.0 seamgen
		onlyInEjbSrc.add("org"); // JBIDE-2431: org dir is always created by
									// Seam 2.0 seamgen

		assertOnlyContainsTheseFiles(onlyInEjbSrc, (IContainer) ejb.findMember(
				"ejbModule").getAdapter(IContainer.class));
	}

	/**
	 * https://issues.jboss.org/browse/JBIDE-7932
	 * @throws CoreException
	 * @throws IOException
	 */
	public void testEarManifestFiles() throws CoreException, IOException {
		IProject war = earProject.getProject();

		SeamProjectsSet seamProjectsSet = new SeamProjectsSet(earProject
				.getProject());

		IProject ejb = seamProjectsSet.getEjbProject();

		IFile ejbManifest = (IFile)ejb.findMember(new Path("ejbModule/META-INF/MANIFEST.MF"));
		assertNotNull("Can't find ejbModule/META-INF/MANIFEST.MF", ejbManifest);
		assertTrue("ejbModule/META-INF/MANIFEST.MF is not accessible.", ejbManifest.isAccessible());
		String content = getContents(ejbManifest);
		assertEquals("Found jboss-seam.jar in ejbModule/META-INF/MANIFEST.MF", -1, content.indexOf("jboss-seam.jar"));

		IFile warManifest = (IFile)war.findMember(new Path("WebContent/META-INF/MANIFEST.MF"));
		assertNotNull("Can't find WebContent/META-INF/MANIFEST.MF", warManifest);
		assertTrue("WebContent/META-INF/MANIFEST.MF is not accessible.", warManifest.isAccessible());
		content = getContents(warManifest);
		assertFalse("Didn't find jboss-seam.jar in WebContent/META-INF/MANIFEST.MF", content.indexOf("jboss-seam.jar")==-1);
	}

	private String getContents(IFile file) throws IOException, CoreException {
		StringBuffer sb = new StringBuffer();
		InputStream is = file.getContents();
		int i = 0;
		while(i!=-1) {
			i = is.read();
			sb.append((char)i);
		}
		return sb.toString();
	}

	/**
	 * Fails if set of fileNames is not found in dir or some other filename is
	 * found in dir.
	 * 
	 * @param fileNames
	 *            set of strings
	 * @param dir
	 *            directory to scan
	 * @throws CoreException
	 */
	protected void assertOnlyContainsTheseFiles(Set<String> fileNames,
			final IResource dir) throws CoreException {

		final Set<String> foundFiles = new HashSet<String>();
		dir.accept(new IResourceProxyVisitor() {

			public boolean visit(IResourceProxy proxy) throws CoreException {
				if (dir.getName().equals(proxy.getName()))
					return true;
				if(proxy.isAccessible()) {
					foundFiles.add(proxy.getName());
				}
				return false;
			}

		}, IResource.DEPTH_ZERO);

		if (!foundFiles.containsAll(fileNames)) {
			fileNames.removeAll(foundFiles);
			fail("Did not find " + fileNames + " in " + dir);
		}

		foundFiles.removeAll(fileNames);

		assertTrue("Found additional files (" + foundFiles + " in " + dir
				+ " at " + dir.getLocation(), foundFiles.isEmpty());
	}

	protected void assertContainsNoneOfTheseFiles(Set<String> fileNames,
			final IResource dir) throws CoreException {
		
		if(dir == null)
			return;
		
		final Set<String> foundFiles = new HashSet<String>();
		dir.accept(new IResourceProxyVisitor() {

			public boolean visit(IResourceProxy proxy) throws CoreException {
				if (dir.getName().equals(proxy.getName()))
					return true;
				foundFiles.add(proxy.getName());
				return false;
			}

		}, IResource.DEPTH_ZERO);
		
		for(String fileName : fileNames){
			if(foundFiles.contains(fileName)){
				fail("Found library: "+fileName);
			}
		}

	}

	public void testSeamProperties() {
		SeamProjectsSet warPs = new SeamProjectsSet(warProject.getProject());

		IProject warProject = warPs.getWarProject();
		assertTrue(warProject.exists());

		assertNotNull(warProject.findMember("src/main/seam.properties"));
		IResource findMember = warProject.findMember("src/hot/seam.properties");
		assertNotNull(findMember);
		assertTrue(findMember instanceof IFile);
	}

	public void testCreateEar() throws CoreException, IOException {
	}

	@Override
	protected IProjectFacetVersion getSeamFacetVersion() {
		return seam2FacetVersion;
	}
}