apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/usage/Java5MethodUsageTests.java

/*******************************************************************************
 * Copyright (c) 2009, 2018 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.pde.api.tools.builder.tests.usage;

import org.eclipse.jdt.core.JavaCore;
import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem;

import junit.framework.Test;

/**
 * Tests Java 5 method accesses
 *
 * @since 1.0.1
 */
public class Java5MethodUsageTests extends MethodUsageTests {

	protected static final String GENERIC_METHOD_CLASS_NAME = "GenericMethodUsageClass<T>"; //$NON-NLS-1$
	protected static final String GENERIC_METHOD_CLASS_NAME2 = "GenericMethodUsageClass2"; //$NON-NLS-1$
	protected static final String METHOD_ENUM_NAME = "MethodUsageEnum"; //$NON-NLS-1$

	public Java5MethodUsageTests(String name) {
		super(name);
	}

	/**
	 * @return the test class for this suite
	 */
	public static Test suite() {
		return buildTestSuite(Java5MethodUsageTests.class);
	}

	@Override
	protected String getTestCompliance() {
		return JavaCore.VERSION_1_5;
	}

	@Override
	public void testMethodUsageTests1F() {
		x1(false);
	}

	@Override
	public void testMethodUsageTests1I() {
		x1(true);
	}

	/**
	 * Tests that accessing restricted enum methods are properly reported
	 */
	private void x1(boolean inc) {
		int[] pids = new int[] {
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
		};
		setExpectedProblemIds(pids);
		String typename = "testM5"; //$NON-NLS-1$
		String[][] args = new String[][] {
				{METHOD_ENUM_NAME, INNER_NAME1, "m1()"}, //$NON-NLS-1$
				{METHOD_ENUM_NAME, INNER_NAME1, "m3()"}, //$NON-NLS-1$
				{METHOD_ENUM_NAME, INNER_NAME1, "m4()"}, //$NON-NLS-1$
				{METHOD_ENUM_NAME, INNER_NAME2, "m1()"}, //$NON-NLS-1$
				{METHOD_ENUM_NAME, INNER_NAME2, "m3()"}, //$NON-NLS-1$
				{METHOD_ENUM_NAME, INNER_NAME2, "m4()"}, //$NON-NLS-1$
				{METHOD_ENUM_NAME, OUTER_NAME, "m1()"}, //$NON-NLS-1$
				{METHOD_ENUM_NAME, OUTER_NAME, "m3()"}, //$NON-NLS-1$
				{METHOD_ENUM_NAME, OUTER_NAME, "m4()"} //$NON-NLS-1$
		};
		setExpectedMessageArgs(args);
		setExpectedLineMappings(new LineMapping[] {
				new LineMapping(25, pids[0], args[0]),
				new LineMapping(27, pids[1], args[1]),
				new LineMapping(28, pids[2], args[2]),
				new LineMapping(37, pids[3], args[3]),
				new LineMapping(39, pids[4], args[4]),
				new LineMapping(40, pids[5], args[5]),
				new LineMapping(50, pids[6], args[6]),
				new LineMapping(52, pids[7], args[7]),
				new LineMapping(53, pids[8], args[8])
		});
		deployUsageTest(typename, inc);
	}

	@Override
	public void testMethodUsageTests2F() {
		x2(false);
	}

	@Override
	public void testMethodUsageTests2I() {
		x2(true);
	}

	/**
	 * Tests that accessing restricted generic methods are properly reported
	 */
	private void x2(boolean inc) {
		int[] pids = new int[] {
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
		};
		setExpectedProblemIds(pids);
		String typename = "testM6"; //$NON-NLS-1$
		String[][] args = new String[][] {
				{GENERIC_METHOD_CLASS_NAME, INNER_NAME1, "m1()"}, //$NON-NLS-1$
				{GENERIC_METHOD_CLASS_NAME, INNER_NAME1, "m2(T)"}, //$NON-NLS-1$
				{GENERIC_METHOD_CLASS_NAME, INNER_NAME2, "m1()"}, //$NON-NLS-1$
				{GENERIC_METHOD_CLASS_NAME, INNER_NAME2, "m2(T)"}, //$NON-NLS-1$
				{GENERIC_METHOD_CLASS_NAME, OUTER_NAME, "m1()"}, //$NON-NLS-1$
				{GENERIC_METHOD_CLASS_NAME, OUTER_NAME, "m2(T)"}, //$NON-NLS-1$
		};
		setExpectedMessageArgs(args);
		setExpectedLineMappings(new LineMapping[] {
				new LineMapping(26, pids[0], args[0]),
				new LineMapping(28, pids[1], args[1]),
				new LineMapping(38, pids[2], args[2]),
				new LineMapping(40, pids[3], args[3]),
				new LineMapping(51, pids[4], args[4]),
				new LineMapping(53, pids[5], args[5])
		});
		deployUsageTest(typename, inc);
	}

	@Override
	public void testMethodUsageTests3F() {
		x3(false);
	}

	@Override
	public void testMethodUsageTests3I() {
		x3(true);
	}

	/**
	 * Tests that accessing restricted methods that has a generic type as a parameter
	 * are properly reported
	 */
	private void x3(boolean inc) {
		int[] pids = new int[] {
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
				getProblemId(IApiProblem.ILLEGAL_REFERENCE, IApiProblem.METHOD),
		};
		setExpectedProblemIds(pids);
		String typename = "testM7"; //$NON-NLS-1$
		String[][] args = new String[][] {
				{GENERIC_METHOD_CLASS_NAME2, INNER_NAME1, "m1(GenericClassUsageClass<?>)"}, //$NON-NLS-1$
				{GENERIC_METHOD_CLASS_NAME2, INNER_NAME2, "m1(GenericClassUsageClass<?>)"}, //$NON-NLS-1$
				{GENERIC_METHOD_CLASS_NAME2, OUTER_NAME, "m1(GenericClassUsageClass<?>)"}, //$NON-NLS-1$
		};
		setExpectedMessageArgs(args);
		setExpectedLineMappings(new LineMapping[] {
				new LineMapping(25, pids[0], args[0]),
				new LineMapping(34, pids[1], args[1]),
				new LineMapping(44, pids[2], args[2])
		});
		deployUsageTest(typename, inc);
	}
}