Implement new BDD connection opening syntax (#412)

flyingsilverfin · web-flow · commit df8bf6f004d4 · 2023-04-21T18:27:20.000+01:00
## What is the goal of this PR? We implement the new BDD connection/user connection syntax set up in typedb/typedb-behaviour#244. ## What are the changes implemented in this PR? Update the BDD step definitions to reflect new syntax from the behaviour repository.
diff --git a/dependencies/vaticle/artifacts.bzl b/dependencies/vaticle/artifacts.bzl
@@ -29,7 +29,7 @@ def vaticle_typedb_artifact():
         artifact_name = "typedb-server-{platform}-{version}.{ext}",
         tag_source = deployment["artifact.release"],
         commit_source = deployment["artifact.snapshot"],
-        commit = "c78d79b00894a65dd94f219339419b278a9663dd",
+        commit = "c36d4deeb6a7f9b53dced92002e57c1df9963f7a",
     )
 
 def vaticle_typedb_cluster_artifact():
@@ -39,5 +39,5 @@ def vaticle_typedb_cluster_artifact():
         artifact_name = "typedb-cluster-all-{platform}-{version}.{ext}",
         tag_source = deployment_private["artifact.release"],
         commit_source = deployment_private["artifact.snapshot"],
-        commit = "b00b9f016899b924fc8a083ff6183341a601f65e",
+        commit = "230757ad05e2b1a8cf78a3cb67d90d759de64a19",
     )
diff --git a/dependencies/vaticle/repositories.bzl b/dependencies/vaticle/repositories.bzl
@@ -53,7 +53,7 @@ def vaticle_typedb_behaviour():
     git_repository(
         name = "vaticle_typedb_behaviour",
         remote = "https://github.com/vaticle/typedb-behaviour",
-        commit = "c75c64d42725163e62078218207efbcb2b5ed845" # 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
     )
 
 def vaticle_factory_tracing():
diff --git a/test/behaviour/concept/type/thingtype/ThingTypeSteps.java b/test/behaviour/concept/type/thingtype/ThingTypeSteps.java
@@ -45,7 +45,7 @@
 
 public class ThingTypeSteps {
 
-    private static final String UNRECOGNISED_VALUE = "Unrecognized value";
+    private static final String ILLEGAL_ARGUMENT = "Illegal argument.";
 
     public static ThingType get_thing_type(RootLabel rootLabel, String typeLabel) {
         switch (rootLabel) {
@@ -55,8 +55,10 @@ public static ThingType get_thing_type(RootLabel rootLabel, String typeLabel) {
                 return tx().concepts().getAttributeType(typeLabel);
             case RELATION:
                 return tx().concepts().getRelationType(typeLabel);
+            case THING:
+                return tx().concepts().getRootThingType();
             default:
-                throw new IllegalArgumentException(UNRECOGNISED_VALUE);
+                throw new IllegalArgumentException(ILLEGAL_ARGUMENT);
         }
     }
 
@@ -94,7 +96,7 @@ public void put_thing_type(RootLabel rootLabel, String typeLabel) {
                 tx().concepts().putRelationType(typeLabel);
                 break;
             default:
-                throw new IllegalArgumentException(UNRECOGNISED_VALUE);
+                throw new IllegalArgumentException(ILLEGAL_ARGUMENT);
         }
     }
 
@@ -160,6 +162,8 @@ public void thing_type_set_supertype(RootLabel rootLabel, String typeLabel, Stri
                 RelationType relationSuperType = tx().concepts().getRelationType(superLabel);
                 tx().concepts().getRelationType(typeLabel).asRemote(tx()).setSupertype(relationSuperType);
                 break;
+            case THING:
+                throw new IllegalArgumentException(ILLEGAL_ARGUMENT);
         }
     }
 
@@ -178,6 +182,8 @@ public void thing_type_set_supertype_throws_exception(RootLabel rootLabel, Strin
                 RelationType relationSuperType = tx().concepts().getRelationType(superLabel);
                 assertThrows(() -> tx().concepts().getRelationType(typeLabel).asRemote(tx()).setSupertype(relationSuperType));
                 break;
+            case THING:
+                throw new IllegalArgumentException(ILLEGAL_ARGUMENT);
         }
     }
 
diff --git a/test/behaviour/config/Parameters.java b/test/behaviour/config/Parameters.java
@@ -56,7 +56,7 @@ public LocalDateTime datetime(String dateTime) {
         return LocalDateTime.parse(dateTime, formatter);
     }
 
-    @ParameterType("entity|attribute|relation")
+    @ParameterType("entity|attribute|relation|thing")
     public RootLabel root_label(String type) {
         return RootLabel.of(type);
     }
@@ -134,7 +134,8 @@ public List<TypeDBTransaction.Type> transaction_types(List<String> values) {
     public enum RootLabel {
         ENTITY("entity"),
         ATTRIBUTE("attribute"),
-        RELATION("relation");
+        RELATION("relation"),
+        THING("thing");
 
         private final String label;
 
diff --git a/test/behaviour/connection/ConnectionStepsBase.java b/test/behaviour/connection/ConnectionStepsBase.java
@@ -26,6 +26,7 @@
 import com.vaticle.typedb.client.api.TypeDBSession;
 import com.vaticle.typedb.client.api.TypeDBTransaction;
 import com.vaticle.typedb.common.test.TypeDBSingleton;
+import io.cucumber.java.en.When;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -113,7 +114,12 @@ void after() {
 
     abstract TypeDBOptions createOptions();
 
-    abstract void open_connection();
+    abstract void connection_opens_with_default_authentication();
+
+    void connection_closes() {
+        client.close();
+        client = null;
+    }
 
     void connection_has_been_opened() {
         assertNotNull(client);
diff --git a/test/behaviour/connection/ConnectionStepsCluster.java b/test/behaviour/connection/ConnectionStepsCluster.java
@@ -71,16 +71,38 @@ TypeDBOptions createOptions() {
     }
 
     @Override
-    @When("open connection")
-    public void open_connection() {
+    @When("connection opens with default authentication")
+    public void connection_opens_with_default_authentication() {
         client = createTypeDBClient(TypeDBSingleton.getTypeDBRunner().address());
     }
 
+    @When("connection opens with authentication: {word}, {word}")
+    public void connection_opens_with_authentication(String username, String password) {
+        if (client != null) {
+            client.close();
+            client = null;
+        }
+
+        client = createTypeDBClient(TypeDBSingleton.getTypeDBRunner().address(), username, password, false);
+    }
+
+    @When("connection opens with authentication: {word}, {word}; throws exception")
+    public void connection_opens_with_authentication_throws_exception(String username, String password) {
+        assertThrows(() -> createTypeDBClient(TypeDBSingleton.getTypeDBRunner().address(), username, password, false));
+    }
+
+    @Override
     @Given("connection has been opened")
     public void connection_has_been_opened() {
         super.connection_has_been_opened();
     }
 
+    @Override
+    @When("connection closes")
+    public void connection_closes() {
+        super.connection_closes();
+    }
+
     @Given("typedb has configuration")
     public void typedb_has_configuration(Map<String, String> map) {
         TypeDBSingleton.deleteTypeDBRunner();
@@ -109,27 +131,8 @@ public void typedb_stops() {
         TypeDBSingleton.getTypeDBRunner().stop();
     }
 
-    @When("user connect: {word}, {word}")
-    public void user_connect(String username, String password) {
-        if (client != null) {
-            client.close();
-            client = null;
-        }
-
-        client = createTypeDBClient(TypeDBSingleton.getTypeDBRunner().address(), username, password, false);
-    }
-
-    @When("user disconnect")
-    public void disconnect_current_user() {
-        client.close();
-        client = null;
-    }
-
-    @When("user connect: {word}, {word}; throws exception")
-    public void user_connect_throws_exception(String username, String password) {
-        assertThrows(() -> createTypeDBClient(TypeDBSingleton.getTypeDBRunner().address(), username, password, false));
-    }
 
+    @Override
     @Given("connection does not have any database")
     public void connection_does_not_have_any_database() {
         super.connection_does_not_have_any_database();
diff --git a/test/behaviour/connection/ConnectionStepsCore.java b/test/behaviour/connection/ConnectionStepsCore.java
@@ -60,12 +60,6 @@ TypeDBOptions createOptions() {
         return TypeDBOptions.core();
     }
 
-    @Override
-    @When("open connection")
-    public void open_connection() {
-        client = createTypeDBClient(TypeDBSingleton.getTypeDBRunner().address());
-    }
-
     @When("typedb starts")
     public void typedb_starts() {
         TypeDBRunner runner = TypeDBSingleton.getTypeDBRunner();
@@ -87,11 +81,25 @@ public void typedb_stops() {
         TypeDBSingleton.getTypeDBRunner().stop();
     }
 
+    @Override
+    @When("connection opens with default authentication")
+    public void connection_opens_with_default_authentication() {
+        client = createTypeDBClient(TypeDBSingleton.getTypeDBRunner().address());
+    }
+
+    @Override
+    @When("connection closes")
+    public void connection_closes() {
+        super.connection_closes();
+    }
+
+    @Override
     @Given("connection has been opened")
     public void connection_has_been_opened() {
         super.connection_has_been_opened();
     }
 
+    @Override
     @Given("connection does not have any database")
     public void connection_does_not_have_any_database() {
         super.connection_does_not_have_any_database();

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ def vaticle_typedb_artifact():`
`29`	`29`	`artifact_name = "typedb-server-{platform}-{version}.{ext}",`
`30`	`30`	`tag_source = deployment["artifact.release"],`
`31`	`31`	`commit_source = deployment["artifact.snapshot"],`
`32`		`- commit = "c78d79b00894a65dd94f219339419b278a9663dd",`
	`32`	`+ commit = "c36d4deeb6a7f9b53dced92002e57c1df9963f7a",`
`33`	`33`	`)`
`34`	`34`
`35`	`35`	`def vaticle_typedb_cluster_artifact():`
`@@ -39,5 +39,5 @@ def vaticle_typedb_cluster_artifact():`
`39`	`39`	`artifact_name = "typedb-cluster-all-{platform}-{version}.{ext}",`
`40`	`40`	`tag_source = deployment_private["artifact.release"],`
`41`	`41`	`commit_source = deployment_private["artifact.snapshot"],`
`42`		`- commit = "b00b9f016899b924fc8a083ff6183341a601f65e",`
	`42`	`+ commit = "230757ad05e2b1a8cf78a3cb67d90d759de64a19",`
`43`	`43`	`)`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ def vaticle_typedb_behaviour():`
`53`	`53`	`git_repository(`
`54`	`54`	`name = "vaticle_typedb_behaviour",`
`55`	`55`	`remote = "https://github.com/vaticle/typedb-behaviour",`
`56`		`- commit = "c75c64d42725163e62078218207efbcb2b5ed845" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_behaviour`
	`56`	`+ commit = "b4cbdd3aaf28428608fc88eae0852425df57fe25" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_behaviour`
`57`	`57`	`)`
`58`	`58`
`59`	`59`	`def vaticle_factory_tracing():`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@`
`45`	`45`
`46`	`46`	`public class ThingTypeSteps {`
`47`	`47`
`48`		`- private static final String UNRECOGNISED_VALUE = "Unrecognized value";`
	`48`	`+ private static final String ILLEGAL_ARGUMENT = "Illegal argument.";`
`49`	`49`
`50`	`50`	`public static ThingType get_thing_type(RootLabel rootLabel, String typeLabel) {`
`51`	`51`	`switch (rootLabel) {`
`@@ -55,8 +55,10 @@ public static ThingType get_thing_type(RootLabel rootLabel, String typeLabel) {`
`55`	`55`	`return tx().concepts().getAttributeType(typeLabel);`
`56`	`56`	`case RELATION:`
`57`	`57`	`return tx().concepts().getRelationType(typeLabel);`
	`58`	`+ case THING:`
	`59`	`+ return tx().concepts().getRootThingType();`
`58`	`60`	`default:`
`59`		`- throw new IllegalArgumentException(UNRECOGNISED_VALUE);`
	`61`	`+ throw new IllegalArgumentException(ILLEGAL_ARGUMENT);`
`60`	`62`	`}`
`61`	`63`	`}`
`62`	`64`
`@@ -94,7 +96,7 @@ public void put_thing_type(RootLabel rootLabel, String typeLabel) {`
`94`	`96`	`tx().concepts().putRelationType(typeLabel);`
`95`	`97`	`break;`
`96`	`98`	`default:`
`97`		`- throw new IllegalArgumentException(UNRECOGNISED_VALUE);`
	`99`	`+ throw new IllegalArgumentException(ILLEGAL_ARGUMENT);`
`98`	`100`	`}`
`99`	`101`	`}`
`100`	`102`
`@@ -160,6 +162,8 @@ public void thing_type_set_supertype(RootLabel rootLabel, String typeLabel, Stri`
`160`	`162`	`RelationType relationSuperType = tx().concepts().getRelationType(superLabel);`
`161`	`163`	`tx().concepts().getRelationType(typeLabel).asRemote(tx()).setSupertype(relationSuperType);`
`162`	`164`	`break;`
	`165`	`+ case THING:`
	`166`	`+ throw new IllegalArgumentException(ILLEGAL_ARGUMENT);`
`163`	`167`	`}`
`164`	`168`	`}`
`165`	`169`
`@@ -178,6 +182,8 @@ public void thing_type_set_supertype_throws_exception(RootLabel rootLabel, Strin`
`178`	`182`	`RelationType relationSuperType = tx().concepts().getRelationType(superLabel);`
`179`	`183`	`assertThrows(() -> tx().concepts().getRelationType(typeLabel).asRemote(tx()).setSupertype(relationSuperType));`
`180`	`184`	`break;`
	`185`	`+ case THING:`
	`186`	`+ throw new IllegalArgumentException(ILLEGAL_ARGUMENT);`
`181`	`187`	`}`
`182`	`188`	`}`
`183`	`189`