journald: Add iterator tests

Tests basic iterator operations, assumes accessible journal and several (> 10)
records available.

Also comes with a simple example script for downloading complete journal.

3 files changed, 188 insertions, 1 deletions

diff --git a/src/journald/test/TestIterators.py b/src/journald/test/TestIterators.py
new file mode 100644
index 0000000..10101f3
--- /dev/null
+++ b/src/journald/test/TestIterators.py
@@ -0,0 +1,159 @@
+# Copyright (C) 2013 Red Hat, Inc.  All rights reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# Authors: Tomas Bzatek <tbzatek@redhat.com>
+#
+
+from common import JournalBase
+import pywbem
+
+CIM_MESSAGELOG_ITERATOR_RESULT_SUCCESS = 0
+CIM_MESSAGELOG_ITERATOR_RESULT_NOT_SUPPORTED = 1
+CIM_MESSAGELOG_ITERATOR_RESULT_FAILED = 2
+
+class TestIterators(JournalBase):
+    """
+    Class for testing LMI_JournalMessageLog iterators
+    """
+
+    def test_simple_iteration(self):
+        """
+        Journal: Test simple iteration and iterator ID stability
+        """
+        inst = self.wbemconnection.ExecQuery('WQL', 'select * from LMI_JournalMessageLog')[0]
+        self.assertTrue(inst is not None)
+        (retval, rfirst) = self.wbemconnection.InvokeMethod("PositionToFirstRecord", inst.path)
+        self.assertEqual(retval, 0)
+        (retval, rget) = self.wbemconnection.InvokeMethod(MethodName="GetRecord", ObjectName=inst.path, PositionToNext=False,
+                                                          IterationIdentifier=rfirst['IterationIdentifier'])
+        self.assertEqual(retval, 0)
+        self.assertEqual(rfirst['IterationIdentifier'], rget['IterationIdentifier'])
+        (retval, rget) = self.wbemconnection.InvokeMethod(MethodName="GetRecord", ObjectName=inst.path, PositionToNext=True,
+                                                          IterationIdentifier=rget['IterationIdentifier'])
+        self.assertEqual(retval, 0)
+        self.assertNotEqual(rfirst['IterationIdentifier'], rget['IterationIdentifier'])
+        (retval, rclose) = self.wbemconnection.InvokeMethod(MethodName="CancelIteration", ObjectName=inst.path,
+                                                            IterationIdentifier=rget['IterationIdentifier'])
+        self.assertEqual(retval, 0)
+
+
+    def test_invalid_cancellation(self):
+        """
+        Journal: Test invalid IDs cancellation
+        """
+        inst = self.wbemconnection.ExecQuery('WQL', 'select * from LMI_JournalMessageLog')[0]
+        self.assertTrue(inst is not None)
+        # Invalid iterator format
+        iter_id = "sdfsdfsdgfa"
+        self.assertRaisesCIM(pywbem.CIM_ERR_INVALID_PARAMETER,
+                             self.wbemconnection.InvokeMethod,
+                                 MethodName="CancelIteration", ObjectName=inst.path,
+                                 IterationIdentifier=iter_id)
+        # Correct format, inactive iterator
+        iter_id = "LMI_JournalMessageLog_CMPI_Iter_9878972#0x7f8504021380#s=a13c10bf472048e69dceeee118cd7f84;i=3;b=5b96431d996a416ebf11dbb6543a5084;m=221f7b;t=4dcc1b6e70a7a;x=b1b572ade816b92e"
+        (retval, rclose) = self.wbemconnection.InvokeMethod(MethodName="CancelIteration", ObjectName=inst.path,
+                                                            IterationIdentifier=iter_id)
+        self.assertEqual(retval, CIM_MESSAGELOG_ITERATOR_RESULT_FAILED)
+
+
+    def test_double_cancellation(self):
+        """
+        Journal: Test double iterator cancellation
+        """
+        inst = self.wbemconnection.ExecQuery('WQL', 'select * from LMI_JournalMessageLog')[0]
+        self.assertTrue(inst is not None)
+        (retval, rfirst) = self.wbemconnection.InvokeMethod("PositionToFirstRecord", inst.path)
+        self.assertEqual(retval, 0)
+        (retval, _) = self.wbemconnection.InvokeMethod(MethodName="CancelIteration", ObjectName=inst.path,
+                                                       IterationIdentifier=rfirst['IterationIdentifier'])
+        self.assertEqual(retval, 0)
+        (retval, _) = self.wbemconnection.InvokeMethod(MethodName="CancelIteration", ObjectName=inst.path,
+                                                       IterationIdentifier=rfirst['IterationIdentifier'])
+        self.assertEqual(retval, CIM_MESSAGELOG_ITERATOR_RESULT_FAILED)
+
+
+    def test_seeking(self):
+        """
+        Journal: Test seeking back and forth
+        """
+        inst = self.wbemconnection.ExecQuery('WQL', 'select * from LMI_JournalMessageLog')[0]
+        self.assertTrue(inst is not None)
+        (retval, rfirst) = self.wbemconnection.InvokeMethod("PositionToFirstRecord", inst.path)
+        self.assertEqual(retval, 0)
+        (retval, rget1) = self.wbemconnection.InvokeMethod(MethodName="GetRecord", ObjectName=inst.path, PositionToNext=True,
+                                                           IterationIdentifier=rfirst['IterationIdentifier'])
+        self.assertEqual(retval, 0)
+        # Seeking to absolute record index should not be supported
+        self.assertRaisesCIM(pywbem.CIM_ERR_INVALID_PARAMETER,
+                             self.wbemconnection.InvokeMethod,
+                                 MethodName="PositionAtRecord", ObjectName=inst.path, MoveAbsolute=True,
+                                 terationIdentifier=rget1['IterationIdentifier'], RecordNumber=pywbem.Sint64(10))
+        (retval, rseek) = self.wbemconnection.InvokeMethod(MethodName="PositionAtRecord", ObjectName=inst.path, MoveAbsolute=False,
+                                                           IterationIdentifier=rget1['IterationIdentifier'], RecordNumber=pywbem.Sint64(5))
+        self.assertEqual(retval, 0)
+        (retval, rseek) = self.wbemconnection.InvokeMethod(MethodName="PositionAtRecord", ObjectName=inst.path, MoveAbsolute=False,
+                                                           IterationIdentifier=rseek['IterationIdentifier'], RecordNumber=pywbem.Sint64(4))
+        self.assertEqual(retval, 0)
+        (retval, rseek) = self.wbemconnection.InvokeMethod(MethodName="PositionAtRecord", ObjectName=inst.path, MoveAbsolute=False,
+                                                           IterationIdentifier=rseek['IterationIdentifier'], RecordNumber=pywbem.Sint64(-10))
+        self.assertEqual(retval, 0)
+        self.assertEqual(rfirst['IterationIdentifier'], rseek['IterationIdentifier'])
+        (retval, rget2) = self.wbemconnection.InvokeMethod(MethodName="GetRecord", ObjectName=inst.path, PositionToNext=False,
+                                                           IterationIdentifier=rseek['IterationIdentifier'])
+        self.assertEqual(retval, 0)
+        # We should be at the starting position now
+        self.assertEqual(rfirst['IterationIdentifier'], rget2['IterationIdentifier'])
+        self.assertEqual(rget1['RecordData'], rget2['RecordData'])
+        (retval, rclose) = self.wbemconnection.InvokeMethod(MethodName="CancelIteration", ObjectName=inst.path,
+                                                            IterationIdentifier=rget2['IterationIdentifier'])
+        self.assertEqual(retval, 0)
+
+
+    def test_stale_iter(self):
+        """
+        Journal: Test stale iterators
+        """
+        # Note this test is closely tied to iterator format, keep in sync with the provider code
+        inst = self.wbemconnection.ExecQuery('WQL', 'select * from LMI_JournalMessageLog')[0]
+        self.assertTrue(inst is not None)
+        (retval, rfirst) = self.wbemconnection.InvokeMethod("PositionToFirstRecord", inst.path)
+        self.assertEqual(retval, 0)
+        iter_pointer = "0x7f8504021380"
+        s1 = rfirst['IterationIdentifier'].split('#')
+        iter_id = s1[0] + "#" + iter_pointer + "#" + s1[2]
+        (retval, rget1) = self.wbemconnection.InvokeMethod(MethodName="GetRecord", ObjectName=inst.path, PositionToNext=False,
+                                                           IterationIdentifier=iter_id)
+        self.assertEqual(retval, 0)
+        self.assertNotEqual(rget1['IterationIdentifier'], iter_id)
+        s2 = rget1['IterationIdentifier'].split('#')
+        self.assertNotEqual(s1[0], s2[0])
+        self.assertNotEqual(s1[1], s2[1])
+        self.assertNotEqual(s2[1], iter_pointer)
+        self.assertEqual(s1[2], s2[2])
+        (retval, rget2) = self.wbemconnection.InvokeMethod(MethodName="GetRecord", ObjectName=inst.path, PositionToNext=False,
+                                                           IterationIdentifier=rget1['IterationIdentifier'])
+        self.assertEqual(retval, 0)
+        self.assertEqual(rget1['IterationIdentifier'], rget2['IterationIdentifier'])
+        (retval, rget3) = self.wbemconnection.InvokeMethod(MethodName="GetRecord", ObjectName=inst.path, PositionToNext=True,
+                                                           IterationIdentifier=rget2['IterationIdentifier'])
+        self.assertEqual(retval, 0)
+        self.assertNotEqual(rget2['IterationIdentifier'], rget3['IterationIdentifier'])
+        (retval, _) = self.wbemconnection.InvokeMethod(MethodName="CancelIteration", ObjectName=inst.path,
+                                                       IterationIdentifier=rget3['IterationIdentifier'])
+        self.assertEqual(retval, 0)
+        (retval, _) = self.wbemconnection.InvokeMethod(MethodName="CancelIteration", ObjectName=inst.path,
+                                                       IterationIdentifier=rfirst['IterationIdentifier'])
+        self.assertEqual(retval, 0)
diff --git a/src/journald/test/common.py b/src/journald/test/common.py
index d65b5d1..f2d0942 100644
--- a/src/journald/test/common.py
+++ b/src/journald/test/common.py
@@ -199,4 +199,11 @@ class JournalBase(unittest.TestCase):
         """ Callback to process one indication."""
         self.indication_queue.put(indication)
 
-
+    def assertRaisesCIM(self, cim_err_code, func, *args, **kwds):
+        """
+        This test passes if given function called with supplied arguments
+        raises pywbem.CIMError with given cim error code.
+        """
+        with self.assertRaises(pywbem.CIMError) as cm:
+            func(*args, **kwds)
+        self.assertEqual(cim_err_code, cm.exception.args[0])
diff --git a/src/journald/test/list-journal b/src/journald/test/list-journal
new file mode 100755
index 0000000..5836884
--- /dev/null
+++ b/src/journald/test/list-journal
@@ -0,0 +1,21 @@
+#!/usr/bin/env lmishell
+#
+# Simple example script to iterate over complete journal
+
+import os
+
+url = os.environ.get("LMI_CIMOM_URL", "localhost")
+username = os.environ.get("LMI_CIMOM_USERNAME", "root")
+password = os.environ.get("LMI_CIMOM_PASSWORD", "")
+
+c = connect(url, username, password)
+inst = c.root.cimv2.LMI_JournalMessageLog.first_instance()
+r = inst.PositionToFirstRecord()
+iter_id = r.rparams['IterationIdentifier']
+
+while True:
+    x = inst.GetRecord(IterationIdentifier=iter_id, PositionToNext=True)
+    if x.rval != 0:
+        break
+    print "".join(map(chr, x.rparams['RecordData']))
+    iter_id = x.rparams['IterationIdentifier']