HardwareManagerManifestLoaderTest.java

/**
 * Copyright (C) 2013 Colorado School of Mines
 *
 * This file is part of the Interface Software Development Kit (SDK).
 *
 * The InterfaceSDK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * The InterfaceSDK is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with the InterfaceSDK.  If not, see <http://www.gnu.org/licenses/>.
 */
package edu.mines.acmX.exhibit.input_services.hardware;

import static org.junit.Assert.assertTrue;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.junit.Test;

/**
 * JUnit tests only for loading the manifest file for the HardwareManager.
 * 
 * @author Aakash Shah
 * @author Ryan Stauffer
 *
 * @see {@link HardwareManagerManifestLoader}
 */
public class HardwareManagerManifestLoaderTest {
	
	private static Logger log = LogManager.getLogger(HardwareManagerManifestLoaderTest.class.getName());
	
	public static final String BASE_FILE = "input_services/";
	
	/**
	 * Compares the expected HardwareManagerMetaData against one loaded from
	 * the manifest file.
	 * @throws HardwareManagerManifestException not expected
	 */
	@Test
	public void testLoadingGoodManifest()
			throws HardwareManagerManifestException {
		HardwareManagerMetaData hmd =
				HardwareManagerManifestLoader.load(BASE_FILE + "GoodCompleteManifest.xml");
		
		assertTrue(hmd != null);
		
		HardwareManagerMetaData expected = new HardwareManagerMetaData();
		Map<String, String> functionalities = new HashMap<String, String>();
		Map<String, String> devices = new HashMap<String, String>();
		Map<String, List<String>> deviceSupports = new HashMap<String, List<String>>();
		
		functionalities.put("depth", "edu.mines.acmX.exhibit.input_services.hardware.devicedata.DepthImageInterface");
		functionalities.put("rgbimage","edu.mines.acmX.exhibit.input_services.hardware.devicedata.RGBImageInterface");
		functionalities.put("handtracking", "edu.mines.acmX.exhibit.input_services.hardware.devicedata.HandTrackerInterface");
		expected.setFunctionalities(functionalities);
		
		devices.put("kinectopenni", "edu.mines.acmX.exhibit.input_services.hardware.drivers.openni.KinectOpenNIDriver");
		expected.setDevices(devices);
		
		List<String> supports = new ArrayList<String>();
		supports.add("rgbimage");
		supports.add("depth");
		supports.add("handtracking");
		deviceSupports.put("kinectopenni", supports);
		expected.setDeviceSupports(deviceSupports);

		assertTrue(hmd.getDevices().equals(devices));
		assertTrue(hmd.getDeviceSupports().equals(deviceSupports));
		assertTrue(hmd.getFunctionalities().equals(functionalities));
		assertTrue(hmd.equals(expected));
		
	}
	
	/**
	 * Tests for duplicate names in the <functionalities> tag.
	 * @throws HardwareManagerManifestException expected
	 */
	@Test(expected=HardwareManagerManifestException.class)
	public void testNameConflict() throws HardwareManagerManifestException {
		HardwareManagerManifestLoader.load(BASE_FILE + "BadNameConflictAttribute.xml");
	}
	
	/**
	 * Tests for when no <functionalities> tag exists.
	 * @throws HardwareManagerManifestException expected
	 */
	@Test(expected=HardwareManagerManifestException.class)
	public void testNoFunctionalities() throws HardwareManagerManifestException  {
		HardwareManagerManifestLoader.load(BASE_FILE + "BadNoFunctionalities.xml");
	}

	/**
	 * Tests for when no <devices> tag exists.
	 * @throws HardwareManagerManifestException expected
	 */
	@Test(expected=HardwareManagerManifestException.class)
	public void testNoDevicesTag() throws HardwareManagerManifestException  {
		HardwareManagerManifestLoader.load(BASE_FILE + "BadNoDevices.xml");
	}

	/**
	 * Tests for when no <manifest> tag exists.
	 */
	@Test(expected=HardwareManagerManifestException.class)
	public void testNoManifestTag() throws HardwareManagerManifestException  {
		HardwareManagerManifestLoader.load(BASE_FILE + "BadNoManifest.xml");
	}

	/**
	 * Tests for when the <support> tag is missing an attribute
	 * @throws HardwareManagerManifestException expected
	 */
	@Test(expected=HardwareManagerManifestException.class)
	public void testMissingAttribute() throws HardwareManagerManifestException  {
		HardwareManagerManifestLoader.load(BASE_FILE + "BadMissingAttribute.xml");
	}

	/**
	 * Tests for when the interface attribute is missing
	 * @throws HardwareManagerManifestException expected
	 */
	@Test(expected=HardwareManagerManifestException.class)
	public void testMissingFunctionalityInterface() throws HardwareManagerManifestException  {
		HardwareManagerManifestLoader.load(BASE_FILE + "BadMissingFunctionalityInterface.xml");
	}

	/**
	 * Tests for when no <device> tag exists.
	 * @throws HardwareManagerManifestException expected
	 */
	@Test(expected=HardwareManagerManifestException.class)
	public void testNoDeviceTag() throws HardwareManagerManifestException  {
		HardwareManagerManifestLoader.load(BASE_FILE + "BadNoDevice.xml");
	}

	/**
	 * Tests for when no <supports> tag exists.
	 * @throws HardwareManagerManifestException expected
	 */
	@Test(expected=HardwareManagerManifestException.class)
	public void testNoSupportsTag() throws HardwareManagerManifestException  {
		HardwareManagerManifestLoader.load(BASE_FILE + "BadNoSupports.xml");
	}
}