Add JSON encoders, string and JSON representation for output descriptors

Use JSON representation to output descriptor related models as JSON
string.

This will increase the readability of the command-line results.

Note: Don't print extra parameters that are not defined in the TSP.

Signed-off-by: Bernd Hufmann <[email protected]>

Author: bhufmann

tsp/output_descriptor.py

@@ -23,6 +23,7 @@
 """OutputDescriptor class file."""
 
 import json
+from tsp.configuration import Configuration, ConfigurationEncoder
 
 NA = "N/A"
 UNKOWN = "UNKNOWN"
@@ -117,20 +118,24 @@ def __init__(self, params):
             self.compatible_providers = []
 
     def __repr__(self):
-        return 'OutputDescriptor(id={}, name={}, description={})'.format(self.id, self.name, self.description)
+        return 'OutputDescriptor(id={}, name={}, description={}, type={})'.format(self.id, self.name, self.description, obj.type)
+
+    def to_json(self):
+        return json.dumps(self, cls=OutputDescriptorEncoder, indent=4)
 
 class OutputDescriptorEncoder(json.JSONEncoder):
     def default(self, obj):
         if isinstance(obj, OutputDescriptor):
             return {
-                'id': obj.id,
-                'name': obj.name,
-                'description': obj.description,
-                'type': obj.type,
-                'query_parameters': obj.query_parameters,
-                'start': obj.start,
-                'end': obj.end,
-                'final': obj.final,
-                'compatible_providers': obj.compatible_providers
+                ID_KEY: obj.id,
+                NAME_KEY: obj.name,
+                DESCRIPTION_KEY: obj.description,
+                TYPE_KEY: obj.type,
+                # Hide non-TSP fields
+                # QUERY_PARAMETERS_KEY: obj.query_parameters,
+                # START_TIME_KEY: obj.start,
+                # END_TIME_KEY: obj.end,
+                # IS_FINAL_KEY: obj.final,
+                # COMPATIBLE_PROVIDERS_KEY: obj.compatible_providers
             }
         return super().default(obj)

tsp/output_descriptor_set.py

@@ -22,7 +22,8 @@
 
 """OutputDescriptorSet class file."""
 
-from tsp.output_descriptor import OutputDescriptor
+import json
+from tsp.output_descriptor import OutputDescriptor, OutputDescriptorEncoder
 
 
 # pylint: disable=too-few-public-methods
@@ -40,4 +41,16 @@ def __init__(self, params):
             self.descriptors.append(OutputDescriptor(obj))
 
     def __repr__(self):
-        return ', '.join([str(descriptor) for descriptor in self.descriptors])
+        return 'OutputDescriptorSet({})'.format(', '.join(str(descriptor) for descriptor in self.descriptors))
+
+    def to_json(self):
+        return json.dumps(self, cls=OutputDescriptorSetEncoder, indent=4)
+
+
+class OutputDescriptorSetEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, OutputDescriptorSet):
+            return [
+                OutputDescriptorEncoder().default(descriptor) for descriptor in obj.descriptors
+            ]
+        return super().default(obj)

tsp_cli_client

@@ -41,30 +41,6 @@ from tsp.tsp_client import TspClient
 
 TRACE_MISSING = "Trace UUID is missing"
 
-# pylint: disable=consider-using-f-string
-
-
-def __print_uuid(elem):
-    return colored(elem.UUID, 'yellow')
-
-def __print_output(output):
-    print('  {0}: {1} {2} ({3})'.format(output.name,
-          output.description, output.type, output.id))
-
-
-# pylint: disable=fixme,line-too-long,undefined-loop-variable
-def __print_outputs(descriptors):
-    if not descriptors:
-        print('No output descriptors for trace {0} ({1}))'.format(
-            t.name, __print_uuid(t)))
-    for descriptor in output_descriptors.descriptors:
-        __print_output(descriptor)
-        # TODO remove when available
-        # if o.id == "org.eclipse.tracecompass.internal.analysis.profiling.callstack.provider.CallStackDataProvider"):
-        #    print('  {0}: {1} ({2})'.format("Function Duration Statistics", "Function Duration Statistics",
-        #          "org.eclipse.tracecompass.internal.analysis.profiling.core.callgraph.callgraphanalysis.statistics"))
-
-
 def __get_descriptor(uuid, output_id):
     resp = tsp_client.fetch_experiment_output(uuid, output_id)
     if resp.status_code == 200:
@@ -352,7 +328,12 @@ if __name__ == "__main__":
                 options.list_outputs)
             if response.status_code == 200:
                 output_descriptors = response.model
-                __print_outputs(output_descriptors.descriptors)
+                if not output_descriptors:
+                    print('No output descriptors for this trace')
+                else:
+                    print('Successfully listed outputs')
+                    print('---------------------------')
+                    print(output_descriptors.to_json())
                 sys.exit(0)
             else:
                 print("List outputs failed")
@@ -363,7 +344,9 @@ if __name__ == "__main__":
                 output_descriptor = __get_descriptor(
                     options.uuid, options.list_output)
                 if output_descriptor is not None:
-                    print(output_descriptor)
+                    print('Successfully listed output')
+                    print('--------------------------')
+                    print(output_descriptor.to_json())
             else:
                 print(TRACE_MISSING)
                 sys.exit(1)