import awxkit

Co-authored-by: Christopher Wang <cwang@ansible.com>
Co-authored-by: Jake McDermott <jmcdermott@ansible.com>
Co-authored-by: Jim Ladd <jladd@redhat.com>
Co-authored-by: Elijah DeLee <kdelee@redhat.com>
Co-authored-by: Alan Rominger <arominge@redhat.com>
Co-authored-by: Yanis Guenane <yanis@guenane.org>

awxkit/awxkit/cli/custom.py

@@ -0,0 +1,216 @@
+from .stdout import monitor, monitor_workflow
+from .utils import CustomRegistryMeta, color_enabled
+
+
+def handle_custom_actions(resource, action, page):
+    key = ' '.join([resource, action])
+    if key in CustomAction.registry:
+        page = CustomAction.registry[key](page)
+        action = 'perform'
+    return page, action
+
+
+class CustomActionRegistryMeta(CustomRegistryMeta):
+
+    @property
+    def name(self):
+        return ' '.join([self.resource, self.action])
+
+
+class CustomAction(object, metaclass=CustomActionRegistryMeta):
+    """Base class for defining a custom action for a resource."""
+
+    def __init__(self, page):
+        self.page = page
+
+    @property
+    def action(self):
+        raise NotImplementedError()
+
+    @property
+    def resource(self):
+        raise NotImplementedError()
+
+    @property
+    def perform(self):
+        raise NotImplementedError()
+
+    def add_arguments(self, parser):
+        pass
+
+
+class Launchable(object):
+
+    def add_arguments(self, parser, with_pk=True):
+        if with_pk:
+            parser.choices[self.action].add_argument('id', type=int, help='')
+        parser.choices[self.action].add_argument(
+            '--monitor', action='store_true',
+            help='If set, prints stdout of the launched job until it finishes.'
+        )
+        parser.choices[self.action].add_argument(
+            '--timeout', type=int,
+            help='If set with --monitor or --wait, time out waiting on job completion.'  # noqa
+        )
+        parser.choices[self.action].add_argument(
+            '--wait', action='store_true',
+            help='If set, waits until the launched job finishes.'
+        )
+
+    def monitor(self, response, **kwargs):
+        mon = monitor_workflow if response.type == 'workflow_job' else monitor
+        if kwargs.get('monitor') or kwargs.get('wait'):
+            status = mon(
+                response,
+                self.page.connection.session,
+                print_stdout=not kwargs.get('wait'),
+                timeout=kwargs.get('timeout'),
+            )
+            if status:
+                response.json['status'] = status
+        return response
+
+    def perform(self, **kwargs):
+        response = self.page.get().related.get(self.action).post()
+        self.monitor(response, **kwargs)
+        return response
+
+
+class JobTemplateLaunch(Launchable, CustomAction):
+    action = 'launch'
+    resource = 'job_templates'
+
+
+class ProjectUpdate(Launchable, CustomAction):
+    action = 'update'
+    resource = 'projects'
+
+
+class ProjectCreate(CustomAction):
+    action = 'create'
+    resource = 'projects'
+
+    def add_arguments(self, parser):
+        parser.choices[self.action].add_argument(
+            '--monitor', action='store_true',
+            help=('If set, prints stdout of the project update until '
+                  'it finishes.')
+        )
+        parser.choices[self.action].add_argument(
+            '--wait', action='store_true',
+            help='If set, waits until the new project has updated.'
+        )
+
+    def post(self, kwargs):
+        should_monitor = kwargs.pop('monitor', False)
+        wait = kwargs.pop('wait', False)
+        response = self.page.post(kwargs)
+        if should_monitor or wait:
+            update = response.related.project_updates.get(
+                order_by='-created'
+            ).results[0]
+            monitor(
+                update,
+                self.page.connection.session,
+                print_stdout=not wait,
+            )
+        return response
+
+
+class InventoryUpdate(Launchable, CustomAction):
+    action = 'update'
+    resource = 'inventory_sources'
+
+
+class AdhocCommandLaunch(Launchable, CustomAction):
+    action = 'create'
+    resource = 'ad_hoc_commands'
+
+    def add_arguments(self, parser):
+        Launchable.add_arguments(self, parser, with_pk=False)
+
+    def perform(self, **kwargs):
+        monitor_kwargs = {
+            'monitor': kwargs.pop('monitor', False),
+            'wait': kwargs.pop('wait', False),
+        }
+        response = self.page.post(kwargs)
+        self.monitor(response, **monitor_kwargs)
+        return response
+
+    def post(self, kwargs):
+        return self.perform(**kwargs)
+
+
+class WorkflowLaunch(Launchable, CustomAction):
+    action = 'launch'
+    resource = 'workflow_job_templates'
+
+
+class HasStdout(object):
+
+    action = 'stdout'
+
+    def add_arguments(self, parser):
+        parser.choices['stdout'].add_argument('id', type=int, help='')
+
+    def perform(self):
+        fmt = 'txt_download'
+        if color_enabled():
+            fmt = 'ansi_download'
+        return self.page.connection.get(
+            self.page.get().related.stdout,
+            query_parameters=dict(format=fmt)
+        ).content.decode('utf-8')
+
+
+class JobStdout(HasStdout, CustomAction):
+    resource = 'jobs'
+
+
+class ProjectUpdateStdout(HasStdout, CustomAction):
+    resource = 'project_updates'
+
+
+class InventoryUpdateStdout(HasStdout, CustomAction):
+    resource = 'inventory_updates'
+
+
+class AdhocCommandStdout(HasStdout, CustomAction):
+    resource = 'ad_hoc_commands'
+
+
+class SettingsList(CustomAction):
+    action = 'list'
+    resource = 'settings'
+
+    def add_arguments(self, parser):
+        parser.choices['list'].add_argument(
+            '--slug', help='optional setting category/slug', default='all'
+        )
+
+    def perform(self, slug):
+        self.page.endpoint = self.page.endpoint + '{}/'.format(slug)
+        return self.page.get()
+
+
+class SettingsModify(CustomAction):
+    action = 'modify'
+    resource = 'settings'
+
+    def add_arguments(self, parser):
+        options = self.page.__class__(
+            self.page.endpoint + 'all/', self.page.connection
+        ).options()
+        parser.choices['modify'].add_argument(
+            'key',
+            choices=sorted(options['actions']['PUT'].keys()),
+            metavar='key',
+            help=''
+        )
+        parser.choices['modify'].add_argument('value', help='')
+
+    def perform(self, key, value):
+        self.page.endpoint = self.page.endpoint + 'all/'
+        resp = self.page.patch(**{key: value})
+        return resp.from_json({'key': key, 'value': resp[key]})