add disabled parameter and support for tags

Author: marioaxonops

cli/README.md

@@ -144,9 +144,12 @@ Manages **Scheduled Repair** in AxonOps.
 * `--optimisestreams` Optimize Streams during repair (require Cassandra 4.1+).
 * `--datacenters` Comma-separated list of datacenters to include in the repair. If not set, all datacenters will be
   included.
-* `--tags` Tags to associate with the scheduled repair job.
+* `--tags` Tags to associate with the scheduled repair job. Tags are used to identify repair jobs in AxonOps.
+  This parameter accepts a string value.
 * `--paxosonly` Run paxos repair only. Default is false.
 * `--skippaxos` Skip paxos repair. Default is false.
+* `--delete` Delete Scheduled Repair. This option needs to be paired with a tags value to identify which scheduled
+  repair job to disable.
 
 #### Examples:
 
@@ -261,4 +264,10 @@ Run a scheduled repair skipping paxos repair with a cron expression:
 
 ```shell
 $ pipenv run python axonops.py scheduledrepair --scheduleexpr '0 0 * * 0' --paxosonly
+```
+
+Delete a scheduled repair job with specific tags:
+
+```shell
+$ pipenv run python axonops.py scheduledrepair --delete --tags 'Weekly repair'
 ```

cli/axonopscli/application.py

@@ -119,26 +119,30 @@ def run(self, argv: Sequence):
         scheduledrepair_parser.add_argument('--datacenters', type=str, required=False,
                                             help='Comma-separated list of datacenters to repair, if not specified all datacenters are included')
         scheduledrepair_parser.add_argument('--tags', type=str, required=False,
-                                            help='Tag for the repair job')
+                                            help='Tag for the repair job', default="")
+        scheduledrepair_parser.add_argument('--delete', action='store_true',
+                                            help='Delete the scheduled repair instead of enabling it')
 
         paxos_group = scheduledrepair_parser.add_mutually_exclusive_group()
         paxos_group.add_argument('--paxosonly', action='store_true', default=False,
-                                            help='Run only Paxos repairs')
+                                 help='Run only Paxos repairs')
         paxos_group.add_argument('--skippaxos', action='store_true', default=False,
-                                            help='Skip Paxos repairs')
+                                 help='Skip Paxos repairs')
 
         parsed_result: argparse.Namespace = parser.parse_args(args=argv)
 
         # ensure --tables is only used together with --keyspace
         if getattr(parsed_result, "tables", None) and not getattr(parsed_result, "keyspace", None):
             parser.error("--tables requires --keyspace")
 
+        # ensure --disabled is only used together with tags
+        if getattr(parsed_result, "delete", None) and not getattr(parsed_result, "tags", None):
+            parser.error("--delete requires --tags")
+
         # ensure --excludedtables is only used together with --keyspace
         if getattr(parsed_result, "excludedtables", None) and not getattr(parsed_result, "keyspace", None):
             parser.error("--excludedtables requires --keyspace")
 
-
-
         # if func() is not present it means that no command was inserted
         if hasattr(parsed_result, 'func'):
             self.run_mandatory_args_check(parsed_result)
@@ -203,6 +207,8 @@ def run_scheduled_repair(self, args: argparse.Namespace):
 
         scheduled_repair = ScheduledRepair(axonops, args)
 
+        scheduled_repair.remove_old_repairs_from_axonops()
+
         scheduled_repair.set_options()
 
         scheduled_repair.set_repair()

cli/axonopscli/axonops.py

@@ -1,12 +1,9 @@
 import json
 import urllib.parse
 from typing import List
-
 import requests
 
-
-class HTTPCodeError(Exception):
-    pass
+from .utils import HTTPCodeError
 
 
 class AxonOps:

cli/axonopscli/components/scheduled_repair.py

@@ -1,12 +1,49 @@
+from axonopscli.axonops import HTTPCodeError
+
+
 class ScheduledRepair:
     """ Class to manage the Scheduled Repair in AxonOps """
     schedule_repair_add_url = "/api/v1/addrepair"
+    repair_url = "/api/v1/repair"
+    cassandrascheduledrepair_url = "/api/v1/cassandrascheduledrepair"
 
     def __init__(self, axonops, args):
         self.axonops = axonops
         self.args = args
         self.repair_data = None
-        self.full_url = f"{self.schedule_repair_add_url}/{args.org}/cassandra/{args.cluster}"
+        self.full_add_repair_url = f"{self.schedule_repair_add_url}/{args.org}/cassandra/{args.cluster}"
+        self.full_repair_url = f"{self.repair_url}/{args.org}/cassandra/{args.cluster}"
+        self.full_cassandrascheduledrepair_url = f"{self.cassandrascheduledrepair_url}/{args.org}/cassandra/{args.cluster}"
+
+    def remove_old_repairs_from_axonops(self):
+        """ Check if the scheduled repair already exists in AxonOps, if so, remove it. """
+        if self.args.v:
+            print("Checking if scheduled repair already exists")
+
+        if self.args.tags != "":
+            if self.args.v:
+                print("Getting scheduled repair with tag:", self.args.tags)
+            response = self.axonops.do_request(
+                url=self.full_repair_url,
+                method='GET',
+            )
+            if not response:
+                if self.args.v:
+                    print("No response received when checking for existing scheduled repair")
+                return
+            elif 'ScheduledRepairs' in response and response['ScheduledRepairs']:
+                for repair in response['ScheduledRepairs']:
+                    if self.args.v:
+                        print(f"Checking scheduled repair: {repair['ID']}")
+                    self.remove_repair(repair['ID'])
+                    if 'Params' in repair:
+                        print(repair['Params'])
+
+            else:
+                print("Repair tag not found, this will be threaded as a new scheduled repair")
+        else:
+            if self.args.v:
+                print("No tag provided, this will be threaded as a new scheduled repair")
 
     def set_options(self):
         """Apply optional CLI parameters into the payload before sending it."""
@@ -59,13 +96,36 @@ def set_options(self):
             self.repair_data['paxos'] = "Paxos Only"
 
     def set_repair(self):
-        full_url = f"{self.axonops.dash_url()}{self.schedule_repair_add_url}"
         print("Setting the scheduled repair")
         if self.args.v:
-            print("POST", self.full_url, self.repair_data)
+            print("POST", self.full_add_repair_url, self.repair_data)
+
+        if self.args.delete:
+            if self.args.v:
+                print("This scheduled repair is delete, not sending to AxonOps")
+            return
 
         self.axonops.do_request(
-            url=self.full_url,
+            url=self.full_add_repair_url,
             method='POST',
             json_data=self.repair_data,
         )
+
+    def remove_repair(self, repair_id: str) -> bool:
+        """ Remove a scheduled repair from AxonOps by its ID. """
+        if self.args.v:
+            print(f"Removing scheduled repair with ID: {repair_id}")
+
+        try:
+            response = self.axonops.do_request(
+                url=f"{self.full_cassandrascheduledrepair_url}?id={repair_id}",
+                method='DELETE',
+            )
+        except HTTPCodeError:
+            print(f"Failed to remove scheduled repair with ID: {repair_id}")
+            raise
+        else:
+            if self.args.v:
+                print(f"Response received when removing scheduled repair with ID: {repair_id}: {response}")
+
+            return True

cli/axonopscli/utils.py

@@ -1,4 +1,7 @@
+class HTTPCodeError(Exception):
+    pass
+
+
 def remove_not_alphanumeric(s: str) -> str:
     """Remove non-alphanumeric characters from a string."""
     return ''.join(c for c in s if c.isalnum())
-