JSON serialization fixes (#287)

## What is the goal of this PR?

We update serialization API from `json()` to more canonical `to_json()`
and update the BDD test steps to reflect the changes in typedb-behaviour
(typedb/typedb-behaviour#240).

Author: dmitrii-ubskii

dependencies/vaticle/repositories.bzl

@@ -39,5 +39,5 @@ def vaticle_typedb_behaviour():
     git_repository(
         name = "vaticle_typedb_behaviour",
         remote = "https://github.com/vaticle/typedb-behaviour",
-        commit = "46619244d5f1773505eeacf6d5bd0ae71781f8e8" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_behaviour
+        commit = "ff4f58b4db2200b907c60b28a2b8ee661449e9c0" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_behaviour
     )

tests/behaviour/concept/serialization/BUILD

@@ -20,40 +20,8 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
-py_library(
-    name = "steps",
-    srcs = ["serialization_steps.py"],
-    deps = [],
-)
-
-typedb_behaviour_py_test(
-    name = "test",
-    feats = ["@vaticle_typedb_behaviour//concept:serialization.feature"],
-    background_core = ["//tests/behaviour/background:core"],
-    background_cluster = ["//tests/behaviour/background:cluster"],
-    steps = [
-        ":steps",
-        "//tests/behaviour/typeql:steps",
-        "//tests/behaviour/connection:steps",
-        "//tests/behaviour/connection/database:steps",
-        "//tests/behaviour/connection/session:steps",
-        "//tests/behaviour/connection/transaction:steps",
-    ],
-    deps = [
-        "//:client_python",
-        "//tests/behaviour:context",
-        "//tests/behaviour/util:util",
-        "//tests/behaviour/config:parameters",
-        "//tests/behaviour/background",
-    ],
-    native_typedb_artifact = "//tests:native-typedb-artifact",
-    native_typedb_cluster_artifact = "//tests:native-typedb-cluster-artifact",
-    size = "medium",
-)
-
 checkstyle_test(
     name = "checkstyle",
     include = glob(["*"]),

tests/behaviour/concept/serialization/json/BUILD

@@ -0,0 +1,62 @@
+#
+# Copyright (C) 2022 Vaticle
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+#
+
+package(default_visibility = ["//tests/behaviour:__subpackages__"])
+load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
+
+py_library(
+    name = "steps",
+    srcs = ["json_steps.py"],
+    deps = [],
+)
+
+typedb_behaviour_py_test(
+    name = "test",
+    feats = ["@vaticle_typedb_behaviour//concept/serialization:json.feature"],
+    background_core = ["//tests/behaviour/background:core"],
+    background_cluster = ["//tests/behaviour/background:cluster"],
+    steps = [
+        ":steps",
+        "//tests/behaviour/typeql:steps",
+        "//tests/behaviour/connection:steps",
+        "//tests/behaviour/connection/database:steps",
+        "//tests/behaviour/connection/session:steps",
+        "//tests/behaviour/connection/transaction:steps",
+    ],
+    deps = [
+        "//:client_python",
+        "//tests/behaviour:context",
+        "//tests/behaviour/util:util",
+        "//tests/behaviour/config:parameters",
+        "//tests/behaviour/background",
+    ],
+    native_typedb_artifact = "//tests:native-typedb-artifact",
+    native_typedb_cluster_artifact = "//tests:native-typedb-cluster-artifact",
+    size = "medium",
+)
+
+checkstyle_test(
+    name = "checkstyle",
+    include = glob(["*"]),
+    license_type = "apache-header",
+    size = "small",
+)

tests/behaviour/concept/serialization/serialization_steps.py renamed to tests/behaviour/concept/serialization/json/json_steps.py

@@ -48,8 +48,8 @@ def unordered_equal_to(expected: List[T]) -> UnorderedEqualTo[T]:
     return UnorderedEqualTo(expected)
 
 
-@step("JSON of answer concepts matches")
+@step("JSON serialization of answers matches")
 def step_impl(context: Context):
     expected = json.loads(context.text)
-    actual = [answer.json() for answer in context.answers]
+    actual = [answer.to_json() for answer in context.answers]
     assert_that(actual, unordered_equal_to(expected))

typedb/api/answer/concept_map.py

@@ -42,9 +42,9 @@ def get(self, variable: str) -> Concept:
     def explainables(self) -> "ConceptMap.Explainables":
         pass
 
-    def json(self) -> Mapping[str, Mapping[str, Union[str, int, float, bool]]]:
+    def to_json(self) -> Mapping[str, Mapping[str, Union[str, int, float, bool]]]:
         return {
-            var: concept.json()
+            var: concept.to_json()
             for var, concept in self._map.items()
         }
 

typedb/api/concept/concept.py

@@ -108,7 +108,7 @@ def is_remote(self) -> bool:
         pass
 
     @abstractmethod
-    def json(self) -> Mapping[str, Union[str, int, float, bool]]:
+    def to_json(self) -> Mapping[str, Union[str, int, float, bool]]:
         pass
 
 

typedb/api/concept/thing/attribute.py

@@ -62,7 +62,7 @@ def is_datetime(self):
     def as_remote(self, transaction: "TypeDBTransaction") -> "RemoteAttribute":
         pass
 
-    def json(self) -> Mapping[str, Union[str, int, float, bool]]:
+    def to_json(self) -> Mapping[str, Union[str, int, float, bool]]:
         return {
             "type": self.get_type().get_label().name(),
             "value_type": str(self.get_type().get_value_type()),
@@ -182,7 +182,7 @@ def get_value(self) -> datetime:
     def as_remote(self, transaction: "TypeDBTransaction") -> "RemoteDateTimeAttribute":
         pass
 
-    def json(self) -> Mapping[str, Union[str, int, float, bool]]:
+    def to_json(self) -> Mapping[str, Union[str, int, float, bool]]:
         return {
             "type": self.get_type().get_label().name(),
             "value_type": str(self.get_type().get_value_type()),

typedb/api/concept/thing/thing.py

@@ -52,7 +52,7 @@ def is_thing(self) -> bool:
     def as_remote(self, transaction: "TypeDBTransaction") -> "RemoteThing":
         pass
 
-    def json(self) -> Mapping[str, str]:
+    def to_json(self) -> Mapping[str, str]:
         return {"type": self.get_type().get_label().name()}
 
 

typedb/api/concept/type/type.py

@@ -49,7 +49,7 @@ def is_type(self) -> bool:
     def as_remote(self, transaction: "TypeDBTransaction") -> "RemoteType":
         pass
 
-    def json(self) -> Mapping[str, str]:
+    def to_json(self) -> Mapping[str, str]:
         return {"label": self.get_label().scoped_name()}