Metacat

/**

 *  '$RCSfile$'

 *  Copyright: 2003 Regents of the University of California and the

 *              National Center for Ecological Analysis and Synthesis

 *  Purpose: To test the MetaCatURL class by JUnit

 *

 *   '$Author: jones $'

 *     '$Date: 2003-08-12 12:35:53 -0700 (Tue, 12 Aug 2003) $'

 * '$Revision: 1795 $'

 *

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

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

import edu.ucsb.nceas.utilities.IOUtil;

import java.io.FileReader;

import java.io.InputStreamReader;

import java.io.IOException;

import java.io.Reader;

import java.io.StringReader;

import java.io.StringWriter;

import java.text.DateFormat;

import java.util.Calendar;

import java.util.GregorianCalendar;

import java.util.Date;

import java.util.SimpleTimeZone;

import java.util.TimeZone;

import junit.framework.Test;

import junit.framework.TestCase;

import junit.framework.TestResult;

import junit.framework.TestSuite;

/**

 * A JUnit test for testing Step class processing

 */

public class MetacatClientTest extends TestCase

{

    private String metacatUrl = 

        "http://dev.nceas.ucsb.edu:8091/tao/servlet/metacat";

        //"http://knb.ecoinformatics.org/knb/servlet/metacat";

    private String username = "@mcuser@";

    private String password = "@mcpassword@";

    private String failpass = "uidfnkj43987yfdn";

    private String prefix = "test";

    private String newdocid = null;

    private String testfile = "test/jones.204.22.xml";

    private String queryFile = "test/query.xml";

    private String testdocument = "";

    private Metacat m;

    /**

     * Constructor to build the test

     *

     * @param name the name of the test method

     */

    public MetacatClientTest(String name)

    {

        super(name);

        newdocid = generateDocid();

    }

    /**

     * Establish a testing framework by initializing appropriate objects

     */

    public void setUp()

    {

        try {

            FileReader fr = new FileReader(testfile);

            testdocument = IOUtil.getAsString(fr, true);

        } catch (IOException ioe) {

            fail("Can't read test data to run the test: " + testfile);

        }

        try {

            m = MetacatFactory.createMetacatConnection(metacatUrl);

        } catch (MetacatInaccessibleException mie) {

            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 MetacatClientTest("initialize"));

        suite.addTest(new MetacatClientTest("invalidLogin"));

        suite.addTest(new MetacatClientTest("login"));

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

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

        suite.addTest(new MetacatClientTest("query"));

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

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

        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 {

            m.login(username, password);

        } catch (MetacatAuthException mae) {

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

        } catch (MetacatInaccessibleException mie) {

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

        }

    }

    /**

     * Test the login() function with INVALID credentials

     */

    public void invalidLogin()

    {

        // Try an invalid login

        try {

            m.login(username, failpass);

            fail("Authorization should have failed.");

        } catch (MetacatAuthException mae) {

            assertTrue(1 == 1);

        } catch (MetacatInaccessibleException mie) {

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

        }

    }

    /**

     * Test the read() function with a known document

     */

    public void read()

    {

        try {

            m.login(username, password);

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

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

            System.err.println(doc);

            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 query() function with a known document

     */

    public void query()

    {

        try {

            FileReader fr = new FileReader(queryFile);

            Reader r = m.query(fr);

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

            assertTrue(result.indexOf(newdocid+".1")!=-1);

        } catch (MetacatInaccessibleException mie) {

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

        } catch (Exception e) {

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

        }

    }

    /**

     * Test the insert() function with a known document

     */

    public void insert()

    {

        try {

            String identifier = newdocid + ".1";

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

            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 update() function with a known document

     */

    public void update()

    {

        try {

            String identifier = newdocid + ".2";

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

        }

    }

    /**

     * Create a hopefully unique docid for testing insert and update. Does

     * not include the 'revision' part of the id.

     *

     * @return a String docid based on the current date and time

     */

    private String generateDocid()

    {

        StringBuffer docid = new StringBuffer(prefix);

        docid.append(".");

        // Create a calendar to get the date formatted properly

        String[] ids = TimeZone.getAvailableIDs(-8 * 60 * 60 * 1000);

        SimpleTimeZone pdt = new SimpleTimeZone(-8 * 60 * 60 * 1000, ids[0]);

        pdt.setStartRule(Calendar.APRIL, 1, Calendar.SUNDAY, 2*60*60*1000);

        pdt.setEndRule(Calendar.OCTOBER, -1, Calendar.SUNDAY, 2*60*60*1000);

        Calendar calendar = new GregorianCalendar(pdt);

        Date trialTime = new Date();

        calendar.setTime(trialTime);

        docid.append(calendar.get(Calendar.YEAR));

        docid.append(calendar.get(Calendar.DAY_OF_YEAR));

        docid.append(calendar.get(Calendar.HOUR_OF_DAY));

        docid.append(calendar.get(Calendar.MINUTE));

        docid.append(calendar.get(Calendar.SECOND));

        return docid.toString();

    }

}