/**
* '$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$'
* '$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.metacatnettest;
import java.io.File;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.StringWriter;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Properties;
import junit.framework.Test;
import junit.framework.TestSuite;
import org.apache.http.HttpResponse;
import org.apache.http.HttpVersion;
import org.apache.http.NameValuePair;
import org.apache.http.client.HttpClient;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.mime.HttpMultipartMode;
import org.apache.http.entity.mime.MultipartEntity;
import org.apache.http.entity.mime.content.FileBody;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.params.CoreProtocolPNames;
import org.apache.http.util.EntityUtils;
import edu.ucsb.nceas.MCTestCase;
import edu.ucsb.nceas.metacat.properties.PropertyService;
import edu.ucsb.nceas.utilities.PropertyNotFoundException;
/**
* A JUnit test for testing Step class processing
*/
public class MetaCatServletNetTest extends MCTestCase {
private String serialNumber;
private static String sessionId;
/**
* Constructor to build the test
*
* @param name the name of the test method
*/
public MetaCatServletNetTest(String name) {
super(name);
}
/**
* Constructor to build the test
*
* @param name the name of the test method
*/
public MetaCatServletNetTest(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 MetaCatServletNetTest("testNCEASLoginFail"));
//Should put a login successfully at the end of login test
//So insert or update can have cookie.
suite.addTest(new MetaCatServletNetTest("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 MetaCatServletNetTest("testInsertXMLDocument", serial));
suite.addTest(new MetaCatServletNetTest("testReadXMLDocumentXMLFormat", serial));
suite.addTest(new MetaCatServletNetTest("testUpdateXMLDocument", serial));
suite.addTest(new MetaCatServletNetTest("testReadXMLDocumentHTMLFormat", serial));
suite.addTest(new MetaCatServletNetTest("testReadXMLDocumentZipFormat", serial));
suite.addTest(new MetaCatServletNetTest("testDeleteXMLDocument", serial));
//insert invalid xml document
number = Math.random() * 100000;
serial = Integer.toString(((new Double(number)).intValue()));
suite.addTest(new MetaCatServletNetTest("testInsertInvalidateXMLDocument",
serial));
//insert non well formed document
number = Math.random() * 100000;
serial = Integer.toString(((new Double(number)).intValue()));
suite.addTest(new MetaCatServletNetTest("testInsertNonWellFormedXMLDocument",
serial));
//insert data file
number = Math.random() * 100000;
serial = Integer.toString(((new Double(number)).intValue()));
suite.addTest(new MetaCatServletNetTest("testLogOut"));
suite.addTest(new MetaCatServletNetTest("testReadFile"));
return suite;
}
/**
* Test the login to nceas succesfully
*/
public void testNCEASLogin() {
System.out.println("Testing nceas login");
debug("\nRunning: testNCEASLogin test");
try {
String user = PropertyService.getProperty("test.mcUser");
String passwd = PropertyService.getProperty("test.mcPassword");
assertTrue(logIn(user, passwd));
//assertTrue( withProtocol.getProtocol().equals("http"));
} catch (PropertyNotFoundException e) {
fail(e.getMessage());
}
}
/**
* Test the login to nceas failed
*/
public void testNCEASLoginFail() {
debug("\nRunning: testNCEASLoginFail test");
try {
String user = PropertyService.getProperty("test.mcUser");
System.out.println("Testing nceas login fail");
String passwd = "thisPasswordIsInvalidAndShouldFail";
assertTrue(!logIn(user, passwd));
} catch (PropertyNotFoundException e) {
fail(e.getMessage());
}
}
/**
* Test the login to lter failed
*/
public void testLterReferralLoginFail() {
debug("\nRunning: testLterReferralLoginFail test");
try {
String user = PropertyService.getProperty("test.lterUser");
String passwd = "thisPasswordIsInvalidAndShouldFail";
assertTrue(!logIn(user, passwd));
//assertTrue( withProtocol.getProtocol().equals("http"));
} catch (PropertyNotFoundException e) {
fail(e.getMessage());
}
}
/**
* Test insert a xml document successfully
*/
public void testInsertXMLDocument() throws PropertyNotFoundException {
debug("\nRunning: testInsertXMLDocument test");
String 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>uid=john,o=NCEAS,dc=ecoinformatics,dc=org</principal>"
+ "<permission>all</permission>" + "</allow>" + "<allow>"
+ "<principal>public</principal>" + "<permission>read</permission>"
+ "</allow>" + "</acl>";
debug("xml document: " + content);
assertTrue(handleXMLDocument(content, name, "insert"));
}
/**
* Test insert a invalidate xml document successfully
* In the String, there is no <!Doctype ... Public/System/>
*/
public void testInsertInvalidateXMLDocument() throws PropertyNotFoundException {
debug("\nRunning: testInsertInvalidateXMLDocument test");
String 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>uid=john,o=NCEAS,dc=ecoinformatics,dc=org</principal>"
+ "<permission>all</permission>" + "</allow>" + "<allow>"
+ "<principal>public</principal>" + "<permission>read</permission>"
+ "</allow>" + "</acl>";
debug("xml document: " + content);
assertTrue(handleXMLDocument(content, name, "insert"));
}
/**
* Test insert a non well-formed xml document successfully
* There is no </acl> in this string
*/
public void testInsertNonWellFormedXMLDocument() throws PropertyNotFoundException {
debug("\nRunning: testInsertNonWellFormedXMLDocument test");
String 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>uid=john,o=NCEAS,dc=ecoinformatics,dc=org</principal>"
+ "<permission>all</permission>" + "</allow>" + "<allow>"
+ "<principal>public</principal>" + "<permission>read</permission>"
+ "</allow>";
debug("xml document: " + content);
assertTrue(!handleXMLDocument(content, name, "insert"));
}
/**
* Test read a xml document in xml format successfully
*/
public void testReadXMLDocumentXMLFormat() throws PropertyNotFoundException {
debug("\nRunning: testReadXMLDocumentXMLFormat test");
String name = "john" + PropertyService.getProperty("document.accNumSeparator") + serialNumber
+ PropertyService.getProperty("document.accNumSeparator") + "1";
assertTrue(handleReadAction(name, "xml"));
}
/**
* Test read a xml document in html format successfully
*/
public void testReadXMLDocumentHTMLFormat() throws PropertyNotFoundException {
debug("\nRunning: testReadXMLDocumentHTMLFormat test");
String name = "john" + PropertyService.getProperty("document.accNumSeparator") + serialNumber
+ PropertyService.getProperty("document.accNumSeparator") + "1";
assertTrue(handleReadAction(name, "html"));
}
/**
* Test read a xml document in zip format successfully
*/
public void testReadXMLDocumentZipFormat() throws PropertyNotFoundException {
debug("\nRunning: testReadXMLDocumentZipFormat test");
String name = "john" + PropertyService.getProperty("document.accNumSeparator") + serialNumber
+ PropertyService.getProperty("document.accNumSeparator") + "1";
assertTrue(handleReadAction(name, "zip"));
}
/**
* Test insert a xml document successfully
*/
public void testUpdateXMLDocument() throws PropertyNotFoundException {
debug("\nRunning: testUpdateXMLDocument test");
String 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>uid=john,o=NCEAS,dc=ecoinformatics,dc=org</principal>"
+ "<permission>all</permission>" + "</allow>" + "<allow>"
+ "<principal>public</principal>" + "<permission>read</permission>"
+ "</allow>" + "</acl>";
debug("xml document: " + content);
//sleep to make sure the original document was indexed
try {
String indexDelay = PropertyService.getProperty("database.maximumIndexDelay");
Thread.sleep(Integer.parseInt(indexDelay));
} catch (Exception e) {
fail(e.getMessage());
}
assertTrue(handleXMLDocument(content, name, "update"));
}
/**
* Test insert a data file successfully
*/
public void testInertDataFile() throws PropertyNotFoundException {
debug("\nRunning: testInertDataFile test");
String name = "john" + PropertyService.getProperty("document.accNumSeparator") + serialNumber
+ PropertyService.getProperty("document.accNumSeparator") + "1";
debug("insert data file docid: " + name);
debug("insert data file ");
File hello = new File("test/jones.204.22.xml");
assertTrue(insertDataFile(name, hello));
}
/**
* Test delete a xml document successfully
*/
public void testDeleteXMLDocument() throws PropertyNotFoundException {
debug("\nRunning: testDeleteXMLDocument test");
String name = "john" + PropertyService.getProperty("document.accNumSeparator") + serialNumber
+ PropertyService.getProperty("document.accNumSeparator") + "2";
debug("delete docid: " + name);
//sleep to make sure the original document was indexed
try {
String indexDelay = PropertyService.getProperty("database.maximumIndexDelay");
Thread.sleep(Integer.parseInt(indexDelay));
} catch (Exception e) {
fail(e.getMessage());
}
assertTrue(handleDeleteFile(name));
}
/**
* 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;
// set the session id
int start = response.indexOf("<sessionId>") + 11;
int end = response.indexOf("</sessionId>");
if ((start != -1) && (end != -1)) {
sessionId = response.substring(start,end);
}
} else {
sessionId = "";
connected = false;
}
debug("sessionId: " + this.sessionId);
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);
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();
//MetacatUtil.debugMessage("Read Message: "+message, 30);
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;
}
}
/**
* sends a data file to the metacat using "multipart/form-data" encoding
*
* @param id the id to assign to the file on metacat (e.g., knb.1.1)
* @param file the file to send
*/
public boolean insertDataFile(String id, File file) {
String response = null;
//Get response for calling sendDataFile function
response = sendDataFile(id, file);
if (response.indexOf("success") != -1) {
//insert successfully
return true;
} else {
return false;
}
}
/**
* sends a data file to the metacat using "multipart/form-data" encoding
*
* @param id the id to assign to the file on metacat (e.g., knb.1.1)
* @param file the file to send
*/
public String sendDataFile(String docid, File file) {
String response = null;
try {
HttpClient httpclient = new DefaultHttpClient();
httpclient.getParams().setParameter(
CoreProtocolPNames.PROTOCOL_VERSION,
HttpVersion.HTTP_1_1);
httpclient.getParams().setParameter(
CoreProtocolPNames.HTTP_CONTENT_CHARSET,
"UTF-8");
HttpPost post = new HttpPost(metacatUrl);
MultipartEntity entity = new MultipartEntity(HttpMultipartMode.BROWSER_COMPATIBLE);
// For File parameters
entity.addPart("datafile", new FileBody(file));
//set up properties
Properties prop = new Properties();
prop.put("action", "upload");
prop.put("docid", docid);
// For usual String parameters
Enumeration<Object> keys = prop.keys();
while (keys.hasMoreElements()) {
String key = (String) keys.nextElement();
String value = prop.getProperty(key);
entity.addPart(key, new StringBody(value, Charset.forName("UTF-8")));
}
post.setHeader("Cookie", "JSESSIONID=" + sessionId);
post.setEntity(entity);
response = EntityUtils.toString(httpclient.execute(post).getEntity(), "UTF-8");
httpclient.getConnectionManager().shutdown();
} catch (Exception e) {
e.printStackTrace();
}
return response;
}
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) throws Exception {
InputStream result = null;
HttpClient httpclient = new DefaultHttpClient();
httpclient.getParams().setParameter(
CoreProtocolPNames.PROTOCOL_VERSION,
HttpVersion.HTTP_1_1);
httpclient.getParams().setParameter(
CoreProtocolPNames.HTTP_CONTENT_CHARSET,
"UTF-8");
HttpPost post = new HttpPost(metacatUrl);
//set the params
List<NameValuePair> nameValuePairs = new ArrayList<NameValuePair>();
Enumeration<Object> keys = prop.keys();
while (keys.hasMoreElements()) {
String key = (String) keys.nextElement();
String value = prop.getProperty(key);
NameValuePair nvp = new BasicNameValuePair(key, value);
nameValuePairs.add(nvp);
}
debug("getMetacatInputStream.sessionId: " + sessionId);
post.setHeader("Cookie", "JSESSIONID=" + sessionId);
post.setEntity(new UrlEncodedFormEntity(nameValuePairs, "UTF-8"));
HttpResponse httpResponse = httpclient.execute(post);
result = httpResponse.getEntity().getContent();
return result;
}
/**
* Test to read a file from Metacat
* @throws Exception
*/
public void testReadFile() throws Exception {
String webapps = PropertyService.getProperty("application.deployDir");
String context = PropertyService.getProperty("application.context");
String docId = "file://" + webapps + "/" + context + "/schema/eml-2.2.0/eml.xsd";
String qformat = "zip";
assertTrue(!handleReadAction(docId, qformat));
qformat = "knb";
assertTrue(!handleReadAction(docId, qformat));
}
}