Rename storage integrity to proof mechanism

John Hartley · eccles · commit 1bd812b95cce · 2021-10-05T12:05:23.000+01:00
Problem:
Upstream the storage integrity option was renamed t
proof mechanism with more options.

Solution:
Change name and enumerated values correspondingly

Signed-off-by: Paul Hewlett &lt;phewlett76@gmail.com&gt;
diff --git a/.gitignore b/.gitignore
@@ -13,4 +13,4 @@ htmlcov/
 .eggs/
 .task/
 *.pyi
-.vscode
+.vscode
diff --git a/README.rst b/README.rst
@@ -26,7 +26,7 @@ One can then use the examples code to create assets (see examples directory):
     
     from archivist.archivist import Archivist
     from archivist.errors import ArchivistError
-    from archivist.storage_integrity import StorageIntegrity
+    from archivist.proof_mechanism import ProofMechanism
     
     # Oauth2 token that grants access
     with open(".auth_token", mode='r') as tokenfile:
@@ -57,11 +57,11 @@ One can then use the examples code to create assets (see examples directory):
     }
     #
     # store asset on the DLT or not. If DLT is not enabled for the user an error will occur if
-    # StorageIntegrity.LEDGER is specified. If unspecified then TENANT_STORAGE is used
+    # ProofMechanism.KHIPU is specified. If unspecified then SIMPLE_HASH is used
     # i.e. not stored on the DLT...
-    # storage_integrity = StorageIntegrity.TENANT_STORAGE
+    # proof_mechanism = ProofMechanism.KHIPU
     props = {
-        "storage_integrity": StorageIntegrity.LEDGER.name,
+        "proof_mechanism": ProofMechanism.KHIPU.name,
     }
 
     # The first argument is the properties of the asset
diff --git a/archivist/archivist.py b/archivist/archivist.py
@@ -11,7 +11,7 @@
    IAM subjects and IAM access policies.
 
    Instantiation of this class encapsulates the URL and authentication
-   parameters (the max_time paramater is optional):
+   parameters (the max_time parameter is optional):
 
    .. code-block:: python
 
diff --git a/archivist/assets.py b/archivist/assets.py
@@ -132,7 +132,7 @@ def create(
         Creates asset with defined properties and attributes.
 
         Args:
-            props (dict): Properties - usually only the storage_integrity setting
+            props (dict): Properties - usually only the proof_mechanism setting
             attrs (dict): attributes of created asset.
             confirm (bool): if True wait for asset to be confirmed.
 
diff --git a/archivist/parser.py b/archivist/parser.py
@@ -12,7 +12,7 @@
 
 from .archivist import Archivist
 from .logger import set_logger
-from .storage_integrity import StorageIntegrity
+from .proof_mechanism import ProofMechanism
 
 LOGGER = logging.getLogger(__name__)
 
@@ -70,13 +70,13 @@ def common_parser(description):
         help="location of Archivist service",
     )
     parser.add_argument(
-        "-i",
-        "--storage-integrity",
-        type=StorageIntegrity,
+        "-p",
+        "--proof-mechanism",
+        type=ProofMechanism,
         action=EnumAction,
-        dest="storage_integrity",
-        default=StorageIntegrity.TENANT_STORAGE,
-        help="Assets will be created on the ledger or on tenant storage",
+        dest="proof_mechanism",
+        default=ProofMechanism.SIMPLE_HASH,
+        help="mechanism for proving the evidence for events on the Asset",
     )
 
     security = parser.add_mutually_exclusive_group(required=True)
@@ -114,7 +114,7 @@ def endpoint(args):
     LOGGER.info("Initialising connection to Jitsuin Archivist...")
     fixtures = {
         "assets": {
-            "storage_integrity": args.storage_integrity.name,
+            "proof_mechanism": args.proof_mechanism.name,
         },
     }
 
diff --git a/archivist/proof_mechanism.py b/archivist/proof_mechanism.py
@@ -0,0 +1,17 @@
+"""Archivist Proof Mechanism
+
+   Enumerated type that allows user to select the proof_mechanism option when
+   creating an asset.
+
+"""
+
+from enum import Enum
+
+
+class ProofMechanism(Enum):
+    """Enumerate proof mechanism options"""
+
+    #: Assets and events are proven using Jitsuin Khipus on the ledger
+    KHIPU = 1
+    #: Assets and events are proven using a hash of the originator's evidence
+    SIMPLE_HASH = 2
diff --git a/archivist/storage_integrity.py b/archivist/storage_integrity.py
diff --git a/docs/fixtures.rst b/docs/fixtures.rst
@@ -12,7 +12,7 @@ and locations.
 
     from archivist.archivist import Archivist
     from archivist.errors import ArchivistError
-    from archivist.storage_integrity import StorageIntegrity
+    from archivist.proof_mechanism import ProofMechanism
     
     # Oauth2 token that grants access
     with open(".auth_token", mode='r') as tokenfile:
@@ -24,7 +24,7 @@ and locations.
         auth=authtoken,
         fixtures = {
             "assets": {
-                "storage_integrity": StorageIntegrity.LEDGER.name,
+                "proof_mechanism": ProofMechanism.KHIPU.name,
             }
         },
     )
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,6 +9,7 @@ Jitsuin Archivist
 .. include:: ../README.rst
 
 .. toctree::
+   :hidden:
    :maxdepth: 2
    :caption: Contents:
 
@@ -25,7 +26,7 @@ Jitsuin Archivist
 
    timestamp
    errors
-   storage_integrity
+   proof_mechanism
 
 Indices and tables
 ==================
diff --git a/docs/proof_mechanism.rst b/docs/proof_mechanism.rst
@@ -0,0 +1,10 @@
+
+.. _proof_mechanism:
+
+Proof Mechanism
+---------------
+
+
+.. automodule:: archivist.proof_mechanism
+   :members:
+
diff --git a/docs/storage_integrity.rst b/docs/storage_integrity.rst
diff --git a/examples/create_asset.py b/examples/create_asset.py
@@ -7,7 +7,7 @@
 """
 
 from archivist.archivist import Archivist
-from archivist.storage_integrity import StorageIntegrity
+from archivist.proof_mechanism import ProofMechanism
 
 
 def create_asset(arch):
@@ -37,12 +37,12 @@ def create_asset(arch):
         # it does not start with arc_
     }
     #
-    # store asset on the DLT or not. If DLT is not enabled for the user an error will occur if
-    # StorageIntegrity.LEDGER is specified. If unspecified then TENANT_STORAGE is used
-    # i.e. not stored on the DLT...
-    # storage_integrity = StorageIntegrity.TENANT_STORAGE.name
+    # Select the mechanism used to prove evidence for the asset.  If the selected proof
+    # mechanism is not enabled for your tenant then an error will occur.
+    # If unspecified then SIMPLE_HASH is used.
+    # proof_mechanism = ProofMechanism.KHIPU.name
     props = {
-        "storage_integrity": StorageIntegrity.LEDGER.name,
+        "proof_mechanism": ProofMechanism.KHIPU.name,
     }
 
     # The first argument are the properties of the asset
@@ -76,8 +76,8 @@ def main():
 
     # Initialize connection to Archivist. max_time is the time to wait for confirmation
     # of an asset or event creation - the default is 1200 seconds but one can optionally
-    # specify a differnet value here particularly when creating assets on TENANT_STORAGE
-    # (rather than LEDGER) as confirmation times are much shorter in this case.
+    # specify a different value here particularly when creating assets on SIMPLE_HASH
+    # (rather than KHIPU) as confirmation times are much shorter in this case.
     arch = Archivist(
         "https://app.rkvst.io",
         auth=authtoken,
diff --git a/functests/execassets.py b/functests/execassets.py
@@ -3,12 +3,13 @@
 """
 
 from copy import copy, deepcopy
+import json
 from os import environ
 from unittest import TestCase
 from uuid import uuid4
 
 from archivist.archivist import Archivist
-from archivist.storage_integrity import StorageIntegrity
+from archivist.proof_mechanism import ProofMechanism
 
 # pylint: disable=fixme
 # pylint: disable=missing-docstring
@@ -46,51 +47,51 @@ def tearDownClass(cls):
         cls.attrs = None
         cls.traffic_light = None
 
-    def test_asset_create_tenant_storage(self):
+    def test_asset_create_simple_hash(self):
         """
-        Test asset creation on tenant storage
+        Test asset creation uses simple hash proof mechanism
         """
         asset = self.arch.assets.create(
             attrs=self.traffic_light,
             confirm=True,
         )
         self.assertEqual(
-            asset["storage_integrity"],
-            StorageIntegrity.TENANT_STORAGE.name,
-            msg="Incorrect asset storage integrity",
+            asset["proof_mechanism"],
+            ProofMechanism.SIMPLE_HASH.name,
+            msg="Incorrect asset proof mechanism",
         )
 
-    def test_asset_create_ledger(self):
+    def test_asset_create_khipu(self):
         """
-        Test asset creation on ledger
+        Test asset creation using khipu proof mechanism
         """
         asset = self.arch.assets.create(
             props={
-                "storage_integrity": StorageIntegrity.LEDGER.name,
+                "proof_mechanism": ProofMechanism.KHIPU.name,
             },
             attrs=self.traffic_light,
             confirm=True,
         )
         self.assertEqual(
-            asset["storage_integrity"],
-            StorageIntegrity.LEDGER.name,
-            msg="Incorrect asset storage integrity",
+            asset["proof_mechanism"],
+            ProofMechanism.KHIPU.name,
+            msg="Incorrect asset proof mechanism",
         )
 
     def test_asset_create_with_fixtures(self):
         """
         Test creation with fixtures
         """
-        # creates tenant_storage endpoint
-        tenant_storage = copy(self.arch)
-        tenant_storage.fixtures = {
+        # creates simple_hash endpoint
+        simple_hash = copy(self.arch)
+        simple_hash.fixtures = {
             "assets": {
-                "storage_integrity": StorageIntegrity.TENANT_STORAGE.name,
+                "proof_mechanism": ProofMechanism.SIMPLE_HASH.name,
             },
         }
 
-        # create traffic lights endpoint from tenant_storage
-        traffic_lights = copy(tenant_storage)
+        # create traffic lights endpoint from simple_hash
+        traffic_lights = copy(simple_hash)
         traffic_lights.fixtures = {
             "assets": {
                 "attributes": {
@@ -127,3 +128,42 @@ def test_asset_create_with_fixtures(self):
             1,
             msg="Incorrect number of fancy_traffic_lights",
         )
+
+    def test_asset_create_event(self):
+        """
+        Test list
+        """
+        # get identity of first asset
+        for asset in self.arch.assets.list():
+            print("asset", json.dumps(asset, sort_keys=True, indent=4))
+            identity = asset["identity"]
+            break
+
+        # different behaviours are also different.
+        props = {
+            "operation": "Record",
+            # This event is used to record evidence.
+            "behaviour": "RecordEvidence",
+            # Optional Client-claimed time at which the maintenance was performed
+            "timestamp_declared": "2019-11-27T14:44:19Z",
+            # Optional Client-claimed identity of person performing the operation
+            "principal_declared": {
+                "issuer": "idp.synsation.io/1234",
+                "subject": "phil.b",
+                "email": "phil.b@synsation.io",
+            },
+        }
+        attrs = {
+            # Required Details of the RecordEvidence request
+            "arc_description": "Safety conformance approved for version 1.6.",
+            # Required The evidence to be retained in the asset history
+            "arc_evidence": "DVA Conformance Report attached",
+            # Example Client can add any additional information in further attributes,
+            # including free text or attachments
+            "conformance_report": "blobs/e2a1d16c-03cd-45a1-8cd0-690831df1273",
+        }
+
+        event = self.arch.events.create(
+            identity, props=props, attrs=attrs, confirm=True
+        )
+        print("event", json.dumps(event, sort_keys=True, indent=4))
diff --git a/unittests/testassets.py b/unittests/testassets.py
@@ -16,7 +16,7 @@
     ROOT,
 )
 from archivist.errors import ArchivistNotFoundError, ArchivistUnconfirmedError
-from archivist.storage_integrity import StorageIntegrity
+from archivist.proof_mechanism import ProofMechanism
 
 from .mock_response import MockResponse
 
@@ -73,11 +73,11 @@
 SUBPATH = f"{ASSETS_SUBPATH}/{ASSETS_LABEL}"
 
 PROPS = {
-    "storage_integrity": StorageIntegrity.TENANT_STORAGE.name,
+    "proof_mechanism": ProofMechanism.SIMPLE_HASH.name,
 }
 REQUEST = {
     "behaviours": BEHAVIOURS,
-    "storage_integrity": StorageIntegrity.TENANT_STORAGE.name,
+    "proof_mechanism": ProofMechanism.SIMPLE_HASH.name,
     "attributes": ATTRS,
 }
 REQUEST_DATA = json.dumps(REQUEST)
diff --git a/unittests/testproof_mechanism.py b/unittests/testproof_mechanism.py
@@ -0,0 +1,30 @@
+"""
+Test proof mechanism
+"""
+
+# pylint: disable=attribute-defined-outside-init
+# pylint: disable=missing-docstring
+# pylint: disable=too-few-public-methods
+
+from unittest import TestCase
+
+from archivist.proof_mechanism import ProofMechanism
+
+
+class TestProofMechanism(TestCase):
+    """
+    Test proof mechanism for archivist
+    """
+
+    def test_proof_mechanism(self):
+        """
+        Test proof_mechanism
+        """
+        self.assertEqual(ProofMechanism.KHIPU.value, 1, msg="Incorrect value")
+        self.assertEqual(ProofMechanism.KHIPU.name, "KHIPU", msg="Incorrect value")
+        self.assertEqual(ProofMechanism.SIMPLE_HASH.value, 2, msg="Incorrect value")
+        self.assertEqual(
+            ProofMechanism.SIMPLE_HASH.name,
+            "SIMPLE_HASH",
+            msg="Incorrect value",
+        )
diff --git a/unittests/teststorage_integrity.py b/unittests/teststorage_integrity.py

-Original file line number
+Diff line change
 .eggs/
 .task/
 *.pyi
 -.vscode
 +.vscode