QPID-2001 : Update to provide control of options in messages.

Update to improve formatting of generated code
Inclusion of more documentation
Defaulted generation to use US locale
Removed duplicate messages in MST that were added to while the option solution was being discussed.

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

7 files changed, 209 insertions, 30 deletions

diff --git a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/AbstractTestMessages.java b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/AbstractTestMessages.java
index 6589695146..17a9d6c591 100644
--- a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/AbstractTestMessages.java
+++ b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/AbstractTestMessages.java
@@ -81,24 +81,35 @@ public abstract class AbstractTestMessages extends TestCase
     {
         assertEquals("Log has incorrect message count", 1, logs.size());
 
-        String log = String.valueOf(logs.get(0));
+        //We trim() here as we don't care about extra white space at the end of the log message
+        // but we do care about the ability to easily check we don't have unexpected text at
+        // the end.
+        String log = String.valueOf(logs.get(0)).trim();
 
-        int index = log.indexOf(_logSubject.toString());
+        // Simple switch to print out all the logged messages 
+        //System.err.println(log);
 
-        assertTrue("Unable to locate Subject:" + log, index != -1);
+        int msgIndex = log.indexOf(_logSubject.toString())+_logSubject.toString().length();
 
-        String message = log.substring(index + _logSubject.toString().length());
+        assertTrue("Unable to locate Subject:" + log, msgIndex != -1);
+
+        String message = log.substring(msgIndex);
 
         assertTrue("Message does not start with tag:" + tag + ":" + message,
                    message.startsWith(tag));
 
         // Test that the expected items occur in order.
-        index = 0;
+        int index = 0;
         for (String text : expected)
         {
             index = message.indexOf(text, index);
             assertTrue("Message does not contain expected (" + text + ") text :" + message, index != -1);
+            index = index + text.length();
         }
+
+        //Check there is nothing left on the log message
+        assertEquals("Message has more text. '" + log.substring(msgIndex + index) + "'",
+                     log.length(), msgIndex +  index);
     }
 
 }
diff --git a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/BindingMessagesTest.java b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/BindingMessagesTest.java
index a12d14239d..b2182bb1b2 100644
--- a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/BindingMessagesTest.java
+++ b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/BindingMessagesTest.java
@@ -25,9 +25,9 @@ import java.util.List;
 public class BindingMessagesTest extends AbstractTestMessages
 {
 
-    public void testMessage1001()
+    public void testMessage1001_NoArgs()
     {
-        _logMessage = BindingMessages.BND_1001();
+        _logMessage = BindingMessages.BND_1001(null, false);
         List<Object> log = performLog();
 
         String[] expected = {"Create"};
@@ -35,6 +35,18 @@ public class BindingMessagesTest extends AbstractTestMessages
         validateLogMessage(log, "BND-1001", expected);
     }
 
+    public void testMessage1001_Args()
+    {
+        String arguments = "arguments";
+
+        _logMessage = BindingMessages.BND_1001(arguments, true);
+        List<Object> log = performLog();
+
+        String[] expected = {"Create", ": Arguments :", arguments};
+
+        validateLogMessage(log, "BND-1001", expected);
+    }
+        
     public void testMessage1002()
     {
         _logMessage = BindingMessages.BND_1002();
diff --git a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/ConnectionMessagesTest.java b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/ConnectionMessagesTest.java
index 8723c48476..eb76029a5c 100644
--- a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/ConnectionMessagesTest.java
+++ b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/ConnectionMessagesTest.java
@@ -24,12 +24,12 @@ import java.util.List;
 
 public class ConnectionMessagesTest extends AbstractTestMessages
 {
-    public void testMessage1001()
+    public void testMessage1001_WithProtocolVersion()
     {
         String clientID = "client";
         String protocolVersion = "8-0";
 
-        _logMessage = ConnectionMessages.CON_1001(clientID, protocolVersion);
+        _logMessage = ConnectionMessages.CON_1001(clientID, protocolVersion, true);
         List<Object> log = performLog();
 
         String[] expected = {"Open :", "Client ID", clientID,
@@ -38,6 +38,19 @@ public class ConnectionMessagesTest extends AbstractTestMessages
         validateLogMessage(log, "CON-1001", expected);
     }
 
+    public void testMessage1001_NoProtocolVersion()
+    {
+        String clientID = "client";        
+
+        _logMessage = ConnectionMessages.CON_1001(clientID, null, false);
+        List<Object> log = performLog();
+
+        String[] expected = {"Open :", "Client ID", clientID};
+
+        validateLogMessage(log, "CON-1001", expected);
+    }
+
+
     public void testMessage1002()
     {
         _logMessage = ConnectionMessages.CON_1002();
diff --git a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/ExchangeMessagesTest.java b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/ExchangeMessagesTest.java
index 46a911fdc6..831ede3e0c 100644
--- a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/ExchangeMessagesTest.java
+++ b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/ExchangeMessagesTest.java
@@ -27,7 +27,7 @@ import java.util.List;
 
 public class ExchangeMessagesTest extends AbstractTestMessages
 {
-    public void testMessage1001()
+    public void testMessage1001_Transient()
     {
         // Get the Default Exchange on the Test Vhost for testing
         Exchange exchange = ApplicationRegistry.getInstance().
@@ -37,7 +37,7 @@ public class ExchangeMessagesTest extends AbstractTestMessages
         String type = exchange.getType().toString();
         String name = exchange.getName().toString();
 
-        _logMessage = ExchangeMessages.EXH_1001(type, name);
+        _logMessage = ExchangeMessages.EXH_1001(type, name, false);
         List<Object> log = performLog();
 
         String[] expected = {"Create :", "Type:", type, "Name:", name};
@@ -45,6 +45,25 @@ public class ExchangeMessagesTest extends AbstractTestMessages
         validateLogMessage(log, "EXH-1001", expected);
     }
 
+    public void testMessage1001_Persistent()
+    {
+        // Get the Default Exchange on the Test Vhost for testing
+        Exchange exchange = ApplicationRegistry.getInstance().
+                getVirtualHostRegistry().getVirtualHost("test").
+                getExchangeRegistry().getDefaultExchange();
+
+        String type = exchange.getType().toString();
+        String name = exchange.getName().toString();
+
+        _logMessage = ExchangeMessages.EXH_1001(type, name, true);
+        List<Object> log = performLog();
+
+        String[] expected = {"Create :", "Durable", "Type:", type, "Name:", name};
+
+        validateLogMessage(log, "EXH-1001", expected);
+    }
+
+
     public void testMessage1002()
     {
         _logMessage = ExchangeMessages.EXH_1002();
diff --git a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/MessageStoreMessagesTest.java b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/MessageStoreMessagesTest.java
index e1ae93b869..e02993b840 100644
--- a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/MessageStoreMessagesTest.java
+++ b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/MessageStoreMessagesTest.java
@@ -61,7 +61,7 @@ public class MessageStoreMessagesTest extends AbstractTestMessages
 
     public void testMessage1004()
     {
-        _logMessage = MessageStoreMessages.MST_1004();
+        _logMessage = MessageStoreMessages.MST_1004(null,false);
         List<Object> log = performLog();
 
         String[] expected = {"Recovery Start"};
@@ -69,24 +69,24 @@ public class MessageStoreMessagesTest extends AbstractTestMessages
         validateLogMessage(log, "MST-1004", expected);
     }
 
-    public void testMessage1005()
+    public void testMessage1004_withQueue()
     {
         String queueName = "testQueue";
 
-        _logMessage = MessageStoreMessages.MST_1005(queueName);
+        _logMessage = MessageStoreMessages.MST_1004(queueName, true);
         List<Object> log = performLog();
 
         String[] expected = {"Recovery Start :", queueName};
 
-        validateLogMessage(log, "MST-1005", expected);
+        validateLogMessage(log, "MST-1004", expected);
     }
 
-    public void testMessage1006()
+    public void testMessage1005()
     {
         String queueName = "testQueue";
         Integer messasgeCount = 2000;
 
-        _logMessage = MessageStoreMessages.MST_1006(messasgeCount, queueName);
+        _logMessage = MessageStoreMessages.MST_1005(messasgeCount, queueName);
         List<Object> log = performLog();
 
         // Here we use MessageFormat to ensure the messasgeCount of 2000 is
@@ -95,29 +95,29 @@ public class MessageStoreMessagesTest extends AbstractTestMessages
                              MessageFormat.format("{0,number}", messasgeCount),
                              "messages for queue", queueName};
 
-        validateLogMessage(log, "MST-1006", expected);
+        validateLogMessage(log, "MST-1005", expected);
     }
 
-    public void testMessage1007()
+    public void testMessage1006()
     {
-        _logMessage = MessageStoreMessages.MST_1007();
+        _logMessage = MessageStoreMessages.MST_1006(null,false);
         List<Object> log = performLog();
 
         String[] expected = {"Recovery Complete"};
 
-        validateLogMessage(log, "MST-1007", expected);
+        validateLogMessage(log, "MST-1006", expected);
     }
 
-    public void testMessage1008()
+    public void testMessage1006_withQueue()
     {
         String queueName = "testQueue";
 
-        _logMessage = MessageStoreMessages.MST_1008(queueName);
+        _logMessage = MessageStoreMessages.MST_1006(queueName, true);
         List<Object> log = performLog();
 
         String[] expected = {"Recovery Complete :", queueName};
 
-        validateLogMessage(log, "MST-1008", expected);
+        validateLogMessage(log, "MST-1006", expected);
     }
 
 }
diff --git a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/QueueMessagesTest.java b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/QueueMessagesTest.java
index 4ba00ea6e4..2f53d0aff5 100644
--- a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/QueueMessagesTest.java
+++ b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/QueueMessagesTest.java
@@ -24,14 +24,114 @@ import java.util.List;
 
 public class QueueMessagesTest extends AbstractTestMessages
 {
-    public void testMessage1001()
+    public void testMessage1001ALL()
     {
         String owner = "guest";
+        Integer priority = 3;
 
-        _logMessage = QueueMessages.QUE_1001(owner);
+        _logMessage = QueueMessages.QUE_1001(owner, priority, true, true, true, true);
         List<Object> log = performLog();
 
-        String[] expected = {"Create :", "Owner:", owner};
+        String[] expected = {"Create :", "Owner:", owner, "AutoDelete",
+                             "Durable", "Transient", "Priority:",
+                             String.valueOf(priority)};
+
+        validateLogMessage(log, "QUE-1001", expected);
+    }
+
+    public void testMessage1001AutoDelete()
+    {
+        String owner = "guest";
+
+        _logMessage = QueueMessages.QUE_1001(owner, null, true, false, false, false);
+        List<Object> log = performLog();
+
+        String[] expected = {"Create :", "Owner:", owner, "AutoDelete"};
+
+        validateLogMessage(log, "QUE-1001", expected);
+    }
+
+    public void testMessage1001Priority()
+    {
+        String owner = "guest";
+        Integer priority = 3;
+
+        _logMessage = QueueMessages.QUE_1001(owner, priority, false, false, false, true);
+        List<Object> log = performLog();
+
+        String[] expected = {"Create :", "Owner:", owner, "Priority:",
+                             String.valueOf(priority)};
+
+        validateLogMessage(log, "QUE-1001", expected);
+    }
+
+    public void testMessage1001AutoDeletePriority()
+    {
+        String owner = "guest";
+        Integer priority = 3;
+
+        _logMessage = QueueMessages.QUE_1001(owner, priority, true, false, false, true);
+        List<Object> log = performLog();
+
+        String[] expected = {"Create :", "Owner:", owner, "AutoDelete",
+                             "Priority:",
+                             String.valueOf(priority)};
+
+        validateLogMessage(log, "QUE-1001", expected);
+    }
+
+    public void testMessage1001AutoDeleteTransient()
+    {
+        String owner = "guest";
+
+        _logMessage = QueueMessages.QUE_1001(owner, null, true, false, true, false);
+        List<Object> log = performLog();
+
+        String[] expected = {"Create :", "Owner:", owner, "AutoDelete",
+                            "Transient"};
+
+        validateLogMessage(log, "QUE-1001", expected);
+    }
+
+    public void testMessage1001AutoDeleteTransientPriority()
+    {
+        String owner = "guest";
+        Integer priority = 3;
+
+        _logMessage = QueueMessages.QUE_1001(owner, priority, true, false, true, true);
+        List<Object> log = performLog();
+
+        String[] expected = {"Create :", "Owner:", owner, "AutoDelete",
+                             "Transient", "Priority:",
+                             String.valueOf(priority)};
+
+        validateLogMessage(log, "QUE-1001", expected);
+    }
+
+    public void testMessage1001AutoDeleteDurable()
+    {
+        String owner = "guest";
+
+        _logMessage = QueueMessages.QUE_1001(owner, null, true, true, false, false);
+        List<Object> log = performLog();
+
+        String[] expected = {"Create :", "Owner:", owner, "AutoDelete",
+                             "Durable"};
+
+        validateLogMessage(log, "QUE-1001", expected);
+    }
+
+    public void testMessage1001AutoDeleteDurablePriority()
+    {
+        String owner = "guest";
+        Integer priority = 3;
+
+        _logMessage = QueueMessages.QUE_1001(owner, priority, true, true, false, true);
+        List<Object> log = performLog();
+
+        String[] expected = {"Create :", "Owner:", owner, "AutoDelete",
+                             "Durable", "Priority:",
+                             String.valueOf(priority)};
 
         validateLogMessage(log, "QUE-1001", expected);
     }
diff --git a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/SubscriptionMessagesTest.java b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/SubscriptionMessagesTest.java
index 1bb96e1e33..80ebcc79cd 100644
--- a/java/broker/src/test/java/org/apache/qpid/server/logging/messages/SubscriptionMessagesTest.java
+++ b/java/broker/src/test/java/org/apache/qpid/server/logging/messages/SubscriptionMessagesTest.java
@@ -24,17 +24,41 @@ import java.util.List;
 
 public class SubscriptionMessagesTest extends AbstractTestMessages
 {
-    public void testMessage1001()
+    public void testMessage1001ALL()
     {
+        String arguments = "arguments";
 
-        _logMessage = SubscriptionMessages.SUB_1001();
+        _logMessage = SubscriptionMessages.SUB_1001(arguments, true, true);
         List<Object> log = performLog();
 
-        String[] expected = {"Create :"};
+        String[] expected = {"Create :", "Durable", "Arguments :", arguments};
 
         validateLogMessage(log, "SUB-1001", expected);
     }
 
+    public void testMessage1001Durable()
+    {
+        _logMessage = SubscriptionMessages.SUB_1001(null, true, false);
+        List<Object> log = performLog();
+
+        String[] expected = {"Create :", "Durable"};
+
+        validateLogMessage(log, "SUB-1001", expected);
+    }
+
+    public void testMessage1001Arguments()
+    {
+        String arguments = "arguments";
+
+        _logMessage = SubscriptionMessages.SUB_1001(arguments, false, true);
+        List<Object> log = performLog();
+
+        String[] expected = {"Create :","Arguments :", arguments};
+
+        validateLogMessage(log, "SUB-1001", expected);
+    }
+
+
     public void testMessage1002()
     {
         _logMessage = SubscriptionMessages.SUB_1002();