1.3.1 test container bump, added global timeout for requests (#49)

* Added possibility for global timeout for GRPC requests

Author: Razikus

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
           make dev
       - name: Start immudb container
         run: |
-          docker run -d --health-cmd "immuadmin status" --health-interval 10s --health-timeout 5s --health-retries 5 -v ${{ github.workspace }}/tests/certs/my.key.pem:/key.pem -p 3322:3322 codenotary/immudb:1.3.0 --signingKey=/key.pem
+          docker run -d --health-cmd "immuadmin status" --health-interval 10s --health-timeout 5s --health-retries 5 -v ${{ github.workspace }}/tests/certs/my.key.pem:/key.pem -p 3322:3322 codenotary/immudb:1.3.1 --signingKey=/key.pem
           docker run -d --health-cmd "immuadmin status" --health-interval 10s --health-timeout 5s --health-retries 5 -v ${{ github.workspace }}/tests/certs/my.key.pem:/key.pem -p 3333:3322 codenotary/immudb:1.2.4 --signingKey=/key.pem
           docker run -d --health-cmd "immuadmin status" --health-interval 10s --health-timeout 5s --health-retries 5 -v ${{ github.workspace }}/tests/certs/my.key.pem:/key.pem -p 3344:3322 codenotary/immudb:1.1.0 --signingKey=/key.pem
       - name: Run tests

immudb/client.py

@@ -34,9 +34,10 @@
 
 class ImmudbClient:
 
-    def __init__(self, immudUrl=None, rs: RootService = None, publicKeyFile: str = None):
+    def __init__(self, immudUrl=None, rs: RootService = None, publicKeyFile: str = None, timeout=None):
         if immudUrl is None:
             immudUrl = "localhost:3322"
+        self.timeout = timeout
         self.channel = grpc.insecure_channel(immudUrl)
         self._resetStub()
         if rs is None:
@@ -81,8 +82,9 @@ def set_token_header_interceptor(self, response):
         return self.get_intercepted_stub()
 
     def get_intercepted_stub(self):
+        allInterceptors = self.headersInterceptors + self.clientInterceptors
         intercepted, newStub = grpcutils.get_intercepted_stub(
-            self.channel, self.headersInterceptors)
+            self.channel, allInterceptors)
         self.intercept_channel = intercepted
         return newStub
 
@@ -136,7 +138,12 @@ def logout(self):
 
     def _resetStub(self):
         self.headersInterceptors = []
+        self.clientInterceptors = []
+        if(self.timeout != None):
+            self.clientInterceptors.append(
+                grpcutils.timeout_adder_interceptor(self.timeout))
         self.__stub = schema_pb2_grpc.ImmuServiceStub(self.channel)
+        self.__stub = self.get_intercepted_stub()
 
     def keepAlive(self):
         self.__stub.KeepAlive(google_dot_protobuf_dot_empty__pb2.Empty())

immudb/grpcutils.py

@@ -28,6 +28,21 @@ class _ClientCallDetails(
     pass
 
 
+def timeout_adder_interceptor(stubTimeout=None):
+
+    def intercept_call(client_call_details, request_iterator, request_streaming,
+                       response_streaming):
+        timeoutToSet = client_call_details.timeout
+        if(timeoutToSet == None):
+            timeoutToSet = stubTimeout
+        client_call_details = _ClientCallDetails(
+            client_call_details.method, timeoutToSet, client_call_details.metadata,
+            client_call_details.credentials)
+        return client_call_details, request_iterator, None
+
+    return generic_client_interceptor.create(intercept_call)
+
+
 def header_adder_interceptor(header, value):
 
     def intercept_call(client_call_details, request_iterator, request_streaming,

setup.py

@@ -17,7 +17,7 @@
     long_description = fh.read()
 
 setup(name='immudb-py',
-      version='1.3.0.post1',
+      version='1.3.1',
       license="Apache License Version 2.0",
       description='Python SDK for Immudb',
       long_description=long_description,

tests/conftest.py

@@ -53,7 +53,10 @@ def client_pem(request):
 def client(request):
     return client_margs(immudUrl=request.param)
 
-
 @pytest.fixture(scope="function", params=TESTURLS)
 def wrappedClient(request):
     return ImmuTestClient(client_margs(immudUrl=request.param))
+
+@pytest.fixture(scope="function", params=TESTURLS)
+def argsToBuildClient(request):
+    return (request.param, "immudb", "immudb")

tests/immu/test_massive_operation.py

@@ -13,6 +13,8 @@
 import string
 import random
 import time
+from tests.immuTestClient import ImmuTestClient
+import pytest
 
 
 def get_random_string(length):
@@ -41,5 +43,9 @@ def test_get_set_massive(self, client):
             assert i in xset
             assert xset[i] == resp[i]
 
-    def test_compact(self, client):
-        client.compactIndex()
+    def test_compact(self, wrappedClient: ImmuTestClient):
+        # Snapshot compaction fixed from 1.3.1
+        if(wrappedClient.serverHigherOrEqualsToVersion("1.3.0")):
+            wrappedClient.client.compactIndex()
+        else:
+            pytest.skip("Server version too low")

tests/immu/test_timeout.py

@@ -0,0 +1,48 @@
+# Copyright 2022 CodeNotary, Inc. All rights reserved.
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#       http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from immudb.client import ImmudbClient
+import pytest
+from grpc import RpcError, StatusCode
+import uuid
+
+def generateBigDict():
+    toBuild = dict()
+    keyList = []
+    for _ in range(0, 128):
+        bigStr = str(uuid.uuid4()) * 512
+        key = str(uuid.uuid4()).encode("utf-8")
+        keyList.append(key)
+        toBuild[key] = bigStr.encode("utf-8")
+    return toBuild, keyList
+
+
+class TestTimeout:
+    def test_simple_timeout(self, argsToBuildClient):
+        url, login, password = argsToBuildClient
+        client = ImmudbClient(url, timeout=1)
+        client.login(login, password)
+
+        with pytest.raises(RpcError) as excinfo: 
+            client = ImmudbClient(url, timeout=0.001)
+            client.login(login, password)
+        assert excinfo.value.code() == StatusCode.DEADLINE_EXCEEDED
+
+
+        with pytest.raises(RpcError) as excinfo: 
+            client = ImmudbClient(url, timeout=0.05)
+            client.login(login, password)
+            keyVal, keys = generateBigDict()
+            client.setAll(keyVal)
+            scanned = client.scan(b"", b"", False, 400)
+        assert excinfo.value.code() == StatusCode.DEADLINE_EXCEEDED
+        

tests/starttestcontainers.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 cd "$(dirname "$0")"
 
-docker run -d --health-cmd "immuadmin status" --health-interval 10s --health-timeout 5s --health-retries 5 -v "$PWD"/certs/my.key.pem:/key.pem -p 3322:3322 codenotary/immudb:1.3.0 --signingKey=/key.pem
+docker run -d --health-cmd "immuadmin status" --health-interval 10s --health-timeout 5s --health-retries 5 -v "$PWD"/certs/my.key.pem:/key.pem -p 3322:3322 codenotary/immudb:1.3.1 --signingKey=/key.pem
 docker run -d --health-cmd "immuadmin status" --health-interval 10s --health-timeout 5s --health-retries 5 -v "$PWD"/certs/my.key.pem:/key.pem -p 3333:3322 codenotary/immudb:1.2.4 --signingKey=/key.pem
 docker run -d --health-cmd "immuadmin status" --health-interval 10s --health-timeout 5s --health-retries 5 -v "$PWD"/certs/my.key.pem:/key.pem -p 3344:3322 codenotary/immudb:1.1.0 --signingKey=/key.pem