Merge pull request #206 from AlanCoding/new_names2

Change awx-manage command names (try #2)

awx/main/management/commands/deprovision_instance.py

@@ -0,0 +1,52 @@
+# Copyright (c) 2016 Ansible, Inc.
+# All Rights Reserved
+
+from optparse import make_option
+import subprocess
+import warnings
+
+from django.db import transaction
+from django.core.management.base import BaseCommand, CommandError
+
+from awx.main.models import Instance
+from awx.main.utils.pglock import advisory_lock
+
+
+class Command(BaseCommand):
+    """
+    Deprovision a Tower cluster node
+    """
+
+    option_list = BaseCommand.option_list + (
+        make_option('--hostname', dest='hostname', type='string',
+                    help='Hostname used during provisioning'),
+        make_option('--name', dest='name', type='string',
+                    help='(PENDING DEPRECIATION) Hostname used during provisioning'),
+    )
+
+    @transaction.atomic
+    def handle(self, *args, **options):
+        # TODO: remove in 3.3
+        if options.get('name'):
+            warnings.warn("`--name` is depreciated in favor of `--hostname`, and will be removed in release 3.3.")
+            if options.get('hostname'):
+                raise CommandError("Cannot accept both --name and --hostname.")
+            options['hostname'] = options['name']
+        hostname = options.get('hostname')
+        if not hostname:
+            raise CommandError("--hostname is a required argument")
+        with advisory_lock('instance_registration_%s' % hostname):
+            instance = Instance.objects.filter(hostname=hostname)
+            if instance.exists():
+                instance.delete()
+                print("Instance Removed")
+                result = subprocess.Popen("rabbitmqctl forget_cluster_node rabbitmq@{}".format(hostname), shell=True).wait()
+                if result != 0:
+                    print("Node deprovisioning may have failed when attempting to "
+                          "remove the RabbitMQ instance {} from the cluster".format(hostname))
+                else:
+                    print('Successfully deprovisioned {}'.format(hostname))
+                print('(changed: True)')
+            else:
+                print('No instance found matching name {}'.format(hostname))
+

awx/main/management/commands/deprovision_node.py

@@ -1,42 +1,17 @@
-# Copyright (c) 2016 Ansible, Inc.
+# Copyright (c) 2017 Ansible by Red Hat
 # All Rights Reserved
 
-from optparse import make_option
-import subprocess
+# Borrow from another AWX command
+from awx.main.management.commands.deprovision_instance import Command as OtherCommand
 
-from django.db import transaction
-from django.core.management.base import BaseCommand, CommandError
-
-from awx.main.models import Instance
-from awx.main.utils.pglock import advisory_lock
+# Python
+import warnings
 
 
-class Command(BaseCommand):
-    """
-    Deprovision a Tower cluster node
-    """
+class Command(OtherCommand):
 
-    option_list = BaseCommand.option_list + (
-        make_option('--name', dest='name', type='string',
-                    help='Hostname used during provisioning'),
-    )
-
-    @transaction.atomic
     def handle(self, *args, **options):
-        hostname = options.get('name')
-        if not hostname:
-            raise CommandError("--name is a required argument")
-        with advisory_lock('instance_registration_%s' % hostname):
-            instance = Instance.objects.filter(hostname=hostname)
-            if instance.exists():
-                instance.delete()
-                print("Instance Removed")
-                result = subprocess.Popen("rabbitmqctl forget_cluster_node rabbitmq@{}".format(hostname), shell=True).wait()
-                if result != 0:
-                    print("Node deprovisioning may have failed when attempting to remove the RabbitMQ instance from the cluster")
-                else:
-                    print('Successfully deprovisioned {}'.format(hostname))
-                print('(changed: True)')
-            else:
-                print('No instance found matching name {}'.format(hostname))
-
+        # TODO: delete this entire file in 3.3
+        warnings.warn('This command is replaced with `deprovision_instance` and will '
+                      'be removed in release 3.3.')
+        return super(Command, self).handle(*args, **options)

awx/main/management/commands/provision_instance.py

@@ -0,0 +1,45 @@
+# Copyright (c) 2015 Ansible, Inc.
+# All Rights Reserved
+
+from awx.main.models import Instance
+from awx.main.utils.pglock import advisory_lock
+from django.conf import settings
+
+from optparse import make_option
+from django.db import transaction
+from django.core.management.base import BaseCommand, CommandError
+
+
+class Command(BaseCommand):
+    """
+    Internal tower command.
+    Regsiter this instance with the database for HA tracking.
+    """
+
+    option_list = BaseCommand.option_list + (
+        make_option('--hostname', dest='hostname', type='string',
+                    help='Hostname used during provisioning'),
+    )
+
+    def _register_hostname(self, hostname):
+        if not hostname:
+            return
+        with advisory_lock('instance_registration_%s' % hostname):
+            instance = Instance.objects.filter(hostname=hostname)
+            if instance.exists():
+                print("Instance already registered {}".format(instance[0].hostname))
+                return
+            instance = Instance(uuid=self.uuid, hostname=hostname)
+            instance.save()
+        print('Successfully registered instance {}'.format(hostname))
+        self.changed = True
+
+    @transaction.atomic
+    def handle(self, **options):
+        if not options.get('hostname'):
+            raise CommandError("Specify `--hostname` to use this command.")
+        self.uuid = settings.SYSTEM_UUID
+        self.changed = False
+        self._register_hostname(options.get('hostname'))
+        if self.changed:
+            print('(changed: True)')

awx/main/management/commands/register_instance.py

@@ -1,45 +1,17 @@
-# Copyright (c) 2015 Ansible, Inc.
+# Copyright (c) 2017 Ansible by Red Hat
 # All Rights Reserved
 
-from awx.main.models import Instance
-from awx.main.utils.pglock import advisory_lock
-from django.conf import settings
+# Borrow from another AWX command
+from awx.main.management.commands.provision_instance import Command as OtherCommand
 
-from optparse import make_option
-from django.db import transaction
-from django.core.management.base import BaseCommand, CommandError
+# Python
+import warnings
 
 
-class Command(BaseCommand):
-    """
-    Internal tower command.
-    Regsiter this instance with the database for HA tracking.
-    """
+class Command(OtherCommand):
 
-    option_list = BaseCommand.option_list + (
-        make_option('--hostname', dest='hostname', type='string',
-                    help='Hostname used during provisioning'),
-    )
-
-    def _register_hostname(self, hostname):
-        if not hostname:
-            return
-        with advisory_lock('instance_registration_%s' % hostname):
-            instance = Instance.objects.filter(hostname=hostname)
-            if instance.exists():
-                print("Instance already registered {}".format(instance[0].hostname))
-                return
-            instance = Instance(uuid=self.uuid, hostname=hostname)
-            instance.save()
-        print('Successfully registered instance {}'.format(hostname))
-        self.changed = True
-
-    @transaction.atomic
-    def handle(self, **options):
-        if not options.get('hostname'):
-            raise CommandError("Specify `--hostname` to use this command.")
-        self.uuid = settings.SYSTEM_UUID
-        self.changed = False
-        self._register_hostname(options.get('hostname'))
-        if self.changed:
-            print('(changed: True)')
+    def handle(self, *args, **options):
+        # TODO: delete this entire file in 3.3
+        warnings.warn('This command is replaced with `provision_instance` and will '
+                      'be removed in release 3.3.')
+        return super(Command, self).handle(*args, **options)