Metacat

/**

 *  '$RCSfile$'

 *  Copyright: 2004 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.metacattest;

import java.io.Reader;

import java.io.StringReader;

import java.util.Calendar;

import java.util.Date;

import java.util.GregorianCalendar;

import java.util.SimpleTimeZone;

import java.util.TimeZone;

import edu.ucsb.nceas.metacat.client.InsufficientKarmaException;

import edu.ucsb.nceas.metacat.client.Metacat;

import edu.ucsb.nceas.metacat.client.MetacatAuthException;

import edu.ucsb.nceas.metacat.client.MetacatException;

import edu.ucsb.nceas.metacat.client.MetacatFactory;

import edu.ucsb.nceas.metacat.client.MetacatInaccessibleException;

import edu.ucsb.nceas.utilities.IOUtil;

import junit.framework.Test;

import junit.framework.TestCase;

import junit.framework.TestSuite;

/**

public class AccessControlTest

    extends TestCase {

  private String username = "@mcuser@";

  private String password = "@mcpassword@";

  private String anotheruser = "@mcanotheruser@";

  private String anotherpassword = "@mcanotherpassword@";

  private String prefix = "test";

  private String newdocid = null;

  private String onlinetestdatafile2 = "test/onlineDataFile2";

  private boolean FAILURE = false;

   * this function might have to modified

   */

  private String testEmlHeader =

      "<?xml version=\"1.0\"?><eml:eml" +

      " xmlns:eml=\"eml://ecoinformatics.org/eml-2.0.1\"" +

      " xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"" +

      " packageId=\"eml.1.1\" system=\"knb\"" +

      " xsi:schemaLocation=\"eml://ecoinformatics.org/eml-2.0.1 eml.xsd\"" +

      " scope=\"system\">";

  private String testEmlCreatorBlock =

      "<creator scope=\"document\">                                       " +

      " <individualName>                                                  " +

      "    <surName>Smith</surName>                                       " +

      " </individualName>                                                 " +

      "</creator>                                                         ";

  private String testEmlContactBlock =

      "<contact scope=\"document\">                                       " +

      " <individualName>                                                  " +

      "    <surName>Jackson</surName>                                     " +

      " </individualName>                                                 " +

      "</contact>                                                         ";

  private String testEmlInlineBlock1 =

      "<inline>                                                           " +

      "  <admin>                                                          " +

      "    <contact>                                                      " +

      "      <name>Operator</name>                                        " +

      "      <institution>PSI</institution>                               " +

      "    </contact>                                                     " +

      "  </admin>                                                         " +

      "</inline>                                                          ";

  private String testEmlInlineBlock2 =

      "<inline>                                                           " +

      "  <instrument>                                                     " +

      "    <instName>LCQ</instName>                                       " +

      "    <source type=\"ESI\"></source>                                 " +

      "    <detector type=\"EM\"></detector>                              " +

      "  </instrument>                                                    " +

      "</inline>                                                          ";

  /**

    * This function returns a valid eml document with no access rules

    * This function is for eml-2.0.1 only. For other eml versions,

    * this function might have to modified

    */

   private String getTestEmlDoc(String title,  String inlineData1,

                               String inlineData2, String onlineUrl1,

                               String onlineUrl2){

    String testDocument = "";

    testDocument = testDocument + testEmlHeader +

        "<dataset scope=\"document\"><title>" + title + "</title>" +

        testEmlCreatorBlock;

    if(inlineData1 != null){

      testDocument = testDocument + "<distribution scope=\"document\">" +

          inlineData1 + "</distribution>";

    }

    if(inlineData2 != null){

      testDocument = testDocument + "<distribution scope=\"document\">" +

          inlineData2 + "</distribution>";

    }

    if(onlineUrl1 != null){

      testDocument = testDocument + "<distribution scope=\"document\">" +

          "<online><url function=\"download\">" + onlineUrl1 + "</url></online></distribution>";

    }

    if(onlineUrl2 != null){

      testDocument = testDocument + "<distribution scope=\"document\">" +

          "<online><url function=\"download\">" + onlineUrl2 + "</url></online></distribution>";

    }

    testDocument = testDocument + testEmlContactBlock + "</dataset></eml:eml>";

    return testDocument;

  }

  /**

   *

   * @param name the name of the test method

   */

  public AccessControlTest(String name) {

    super(name);

    newdocid = generateDocid();

  }

  /**

   * Establish a testing framework by initializing appropriate objects

   */

  public void setUp() {

    try {

      System.err.println("Test Metacat: " + metacatUrl);

      m = MetacatFactory.createMetacatConnection(metacatUrl);

    }

    catch (MetacatInaccessibleException mie) {

      System.err.println("Metacat is: " + metacatUrl);

      fail("Metacat connection failed." + mie.getMessage());

    }

  }

  /**

   * Release any objects after tests are complete

   */

  public void tearDown() {

  }

  /**

   * Create a suite of tests to be run together

   */

  public static Test suite() {

    TestSuite suite = new TestSuite();

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

    // Test basic functions

    suite.addTest(new AccessControlTest("insert"));

    suite.addTest(new AccessControlTest("read"));

    suite.addTest(new AccessControlTest("update"));

    suite.addTest(new AccessControlTest("delete"));

    suite.addTest(new AccessControlTest("noAccessSpecified_Owner"));

    //suite.addTest(new AccessControlTest("noAccessSpecified_Public"));

    return suite;

  }

  /**

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

   * harness is working.

   */

  public void initialize() {

    assertTrue(1 == 1);

  }

  /**

   * Test the login() function with valid credentials

   */

  public void login() {

    // Try a valid login

    try {

      String response = m.login(username, password);

      System.err.println("Login response: " + response);

      assertTrue(response != null);

      assertTrue(response.indexOf("<login>") != -1);

      String sessionId = m.getSessionId();

      System.err.println("Session ID: " + m.getSessionId());

      assertTrue(sessionId != null);

      assertTrue(response.indexOf(m.getSessionId()) != -1);

    }

    catch (MetacatAuthException mae) {

      fail("Authorization failed:\n" + mae.getMessage());

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

  }

  /**

   * Test the insert() function with a known document

   */

  public void insert() {

    try {

                                   null, null, null);

      m.login(username, password);

      String response = m.insert(identifier,

                                 new StringReader(testdocument), null);

      assertTrue(response.indexOf("<success>") != -1);

      assertTrue(response.indexOf(identifier) != -1);

      System.err.println(response);

    }

    catch (MetacatAuthException mae) {

      fail("Authorization failed:\n" + mae.getMessage());

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

    catch (InsufficientKarmaException ike) {

      assertTrue(1 == 1);

      fail("Insufficient karma:\n" + ike.getMessage());

    }

    catch (MetacatException me) {

      fail("Metacat Error:\n" + me.getMessage());

    }

    catch (Exception e) {

      fail("General exception:\n" + e.getMessage());

    }

  }

  /**

   * The read() function

   */

  public void read() {

    try {

                                   null, null);

      Reader r = m.read(newdocid + ".1");

      String doc = IOUtil.getAsString(r, true);

      assertTrue(doc.equals(testdocument));

    }

    catch (MetacatAuthException mae) {

      fail("Authorization failed:\n" + mae.getMessage());

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

    catch (Exception e) {

      fail("General exception:\n" + e.getMessage());

    }

  }

  /**

   * Test the update() function with a known document

   */

  public void update() {

    try {

                                   null, null);

      m.login(username, password);

      String response = m.update(identifier,

                                 new StringReader(testdocument), null);

      assertTrue(response.indexOf("<success>") != -1);

      assertTrue(response.indexOf(identifier) != -1);

      System.err.println(response);

    }

    catch (MetacatAuthException mae) {

      fail("Authorization failed:\n" + mae.getMessage());

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

    catch (InsufficientKarmaException ike) {

      fail("Insufficient karma:\n" + ike.getMessage());

    }

    catch (MetacatException me) {

      fail("Metacat Error:\n" + me.getMessage());

    }

    catch (Exception e) {

      fail("General exception:\n" + e.getMessage());

    }

  }

  /**

   * Test the delete() function with a known document

   */

  public void delete() {

    try {

      String identifier = newdocid + ".2";

      m.login(username, password);

      String response = m.delete(identifier);

      assertTrue(response.indexOf("<success>") != -1);

      System.err.println(response);

    }

    catch (MetacatAuthException mae) {

      fail("Authorization failed:\n" + mae.getMessage());

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

    catch (InsufficientKarmaException ike) {

      fail("Insufficient karma:\n" + ike.getMessage());

    }

    catch (MetacatException me) {

      fail("Metacat Error:\n" + me.getMessage());

    }

    catch (Exception e) {

      fail("General exception:\n" + e.getMessage());

    }

  }

  /** *********

   * 1. the owner tries to read the document  - Success.

   *                                            Both document and data show up.

   * 2. the owner tries to update the document - Success.

   * 3. the owner tries to update the inline data - Success.

   * 4. the owner tries to update the online data file - Success.

   * 5. the owner tries to update the access rules for the document - Success.

   * 6. the owner tries to update the access rules for the inline data - Success.

   * 7. the owner tries to update the access rules for the online data - Success.

   * 8. the owner tries to delete the document - Success.

      newdocid = generateDocid();

      m.login(username, password);

      onlineDocid = generateDocid();

      uploadDocid(onlineDocid + ".1", onlinetestdatafile1, SUCCESS);

                                   null, "ecogrid://knb/" + onlineDocid, null);

      // update the document

                                   null, null, null);

      // update the inline data

                                   null, null, null);

      // update the online data

      // the second time

      // update the document access control

                                   null, null, null);

      updateDocid(newdocid + ".5", testdocument, SUCCESS);

      readDocidWhichEqualsDoc(newdocid + ".5", testdocument, SUCCESS);

      // update the document access control for inline data

                                   null, null, null);

      updateDocid(newdocid + ".6", testdocument, SUCCESS);

      readDocidWhichEqualsDoc(newdocid + ".6", testdocument, SUCCESS);

      // update the document access control for online data

                                   null, null, null);

      updateDocid(newdocid + ".7", testdocument, SUCCESS);

      readDocidWhichEqualsDoc(newdocid + ".7", testdocument, SUCCESS);

      // delete the document

    }

    catch (MetacatAuthException mae) {

      fail("Authorization failed:\n" + mae.getMessage());

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

    catch (Exception e) {

      fail("General exception:\n" + e.getMessage());

    }

  }

  /** *********

   * 1. the owner tries to read the document - Failure.

   * 2. the owner tries to update the document - Failure.

   * 3. the owner tries to update the inline data - Failure.

   * 4. the owner tries to update the online data file - Failure.

   * 5. the owner tries to update the access rules for the document - Failure.

   * 6. the owner tries to update the access rules for the inline data - Failure.

   * 7. the owner tries to update the access rules for the online data - Failure.

   * 8. the owner tries to delete the document - Failure.

      newdocid = generateDocid();

      String identifier = newdocid + ".1";

      // login

      m.login(username, password);

      // insert a document - get the docid

      insertDocid(newdocid + ".1", testdocument, SUCCESS);

      readDocidWhichEqualsDoc(newdocid + ".1", testdocument, SUCCESS);

      // logoutand login as other user

      m.logout();

      m.login(anotheruser, anotherpassword);

      // read the document

      readDocidWhichEqualsDoc(newdocid + ".1", null, FAILURE);

      // update the document

      updateDocid(newdocid + ".2", testdocument, FAILURE);

      // update the inline data

      updateDocid(newdocid + ".2", testdocument, FAILURE);

      // update the online data

      updateDocid(newdocid + ".2", testdocument, FAILURE);

      // update the document access control

      updateDocid(newdocid + ".2", testdocument, FAILURE);

      // update the document access control for inline data

      updateDocid(newdocid + ".2", testdocument, FAILURE);

      // update the document access control for online data

      updateDocid(newdocid + ".2", testdocument, FAILURE);

      // delete the document

      deleteDocid(newdocid + ".2", SUCCESS);

      m.logout();

    }

    catch (MetacatAuthException mae) {

      fail("Authorization failed:\n" + mae.getMessage());

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

    catch (MetacatException me) {

      fail("Metacat Error:\n" + me.getMessage());

    }

    catch (Exception e) {

      fail("General exception:\n" + e.getMessage());

    }

  }

  /** *********

   * 1. the owner tries to read the document - Failure.

   * 2. the owner tries to update the document - Failure.

   * 3. the owner tries to update the inline data - Failure.

   * 4. the owner tries to update the online data file - Failure.

   * 5. the owner tries to update the access rules for the document - Failure.

   * 6. the owner tries to update the access rules for the inline data - Failure.

   * 7. the owner tries to update the access rules for the online data - Failure.

   * 8. the owner tries to delete the document - Failure.

      newdocid = generateDocid();

      String identifier = newdocid + ".1";

      // login

      m.login(username, password);

      // insert a document - get the docid

      insertDocid(newdocid + ".1", testdocument, SUCCESS);

      readDocidWhichEqualsDoc(newdocid + ".1", testdocument, SUCCESS);

      // logoutand login as other user

      m.logout();

      // read the document

      readDocidWhichEqualsDoc(newdocid + ".1", null, FAILURE);

      // update the document

      updateDocid(newdocid + ".2", testdocument, FAILURE);

      // update the inline data

      updateDocid(newdocid + ".2", testdocument, FAILURE);

      // update the online data

      updateDocid(newdocid + ".2", testdocument, FAILURE);

      // update the document access control

      updateDocid(newdocid + ".2", testdocument, FAILURE);

      // update the document access control for inline data

      updateDocid(newdocid + ".2", testdocument, FAILURE);

      // update the document access control for online data

      updateDocid(newdocid + ".2", testdocument, FAILURE);

      // delete the document

      deleteDocid(newdocid + ".2", SUCCESS);

      m.logout();

    }

    catch (MetacatAuthException mae) {

      fail("Authorization failed:\n" + mae.getMessage());

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

    catch (MetacatException me) {

      fail("Metacat Error:\n" + me.getMessage());

    }

    catch (Exception e) {

      fail("General exception:\n" + e.getMessage());

    }

  }

  /**

   * Insert a document into metacat. The expected result is passed as result

   */

    String response = null;

    try {

      response = m.insert(docid,

                          new StringReader(testdocument), null);

      if (result) {

        assertTrue( (response.indexOf("<success>") != -1));

        assertTrue(response.indexOf(docid) != -1);

      }

      else {

        assertTrue( (response.indexOf("<success>") == -1));

      }

      System.err.println(response);

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

    catch (InsufficientKarmaException ike) {

      fail("Insufficient karma:\n" + ike.getMessage());

    }

    catch (MetacatException me) {

      fail("Metacat Error:\n" + me.getMessage());

    }

    catch (Exception e) {

      fail("General exception:\n" + e.getMessage());

    }

    return response;

  }

  /**

   * Insert a document into metacat. The expected result is passed as result

   */

  public String uploadDocid(String docid, String filePath, boolean result) {

    String response = null;

    try {

      response = m.upload(docid, new File(filePath));

      if (result) {

        assertTrue( (response.indexOf("<success>") != -1));

        assertTrue(response.indexOf(docid) != -1);

      }

      else {

        assertTrue( (response.indexOf("<success>") == -1));

      }

      System.err.println(response);

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

    catch (InsufficientKarmaException ike) {

      fail("Insufficient karma:\n" + ike.getMessage());

    }

    catch (MetacatException me) {

      fail("Metacat Error:\n" + me.getMessage());

    }

    catch (Exception e) {

      fail("General exception:\n" + e.getMessage());

    }

    return response;

  }

  /**

   * Update a document in metacat. The expected result is passed as result

   */

    String response = null;

    try {

      response = m.update(docid,

        assertTrue( (response.indexOf("<success>") != -1));

        assertTrue(response.indexOf(docid) != -1);

      }

      else {

        assertTrue( (response.indexOf("<success>") == -1));

      }

      System.err.println(response);

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

    catch (InsufficientKarmaException ike) {

      fail("Insufficient karma:\n" + ike.getMessage());

    }

    catch (MetacatException me) {

      fail("Metacat Error:\n" + me.getMessage());

    }

    catch (Exception e) {

      fail("General exception:\n" + e.getMessage());

    }

    return response;

  }

   * Delete a document into metacat. The expected result is passed as result

   */

    try {

      String response = m.delete(docid);

      if (result) {

        assertTrue(response.indexOf("<success>") != -1);

      }

      else {

        assertTrue(response.indexOf("<success>") == -1);

      }

      System.err.println(response);

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

    catch (InsufficientKarmaException ike) {

      fail("Insufficient karma:\n" + ike.getMessage());

    }

    catch (MetacatException me) {

      fail("Metacat Error:\n" + me.getMessage());

    }

    catch (Exception e) {

      fail("General exception:\n" + e.getMessage());

    }

  }

   * Read a document from metacat and check if it is equal to a given string.

   * The expected result is passed as result

   */

    try {

      Reader r = m.read(docid);

      String doc = IOUtil.getAsString(r, true);

      if (result) {

        assertTrue(testDoc.equals(doc));

      } else {

        assertTrue(doc.indexOf("<error>") != -1);

      }

    }

    catch (MetacatInaccessibleException mie) {

      fail("Metacat Inaccessible:\n" + mie.getMessage());

    }

    catch (InsufficientKarmaException ike) {

      fail("Insufficient karma:\n" + ike.getMessage());

    }

    catch (MetacatException me) {