READY: Add Timeseries support

.gitignore

@@ -1,6 +1,8 @@
 *.pyc
 .python-version
 
+.tox/
+
 docs/_build
 
 .*.swp

README.rst

@@ -139,6 +139,8 @@ If your Riak server isn't running on localhost or you have built a
 Riak devrel from source, use the environment variables
 ``RIAK_TEST_HOST``, ``RIAK_TEST_HTTP_PORT`` and
 ``RIAK_TEST_PB_PORT`` to specify where to find the Riak server.
+``RIAK_TEST_PROTOCOL`` to specify which protocol to test.  Can be
+either ``pbc`` or ``http``.
 
 Some of the connection tests need port numbers that are NOT in use. If
 ports 1023 and 1022 are in use on your test system, set the
@@ -150,7 +152,7 @@ Testing Search
 
 If you don't have `Riak Search
 <http://docs.basho.com/riak/latest/dev/using/search/>`_ enabled, you
-can set the ``SKIP_SEARCH`` environment variable to 1 skip those
+can set the ``RUN_SEARCH`` environment variable to 0 skip those
 tests.
 
 If you don't have `Search 2.0 <https://github.com/basho/yokozuna>`_
@@ -176,15 +178,45 @@ You may alternately add these lines to `setup.cfg`
     [create_bucket_types]
     riak-admin=/Users/sean/dev/riak/rel/riak/bin/riak-admin
 
-To skip the bucket-type tests, set the ``SKIP_BTYPES`` environment
+To skip the bucket-type tests, set the ``RUN_BTYPES`` environment
+variable to ``0``.
+
+Testing Data Types (Riak 2+)
+----------------------------
+
+To test data types, you must set up bucket types (see above.)
+
+To skip the data type tests, set the ``RUN_DATATYPES`` environment
+variable to ``0``.
+
+Testing Timeseries (Riak 2.1+)
+------------------------------
+
+To test timeseries data, you must run the ``setup_timeseries`` command,
+which will create the bucket-types used in testing, or create them
+manually yourself. It can be run like so (substituting ``$RIAK`` with
+the root of your Riak install)
+
+.. code-block:: console
+
+    ./setup.py setup_timeseries --riak-admin=$RIAK/bin/riak-admin
+
+You may alternately add these lines to `setup.cfg`
+
+.. code-block:: ini
+
+    [setup_timeseries]
+    riak-admin=/Users/sean/dev/riak/rel/riak/bin/riak-admin
+
+To enable the timeseries tests, set the ``RUN_TIMESERIES`` environment
 variable to ``1``.
 
 Testing Secondary Indexes
 -------------------------
 
 To test
 `Secondary Indexes <http://docs.basho.com/riak/2.0.0/dev/using/2i/>`_,
-the ``SKIP_INDEX`` environment variable must be set to 0 (or 1 to skip them.)
+the ``RUN_INDEXES`` environment variable must be set to 1 (or 0 to skip them.)
 
 Testing Security (Riak 2+)
 --------------------------
@@ -212,3 +244,51 @@ To run the tests, then simply
 .. code-block:: console
 
     RUN_SECURITY=1 RIAK_TEST_HTTP_PORT=18098 python setup.py test
+
+Contributors
+--------------------------
+    - Andrew Thompson
+    - Andy Gross <andy@basho.com>
+    - Armon Dadgar
+    - Brett Hazen
+    - Brett Hoerner
+    - Brian Roach
+    - Bryan Fink
+    - Daniel Lindsley
+    - Daniel Néri
+    - Daniel Reverri
+    - David Koblas
+    - Dmitry Rozhkov
+    - Eric Florenzano
+    - Eric Moritz
+    - Filip de Waard
+    - Gilles Devaux
+    - Greg Nelson
+    - Greg Stein
+    - Gregory Burd
+    - Ian Plosker
+    - Jayson Baird <jay@mochimedia.com>
+    - Jeffrey Massung
+    - Jon Meredith <jmeredith@basho.com>
+    - Josip Lisec
+    - Justin Sheehy <justin@basho.com>
+    - Kevin Smith
+    - `Luke Bakken <https://github.com/lukebakken>`_
+    - Mark Erdmann
+    - Mark Phillips
+    - Mathias Meyer
+    - Matt Heitzenroder
+    - Mikhail Sobolev
+    - Reid Draper
+    - Russell Brown
+    - Rusty Klophaus
+    - Rusty Klophaus <rusty@basho.com>
+    - Scott Lystig Fritchie
+    - Sean Cribbs
+    - Shuhao Wu
+    - Silas Sewell
+    - Socrates Lee
+    - Soren Hansen
+    - Sreejith Kesavan
+    - Timothée Peignier
+    - William Kral

buildbot/Makefile

@@ -26,12 +26,19 @@ test: setup test_normal test_security
 test_normal:
 	@echo "Testing Riak Python Client (without security)"
 	@../setup.py disable_security --riak-admin=${RIAK_ADMIN}
-	@RUN_YZ=1 SKIP_DATATYPES=0 SKIP_INDEXES=0 ./tox_runner.sh ..
+	@RIAK_TEST_PROTOCOL='pbc' RUN_YZ=1 RUN_DATATYPES=1 RUN_INDEXES=1 ./tox_runner.sh ..
+	@RIAK_TEST_PROTOCOL='http' RUN_YZ=1 RUN_DATATYPES=1 RUN_INDEXES=1 ./tox_runner.sh ..
 
 test_security:
 	@echo "Testing Riak Python Client (with security)"
 	@../setup.py enable_security --riak-admin=${RIAK_ADMIN}
-	@RUN_YZ=1 SKIP_INDEXES=0 RUN_SECURITY=1 SKIP_POOL=1 SKIP_RESOLVE=1 RIAK_TEST_HTTP_PORT=18098 ./tox_runner.sh ..
+	@RIAK_TEST_PROTOCOL='pbc' RUN_YZ=1 RUN_INDEXES=1 RUN_SECURITY=1 RUN_POOL=0 RUN_RESOLVE=0 ./tox_runner.sh ..
+	@RIAK_TEST_PROTOCOL='http' RUN_YZ=1 RUN_INDEXES=1 RUN_SECURITY=1 RUN_POOL=0 RUN_RESOLVE=0 RIAK_TEST_HTTP_PORT=18098 ./tox_runner.sh ..
+
+test_timeseries:
+	@echo "Testing Riak Python Client (timeseries)"
+	@../setup.py disable_security --riak-admin=${RIAK_ADMIN}
+	@RIAK_TEST_PROTOCOL='pbc' RUN_YZ=0 RUN_DATATYPES=0 RUN_INDEXES=1 RUN_TIMESERIES=1 ./tox_runner.sh ..
 
 # These are required to actually build all the Python versions:
 # * pip install tox

buildbot/tox_cleanup.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+for pbin in .tox/*/bin
+do
+    echo $pbin
+    pip="$pbin/pip"
+    $pip uninstall riak_pb --yes
+    $pip uninstall riak --yes
+    $pip uninstall protobuf --yes
+    $pip uninstall python3-riak-pb --yes
+    $pip uninstall python3-protobuf --yes
+    echo -----
+done 

buildbot/tox_setup.sh

@@ -47,19 +47,19 @@ if [[ -z $(pyenv versions | grep riak_3.3.6) ]]; then
     VERSION_ALIAS="riak_3.3.6" pyenv install 3.3.6
     pyenv virtualenv riak_3.3.6 riak-py33
 fi
-if [[ -z $(pyenv versions | grep riak_2.7.10) ]]; then
-    VERSION_ALIAS="riak_2.7.10" pyenv install 2.7.10
-    pyenv virtualenv riak_2.7.10 riak-py27
+if [[ -z $(pyenv versions | grep riak_3.5.1) ]]; then
+    VERSION_ALIAS="riak_3.5.1" pyenv install 3.5.1
+    pyenv virtualenv riak_3.5.1 riak-py35
 fi
-if [[ -z $(pyenv versions | grep riak_2.7.9) ]]; then
-    VERSION_ALIAS="riak_2.7.9" pyenv install 2.7.9
-    pyenv virtualenv riak_2.7.9 riak-py279
+if [[ -z $(pyenv versions | grep riak_2.7.11) ]]; then
+    VERSION_ALIAS="riak_2.7.11" pyenv install 2.7.11
+    pyenv virtualenv riak_2.7.11 riak-py27
 fi
-if [[ -z $(pyenv versions | grep riak_2.6.9) ]]; then
-    VERSION_ALIAS="riak_2.6.9" pyenv install 2.6.9
-    pyenv virtualenv riak_2.6.9 riak-py26
+if [[ -z $(pyenv versions | grep riak_2.7.8) ]]; then
+    VERSION_ALIAS="riak_2.7.8" pyenv install 2.7.8
+    pyenv virtualenv riak_2.7.8 riak-py278
 fi
-pyenv global riak-py34 riak-py33 riak-py27 riak-py279 riak-py26
+pyenv global riak-py34 riak-py33 riak-py35 riak-py27 riak-py278
 pyenv versions
 
 # Now install tox

commands.py

@@ -11,8 +11,10 @@
 import os.path
 
 
-__all__ = ['create_bucket_types', 'setup_security', 'enable_security',
-           'disable_security', 'preconfigure', 'configure']
+__all__ = ['create_bucket_types',
+           'setup_security', 'enable_security', 'disable_security',
+           'setup_timeseries',
+           'preconfigure', 'configure']
 
 
 # Exception classes used by this module.
@@ -73,35 +75,7 @@ def check_output(*popenargs, **kwargs):
     import json
 
 
-class create_bucket_types(Command):
-    """
-    Creates bucket-types appropriate for testing. By default this will create:
-
-    * `pytest-maps` with ``{"datatype":"map"}``
-    * `pytest-sets` with ``{"datatype":"set"}``
-    * `pytest-counters` with ``{"datatype":"counter"}``
-    * `pytest-consistent` with ``{"consistent":true}``
-    * `pytest-write-once` with ``{"write_once": true}``
-    * `pytest-mr`
-    * `pytest` with ``{"allow_mult":false}``
-    """
-
-    description = "create bucket-types used in integration tests"
-
-    user_options = [
-        ('riak-admin=', None, 'path to the riak-admin script')
-    ]
-
-    _props = {
-        'pytest-maps': {'datatype': 'map'},
-        'pytest-sets': {'datatype': 'set'},
-        'pytest-counters': {'datatype': 'counter'},
-        'pytest-consistent': {'consistent': True},
-        'pytest-write-once': {'write_once': True},
-        'pytest-mr': {},
-        'pytest': {'allow_mult': False}
-    }
-
+class bucket_type_commands:
     def initialize_options(self):
         self.riak_admin = None
 
@@ -171,6 +145,66 @@ def _btype_command(self, *args):
         return cmd
 
 
+class create_bucket_types(bucket_type_commands, Command):
+    """
+    Creates bucket-types appropriate for testing. By default this will create:
+
+    * `pytest-maps` with ``{"datatype":"map"}``
+    * `pytest-sets` with ``{"datatype":"set"}``
+    * `pytest-counters` with ``{"datatype":"counter"}``
+    * `pytest-consistent` with ``{"consistent":true}``
+    * `pytest-write-once` with ``{"write_once": true}``
+    * `pytest-mr`
+    * `pytest` with ``{"allow_mult":false}``
+    """
+
+    description = "create bucket-types used in integration tests"
+
+    user_options = [
+        ('riak-admin=', None, 'path to the riak-admin script')
+    ]
+
+    _props = {
+        'pytest-maps': {'datatype': 'map'},
+        'pytest-sets': {'datatype': 'set'},
+        'pytest-counters': {'datatype': 'counter'},
+        'pytest-consistent': {'consistent': True},
+        'pytest-write-once': {'write_once': True},
+        'pytest-mr': {},
+        'pytest': {'allow_mult': False}
+    }
+
+
+class setup_timeseries(bucket_type_commands, Command):
+    """
+    Creates bucket-types appropriate for timeseries.
+    """
+
+    description = "create bucket-types used in timeseries tests"
+
+    user_options = [
+        ('riak-admin=', None, 'path to the riak-admin script')
+    ]
+
+    _props = {
+        'GeoCheckin': {
+            'n_val': 3,
+            'table_def': '''
+                CREATE TABLE GeoCheckin (
+                    geohash varchar not null,
+                    user varchar not null,
+                    time timestamp not null,
+                    weather varchar not null,
+                    temperature double,
+                    PRIMARY KEY(
+                        (geohash, user, quantum(time, 15, m)),
+                        geohash, user, time
+                    )
+                )'''
+        }
+    }
+
+
 class security_commands(object):
     def check_security_command(self, *args):
         cmd = self._security_command(*args)
@@ -396,9 +430,9 @@ def _update_riak_conf(self):
         https_host = self.host + ':' + self.https_port
         pb_host = self.host + ':' + self.pb_port
         self._backup_file(self.riak_conf)
-        f = open(self.riak_conf, 'r', buffering=1)
-        conf = f.read()
-        f.close()
+        conf = None
+        with open(self.riak_conf, 'r', buffering=1) as f:
+            conf = f.read()
         conf = re.sub(r'search\s+=\s+off', r'search = on', conf)
         conf = re.sub(r'##[ ]+ssl\.', r'ssl.', conf)
         conf = re.sub(r'ssl.certfile\s+=\s+\S+',
@@ -427,9 +461,8 @@ def _update_riak_conf(self):
         # Older versions of OpenSSL client library need to match on the server
         conf += 'tls_protocols.tlsv1 = on\n'
         conf += 'tls_protocols.tlsv1.1 = on\n'
-        f = open(self.riak_conf, 'w', buffering=1)
-        f.write(conf)
-        f.close()
+        with open(self.riak_conf, 'w', buffering=1) as f:
+            f.write(conf)
 
     def _backup_file(self, name):
         backup = name + ".bak"
@@ -469,6 +502,4 @@ def run(self):
         for cmd_name in self.get_sub_commands():
             self.run_command(cmd_name)
 
-    sub_commands = [('create_bucket_types', None),
-                    ('setup_security', None)
-                    ]
+    sub_commands = [('create_bucket_types', None), ('setup_security', None)]