Implement identifier service

Signed-off-by: Vlad Arama <[email protected]>

Author: Vlad Arama

README.md

@@ -88,6 +88,7 @@ usage: tsp_cli_client [-h] [--ip IP] [--port PORT]
                       [--config-id CONFIG_ID] 
                       [--params PARAMS]
                       [--get-health]
+		                  [--get-identifier]
 
 CLI client to send Trace Server Protocol commands to a Trace Server.
 
@@ -158,6 +159,7 @@ optional arguments:
                         id of configuration
   --params PARAMS       comma separated key value pairs (key1=val1,key2=val2)
   --get-health          Get the health status of the server
+  --get-identifier      Identify important information regarding the server and the system
 ```
 
 Examples:
@@ -188,6 +190,7 @@ Examples:
   ./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
   ./tsp_cli_client --get-health
+  ./tsp_cli_client --get-identifier
 ```
 
 [agc]: https://kislyuk.github.io/argcomplete/#activating-global-completion

test_tsp.py

@@ -579,6 +579,20 @@ def test_fetch_health(self):
         assert response.model
         assert response.model.status == HealthStatus.UP
 
+    def test_fetch_identifier(self):
+        """Expect a successful identifier response"""
+        response = self.tsp_client.fetch_identifier()
+        assert response.status_code == 200
+        assert response.model
+        assert response.model.server_version
+        assert response.model.build_time
+        assert response.model.os_name
+        assert response.model.os_arch
+        assert response.model.os_version
+        assert response.model.cpu_count
+        assert response.model.max_memory
+        assert response.model.product_id
+
     @staticmethod
     def __requested_parameters(response):
         parameters = {}

tsp/identifier.py

@@ -0,0 +1,113 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2024 - 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.
+
+"""Identifier Service Class"""
+
+SERVER_VERSION = "version"
+BUILD_TIME = "buildTime"
+OS_NAME = "os"
+OS_ARCH = "osArch"
+OS_VERSION = "osVersion"
+CPU_COUNT = "cpuCount"
+MAX_MEMORY = "maxMemory"
+LAUNCHER_NAME = "launcherName"
+PRODUCT_ID = "productId"
+
+
+class Identifier:
+    '''
+    Model of the Identifier Service. This is a Service used to identify important information
+    regarding the trace server and the system it is running on.
+    '''
+    def __init__(self, params):
+        '''
+        Constructor
+        '''
+
+        # Server Version
+        if SERVER_VERSION in params:
+            self.server_version = params.get(SERVER_VERSION)
+            del params[SERVER_VERSION]
+        else:
+            self.server_version = None
+
+        # Build Time
+        if BUILD_TIME in params:
+            self.build_time = params.get(BUILD_TIME)
+            del params[BUILD_TIME]
+        else:
+            self.build_time = None
+
+        # OS Name
+        if OS_NAME in params:
+            self.os_name = params.get(OS_NAME)
+            del params[OS_NAME]
+        else:
+            self.os_name = None
+
+        # OS Arch
+        if OS_ARCH in params:
+            self.os_arch = params.get(OS_ARCH)
+            del params[OS_ARCH]
+        else:
+            self.os_arch = None
+
+        # OS Version
+        if OS_VERSION in params:
+            self.os_version = params.get(OS_VERSION)
+            del params[OS_VERSION]
+        else:
+            self.os_version = None
+
+        # CPU Count
+        if CPU_COUNT in params:
+            self.cpu_count = params.get(CPU_COUNT)
+            del params[CPU_COUNT]
+        else:
+            self.cpu_count = None
+
+        # Max Memory
+        if MAX_MEMORY in params:
+            self.max_memory = params.get(MAX_MEMORY)
+            del params[MAX_MEMORY]
+        else:
+            self.max_memory = None
+
+        # Product ID
+        if PRODUCT_ID in params:
+            self.product_id = params.get(PRODUCT_ID)
+            del params[PRODUCT_ID]
+        else:
+            self.product_id = None
+
+        # Launcher Name
+        if LAUNCHER_NAME in params:
+            self.launcher_name = params.get(LAUNCHER_NAME)
+            del params[LAUNCHER_NAME]
+        else:
+            self.launcher_name = None
+
+    def to_string(self):
+        '''
+        to_string method
+        '''
+        return f"Identifier[version={self.server_version}, buildTime={self.build_time}, os={self.os_name}, osArch={self.os_arch}, osVersion={self.os_version}, cpuCount={self.cpu_count}, maxMemory={self.max_memory}, productId={self.product_id}, launcherName={self.launcher_name}]"

tsp/tsp_client.py

@@ -38,6 +38,7 @@
 from tsp.experiment import Experiment
 from tsp.output_descriptor import OutputDescriptor
 from tsp.health import Health
+from tsp.identifier import Identifier
 
 APPLICATION_JSON = 'application/json'
 
@@ -535,3 +536,20 @@ def fetch_health(self):
         else:  # pragma: no cover
             print("get health failed: {0}".format(response.status_code))
             return TspClientResponse(None, response.status_code, response.text)
+
+    def fetch_identifier(self):
+        '''
+        Fetch the identifier service to obtain important information regarding the trace server
+        and the system it is running on.
+
+        :return: :class:`TspClientResponse <Identifier> object
+        :rtype: TspClientResponse
+        '''
+        api_url = '{0}identifier'.format(self.base_url)
+        response = requests.get(api_url, headers=headers)
+        if response.status_code == 200:
+            return TspClientResponse(Identifier(json.loads(response.content.decode('utf-8'))),
+                                     response.status_code, response.text)
+        else:  # pragma: no cover
+            print("get identifiers failed: {0}".format(response.status_code))
+            return TspClientResponse(None, response.status_code, response.text)

tsp_cli_client

@@ -239,6 +239,7 @@ if __name__ == "__main__":
     parser.add_argument("--config-id", dest="config_id", help="id of configuration")
     parser.add_argument("--params", dest="params", help="semicolon separated key value pairs (key1=val1;key2=val2)")
     parser.add_argument("--get-health", dest="get_health", action='store_true', help="Get the health status of the server")
+    parser.add_argument("--get-identifier", dest="get_identifier", action='store_true', help="Get important information regarding the trace server and the system")
 
     argcomplete.autocomplete(parser)
     options = parser.parse_args()
@@ -590,6 +591,14 @@ if __name__ == "__main__":
             else:
                 sys.exit(1)
 
+        if options.get_identifier:
+            response = tsp_client.fetch_identifier()
+            if response.status_code == 200:
+                print('  {0}'.format(response.model.to_string()))
+                sys.exit(0)
+            else:
+                sys.exit(1)
+
     except requests.exceptions.ConnectionError as e:
         print('Unexpected error: {0}'.format(e))
         sys.exit(1)