Define user password expiry in terms of seconds (#288)

## What is the goal of this PR?

We've redefined the way we expose how long until a password expires in seconds, rather than days as was done previously.

## What are the changes implemented in this PR?

* We've changed `password_expiry_days` to `password_expiry_seconds`.
* We implement the newly updated BDD steps to do with opening and closing connections, and prepare other steps for booting and configuring TypeDB for use once the TypeDB runner is available in Python

Author: James Williams

.factory/automation.yml

@@ -63,17 +63,20 @@ build:
         export ARTIFACT_USERNAME=$REPO_VATICLE_USERNAME
         export ARTIFACT_PASSWORD=$REPO_VATICLE_PASSWORD
         bazel run @vaticle_dependencies//distribution/artifact:create-netrc
-        .factory/test-core.sh //tests/behaviour/connection/... --test_output=errors --jobs=1
-#    test-behaviour-connection-cluster:
-#      image: vaticle-ubuntu-21.04
-#      type: foreground
-#      command: |
-#        python3 -m pip install -U pip
-#        python3 -m pip install -r requirements_dev.txt
-#        export ARTIFACT_USERNAME=$REPO_VATICLE_USERNAME
-#        export ARTIFACT_PASSWORD=$REPO_VATICLE_PASSWORD
-#        bazel run @vaticle_dependencies//distribution/artifact:create-netrc
-#        .factory/test-cluster.sh //tests/behaviour/connection/... --test_output=errors --jobs=1
+        .factory/test-core.sh $(bazel query //tests/behaviour/connection/... except //tests/behaviour/connection/user/...) --test_output=errors --jobs=1
+    test-behaviour-connection-cluster:
+      image: vaticle-ubuntu-22.04
+      type: foreground
+      command: |
+        export PATH="$HOME/.local/bin:$PATH"
+        sudo apt-get update
+        sudo apt install python3-pip -y
+        python3 -m pip install -U pip
+        python3 -m pip install -r requirements_dev.txt
+        export ARTIFACT_USERNAME=$REPO_VATICLE_USERNAME
+        export ARTIFACT_PASSWORD=$REPO_VATICLE_PASSWORD
+        bazel run @vaticle_dependencies//distribution/artifact:create-netrc
+        .factory/test-cluster.sh //tests/behaviour/connection/... --test_output=errors --jobs=1
     test-behaviour-concept-core:
       image: vaticle-ubuntu-22.04
       type: foreground
@@ -113,22 +116,20 @@ build:
         bazel run @vaticle_dependencies//distribution/artifact:create-netrc
         .factory/test-core.sh //tests/behaviour/typeql/language/match/... --test_output=errors
         .factory/test-core.sh //tests/behaviour/typeql/language/get/... --test_output=errors
-#    test-behaviour-match-cluster:
-#      image: vaticle-ubuntu-21.04
-#      type: foreground
-#      command: |
-#        pyenv install 3.7.12
-#        pyenv global 3.7.12
-#        python3 -m pip install -U pip
-#        python3 -m pip install -r requirements_dev.txt
-#        sudo unlink /usr/bin/python3
-#        sudo ln -s $(which python3) /usr/bin/python3
-#        sudo ln -s /usr/share/pyshared/lsb_release.py /opt/pyenv/versions/3.7.12/lib/python3.7/site-packages/lsb_release.py
-#        export ARTIFACT_USERNAME=$REPO_VATICLE_USERNAME
-#        export ARTIFACT_PASSWORD=$REPO_VATICLE_PASSWORD
-#        bazel run @vaticle_dependencies//distribution/artifact:create-netrc
-#        .factory/test-cluster.sh //tests/behaviour/typeql/language/match/... --test_output=errors
-#        .factory/test-cluster.sh //tests/behaviour/typeql/language/get/... --test_output=errors
+    test-behaviour-match-cluster:
+      image: vaticle-ubuntu-22.04
+      type: foreground
+      command: |
+        export PATH="$HOME/.local/bin:$PATH"
+        sudo apt-get update
+        sudo apt install python3-pip -y
+        python3 -m pip install -U pip
+        python3 -m pip install -r requirements_dev.txt
+        export ARTIFACT_USERNAME=$REPO_VATICLE_USERNAME
+        export ARTIFACT_PASSWORD=$REPO_VATICLE_PASSWORD
+        bazel run @vaticle_dependencies//distribution/artifact:create-netrc
+        .factory/test-cluster.sh //tests/behaviour/typeql/language/match/... --test_output=errors
+        .factory/test-cluster.sh //tests/behaviour/typeql/language/get/... --test_output=errors
     test-behaviour-writable-core:
       image: vaticle-ubuntu-22.04
       type: foreground
@@ -206,10 +207,10 @@ build:
       dependencies: [
         build,
         test-behaviour-connection-core,
-        # test-behaviour-connection-cluster,
+         test-behaviour-connection-cluster,
         test-behaviour-concept-core, test-behaviour-concept-cluster,
         test-behaviour-match-core,
-#        test-behaviour-match-cluster,
+        test-behaviour-match-cluster,
         test-behaviour-writable-core, test-behaviour-writable-cluster,
         test-behaviour-definable-core, test-behaviour-definable-cluster,
         test-failover-cluster

dependencies/vaticle/artifacts.bzl

@@ -29,7 +29,7 @@ def vaticle_typedb_artifacts():
         artifact_name = "typedb-server-{platform}-{version}.{ext}",
         tag_source = deployment["artifact.release"],
         commit_source = deployment["artifact.snapshot"],
-        tag = "2.16.1",
+        commit = "c36d4deeb6a7f9b53dced92002e57c1df9963f7a",
     )
 
 def vaticle_typedb_cluster_artifacts():
@@ -39,5 +39,5 @@ def vaticle_typedb_cluster_artifacts():
         artifact_name = "typedb-cluster-all-{platform}-{version}.{ext}",
         tag_source = deployment_private["artifact.release"],
         commit_source = deployment_private["artifact.snapshot"],
-        tag = "2.16.1",
+        commit = "230757ad05e2b1a8cf78a3cb67d90d759de64a19",
     )

dependencies/vaticle/repositories.bzl

@@ -25,19 +25,19 @@ def vaticle_dependencies():
     git_repository(
         name = "vaticle_dependencies",
         remote = "https://github.com/vaticle/dependencies",
-        commit = "0daf20ca5efc141fc8e3f9a767a9118b6eee0980", # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies
+        commit = "e0446ffa70cacca89cb1faa2cd6f299c3784d845", # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies
     )
 
 def vaticle_typedb_common():
     git_repository(
         name = "vaticle_typedb_common",
         remote = "https://github.com/vaticle/typedb-common",
-        tag = "2.16.0" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_common
+        tag = "2.17.0" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_common
     )
 
 def vaticle_typedb_behaviour():
     git_repository(
         name = "vaticle_typedb_behaviour",
         remote = "https://github.com/vaticle/typedb-behaviour",
-        commit = "ff4f58b4db2200b907c60b28a2b8ee661449e9c0" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_behaviour
+        commit = "b4cbdd3aaf28428608fc88eae0852425df57fe25" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_behaviour
     )

requirements.txt

@@ -35,6 +35,6 @@
 
 ## Dependencies
 
-typedb-protocol==2.16.1
+typedb-protocol==2.17.0
 grpcio>=1.43.0,<2
 protobuf>=3.15.5,<4

tests/behaviour/background/cluster/environment.py

@@ -25,31 +25,43 @@
 from tests.behaviour.background import environment_base
 from tests.behaviour.context import Context
 
-IGNORE_TAGS = ["ignore", "ignore-client-python", "ignore-typedb-cluster-client-python"]
+IGNORE_TAGS = ["ignore", "ignore-client-python", "ignore-typedb-client-python", "ignore-typedb-cluster-client-python"]
 
 
 def before_all(context: Context):
     environment_base.before_all(context)
-
-    root_ca_path = os.environ["ROOT_CA"]
-    credential = TypeDBCredential("admin", "password", root_ca_path)
-    context.client = TypeDB.cluster_client(addresses=["127.0.0.1:" + context.config.userdata["port"]], credential=credential)
+    context.credential_root_ca_path = os.environ["ROOT_CA"]
+    context.setup_context_client_fn = lambda user="admin", password="password": setup_context_client(context, user, password)
 
 
 def before_scenario(context: Context, scenario):
     for tag in IGNORE_TAGS:
         if tag in scenario.effective_tags:
             scenario.skip("tagged with @" + tag)
             return
-    environment_base.before_scenario(context, scenario)
+    environment_base.before_scenario(context)
+
+
+def setup_context_client(context, username, password):
+    credential = TypeDBCredential(username, password, context.credential_root_ca_path)
+    context.client = TypeDB.cluster_client(addresses=["127.0.0.1:" + context.config.userdata["port"]], credential=credential)
     context.session_options = TypeDBOptions.cluster().set_infer(True)
     context.transaction_options = TypeDBOptions.cluster().set_infer(True)
 
 
-
 def after_scenario(context: Context, scenario):
     environment_base.after_scenario(context, scenario)
 
+    # TODO: reset the database through the TypeDB runner once it exists
+    context.setup_context_client_fn()
+    for database in context.client.databases().all():
+        database.delete()
+
+    for user in context.client.users().all():
+        if user.username() != "admin":
+            context.client.users().delete(user.username())
+    context.client.close()
+
 
 def after_all(context: Context):
     environment_base.after_all(context)

tests/behaviour/background/core/environment.py

@@ -29,21 +29,33 @@
 
 def before_all(context: Context):
     environment_base.before_all(context)
-    context.client = TypeDB.core_client(address="localhost:%d" % int(context.config.userdata["port"]))
+    context.setup_context_client_fn = lambda user=None, password=None: setup_context_client(context, user, password)
 
 
 def before_scenario(context: Context, scenario):
     for tag in IGNORE_TAGS:
         if tag in scenario.effective_tags:
             scenario.skip("tagged with @" + tag)
             return
-    environment_base.before_scenario(context, scenario)
+    environment_base.before_scenario(context)
+
+
+def setup_context_client(context, username=None, password=None):
+    if username is not None or password is not None:
+        raise Exception("Core client does not support authentication")
+    context.client = TypeDB.core_client(address="localhost:%d" % int(context.config.userdata["port"]))
     context.session_options = TypeDBOptions.core().set_infer(True)
     context.transaction_options = TypeDBOptions.core().set_infer(True)
 
+
 def after_scenario(context: Context, scenario):
     environment_base.after_scenario(context, scenario)
 
+    # TODO: reset the database through the TypeDB runner once it exists
+    context.setup_context_client_fn()
+    for database in context.client.databases().all():
+        database.delete()
+    context.client.close()
 
 def after_all(context: Context):
     environment_base.after_all(context)

tests/behaviour/background/environment_base.py

@@ -29,16 +29,16 @@ def before_all(context: Context):
     context.THREAD_POOL_SIZE = 32
 
 
-def before_scenario(context: Context, scenario):
-    for database in context.client.databases().all():
-        database.delete()
+def before_scenario(context: Context):
+    # setup context state
     context.sessions = []
     context.sessions_to_transactions = {}
     context.sessions_parallel = []
     context.sessions_to_transactions_parallel = {}
     context.sessions_parallel_to_transactions_parallel = {}
-    context.tx = lambda: context.sessions_to_transactions[context.sessions[0]][0]
     context.things = {}
+    # setup context functions
+    context.tx = lambda: context.sessions_to_transactions[context.sessions[0]][0]
     context.get = lambda var: context.things[var]
     context.put = lambda var, thing: _put_impl(context, var, thing)
     context.get_thing_type = lambda root_label, type_label: _get_thing_type_impl(context, root_label, type_label)
@@ -60,6 +60,8 @@ def _get_thing_type_impl(context: Context, root_label: RootLabel, type_label: st
         return context.tx().concepts().get_attribute_type(type_label)
     elif root_label == RootLabel.RELATION:
         return context.tx().concepts().get_relation_type(type_label)
+    elif root_label == RootLabel.THING:
+        return context.tx().concepts().get_root_thing_type()
     else:
         raise ValueError("Unrecognised value")
 
@@ -74,14 +76,9 @@ def _clear_answers_impl(context: Context):
 def after_scenario(context: Context, scenario):
     if scenario.status == Status.skipped:
         return
-
-    for session in context.sessions:
-        session.close()
-    for future_session in context.sessions_parallel:
-        future_session.result().close()
-    for database in context.client.databases().all():
-        database.delete()
+    if context.client.is_open():
+        context.client.close()
 
 
 def after_all(context: Context):
-    context.client.close()
+    pass

tests/behaviour/config/parameters.py

@@ -18,10 +18,11 @@
 # specific language governing permissions and limitations
 # under the License.
 #
+from enum import Enum
+
 import parse
 from behave import register_type
 from behave.model import Table
-from enum import Enum
 # TODO: We aren't consistently using typed parameters in step implementations - we should be.
 from typedb.client import *
 
@@ -48,6 +49,14 @@ def parse_float(text: str) -> float:
 register_type(Float=parse_float)
 
 
+@parse.with_pattern("[\w_-]+")
+def parseWords(text):
+    return text
+
+
+register_type(Words=parseWords)
+
+
 @parse.with_pattern(r"\d\d\d\d-\d\d-\d\d(?: \d\d:\d\d:\d\d)?")
 def parse_datetime(text: str) -> datetime:
     try:
@@ -62,17 +71,20 @@ def parse_datetime(text: str) -> datetime:
 class RootLabel(Enum):
     ENTITY = 0,
     ATTRIBUTE = 1,
-    RELATION = 2
+    RELATION = 2,
+    THING = 3
 
 
-@parse.with_pattern(r"entity|attribute|relation")
+@parse.with_pattern(r"entity|attribute|relation|thing")
 def parse_root_label(text: str) -> RootLabel:
     if text == "entity":
         return RootLabel.ENTITY
     elif text == "attribute":
         return RootLabel.ATTRIBUTE
     elif text == "relation":
         return RootLabel.RELATION
+    elif text == "thing":
+        return RootLabel.THING
     else:
         raise ValueError("Unrecognised root label: " + text)
 

tests/behaviour/connection/connection_steps.py

@@ -20,10 +20,55 @@
 #
 
 from behave import *
+from typedb.common.exception import TypeDBClientException
 
 from tests.behaviour.context import Context
 
 
+@step(u'typedb has configuration')
+def step_impl(context):
+    # TODO: implement configuring the TypeDB runner when a python typedb-runner is available
+    pass
+
+
+@step(u'typedb starts')
+def step_impl(context):
+    # TODO: start TypeDB via a python typedb-runner once one is available
+    pass
+
+
+@step(u'connection opens with default authentication')
+def step_impl(context):
+    context.setup_context_client_fn()
+    for database in context.client.databases().all():
+        database.delete()
+
+
+@step(u'connection opens with authentication: {username:Words}, {password:Words}')
+def step_impl(context, username: str, password: str):
+    context.setup_context_client_fn(username, password)
+
+
+@step(u'connection opens with authentication: {username:Words}, {password:Words}; throws exception')
+def step_impl(context, username: str, password: str):
+    try:
+        context.setup_context_client_fn(username, password)
+        assert False
+    except TypeDBClientException:
+        pass
+
+
+@step(u'connection closes')
+def step_impl(context):
+    context.client.close()
+
+
+@step(u'typedb stops')
+def step_impl(context):
+    # TODO: stop TypeDB via a python typedb-runner once one is available
+    pass
+
+
 @step("connection has been opened")
 def step_impl(context: Context):
     assert context.client and context.client.is_open()
@@ -32,4 +77,3 @@ def step_impl(context: Context):
 @step("connection does not have any database")
 def step_impl(context: Context):
     assert len(context.client.databases().all()) == 0
-