apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/reference/tests/SearchScopeTests.java

/*******************************************************************************
 * Copyright (c) 2007, 2009 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
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.pde.api.tools.reference.tests;

import java.util.Collection;
import java.util.HashSet;

import junit.framework.TestCase;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.pde.api.tools.internal.provisional.Factory;
import org.eclipse.pde.api.tools.internal.provisional.descriptors.IPackageDescriptor;
import org.eclipse.pde.api.tools.internal.provisional.descriptors.IReferenceTypeDescriptor;
import org.eclipse.pde.api.tools.internal.provisional.model.ApiTypeContainerVisitor;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiBaseline;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiComponent;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeContainer;
import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeRoot;
import org.eclipse.pde.api.tools.model.tests.TestSuiteHelper;

/**
 * Tests search scopes.
 * 
 * @since 1.0.0
 */
public class SearchScopeTests extends TestCase {
	
	/**
	 * Tests that visiting a scope with whole components is the same as visiting
	 * the components.
	 * 
	 * @throws CoreException
	 */
	public void testVisitEntireComponentsScope() throws CoreException {
		IApiBaseline profile = TestSuiteHelper.createTestingBaseline("test-plugins");
		IApiComponent componentA = profile.getApiComponent("component.a");
		IApiComponent componentB = profile.getApiComponent("component.b");
		IApiComponent[] components = new IApiComponent[]{componentA, componentB};
		IApiTypeContainer scope = Factory.newScope(components);
		Collection<String> expectedPackages = new HashSet<String>();
		Collection<String> expectedTypes = new HashSet<String>();
		visit(componentA, expectedPackages, expectedTypes);
		visit(componentB, expectedPackages, expectedTypes);
		Collection<String> actualPackages = new HashSet<String>();
		Collection<String> actualTypes = new HashSet<String>();
		visit(scope, actualPackages, actualTypes);
		assertEquals("Different packages", expectedPackages, actualPackages);
		assertEquals("Different types", expectedTypes, actualTypes);
	}

	/**
	 * Visits all classes files in the container, add visited packages and types to the
	 * given collections.
	 * 
	 * @param container
	 * @param packageNames
	 * @param typeNames
	 * @throws CoreException 
	 */
	private void visit(IApiTypeContainer container, final Collection<String> packageNames, final Collection<String> typeNames) throws CoreException {
		ApiTypeContainerVisitor visitor = new ApiTypeContainerVisitor() {
		
			public boolean visitPackage(String packageName) {
				packageNames.add(packageName);
				return true;
			}
		
			public void visit(String packageName, IApiTypeRoot classFile) {
				typeNames.add(classFile.getTypeName());
			}
		};
		container.accept(visitor);
	}
	
	/**
	 * Tests visiting a type scope - type A in package component.a in component.a
	 * 
	 * @throws CoreException
	 */
	public void testVisitTypeScope() throws CoreException {
		IApiBaseline profile = TestSuiteHelper.createTestingBaseline("test-plugins");
		IApiComponent componentA = profile.getApiComponent("component.a");
		IPackageDescriptor pkg = Factory.packageDescriptor("component.a");
		IReferenceTypeDescriptor type = pkg.getType("A");
		IApiTypeContainer scope = Factory.newTypeScope(componentA, new IReferenceTypeDescriptor[]{type});
		Collection<String> expectedPackages = new HashSet<String>();
		expectedPackages.add("component.a");
		Collection<String> expectedTypes = new HashSet<String>();
		expectedTypes.add("component.a.A");
		Collection<String> actualPackages = new HashSet<String>();
		Collection<String> actualTypes = new HashSet<String>();
		visit(scope, actualPackages, actualTypes);
		assertEquals("Different packages", expectedPackages, actualPackages);
		assertEquals("Different types", expectedTypes, actualTypes);
	}	
	
	/**
	 * Tests that visiting a scope with two class files.
	 * 
	 * @throws CoreException
	 */
	public void testVisitSpecificTypes() throws CoreException {
		IApiBaseline profile = TestSuiteHelper.createTestingBaseline("test-plugins");
		IApiComponent componentA = profile.getApiComponent("component.a");
		Collection<String> expectedPackages = new HashSet<String>();
		expectedPackages.add("a.b.c");
		expectedPackages.add("component.a");
		Collection<String> expectedTypes = new HashSet<String>();
		IReferenceTypeDescriptor one = Factory.typeDescriptor("a.b.c.Generics");
		IReferenceTypeDescriptor two = Factory.typeDescriptor("component.a.NoExtendClass");
		expectedTypes.add(one.getQualifiedName());
		expectedTypes.add(two.getQualifiedName());
		IApiTypeContainer scope = Factory.newTypeScope(componentA, new IReferenceTypeDescriptor[]{one, two});
		Collection<String> actualPackages = new HashSet<String>();
		Collection<String> actualTypes = new HashSet<String>();
		visit(scope, actualPackages, actualTypes);
		assertEquals("Different packages", expectedPackages, actualPackages);
		assertEquals("Different types", expectedTypes, actualTypes);
	}
	
}