Get virtual table header (i.e., columns)

Author: kavehshahedi

tsp/model_type.py

@@ -35,4 +35,5 @@ class ModelType(Enum):
     STATES = "states"
     XY = "xy"
     DATA_TREE = "data_tree"
+    VIRTUAL_TABLE_HEADER = "virtual_table_header"
     VIRTUAL_TABLE = "virtual_table"

tsp/response.py

@@ -27,6 +27,7 @@
 from tsp.model_type import ModelType
 from tsp.output_descriptor import OutputDescriptor
 from tsp.entry_model import EntryModel
+from tsp.virtual_tabel_header_model import VirtualTableHeaderModel
 from tsp.xy_model import XYModel
 from tsp.virtual_table_model import VirtualTableModel
 
@@ -88,6 +89,8 @@ def __init__(self, params, model_type):
                 self.model = XYModel(params.get(MODEL_KEY))
             elif self.model_type == ModelType.DATA_TREE:
                 self.model = EntryModel(params.get(MODEL_KEY), self.model_type)
+            elif self.model_type == ModelType.VIRTUAL_TABLE_HEADER:
+                self.model = VirtualTableHeaderModel(params.get(MODEL_KEY))
             elif self.model_type == ModelType.VIRTUAL_TABLE: 
                 self.model = VirtualTableModel(params.get(MODEL_KEY))
 

tsp/tsp_client.py

@@ -58,7 +58,7 @@ class TspClient:
     PARAMETERS_KEY = 'parameters'
     REQUESTED_TIME_KEY = 'requested_times'
     REQUESTED_ITEM_KEY = 'requested_items'
-    
+
     REQUESTED_TIME_RANGE_KEY = 'requested_timerange'
     REQUESTED_TIME_RANGE_START_KEY = 'start'
     REQUESTED_TIME_RANGE_END_KEY = 'end'
@@ -286,7 +286,28 @@ def fetch_datatree(self, exp_uuid, output_id, parameters=None):
         else:  # pragma: no cover
             print(GET_TREE_FAILED.format(response.status_code))
             return TspClientResponse(None, response.status_code, response.text)
-        
+
+    def fetch_virtual_table_columns(self, exp_uuid, output_id):
+        '''
+        Fetch Virtual Table columns, Model extends VirtualTableModel
+        :param exp_uuid: Experiment UUID
+        :param output_id: Output ID
+        :returns: :class:  `TspClientResponse <GenericResponse>` object Virtual Table columns response
+        :rtype: TspClientResponse
+        '''
+        api_url = '{0}experiments/{1}/outputs/table/{2}/columns'.format(
+            self.base_url, exp_uuid, output_id)
+
+        response = requests.post(api_url, json={}, headers=headers)
+
+        if response.status_code == 200:
+            return TspClientResponse(GenericResponse(json.loads(response.content.decode('utf-8')),
+                                                     ModelType.VIRTUAL_TABLE_HEADER),
+                                     response.status_code, response.text)
+        else:
+            print(GET_TREE_FAILED.format(response.status_code))
+            return TspClientResponse(None, response.status_code, response.text)
+
     def fetch_virtual_table_lines(self, exp_uuid, output_id, parameters=None):
         '''
         Fetch Virtual Table lines, Model extends VirtualTableModel
@@ -451,7 +472,6 @@ def fetch_configuration(self, type_id, config_id):
             print("failed to get configuration: {0}".format(response.status_code))
             return TspClientResponse(None, response.status_code, response.text)
 
-
     def post_configuration(self, type_id, params):
         '''
         Load an extension
@@ -480,7 +500,7 @@ def put_configuration(self, type_id, config_id, params):
         response = requests.put(api_url, json=parameters, headers=headers)
 
         if response.status_code == 200:
-            return TspClientResponse(Configuration(json.loads(response.content.decode('utf-8'))), 
+            return TspClientResponse(Configuration(json.loads(response.content.decode('utf-8'))),
                                      response.status_code, response.text)
         else:  # pragma: no cover
             print("put extension failed: {0}".format(response.status_code))

tsp/virtual_tabel_header_model.py

@@ -0,0 +1,83 @@
+# 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.
+
+"""Virtual table header model file."""
+
+COLUMN_ID_KEY = "id"
+COLUMN_NAME_KEY = "name"
+COLUMN_DESCRIPTION_KEY = "description"
+COLUMN_TYPE_KEY = "type"
+
+
+class VirtualTableHeaderModel:
+    '''
+    Virtual table header model that will be returned by the server
+    '''
+
+    def __init__(self, params):
+        # Array of columns in the virtual table
+        self.columns = []
+        if params is not None:
+            for column in params:
+                # Column ID
+                column_id = None
+                if COLUMN_ID_KEY in column:
+                    column_id = column.get(COLUMN_ID_KEY)
+                    del column[COLUMN_ID_KEY]
+
+                # Column name
+                column_name = None
+                if COLUMN_NAME_KEY in column:
+                    column_name = column.get(COLUMN_NAME_KEY)
+                    del column[COLUMN_NAME_KEY]
+
+                # Column description
+                column_description = None
+                if COLUMN_DESCRIPTION_KEY in column:
+                    column_description = column.get(COLUMN_DESCRIPTION_KEY)
+                    del column[COLUMN_DESCRIPTION_KEY]
+
+                # Column type
+                column_type = None
+                if COLUMN_TYPE_KEY in column:
+                    column_type = column.get(COLUMN_TYPE_KEY)
+                    del column[COLUMN_TYPE_KEY]
+
+                # Add column to the list
+                self.columns.append({
+                    COLUMN_ID_KEY: column_id,
+                    COLUMN_NAME_KEY: column_name,
+                    COLUMN_DESCRIPTION_KEY: column_description,
+                    COLUMN_TYPE_KEY: column_type
+                })
+
+    def print(self):
+        '''
+        Print the virtual table header model
+        '''
+        print("Virtual Table Columns:")
+        for column in self.columns:
+            print("  id: " + str(column.get(COLUMN_ID_KEY)))
+            print("  name: " + str(column.get(COLUMN_NAME_KEY)))
+            print("  description: " + str(column.get(COLUMN_DESCRIPTION_KEY)))
+            print("  type: " + str(column.get(COLUMN_TYPE_KEY)))
+            print("-" * 50)

tsp_cli_client

@@ -188,6 +188,8 @@ if __name__ == "__main__":
                         help="Get details on the given output of a trace", metavar="OUTPUT_ID")
     parser.add_argument("--get-tree", dest="get_tree",
                         help="Get the tree of an output of type DATA_TREE", metavar="OUTPUT_ID")
+    parser.add_argument("--get-virtual-table-columns", dest="get_virtual_table_columns",
+                        help="Get the columns of an output of type DATA_TREE", metavar="OUTPUT_ID")
     parser.add_argument("--get-virtual-table-lines", dest="get_virtual_table_lines",
                         help="Get the tree lines of an output of type DATA_TREE", metavar="OUTPUT_ID")
     parser.add_argument("--table-line-index", dest="table_line_index",
@@ -421,6 +423,21 @@ if __name__ == "__main__":
                 print(TRACE_MISSING)
                 sys.exit(1)
 
+        if options.get_virtual_table_columns:
+            if options.uuid is not None:
+                response = tsp_client.fetch_virtual_table_columns(
+                    options.uuid, options.get_virtual_table_columns)
+
+                if response.status_code == 200:
+                    model = response.model.model
+                    model.print()
+                    sys.exit(0)
+                else:
+                    sys.exit(1)
+            else:
+                print(TRACE_MISSING)
+                sys.exit(1)
+
         if options.get_virtual_table_lines:
             if options.uuid is not None:
                 if options.table_line_index is None and options.table_times is None: