MixinModelManipulationTests.java

/*******************************************************************************
 * Copyright (c) 2005, 2016 IBM Corporation and others.
 * 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
 *
 *******************************************************************************/
package org.eclipse.dltk.ruby.core.tests.search.mixin;

import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.dltk.core.DLTKCore;
import org.eclipse.dltk.core.IBuildpathEntry;
import org.eclipse.dltk.core.IProjectFragment;
import org.eclipse.dltk.core.IScriptFolder;
import org.eclipse.dltk.core.ISourceModule;
import org.eclipse.dltk.core.mixin.IMixinElement;
import org.eclipse.dltk.core.mixin.MixinModel;
import org.eclipse.dltk.core.tests.model.AbstractDLTKSearchTests;
import org.eclipse.dltk.ruby.core.RubyLanguageToolkit;
import org.eclipse.dltk.ruby.core.tests.Activator;

/**
 * Tests for mixin model. Checks operations with a source modules and
 * buildpaths. For model building tests see AutoMixinTests.
 * 
 * Warning! Tests results depends of test execution order cause tests modifies a
 * project.
 * 
 * @author fourdman
 * 
 */
public class MixinModelManipulationTests extends AbstractDLTKSearchTests {
	private static final String PROJECT_NAME = "mixins";

	public MixinModelManipulationTests(String name) {
		super(Activator.PLUGIN_ID, name);
	}

	public static Suite suite() {
		return new Suite(MixinModelManipulationTests.class);
	}

	@Override
	protected void setUp() throws Exception {
		super.setUp();
		SCRIPT_PROJECT = setUpScriptProject(PROJECT_NAME);
		waitUntilIndexesReady();
	}

	@Override
	protected void tearDown() throws Exception {
		if (SCRIPT_PROJECT != null) {
			deleteProject(SCRIPT_PROJECT.getElementName());
		}
		super.tearDown();
	}

	public void REM_testTotalKeysCount() {
		MixinModel model = new MixinModel(RubyLanguageToolkit.getDefault());
		String[] keys = model.findKeys("*", new NullProgressMonitor());
		assertEquals(26, keys.length);
	}

	// If fails, call ghostbusters, please
	public void testForGhosts() {
		MixinModel model = new MixinModel(RubyLanguageToolkit.getDefault());
		String[] keys = model.findKeys("*ghost*", new NullProgressMonitor());
		assertEquals(0, keys.length);
	}

	public void testModuleDeletion() throws Exception {
		MixinModel model = new MixinModel(RubyLanguageToolkit.getDefault());

		IMixinElement mixinElement = model.get("Foo");
		assertNotNull(mixinElement);
		Object[] objs = mixinElement.getAllObjects();
		assertNotNull(objs);
		assertEquals(2, objs.length);

		ISourceModule sourceModule = getSourceModule(PROJECT_NAME, "src",
				"src2.rb");
		sourceModule.delete(true, null);

		waitUntilIndexesReady();

		Object objs2[] = mixinElement.getAllObjects();
		assertEquals(1, objs2.length);
	}

	public void testProjectFragmentDeletion() throws Exception {
		MixinModel model = new MixinModel(RubyLanguageToolkit.getDefault());

		assertEquals(1, model.find("Foo", new NullProgressMonitor()).length);
		IMixinElement mixinElement = model.get("Foo");
		assertNotNull(mixinElement);
		Object[] objs = mixinElement.getAllObjects();
		assertNotNull(objs);
		assertEquals(2, objs.length);

		getProjectFragment(PROJECT_NAME, "src").delete(
				IResource.KEEP_HISTORY,
				IProjectFragment.ORIGINATING_PROJECT_BUILDPATH
						| IProjectFragment.OTHER_REFERRING_PROJECTS_BUILDPATH,
				null);
		waitUntilIndexesReady();

		assertEquals(0, model.find("Foo", new NullProgressMonitor()).length);
		mixinElement = model.get("Foo");
		assertNull(mixinElement);
	}

	public void testSourceFolderDeletion() throws Exception {
		MixinModel model = new MixinModel(RubyLanguageToolkit.getDefault());

		assertEquals(1, model.find("Folder", new NullProgressMonitor()).length);
		IMixinElement mixinElement = model.get("Folder");
		assertNotNull(mixinElement);
		Object[] objs = mixinElement.getAllObjects();
		assertNotNull(objs);
		assertEquals(2, objs.length);

		getScriptFolder(PROJECT_NAME, "src", new Path("folder1")).delete(true,
				null);
		waitUntilIndexesReady();
		getScriptFolder(PROJECT_NAME, "src", new Path("folder2")).delete(true,
				null);
		waitUntilIndexesReady();

		assertEquals(0, model.find("Folder", new NullProgressMonitor()).length);
		mixinElement = model.get("Folder");
		assertNull(mixinElement);
	}

	public void testFatalModuleDeletion() throws Exception {
		MixinModel model = new MixinModel(RubyLanguageToolkit.getDefault());

		IMixinElement mixinElement = model.get("D");
		assertNotNull(mixinElement);
		Object[] objs = mixinElement.getAllObjects();
		assertNotNull(objs);
		assertEquals(2, objs.length);

		ISourceModule sourceModule = getSourceModule(PROJECT_NAME, "src",
				"src1.rb");
		sourceModule.delete(true, null);

		waitUntilIndexesReady();

		mixinElement = model.get("D");

		assertNull(mixinElement);
	}

	public void testExistentClassExtension() throws Exception {
		MixinModel model = new MixinModel(RubyLanguageToolkit.getDefault());

		IMixinElement mixinElement = model.get("Foo");
		assertNotNull(mixinElement);
		Object[] objs = mixinElement.getAllObjects();
		assertEquals(2, objs.length);

		IScriptFolder scriptFolder = getScriptFolder(PROJECT_NAME, "src",
				new Path(""));
		String contents = "class Foo\n def bar\n end\n end\n";
		scriptFolder.createSourceModule("MoreFoo.rb", contents, true, null);

		waitUntilIndexesReady();

		mixinElement = model.get("Foo");
		Object objs2[] = mixinElement.getAllObjects();
		assertEquals(3, objs2.length);
	}

	public void testNewClassAddition() throws Exception {
		MixinModel model = new MixinModel(RubyLanguageToolkit.getDefault());

		IMixinElement mixinElement = model.get("Buzzy");
		assertNull(mixinElement);

		IScriptFolder scriptFolder = getScriptFolder(PROJECT_NAME, "src",
				new Path(""));
		String contents = "class Buzzy\n" + "    def myFyb\n " + "    end\n "
				+ "end\n";

		scriptFolder.createSourceModule("Buzzy.rb", contents, true, null);

		waitUntilIndexesReady();

		mixinElement = model.get("Buzzy");
		assertNotNull(mixinElement);
		Object objs2[] = mixinElement.getAllObjects();
		assertEquals(1, objs2.length);
	}

	public void testBuildpathAddition() throws Exception {
		MixinModel model = new MixinModel(RubyLanguageToolkit.getDefault());
		IMixinElement mixinElement = model.get("Cat");
		assertNull(mixinElement);

		IBuildpathEntry[] rawBuildpath = SCRIPT_PROJECT.getRawBuildpath();
		IBuildpathEntry[] newRawBuildpath = new IBuildpathEntry[rawBuildpath.length + 1];
		System.arraycopy(rawBuildpath, 0, newRawBuildpath, 0,
				rawBuildpath.length);
		newRawBuildpath[rawBuildpath.length] = DLTKCore
				.newSourceEntry(new Path("/mixins/src3"));
		SCRIPT_PROJECT.setRawBuildpath(newRawBuildpath, null);

		waitUntilIndexesReady();

		mixinElement = model.get("Cat");
		assertNotNull(mixinElement);
		Object[] allObjects = mixinElement.getAllObjects();
		assertTrue(allObjects.length > 0);
	}

	public void testBuildpathDeletion() throws Exception {
		MixinModel model = new MixinModel(RubyLanguageToolkit.getDefault());
		IMixinElement mixinElement = model.get("Dragon");
		assertNotNull(mixinElement);
		Object[] objs = mixinElement.getAllObjects();
		assertNotNull(objs);

		IBuildpathEntry[] rawBuildpath = SCRIPT_PROJECT.getRawBuildpath();
		IBuildpathEntry[] newRawBuildpath = new IBuildpathEntry[rawBuildpath.length - 1];
		boolean found = false;
		for (int i = 0, j = 0; i < rawBuildpath.length; i++) {
			if (!rawBuildpath[i].getPath().toString().endsWith("src2")) {
				newRawBuildpath[j++] = rawBuildpath[i];
			} else {
				found = true;
			}
		}
		assertTrue("Buildpath should contain source folder src2", found);

		SCRIPT_PROJECT.setRawBuildpath(newRawBuildpath, null);

		waitUntilIndexesReady();

		mixinElement = model.get("Dragon");
		assertNull(mixinElement);
	}

}