package junit.framework;

/*-
 * #%L
 * org.eclipse.jdt.ui.junit.sampleproject
 * %%
 * Copyright (C) 2020 Eclipse Foundation
 * %%
 * This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v. 1.0 which accompanies this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 * #L%
 */

import java.lang.reflect.*;

/**
 * A test case defines the fixture to run multiple tests. To define a test
 * case<br>
 * 1) implement a subclass of TestCase<br>
 * 2) define instance variables that store the state of the fixture<br>
 * 3) initialize the fixture state by overriding <code>setUp</code><br>
 * 4) clean-up after a test by overriding <code>tearDown</code>.<br>
 * Each test runs in its own fixture so there can be no side effects among test
 * runs. Here is an example:
 * 
 * <pre>
 * public class MathTest extends TestCase {
 * 	protected double fValue1;
 * 	protected double fValue2;
 *
 * 	protected void setUp() {
 * 		fValue1 = 2.0;
 * 		fValue2 = 3.0;
 * 	}
 * }
 * </pre>
 *
 * For each test implement a method which interacts with the fixture. Verify the
 * expected results with assertions specified by calling <code>assertTrue</code>
 * with a boolean.
 * 
 * <pre>
 * public void testAdd() {
 * 	double result = fValue1 + fValue2;
 * 	assertTrue(result == 5.0);
 * }
 * </pre>
 * 
 * Once the methods are defined you can run them. The framework supports both a
 * static type safe and more dynamic way to run a test. In the static way you
 * override the runTest method and define the method to be invoked. A convenient
 * way to do so is with an anonymous inner class.
 * 
 * <pre>
 * TestCase test = new MathTest("add") {
 * 	public void runTest() {
 * 		testAdd();
 * 	}
 * };
 * test.run();
 * </pre>
 * 
 * The dynamic way uses reflection to implement <code>runTest</code>. It
 * dynamically finds and invokes a method. In this case the name of the test
 * case has to correspond to the test method to be run.
 * 
 * <pre>
 * TestCase = new MathTest("testAdd");
 * test.run();
 * </pre>
 * 
 * The tests to be run can be collected into a TestSuite. JUnit provides
 * different <i>test runners</i> which can run a test suite and collect the
 * results. A test runner either expects a static method <code>suite</code> as
 * the entry point to get a test to run or it will extract the suite
 * automatically.
 * 
 * <pre>
 * public static Test suite() {
 * 	suite.addTest(new MathTest("testAdd"));
 * 	suite.addTest(new MathTest("testDivideByZero"));
 * 	return suite;
 * }
 * </pre>
 * 
 * @see TestResult
 * @see TestSuite
 */

public abstract class TestCase extends Assert implements Test {
	/**
	 * the name of the test case
	 */
	private String fName;

	/**
	 * No-arg constructor to enable serialization. This method is not intended to be
	 * used by mere mortals without calling setName().
	 */
	public TestCase() {
		fName = null;
	}

	/**
	 * Constructs a test case with the given name.
	 */
	public TestCase(String name) {
		fName = name;
	}

	/**
	 * Counts the number of test cases executed by run(TestResult result).
	 */
	public int countTestCases() {
		return 1;
	}

	/**
	 * Creates a default TestResult object
	 *
	 * @see TestResult
	 */
	protected TestResult createResult() {
		return new TestResult();
	}

	/**
	 * A convenience method to run this test, collecting the results with a default
	 * TestResult object.
	 *
	 * @see TestResult
	 */
	public TestResult run() {
		TestResult result = createResult();
		run(result);
		return result;
	}

	/**
	 * Runs the test case and collects the results in TestResult.
	 */
	public void run(TestResult result) {
		result.run(this);
	}

	/**
	 * Runs the bare test sequence.
	 * 
	 * @exception Throwable if any exception is thrown
	 */
	public void runBare() throws Throwable {
		setUp();
		try {
			runTest();
		} finally {
			tearDown();
		}
	}

	/**
	 * Override to run the test and assert its state.
	 * 
	 * @exception Throwable if any exception is thrown
	 */
	protected void runTest() throws Throwable {
		assertNotNull(fName);
		Method runMethod = null;
		try {
			// use getMethod to get all public inherited
			// methods. getDeclaredMethods returns all
			// methods of this class but excludes the
			// inherited ones.
			runMethod = getClass().getMethod(fName, null);
		} catch (NoSuchMethodException e) {
			fail("Method \"" + fName + "\" not found");
		}
		if (!Modifier.isPublic(runMethod.getModifiers())) {
			fail("Method \"" + fName + "\" should be public");
		}

		try {
			runMethod.invoke(this, new Class[0]);
		} catch (InvocationTargetException e) {
			e.fillInStackTrace();
			throw e.getTargetException();
		} catch (IllegalAccessException e) {
			e.fillInStackTrace();
			throw e;
		}
	}

	/**
	 * Sets up the fixture, for example, open a network connection. This method is
	 * called before a test is executed.
	 */
	protected void setUp() throws Exception {
	}

	/**
	 * Tears down the fixture, for example, close a network connection. This method
	 * is called after a test is executed.
	 */
	protected void tearDown() throws Exception {
	}

	/**
	 * Returns a string representation of the test case
	 */
	public String toString() {
		return getName() + "(" + getClass().getName() + ")";
	}

	/**
	 * Gets the name of a TestCase
	 * 
	 * @return returns a String
	 */
	public String getName() {
		return fName;
	}

	/**
	 * Sets the name of a TestCase
	 * 
	 * @param name The name to set
	 */
	public void setName(String name) {
		fName = name;
	}
}
