DVPL-3648: splunklib.searchcommands | decorators.Option class should render Duration values in '%H:%M:%S' format, not as an integer number of seconds

Validated with automated unit tests and ad-hoc integration testing

Signed-off-by: David Noble <[email protected]>

Author: David Noble

splunklib/searchcommands/validators.py

@@ -12,7 +12,6 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from time import strptime
 import os
 import re
 import sys
@@ -58,20 +57,6 @@ def __call__(self, value):
         return value
 
 
-class Duration(Validator):
-    """ Validates duration option values.
-
-    """
-    def __call__(self, value):
-        if value is not None:
-            try:
-                value = strptime(value, '%H:%M:%S')
-            except ValueError as e:
-                raise ValueError(str(e).capitalize())
-            value = 3600 * value.tm_hour + 60 * value.tm_min + value.tm_sec
-        return value
-
-
 class Fieldname(Validator):
     """ Validates field name option values.
 
@@ -131,6 +116,44 @@ def __call__(self, value):
         return value
 
 
+class Duration(Validator):
+    """ Validates duration option values.
+
+    """
+    def __call__(self, value):
+
+        if value is None:
+            return None
+
+        try:
+            p = value.split(':', 2)
+            _60 = Duration._60
+            _unsigned = Duration._unsigned
+            if len(p) == 1:
+                result = _unsigned(p[0])
+            if len(p) == 2:
+                result = 60 * _unsigned(p[0]) + _60(p[1])
+            if len(p) == 3:
+                result = 3600 * _unsigned(p[0]) + 60 * _60(p[1]) + _60(p[2])
+        except ValueError:
+            raise ValueError("Invalid duration value: %s", value)
+
+        return result
+
+    def format(self, value):
+
+        value = int(value)
+
+        s = value % 60
+        m = value / 60 % 60
+        h = value / (60 * 60)
+
+        return '%02d:%02d:%02d' % (h, m, s)
+
+    _60 = Integer(0, 59)
+    _unsigned = Integer(0)
+
+
 class OptionName(Validator):
     """ Validates option names.
 

tests/test_searchcommands_validators.py

@@ -20,6 +20,7 @@
     import unittest
 
 from splunklib.searchcommands import validators
+from time import gmtime, strftime, strptime
 import os
 
 
@@ -29,6 +30,37 @@ def setUp(self):
         super(TestSearchCommandsValidators, self).setUp()
         return
 
+    def test_duration(self):
+
+        # Duration validator should parse and format time intervals of the form
+        # HH:MM:SS
+
+        validator = validators.Duration()
+
+        for seconds in range(0, 25 * 60 * 60, 17):
+            value = str(seconds)
+            self.assertEqual(validator(value), seconds)
+            self.assertEqual(validator(validator.format(seconds)), seconds)
+            value = '%d:%02d' % (seconds / 60, seconds % 60)
+            self.assertEqual(validator(value), seconds)
+            self.assertEqual(validator(validator.format(seconds)), seconds)
+            value = '%d:%02d:%02d' % (seconds / 3600, (seconds / 60) % 60, seconds % 60)
+            self.assertEqual(validator(value), seconds)
+            self.assertEqual(validator(validator.format(seconds)), seconds)
+
+        self.assertEqual(validator('23:00:00'), 23 * 60 * 60)
+        self.assertEqual(validator('00:59:00'), 59 * 60)
+        self.assertEqual(validator('00:00:59'), 59)
+
+        self.assertEqual(validator.format(23 * 60 * 60), '23:00:00')
+        self.assertEqual(validator.format(59 * 60), '00:59:00')
+        self.assertEqual(validator.format(59), '00:00:59')
+
+        self.assertRaises(ValueError, validator, '00:60:00')
+        self.assertRaises(ValueError, validator, '00:00:60')
+
+        return
+
     def test_file(self):
 
         # Create a file on $SPLUNK_HOME/var/run/splunk