Add JSON encoders, string and JSON representation for configurations

Use JSON representation to print global configuration related results as
JSON string.

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

Also, replace to_string by string representation of the classes.

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

Author: bhufmann

tsp/configuration.py

@@ -22,8 +22,10 @@
 
 """Configuration class file."""
 
+import json
+
 NAME_KEY = "name"
-DESCTIPION_KEY = "description"
+DESCRIPTION_KEY = "description"
 ID_KEY = "id"
 SOURCE_TYPE_ID = "sourceTypeId"
 PARAMETER_KEY = "parameters"
@@ -44,9 +46,9 @@ def __init__(self, params):
         else:
             self.name = ""
 
-        if DESCTIPION_KEY in params:
-            self.description = params.get(DESCTIPION_KEY)
-            del params[DESCTIPION_KEY]
+        if DESCRIPTION_KEY in params:
+            self.description = params.get(DESCRIPTION_KEY)
+            del params[DESCRIPTION_KEY]
         else:
             self.description = ""
 
@@ -71,11 +73,23 @@ def __init__(self, params):
         else:
             self.parameters = {}
 
+    def __repr__(self):
+        return 'Configuration(name={}, description={}, id={}, source_type_id={}, parameters={})'.format(
+            self.name, self.description, self.id, self.source_type_id, self.parameters)
+
+    def to_json(self):
+        return json.dumps(self, cls=ConfigurationEncoder, indent=4)
+
+
+class ConfigurationEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, Configuration):
+            return {
+                ID_KEY: obj.id,
+                NAME_KEY: obj.name,
+                DESCRIPTION_KEY: obj.description,
+                SOURCE_TYPE_ID: obj.source_type_id,
+                PARAMETER_KEY: obj.parameters
+            }
+        return super().default(obj)
 
-    # pylint: disable=consider-using-f-string
-    def to_string(self):
-        '''
-        to_string method
-        '''
-        return 'Configuration[name={0}, description={1}, id={2}, source_type_id={3}, parameters={4}]'.format(self.name,
-          self.description, self.id, self.source_type_id, self.parameters)

tsp/configuration_parameter_descriptor.py

@@ -22,6 +22,8 @@
 
 """Configuration parameter descriptors class file."""
 
+import json
+
 KEY_NAME_KEY = "keyName"
 DESCTIPION_KEY = "description"
 DATA_TYPE_KEY = "dataType"
@@ -61,13 +63,23 @@ def __init__(self, params):
             self.is_required = params.get(REQUIRED_KEY)
             del params[REQUIRED_KEY]
         else:
-            self.is_required = "unknown_source_type_id"
+            self.is_required = "false"
 
+    def __repr__(self):
+        return 'ConfigurationParameterDescriptor[key_name={}, description={}, data_type={}, is_required={}])'.format(
+            self.key_name,self.description, self.data_type, self.is_required)
 
-    # pylint: disable=consider-using-f-string
-    def to_string(self):
-        '''
-        to_string method
-        '''
-        return 'ConfigurationParameterDescriptor[key_name={0}, description={1}, data_type={2}, is_required={3}]'.format(self.key_name,
-          self.description, self.data_type, self.is_required)
+    def to_json(self):
+        return (json.dumps(self, cls=ConfigurationParameterDescriptorEncoder, indent=4))
+
+
+class ConfigurationParameterDescriptorEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, ConfigurationParameterDescriptor):
+            return {
+                KEY_NAME_KEY: obj.key_name,
+                DESCTIPION_KEY: obj.description,
+                DATA_TYPE_KEY: obj.data_type,
+                REQUIRED_KEY: obj.is_required
+            }
+        return super().default(obj)

tsp/configuration_parameter_descriptor_set.py

@@ -22,7 +22,8 @@
 
 """ConfigurationSet class file."""
 
-from tsp.configuration_parameter_descriptor import ConfigurationParameterDescriptor
+import json
+from tsp.configuration_parameter_descriptor import ConfigurationParameterDescriptor, ConfigurationParameterDescriptorEncoder
 
 
 # pylint: disable=too-few-public-methods
@@ -39,16 +40,17 @@ def __init__(self, params):
         for obj in params:
             self.configuration_parameter_set.append(ConfigurationParameterDescriptor(obj))
 
+    def __repr__(self) -> str:
+        return 'ConfigurationParameterDescriptorSet({})'.format(', '.join(str(source) for source in self.configuration_parameter_set))
+
+    def to_json(self):
+        return (json.dumps(self, cls=ConfigurationParameterDescriptorSetEncoder, indent=4))
 
-    # pylint: disable=consider-using-f-string
-    def to_string(self):
-        '''
-        to string method
-        '''
-        sep = ''
-        my_str = ''
-        for desc in self.configuration_parameter_set:
-            my_str = my_str + '{0}{1}\n'.format(sep, desc.to_string())
-            sep = ', '
 
-        return my_str
+class ConfigurationParameterDescriptorSetEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, ConfigurationParameterDescriptorSet):
+            return [
+                ConfigurationParameterDescriptorEncoder().default(configuration_parameter) for configuration_parameter in obj.configuration_parameter_set
+            ]
+        return super().default(obj)

tsp/configuration_set.py

@@ -22,7 +22,8 @@
 
 """ConfigurationSet class file."""
 
-from tsp.configuration import Configuration
+import json
+from tsp.configuration import Configuration, ConfigurationEncoder
 
 
 # pylint: disable=too-few-public-methods
@@ -39,15 +40,17 @@ def __init__(self, params):
         for obj in params:
             self.configuration_set.append(Configuration(obj))
 
+    def __repr__(self) -> str:
+        return 'ConfigurationSet({})'.format(', '.join(str(config) for config in self.configuration_set))
 
-    # pylint: disable=consider-using-f-string
-    def to_string(self):
-        '''
-        to string method
-        '''
-        my_str = ''
-        sep = ''
-        for desc in self.configuration_set:
-            my_str = my_str + '{0}{1}\n'.format(sep, desc.to_string())
-            sep = ', '
-        return my_str
+    def to_json(self):
+        return json.dumps(self, cls=ConfigurationSetEncoder, indent=4)
+
+
+class ConfigurationSetEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, ConfigurationSet):
+            return [
+                ConfigurationEncoder().default(configuration) for configuration in obj.configuration_set
+            ]
+        return super().default(obj)

tsp/configuration_source.py

@@ -22,7 +22,8 @@
 
 """ConfigurationSource class file."""
 
-from tsp.configuration_parameter_descriptor_set import ConfigurationParameterDescriptorSet
+import json
+from tsp.configuration_parameter_descriptor_set import ConfigurationParameterDescriptorSet, ConfigurationParameterDescriptorSetEncoder
 
 NAME_KEY = "name"
 DESCTIPION_KEY = "description"
@@ -71,19 +72,27 @@ def __init__(self, params):
             self.schema = params.get(SCHEMA_KEY)
             del params[SCHEMA_KEY]
 
-    # pylint: disable=consider-using-f-string
-    def to_string(self):
-        '''
-        to_string 
-        '''
-        my_str = "no parameter descriptor"
-        if self.parameter_descriptors is not None:
-            my_str = self.parameter_descriptors.to_string()
+    def __repr__(self):
+        return 'ConfigurationSource(id={}, name={}, description={}, parameter_descriptors={}, schema={})'.format(
+            self.id,
+            self.name,
+            self.description,
+            self.parameter_descriptors if self.parameter_descriptors is not None else 'None',
+            obj.schema if obj.schema is not None else 'None')
+
+    def to_json(self):
+        return json.dumps(self, cls=ConfigurationSourceEncoder, indent=4)
 
-        my_schema = "no schema"
-        if self.schema is not None:
-            my_schema = self.schema
 
-        return'Configuration Source[id={0}, name={1}, description: {2}, parameter_descriptor={3}, schema={4}]'.format(self.id,
-              self.name, self.description, my_str, my_schema)
+class ConfigurationSourceEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, ConfigurationSource):
+            return {
+                ID_KEY: obj.id,
+                NAME_KEY: obj.name,
+                DESCTIPION_KEY: obj.description,
+                PARAM_DESC_KEY: ConfigurationParameterDescriptorSetEncoder().default(obj.parameter_descriptors) if isinstance(obj.parameter_descriptors, ConfigurationParameterDescriptorSet) else "None",
+                SCHEMA_KEY: obj.schema if obj.schema is not None else 'None'
+            }
+        return super().default(obj)
 

tsp/configuration_source_set.py

@@ -21,8 +21,8 @@
 # SOFTWARE.
 
 """ConfigurationSourceSet class file."""
-
-from tsp.configuration_source import ConfigurationSource
+import json
+from tsp.configuration_source import ConfigurationSource, ConfigurationSourceEncoder
 
 
 # pylint: disable=too-few-public-methods
@@ -39,16 +39,18 @@ def __init__(self, params):
         for obj in params:
             self.configuration_source_set.append(ConfigurationSource(obj))
 
-    # pylint: disable=consider-using-f-string
-    def to_string(self):
-        '''
-        to string method
-        '''
-        my_str = ''
-        sep = ''
-        for desc in self.configuration_source_set:
-            my_str = my_str + '{0}{1}\n'.format(sep, desc.to_string())
-            sep = ', '
-        return my_str
+    def __repr__(self) -> str:
+        return 'ConfigurationSourceSet({})'.format(', '.join(str(source) for source in self.configuration_source_set))
+
+    def to_json(self):
+        return json.dumps(self, cls=ConfigurationSourceSetEncoder, indent=4)
+
 
+class ConfigurationSourceSetEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, ConfigurationSourceSet):
+            return [
+                ConfigurationSourceEncoder().default(configuration_source) for configuration_source in obj.configuration_source_set
+            ]
+        return super().default(obj)
 

tsp_cli_client

@@ -483,17 +483,22 @@ if __name__ == "__main__":
                 if not configuration_source_set or len(configuration_source_set.configuration_source_set) == 0:
                     print('No configuration sources available')
                 else:
-                    print('  {0}'.format(configuration_source_set.to_string()))
+                    print('Successfully listed configuration sources')
+                    print('-----------------------------------------')
+                    print(response.model.to_json())
                 sys.exit(0)
             else:
                 sys.exit(1)
 
         if options.list_configuration_source:
             response = tsp_client.fetch_configuration_source(options.list_configuration_source)
             if response.status_code == 200:
-                print('  {0}'.format(response.model.to_string()))
+                print('Successfully listed configuration source')
+                print('----------------------------------------')
+                print(response.model.to_json())
                 sys.exit(0)
             else:
+                print('No such configuration source')
                 sys.exit(1)
 
         if options.list_configurations:
@@ -503,7 +508,9 @@ if __name__ == "__main__":
                 if not configuration_set or len(configuration_set.configuration_set) == 0:
                     print('No configurations loaded')
                 else:
-                    print('  {0}'.format(configuration_set.to_string()))
+                    print('Successfully listed configurations')
+                    print('----------------------------------')
+                    print(response.model.to_json())
                 sys.exit(0)
             else:
                 sys.exit(1)
@@ -513,9 +520,12 @@ if __name__ == "__main__":
             if options.type_id is not None:
                 response = tsp_client.fetch_configuration(options.type_id, options.list_configuration)
                 if response.status_code == 200:
-                    print('  {0}'.format(response.model.to_string()))
+                    print('Successfully listed configuration')
+                    print('---------------------------------')
+                    print(response.model.to_json())
                     sys.exit(0)
                 else:
+                    print('No such configuration')
                     sys.exit(1)
             else:
                 print("No type id of configuration provided")
@@ -530,7 +540,9 @@ if __name__ == "__main__":
                     if (params is not None):
                         response = tsp_client.post_configuration(options.type_id, params)
                         if response.status_code == 200:
-                            print('  {0}'.format(response.model.to_string()))
+                            print('Successfully loaded configuration')
+                            print('---------------------------------')
+                            print(response.model.to_json())
                             sys.exit(0)
                         else:
                             sys.exit(1)
@@ -552,7 +564,9 @@ if __name__ == "__main__":
                         if (params is not None):
                             response = tsp_client.put_configuration(options.type_id, options.config_id, params)
                             if response.status_code == 200:
-                                print('  {0}'.format(response.model.to_string()))
+                                print('Successfully updated configuration')
+                                print('---------------------------------')
+                                print(response.model.to_json())
                                 sys.exit(0)
                             else:
                                 sys.exit(1)
@@ -573,7 +587,9 @@ if __name__ == "__main__":
             if options.type_id is not None:
                 response = tsp_client.delete_configuration(options.type_id, options.delete_configuration)
                 if response.status_code == 200:
-                    print('  {0}'.format(response.model.to_string()))
+                    print('Successfully deleted configuration')
+                    print('---------------------------------')
+                    print(response.model.to_json())
                     sys.exit(0)
                 else:
                     sys.exit(1)