Implement configuration API of the TSP

It replaces the list/load/delete extension CLI that used the
undocumented XML endpoint of Trace Compass server. It adds the
following commands and corresponding TSP API calls:

- --list-configuration-sources: list all the configuration source types
- --list-configuration-sourceL list a single configuration source type
- --list-configurations: list loaded configurations for a source type
- --list-configuration: list a single configuration for a source type
- --load-configuration: load a configuration for a source type
- --update-configuration: update a configuration for a source type
- --delete-configuration: delete a configuration for a source type

Update README.md as well for these new commands.

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

Author: bhufmann

.vscode/launch.json

@@ -5,11 +5,19 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "Python: Current File",
+            "name": "Python: Test",
             "type": "python",
             "request": "launch",
             "program": ".venv/bin/pytest",
             "console": "integratedTerminal"
+        },
+        {
+            "name": "Python: CLI",
+            "type": "python",
+            "request": "launch",
+            "program": "tsp_cli_client",
+            "args": ["--list-experiments"],
+            "console": "integratedTerminal"
         }
     ]
 }

README.md

@@ -59,18 +59,28 @@ To use the **tsp_cli_client** script, type the following command in the root dir
 ```python
 ./tsp_cli_client -h
 
-usage: tsp_cli_client [-h] [--ip IP] [--port PORT] [--open-trace TRACE_PATH]
+usage: tsp_cli_client [-h] [--ip IP] [--port PORT] 
+                      [--open-trace TRACE_PATH]
                       [--name NAME] [--list-trace UUID] [--list-traces]
                       [--delete-trace UUID] [--open-experiment EXP_NAME]
                       [--list-experiment UUID] [--list-experiments]
                       [--delete-experiment UUID] [--list-outputs UUID]
                       [--list-output OUTPUT_ID] [--get-tree OUTPUT_ID]
+                      [--get-timegraph-tree OUTPUT_ID] 
                       [--get-xy-tree OUTPUT_ID] [--get-xy OUTPUT_ID]
                       [--items [ITEMS ...]] [--times [TIMES ...]]
                       [--uuid UUID] [--uuids [UUIDS ...]] [--do-delete-traces]
-                      [--paths [PATHS ...]] [--list-extensions]
-                      [--load-extension EXTENSION_PATH]
-                      [--delete-extension EXTENSION_NAME]
+                      [--paths [PATHS ...]]
+                      [--list-configuration-sources] 
+                      [--list-configuration-source TYPE_ID] 
+                      [--list-configurations TYPE_ID]
+                      [--list-configuration CONFIG_ID] 
+                      [--load-configuration] 
+                      [--update-configuration] 
+                      [--delete-configuration CONFIGURATION_ID]
+                      [--type-id TYPE_ID] 
+                      [--config-id CONFIG_ID] 
+                      [--params PARAMS]
 
 CLI client to send Trace Server Protocol commands to a Trace Server.
 
@@ -94,21 +104,62 @@ optional arguments:
   --list-outputs UUID   Get details on the given trace
   --list-output OUTPUT_ID
                         Get details on the given output of a trace
-  --get-tree OUTPUT_ID  Get the timegraph tree of an output
+  --get-tree OUTPUT_ID  Get the tree of an output of type DATA_TREE
+  --get-timegraph-tree OUTPUT_ID
+                        Get the tree of an output of type TIME_GRAPH
   --get-xy-tree OUTPUT_ID
-                        Get the XY tree of an output
+                        Get the tree of an output of type TREE_TIME_XY
   --get-xy OUTPUT_ID    Get the XY data of an output
   --items [ITEMS ...]   The list of XY items requested
   --times [TIMES ...]   The list of XY times requested
   --uuid UUID           The UUID of a trace
   --uuids [UUIDS ...]   The list of UUIDs
   --do-delete-traces    Also delete traces when deleting experiment
   --paths [PATHS ...]   List of trace paths to be part of an experiment
-  --list-extensions     Get the extensions loaded
-  --load-extension EXTENSION_PATH
-                        Load an extension
-  --delete-extension EXTENSION_NAME
-                        Delete an extension
+  --list-configuration-sources
+                        Get the available configuration sources
+  --list-configuration-source TYPE_ID
+                        Get a available configuration source
+  --list-configurations TYPE_ID
+                        Get the configurations loaded for given type
+  --list-configuration CONFIG_ID
+                        Get a configuration loaded for given type and config id
+  --load-configuration  Load an configuration using paramemeters provided by --params
+  --update-configuration
+                        Update an configuration using paramemeters provided by --params
+  --delete-configuration CONFIGURATION_ID
+                        Delete a configuration
+  --type-id TYPE_ID     id of configuration source type
+  --config-id CONFIG_ID
+                        id of configuration
+  --params PARAMS       comma separated key value pairs (key1=val1,key2=val2)
+```
+
+Examples:
+```python
+  '''Open trace ''' 
+  ./tsp_cli_client --open-trace TRACE_PATH [--name NAME]
+  ./tsp_cli_client --list-traces
+  ./tsp_cli_client --list-trace UUID
+  ./tsp_cli_client --list-trace UUID
+  ./tsp_cli_client --delete-trace UUID
+  ./tsp_cli_client --open-experiment EXP_NAME --uuids UUIDS 
+  ./tsp_cli_client --open-experiment EXP_NAME --paths PATHS
+  ./tsp_cli_client --list-experiments
+  ./tsp_cli_client --list-experiment UUID
+  ./tsp_cli_client --delete-experiment UUID [--do-delete-traces]
+  ./tsp_cli_client --list-outputs UUID
+  ./tsp_cli_client --get-tree OUTPUT_ID --uuid UUID
+  ./tsp_cli_client --get-timegraph-tree OUTPUT_ID --uuid UUID
+  ./tsp_cli_client --get-xy-tree OUTPUT_ID --uuid UUID
+  ./tsp_cli_client --get-xy OUTPUT_ID --uuid UUID --items ITEMS --times TIMES
+  ./tsp_cli_client --list-configuration-sources
+  ./tsp_cli_client --list-configuration-source TYPE_ID
+  ./tsp_cli_client --list-configurations TYPE_ID
+  ./tsp_cli_client --list-configuration CONFIG_ID --type-id TYPE_ID
+  ./tsp_cli_client --load-configuration --type-id TYPE_ID --params key1:value1
+  ./tsp_cli_client --update-configuration --type-id TYPE_ID --config-id CONFIG_ID --params key1=value1,key2=value2
+  ./tsp_cli_client --delete-configuration CONFIGURATION_ID --type-id TYPE_ID
 ```
 
 [agc]: https://kislyuk.github.io/argcomplete/#activating-global-completion

test_tsp.py

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (C) 2021 - Ericsson
+# Copyright (C) 2021, 2023 - Ericsson
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -43,6 +43,8 @@
                        REQUESTED_TIME_START) / REQUESTED_TIME_LENGTH
 
 
+CONFIG_SOURCE_TYPE = 'org.eclipse.tracecompass.tmf.core.config.xmlsourcetype'
+
 # pylint: disable=too-many-public-methods
 class TestTspClient:
     """TspClient test methods.
@@ -405,31 +407,73 @@ def test_fetch_timegraph_tree_complete(self, kernel):
         self._delete_experiments()
         self._delete_traces()
 
-    def test_fetch_extensions_none(self):
-        """Expect no extensions without posting any."""
-        response = self.tsp_client.fetch_extensions()
+    def test_fetch_configuration_sources(self):
+        """Expect at least configuration source ."""
+        response = self.tsp_client.fetch_configuration_sources()
+        assert response.status_code == 200
+        assert response.model.configuration_source_set
+
+        response = self.tsp_client.fetch_configuration_source(CONFIG_SOURCE_TYPE)
         assert response.status_code == 200
-        assert not response.model.extension_set
+        assert response.model
+
+    def test_fetch_configurations_none(self):
+        """Expect no configurations without posting any."""
+        response = self.tsp_client.fetch_configurations(CONFIG_SOURCE_TYPE)
+        assert response.status_code == 200
+        assert response.model.configuration_set
+
+        response = self.tsp_client.fetch_configuration(CONFIG_SOURCE_TYPE, self.name)
+        assert response.status_code == 404
 
-    def test_post_extension(self, extension):
-        """Expect extension after posting it."""
-        response = self.tsp_client.post_extension(extension)
+    def test_post_configuration(self, extension):
+        """Expect configuration after posting it."""
+        params = {}
+        params['path'] = extension
+        response = self.tsp_client.post_configuration(CONFIG_SOURCE_TYPE, params)
         assert response.status_code == 200
 
-        response = self.tsp_client.fetch_extensions()
-        assert len(response.model.extension_set) == 1
+        response = self.tsp_client.fetch_configurations(CONFIG_SOURCE_TYPE)
+        assert len(response.model.configuration_set) > 0
+        found = False
+        for config in response.model.configuration_set:
+            if config.id == self.name:
+                found = True
+        assert found
 
-        response = self.tsp_client.delete_extension(self.name)
+        response = self.tsp_client.fetch_configuration(CONFIG_SOURCE_TYPE, self.name)
         assert response.status_code == 200
+        assert response.model
+        assert response.model.id == self.name
+
+        response = self.tsp_client.delete_configuration(CONFIG_SOURCE_TYPE, self.name)
+        assert response.status_code == 200
+        assert response.model
+        assert response.model.id == self.name
+
+    def test_posted_configuration_deleted(self, extension):
+        """Expect no configuration after deletion."""
+        params = {}
+        params['path'] = extension
+        self.tsp_client.post_configuration(CONFIG_SOURCE_TYPE, params)
+        response = self.tsp_client.delete_configuration(CONFIG_SOURCE_TYPE, self.name)
+        assert response.status_code == 200
+
+        response = self.tsp_client.fetch_configurations(CONFIG_SOURCE_TYPE)
+        assert response.model.configuration_set
+
+    def test_put_configuration(self, extension):
+        """Expect successful update of configuartion."""
+        params = {}
+        params['path'] = extension
+        self.tsp_client.post_configuration(CONFIG_SOURCE_TYPE, params)
 
-    def test_posted_extension_deleted(self, extension):
-        """Expect no extension after deletion."""
-        self.tsp_client.post_extension(extension)
-        response = self.tsp_client.delete_extension(self.name)
+        response = self.tsp_client.put_configuration(CONFIG_SOURCE_TYPE, self.name, params)
         assert response.status_code == 200
+        assert response.model
+        assert response.model.id == self.name
 
-        response = self.tsp_client.fetch_extensions()
-        assert not response.model.extension_set
+        self.tsp_client.delete_configuration(CONFIG_SOURCE_TYPE, self.name)
 
     @staticmethod
     def __requested_parameters(response):

tsp/configuration.py

@@ -0,0 +1,81 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2020, 2023 - Ericsson
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Configuration class file."""
+
+NAME_KEY = "name"
+DESCTIPION_KEY = "description"
+ID_KEY = "id"
+SOURCE_TYPE_ID = "sourceTypeId"
+PARAMETER_KEY = "parameters"
+
+# pylint: disable=too-few-public-methods
+class Configuration:
+    '''
+    Class to handle configurations available on the remote node
+    '''
+    def __init__(self, params):
+        '''
+        Constructor
+        '''
+
+        if NAME_KEY in params:
+            self.name = params.get(NAME_KEY)
+            del params[NAME_KEY]
+        else:
+            self.name = ""
+
+        if DESCTIPION_KEY in params:
+            self.description = params.get(DESCTIPION_KEY)
+            del params[DESCTIPION_KEY]
+        else:
+            self.description = ""
+
+        if ID_KEY in params:
+            # pylint: disable=invalid-name
+            self.id = params.get(ID_KEY)
+            del params[ID_KEY]
+        else:
+            self.id = "unknown-id"
+
+        if SOURCE_TYPE_ID in params:
+            # pylint: disable=invalid-name
+            self.source_type_id = params.get(SOURCE_TYPE_ID)
+            del params[SOURCE_TYPE_ID]
+        else:
+            self.source_type_id = "unknown_source_type_id"
+
+        if PARAMETER_KEY in params:
+            # pylint: disable=invalid-name
+            self.parameters = params.get(PARAMETER_KEY)
+            del params[PARAMETER_KEY]
+        else:
+            self.parameters = {}
+
+
+    # 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

@@ -0,0 +1,73 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2023 - Ericsson
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Configuration parameter descriptors class file."""
+
+KEY_NAME_KEY = "keyName"
+DESCTIPION_KEY = "description"
+DATA_TYPE_KEY = "dataType"
+REQUIRED_KEY = "isRequired"
+
+# pylint: disable=too-few-public-methods
+class ConfigurationParameterDescriptor:
+    '''
+    Class to handle configuration parameter descriptor available on the remote node
+    '''
+    def __init__(self, params):
+        '''
+        Constructor
+        '''
+
+        if KEY_NAME_KEY in params:
+            self.key_name = params.get(KEY_NAME_KEY)
+            del params[KEY_NAME_KEY]
+        else:
+            self.key_name = ""
+
+        if DESCTIPION_KEY in params:
+            self.description = params.get(DESCTIPION_KEY)
+            del params[DESCTIPION_KEY]
+        else:
+            self.description = ""
+
+        if DATA_TYPE_KEY in params:
+            # pylint: disable=invalid-name
+            self.data_type = params.get(DATA_TYPE_KEY)
+            del params[DATA_TYPE_KEY]
+        else:
+            self.data_type = "STRING"
+
+        if REQUIRED_KEY in params:
+            # pylint: disable=invalid-name
+            self.is_required = params.get(REQUIRED_KEY)
+            del params[REQUIRED_KEY]
+        else:
+            self.is_required = "unknown_source_type_id"
+
+
+    # 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)