Dds 1690 -- New cli command: dds project status extend

SPRINTLOG.md

@@ -305,4 +305,5 @@ _Nothing merged in CLI during this sprint_
 
 # 2023-10-16 - 2023-10-27
 
+- Added a new command to match with the new extend deadline endpoint ([#661])(https://github.com/ScilifelabDataCentre/dds_cli/pull/661)
 - Change "Checksum verification successful. File integrity verified." logging level from INFO to DEBUG in order to not print for all files ([#662])(https://github.com/ScilifelabDataCentre/dds_cli/pull/661)

dds_cli/__main__.py

@@ -1243,6 +1243,35 @@ def delete_project(click_ctx, project: str):
         sys.exit(1)
 
 
+# -- dds project status extend -- #
+@project_status.command(name="extend", no_args_is_help=True)
+# Options
+@project_option(required=True)
+@click.pass_obj
+def extend_deadline(click_ctx, project: str):
+    """Extend a project deadline by an specified number of days.
+
+    This operation has the same effect as expiring and re-releasing a project
+    Therefore it consumes one of the possible expiring times.
+    """
+    try:
+        with dds_cli.project_status.ProjectStatusManager(
+            project=project,
+            no_prompt=click_ctx.get("NO_PROMPT", False),
+            token_path=click_ctx.get("TOKEN_PATH"),
+        ) as updater:
+            updater.extend_deadline()
+    except (
+        dds_cli.exceptions.APIError,
+        dds_cli.exceptions.AuthenticationError,
+        dds_cli.exceptions.DDSCLIException,
+        dds_cli.exceptions.ApiResponseError,
+        dds_cli.exceptions.ApiRequestError,
+    ) as err:
+        LOG.error(err)
+        sys.exit(1)
+
+
 # -- dds project status busy -- #
 @project_status.command(name="busy", no_args_is_help=False)
 # Flags

dds_cli/project_status.py

@@ -148,6 +148,112 @@ def update_status(self, new_status, deadline=None, is_aborted=False, no_mail=Fal
 
         dds_cli.utils.console.print(f"Project {response_json.get('message')}")
 
+    def extend_deadline(self):
+        """
+        Extend the project deadline
+        """
+        # Define initial parameters
+        extra_params = {"send_email": False}
+
+        # Fetch project status and default deadline
+        response_json, _ = dds_cli.utils.perform_request(
+            endpoint=DDSEndpoint.UPDATE_PROJ_STATUS,
+            headers=self.token,
+            method="patch",
+            params={"project": self.project},
+            json=extra_params,
+        )
+
+        # Structure of the response:
+        #   {
+        #   'default_unit_days': 30,
+        #   'project_info': {
+        #       'Created by': 'First Unit User',
+        #       'Description': 'This is a test project',
+        #       'Last updated': 'Wed, 18 Oct 2023 08:40:43 GMT',
+        #       'PI': '[email protected]',
+        #       'Project ID': 'project_1',
+        #       'Size': 0,
+        #       'Status': 'Available',
+        #       'Title': 'First Project'
+        #       },
+        #   'project_status': {
+        #       'current_deadline': 'Sat, 04 Nov 2023 23:59:59 GMT',
+        #       'current_status': 'Available'},
+        #   'warning': 'Operation must be confirmed before proceding.'
+        #   }
+
+        # Extract default unit days and current deadline
+        default_unit_days = response_json.get("default_unit_days")
+        current_deadline = response_json.get("project_status").get("current_deadline")
+
+        # print information about the project status and table with the project info
+        print_info = (
+            f"\nCurrent deadline: [b][green]{current_deadline}[/green][/b]\n"
+            f"Default deadline extension: [b][green]{default_unit_days}[/green][/b] days\n"
+        )
+        table = self.generate_project_table(project_info=response_json.get("project_info"))
+        dds_cli.utils.console.print(table)
+        dds_cli.utils.console.print(print_info)
+
+        # First question, number of days to extend the deadline
+        prompt_question = (
+            f"Enter the number of days you want to extend the project, "
+            f"the number of days has to be equal or same as "
+            f"[b][green]{default_unit_days}[/green][/b].\n"
+            f"Or leave it empty to apply the default "
+            f"[b][green]{default_unit_days} days [/green][/b]"
+        )
+
+        dds_cli.utils.console.print(prompt_question)
+        extend_deadline = rich.prompt.Prompt.ask("-")
+        if not extend_deadline:
+            # Set extend_deadline to default
+            extend_deadline = default_unit_days
+        try:
+            # the input was an string --> convert to integer
+            extend_deadline = int(extend_deadline)
+            if extend_deadline > default_unit_days:
+                dds_cli.utils.console.print(
+                    "\n[b][red]The number of days has to be lower than "
+                    "the default deadline extension number[/b][/red]\n"
+                )
+                LOG.info("Exiting the function, try again")
+                sys.exit(0)
+
+        except ValueError:
+            dds_cli.utils.console.print(
+                "\n[b][red]Remember to write the number of days "
+                "using numbers (dont use letters)[/b][/red]\n"
+            )
+            LOG.info("Exiting the function, try again")
+            sys.exit(0)
+
+        # Second question, confirm operation
+        prompt_question = (
+            f"\n\n[b][blue]Are you sure [/b][/blue]you want to perform this operation?. "
+            f"\nThis will extend the deadline by [b][blue]{extend_deadline} days[/b][/blue]."
+            "\nYou can only extend the data availability a maximum of "
+            "[b][blue]3 times[/b][/blue], this consumes one of those times."
+        )
+
+        dds_cli.utils.console.print(prompt_question)
+        if not rich.prompt.Confirm.ask("-"):
+            LOG.info("Probably for the best. Exiting.")
+            sys.exit(0)
+
+        # Update parameters for the second request
+        extra_params = {**extra_params, "confirmed": True, "new_deadline_in": extend_deadline}
+
+        response_json, _ = dds_cli.utils.perform_request(
+            endpoint=DDSEndpoint.UPDATE_PROJ_STATUS,
+            headers=self.token,
+            method="patch",
+            params={"project": self.project},
+            json=extra_params,
+        )
+        dds_cli.utils.console.print(f"Project {response_json.get('message')}")
+
 
 class ProjectBusyStatusManager(base.DDSBaseClass):
     """Project Busy Status manager class."""

dds_cli/utils.py

@@ -165,6 +165,8 @@ def perform_request(
         request_method = requests.post
     elif method == "delete":
         request_method = requests.delete
+    elif method == "patch":
+        request_method = requests.patch
 
     def transform_paths(json_input):
         """Make paths serializable."""