org.springframework.ide.eclipse.gettingstarted.tests.ZBuildGuidesTest.java Source code

Introduction

Here is the source code for org.springframework.ide.eclipse.gettingstarted.tests.ZBuildGuidesTest.java

Source

/*******************************************************************************
 *  Copyright (c) 2013 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.springframework.ide.eclipse.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 java.util.List;

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

import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Platform;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.springframework.ide.eclipse.gettingstarted.content.BuildType;
import org.springframework.ide.eclipse.gettingstarted.content.CodeSet;
import org.springframework.ide.eclipse.gettingstarted.guides.GettingStartedGuide;
import org.springframework.ide.eclipse.gettingstarted.importing.ImportUtils;
import org.springsource.ide.eclipse.gradle.core.util.ExceptionUtil;

/**
 * An instace 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 BuildType buildType;

    public ZBuildGuidesTest(GettingStartedGuide guide, CodeSet codeset, BuildType buildType) {
        super(guide);
        setName(getName() + "-" + codeset.getName() + "-" + buildType);
        this.codeset = codeset;
        this.buildType = buildType;
    }

    @Override
    protected void setUp() throws Exception {
        super.setUp();
        //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.

        IProject[] allProjects = ResourcesPlugin.getWorkspace().getRoot().getProjects();
        for (IProject project : allProjects) {
            project.refreshLocal(IResource.DEPTH_INFINITE, null);
            project.delete(/*content*/true, /*force*/true, new NullProgressMonitor());
        }
    }

    @Override
    protected void runTest() throws Throwable {
        try {
            System.out.println("=== codeset build test ===");
            System.out.println("guide   : " + guide.getName());
            System.out.println("codeset : " + codeset.getName());
            System.out.println("type    : " + buildType);
            System.out.println();

            String projectName = guide.getName() + "-" + codeset.getName();
            IRunnableWithProgress importOp = buildType.getImportStrategy()
                    .createOperation(ImportUtils.importConfig(guide, codeset));

            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);
        }

    }

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

    public static Test suite() throws Exception {
        TestSuite suite = new TestSuite(ZBuildGuidesTest.class.getName());
        for (GettingStartedGuide g : GuidesTests.getGuides()) {
            if (zipLooksOk(g)) {
                //Avoid running build tests for zips that look like they have 'missing parts'
                for (CodeSet cs : g.getCodeSets()) {
                    List<BuildType> buildTypes = cs.getBuildTypes();
                    for (BuildType bt : buildTypes) {
                        //Don't run tests for things we haven't yet implemented support for.
                        if (bt.getImportStrategy().isSupported()) {
                            GuidesTestCase test = new ZBuildGuidesTest(g, cs, bt);
                            suite.addTest(test);
                        }
                    }
                }
            }
        }
        return suite;
    }

}