Merge pull request #432 from basho/fixes/lrb/gh-430-millisecond-precision

READY: Fix millisecond handling

Reviewed-by: javajolt

Author: borshop

README.rst

@@ -17,7 +17,15 @@ Install
 =======
 
 The recommended versions of Python for use with this client are Python
-`2.7.x`, `3.3.x`, `3.4.x` and `3.5.x`.
+`2.7.x`, `3.3.x`, `3.4.x` and `3.5.x`. The latest version from each series
+should be preferred.
+
+Riak TS (Timeseries)
+===================
+
+You must use version `2.7.11`, `3.4.4` or `3.5.1` (or greater within a version series).
+Otherwise you will be affected by `this Python bug <https://bugs.python.org/issue23517>`_.
+
 
 From Source
 -----------

RELEASE_NOTES.md

@@ -1,5 +1,10 @@
 # Riak Python Client Release Notes
 
+## 2.4.1 Patch Release - 2016-02-03
+
+* [Riak TS: Millisecond precision](https://github.com/basho/riak-python-client/issues/430)
+* [Fix release process](https://github.com/basho/riak-python-client/issues/429)
+
 ## 2.4.0 Feature Release - 2016-01-13
 
 This release enhances Riak Time Series functionality.

riak/tests/test_timeseries.py

@@ -3,13 +3,15 @@
 import platform
 import random
 import string
+
 import riak.pb.riak_ts_pb2
 
 from riak import RiakError
 from riak.table import Table
 from riak.ts_object import TsObject
 from riak.transports.pbc.codec import RiakPbcCodec
-from riak.util import str_to_bytes, bytes_to_str
+from riak.util import str_to_bytes, bytes_to_str, \
+    is_timeseries_supported
 from riak.tests import RUN_TIMESERIES
 from riak.tests.base import IntegrationTestBase
 from riak.pb.riak_ts_pb2 import TsColumnType
@@ -25,21 +27,36 @@
 bd1 = 'временные ряды'
 
 fiveMins = datetime.timedelta(0, 300)
-ts0 = datetime.datetime(2015, 1, 1, 12, 0, 0)
+# NB: last arg is microseconds, 987ms expressed
+ts0 = datetime.datetime(2015, 1, 1, 12, 0, 0, 987000)
+ex0ms = 1420113600987
+
 ts1 = ts0 + fiveMins
+ex1ms = 1420113900987
 
 
+@unittest.skipUnless(is_timeseries_supported(), "Timeseries not supported")
 class TimeseriesUnitTests(unittest.TestCase):
-    def setUp(self):
-        self.c = RiakPbcCodec()
-        self.ts0ms = self.c._unix_time_millis(ts0)
-        self.ts1ms = self.c._unix_time_millis(ts1)
-        self.rows = [
+    @classmethod
+    def setUpClass(cls):
+        cls.c = RiakPbcCodec()
+
+        cls.ts0ms = cls.c._unix_time_millis(ts0)
+        if cls.ts0ms != ex0ms:
+            raise AssertionError(
+                'expected {:d} to equal {:d}'.format(cls.ts0ms, ex0ms))
+
+        cls.ts1ms = cls.c._unix_time_millis(ts1)
+        if cls.ts1ms != ex1ms:
+            raise AssertionError(
+                'expected {:d} to equal {:d}'.format(cls.ts1ms, ex1ms))
+
+        cls.rows = [
             [bd0, 0, 1.2, ts0, True],
             [bd1, 3, 4.5, ts1, False]
         ]
-        self.test_key = ['hash1', 'user2', ts0]
-        self.table = Table(None, 'test-table')
+        cls.test_key = ['hash1', 'user2', ts0]
+        cls.table = Table(None, 'test-table')
 
     def validate_keyreq(self, req):
         self.assertEqual(self.table.name, bytes_to_str(req.table))
@@ -48,6 +65,12 @@ def validate_keyreq(self, req):
         self.assertEqual('user2', bytes_to_str(req.key[1].varchar_value))
         self.assertEqual(self.ts0ms, req.key[2].timestamp_value)
 
+    def test_encode_decode_timestamp(self):
+        ts0ms = self.c._unix_time_millis(ts0)
+        self.assertEqual(ts0ms, ex0ms)
+        ts0_d = self.c._datetime_from_unix_time_millis(ts0ms)
+        self.assertEqual(ts0, ts0_d)
+
     def test_encode_data_for_get(self):
         req = riak.pb.riak_ts_pb2.TsGetReq()
         self.c._encode_timeseries_keyreq(self.table, self.test_key, req)
@@ -166,12 +189,13 @@ def test_decode_data_from_query(self):
         self.assertEqual(r1[4], self.rows[1][4])
 
 
-@unittest.skipUnless(RUN_TIMESERIES, 'RUN_TIMESERIES is 0')
+@unittest.skipUnless(is_timeseries_supported() and RUN_TIMESERIES,
+                     'Timeseries not supported or RUN_TIMESERIES is 0')
 class TimeseriesTests(IntegrationTestBase, unittest.TestCase):
     @classmethod
     def setUpClass(cls):
         super(TimeseriesTests, cls).setUpClass()
-        cls.now = datetime.datetime.utcfromtimestamp(144379690)
+        cls.now = datetime.datetime.utcfromtimestamp(144379690.987000)
         fiveMinsAgo = cls.now - fiveMins
         tenMinsAgo = fiveMinsAgo - fiveMins
         fifteenMinsAgo = tenMinsAgo - fiveMins
@@ -211,6 +235,7 @@ def validate_data(self, ts_obj):
         self.assertEqual(row[0], 'hash1')
         self.assertEqual(row[1], 'user2')
         self.assertEqual(row[2], self.fiveMinsAgo)
+        self.assertEqual(row[2].microsecond, 987000)
         self.assertEqual(row[3], 'wind')
         self.assertIsNone(row[4])
 

riak/tests/test_util.py

@@ -0,0 +1,20 @@
+import platform
+
+from riak.util import is_timeseries_supported
+
+if platform.python_version() < '2.7':
+    unittest = __import__('unittest2')
+else:
+    import unittest
+
+
+class UtilUnitTests(unittest.TestCase):
+    def test_is_timeseries_supported(self):
+        v = (2, 7, 11)
+        self.assertEqual(True, is_timeseries_supported(v))
+        v = (2, 7, 12)
+        self.assertEqual(True, is_timeseries_supported(v))
+        v = (3, 3, 6)
+        self.assertEqual(False, is_timeseries_supported(v))
+        v = (3, 4, 3)
+        self.assertEqual(False, is_timeseries_supported(v))

riak/transports/pbc/codec.py

@@ -1,10 +1,10 @@
+import datetime
+import logging
 import riak.pb
 import riak.pb.riak_pb2
 import riak.pb.riak_dt_pb2
 import riak.pb.riak_kv_pb2
 import riak.pb.riak_ts_pb2
-import logging
-import datetime
 
 from riak import RiakError
 from riak.content import RiakContent
@@ -85,13 +85,7 @@ def __init__(self, **unused_args):
 
     def _unix_time_millis(self, dt):
         td = dt - epoch
-        try:
-            return int(dt.total_seconds() * 1000.0)
-        except AttributeError:
-            # NB: python 2.6 must use this method
-            return int(((td.microseconds +
-                         (td.seconds + td.days * 24 * 3600) * 10**6) /
-                        10**6) * 1000.0)
+        return int(td.total_seconds() * 1000.0)
 
     def _datetime_from_unix_time_millis(self, ut):
         return datetime.datetime.utcfromtimestamp(ut / 1000.0)

riak/util.py

@@ -1,9 +1,18 @@
 from __future__ import print_function
+
+import sys
 import warnings
+
 from collections import Mapping
 from six import string_types, PY2
 
 
+def is_timeseries_supported(v=None):
+    if v is None:
+        v = sys.version_info
+    return v < (3,) or v >= (3, 4, 4)
+
+
 def quacks_like_dict(object):
     """Check if object is dict-like"""
     return isinstance(object, Mapping)