Add ipalib.messages

The messages module contains message classes that can be added
to a RPC response to provide additional information or warnings.

This patch adds only the module with a single public message,
VersionMissing, and unit tests.
Since message classes are very similar to public errors, some
functionality and unit tests were shared.

Design page: http://freeipa.org/page/V3/Messages
Ticket: https://fedorahosted.org/freeipa/ticket/2732

1 files changed, 60 insertions, 0 deletions

diff --git a/tests/test_ipalib/test_messages.py b/tests/test_ipalib/test_messages.py
new file mode 100644
index 00000000..d6a4b9aa
--- /dev/null
+++ b/tests/test_ipalib/test_messages.py
@@ -0,0 +1,60 @@
+# Authors:
+#   Petr Viktorin <pviktori@redhat.com>
+#
+# Copyright (C) 1012  Red Hat
+# see file 'COPYING' for use and warranty information
+#
+# 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 3 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, see <http://www.gnu.org/licenses/>.
+
+"""
+Test the `ipalib.messages` module.
+"""
+
+from ipalib import messages
+from tests.test_ipalib import test_errors
+
+
+class HelloMessage(messages.PublicMessage):
+    type = 'info'
+    format = '%(greeting)s, %(object)s!'
+    errno = 1234
+
+
+class test_PublicMessage(test_errors.test_PublicError):
+    """Test public messages"""
+    # The messages are a lot like public errors; defer testing to that.
+    klass = messages.PublicMessage
+    required_classes = (UserWarning, messages.PublicMessage)
+
+
+class test_PublicMessages(test_errors.BaseMessagesTest):
+    message_list = messages.public_messages
+    errno_range = xrange(10000, 19999)
+    required_classes = (UserWarning, messages.PublicMessage)
+    texts = messages._texts
+
+    def extratest(self, cls):
+        if cls is not messages.PublicMessage:
+            assert cls.type in ('debug', 'info', 'warning', 'error')
+
+
+def test_to_dict():
+    expected = dict(
+        name='HelloMessage',
+        type='info',
+        message='Hello, world!',
+        code=1234,
+    )
+
+    assert HelloMessage(greeting='Hello', object='world').to_dict() == expected