/*
 * The MIT License (MIT)
 * 
 * Copyright (c) 2013 Jeff Nelson, Cinchapi Software Collective
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.cinchapi.concourse;

import org.cinchapi.concourse.testing.Variables;
import org.junit.Rule;
import org.junit.rules.TestWatcher;
import org.junit.runner.Description;

/**
 * The base class for all Concourse tests. ALL Concourse tests should extend
 * this class to ensure that they have proper error handling, cleanup, etc.
 * <p>
 * Each subclass should register local variables using
 * {@link Variables#register(String, Object)} to ensure that they are printed on
 * test failure to help with debugging.
 * <pre>
 * long number = Variables.register("number", TestData.getLong());
 * Assert.assertNotEquals(number, (long) Variables.get("smaller_number"));
 * </pre>
 * </p>
 * 
 * @author jnelson
 */
public abstract class ConcourseBaseTest {

	/**
	 * This watcher clears previously registered {@link Variables} on startup
	 * and dumps them in the event of failure.
	 */
	@Rule
	public final TestWatcher __watcher = new TestWatcher() {

		@Override
		protected void failed(Throwable t, Description description) {
			System.out.println("TEST FAILURE in " + description.getMethodName()
					+ ": " + t.getMessage());
			System.out.println("---");
			System.out.println(Variables.dump());
			System.out.println("");
		}

		@Override
		protected void starting(Description description) {
			Variables.clear();
		}

	};

}

/*
 * The MIT License (MIT)
 * 
 * Copyright (c) 2013 Jeff Nelson, Cinchapi Software Collective
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.cinchapi.concourse;

import org.cinchapi.concourse.testing.Variables;
import org.junit.Rule;
import org.junit.rules.TestWatcher;
import org.junit.runner.Description;

/**
 * The base class for all Concourse tests. ALL Concourse tests should extend
 * this class to ensure that they have proper error handling, cleanup, etc.
 * <p>
 * Each subclass should register local variables using
 * {@link Variables#register(String, Object)} to ensure that they are printed on
 * test failure to help with debugging.
 * 
 * <pre>
 * long number = Variables.register(&quot;number&quot;, TestData.getLong());
 * Assert.assertNotEquals(number, (long) Variables.get(&quot;smaller_number&quot;));
 * </pre>
 * 
 * </p>
 * 
 * @author jnelson
 */
public abstract class ConcourseBaseTest {

	// Initialization for all tests
	static {
		System.setProperty("test", "true");
	}

	/**
	 * This watcher clears previously registered {@link Variables} on startup
	 * and dumps them in the event of failure.
	 */
	@Rule
	public final TestWatcher __watcher = new TestWatcher() {

		@Override
		protected void failed(Throwable t, Description description) {
			System.out.println("TEST FAILURE in " + description.getMethodName()
					+ ": " + t.getMessage());
			System.out.println("---");
			System.out.println(Variables.dump());
			System.out.println("");
		}

		@Override
		protected void starting(Description description) {
			Variables.clear();
		}

	};

}

set system property for each test