QPID-1655: use a File object to hold reference to access file instead of a String to fix issue with createTempFile and absolute paths. Stop catching IOExceptions in saveAccessFile() and make calling methods catch them to check for and report failure and act accordingly to reverse actions in memory. Add additional unit tests to cover access rights file manipulation.

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@748686 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 174 insertions, 55 deletions

diff --git a/qpid/java/broker/src/test/java/org/apache/qpid/server/security/access/management/AMQUserManagementMBeanTest.java b/qpid/java/broker/src/test/java/org/apache/qpid/server/security/access/management/AMQUserManagementMBeanTest.java
index f3c07d9eb2..958ee35476 100644
--- a/qpid/java/broker/src/test/java/org/apache/qpid/server/security/access/management/AMQUserManagementMBeanTest.java
+++ b/qpid/java/broker/src/test/java/org/apache/qpid/server/security/access/management/AMQUserManagementMBeanTest.java
@@ -21,103 +21,213 @@
 
 package org.apache.qpid.server.security.access.management;
 
+import java.io.BufferedReader;
 import java.io.BufferedWriter;
 import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileReader;
 import java.io.FileWriter;
 import java.io.IOException;
 
-import org.apache.qpid.server.security.auth.database.Base64MD5PasswordFilePrincipalDatabase;
+import javax.management.MalformedObjectNameException;
+import javax.management.ObjectName;
+
+import org.apache.commons.configuration.ConfigurationException;
+import org.apache.qpid.server.management.MBeanInvocationHandlerImpl;
+import org.apache.qpid.server.security.auth.database.PlainPasswordFilePrincipalDatabase;
 
 import junit.framework.TestCase;
 
+/* Note: The main purpose is to test the jmx access rights file manipulation 
+ * within AMQUserManagementMBean. The Principal Databases are tested by their own tests, 
+ * this test just exercises their usage in AMQUserManagementMBean. 
+ */
 public class AMQUserManagementMBeanTest extends TestCase
 {
-    private Base64MD5PasswordFilePrincipalDatabase _database;
+    private PlainPasswordFilePrincipalDatabase _database;
     private AMQUserManagementMBean _amqumMBean;
+    
+    private File _passwordFile;
+    private File _accessFile;
 
-    private static final String _QPID_HOME =  System.getProperty("QPID_HOME");
-
-    private static final String USERNAME = "testuser";
-    private static final String PASSWORD = "password";
-    private static final String JMXRIGHTS = "admin";
-    private static final String TEMP_PASSWORD_FILE_NAME = "tempPasswordFile.tmp";
-    private static final String TEMP_JMXACCESS_FILE_NAME = "tempJMXAccessFile.tmp";
+    private static final String TEST_USERNAME = "testuser";
+    private static final String TEST_PASSWORD = "password";
 
     @Override
     protected void setUp() throws Exception
     {
-        assertNotNull("QPID_HOME not set", _QPID_HOME);
-
-        _database = new Base64MD5PasswordFilePrincipalDatabase();
+        _database = new PlainPasswordFilePrincipalDatabase();
         _amqumMBean = new AMQUserManagementMBean();
+        loadFreshTestPasswordFile();
+        loadFreshTestAccessFile();
     }
 
     @Override
     protected void tearDown() throws Exception
     {
-        File testFile = new File(_QPID_HOME + File.separator + TEMP_JMXACCESS_FILE_NAME + ".tmp");
-        if (testFile.exists())
+            _passwordFile.delete();
+            _accessFile.delete();
+    }
+
+    public void testDeleteUser()
+    {
+        loadFreshTestPasswordFile();
+        loadFreshTestAccessFile();
+
+        //try deleting a non existant user
+        assertFalse(_amqumMBean.deleteUser("made.up.username"));
+        
+        assertTrue(_amqumMBean.deleteUser(TEST_USERNAME));
+    }
+    
+    public void testDeleteUserIsSavedToAccessFile()
+    {
+        loadFreshTestPasswordFile();
+        loadFreshTestAccessFile();
+
+        assertTrue(_amqumMBean.deleteUser(TEST_USERNAME));
+
+        //check the access rights were actually deleted from the file
+        try{
+            BufferedReader reader = new BufferedReader(new FileReader(_accessFile));
+
+            //check the 'generated by' comment line is present
+            assertTrue("File has no content", reader.ready());
+            assertTrue("'Generated by' comment line was missing",reader.readLine().contains("Generated by " +
+                                                      "AMQUserManagementMBean Console : Last edited by user:"));
+
+            //there should also be a modified date/time comment line
+            assertTrue("File has no modified date/time comment line", reader.ready());
+            assertTrue("Modification date/time comment line was missing",reader.readLine().startsWith("#"));
+            
+            //the access file should not contain any further data now as we just deleted the only user
+            assertFalse("User access data was present when it should have been deleted", reader.ready());
+        }
+        catch (IOException e)
         {
-            testFile.delete();
+            fail("Unable to valdate file contents due to:" + e.getMessage());
         }
+        
+    }
+
+    public void testSetRights()
+    {
+        loadFreshTestPasswordFile();
+        loadFreshTestAccessFile();
+        
+        assertFalse(_amqumMBean.setRights("made.up.username", true, false, false));
+        
+        assertTrue(_amqumMBean.setRights(TEST_USERNAME, true, false, false));
+        assertTrue(_amqumMBean.setRights(TEST_USERNAME, false, true, false));
+        assertTrue(_amqumMBean.setRights(TEST_USERNAME, false, false, true));
+    }
+    
+    public void testSetRightsIsSavedToAccessFile()
+    {
+        loadFreshTestPasswordFile();
+        loadFreshTestAccessFile();
+        
+        assertTrue(_amqumMBean.setRights(TEST_USERNAME, false, false, true));
+        
+        //check the access rights were actually updated in the file
+        try{
+            BufferedReader reader = new BufferedReader(new FileReader(_accessFile));
+
+            //check the 'generated by' comment line is present
+            assertTrue("File has no content", reader.ready());
+            assertTrue("'Generated by' comment line was missing",reader.readLine().contains("Generated by " +
+                                                      "AMQUserManagementMBean Console : Last edited by user:"));
 
-        testFile = new File(_QPID_HOME + File.separator + TEMP_JMXACCESS_FILE_NAME + ".old");
-        if (testFile.exists())
+            //there should also be a modified date/time comment line
+            assertTrue("File has no modified date/time comment line", reader.ready());
+            assertTrue("Modification date/time comment line was missing",reader.readLine().startsWith("#"));
+            
+            //the access file should not contain any further data now as we just deleted the only user
+            assertTrue("User access data was not updated in the access file", 
+                    reader.readLine().equals(TEST_USERNAME + "=" + MBeanInvocationHandlerImpl.ADMIN));
+            
+            //the access file should not contain any further data now as we just deleted the only user
+            assertFalse("Additional user access data was present when there should be no more", reader.ready());
+        }
+        catch (IOException e)
         {
-            testFile.delete();
+            fail("Unable to valdate file contents due to:" + e.getMessage());
         }
+    }
 
-        testFile = new File(_QPID_HOME + File.separator + TEMP_PASSWORD_FILE_NAME + ".tmp");
-        if (testFile.exists())
+    public void testMBeanVersion()
+    {
+        try
         {
-            testFile.delete();
+            ObjectName name = _amqumMBean.getObjectName();
+            assertEquals(AMQUserManagementMBean.VERSION, Integer.parseInt(name.getKeyProperty("version")));
         }
-
-        testFile = new File(_QPID_HOME + File.separator + TEMP_PASSWORD_FILE_NAME + ".old");
-        if (testFile.exists())
+        catch (MalformedObjectNameException e)
         {
-            testFile.delete();
+            fail(e.getMessage());
         }
     }
 
-    public void testDeleteUser()
+    public void testSetAccessFileWithMissingFile()
     {
-        loadTestPasswordFile();
-        loadTestAccessFile();
-
-        boolean deleted = false;
+        try
+        {
+            _amqumMBean.setAccessFile("made.up.filename");
+        }
+        catch (IOException e)
+        {
+            fail("Should not have been an IOE." + e.getMessage());
+        }
+        catch (ConfigurationException e)
+        {
+            assertTrue(e.getMessage(), e.getMessage().endsWith("does not exist"));
+        }
+    }
 
+    public void testSetAccessFileWithReadOnlyFile()
+    {
+        File testFile = null;
         try
         {
-            deleted = _amqumMBean.deleteUser(USERNAME);
+            testFile = File.createTempFile(this.getClass().getName(),".access.readonly");
+            BufferedWriter passwordWriter = new BufferedWriter(new FileWriter(testFile, false));
+            passwordWriter.write(TEST_USERNAME + ":" + TEST_PASSWORD);
+            passwordWriter.newLine();
+            passwordWriter.flush();
+            passwordWriter.close();
+
+            testFile.setReadOnly();
+            _amqumMBean.setAccessFile(testFile.getPath());
         }
-        catch(Exception e){
-            fail("Unable to delete user: " + e.getMessage());
+        catch (IOException e)
+        {
+            fail("Access file was not created." + e.getMessage());
+        }
+        catch (ConfigurationException e)
+        {
+            fail("There should not have been a configuration exception." + e.getMessage());
         }
 
-        assertTrue(deleted);
+        testFile.delete();
     }
- 
-    
+
     // ============================ Utility methods =========================
 
-    private void loadTestPasswordFile()
+    private void loadFreshTestPasswordFile()
     {
         try
         {
-            File tempPasswordFile = new File(_QPID_HOME + File.separator + TEMP_PASSWORD_FILE_NAME);
-            if (tempPasswordFile.exists())
+            if(_passwordFile == null)
             {
-                tempPasswordFile.delete();
+                _passwordFile = File.createTempFile(this.getClass().getName(),".password");
             }
-            tempPasswordFile.deleteOnExit();
 
-            BufferedWriter passwordWriter = new BufferedWriter(new FileWriter(tempPasswordFile));
-            passwordWriter.write(USERNAME + ":" + PASSWORD);
+            BufferedWriter passwordWriter = new BufferedWriter(new FileWriter(_passwordFile, false));
+            passwordWriter.write(TEST_USERNAME + ":" + TEST_PASSWORD);
             passwordWriter.newLine();
             passwordWriter.flush();
-
-            _database.setPasswordFile(tempPasswordFile.toString());
+            passwordWriter.close();
+            _database.setPasswordFile(_passwordFile.toString());
             _amqumMBean.setPrincipalDatabase(_database);
         }
         catch (IOException e)
@@ -126,27 +236,36 @@ public class AMQUserManagementMBeanTest extends TestCase
         }
     }
 
-    private void loadTestAccessFile()
+    private void loadFreshTestAccessFile()
     {
         try
         {
-            File tempAccessFile = new File(_QPID_HOME + File.separator + TEMP_JMXACCESS_FILE_NAME);
-            if (tempAccessFile.exists())
+            if(_accessFile == null)
             {
-                tempAccessFile.delete();
+                _accessFile = File.createTempFile(this.getClass().getName(),".access");
             }
-            tempAccessFile.deleteOnExit();
-
-            BufferedWriter accessWriter = new BufferedWriter(new FileWriter(tempAccessFile));
-            accessWriter.write(USERNAME + "=" + JMXRIGHTS);
+            
+            BufferedWriter accessWriter = new BufferedWriter(new FileWriter(_accessFile,false));
+            accessWriter.write("#Last Updated By comment");
+            accessWriter.newLine();
+            accessWriter.write("#Date/time comment");
+            accessWriter.newLine();
+            accessWriter.write(TEST_USERNAME + "=" + MBeanInvocationHandlerImpl.READONLY);
             accessWriter.newLine();
             accessWriter.flush();
+            accessWriter.close();
+        }
+        catch (IOException e)
+        {
+            fail("Unable to create test access file: " + e.getMessage());
+        }
 
-            _amqumMBean.setAccessFile(tempAccessFile.toString());
+        try{
+            _amqumMBean.setAccessFile(_accessFile.toString());
         }
         catch (Exception e)
         {
-            fail("Unable to create test access file: " + e.getMessage());
+            fail("Unable to set access file: " + e.getMessage());
         }
     }
 }