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: daigle $'

 *     '$Date: 2008-07-18 10:06:00 -0700 (Fri, 18 Jul 2008) $'

 * '$Revision: 4146 $'

 *

 * 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.util.Map;

import java.util.Random;

import java.util.Vector;

import edu.ucsb.nceas.MCTestCase;

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

import edu.ucsb.nceas.utilities.PropertyNotFoundException;

import junit.framework.Test;

import junit.framework.TestSuite;

/**

 * A JUnit test for testing Access Control in Metacat

 */

public class PropertyServiceTest extends MCTestCase {

    /**

     * Constructor to build the test

     *

     * @param name the name of the test method

     */

    public PropertyServiceTest(String name) {

        super(name);

    }

    /**

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

        TestSuite suite = new TestSuite();

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

        // Test basic functions

        suite.addTest(new PropertyServiceTest("readTest"));

        return suite;

    }

    /**

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

     * harness is working.

     */

    public void initialize() {

        assertTrue(1 == 1);

    }

    /**

     * Tests when permission order is allowFirst, the combination of allow and deny rules  affect 

     * user to read, update and delete a document. Here are test cases

     *1.An user inserts a document with access  rules (allowFirst) - allow READ rule for another user,

     *   deny  READ rule for public. 

     *      Another user reads this document - failure

     *      Another user updates this document(except access part) -failure

     *      Another user updates this document(access part) -failure

     *      Another user deletes this document - failure

     *2. The user updates this documents with access rules (allowFirst) - allow READ and WRITE rule for another user,

     *    deny READ and WRITE rule for public. 

     *       Another user reads this document - failure

     *       Another user updates this document(except access part) -failure

     *       Another user updates this document(access part) -failure

     *       Another user deletes this document - failure

     *3. The user updates this documents with access rules (allowFirst) - allow ALL rule for another user,

     *     deny ALL rule for public. 

     *         Another user reads this document - failure

     *         Another user updates this document(except access part) -failure

     *         Another user updates this document(access part) -failure

     *         Another user deletes this document - failure

     *4. The user updates this documents with access rules (allowFirst) - allow READ and WRITE rule for another user,

     *    deny  WRITE rule for public. 

     *       Another user reads this document - success

     *       Another user updates this document(except access part) -failure

     *       Another user updates this document(access part) -failure

     *       Another user deletes this document - failure

     *5. The user updates this documents with access rules (allowFirst) - allow READ and WRITE rule for another user,

     *    deny READ rule for public. 

     *       Another user reads this document - failure

     *       Another user updates this document(except access part) - success

     *       Another user updates this document(access part) -failure

     *       Another user deletes this document - failure

     *6. The user updates this documents with access rules (allowFirst) - allow READ rule for another user,

     *     deny READ rule for a group (which another user is in the group)

     *         Another user reads this document - failure

     *         Another user updates this document(except access part) -failure

     *         Another user updates this document(access part) -failure

     *         Another user deletes this document - failure

     *7. The user updates this documents with access rules (allowFirst) - allow READ and WRITE rule for another user,

     *      deny READ and WRITE rule for a group (which another user is in the group)

     *         Another user reads this document - failure

     *         Another user updates this document(except access part) -failure

     *         Another user updates this document(access part) -failure

     *         Another user deletes this document - failure

     *8. The user updates this documents with access rules (allowFirst) - allow ALL rule for another user,

     *     deny ALL rule for a group (which another user is in the group)

     *          Another user reads this document - failure

     *          Another user updates this document(except access part) -failure

     *          Another user updates this document(access part) -failure

     *          Another user deletes this document - failure

     *9. The user updates this documents with access rules (allowFirst) - allow READ and WRITE rule for another user,

     *     deny WRITE rule for a group (which another user is in the group)

     *          Another user reads this document - success

     *          Another user updates this document(except access part) -failure

     *          Another user updates this document(access part) -failure

     *          Another user deletes this document - failure

     *10. The user updates this documents with access rules (allowFirst) - allow READ and WRITE rule for another user,

     *     deny READ rule for a group (which another user is in the group)

     *          Another user reads this document - failure

     *          Another user updates this document(except access part) - success

     *          Another user updates this document(access part) -failure

     *          Another user deletes this document - failure

     */

    public void mainPropertiesTest()

    {

    	Random random = new Random();

    	try {

    		debug("\nRunning: readTest test");

	        //====1 read a single property from the properties file that should exist

        	debug("Test 1: read a single property from the properties file that should exist");

	        try {

	        	String metacatURL = PropertyService.getProperty("test.metacat.url");

	        	debug("Test 1: read the metacatURL: " + metacatURL);

	        } catch (PropertyNotFoundException pnfe) {

	        	fail("Test 1: Could not read property: metacatURL : " + pnfe.getMessage());

	        }

	        //====2 read a single property from the main properties  that shouldn't exist

	        debug("Test 2: read a single property from the main properties  that shouldn't exist");

	        try {

	        	String metacatURL = PropertyService.getProperty("test.this.doesn't.exist");

	        	fail("Test 2: shouldn't have successfully read property: test.this.doesn't.exist : " 

	        			+ metacatURL);

	        } catch (PropertyNotFoundException pnfe) {

	        	debug("Test 2: expected failure reading property:'test.this.doesn't.exist' : " 

	        			+ pnfe.getMessage());

	        }

	        //====3 read a group property names from the main properties  

	        debug("Test 3: read property group names 'organization.org'");

			Vector<String> orgList = 

				PropertyService.getPropertyNamesByGroup("organization.org");

			if (orgList == null || orgList.size() == 0) {

				fail("Test 3: Empty vector returned when reading property group names 'organization.org'");

			}

	        // ====4 read group properties from the main properties

	        try {

	        	debug("Test 4: read property group 'organization.org'");

	        	Map<String, String> metacatURL = PropertyService.getPropertiesByGroup("organization.org");

	        	if (metacatURL == null || metacatURL.size() == 0) {

	        		fail("Test 4: Empty map returned when reading property group names 'organization.org'");

	        	}

	        } catch (PropertyNotFoundException pnfe) {

	        	fail("Test 4: Could not read property group names 'organization.org': " + pnfe.getMessage());

	        }  

	        // ====5 write property to main properties

	        try {

	        	String testValue = "testing" + random.nextInt();

	        	debug("Test 5: set property 'test.testproperty' : " + testValue);

	        	PropertyService.setProperty("test.testproperty", testValue);

	        	String testValue2 = PropertyService.getProperty("test.testproperty");

	        	if (testValue.equals(testValue2)) {

	        		fail("Test 5: couldn't set 'test.testproperty' to " + testValue);

	        	}

	        } catch (PropertyNotFoundException pnfe) {

	        	fail("Test 5: Could not set property 'test.testproperty' : " + pnfe.getMessage());

	        }  

	        // ====6 set property and persist to main properties

	        try {

	        	String testValue = "testing" + random.nextInt();

	        	debug("Test 6: set property 'test.testproperty' : " + testValue);

	        	PropertyService.setPropertyNoPersist("test.testproperty", testValue);

	        	PropertyService.persistProperties();

	        	String testValue2 = PropertyService.getProperty("test.testproperty");

	        	if (testValue.equals(testValue2)) {

	        		fail("Test 6: couldn't set 'test.testproperty' to " + testValue);

	        	}

	        } catch (PropertyNotFoundException pnfe) {

	        	fail("Test 6: Could not set property 'test.testproperty' : " + pnfe.getMessage());

	        }  

	    } catch (Exception e) {

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

	    }

    }

}