D-Net

package eu.dnetlib.enabling.is.store; // NOPMD

import static org.junit.Assert.assertArrayEquals;

import static org.junit.Assert.assertEquals;

import static org.junit.Assert.assertNotNull;

import static org.junit.Assert.assertTrue; // NOPMD

import static org.mockito.Matchers.anyObject;

import static org.mockito.Mockito.doAnswer;

import static org.mockito.Mockito.mock;

import static org.mockito.Mockito.verify;

import static org.mockito.Mockito.when; // NOPMD

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Iterator;

import java.util.List;

import javax.xml.namespace.QName;

import org.apache.cxf.endpoint.Endpoint;

import org.apache.cxf.endpoint.ServerImpl;

import org.apache.cxf.jaxws.EndpointImpl;

import org.apache.cxf.service.Service;

import org.apache.cxf.service.model.EndpointInfo;

import org.junit.After;

import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.mockito.Mock;

import org.mockito.invocation.InvocationOnMock;

import org.mockito.junit.MockitoJUnitRunner;

import org.mockito.stubbing.Answer;

import org.xmldb.api.base.XMLDBException;

import eu.dnetlib.enabling.is.store.rmi.ISStoreException;

import eu.dnetlib.enabling.is.store.rmi.ISStoreService;

import eu.dnetlib.enabling.resultset.LocalResultSetFactoryImpl;

import eu.dnetlib.enabling.resultset.LocalResultSetImpl;

import eu.dnetlib.enabling.resultset.ResultSet;

import eu.dnetlib.enabling.resultset.ResultSetRegistry;

import eu.dnetlib.enabling.resultset.ResultSetServiceImpl;

import eu.dnetlib.soap.cxf.JaxwsEndpointReferenceBuilder;

import eu.dnetlib.soap.cxf.StandaloneCxfEndpointReferenceBuilder;

import eu.dnetlib.xml.database.XMLDatabase;

/**

 * test the ISStore service.

 * 

 * @author marko

 * 

 */

@RunWith(MockitoJUnitRunner.class)

public class ISStoreServiceTest { // NOPMD by marko on 11/24/08 4:54 PM

	/**

	 * root collection name for mocked xmldb.

	 */

	private static final String ROOT_COLLECTION = "/db";

	/**

	 * test resultset id.

	 */

	private static final String SOME_RS_ID = "someRsId";

	/**

	 * some test query.

	 */

	private static final String SOME_QUERY = "someQuery";

	/**

	 * a test collection name.

	 */

	private static final String TEST_COLLECTION = "testCollection";

	/**

	 * a test string value.

	 */

	private static final String ONE = "one";

	/**

	 * another test resultset value.

	 */

	private static final String TWO = "two";

	/**

	 * name of the a test file.

	 */

	private static final String TEST_FILE = "testFile";

	/**

	 * the ISStoreService under test.

	 */

	private transient ISStoreService store = null;

	/**

	 * the ISStoreService under test. Used only in setUp/tearDown().

	 */

	private transient ISStoreServiceImpl ismo = null;

	/**

	 * the XMLDatabase injected into the ISStore.

	 */

	@Mock

	private transient XMLDatabase xdb;

	/**

	 * resultset service mock. needed only for resultset testing.

	 */

	@Mock

	private transient ResultSetServiceImpl resultSetService;

	/**

	 * jaxws endpoint mock. needed for resultset testing.

	 */

	@Mock

	private transient EndpointImpl jaxwsEndpoint;

	/**

	 * cxf server mock. needed for resultset testing.

	 */

	@Mock

	private transient ServerImpl cxfServer;

	/**

	 * cxf endpoint mock. needed for resultset testing.

	 */

	@Mock

	private transient Endpoint endpoint;

	/**

	 * cxf service mock. needed for resultset testing.

	 */

	@Mock

	private transient Service service;

	/**

	 * cxf endpoint info mock. needed for resultset testing.

	 */

	@Mock

	private transient EndpointInfo endpointInfo;

	/**

	 * resultset registry mock. needed for resultset testing.

	 */

	@Mock

	private transient ResultSetRegistry resultSetRegistry;

	/**

	 * hook for inspecting the created resultset object.

	 */

	private transient LocalResultSetImpl resultSetImpl;

	/**

	 * setup the ISStore instance, injecting all the dependencies.

	 * 

	 * @throws Exception

	 *             shouldn't throw

	 */

	@Before

	public void setUp() throws Exception {

		ismo = new ISStoreServiceImpl();

		ismo.setXmlDatabase(xdb);

		ismo.start();

		store = ismo;

	}

	/**

	 * Setup a fake resultset with all the necessary endpoint mocks used to generate an actual W3CEndpoint.

	 */

	public void setUpResultSet() {

		final StandaloneCxfEndpointReferenceBuilder cxfEprBuilder = new StandaloneCxfEndpointReferenceBuilder();

		cxfEprBuilder.setBaseAddress("http://dnetlib.eu");

		final JaxwsEndpointReferenceBuilder eprBuilder = new JaxwsEndpointReferenceBuilder();

		eprBuilder.setBuilder(cxfEprBuilder);

		when(resultSetService.getEprBuilder()).thenReturn(eprBuilder);

		final LocalResultSetFactoryImpl resultSetFactory = new LocalResultSetFactoryImpl();

		resultSetFactory.setResultSetService(resultSetService);

		setUpRSEndpoint();

		when(resultSetService.getEndpoint()).thenReturn(jaxwsEndpoint);

		when(jaxwsEndpoint.getServer()).thenReturn(cxfServer);

		when(cxfServer.getEndpoint()).thenReturn(endpoint);

		when(resultSetService.getResultsetRegistry()).thenReturn(resultSetRegistry);

		doAnswer(new Answer<Void>() {

			@Override

			public Void answer(final InvocationOnMock invocation) throws Throwable {

				resultSetImpl = (LocalResultSetImpl) invocation.getArguments()[0];

				resultSetImpl.setIdentifier(SOME_RS_ID);

				return null;

			}

		}).when(resultSetRegistry).addResultSet((ResultSet) anyObject());

		ismo.setResultSetFactory(resultSetFactory);

	}

	/**

	 * create resultset endpoint.

	 */

	private void setUpRSEndpoint() {

		when(service.getName()).thenReturn(new QName("http://my.test", "TestService"));

		when(endpoint.getEndpointInfo()).thenReturn(endpointInfo);

		when(endpoint.getService()).thenReturn(service);

		when(endpointInfo.getAddress()).thenReturn("http://localhost/something");

		when(endpointInfo.getName()).thenReturn(new QName("http://my.test", "TestServiceEndpoint"));

	}

	/**

	 * respect the service lifecycle.

	 */

	@After

	public void tearDown() {

		ismo.stop();

	}

	/**

	 * create collection.

	 * 

	 * @throws ISStoreException

	 *             shouldn't happen

	 * @throws XMLDBException

	 *             shouldn't happen

	 */

	@Test

	public void testCreateFileColl() throws ISStoreException, XMLDBException {

		assertTrue("create collection", store.createFileColl(TEST_COLLECTION));

		verify(xdb).createCollection(TEST_COLLECTION);

	}

	/**

	 * delete collection.

	 * 

	 * @throws XMLDBException

	 *             shouldn't happen

	 * @throws ISStoreException

	 *             shouldn't happen

	 */

	@Test

	public void testDeleteFileColl() throws XMLDBException, ISStoreException {

		assertTrue("delete collection", store.deleteFileColl(TEST_COLLECTION));

		verify(xdb).removeCollection(TEST_COLLECTION);

	}

	/**

	 * delete an xml file.

	 * 

	 * @throws ISStoreException

	 *             shouldn't happen

	 * @throws XMLDBException

	 *             shouldn't happen

	 */

	@Test

	public void testDeleteXML() throws ISStoreException, XMLDBException {

		when(xdb.remove(TEST_FILE, TEST_COLLECTION)).thenReturn(true);

		assertTrue("delete xml", store.deleteXML(TEST_FILE, TEST_COLLECTION));

		verify(xdb).remove(TEST_FILE, TEST_COLLECTION);

	}

	/**

	 * execute an XUpdate.

	 */

	// @Test

	// public void testExecuteXUpdate() {

	// fail(NYI);

	// }

	/**

	 * get collection names.

	 * 

	 * @throws ISStoreException

	 *             shouldn't happen

	 * @throws XMLDBException

	 *             shouldn't happen

	 */

	@Test

	public void testGetFileColls() throws ISStoreException, XMLDBException {

		final String[] expectedNames = new String[] { "col1", "col2" };

		when(xdb.getRootCollection()).thenReturn(ROOT_COLLECTION);

		when(xdb.listChildCollections(ROOT_COLLECTION)).thenReturn(Arrays.asList(expectedNames));

		final List<String> names = store.getFileColls();

		verify(xdb).getRootCollection();

		assertArrayEquals(expectedNames, names.toArray());

	}

	/**

	 * list file names.

	 * 

	 * @throws ISStoreException

	 *             shouldn't happen

	 * @throws XMLDBException

	 *             shouldn't happen

	 */

	@Test

	public void testGetFileNames() throws ISStoreException, XMLDBException {

		final String[] expectedNames = new String[] { "fil1", "file2", "file3" };

		when(xdb.list(ROOT_COLLECTION)).thenReturn(Arrays.asList(expectedNames));

		final List<String> names = store.getFileNames(ROOT_COLLECTION);

		assertArrayEquals(expectedNames, names.toArray());

	}

	/**

	 * read an xml file.

	 * 

	 * @throws ISStoreException

	 *             shouldn't happen

	 * @throws XMLDBException

	 *             shouldn't happen

	 */

	@Test

	public void testGetXML() throws ISStoreException, XMLDBException {

		when(xdb.read(TEST_FILE, TEST_COLLECTION)).thenReturn("testContent");

		final String res = store.getXML(TEST_FILE, TEST_COLLECTION);

		assertEquals("get xml", "testContent", res);

	}

	/**

	 * read an xml file using a xquery.

	 * 

	 * @throws XMLDBException

	 *             shouldn't happen

	 * @throws ISStoreException

	 *             shouldn't happen

	 */

	@Test

	public void testGetXMLbyQuery() throws XMLDBException, ISStoreException {

		prepareXMLDBResultSet();

		final String res = store.getXMLbyQuery(SOME_QUERY);

		assertEquals("get xml by query", ONE, res);

	}

	/**

	 * helper method. Prepares a common result mock.

	 * 

	 * @throws XMLDBException

	 *             the declaration of this exception is just a syntactic necessity

	 */

	private void prepareXMLDBResultSet() throws XMLDBException {

		List<String> myList = Arrays.asList(ONE,TWO);

		when(xdb.xquery(SOME_QUERY)).thenReturn(myList.iterator());

	}

	/**

	 * insert a new xml file.

	 * 

	 * @throws ISStoreException

	 *             shouldn't happen

	 * @throws XMLDBException

	 *             shouldn't happen

	 */

	@Test

	public void testInsertXML() throws ISStoreException, XMLDBException {

		assertTrue("insert xml", store.insertXML("example", ROOT_COLLECTION, "<hello/>"));

		verify(xdb).create("example", ROOT_COLLECTION, "<hello/>");

	}

	/**

	 * test quick search xml.

	 * 

	 * @throws ISStoreException

	 *             happens

	 * @throws XMLDBException

	 *             happens

	 */

	@Test

	public void testQuickSearchXML() throws ISStoreException, XMLDBException {

		final List<String> ans = new ArrayList<String>();

		ans.add(ONE);

		ans.add(TWO);

		prepareXMLDBResultSet();

		final ArrayList<String> res = (ArrayList<String>) store.quickSearchXML(SOME_QUERY);

		assertNotNull("query returned", res);

		assertEquals("correct size", 2, res.size());

		assertEquals("first value", ONE, res.get(0));

		assertEquals("second value", TWO, res.get(1));

	}

}