/*
 * #%L
 * SciJava Common shared library for SciJava software.
 * %%
 * Copyright (C) 2009 - 2017 Board of Regents of the University of
 * Wisconsin-Madison, Broad Institute of MIT and Harvard, Max Planck
 * Institute of Molecular Cell Biology and Genetics, University of
 * Konstanz, and KNIME GmbH.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package org.scijava.plugin;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertSame;

import java.util.List;

import org.junit.Test;
import org.scijava.Context;

/**
 * Tests {@link PluginIndex}.
 * 
 * @author Curtis Rueden
 */
public class PluginIndexTest {

	/**
	 * Tests {@link PluginService#getPluginsOfClass(Class)}. In particular, it
	 * verifies that the plugin service can retrieve a plugin that does not have
	 * an associated @{@link Plugin} annotation.
	 */
	@Test
	public void testGetPluginsOfClass() {
		// create a minimal SciJava context
		final Context context = new Context(PluginService.class);
		final PluginIndex pluginIndex = context.getPluginIndex();

		// add a plugin to the index
		final PluginInfo<SciJavaPlugin> testPlugin =
			new PluginInfo<>(FooBar.class.getName(), SciJavaPlugin.class);
		pluginIndex.add(testPlugin);

		// retrieve the plugin from the index, by class
		final PluginService pluginService = context.getService(PluginService.class);
		final List<PluginInfo<SciJavaPlugin>> plugins =
			pluginService.getPluginsOfClass(FooBar.class);

		assertEquals(1, plugins.size());
		assertSame(testPlugin, plugins.get(0));

		final PluginInfo<SciJavaPlugin> plugin =
			pluginService.getPlugin(FooBar.class);
		assertSame(testPlugin, plugin);

		context.dispose();
	}

	/**
	 * Tests {@link PluginService#getPluginsOfClass(String)}. In particular, it
	 * verifies that the plugin service can retrieve a plugin that does not have
	 * an associated @{@link Plugin} annotation.
	 */
	@Test
	public void testGetPluginsOfClassString() {
		// create a minimal SciJava context
		final Context context = new Context(PluginService.class);
		final PluginIndex pluginIndex = context.getPluginIndex();

		// add a fake plugin to the index
		final String fakeClass = "foo.bar.FooBar";
		final PluginInfo<SciJavaPlugin> testPlugin =
			new PluginInfo<>(fakeClass, SciJavaPlugin.class);
		pluginIndex.add(testPlugin);

		// retrieve the fake plugin from the index, by class name
		final PluginService pluginService = context.getService(PluginService.class);
		final List<PluginInfo<SciJavaPlugin>> plugins =
			pluginService.getPluginsOfClass(fakeClass);

		assertEquals(1, plugins.size());
		assertSame(testPlugin, plugins.get(0));

		final PluginInfo<SciJavaPlugin> plugin = pluginService.getPlugin(fakeClass);
		assertSame(testPlugin, plugin);

		context.dispose();
	}

	/** A dummy plugin for testing the plugin service. */
	public static class FooBar implements SciJavaPlugin {
		// NB: No implementation needed.
	}

}
