adds collection/name parsing for streams method [ch1554]

Author: looselycoupled

btrdb/conn.py

@@ -1,49 +1,45 @@
-# Copyright (c) 2017 Sam Kumar <samkumar@berkeley.edu>
-# Copyright (c) 2017 Michael P Andersen <m.andersen@cs.berkeley.edu>
-# Copyright (c) 2017 University of California, Berkeley
-# All rights reserved.
+# btrdb.conn
+# Connection related objects for the BTrDB library
 #
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#     * Redistributions of source code must retain the above copyright
-#       notice, this list of conditions and the following disclaimer.
-#     * Redistributions in binary form must reproduce the above copyright
-#       notice, this list of conditions and the following disclaimer in the
-#       documentation and/or other materials provided with the distribution.
-#     * Neither the name of the University of California, Berkeley nor the
-#       names of its contributors may be used to endorse or promote products
-#       derived from this software without specific prior written permission.
+# Author:   PingThings
+# Created:  Fri Dec 21 14:57:30 2018 -0500
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNERS OR CONTRIBUTORS BE LIABLE FOR
-# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# For license information, see LICENSE.txt
+# ID: conn.py [] allen@pingthings.io $
 
 """
-The 'btrdb' module provides Python bindings to interact with BTrDB.
+Connection related objects for the BTrDB library
 """
 
-import grpc
-import uuid as uuidlib
+##########################################################################
+## Imports
+##########################################################################
+
 import os
+import re
+import uuid as uuidlib
 
+import grpc
 from grpc._cython.cygrpc import CompressionAlgorithm
 
 from btrdb.stream import Stream, StreamSet
 from btrdb.utils.general import unpack_stream_descriptor
 from btrdb.utils.conversion import to_uuid
+from btrdb.exceptions import NotFound
+
+##########################################################################
+## Module Variables
+##########################################################################
 
 MIN_TIME = -(16 << 56)
 MAX_TIME = 48 << 56
 MAX_POINTWIDTH = 63
 
 
+##########################################################################
+## Classes
+##########################################################################
+
 class Connection(object):
 
     def __init__(self, addrportstr, apikey=None):
@@ -129,7 +125,31 @@ def streams(self, *identifiers, versions=None):
         if versions and len(versions) != len(identifiers):
             raise ValueError("number of versions does not match identifiers")
 
-        streams = [self.stream_from_uuid(ident) for ident in identifiers]
+        streams = []
+        for ident in identifiers:
+            if isinstance(ident, uuidlib.UUID):
+                streams.append(self.stream_from_uuid(ident))
+                continue
+
+            if isinstance(ident, str):
+                # attempt UUID lookup
+                pattern = "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
+                if re.match(pattern, ident):
+                    streams.append(self.stream_from_uuid(ident))
+                    continue
+
+                # attempt collection/name lookup
+                if "/" in ident:
+                    parts = ident.split("/")
+                    found = self.streams_in_collection("/".join(parts[:-1]), tags={"name": parts[-1]})
+                    if len(found) == 1:
+                        streams.append(found[0])
+                        continue
+                    raise NotFound(f"Could not identify stream `{ident}`")
+
+            raise ValueError(f"Could not identify stream based on `{ident}`.  Identifier must be UUID or collection/name.")
+
+
         obj = StreamSet(streams)
 
         if versions:

tests/btrdb/test_conn.py

@@ -22,6 +22,7 @@
 from btrdb.conn import Connection, BTrDB
 from btrdb.endpoint import Endpoint
 from btrdb.grpcinterface import btrdb_pb2
+from btrdb.exceptions import *
 
 ##########################################################################
 ## Connection Tests
@@ -55,6 +56,10 @@ def test_raises_err_for_apikey_insecure_port(self):
 
 class TestBTrDB(object):
 
+    ##########################################################################
+    ## .streams tests
+    ##########################################################################
+
     def test_streams_raises_err_if_version_not_list(self):
         """
         Assert streams raises TypeError if versions is not list
@@ -90,6 +95,84 @@ def test_streams_stores_versions(self):
         streams = db.streams(uuid1, uuid2, versions=versions)
         assert streams._pinned_versions == expected
 
+
+    @patch('btrdb.conn.BTrDB.stream_from_uuid')
+    def test_streams_recognizes_uuid(self, mock_func):
+        """
+        Assert streams recognizes uuid strings
+        """
+        db = BTrDB(None)
+        uuid1 = uuidlib.UUID('0d22a53b-e2ef-4e0a-ab89-b2d48fb2592a')
+        mock_func.return_value = [1]
+        db.streams(uuid1)
+
+        mock_func.assert_called_once()
+        assert mock_func.call_args[0][0] == uuid1
+
+
+    @patch('btrdb.conn.BTrDB.stream_from_uuid')
+    def test_streams_recognizes_uuid_string(self, mock_func):
+        """
+        Assert streams recognizes uuid strings
+        """
+        db = BTrDB(None)
+        uuid1 = '0d22a53b-e2ef-4e0a-ab89-b2d48fb2592a'
+        mock_func.return_value = [1]
+        db.streams(uuid1)
+
+        mock_func.assert_called_once()
+        assert mock_func.call_args[0][0] == uuid1
+
+
+    @patch('btrdb.conn.BTrDB.streams_in_collection')
+    def test_streams_handles_path(self, mock_func):
+        """
+        Assert streams calls streams_in_collection for collection/name paths
+        """
+        db = BTrDB(None)
+        ident = "zoo/animal/dog"
+        mock_func.return_value = [1]
+        db.streams(ident, '0d22a53b-e2ef-4e0a-ab89-b2d48fb2592a')
+
+        mock_func.assert_called_once()
+        assert mock_func.call_args[0][0] == 'zoo/animal'
+        assert mock_func.call_args[1] == {'tags': {'name': 'dog'}}
+
+
+    @patch('btrdb.conn.BTrDB.streams_in_collection')
+    def test_streams_raises_err(self, mock_func):
+        """
+        Assert streams raises NotFound
+        """
+        db = BTrDB(None)
+        ident = "zoo/animal/dog"
+
+        mock_func.return_value = []
+        with pytest.raises(NotFound) as exc:
+            db.streams(ident)
+
+        mock_func.return_value = [1,2]
+        with pytest.raises(NotFound) as exc:
+            db.streams(ident)
+
+        # check that does not raise if one returned
+        mock_func.return_value = [1]
+        db.streams(ident)
+
+
+    def test_streams_raises_valueerror(self):
+        """
+        Assert streams raises ValueError if not uuid, uuid str, or path
+        """
+        db = BTrDB(None)
+        with pytest.raises(ValueError) as exc:
+            db.streams(11)
+
+
+    ##########################################################################
+    ## other tests
+    ##########################################################################
+
     def test_info(self):
         """
         Assert info method returns a dict