/test/edu/ucsb/nceas/metacattest/MetaCatServletTest.java - Annotate - Metacat - Ecoinformatics Redmine

metacat/test/edu/ucsb/nceas/metacattest/MetaCatServletTest.java @ 6004

-            tao
+/**
  *  '$RCSfile$'
  *  Copyright: 2000 Regents of the University of California and the
  *              National Center for Ecological Analysis and Synthesis
  *  Purpose: To test the MetaCatURL class by JUnit
-            jones
+ *    Authors: Jing Tao
             tao
  *   '$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
  */
-            tao
+package edu.ucsb.nceas.metacattest;
             tao
-            daigle
+import edu.ucsb.nceas.MCTestCase;
-            cjones
+import edu.ucsb.nceas.metacat.dataone.CrudServiceTest;
-            daigle
+import edu.ucsb.nceas.metacat.properties.PropertyService;
-            jones
+import edu.ucsb.nceas.utilities.HttpMessage;
-            daigle
+import edu.ucsb.nceas.utilities.PropertyNotFoundException;
             cjones
-            tao
+import junit.framework.Test;
 import junit.framework.TestSuite;
 import java.io.*;
 import java.net.*;
 import java.util.*;
-            cjones
+import org.dataone.service.types.AuthToken;
 import org.dataone.service.types.Identifier;
-            tao
+/**
  * A JUnit test for testing Step class processing
  */
-            daigle
+public class MetaCatServletTest extends MCTestCase {
-            daigle
+	private static String metacatURL;
 	private String serialNumber;
             daigle
 	/* Initialize properties */
-            daigle
+	static {
 		try {
-            daigle
+			metacatURL = PropertyService.getProperty("test.metacatUrl");
-            daigle
+		} catch (PropertyNotFoundException pnfe) {
 			System.err.println("Could not get property in static block: "
 					+ pnfe.getMessage());
             daigle
+	}
             tao
-            daigle
+	/**
 	 * Constructor to build the test
             daigle
 	 * @param name
 	 *            the name of the test method
-            daigle
+	 */
 	public MetaCatServletTest(String name) {
 		super(name);
+	}
             tao
-            daigle
+	/**
 	 * Constructor to build the test
             daigle
 	 * @param name
 	 *            the name of the test method
-            daigle
+	 */
 	public MetaCatServletTest(String name, String serial) {
 		super(name);
 		serialNumber = serial;
+	}
             tao
-            daigle
+	/**
 	 * Establish a testing framework by initializing appropriate objects
 	 */
 	public void setUp() {
             tao
             daigle
             tao
-            daigle
+	/**
 	 * Release any objects after tests are complete
 	 */
 	public void tearDown() {
+	}
             tao
-            daigle
+	/**
 	 * Create a suite of tests to be run together
 	 */
 	public static Test suite() {
 		double number = 0;
 		String serial = null;
             tao
-            daigle
+		TestSuite suite = new TestSuite();
 		suite.addTest(new MetaCatServletTest("initialize"));
 		suite.addTest(new MetaCatServletTest("testLterReferralLogin"));
 		suite.addTest(new MetaCatServletTest("testLterReferralLoginFail"));
 		suite.addTest(new MetaCatServletTest("testPiscoReferralLogin"));
 		suite.addTest(new MetaCatServletTest("testPiscoReferralLoginFail"));
 		suite.addTest(new MetaCatServletTest("testNCEASLoginFail"));
-            daigle
+		// Should put a login successfully at the end of login test
 		// So insert or update can have cookie.
-            daigle
+		suite.addTest(new MetaCatServletTest("testNCEASLogin"));
             tao
-            daigle
+		// create random number for docid, so it can void repeat
-            daigle
+		number = Math.random() * 100000;
 		serial = Integer.toString(((new Double(number)).intValue()));
-            daigle
+		debug("serial: " + serial);
-            daigle
+		suite.addTest(new MetaCatServletTest("testInsertXMLDocument", serial));
 		suite.addTest(new MetaCatServletTest("testReadXMLDocumentXMLFormat", serial));
 		suite.addTest(new MetaCatServletTest("testUpdateXMLDocument", serial));
             cjones
-            daigle
+		suite.addTest(new MetaCatServletTest("testReadXMLDocumentHTMLFormat", serial));
 		suite.addTest(new MetaCatServletTest("testReadXMLDocumentZipFormat", serial));
             cjones
-            daigle
+		suite.addTest(new MetaCatServletTest("testDeleteXMLDocument", serial));
             cjones
 		// test delete using GUID
 		number = Math.random() * 100000;
 		serial = Integer.toString(((new Double(number)).intValue()));
 		suite.addTest(new MetaCatServletTest("testDeleteDocumentByGUID", serial));
             tao
-            daigle
+		// insert invalid xml document
-            daigle
+		number = Math.random() * 100000;
 		serial = Integer.toString(((new Double(number)).intValue()));
 		suite.addTest(new MetaCatServletTest("testInsertInvalidateXMLDocument", serial));
-            daigle
+		// insert non well formed document
-            daigle
+		number = Math.random() * 100000;
 		serial = Integer.toString(((new Double(number)).intValue()));
 		suite
 				.addTest(new MetaCatServletTest("testInsertNonWellFormedXMLDocument",
 						serial));
             cjones
-            daigle
+		suite.addTest(new MetaCatServletTest("testLogOut"));
             tao
-            daigle
+		return suite;
+	}
             tao
-            daigle
+	/**
-            daigle
+	 * Run an initial test that always passes to check that the test harness is
 	 * working.
-            daigle
+	 */
 	public void initialize() {
 		assertTrue(1 == 1);
+	}
             tao
-            daigle
+	/**
 	 * Test the login to neceas succesfully
 	 */
 	public void testNCEASLogin() {
-            daigle
+		debug("\nRunning: testNCEASLogin test");
-            daigle
+		String user = "uid=john,o=NCEAS,dc=ecoinformatics,dc=org";
-            cjones
+		String passwd = "12345678";
-            daigle
+		assertTrue(logIn(user, passwd));
-            daigle
+		// assertTrue( withProtocol.getProtocol().equals("http"));
             daigle
 	/**
 	 * Test the login to neceas failed
 	 */
 	public void testNCEASLoginFail() {
-            daigle
+		debug("\nRunning: testNCEASLoginFail test");
-            daigle
+		String user = "uid=john,o=NCEAS,dc=ecoinformatics,dc=org";
 		String passwd = "12345678";
 		assertTrue(!logIn(user, passwd));
+	}
 	/**
 	 * Test the login to lter succesfully
 	 */
 	public void testLterReferralLogin() {
-            daigle
+		debug("\nRunning: testLterReferralLogin test");
-            daigle
+		String user = null;
 		String passwd = null;
 		try {
-            daigle
+			user = PropertyService.getProperty("test.lterUser");
 			passwd = PropertyService.getProperty("test.lterPassword");
-            daigle
+		} catch (PropertyNotFoundException pnfe) {
 			fail("Could not find property: " + pnfe.getMessage());
+		}
             daigle
 		debug("Logging into lter: " + user + " : " + passwd);
-            daigle
+		assertTrue(logIn(user, passwd));
+	}
 	/**
 	 * Test the login to lter failed
 	 */
 	public void testLterReferralLoginFail() {
-            daigle
+		debug("\nRunning: testLterReferralLoginFail test");
-            daigle
+		String user = "uid=jtao,o=LTER,dc=ecoinformatics,dc=org";
 		String passwd = "qVyGpveb";
 		assertTrue(!logIn(user, passwd));
-            daigle
+		// assertTrue( withProtocol.getProtocol().equals("http"));
             daigle
 	/**
 	 * Test the login to pisco succesfully
 	 */
 	public void testPiscoReferralLogin() {
-            daigle
+		debug("\nRunning: testPiscoReferralLogin test");
-            daigle
+		String user = null;
 		String passwd = null;
 		try {
-            daigle
+			user = PropertyService.getProperty("test.piscoUser");
 			passwd = PropertyService.getProperty("test.piscoPassword");
-            daigle
+		} catch (PropertyNotFoundException pnfe) {
 			fail("Could not find property: " + pnfe.getMessage());
+		}
-            daigle
+		debug("logging in pisco user: " + user + ":" + passwd);
-            daigle
+		assertTrue(logIn(user, passwd));
 		// assertTrue( withProtocol.getProtocol().equals("http"));
+	}
 	/**
 	 * Test the login to pisco failed
 	 */
 	public void testPiscoReferralLoginFail() {
-            daigle
+		debug("\nRunning: testPiscoReferralLoginFail test");
-            daigle
+		String user = "uid=tao,o=PISCO,dc=ecoinformatics,dc=org";
 		String passwd = "hello";
 		assertTrue(!logIn(user, passwd));
-            daigle
+		// assertTrue( withProtocol.getProtocol().equals("http"));
             daigle
 	/**
 	 * Test insert a xml document successfully
 	 */
 	public void testInsertXMLDocument() {
-            daigle
+		debug("\nRunning: testInsertXMLDocument test");
-            daigle
+		String name = null;
 		try {
-            daigle
+			name = "john" + PropertyService.getProperty("document.accNumSeparator")
 					+ serialNumber
-            daigle
+					+ PropertyService.getProperty("document.accNumSeparator") + "1";
-            daigle
+		} catch (PropertyNotFoundException pnfe) {
 			fail("Could not find property: " + pnfe.getMessage());
+		}
-            daigle
+		debug("insert docid: " + name);
-            daigle
+		String content = "<?xml version=\"1.0\"?>"
 				+ "<!DOCTYPE acl PUBLIC \"-//ecoinformatics.org//"
 				+ "eml-access-2.0.0beta6//EN\" \"http://pine.nceas.ucsb."
 				+ "edu:8080/tao/dtd/eml-access-2.0.0beta6.dtd\">"
 				+ "<acl authSystem=\"knb\" order=\"allowFirst\">" + "<identifier>" + name
 				+ "</identifier>" + "<allow>"
 				+ "<principal>uid=john,o=NCEAS,dc=ecoinformatics,dc=org</principal>"
 				+ "<permission>all</permission>" + "</allow>" + "<allow>"
 				+ "<principal>public</principal>" + "<permission>read</permission>"
 				+ "</allow>" + "</acl>";
-            daigle
+		debug("xml document: " + content);
-            daigle
+		assertTrue(handleXMLDocument(content, name, "insert"));
+	}
 	/**
-            daigle
+	 * Test insert a invalidate xml document successfully In the String, there
 	 * is no <!Doctype ... Public/System/>
-            daigle
+	 */
 	public void testInsertInvalidateXMLDocument() {
-            daigle
+		debug("\nRunning: testInsertInvalidateXMLDocument test");
-            daigle
+		String name = null;
 		try {
-            daigle
+			name = "john" + PropertyService.getProperty("document.accNumSeparator")
 					+ serialNumber
 					+ PropertyService.getProperty("document.accNumSeparator") + "1";
-            daigle
+		} catch (PropertyNotFoundException pnfe) {
 			fail("Could not find property: " + pnfe.getMessage());
+		}
-            daigle
+		debug("insert docid: " + name);
-            daigle
+		String content = "<?xml version=\"1.0\"?>"
 				+ "<acl authSystem=\"knb\" order=\"allowFirst\">" + "<identifier>" + name
 				+ "</identifier>" + "<allow>"
 				+ "<principal>uid=john,o=NCEAS,dc=ecoinformatics,dc=org</principal>"
 				+ "<permission>all</permission>" + "</allow>" + "<allow>"
 				+ "<principal>public</principal>" + "<permission>read</permission>"
 				+ "</allow>" + "</acl>";
-            daigle
+		debug("xml document: " + content);
-            daigle
+		assertTrue(handleXMLDocument(content, name, "insert"));
+	}
 	/**
-            daigle
+	 * Test insert a non well-formed xml document successfully There is no
 	 * </acl> in this string
-            daigle
+	 */
 	public void testInsertNonWellFormedXMLDocument() {
-            daigle
+		debug("\nRunning: testInsertNonWellFormedXMLDocument test");
-            daigle
+		String name = null;
 		try {
-            daigle
+			name = "john" + PropertyService.getProperty("document.accNumSeparator")
 					+ serialNumber
 					+ PropertyService.getProperty("document.accNumSeparator") + "1";
-            daigle
+		} catch (PropertyNotFoundException pnfe) {
 			fail("Could not find property: " + pnfe.getMessage());
+		}
-            daigle
+		debug("insert non well-formed docid: " + name);
-            daigle
+		String content = "<?xml version=\"1.0\"?>"
 				+ "<acl authSystem=\"knb\" order=\"allowFirst\">" + "<identifier>" + name
 				+ "</identifier>" + "<allow>"
 				+ "<principal>uid=john,o=NCEAS,dc=ecoinformatics,dc=org</principal>"
 				+ "<permission>all</permission>" + "</allow>" + "<allow>"
 				+ "<principal>public</principal>" + "<permission>read</permission>"
 				+ "</allow>";
-            daigle
+		debug("xml document: " + content);
-            daigle
+		assertTrue(!handleXMLDocument(content, name, "insert"));
+	}
 	/**
-            daigle
+	 * Test read a xml document in xml format successfully
-            daigle
+	 */
 	public void testReadXMLDocumentXMLFormat() {
-            daigle
+		debug("\nRunning: testReadXMLDocumentXMLFormat test");
-            daigle
+		String name = null;
 		try {
-            daigle
+			name = "john" + PropertyService.getProperty("document.accNumSeparator")
 					+ serialNumber
 					+ PropertyService.getProperty("document.accNumSeparator") + "1";
-            daigle
+		} catch (PropertyNotFoundException pnfe) {
 			fail("Could not find property: " + pnfe.getMessage());
+		}
 		assertTrue(handleReadAction(name, "xml"));
+	}
 	/**
-            daigle
+	 * Test read a xml document in html format successfully
-            daigle
+	 */
 	public void testReadXMLDocumentHTMLFormat() {
-            daigle
+		debug("\nRunning: testReadXMLDocumentHTMLFormat test");
-            daigle
+		String name = null;
 		try {
-            daigle
+			name = "john" + PropertyService.getProperty("document.accNumSeparator")
 					+ serialNumber
 					+ PropertyService.getProperty("document.accNumSeparator") + "1";
-            daigle
+		} catch (PropertyNotFoundException pnfe) {
 			fail("Could not find property: " + pnfe.getMessage());
             daigle
-            daigle
+		assertTrue(handleReadAction(name, "html"));
+	}
 	/**
-            daigle
+	 * Test read a xml document in zip format successfully
-            daigle
+	 */
 	public void testReadXMLDocumentZipFormat() {
-            daigle
+		debug("\nRunning: testReadXMLDocumentZipFormat test");
-            daigle
+		String name = null;
 		try {
-            daigle
+			name = "john" + PropertyService.getProperty("document.accNumSeparator")
 					+ serialNumber
 					+ PropertyService.getProperty("document.accNumSeparator") + "1";
-            daigle
+		} catch (PropertyNotFoundException pnfe) {
 			fail("Could not find property: " + pnfe.getMessage());
             daigle
-            daigle
+		assertTrue(handleReadAction(name, "zip"));
+	}
 	/**
 	 * Test insert a xml document successfully
 	 */
 	public void testUpdateXMLDocument() {
-            daigle
+		debug("\nRunning: testUpdateXMLDocument test");
-            daigle
+		String name = null;
 		try {
-            daigle
+			name = "john" + PropertyService.getProperty("document.accNumSeparator")
 					+ serialNumber
 					+ PropertyService.getProperty("document.accNumSeparator") + "2";
-            daigle
+		} catch (PropertyNotFoundException pnfe) {
 			fail("Could not find property: " + pnfe.getMessage());
             daigle
 		debug("update docid: " + name);
-            daigle
+		String content = "<?xml version=\"1.0\"?>"
 				+ "<!DOCTYPE acl PUBLIC \"-//ecoinformatics.org//"
 				+ "eml-access-2.0.0beta6//EN\" \"http://pine.nceas.ucsb."
 				+ "edu:8080/tao/dtd/eml-access-2.0.0beta6.dtd\">"
 				+ "<acl authSystem=\"knb\" order=\"allowFirst\">" + "<identifier>" + name
 				+ "</identifier>" + "<allow>"
 				+ "<principal>uid=john,o=NCEAS,dc=ecoinformatics,dc=org</principal>"
 				+ "<permission>all</permission>" + "</allow>" + "<allow>"
 				+ "<principal>public</principal>" + "<permission>read</permission>"
 				+ "</allow>" + "</acl>";
-            daigle
+		debug("xml document: " + content);
-            daigle
+		assertTrue(handleXMLDocument(content, name, "update"));
+	}
 	/**
 	 * Test delete a xml document successfully
 	 */
 	public void testDeleteXMLDocument() {
-            daigle
+		debug("\nRunning: testDeleteXMLDocument test");
-            daigle
+		String name = null;
 		try {
-            daigle
+			name = "john" + PropertyService.getProperty("document.accNumSeparator")
 					+ serialNumber
 					+ PropertyService.getProperty("document.accNumSeparator") + "2";
-            daigle
+		} catch (PropertyNotFoundException pnfe) {
 			fail("Could not find property: " + pnfe.getMessage());
+		}
-            daigle
+		debug("delete docid: " + name);
-            daigle
+		assertTrue(handleDeleteFile(name));
+	}
-            cjones
+  /**
    * Test to delete a document by GUID (not docid).  This exercises
    * MetacatServlet.handleDeleteAction()'s handling of GUIDs.
    */
   public void testDeleteDocumentByGUID() {
     debug("\nRunning: testDeleteDocumentByGUID test");
     CrudServiceTest crudServiceTest = new CrudServiceTest("testDeleteDocumentByGUID");
     String guid = "";
     String user = "uid=john,o=NCEAS,dc=ecoinformatics,dc=org";
 		String passwd = "123456";
 		AuthToken token = null;
 		String result = "";
     // create a document via the CRUD service to get a GUID
     try {
       token = crudServiceTest.getToken(user, passwd);
       String testDocument = crudServiceTest.getTestDoc();
       Identifier identifier = crudServiceTest.createDoc(token, testDocument);
       guid = identifier.getValue();
     } catch (Exception e) {
       fail("Could not create test document to delete: " + e.getMessage());
+    }
     // delete the document via the Metacat servlet with the GUID
     try {
       Properties props = new Properties();
       props.put("action", "delete");
       props.put("docid", guid);
       props.put("sessionid", token.getToken());
       debug("Trying to delete by GUID: " + guid);
       result = getMetacatString(props);
     } catch ( Exception e ) {
       fail("Couldn't delete GUID: " + guid);
+    }
     assertTrue(result.indexOf("<success>") > 0);
+  }
-            daigle
+	/**
 	 * Test logout action
 	 */
 	public void testLogOut() {
-            daigle
+		debug("\nRunning: testLogOut test");
-            daigle
+		assertTrue(handleLogOut());
+	}
 	/**
 	 * Method to hanld login action
             daigle
 	 * @param usrerName,
 	 *            the DN name of the test method
 	 * @param passWord,
 	 *            the passwd of the user
-            daigle
+	 */
 	public boolean logIn(String userName, String passWord) {
 		Properties prop = new Properties();
 		prop.put("action", "login");
 		prop.put("qformat", "xml");
 		prop.put("username", userName);
 		prop.put("password", passWord);
 		// Now contact metacat
 		String response = getMetacatString(prop);
-            daigle
+		debug("Login Message: " + response);
-            daigle
+		boolean connected = false;
 		if (response.indexOf("<login>") != -1) {
 			connected = true;
 		} else {
 			connected = false;
+		}
 		return connected;
+	}
 	/**
 	 * Method to hanld logout action
             daigle
 	 * @param usrerName,
 	 *            the DN name of the test method
 	 * @param passWord,
 	 *            the passwd of the user
-            daigle
+	 */
 	public boolean handleLogOut() {
 		boolean disConnected = false;
 		Properties prop = new Properties();
 		prop.put("action", "logout");
 		prop.put("qformat", "xml");
 		String response = getMetacatString(prop);
-            daigle
+		debug("Logout Message: " + response);
-            daigle
+		HttpMessage.setCookie(null);
 		if (response.indexOf("<logout>") != -1) {
 			disConnected = true;
 		} else {
 			disConnected = false;
+		}
 		return disConnected;
+	}
 	/**
 	 * Method to hanld read both xml and data file
             daigle
 	 * @param docid,
 	 *            the docid of the document want to read
 	 * @param qformat,
 	 *            the format of document user want to get
-            daigle
+	 */
 	public boolean handleReadAction(String docid, String qformat) {
 		Properties prop = new Properties();
 		String message = "";
 		prop.put("action", "read");
 		prop.put("qformat", qformat);
 		prop.put("docid", docid);
 		message = getMetacatString(prop);
 		message = message.trim();
-            daigle
+		if (message == null || message.equals("") || message.indexOf("<error>") != -1) {// there
 																						// was
 																						// an
 																						// error
             daigle
 			return false;
-            daigle
+		} else {// successfully
-            daigle
+			return true;
+		}
+	}
 	/**
 	 * Method to hanld inset or update xml document
             daigle
 	 * @param xmlDocument,
 	 *            the content of xml qformat
 	 * @param docid,
 	 *            the docid of the document
 	 * @param action,
 	 *            insert or update
-            daigle
+	 */
 	public boolean handleXMLDocument(String xmlDocument, String docid, String action)
-            daigle
+	{ // -attempt to write file to metacat
-            daigle
+		String access = "no";
 		StringBuffer fileText = new StringBuffer();
 		StringBuffer messageBuf = new StringBuffer();
 		String accessFileId = null;
 		Properties prop = new Properties();
 		prop.put("action", action);
-            daigle
+		prop.put("public", access); // This is the old way of controlling access
-            daigle
+		prop.put("doctext", xmlDocument);
 		prop.put("docid", docid);
 		String message = getMetacatString(prop);
-            daigle
+		debug("Insert or Update Message: " + message);
 		if (message.indexOf("<error>") != -1) {// there was an error
             daigle
 			return false;
-            daigle
+		} else if (message.indexOf("<success>") != -1) {// the operation worked
 			// write the file to the cache and return the file object
-            daigle
+			return true;
-            daigle
+		} else {// something weird happened.
-            daigle
+			return false;
+		}
+	}
 	public boolean handleDeleteFile(String name) {
 		Properties prop = new Properties();
 		prop.put("action", "delete");
 		prop.put("docid", name);
 		String message = getMetacatString(prop);
-            daigle
+		debug("Delete Message: " + message);
 		if (message.indexOf("<error>") != -1) {// there was an error
             daigle
 			return false;
-            daigle
+		} else if (message.indexOf("<success>") != -1) {// the operation worked
 			// write the file to the cache and return the file object
-            daigle
+			return true;
-            daigle
+		} else {// something weird happened.
-            daigle
+			return false;
+		}
+	}
 	public String getMetacatString(Properties prop) {
 		String response = null;
 		// Now contact metacat and send the request
 		try {
 			InputStreamReader returnStream = new InputStreamReader(
 					getMetacatInputStream(prop));
 			StringWriter sw = new StringWriter();
 			int len;
 			char[] characters = new char[512];
 			while ((len = returnStream.read(characters, 0, 512)) != -1) {
 				sw.write(characters, 0, len);
+			}
 			returnStream.close();
 			response = sw.toString();
 			sw.close();
 		} catch (Exception e) {
 			return null;
+		}
 		return response;
+	}
 	/**
 	 * Send a request to Metacat
             daigle
 	 * @param prop
 	 *            the properties to be sent to Metacat
-            daigle
+	 * @return InputStream as returned by Metacat
 	 */
 	public InputStream getMetacatInputStream(Properties prop) {
 		InputStream returnStream = null;
 		// Now contact metacat and send the request
 		try {
 			URL url = new URL(metacatURL);
 			HttpMessage msg = new HttpMessage(url);
 			returnStream = msg.sendPostMessage(prop);
 			return returnStream;
 		} catch (Exception e) {
 			e.printStackTrace(System.err);
+		}
 		return returnStream;
+	}
             tao

Project

General

Profile

Metacat