ZBuildGuidesTest.java

/*******************************************************************************
 *  Copyright (c) 2013, 2016 GoPivotal, 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:
 *      GoPivotal, Inc. - initial API and implementation
 *******************************************************************************/
package org.springsource.ide.eclipse.commons.gettingstarted.tests;

import static org.springsource.ide.eclipse.commons.tests.util.StsTestUtil.assertNoErrors;
import static org.springsource.ide.eclipse.commons.tests.util.StsTestUtil.getProject;

import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.springframework.ide.eclipse.boot.wizard.content.BuildType;
import org.springframework.ide.eclipse.boot.wizard.content.CodeSet;
import org.springframework.ide.eclipse.boot.wizard.content.GithubRepoContent;
import org.springframework.ide.eclipse.boot.wizard.importing.ImportConfiguration;
import org.springframework.ide.eclipse.boot.wizard.importing.ImportStrategy;
import org.springframework.ide.eclipse.boot.wizard.importing.ImportUtils;
import org.springsource.ide.eclipse.commons.tests.util.StsTestUtil;
import org.springsource.ide.eclipse.gradle.core.util.ExceptionUtil;
import org.springsource.ide.eclipse.gradle.core.util.GradleRunnable;

import junit.framework.Test;
import junit.framework.TestSuite;

/**
 * An instance of this test verifies that a codesets for a given
 * guide imports and builds cleanly with with a given build
 * tool.
 * <p>
 * A static suite method is provided to create a suite that has
 * a test instance for each valid guide, codeset and buildtool
 * combination.
 *
 * @author Kris De Volder
 */
public class ZBuildGuidesTest extends GuidesTestCase {

	//Note the funny name of this class is an attempt to
	// show test results at the bottom on bamboo builds.
	// It looks like the tests reports are getting sorted
	// alphabetically.

	private CodeSet codeset;
	private ImportStrategy importStrategy;

	public ZBuildGuidesTest(GithubRepoContent guide, CodeSet codeset, ImportStrategy importStrategy) {
		super(guide);
		setName(getName()+"-"+codeset.getName()+"-"+importStrategy);
		this.codeset = codeset;
		this.importStrategy = importStrategy;
	}

	@Override
	protected void setUp() throws Exception {
		super.setUp();
		StsTestUtil.setAutoBuilding(false);
		//System.out.println(">>> Setting up "+getName());
		//Clean stuff from previous test: Delete any projects and their contents.
		// We need to do this because imported maven and gradle projects will have the same name.
		// And this cause clashes / errors.
		buildJob(new GradleRunnable("delete existing workspace projects") {
			public void doit(IProgressMonitor mon) throws Exception {
				IProject[] allProjects = ResourcesPlugin.getWorkspace().getRoot().getProjects();
				for (IProject project : allProjects) {
					project.refreshLocal(IResource.DEPTH_INFINITE, null);
					project.delete(/*content*/true, /*force*/true, new NullProgressMonitor());
				}
			}
		});
		//System.out.println("<<< Setting up "+getName());
	}

	@Override
	protected void runTest() throws Throwable {
		//System.out.println(">>> Running "+getName());

		try {
			System.out.println("=== codeset build test ===");
			System.out.println("guide   : "+guide.getName());
			System.out.println("codeset : "+codeset.getName());
			System.out.println("type    : "+importStrategy);
			System.out.println();

			ImportConfiguration importConf = ImportUtils.importConfig(guide, codeset);
			String projectName = importConf.getProjectName();
			final IRunnableWithProgress importOp = importStrategy.createOperation(importConf);
//			buildJob(new GradleRunnable("import "+guide.getName() + " " + codeset.getName() + " "+buildType) {
//				@Override
//				public void doit(IProgressMonitor mon) throws Exception {
					importOp.run(new NullProgressMonitor());
//				}
//			});

			//TODO: we are not checking if there are extra projects beyond the expected one.
			IProject project = getProject(projectName);
			assertNoErrors(project);
		} catch (Throwable e) {
			//Shorter stacktrace for somewhat nicer looking test failures on bamboo
			throw ExceptionUtil.getDeepestCause(e);
		} finally {
			//System.out.println("<<< Running "+getName());
		}
	}

	static boolean zipLooksOk(GithubRepoContent g) {
		try {
			GuidesStructureTest.validateZipStructure(g);
			return true;
		} catch (Throwable e) {
//			e.printStackTrace();
		}
		return false;
	}

	public static Test suite() throws Exception {
		TestSuite suite = new TestSuite(ZBuildGuidesTest.class.getName());
		for (GithubRepoContent g : GuidesTests.getGuides()) {
//			if (g.getName().contains("securing-web")) {
//			if (g.getName().contains("accessing-facebook")) {
				if (!g.getName().contains("android") && !g.getName().contains("data-gorm")) {
					//Skipping android tests for now... lots of problems there.
					if (zipLooksOk(g)) {
						//Avoid running build tests for zips that look like they have 'missing parts'
						for (CodeSet cs : g.getCodeSets()) {
							for (BuildType bt : cs.getBuildTypes()) {
								for (ImportStrategy is : bt.getImportStrategies()) {
									//Don't run tests for things we haven't yet implemented support for.
									if (is.isSupported()) {
										GuidesTestCase test = new ZBuildGuidesTest(g, cs, is);
										suite.addTest(test);
									}
								}
							}
						}
					}
				}
//			}
		}
		return suite;
	}

}