kaqing 2.0.145__py3-none-any.whl → 2.0.189__py3-none-any.whl

adam/commands/reaper/utils_reaper.py

@@ -0,0 +1,203 @@
+from collections.abc import Callable
+from functools import partial
+from typing import List, cast
+from kubernetes import client
+import re
+
+import requests
+from adam.config import Config
+from adam.repl_state import ReplState
+from adam.utils import tabulize, log2, wait_log
+from adam.utils_k8s.k8s import port_forwarding
+
+class ReaperService:
+    def __init__(self, state: ReplState, local_addr: str, remote_addr: str, show_out = True):
+        self.state = state
+        self.local_addr = local_addr
+        self.remote_addr = remote_addr
+        self.show_out = show_out
+        self.headers = None
+
+    def get(self, path: str, params: dict[str, any] = {}):
+        with logging(self, 'GET', path) as (url, headers):
+            return requests.get(url, headers=headers, params=params)
+
+    def put(self, path: str, params: dict[str, any] = {}):
+        with logging(self, 'PUT', path) as (url, headers):
+            return requests.put(url, headers=headers, params=params)
+
+    def post(self, path: str, params: dict[str, any] = {}):
+        with logging(self, 'POST', path) as (url, headers):
+            return requests.post(url, headers=headers, params=params)
+
+class ReaperLogginHandler:
+    def __init__(self, svc: ReaperService, method: str, path: str):
+        self.svc = svc
+        self.method = method
+        self.path = path
+
+    def __enter__(self) -> tuple[str, dict[str, any]]:
+        if not self.svc.headers:
+            self.svc.headers = Reapers.cookie_header(self.svc.state, self.svc.local_addr, self.svc.remote_addr, show_output=self.svc.show_out)
+
+        if self.svc.show_out and self.method:
+            log2(f'{self.method} {self.svc.remote_addr}/{self.path}')
+
+        return (f'http://{self.svc.local_addr}/{self.path}', self.svc.headers)
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        if exc_val and isinstance(exc_val, requests.Response):
+            if int(exc_val.status_code / 100) != 2:
+                if self.svc.show_out:
+                    log2(exc_val.status_code)
+
+        return False
+
+def logging(svc: ReaperService, method: str, path: str):
+    return ReaperLogginHandler(svc, method, path)
+
+class ReaperHandler:
+    def __init__(self, state: ReplState, show_out = True):
+        self.state = state
+        self.show_out = show_out
+        self.headers = None
+        self.forwarding = None
+
+    def __enter__(self):
+        self.forwarding = port_forwarding(self.state, Reapers.local_port(), partial(Reapers.svc_or_pod, self.state), Reapers.target_port())
+        (local_addr, remote_addr) = self.forwarding.__enter__()
+
+        return ReaperService(self.state, local_addr, remote_addr, show_out=self.show_out)
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        if self.forwarding:
+            return self.forwarding.__exit__(exc_type, exc_val, exc_tb)
+
+        return False
+
+def reaper(state: ReplState, show_out = True):
+    return ReaperHandler(state, show_out=show_out)
+
+class Reapers:
+    schedules_ids_by_cluster: dict[str, list[str]] = {}
+
+    def pod_name(state: ReplState):
+        pods = Reapers.list_reaper_pods(state.sts if state.sts else state.pod, state.namespace)
+        if pods:
+            return pods[0].metadata.name
+
+        return None
+
+    def show_schedule(state: ReplState, schedule_id: str):
+        def filter(schedules: list[dict]):
+            return [schedule for schedule in schedules if schedule['id'] == schedule_id]
+
+        Reapers.show_schedules(state, filter)
+
+    def show_schedules(state: ReplState, filter: Callable[[list[dict]], dict] = None):
+        schedules = Reapers.list_schedules(state, filter=filter)
+
+        # forced refresh of schedule list
+        if not filter:
+            Reapers.schedules_ids_by_cluster[state.sts] = [schedule['id'] for schedule in schedules]
+
+        tabulize(schedules, lambda s: f"{s['id']} {s['state']} {s['cluster_name']} {s['keyspace_name']}", header='ID STATE CLUSTER KEYSPACE', to=2)
+
+    def schedule_ids(state: ReplState, show_output = True, filter: Callable[[list[dict]], dict] = None):
+        schedules = Reapers.list_schedules(state, show_output=show_output, filter=filter)
+        return [schedule['id'] for schedule in schedules]
+
+    def list_schedules(state: ReplState, show_output = True, filter: Callable[[list[dict]], dict] = None) -> list[dict]:
+        with reaper(state, show_out=show_output) as requests:
+            if not (response := requests.get('repair_schedule')):
+                return
+
+            res = response.json()
+            if filter:
+                res = filter(res)
+
+            return res
+
+    def list_reaper_pods(sts_name: str, namespace: str) -> List[client.V1Pod]:
+        v1 = client.CoreV1Api()
+
+        # k8ssandra.io/reaper: cs-d0767a536f-cs-d0767a536f-reaper
+        groups = re.match(Config().get('reaper.pod.cluster-regex', r'(.*?-.*?-.*?-.*?)-.*'), sts_name)
+        label_selector = Config().get('reaper.pod.label-selector', 'k8ssandra.io/reaper={cluster}-reaper').replace('{cluster}', groups[1])
+
+        return cast(List[client.V1Pod], v1.list_namespaced_pod(namespace, label_selector=label_selector).items)
+
+    def cookie_header(state: ReplState, local_addr, remote_addr, show_output = True):
+        return {'Cookie': Reapers.login(state, local_addr, remote_addr, show_output=show_output)}
+
+    def login(state: ReplState, local_addr: str, remote_addr: str, show_output = True) -> str :
+        user, pw = state.user_pass(secret_path='reaper.secret')
+
+        response = requests.post(f'http://{local_addr}/login', headers={
+            'Accept': '*'
+        },data={
+            'username':user,
+            'password':pw})
+        if show_output:
+            log2(f'POST {remote_addr}/login')
+            log2(f'     username={user}&password={pw}')
+
+        if int(response.status_code / 100) != 2:
+            if show_output:
+                log2("login failed")
+            return None
+
+        return response.headers['Set-Cookie']
+
+    def reaper_spec(state: ReplState) -> dict[str, any]:
+        if not (pod := Reapers.pod_name(state)):
+            return {}
+
+        user, pw = state.user_pass(secret_path='reaper.secret')
+
+        return {
+            'pod': pod,
+            'exec': f'kubectl exec -it {pod} -n {state.namespace} -- bash',
+            'forward': f'kubectl port-forward pods/{pod} -n {state.namespace} {Reapers.local_port()}:{Reapers.target_port()}',
+            'web-uri': f'http://localhost:{Reapers.local_port()}/webui',
+            'username': user,
+            'password': pw
+        }
+
+    def cached_schedule_ids(state: ReplState) -> list[str]:
+        if state.sts in Reapers.schedules_ids_by_cluster:
+            return Reapers.schedules_ids_by_cluster[state.sts]
+
+        if pod := Reapers.pod_name(state):
+            wait_log('Inspecting Cassandra Reaper...')
+
+            schedules = Reapers.schedule_ids(state, show_output = False)
+            Reapers.schedules_ids_by_cluster[state.sts] = schedules
+
+            return schedules
+
+        return []
+
+    def svc_name():
+        return Config().get('reaper.service-name', 'reaper-service')
+
+    def local_port():
+        return Config().get('reaper.port-forward.local-port', 9001)
+
+    def target_port():
+        return 8080
+
+    def svc_or_pod(state: ReplState, is_service: bool):
+        if is_service:
+            return Reapers.svc_name()
+        else:
+            return Reapers.pod_name(state)
+
+    def schedules_auto_completion(ids: callable):
+        auto = Config().get('reaper.schedules-auto-complete', 'off')
+
+        leaf = None
+        if auto == 'on':
+            leaf = {id: None for id in ids()}
+
+        return (leaf, auto == 'lazy')

adam/commands/repair/repair.py

@@ -1,13 +1,12 @@
 import click
 
-from adam.commands.command import Command
+from adam.commands.intermediate_command import IntermediateCommand
 from .repair_run import RepairRun
 from .repair_scan import RepairScan
 from .repair_stop import RepairStop
 from .repair_log import RepairLog
-from adam.repl_state import ReplState, RequiredState
 
-class Repair(Command):
+class Repair(IntermediateCommand):
     COMMAND = 'repair'
 
     # the singleton pattern
@@ -16,29 +15,12 @@ class Repair(Command):
 
         return cls.instance
 
-    def __init__(self, successor: Command=None):
-        super().__init__(successor)
-
     def command(self):
         return Repair.COMMAND
 
-    def required(self):
-        return RequiredState.CLUSTER
-
-    def run(self, cmd: str, state: ReplState):
-        if not(args := self.args(cmd)):
-            return super().run(cmd, state)
-        if not self.validate_state(state):
-            return state
-
-        return super().intermediate_run(cmd, state, args, Repair.cmd_list())
-
-    def cmd_list():
+    def cmd_list(self):
         return [RepairRun(), RepairScan(), RepairStop(), RepairLog()]
 
-    def completion(self, state: ReplState):
-        return super().completion(state)
-
 class RepairCommandHelper(click.Command):
     def get_help(self, ctx: click.Context):
-        Command.intermediate_help(super().get_help(ctx), Repair.COMMAND, Repair.cmd_list(), show_cluster_help=True)
+        IntermediateCommand.intermediate_help(super().get_help(ctx), Repair.COMMAND, Repair().cmd_list(), show_cluster_help=True)

adam/commands/repair/repair_log.py

@@ -24,20 +24,14 @@ class RepairLog(Command):
         if not(args := self.args(cmd)):
             return super().run(cmd, state)
 
-        state, args = self.apply_state(args, state)
-        if not self.validate_state(state):
-            return state
-
-        ns = state.namespace
-        Jobs.get_logs('cassrepair-'+state.sts, ns)
+        with self.validate(args, state) as (args, state):
+            ns = state.namespace
+            Jobs.get_logs('cassrepair-'+state.sts, ns)
 
-        return state
+            return state
 
     def completion(self, state: ReplState):
-        if state.sts:
-            return super().completion(state)
-
-        return {}
+        return super().completion(state)
 
     def help(self, _: ReplState):
         return f'{RepairLog.COMMAND}\t get repair job logs'

adam/commands/repair/repair_run.py

@@ -1,12 +1,12 @@
 from adam.commands.command import Command
+from adam.commands.reaper.utils_reaper import Reapers
 from adam.utils_k8s.jobs import Jobs
 from adam.utils_k8s.volumes import Volumes
 from adam.repl_state import ReplState, RequiredState
 from adam.config import Config
-from adam.commands.reaper.reaper_session import ReaperSession
 from adam.commands.reaper.reaper_runs_abort import ReaperRunsAbort
 from adam.commands.reaper.reaper_schedule_stop import ReaperScheduleStop
-from adam.utils import log2
+from adam.utils import log2, log_exc
 
 class RepairRun(Command):
     COMMAND = 'repair run'
@@ -30,43 +30,36 @@ class RepairRun(Command):
         if not(args := self.args(cmd)):
             return super().run(cmd, state)
 
-        state, args = self.apply_state(args, state)
-        if not self.validate_state(state):
-            return state
-
-        replace = False
-        if len(args) == 1:
-            replace = args[0] == 'replace'
+        with self.validate(args, state) as (args, state):
+            replace = False
+            if len(args) == 1:
+                replace = args[0] == 'replace'
 
-        log2("Stopping all reaper schedules...")
-        reaper = ReaperSession.create(state)
-        schedules = reaper.schedule_ids(state)
-        for schedule_id in schedules:
-            ReaperScheduleStop().run(f'reaper stop schedule {schedule_id}', state)
-        log2("Aborting all reaper runs...")
-        state = ReaperRunsAbort().run('reaper abort runs', state)
+            with log_exc():
+                log2("Stopping all reaper schedules...")
+                for schedule_id in Reapers.cached_schedule_ids(state):
+                    ReaperScheduleStop().run(f'reaper stop schedule {schedule_id}', state)
+                log2("Aborting all reaper runs...")
+                state = ReaperRunsAbort().run('reaper abort runs', state)
 
-        image = Config().get('repair.image', 'ci-registry.c3iot.io/cloudops/cassrepair:2.0.11')
-        secret = Config().get('repair.secret', 'ciregistryc3iotio')
-        log_path = Config().get('repair.log-path', '/home/cassrepair/logs/')
-        user, _ = state.user_pass()
-        ns = state.namespace
-        env = Config().get('repair.env', {})
-        env["cluster"] = ns
-        env_from = {"username": user, "password": user}
-        pvc_name ='cassrepair-log-' + state.sts
-        Volumes.create_pvc(pvc_name, 30, ns)
-        if replace:
-            Jobs.delete('cassrepair-'+state.sts, ns)
-        Jobs.create('cassrepair-'+state.sts, ns, image, secret, env, env_from, 'cassrepair', pvc_name, log_path)
+            image = Config().get('repair.image', 'ci-registry.c3iot.io/cloudops/cassrepair:2.0.11')
+            secret = Config().get('repair.secret', 'ciregistryc3iotio')
+            log_path = Config().get('repair.log-path', '/home/cassrepair/logs/')
+            user, _ = state.user_pass()
+            ns = state.namespace
+            env = Config().get('repair.env', {})
+            env["cluster"] = ns
+            env_from = {"username": user, "password": user}
+            pvc_name ='cassrepair-log-' + state.sts
+            Volumes.create_pvc(pvc_name, 30, ns)
+            if replace:
+                Jobs.delete('cassrepair-'+state.sts, ns)
+            Jobs.create('cassrepair-'+state.sts, ns, image, secret, env, env_from, 'cassrepair', pvc_name, log_path)
 
-        return state
+            return state
 
     def completion(self, state: ReplState):
-        if state.sts:
-            return super().completion(state)
-
-        return {}
+        return super().completion(state)
 
     def help(self, _: ReplState):
         return f'{RepairRun.COMMAND} [replace]\t start a repair job, default not replacing'

adam/commands/repair/repair_scan.py

@@ -1,5 +1,3 @@
-import time
-
 from adam.commands.command import Command
 from adam.utils_k8s.pods import Pods
 from adam.repl_state import ReplState, RequiredState
@@ -28,47 +26,41 @@ class RepairScan(Command):
         if not(args := self.args(cmd)):
             return super().run(cmd, state)
 
-        state, args = self.apply_state(args, state)
-        if not self.validate_state(state):
-            return state
-
-        n = "7"
-        if len(args) == 1:
-            n = str(args[0])
-        image = Config().get('repair.image', 'ci-registry.c3iot.io/cloudops/cassrepair:2.0.11')
-        secret = Config().get('repair.secret', 'ciregistryc3iotio')
-        log_path = secret = Config().get('repair.log-path', '/home/cassrepair/logs/')
-        ns = state.namespace
-        pvc_name ='cassrepair-log-' + state.sts
-        pod_name = 'repair-scan'
-
-        try:
-            Pods.create(ns, pod_name, image, ["sh", "-c", "tail -f /dev/null"],
-                       secret=secret,
-                       env={},
-                       volume_name='cassrepair-log',
-                       pvc_name=pvc_name,
-                       mount_path='/home/cassrepair/logs/')
-        except Exception as e:
-            if e.status == 409:
-                log2(f"Pod {pod_name} already exists")
-            else:
-                log2("Exception when calling BatchV1Apii->create_namespaced_job: %s\n" % e)
+        with self.validate(args, state) as (args, state):
+            n = "7"
+            if len(args) == 1:
+                n = str(args[0])
+            image = Config().get('repair.image', 'ci-registry.c3iot.io/cloudops/cassrepair:2.0.11')
+            secret = Config().get('repair.secret', 'ciregistryc3iotio')
+            log_path = secret = Config().get('repair.log-path', '/home/cassrepair/logs/')
+            ns = state.namespace
+            pvc_name ='cassrepair-log-' + state.sts
+            pod_name = 'repair-scan'
+
+            try:
+                Pods.create(ns, pod_name, image, ["sh", "-c", "tail -f /dev/null"],
+                        secret=secret,
+                        env={},
+                        volume_name='cassrepair-log',
+                        pvc_name=pvc_name,
+                        mount_path='/home/cassrepair/logs/')
+            except Exception as e:
+                if e.status == 409:
+                    log2(f"Pod {pod_name} already exists")
+                else:
+                    log2("Exception when calling BatchV1Apii->create_namespaced_job: %s\n" % e)
+
+            Pods.wait_for_running(ns, pod_name, 'Waiting for the scanner pod to start up...')
+
+            try:
+                Pods.exec(pod_name, pod_name, ns, f"find {log_path} -type f -mtime -{n} -print0 | xargs -0 grep failed")
+            finally:
+                Pods.delete(pod_name, ns)
 
-        Pods.wait_for_running(ns, pod_name, 'Waiting for the scanner pod to start up...')
-
-        try:
-            Pods.exec(pod_name, pod_name, ns, f"find {log_path} -type f -mtime -{n} -print0 | xargs -0 grep failed")
-        finally:
-            Pods.delete(pod_name, ns)
-
-        return state
+            return state
 
     def completion(self, state: ReplState):
-        if state.sts:
-            return super().completion(state)
-
-        return {}
+        return super().completion(state)
 
     def help(self, _: ReplState):
         return f'{RepairScan.COMMAND} [n]\t scan last n days repair log, default 7 days'

adam/commands/repair/repair_stop.py

@@ -1,7 +1,6 @@
 from adam.commands.command import Command
 from adam.utils_k8s.jobs import Jobs
 from adam.repl_state import ReplState, RequiredState
-from adam.config import Config
 
 class RepairStop(Command):
     COMMAND = 'repair stop'
@@ -25,20 +24,14 @@ class RepairStop(Command):
         if not(args := self.args(cmd)):
             return super().run(cmd, state)
 
-        state, args = self.apply_state(args, state)
-        if not self.validate_state(state):
-            return state
-
-        ns = state.namespace
-        Jobs.delete('cassrepair-'+state.sts, ns)
+        with self.validate(args, state) as (args, state):
+            ns = state.namespace
+            Jobs.delete('cassrepair-'+state.sts, ns)
 
-        return state
+            return state
 
     def completion(self, state: ReplState):
-        if state.sts:
-            return super().completion(state)
-
-        return {}
+        return super().completion(state)
 
     def help(self, _: ReplState):
         return f'{RepairStop.COMMAND}\t delete a repair job'

adam/commands/report.py

@@ -29,35 +29,33 @@ class Report(Command):
         if not(args := self.args(cmd)):
             return super().run(cmd, state)
 
-        output: dict[str, any] = {}
-        state, args = self.apply_state(args, state)
-        if not self.validate_state(state):
-            return state
-
-        if state.in_repl:
-            args, show = Command.extract_options(args, ['-s', '--show'])
-
-            args, redirect = Command.extract_options(args, ['>'])
-            if not redirect or not args:
-                log2('Please specify file name: e.g. report > /tmp/report.log')
-                return 'no-report-destination'
-
-            results = run_checks(state.sts, state.namespace, state.pod, show_output=show)
-            output = CheckResult.report(results)
-            with open(args[0], "w") as json_file:
-                json.dump(output, json_file, indent=2)
-                log2(f'Report stored in {args[0]}.')
-        else:
-            args, show = Command.extract_options(args, ['-s', '--show'])
-
-            results = run_checks(state.sts, state.namespace, state.pod, show_output=show)
-            output = CheckResult.report(results)
-            click.echo(json.dumps(output, indent=2))
-
-        return output
-
-    def completion(self, _: ReplState):
-        return {Report.COMMAND: {">": None}}
+        with self.validate(args, state) as (args, state):
+            output: dict[str, any] = {}
+
+            if state.in_repl:
+                args, show = Command.extract_options(args, ['-s', '--show'])
+
+                args, redirect = Command.extract_options(args, ['>'])
+                if not redirect or not args:
+                    log2('Please specify file name: e.g. report > /tmp/report.log')
+                    return 'no-report-destination'
+
+                results = run_checks(state.sts, state.namespace, state.pod, show_out=show)
+                output = CheckResult.report(results)
+                with open(args[0], "w") as json_file:
+                    json.dump(output, json_file, indent=2)
+                    log2(f'Report stored in {args[0]}.')
+            else:
+                args, show = Command.extract_options(args, ['-s', '--show'])
+
+                results = run_checks(state.sts, state.namespace, state.pod, show_out=show)
+                output = CheckResult.report(results)
+                click.echo(json.dumps(output, indent=2))
+
+            return output
+
+    def completion(self, state: ReplState):
+        return super().completion(state, {">": None})
 
     def help(self, _: ReplState):
         return f"{Report.COMMAND} > <file-name>\t generate report"

adam/commands/restart.py

@@ -1,3 +1,4 @@
+from adam.commands import extract_options
 from adam.commands.command import Command
 from adam.utils_k8s.pods import Pods
 from adam.utils_k8s.statefulsets import StatefulSets
@@ -26,34 +27,32 @@ class Restart(Command):
         if not(args := self.args(cmd)):
             return super().run(cmd, state)
 
-        state, args = self.apply_state(args, state)
-        if not self.validate_state(state):
-            return state
-
-        args, forced = Command.extract_options(args, '--force')
-        if not args:
-            if state.pod:
-                log2(f'Restarting {state.pod}...')
-                Pods.delete(state.pod, state.namespace)
-            else:
-                if not forced:
-                    log2('Please add --force for restarting all nodes in a cluster.')
-                    return 'force-needed'
-
-                log2(f'Restarting all pods from {state.sts}...')
-                for pod_name in StatefulSets.pod_names(state.sts, state.namespace):
-                    Pods.delete(pod_name, state.namespace)
-        else:
-            for arg in args:
-                Pods.delete(arg, state.namespace)
-
-        return state
+        with self.validate(args, state) as (args, state):
+            with extract_options(args, '--force') as (args, forced):
+                if not args:
+                    if state.pod:
+                        log2(f'Restarting {state.pod}...')
+                        Pods.delete(state.pod, state.namespace)
+                    else:
+                        if not forced:
+                            log2('Please add --force for restarting all nodes in a cluster.')
+                            return 'force-needed'
+
+                        log2(f'Restarting all pods from {state.sts}...')
+                        for pod_name in StatefulSets.pod_names(state.sts, state.namespace):
+                            Pods.delete(pod_name, state.namespace)
+                else:
+                    for arg in args:
+                        Pods.delete(arg, state.namespace)
+
+                return state
 
     def completion(self, state: ReplState):
-        if state.pod:
-            return {Restart.COMMAND: None}
-        elif state.sts:
-            return {Restart.COMMAND: {p: None for p in StatefulSets.pod_names(state.sts, state.namespace)}}
+        if super().completion(state):
+            if state.pod:
+                return {Restart.COMMAND: None}
+            elif state.sts:
+                return {Restart.COMMAND: {p: None for p in StatefulSets.pod_names(state.sts, state.namespace)}}
 
         return {}