From 27571d5455d78833f4f2f779507e3157498e7a61 Mon Sep 17 00:00:00 2001 From: Bernd Hufmann Date: Thu, 2 Nov 2023 13:45:36 -0400 Subject: [PATCH] Add an endpoint for closing an experiment With this it's possible to close an experiment on the server. Upon reception of the command the server can dispose allocated resources hence the client doesn't need them anymore. This change follows the TSP update provided by: https://github.com/eclipse-cdt-cloud/trace-server-protocol/pull/95 Also add CLI option and unit test for this. Signed-off-by: Bernd Hufmann --- README.md | 3 +++ test_tsp.py | 6 ++++++ tsp/tsp_client.py | 19 +++++++++++++++++++ tsp_cli_client | 11 +++++++++++ 4 files changed, 39 insertions(+) diff --git a/README.md b/README.md index 6469d1d..a103f28 100644 --- a/README.md +++ b/README.md @@ -99,6 +99,8 @@ optional arguments: --list-experiment UUID Get details on the given experiment --list-experiments List all open experiments on the server + --close-experiment UUID + Close an experiment on the server --delete-experiment UUID Delete an experiment on the server --list-outputs UUID Get details on the given trace @@ -147,6 +149,7 @@ Examples: ./tsp_cli_client --open-experiment EXP_NAME --paths PATHS ./tsp_cli_client --list-experiments ./tsp_cli_client --list-experiment UUID + ./tsp_cli_client --close-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 diff --git a/test_tsp.py b/test_tsp.py index de18c50..eb13711 100644 --- a/test_tsp.py +++ b/test_tsp.py @@ -188,8 +188,14 @@ def test_open_experiment(self, kernel, other): os.path.basename(kernel), traces) assert response.status_code == 200 + exp_uuid = response.model.UUID + response = self.tsp_client.fetch_experiments() assert len(response.model.experiments) == 1 + + response = self.tsp_client.close_experiment(exp_uuid) + assert response.model.indexin_status == "CLOSED" + self._delete_experiments() self._delete_traces() diff --git a/tsp/tsp_client.py b/tsp/tsp_client.py index 03439de..e676c4f 100644 --- a/tsp/tsp_client.py +++ b/tsp/tsp_client.py @@ -172,6 +172,25 @@ def fetch_experiment(self, uuid): print("get trace failed: {0}".format(response.status_code)) return TspClientResponse(None, response.status_code, response.text) + def close_experiment(self, uuid): + ''' + Close a specific experiment + :param uuid: Experiment UUID to fetch + :return: :class:`TspClientResponse ` object + :rtype: TspClientResponse + ''' + api_url = '{0}experiments/{1}:close'.format(self.base_url, uuid) + parameters = {'parameters': {}} + + response = requests.put(api_url, json=parameters, headers=headers) + + if response.status_code == 200: + return TspClientResponse(Experiment(json.loads(response.content.decode('utf-8'))), + response.status_code, response.text) + else: # pragma: no cover + print("delete experiment failed: {0}".format(response.status_code)) + return TspClientResponse(None, response.status_code, response.text) + def delete_experiment(self, uuid): ''' Delete a specific experiment diff --git a/tsp_cli_client b/tsp_cli_client index 04e9643..04fbcb3 100755 --- a/tsp_cli_client +++ b/tsp_cli_client @@ -180,6 +180,8 @@ if __name__ == "__main__": help="Get details on the given experiment", metavar="UUID") parser.add_argument("--list-experiments", dest="list_experiments", action='store_true', help="List all open experiments on the server") + parser.add_argument("--close-experiment", dest="close_experiment", + help="Close an experiment on the server", metavar="UUID") parser.add_argument("--delete-experiment", dest="delete_experiment", help="Delete an experiment on the server", metavar="UUID") parser.add_argument("--list-outputs", dest="list_outputs", @@ -323,6 +325,15 @@ if __name__ == "__main__": else: sys.exit(1) + if options.close_experiment: + response = tsp_client.close_experiment(options.close_experiment) + if response.status_code == 200: + print("Successfully closed experiment") + sys.exit(0) + else: + print("Failed closing experiment with error " + response.status_code) + sys.exit(1) + if options.delete_experiment: response = tsp_client.delete_experiment(options.delete_experiment) if response.status_code == 200: