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$'

 *     '$Date$'

 * '$Revision$'

 *

 * 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.InputStream;

import junit.framework.Test;

import junit.framework.TestSuite;

import org.dataone.service.exceptions.NotImplemented;

import org.dataone.service.exceptions.ServiceFailure;

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

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

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

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

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

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

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

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

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

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

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

import org.dataone.service.types.v2.Node;

import org.dataone.service.types.v2.NodeList;

import org.dataone.service.types.v2.ObjectFormat;

import org.dataone.service.types.v2.ObjectFormatList;

/**

 * A JUnit test for testing the dataone CNCore implementation

 */

    /**

    * constructor for the test

    */

        super(name);

    }

	/**

	 * Create a suite of tests to be run together

	 */

	public static Test suite()

	{

		TestSuite suite = new TestSuite();

		suite.addTest(new CNodeServiceTest("testCreate"));

		suite.addTest(new CNodeServiceTest("testObjectFormatNotFoundException"));

		suite.addTest(new CNodeServiceTest("testReplicationStatus"));

		suite.addTest(new CNodeServiceTest("testReserveIdentifier"));

		suite.addTest(new CNodeServiceTest("testSearch"));

		return suite;

	}

	/**

	 */

	    try {

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

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

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

	 * test for getting system metadata

	 */

	public void testGetSystemMetadata() {

	    printTestHeader("testGetSystemMetadata");

	    try {

            Session session = getTestSession();

			Identifier guid = new Identifier();

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

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

			assertEquals(sysmeta.getIdentifier().getValue(), retSysmeta.getIdentifier().getValue());

        } catch(Exception e) {

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

        }

	}

	    printTestHeader("testGetLogRecords");

	    try {

		    Session session = getTestSession();

		    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");

		    Date fromDate = sdf.parse("2010-01-01");

		    Date toDate = new Date();

		    Event event = Event.CREATE;

		    int start = 0;

		    assertTrue(log.getStart() == start);

		    assertTrue(log.getTotal() > 0);

		    e.printStackTrace();

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

	    }

	}

	    printTestHeader("testCreate");

	    try {

            Session session = getTestSession();

			Identifier guid = new Identifier();

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

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

        } catch(Exception e) {

        	e.printStackTrace();

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

	}

	    printTestHeader("testGet");

	    try {

            Session session = getTestSession();

			Identifier guid = new Identifier();

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

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

        } catch(Exception e) {

        	e.printStackTrace();

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

        }

	}

	    printTestHeader("testChecksum");

	    try {

            Session session = getTestSession();

			Identifier guid = new Identifier();

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

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

        } catch(Exception e) {

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

        }

	}

	public void testListNodes() {

	    printTestHeader("testListNodes");

	    try {

        	// expecting not implemented

            assertTrue(true);

        } catch(Exception e) {

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

        }

	}

	public void testReserveIdentifier() {

	    printTestHeader("testReserveIdentifier");

	    try {

            Session session = getTestSession();

			Identifier guid = new Identifier();

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

			// reserve it

			assertNotNull(resultPid);

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

        	// this is not implemented in Metacat

            assertTrue(true);

        	e.printStackTrace();

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

        }

	}

	public void testSearch() {

	    printTestHeader("testSearch");

	    try {

            Session session = getTestSession();

			try {

				ObjectList objectList = CNodeService.getInstance(request).search(session, null, null);

			} catch (NotImplemented ne) {

				assertTrue(true);

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

        }

	}

	public void testSetOwner() {

	    printTestHeader("testSetOwner");

	    try {

            Session session = getTestSession();

			Identifier guid = new Identifier();

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

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

			rightsHolder.setValue("newUser");

			// set it

			// get it

			// check it

        } catch(Exception e) {

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

        }

	}

	    printTestHeader("testSetAccessPolicy");

	    try {

            Session session = getTestSession();

			Identifier guid = new Identifier();

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

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

			AccessRule accessRule = new AccessRule();

			accessRule.addPermission(Permission.WRITE);

			Subject publicSubject = new Subject();

			accessPolicy.addAllow(accessRule);

			// set it

			// check it

        } catch(Exception e) {

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

        }

	}

	public void testIsAuthorized() {

	    printTestHeader("testIsAuthorized");

	    try {

            Session session = getTestSession();

			Identifier guid = new Identifier();

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

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

			Subject publicSubject = new Subject();

			// public read

			// not public write

			try {

				result = false;

			} catch (NotAuthorized nae) {

				result = true;

			}

			assertTrue(result);

        } catch(Exception e) {

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

        }

	}

	    printTestHeader("testReplicationPolicy");

	    try {

            Session session = getTestSession();

			Identifier guid = new Identifier();

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

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

			ReplicationPolicy policy = new ReplicationPolicy();

			NodeReference node = new NodeReference();

			node.setValue("testNode");

			policy.addPreferredMemberNode(node );

			// set it

			// get it

			// check it

			assertEquals(policy.getPreferredMemberNode(0).getValue(), sysmeta.getReplicationPolicy().getPreferredMemberNode(0).getValue());

        } catch(Exception e) {

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

        }

	}

	public void testReplicationStatus() {

	    printTestHeader("testReplicationStatus");

	    try {

            Session session = getTestSession();

			Identifier guid = new Identifier();

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

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

			NodeReference replicaMemberNode = new NodeReference();

			replicaMemberNode.setValue("testNode");

			replica.setReplicationStatus(ReplicationStatus.REQUESTED);

			replica.setReplicaMemberNode(replicaMemberNode);

			// save it

			ReplicationStatus status = ReplicationStatus.COMPLETED;

			boolean result = CNodeService.getInstance(request).setReplicationStatus(session, guid, replicaMemberNode, status, failure);

			// get it

			// check it

			assertEquals(status, sysmeta.getReplica(0).getReplicationStatus());

        } catch(Exception e) {

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

        }

	}

	 * Run an initial test that always passes to check that the test harness is

	 * working.

	 */

	public void initialize()

	{

	    printTestHeader("initialize");

		assertTrue(1 == 1);

	}

	 * We want to act as the CN itself

	 * @throws ServiceFailure

	 * @throws Exception

	 */

	@Override

	public Session getTestSession() throws Exception {

		Session session = super.getTestSession();

		// use the first CN we find in the nodelist

        NodeList nodeList = D1Client.getCN().listNodes();

        for (Node node : nodeList.getNodeList()) {

            if ( node.getType().equals(NodeType.CN) ) {

                List<Subject> subjects = node.getSubjectList();

                for (Subject subject : subjects) {

                   session.setSubject(subject);

                   // we are done here

                   return session;

                }

            }

        }

        // in case we didn't find it

        return session;

	}

	/**

	 * test to list the object formats registered in metacat

	 */

	public void testListFormats() {

    printTestHeader("testListFormats");

    setUpFormats();

  	int formatsCount = 59;

  	ObjectFormatList objectFormatList;

  	try {

  	} catch (ServiceFailure e) {

  		fail("Could not get the object format list: " + e.getMessage());

    } catch (NotImplemented e) {

  		fail("Could not get the object format list: " + e.getMessage());

    }

	}

   * Test getting a single object format from the registered list

   */

  public void testGetFormat() {

    printTestHeader("testGetFormat");

    setUpFormats();

    ObjectFormatIdentifier fmtid = new ObjectFormatIdentifier();

    fmtid.setValue(knownFormat);

    try {

			String result =

	  	System.out.println("Found    result: " + result);

	  	assertTrue(result.equals(knownFormat));

    } catch (NullPointerException npe) {

	    fail("The returned format was null: " + npe.getMessage());

    } catch (NotFound nfe) {

    	fail("The format " + knownFormat + " was not found: " + nfe.getMessage());

    } catch (ServiceFailure sfe) {

    	fail("The format " + knownFormat + " was not found: " + sfe.getMessage());

    } catch (NotImplemented nie) {

    	fail("The getFormat() method has not been implemented: " + nie.getMessage());

    }

  }

  /**

   * Test getting a non-existent object format, returning NotFound

   */

  public void testObjectFormatNotFoundException() {

    printTestHeader("testObjectFormatNotFoundException");

    ObjectFormatIdentifier fmtid = new ObjectFormatIdentifier();

  	String badFormat = "text/bad-format";

  	fmtid.setValue(badFormat);

  	try {

	    ObjectFormat objectFormat =

  	} catch (Exception e) {

  		assertTrue(e instanceof NotFound);

  	}

  }

  public void readDeletedObject() {

      printTestHeader("testCreate");

      try {

          Session session = getTestSession();

          Identifier guid = new Identifier();

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

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

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

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

          assertEquals(guid, pid);

          Thread.sleep(3000);

          // use MN admin to delete

          session = getMNSession();

          Identifier deletedPid = CNodeService.getInstance(request).delete(session, pid);

          System.out.println("after deleting");

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

          // check that we cannot get the object

          session = getTestSession();

          InputStream deletedObject = null;

          try {

              //System.out.println("before read ===============");

              deletedObject = CNodeService.getInstance(request).get(session, deletedPid);

              //System.out.println("after read ===============");

          } catch (NotFound nf) {

              //System.out.println("the exception is1 "+nf.getMessage());

              //nf.printStackTrace();

              assertTrue(nf.getMessage().contains("deleted"));

          }

          try {

              //System.out.println("before read ===============");

              SystemMetadata sysmeta2 = CNodeService.getInstance(request).getSystemMetadata(session, deletedPid);

              //System.out.println("after read ===============");

          } catch (NotFound nf) {

              //System.out.println("the exception is "+nf.getMessage());

              //nf.printStackTrace();

              assertTrue(nf.getMessage().contains("deleted"));

          }

          try {

              //System.out.println("before read ===============");

              DescribeResponse describeResponse = CNodeService.getInstance(request).describe(session, pid);

              //System.out.println("after read ===============");

          } catch (NotFound nf) {

              //System.out.println("the exception is "+nf.getMessage());

              //nf.printStackTrace();

              assertTrue(nf.getMessage().contains("deleted"));

          }

          try {

              //System.out.println("before read ===============");

              Checksum checksum = CNodeService.getInstance(request).getChecksum(session, pid);

              //System.out.println("after read ===============");

          } catch (NotFound nf) {

              //System.out.println("the exception 3 is "+nf.getMessage());

              //nf.printStackTrace();

              assertTrue(nf.getMessage().contains("deleted"));

          }

          try {

              //System.out.println("before read ===============");

              boolean isAuthorized =

                      CNodeService.getInstance(request).isAuthorized(session, pid, Permission.READ);

              //System.out.println("after read ===============");

          } catch (NotFound nf) {

              //System.out.println("the exception 4 is "+nf.getMessage());

              //nf.printStackTrace();

              assertTrue(nf.getMessage().contains("deleted"));

          }

          assertNull(deletedObject);

      } catch(Exception e) {

          e.printStackTrace();

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

      }

  }

}