Support for atRevision for get and verifiedGet (#47)

Razikus · web-flow · commit 483bdaf204ef · 2022-06-12T18:21:35.000+02:00
* Added tests for 1.3.0
* Supports atRevision for get and verifiedGet
* Update version to 1.3.0
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,8 +21,9 @@ 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.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 3333:3322 codenotary/immudb:1.1.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.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 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
         run: |
           make test
diff --git a/devtest.py b/devtest.py
diff --git a/immudb/client.py b/immudb/client.py
@@ -273,14 +273,14 @@ def expireableSet(self, key: bytes, value: bytes, expiresAt: datetime.datetime):
         metadata.ExpiresAt(expiresAt)
         return setValue.call(self.__stub, self.__rs, key, value, metadata)
 
-    def get(self, key: bytes):
-        return get.call(self.__stub, self.__rs, key)
+    def get(self, key: bytes, atRevision: int = None):
+        return get.call(self.__stub, self.__rs, key, atRevision=atRevision)
 
     # Not implemented: getSince
     # Not implemented: getAt
 
-    def verifiedGet(self, key: bytes):
-        return verifiedGet.call(self.__stub, self.__rs, key, verifying_key=self.__vk)
+    def verifiedGet(self, key: bytes, atRevision: int = None):
+        return verifiedGet.call(self.__stub, self.__rs, key, verifying_key=self.__vk, atRevision=atRevision)
 
     def verifiedGetSince(self, key: bytes, sinceTx: int):
         return verifiedGet.call(self.__stub, self.__rs, key, sinceTx=sinceTx, verifying_key=self.__vk)
diff --git a/immudb/datatypes.py b/immudb/datatypes.py
@@ -35,6 +35,7 @@ class SafeGetResponse:
     timestamp: int
     verified: bool
     refkey: bytes
+    revision: int
 
 
 @dataclass
@@ -49,6 +50,7 @@ class GetResponse:
     tx: int
     key: bytes
     value: bytes
+    revision: int
 
 
 @dataclass
diff --git a/immudb/grpc/proto/schema.proto b/immudb/grpc/proto/schema.proto
@@ -127,13 +127,15 @@ message Entry {
 	Reference referencedBy = 4;
 	KVMetadata metadata = 5;
 	bool expired = 6;
+	uint64 revision = 7;
 }
 
 message Reference {
 	uint64 tx = 1;
 	bytes key = 2;
 	uint64 atTx = 3;
 	KVMetadata metadata = 4;
+	uint64 revision = 5;
 }
 
 message Op {
@@ -280,6 +282,7 @@ message KeyRequest {
     uint64 atTx = 2;
 	uint64 sinceTx = 3;
 	bool  noWait = 4;
+	int64 atRevision = 5;
 }
 
 message KeyListRequest {
@@ -419,6 +422,10 @@ message TxList {
 	repeated Tx txs = 1;
 }
 
+message ExportTxRequest {
+	uint64 tx = 1;
+}
+
 message Database {
 	string databaseName = 1;
 }
diff --git a/immudb/grpc/schema_pb2.py b/immudb/grpc/schema_pb2.py
diff --git a/immudb/grpc/schema_pb2_grpc.py b/immudb/grpc/schema_pb2_grpc.py
diff --git a/immudb/handler/get.py b/immudb/handler/get.py
@@ -18,9 +18,10 @@
 from immudb import datatypes
 
 
-def call(service: schema_pb2_grpc.ImmuServiceStub, rs: RootService, key: bytes):
+def call(service: schema_pb2_grpc.ImmuServiceStub, rs: RootService, key: bytes, atRevision: int = None):
     request = schema_pb2.KeyRequest(
-        key=key
+        key=key,
+        atRevision=atRevision
     )
     try:
         msg = service.Get(request)
@@ -32,5 +33,6 @@ def call(service: schema_pb2_grpc.ImmuServiceStub, rs: RootService, key: bytes):
     return datatypes.GetResponse(
         tx=msg.tx,
         key=msg.key,
-        value=msg.value
+        value=msg.value,
+        revision=msg.revision
     )
diff --git a/immudb/handler/verifiedGet.py b/immudb/handler/verifiedGet.py
@@ -23,11 +23,11 @@
 import sys
 
 
-def call(service: schema_pb2_grpc.ImmuServiceStub, rs: RootService, requestkey: bytes, atTx: int = None, verifying_key=None, sinceTx: int = None):
+def call(service: schema_pb2_grpc.ImmuServiceStub, rs: RootService, requestkey: bytes, atTx: int = None, verifying_key=None, sinceTx: int = None, atRevision: int = None):
     state = rs.get()
     req = schema_pb2.VerifiableGetRequest(
         keyRequest=schema_pb2.KeyRequest(
-            key=requestkey, atTx=atTx, sinceTx=sinceTx),
+            key=requestkey, atTx=atTx, sinceTx=sinceTx, atRevision=atRevision),
         proveSinceTx=state.txId
     )
     ventry = service.VerifiableGet(req)
@@ -95,5 +95,6 @@ def call(service: schema_pb2_grpc.ImmuServiceStub, rs: RootService, requestkey:
         value=ventry.entry.value,
         timestamp=ventry.verifiableTx.tx.header.ts,
         verified=verifies,
-        refkey=refkey
+        refkey=refkey,
+        revision=ventry.entry.revision
     )
diff --git a/setup.py b/setup.py
@@ -17,7 +17,7 @@
     long_description = fh.read()
 
 setup(name='immudb-py',
-      version='1.2.4',
+      version='1.3.0',
       license="Apache License Version 2.0",
       description='Python SDK for Immudb',
       long_description=long_description,
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -15,7 +15,7 @@
 
 # See .github/workflows/ci.yml for the automated tests
 
-TESTURLS = ["localhost:3322", "localhost:3333"]
+TESTURLS = ["localhost:3322", "localhost:3333", "localhost:3344"]
 
 
 @pytest.fixture(scope="module")
diff --git a/tests/immu/test_get_revision.py b/tests/immu/test_get_revision.py
@@ -0,0 +1,107 @@
+# Copyright 2021 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 grpc import RpcError
+import uuid
+import pytest
+from tests.immuTestClient import ImmuTestClient
+
+class TestGetRevision:
+
+    def test_relative_get_revision(self, wrappedClient: ImmuTestClient):
+        if(wrappedClient.serverHigherOrEqualsToVersion("1.3.0")):
+            key = str(uuid.uuid4()).encode("utf-8")
+            wrappedClient.set(key, b'0')
+            wrappedClient.set(key, b'1')
+            wrappedClient.set(key, b'2')
+
+            now = wrappedClient.get(key, 0)
+            assert now.value == b'2'
+            assert now.revision == 3
+            now = wrappedClient.get(key, -1)
+            assert now.value == b'1'
+            assert now.revision == 2
+            now = wrappedClient.get(key, -2)
+            assert now.value == b'0'
+            assert now.revision == 1
+            with pytest.raises(RpcError, match="invalid key revision number") :
+                now = wrappedClient.get(key, -3)
+
+    def test_non_relative_get_revision(self, wrappedClient: ImmuTestClient):
+        if(wrappedClient.serverHigherOrEqualsToVersion("1.3.0")):
+            key = str(uuid.uuid4()).encode("utf-8")
+            wrappedClient.set(key, b'033')
+            wrappedClient.set(key, b'133')
+            wrappedClient.set(key, b'233')
+            
+            now = wrappedClient.get(key, 1)
+            assert now.value == b'033'
+            assert now.revision == 1
+            now = wrappedClient.get(key, 2)
+            assert now.value == b'133'
+            assert now.revision == 2
+            now = wrappedClient.get(key, 3)
+            assert now.value == b'233'
+            assert now.revision == 3
+
+            with pytest.raises(RpcError, match="invalid key revision number") :
+                now = wrappedClient.get(key, 4)
+        else:
+            pytest.skip("Server does not support yet revisions")
+
+
+    def test_relative_verified_get_revision(self, wrappedClient: ImmuTestClient):
+        if(wrappedClient.serverHigherOrEqualsToVersion("1.3.0")):
+            key = str(uuid.uuid4()).encode("utf-8")
+            wrappedClient.set(key, b'0')
+            wrappedClient.set(key, b'1')
+            wrappedClient.set(key, b'2')
+
+            now = wrappedClient.verifiedGet(key, 0)
+            assert now.value == b'2'
+            assert now.revision == 3
+            assert now.verified == True
+            now = wrappedClient.verifiedGet(key, -1)
+            assert now.value == b'1'
+            assert now.revision == 2
+            assert now.verified == True
+            now = wrappedClient.verifiedGet(key, -2)
+            assert now.value == b'0'
+            assert now.revision == 1
+            assert now.verified == True
+            with pytest.raises(RpcError, match="invalid key revision number") :
+                now = wrappedClient.verifiedGet(key, -3)
+
+    def test_non_relative_verified_get_revision(self, wrappedClient: ImmuTestClient):
+        if(wrappedClient.serverHigherOrEqualsToVersion("1.3.0")):
+            key = str(uuid.uuid4()).encode("utf-8")
+            wrappedClient.set(key, b'033')
+            wrappedClient.set(key, b'133')
+            wrappedClient.set(key, b'233')
+            
+            now = wrappedClient.verifiedGet(key, 1)
+            assert now.value == b'033'
+            assert now.revision == 1
+            assert now.verified == True
+            now = wrappedClient.verifiedGet(key, 2)
+            assert now.value == b'133'
+            assert now.revision == 2
+            assert now.verified == True
+            now = wrappedClient.verifiedGet(key, 3)
+            assert now.value == b'233'
+            assert now.revision == 3
+            assert now.verified == True
+
+            with pytest.raises(RpcError, match="invalid key revision number") :
+                now = wrappedClient.verifiedGet(key, 4)
+        else:
+            pytest.skip("Server does not support yet revisions")
diff --git a/tests/immuTestClient.py b/tests/immuTestClient.py
@@ -30,8 +30,11 @@ def rollback(self):
     def openManagedSession(self, login, password, db):
         return self.client.openManagedSession(login, password, db)
 
-    def get(self, key: bytes):
-        return self.client.get(key)
+    def get(self, key: bytes, atRevision: int = None):
+        return self.client.get(key, atRevision = atRevision)
+
+    def verifiedGet(self, key: bytes, atRevision: int = None):
+        return self.client.verifiedGet(key, atRevision = atRevision)
         
     def set(self, key: bytes, value: bytes):
         return self.client.set(key, value)
diff --git a/tests/starttestcontainers.sh b/tests/starttestcontainers.sh
@@ -0,0 +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 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

Original file line number	Diff line number	Diff line change
`@@ -127,13 +127,15 @@ message Entry {`
`127`	`127`	`Reference referencedBy = 4;`
`128`	`128`	`KVMetadata metadata = 5;`
`129`	`129`	`bool expired = 6;`
	`130`	`+ uint64 revision = 7;`
`130`	`131`	`}`
`131`	`132`
`132`	`133`	`message Reference {`
`133`	`134`	`uint64 tx = 1;`
`134`	`135`	`bytes key = 2;`
`135`	`136`	`uint64 atTx = 3;`
`136`	`137`	`KVMetadata metadata = 4;`
	`138`	`+ uint64 revision = 5;`
`137`	`139`	`}`
`138`	`140`
`139`	`141`	`message Op {`
`@@ -280,6 +282,7 @@ message KeyRequest {`
`280`	`282`	`uint64 atTx = 2;`
`281`	`283`	`uint64 sinceTx = 3;`
`282`	`284`	`bool noWait = 4;`
	`285`	`+ int64 atRevision = 5;`
`283`	`286`	`}`
`284`	`287`
`285`	`288`	`message KeyListRequest {`
`@@ -419,6 +422,10 @@ message TxList {`
`419`	`422`	`repeated Tx txs = 1;`
`420`	`423`	`}`
`421`	`424`
	`425`	`+message ExportTxRequest {`
	`426`	`+ uint64 tx = 1;`
	`427`	`+}`
	`428`	`+`
`422`	`429`	`message Database {`
`423`	`430`	`string databaseName = 1;`
`424`	`431`	`}`