Metacat

/**

 *  '$RCSfile$'

 *  Copyright: 2010 Regents of the University of California and the

 *              National Center for Ecological Analysis and Synthesis

 *  Purpose: To test the Access Controls in metacat by JUnit

 *

 *   '$Author: jones $'

 *     '$Date: 2013-10-09 23:52:11 -0700 (Wed, 09 Oct 2013) $'

 * '$Revision: 8304 $'

 *

 * This program 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 2 of the License, or

 * (at your option) any later version.

 *

 * This program 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 this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.dataone;

import java.io.ByteArrayInputStream;

import java.io.FileInputStream;

import java.io.FileNotFoundException;

import java.io.InputStream;

import java.util.HashMap;

import junit.framework.Test;

import junit.framework.TestSuite;

import org.apache.commons.io.IOUtils;

import org.dataone.client.ObjectFormatCache;

import org.dataone.configuration.Settings;

import org.dataone.service.types.v1.Identifier;

import org.dataone.service.types.v1.Session;

import org.dataone.service.types.v1.Subject;

import org.dataone.service.types.v1.SystemMetadata;

import org.junit.After;

import org.junit.Before;

import edu.ucsb.nceas.ezid.EZIDService;

import edu.ucsb.nceas.ezid.profile.DataCiteProfile;

import edu.ucsb.nceas.ezid.profile.InternalProfile;

import edu.ucsb.nceas.metacat.properties.PropertyService;

/**

 * A JUnit test to exercise the DOI registration for content added

 * via the DataONE MN API

 * 

 * @author leinfelder

 *

 */

public class RegisterDOITest extends D1NodeServiceTest {

	/**

	 * Set up the test fixtures

	 * 

	 * @throws Exception

	 */

	@Before

	public void setUp() throws Exception {

		super.setUp();

		// set up the configuration for d1client

		Settings.getConfiguration().setProperty("D1Client.cnClassName",

				MockCNode.class.getName());

	}

	/**

	 * Remove the test fixtures

	 */

	@After

	public void tearDown() {

	}

	/**

	 * Build the test suite

	 * 

	 * @return

	 */

	public static Test suite() {

		TestSuite suite = new TestSuite();

		suite.addTest(new RegisterDOITest("initialize"));

		// DOI registration test

		suite.addTest(new RegisterDOITest("testCreateDOI"));

		suite.addTest(new RegisterDOITest("testMintAndCreateDOI"));

		suite.addTest(new RegisterDOITest("testMintAndCreateForEML"));

		// publish

		suite.addTest(new RegisterDOITest("testPublishDOI"));

		return suite;

	}

	/**

	 * Constructor for the tests

	 * 

	 * @param name

	 *            - the name of the test

	 */

	public RegisterDOITest(String name) {

		super(name);

	}

	/**

	 * Initial blank test

	 */

	public void initialize() {

		assertTrue(1 == 1);

	}

	/**

	 * constructs a "fake" session with a test subject

	 * @return

	 */

	@Override

	public Session getTestSession() throws Exception {

		Session session = new Session();

        Subject subject = new Subject();

        subject.setValue("CN=Benjamin Leinfelder A515,O=University of Chicago,C=US,DC=cilogon,DC=org");

        session.setSubject(subject);

        return session;

	}

	public void testMintAndCreateDOI() {

		printTestHeader("testMintAndCreateDOI");

		testMintAndCreateDOI(null);

	}

	public void testMintAndCreateForEML() {

		printTestHeader("testMintAndCreateForEML");

		String emlFile = "test/tao.14563.1.xml";

		InputStream content = null;

		try {

		    content = new FileInputStream(emlFile);

		    testMintAndCreateDOI(content);

		    content.close(); 

		} catch (FileNotFoundException e) {

			e.printStackTrace();

			fail(e.getMessage());

		} finally {

		    IOUtils.closeQuietly(content);

		}

	}

	/**

	 * Test object creation

	 */

	private void testMintAndCreateDOI(InputStream inputStream) {

		printTestHeader("testMintAndCreateDOI - common");

		try {

			// get ezid config properties

			String ezidUsername = PropertyService.getProperty("guid.ezid.username");

			String ezidPassword = PropertyService.getProperty("guid.ezid.password");

			String ezidServiceBaseUrl = PropertyService.getProperty("guid.ezid.baseurl");

			EZIDService ezid = new EZIDService(ezidServiceBaseUrl);

			ezid.login(ezidUsername, ezidPassword);

			// Mint a DOI

			Session session = getTestSession();

			Identifier guid = MNodeService.getInstance(request).generateIdentifier(session, "DOI", null);

			// check that EZID knows about it

			HashMap<String, String> metadata = ezid.getMetadata(guid.getValue());

			assertNotNull(metadata);

			// add the actual object for the newly-minted DOI

			SystemMetadata sysmeta = null;

			InputStream object = null;

			boolean isMetadata = false;

			if (inputStream != null) {

				sysmeta = createSystemMetadata(guid, session.getSubject(), null);

				object = inputStream;

		        sysmeta.setFormatId(ObjectFormatCache.getInstance().getFormat("eml://ecoinformatics.org/eml-2.1.0").getFormatId());

		        isMetadata = true;

			} else {

				object = new ByteArrayInputStream("test".getBytes("UTF-8"));

				sysmeta = createSystemMetadata(guid, session.getSubject(), object);

			}

			Identifier pid = MNodeService.getInstance(request).create(session, guid, object, sysmeta);

			assertEquals(guid.getValue(), pid.getValue());

			// check for the metadata for title element

			metadata = ezid.getMetadata(pid.getValue());

			assertNotNull(metadata);

			assertTrue(metadata.containsKey(DataCiteProfile.TITLE.toString()));

			// check that the target URI was updated

			if (isMetadata) {

				String registeredTarget = metadata.get(InternalProfile.TARGET.toString());

				assertTrue(registeredTarget.endsWith("/#view/" + pid.getValue()));

			}

			System.out.println("tested with DOI: " + pid.getValue());

		} catch (Exception e) {

			e.printStackTrace();

			fail("Unexpected error: " + e.getMessage());

		}

	}

	/**

	 * Test object creation

	 */

	public void testCreateDOI() {

		printTestHeader("testCreateDOI");

		try {

			// get ezid config properties

			String shoulder = PropertyService.getProperty("guid.ezid.doishoulder.1");

			String ezidUsername = PropertyService.getProperty("guid.ezid.username");

			String ezidPassword = PropertyService.getProperty("guid.ezid.password");

			String ezidServiceBaseUrl = PropertyService.getProperty("guid.ezid.baseurl");

			Session session = getTestSession();

			Identifier guid = new Identifier();

			guid.setValue(shoulder + "/testCreateDOI." + System.currentTimeMillis());

			InputStream object = new ByteArrayInputStream( "test".getBytes("UTF-8"));

			SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), object);

			Identifier pid = MNodeService.getInstance(request).create(session, guid, object, sysmeta);

			assertEquals(guid.getValue(), pid.getValue());

			// check for the metadata explicitly, using ezid service

			EZIDService ezid = new EZIDService(ezidServiceBaseUrl);

			ezid.login(ezidUsername, ezidPassword);

			HashMap<String, String> metadata = ezid.getMetadata(pid.getValue());

			assertNotNull(metadata);

			assertTrue(metadata.containsKey(DataCiteProfile.TITLE.toString()));

		} catch (Exception e) {

			e.printStackTrace();

			fail("Unexpected error: " + e.getMessage());

		}

	}

	/**

	 * Test object publishing

	 */

	public void testPublishDOI() {

		printTestHeader("testPublishDOI");

		try {

			// get ezid config properties

			String ezidUsername = PropertyService.getProperty("guid.ezid.username");

			String ezidPassword = PropertyService.getProperty("guid.ezid.password");

			String ezidServiceBaseUrl = PropertyService.getProperty("guid.ezid.baseurl");

			Session session = getTestSession();

			Identifier guid = new Identifier();

			guid.setValue("testPublishDOI." + System.currentTimeMillis());

			// use EML to test

			// TODO: include an ORE to really exercise it

			String emlFile = "test/tao.14563.1.xml";

			InputStream content = null;

			try {

				content = new FileInputStream(emlFile);

	            // create the initial version without DOI

	            SystemMetadata sysmeta = createSystemMetadata(guid, session.getSubject(), null);

	            sysmeta.setFormatId(ObjectFormatCache.getInstance().getFormat("eml://ecoinformatics.org/eml-2.1.0").getFormatId());

	            Identifier pid = MNodeService.getInstance(request).create(session, guid, content, sysmeta);

	            assertEquals(guid.getValue(), pid.getValue());

	            // now publish it

	            Identifier publishedIdentifier = MNodeService.getInstance(request).publish(session, pid);

	            // check for the metadata explicitly, using ezid service

	            EZIDService ezid = new EZIDService(ezidServiceBaseUrl);

	            ezid.login(ezidUsername, ezidPassword);

	            HashMap<String, String> metadata = ezid.getMetadata(publishedIdentifier.getValue());

	            assertNotNull(metadata);

	            assertTrue(metadata.containsKey(DataCiteProfile.TITLE.toString()));

	            content.close();

			} catch (FileNotFoundException e) {

				e.printStackTrace();

				fail(e.getMessage());

			} finally {

			    IOUtils.closeQuietly(content);

			}

		} catch (Exception e) {

			e.printStackTrace();

			fail("Unexpected error: " + e.getMessage());

		}

	}

}