Graphql tooling

Pipfile

@@ -11,6 +11,7 @@ pytest = ">=2.7.2"
 PyYAML = ">=5.1"
 rdflib = ">=6.0.0"
 vss-tools = {editable = true, path = "."}
+graphql-core = "*"
 
 [dev-packages]
 

README.md

@@ -29,7 +29,7 @@ Examples on tool usage can be found in the [VSS Makefile](https://github.com/COV
 [vspec2ocf.py](contrib/ocf/vspec2ocf.py) | Parses and expands a VSS and generates a OCF specification | Contrib (Obsolete, no longer functional)  | - |
 [vspec2proto.py](contrib/vspec2protobuf.py) | Parses and expands a VSS and generates a Protobuf specification | Contrib (Beta)  | - |
 [vspec2ttl.py](contrib/vspec2ttl/vspec2ttl.py) | Parses and expands a VSS and generates a TTL specification | Contrib  | - |
-[vspec2graphql.py](contrib/vspec2graphql.py) | Parses and expands a VSS and generates a GraphQL specification | Contrib  | - |
+[vspec2graphql.py](contrib/vspec2graphql.py) | Parses and expands a VSS and generates a GraphQL specification | Community Supported  | [Documentation](docs/VSS2GRAPHQL.md) |
 
 ## Tool Architecture
 

docs/VSS2GRAPHQL.md

@@ -0,0 +1,72 @@
+## vspec2graphql
+
+This exporter allows to automatically generate a graphql schema that can represent VSS data.
+The resulting schema does only allow querying information. Mutations are not supported.
+
+The resulting schema will look something like this:
+```
+type Query {
+  vehicle(
+    """VIN of the vehicle that you want to request data for."""
+    id: String!
+
+    """
+    Filter data to only provide information that was sent from the vehicle after that timestamp.
+    """
+    after: String
+  ): Vehicle
+}
+
+"""Highlevel vehicle data."""
+type Vehicle {
+  """Attributes that identify a vehicle"""
+  vehicleIdentification: Vehicle_VehicleIdentification
+  ...
+}
+
+type Vehicle_VehicleIdentification {
+  ...
+}
+...
+```
+
+Leaves look like this:
+```
+"""Vehicle brand or manufacturer"""
+type Vehicle_VehicleIdentification_Brand {
+  """Value: Vehicle brand or manufacturer"""
+  value: String
+
+  """Timestamp: Vehicle brand or manufacturer"""
+  timestamp: String
+}
+```
+
+Every leaf has a timestamp. This is supposed to contain the date of the last modification of the value. 
+Queries can then filter data that has been recorded after a given timestamp.
+
+### Additional leaf parameters
+
+As for `timestamp` in some scenarios it makes sense to add certain metadata like the `source` of a
+served signal or additional privacy information. Therefore the tool has an additional calling parameter
+`--gqlfield <name> <description>`, which takes the name and description of the additional field, like:
+
+```
+--gqlfield "source" "Source System"
+```
+
+Resulting in the following leaf in the schema:
+
+```
+"""Vehicle brand or manufacturer"""
+type Vehicle_VehicleIdentification_Brand {
+  """Value: Vehicle brand or manufacturer."""
+  value: String
+
+  """Timestamp: Vehicle brand or manufacturer."""
+  timestamp: String
+
+  """ Source System: Vehicle brand or manufacturer."""
+  source: String
+}
+```

vspec2graphql.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python3
+#
+#
+# (c) 2022 BMW Group
+#
+# All files and artifacts in this repository are licensed under the
+# provisions of the license provided by the LICENSE file in this repository.
+#
+#
+# Convert vspec2grahql wrapper for vspec2x
+#
+
+import sys
+import vspec2x
+
+if __name__ == "__main__":
+    vspec2x.main(["--format", "graphql"]+sys.argv[1:])

vspec2x.py

@@ -16,7 +16,7 @@
 import sys
 import vspec
 
-from vssexporters import vss2json, vss2csv, vss2yaml, vss2binary, vss2franca, vss2ddsidl
+from vssexporters import vss2json, vss2csv, vss2yaml, vss2binary, vss2franca, vss2ddsidl, vss2graphql
 
 
 
@@ -34,6 +34,7 @@ def export(config: argparse.Namespace, root: VSSNode):
     binary = vss2binary
     franca = vss2franca
     idl = vss2ddsidl
+    graphql = vss2graphql
 
     def __str__(self):
         return self.name