JointGrailsCommandTest.java

/*******************************************************************************
 * Copyright (c) 2012 VMWare, Inc.
 * 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:
 *     VMWare, Inc. - initial API and implementation
 *******************************************************************************/
package org.grails.ide.eclipse.commands.test;

import java.io.File;
import java.util.Map;

import org.grails.ide.eclipse.commands.GrailsCommand;
import org.grails.ide.eclipse.commands.GrailsCommandFactory;
import org.grails.ide.eclipse.commands.GrailsCommandUtils;
import org.grails.ide.eclipse.commands.GroovyCompilerVersionCheck;
import org.grails.ide.eclipse.core.internal.classpath.PerProjectAttachementsCache;
import org.grails.ide.eclipse.core.internal.classpath.PerProjectAttachementsCache.Dependency;
import org.grails.ide.eclipse.core.launch.GrailsCommandLaunchConfigurationDelegate;
import org.grails.ide.eclipse.core.launch.SynchLaunch.ILaunchResult;
import org.grails.ide.eclipse.core.model.GrailsVersion;
import org.grails.ide.eclipse.core.model.IGrailsInstall;
import org.springsource.ide.eclipse.commons.tests.util.StsTestUtil;

/**
 * Tests for (portions of) the {@link GrailsCommandUtils} class.
 * These are the JOINT tests, the ones that run on the joint STS-grails build 
 * @author Kris De Volder
 * @created 2010-08-04
 */
public class JointGrailsCommandTest extends AbstractCommandTest {

	public static boolean heartbeat = false;

	@Override
	protected void setUp() throws Exception {
		super.setUp();
		GroovyCompilerVersionCheck.testMode();
		//Ensure prior test projects don't exist
		StsTestUtil.deleteAllProjects();
		//clearGrailsState(); //Workaround for http://jira.grails.org/browse/GRAILS-7655 (ivy cache corruption)
	}
	
	/**
	 * Attempt to distill down to smaller test the reason for test failures where it seems
	 * "grails compile --non-interactive" is being interpreted as a request to call "grails interactive"
	 * instead. This happens only when we call it from STS, not commandline.
	 */
	public void testRefreshDependencyFileCommand() throws Exception {
//		GrailsCommandLaunchConfigurationDelegate.DEBUG = true;
		try {
			GrailsVersion version = GrailsVersion.MOST_RECENT;
			ensureDefaultGrailsVersion(version);
            project = ensureProject(TEST_PROJECT_NAME);

			GrailsCommand cmd = GrailsCommandFactory.refreshDependencyFile(project);
			System.out.println(cmd.synchExec());
		} finally {
			GrailsCommandLaunchConfigurationDelegate.DEBUG = false;
		}
	}
	
	/**
	 * A test running the Grails command used for downloading
	 * @throws Exception
	 */
	public void DISABLED_testDownloadSourcesWithFunnyChars() throws Exception {
		//Test now permantly disabled doesn't look Grails bug getting fixed.
		if (GrailsVersion.V_2_3_.compareTo(GrailsVersion.MOST_RECENT) > 0) {
			//This is known to be broken in Grails 2.0.3:
			//See http://jira.grails.org/browse/GRAILS-8955
			return; 
		}
		if (GrailsVersion.MOST_RECENT.equals(GrailsVersion.V_2_3_0_RC1)) {
			//Yep still broken in 2.3 RC1
			return; 
		}
		GrailsVersion version = GrailsVersion.MOST_RECENT;
		doTestDownloadSources(File.createTempFile("a name with spaces", "xml"), version);
		doTestDownloadSources(File.createTempFile("with \\ and space", "xml"), version);
	}

    /**
     * A test running the Grails command used for downloading
     * @throws Exception
     */
    public void DISABLED_testDownloadSources() throws Exception {
        if (GrailsVersion.V_2_3_.compareTo(GrailsVersion.MOST_RECENT) > 0) {
			//This is known to be broken in Grails 2.0.3:
			//See http://jira.grails.org/browse/GRAILS-8955
			return; 
		}
        if (GrailsVersion.MOST_RECENT.equals(GrailsVersion.V_2_3_0_RC1)) {
			//Yep still broken in 2.3 RC1
			return; 
		}
		GrailsVersion version = GrailsVersion.MOST_RECENT;
		doTestDownloadSources(File.createTempFile("dependencies", "xml"), version);
    }

    private void doTestDownloadSources(File target, GrailsVersion version) throws Exception {
        if (version.compareTo(GrailsVersion.V_2_0_0) >= 0) {
            ensureDefaultGrailsVersion(version);
            final String projectName = TEST_PROJECT_NAME;
            project = ensureProject(projectName);
            GrailsCommand cmd = GrailsCommand.forTest(project, "refresh-dependencies");
            cmd.addArgument("--include-source");
            // cmd.addArgument("--include-javadoc");
            cmd.addArgument(target.getAbsolutePath());

            ILaunchResult result = cmd.synchExec();
            assertTrue(result.isOK());

            Map<String, Dependency> data = PerProjectAttachementsCache.parseData(target);
            assertTrue(data != null && !data.isEmpty());
        }
    }

    
    /**
     * Quick test of the method that retrieves the spring-loaded jar File from
     * a Grails install.
     */
    public void testSpringLoadedJar() throws Exception {
        GrailsVersion version = GrailsVersion.MOST_RECENT;
        ensureDefaultGrailsVersion(version);
        if (version.compareTo(GrailsVersion.V_2_0_0)>=0) {
            //Only applicable from Grails 1.4 and up.
            IGrailsInstall install = GrailsVersion.MOST_RECENT.getInstall();
            File jar = install.getSpringLoadedJar();
            assertNotNull(jar);
            assertTrue(jar.exists());
            assertTrue(jar.isAbsolute());
            assertTrue(jar.getName().endsWith(".jar"));
            assertTrue(jar.getName().startsWith("springloaded-"));
        }
    }

    /**
     * Execute a command that is not associated with any project (yet).
     */
    public void testCreateApp() throws Exception {
        ensureProject(TEST_PROJECT_NAME);
    }

    /**
     * Tests creation of a plugin project
     */
    public void testCreatePlugin() throws Exception {
        ensureProject(TEST_PROJECT_NAME+"-plugin", true);
    }
 }