Metacat

/**

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

 *    Authors: Jing Tao

 *

 *   '$Author: jones $'

 *     '$Date: 2011-05-19 19:06:08 -0700 (Thu, 19 May 2011) $'

 * '$Revision: 6094 $'

 *

 * 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 edu.ucsb.nceas.MCTestCase;

import edu.ucsb.nceas.metacat.dataone.CrudServiceTest;

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

import edu.ucsb.nceas.utilities.HttpMessage;

import edu.ucsb.nceas.utilities.PropertyNotFoundException;

import junit.framework.Test;

import junit.framework.TestSuite;

import java.io.*;

import java.net.*;

import java.util.*;

import org.dataone.service.types.AuthToken;

import org.dataone.service.types.Identifier;

/**

 * A JUnit test for testing Step class processing

 */

public class MetaCatServletTest extends MCTestCase {

	private static String metacatURL;

	private String serialNumber;

	/* Initialize properties */

	static {

		try {

			metacatURL = PropertyService.getProperty("test.metacatUrl");

		} catch (PropertyNotFoundException pnfe) {

			System.err.println("Could not get property in static block: "

					+ pnfe.getMessage());

		}

	}

	/**

	 * Constructor to build the test

	 * 

	 * @param name

	 *            the name of the test method

	 */

	public MetaCatServletTest(String name) {

		super(name);

	}

	/**

	 * Constructor to build the test

	 * 

	 * @param name

	 *            the name of the test method

	 */

	public MetaCatServletTest(String name, String serial) {

		super(name);

		serialNumber = serial;

	}

	/**

	 * Establish a testing framework by initializing appropriate objects

	 */

	public void setUp() {

	}

	/**

	 * Release any objects after tests are complete

	 */

	public void tearDown() {

	}

	/**

	 * Create a suite of tests to be run together

	 */

	public static Test suite() {

		double number = 0;

		String serial = null;

		TestSuite suite = new TestSuite();

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

		suite.addTest(new MetaCatServletTest("testLterReferralLogin"));

		suite.addTest(new MetaCatServletTest("testLterReferralLoginFail"));

		// the pisco referral isn't working in test environment, so commenting out the tests

		//		suite.addTest(new MetaCatServletTest("testPiscoReferralLogin"));

		//      suite.addTest(new MetaCatServletTest("testPiscoReferralLoginFail"));

		suite.addTest(new MetaCatServletTest("testNCEASLoginFail"));

		// Should put a login successfully at the end of login test

		// So insert or update can have cookie.

		suite.addTest(new MetaCatServletTest("testNCEASLogin"));

		// create random number for docid, so it can void repeat

		number = Math.random() * 100000;

		serial = Integer.toString(((new Double(number)).intValue()));

		debug("serial: " + serial);

		suite.addTest(new MetaCatServletTest("testInsertXMLDocument", serial));

		suite.addTest(new MetaCatServletTest("testReadXMLDocumentXMLFormat", serial));

		suite.addTest(new MetaCatServletTest("testUpdateXMLDocument", serial));

		suite.addTest(new MetaCatServletTest("testReadXMLDocumentHTMLFormat", serial));

		suite.addTest(new MetaCatServletTest("testReadXMLDocumentZipFormat", serial));

		suite.addTest(new MetaCatServletTest("testDeleteXMLDocument", serial));

		// test delete using GUID

		number = Math.random() * 100000;

		serial = Integer.toString(((new Double(number)).intValue()));

		suite.addTest(new MetaCatServletTest("testDeleteDocumentByGUID", serial));

		// insert invalid xml document

		number = Math.random() * 100000;

		serial = Integer.toString(((new Double(number)).intValue()));

		suite.addTest(new MetaCatServletTest("testInsertInvalidateXMLDocument", serial));

		// insert non well formed document

		number = Math.random() * 100000;

		serial = Integer.toString(((new Double(number)).intValue()));

		suite

				.addTest(new MetaCatServletTest("testInsertNonWellFormedXMLDocument",

						serial));

		suite.addTest(new MetaCatServletTest("testLogOut"));

		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 to neceas succesfully

	 */

    public void testNCEASLogin() {

        debug("\nRunning: testNCEASLogin test");

        try {

            String user = PropertyService.getProperty("test.mcUser");

            String passwd = PropertyService.getProperty("test.mcPassword");

            assertTrue(logIn(user, passwd));

        } catch (PropertyNotFoundException pnfe) {

            fail("Could not find property: " + pnfe.getMessage());

        }

    }

	/**

	 * Test the login to neceas failed

	 */

	public void testNCEASLoginFail() {

		debug("\nRunning: testNCEASLoginFail test");

        try {

            String user = PropertyService.getProperty("test.mcUser");

            String passwd = "BogusPasswordShouldFail";

            assertTrue(!logIn(user, passwd));

        } catch (PropertyNotFoundException pnfe) {

            fail("Could not find property: " + pnfe.getMessage());

        }

	}

	/**

	 * Test the login to lter succesfully

	 */

	public void testLterReferralLogin() {

		debug("\nRunning: testLterReferralLogin test");

		String user = null;

		String passwd = null;

		try {

			user = PropertyService.getProperty("test.lterUser");

			passwd = PropertyService.getProperty("test.lterPassword");

		} catch (PropertyNotFoundException pnfe) {

			fail("Could not find property: " + pnfe.getMessage());

		}

		debug("Logging into lter: " + user + " : " + passwd);

		assertTrue(logIn(user, passwd));

	}

	/**

	 * Test the login to lter failed

	 */

	public void testLterReferralLoginFail() {

		debug("\nRunning: testLterReferralLoginFail test");

		String user = "uid=jtao,o=LTER,dc=ecoinformatics,dc=org";

		String passwd = "qVyGpveb";

		assertTrue(!logIn(user, passwd));

		// assertTrue( withProtocol.getProtocol().equals("http"));

	}

	/**

	 * Test the login to pisco succesfully

	 */

	public void testPiscoReferralLogin() {

		debug("\nRunning: testPiscoReferralLogin test");

		String user = null;

		String passwd = null;

		try {

			user = PropertyService.getProperty("test.piscoUser");

			passwd = PropertyService.getProperty("test.piscoPassword");

		} catch (PropertyNotFoundException pnfe) {

			fail("Could not find property: " + pnfe.getMessage());

		}

		debug("logging in pisco user: " + user + ":" + passwd);

		assertTrue(logIn(user, passwd));

		// assertTrue( withProtocol.getProtocol().equals("http"));

	}

	/**

	 * Test the login to pisco failed

	 */

	public void testPiscoReferralLoginFail() {

		debug("\nRunning: testPiscoReferralLoginFail test");

		String user = "uid=tao,o=PISCO,dc=ecoinformatics,dc=org";

		String passwd = "hello";

		assertTrue(!logIn(user, passwd));

		// assertTrue( withProtocol.getProtocol().equals("http"));

	}

	/**

	 * Test insert a xml document successfully

	 */

    public void testInsertXMLDocument() {

        debug("\nRunning: testInsertXMLDocument test");

        String name = null;

        try {

            String user = PropertyService.getProperty("test.mcUser");

            String passwd = PropertyService.getProperty("test.mcPassword");

            name = "john" + PropertyService.getProperty("document.accNumSeparator") + serialNumber + PropertyService.getProperty("document.accNumSeparator")

                    + "1";

            debug("insert docid: " + name);

            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>" + user

                    + "</principal>" + "<permission>all</permission>" + "</allow>" + "<allow>" + "<principal>public</principal>"

                    + "<permission>read</permission>" + "</allow>" + "</acl>";

            debug("xml document: " + content);

            assertTrue(handleXMLDocument(content, name, "insert"));

        } catch (PropertyNotFoundException pnfe) {

            fail("Could not find property: " + pnfe.getMessage());

        }

    }

	/**

	 * Test insert a invalidate xml document successfully In the String, there

	 * is no <!Doctype ... Public/System/>

	 */

    public void testInsertInvalidateXMLDocument() {

        debug("\nRunning: testInsertInvalidateXMLDocument test");

        String name = null;

        try {

            String user = PropertyService.getProperty("test.mcUser");

            String passwd = PropertyService.getProperty("test.mcPassword");

            name = "john" + PropertyService.getProperty("document.accNumSeparator") + serialNumber + PropertyService.getProperty("document.accNumSeparator")

                    + "1";

            debug("insert docid: " + name);

            String content = "<?xml version=\"1.0\"?>" + "<acl authSystem=\"knb\" order=\"allowFirst\">" + "<identifier>" + name + "</identifier>" + "<allow>"

                    + "<principal>" + user + "</principal>" + "<permission>all</permission>" + "</allow>" + "<allow>" + "<principal>public</principal>"

                    + "<permission>read</permission>" + "</allow>" + "</acl>";

            debug("xml document: " + content);

            assertTrue(handleXMLDocument(content, name, "insert"));

        } catch (PropertyNotFoundException pnfe) {

            fail("Could not find property: " + pnfe.getMessage());

        }

    }

	/**

	 * Test insert a non well-formed xml document successfully There is no

	 * </acl> in this string

	 */

    public void testInsertNonWellFormedXMLDocument() {

        debug("\nRunning: testInsertNonWellFormedXMLDocument test");

        String name = null;

        try {

            String user = PropertyService.getProperty("test.mcUser");

            String passwd = PropertyService.getProperty("test.mcPassword");

            name = "john" + PropertyService.getProperty("document.accNumSeparator") + serialNumber + PropertyService.getProperty("document.accNumSeparator")

                    + "1";

            debug("insert non well-formed docid: " + name);

            String content = "<?xml version=\"1.0\"?>" + "<acl authSystem=\"knb\" order=\"allowFirst\">" + "<identifier>" + name + "</identifier>" + "<allow>"

                    + "<principal>" + user + "</principal>" + "<permission>all</permission>" + "</allow>" + "<allow>" + "<principal>public</principal>"

                    + "<permission>read</permission>" + "</allow>";

            debug("xml document: " + content);

            assertTrue(!handleXMLDocument(content, name, "insert"));

        } catch (PropertyNotFoundException pnfe) {

            fail("Could not find property: " + pnfe.getMessage());

        }

    }

	/**

	 * Test read a xml document in xml format successfully

	 */

	public void testReadXMLDocumentXMLFormat() {

		debug("\nRunning: testReadXMLDocumentXMLFormat test");

		String name = null;

		try {

			name = "john" + PropertyService.getProperty("document.accNumSeparator")

					+ serialNumber

					+ PropertyService.getProperty("document.accNumSeparator") + "1";

		} catch (PropertyNotFoundException pnfe) {

			fail("Could not find property: " + pnfe.getMessage());

		}

		assertTrue(handleReadAction(name, "xml"));

	}

	/**

	 * Test read a xml document in html format successfully

	 */

	public void testReadXMLDocumentHTMLFormat() {

		debug("\nRunning: testReadXMLDocumentHTMLFormat test");

		String name = null;

		try {

			name = "john" + PropertyService.getProperty("document.accNumSeparator")

					+ serialNumber

					+ PropertyService.getProperty("document.accNumSeparator") + "1";

		} catch (PropertyNotFoundException pnfe) {

			fail("Could not find property: " + pnfe.getMessage());

		}

		assertTrue(handleReadAction(name, "html"));

	}

	/**

	 * Test read a xml document in zip format successfully

	 */

	public void testReadXMLDocumentZipFormat() {

		debug("\nRunning: testReadXMLDocumentZipFormat test");

		String name = null;

		try {

			name = "john" + PropertyService.getProperty("document.accNumSeparator")

					+ serialNumber

					+ PropertyService.getProperty("document.accNumSeparator") + "1";

		} catch (PropertyNotFoundException pnfe) {

			fail("Could not find property: " + pnfe.getMessage());

		}

		assertTrue(handleReadAction(name, "zip"));

	}

	/**

	 * Test insert a xml document successfully

	 */

    public void testUpdateXMLDocument() {

        debug("\nRunning: testUpdateXMLDocument test");

        String name = null;

        try {

            String user = PropertyService.getProperty("test.mcUser");

            String passwd = PropertyService.getProperty("test.mcPassword");

            name = "john" + PropertyService.getProperty("document.accNumSeparator") + serialNumber + PropertyService.getProperty("document.accNumSeparator")

                    + "2";

            debug("update docid: " + name);

            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>" + user

                    + "</principal>" + "<permission>all</permission>" + "</allow>" + "<allow>" + "<principal>public</principal>"

                    + "<permission>read</permission>" + "</allow>" + "</acl>";

            debug("xml document: " + content);

            assertTrue(handleXMLDocument(content, name, "update"));

        } catch (PropertyNotFoundException pnfe) {

            fail("Could not find property: " + pnfe.getMessage());

        }

    }

	/**

	 * Test delete a xml document successfully

	 */

	public void testDeleteXMLDocument() {

		debug("\nRunning: testDeleteXMLDocument test");

		String name = null;

		try {

			name = "john" + PropertyService.getProperty("document.accNumSeparator")

					+ serialNumber

					+ PropertyService.getProperty("document.accNumSeparator") + "2";

		} catch (PropertyNotFoundException pnfe) {

			fail("Could not find property: " + pnfe.getMessage());

		}

		debug("delete docid: " + name);

		assertTrue(handleDeleteFile(name));

	}

    /**

     * Test to delete a document by GUID (not docid).  This exercises 

     * MetacatServlet.handleDeleteAction()'s handling of GUIDs.

     */

    public void testDeleteDocumentByGUID() {

        debug("\nRunning: testDeleteDocumentByGUID test");

        try {

            String user = PropertyService.getProperty("test.mcUser");

            String passwd = PropertyService.getProperty("test.mcPassword");

            CrudServiceTest crudServiceTest = new CrudServiceTest("testDeleteDocumentByGUID");

            String guid = "";

            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);

        } catch (PropertyNotFoundException pnfe) {

            fail("Could not find property: " + pnfe.getMessage());

        }

    }

	/**

	 * Test logout action

	 */

	public void testLogOut() {

		debug("\nRunning: testLogOut test");

		assertTrue(handleLogOut());

	}

	/**

	 * Method to hanld login action

	 * 

	 * @param usrerName,

	 *            the DN name of the test method

	 * @param passWord,

	 *            the passwd of the user

	 */

	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);

		debug("Login Message: " + response);

		boolean connected = false;

		if (response.indexOf("<login>") != -1) {

			connected = true;

		} else {

			connected = false;

		}

		return connected;

	}

	/**

	 * Method to hanld logout action

	 * 

	 * @param usrerName,

	 *            the DN name of the test method

	 * @param passWord,

	 *            the passwd of the user

	 */

	public boolean handleLogOut() {

		boolean disConnected = false;

		Properties prop = new Properties();

		prop.put("action", "logout");

		prop.put("qformat", "xml");

		String response = getMetacatString(prop);

		debug("Logout Message: " + response);

		HttpMessage.setCookie(null);

		if (response.indexOf("<logout>") != -1) {

			disConnected = true;

		} else {

			disConnected = false;

		}

		return disConnected;

	}

	/**

	 * Method to hanld read both xml and data file

	 * 

	 * @param docid,

	 *            the docid of the document want to read

	 * @param qformat,

	 *            the format of document user want to get

	 */

	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();

		if (message == null || message.equals("") || message.indexOf("<error>") != -1) {// there

																						// was

																						// an

																						// error

			return false;

		} else {// successfully

			return true;

		}

	}

	/**

	 * Method to hanld inset or update xml document

	 * 

	 * @param xmlDocument,

	 *            the content of xml qformat

	 * @param docid,

	 *            the docid of the document

	 * @param action,

	 *            insert or update

	 */

	public boolean handleXMLDocument(String xmlDocument, String docid, String action)

	{ // -attempt to write file to metacat

		String access = "no";

		StringBuffer fileText = new StringBuffer();

		StringBuffer messageBuf = new StringBuffer();

		String accessFileId = null;

		Properties prop = new Properties();

		prop.put("action", action);

		prop.put("public", access); // This is the old way of controlling access

		prop.put("doctext", xmlDocument);

		prop.put("docid", docid);

		String message = getMetacatString(prop);

		debug("Insert or Update Message: " + message);

		if (message.indexOf("<error>") != -1) {// there was an error

			return false;

		} else if (message.indexOf("<success>") != -1) {// the operation worked

			// write the file to the cache and return the file object

			return true;

		} else {// something weird happened.

			return false;

		}

	}

	public boolean handleDeleteFile(String name) {

		Properties prop = new Properties();

		prop.put("action", "delete");

		prop.put("docid", name);

		String message = getMetacatString(prop);

		debug("Delete Message: " + message);

		if (message.indexOf("<error>") != -1) {// there was an error

			return false;

		} else if (message.indexOf("<success>") != -1) {// the operation worked

			// write the file to the cache and return the file object

			return true;

		} else {// something weird happened.

			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

	 * 

	 * @param prop

	 *            the properties to be sent to Metacat

	 * @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;

	}

}