From a61a3538291812de5032bc383e662c000e33741e Mon Sep 17 00:00:00 2001 From: Chris Church Date: Fri, 29 Mar 2013 01:02:07 -0400 Subject: [PATCH] Start on tests for inventory command and celery task, stub for playbook callback module. --- lib/main/management/__init__.py | 16 + .../management/commands/acom_inventory.py | 64 ++-- lib/main/migrations/0007_changes.py | 285 ++++++++++++++++++ lib/main/models/__init__.py | 64 +++- lib/main/tasks.py | 25 +- lib/main/tests/__init__.py | 21 +- lib/main/tests/commands.py | 82 +++++ lib/main/tests/organizations.py | 1 - lib/main/tests/tasks.py | 28 ++ lib/plugins/callback/acom_callback.py | 86 ++++++ 10 files changed, 626 insertions(+), 46 deletions(-) create mode 100644 lib/main/migrations/0007_changes.py create mode 100644 lib/main/tests/commands.py create mode 100644 lib/main/tests/tasks.py create mode 100644 lib/plugins/callback/acom_callback.py diff --git a/lib/main/management/__init__.py b/lib/main/management/__init__.py index e69de29bb2..5adf0ca3e8 100644 --- a/lib/main/management/__init__.py +++ b/lib/main/management/__init__.py @@ -0,0 +1,16 @@ +# (c) 2013, AnsibleWorks +# +# This file is part of Ansible Commander +# +# Ansible Commander is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible Commander is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible Commander. If not, see . diff --git a/lib/main/management/commands/acom_inventory.py b/lib/main/management/commands/acom_inventory.py index 6c03d34a7c..7a80638738 100755 --- a/lib/main/management/commands/acom_inventory.py +++ b/lib/main/management/commands/acom_inventory.py @@ -31,7 +31,7 @@ class Command(NoArgsCommand): option_list = NoArgsCommand.option_list + ( make_option('-i', '--inventory', dest='inventory', type='int', default=0, help='Inventory ID (can also be specified using ' - 'ACOM_INVENTORY environment variable)'), + 'ACOM_INVENTORY_ID environment variable)'), make_option('--list', action='store_true', dest='list', default=False, help='Return JSON hash of host groups.'), make_option('--host', dest='host', default='', @@ -44,7 +44,6 @@ class Command(NoArgsCommand): groups = {} for group in inventory.groups.all(): # FIXME: Check if group is active? - group_info = { 'hosts': list(group.hosts.values_list('name', flat=True)), 'children': list(group.children.values_list('name', flat=True)), @@ -70,42 +69,49 @@ class Command(NoArgsCommand): hostvars = {} if host.variables is not None: hostvars = json.loads(host.variables.data) - # FIXME: Do we also need to include variables defined for groups of which - # this host is a member? (MPD: pretty sure we don't!) self.stdout.write(json.dumps(hostvars, indent=indent)) def handle_noargs(self, **options): - from lib.main.models import Inventory try: - inventory_id = int(os.getenv('ACOM_INVENTORY', options.get('inventory', 0))) - except ValueError: - raise CommandError('Inventory ID must be an integer') - if not inventory_id: - raise CommandError('No inventory ID specified') - try: - inventory = Inventory.objects.get(id=inventory_id) - except Inventory.DoesNotExist: - raise CommandError('Inventory with ID %d not found' % inventory_id) - list_ = options.get('list', False) - host = options.get('host', '') - indent = options.get('indent', None) - if list_ and host: - raise CommandError('Only one of --list or --host can be specified') - elif list_: - self.get_list(inventory, indent=indent) - elif host: - self.get_host(inventory, host, indent=indent) - else: - self.stderr.write('Either --list or --host must be specified') - self.print_help() + from lib.main.models import Inventory + try: + inventory_id = int(os.getenv('ACOM_INVENTORY_ID', options.get('inventory', 0))) + except ValueError: + raise CommandError('Inventory ID must be an integer') + if not inventory_id: + raise CommandError('No inventory ID specified') + try: + inventory = Inventory.objects.get(id=inventory_id) + except Inventory.DoesNotExist: + raise CommandError('Inventory with ID %d not found' % inventory_id) + list_ = options.get('list', False) + host = options.get('host', '') + indent = options.get('indent', None) + if list_ and host: + raise CommandError('Only one of --list or --host can be specified') + elif list_: + self.get_list(inventory, indent=indent) + elif host: + self.get_host(inventory, host, indent=indent) + else: + self.stderr.write('Either --list or --host must be specified') + self.print_help() + except CommandError: + self.stdout.write(json.dumps({})) + raise if __name__ == '__main__': - # FIXME: This environment variable *should* already be set if this script - # is called from a celery task. Probably won't work otherwise. + # FIXME: Not particularly fond of this sys.path hack, but it is needed + # when a celery task calls ansible-playback and needs to execute this + # script directly. try: import lib.settings except ImportError: - sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', '..', '..'))) + top_dir = os.path.join(os.path.dirname(__file__), '..', '..', '..', '..') + sys.path.insert(0, os.path.abspath(top_dir)) + # FIXME: The DJANGO_SETTINGS_MODULE environment variable *should* already + # be set if this script is called from a celery task. Probably won't work + # otherwise. os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'lib.settings') from django.core.management import execute_from_command_line argv = [sys.argv[0], 'acom_inventory'] + sys.argv[1:] diff --git a/lib/main/migrations/0007_changes.py b/lib/main/migrations/0007_changes.py new file mode 100644 index 0000000000..5d7fd101a9 --- /dev/null +++ b/lib/main/migrations/0007_changes.py @@ -0,0 +1,285 @@ +# -*- coding: utf-8 -*- +import datetime +from south.db import db +from south.v2 import SchemaMigration +from django.db import models + + +class Migration(SchemaMigration): + + def forwards(self, orm): + # Deleting field 'LaunchJobStatus.result_data' + db.delete_column(u'main_launchjobstatus', 'result_data') + + # Adding field 'LaunchJobStatus.result_stdout' + db.add_column(u'main_launchjobstatus', 'result_stdout', + self.gf('django.db.models.fields.TextField')(default='', blank=True), + keep_default=False) + + # Adding field 'LaunchJobStatus.result_stderr' + db.add_column(u'main_launchjobstatus', 'result_stderr', + self.gf('django.db.models.fields.TextField')(default='', blank=True), + keep_default=False) + + # Adding field 'LaunchJobStatus.celery_task' + db.add_column(u'main_launchjobstatus', 'celery_task', + self.gf('django.db.models.fields.related.ForeignKey')(related_name='launch_job_statuses', on_delete=models.SET_NULL, default=None, to=orm['djcelery.TaskMeta'], blank=True, null=True), + keep_default=False) + + + # Changing field 'LaunchJobStatus.status' + db.alter_column(u'main_launchjobstatus', 'status', self.gf('django.db.models.fields.CharField')(max_length=20)) + + def backwards(self, orm): + # Adding field 'LaunchJobStatus.result_data' + db.add_column(u'main_launchjobstatus', 'result_data', + self.gf('django.db.models.fields.TextField')(default='_'), + keep_default=False) + + # Deleting field 'LaunchJobStatus.result_stdout' + db.delete_column(u'main_launchjobstatus', 'result_stdout') + + # Deleting field 'LaunchJobStatus.result_stderr' + db.delete_column(u'main_launchjobstatus', 'result_stderr') + + # Deleting field 'LaunchJobStatus.celery_task' + db.delete_column(u'main_launchjobstatus', 'celery_task_id') + + + # Changing field 'LaunchJobStatus.status' + db.alter_column(u'main_launchjobstatus', 'status', self.gf('django.db.models.fields.IntegerField')()) + + models = { + u'auth.group': { + 'Meta': {'object_name': 'Group'}, + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}), + 'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}) + }, + u'auth.permission': { + 'Meta': {'ordering': "(u'content_type__app_label', u'content_type__model', u'codename')", 'unique_together': "((u'content_type', u'codename'),)", 'object_name': 'Permission'}, + 'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}), + 'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['contenttypes.ContentType']"}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'max_length': '50'}) + }, + u'auth.user': { + 'Meta': {'object_name': 'User'}, + 'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}), + 'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}), + 'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}), + 'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}), + 'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}), + 'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}), + 'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}), + 'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'}) + }, + u'contenttypes.contenttype': { + 'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"}, + 'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}), + 'name': ('django.db.models.fields.CharField', [], {'max_length': '100'}) + }, + u'djcelery.taskmeta': { + 'Meta': {'object_name': 'TaskMeta', 'db_table': "'celery_taskmeta'"}, + 'date_done': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'blank': 'True'}), + 'hidden': ('django.db.models.fields.BooleanField', [], {'default': 'False', 'db_index': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'meta': ('djcelery.picklefield.PickledObjectField', [], {'default': 'None', 'null': 'True'}), + 'result': ('djcelery.picklefield.PickledObjectField', [], {'default': 'None', 'null': 'True'}), + 'status': ('django.db.models.fields.CharField', [], {'default': "'PENDING'", 'max_length': '50'}), + 'task_id': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '255'}), + 'traceback': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}) + }, + 'main.audittrail': { + 'Meta': {'object_name': 'AuditTrail'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'audit_trail': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'audittrail_audit_trails'", 'blank': 'True', 'to': "orm['main.AuditTrail']"}), + 'comment': ('django.db.models.fields.TextField', [], {}), + 'created_by': ('django.db.models.fields.related.ForeignKey', [], {'related_name': '"{\'class\': \'audittrail\', \'app_label\': \'main\'}(class)s_created"', 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}), + 'creation_date': ('django.db.models.fields.DateField', [], {'auto_now_add': 'True', 'blank': 'True'}), + 'delta': ('django.db.models.fields.TextField', [], {}), + 'description': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + 'detail': ('django.db.models.fields.TextField', [], {}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'modified_by': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['auth.User']", 'null': 'True', 'on_delete': 'models.SET_NULL', 'blank': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '512'}), + 'resource_type': ('django.db.models.fields.CharField', [], {'max_length': '64'}), + 'tag': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['main.Tag']", 'null': 'True', 'on_delete': 'models.SET_NULL', 'blank': 'True'}), + 'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'audittrail_tags'", 'blank': 'True', 'to': "orm['main.Tag']"}) + }, + 'main.credential': { + 'Meta': {'object_name': 'Credential'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'audit_trail': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'credential_audit_trails'", 'blank': 'True', 'to': "orm['main.AuditTrail']"}), + 'created_by': ('django.db.models.fields.related.ForeignKey', [], {'related_name': '"{\'class\': \'credential\', \'app_label\': \'main\'}(class)s_created"', 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}), + 'creation_date': ('django.db.models.fields.DateField', [], {'auto_now_add': 'True', 'blank': 'True'}), + 'description': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '512'}), + 'project': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'credentials'", 'on_delete': 'models.SET_NULL', 'default': 'None', 'to': u"orm['main.Project']", 'blank': 'True', 'null': 'True'}), + 'ssh_key_data': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + 'ssh_key_path': ('django.db.models.fields.CharField', [], {'default': "''", 'max_length': '4096', 'blank': 'True'}), + 'ssh_key_unlock': ('django.db.models.fields.CharField', [], {'default': "''", 'max_length': '1024', 'blank': 'True'}), + 'ssh_password': ('django.db.models.fields.CharField', [], {'default': "''", 'max_length': '1024', 'blank': 'True'}), + 'sudo_password': ('django.db.models.fields.CharField', [], {'default': "''", 'max_length': '1024', 'blank': 'True'}), + 'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'credential_tags'", 'blank': 'True', 'to': "orm['main.Tag']"}), + 'team': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'credentials'", 'on_delete': 'models.SET_NULL', 'default': 'None', 'to': "orm['main.Team']", 'blank': 'True', 'null': 'True'}), + 'user': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'credentials'", 'on_delete': 'models.SET_NULL', 'default': 'None', 'to': u"orm['auth.User']", 'blank': 'True', 'null': 'True'}) + }, + 'main.group': { + 'Meta': {'object_name': 'Group'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'audit_trail': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'group_audit_trails'", 'blank': 'True', 'to': "orm['main.AuditTrail']"}), + 'created_by': ('django.db.models.fields.related.ForeignKey', [], {'related_name': '"{\'class\': \'group\', \'app_label\': \'main\'}(class)s_created"', 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}), + 'creation_date': ('django.db.models.fields.DateField', [], {'auto_now_add': 'True', 'blank': 'True'}), + 'description': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + 'hosts': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'groups'", 'blank': 'True', 'to': "orm['main.Host']"}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'inventory': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'groups'", 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': "orm['main.Inventory']"}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '512'}), + 'parents': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'children'", 'blank': 'True', 'to': "orm['main.Group']"}), + 'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'group_tags'", 'blank': 'True', 'to': "orm['main.Tag']"}) + }, + 'main.host': { + 'Meta': {'object_name': 'Host'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'audit_trail': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'host_audit_trails'", 'blank': 'True', 'to': "orm['main.AuditTrail']"}), + 'created_by': ('django.db.models.fields.related.ForeignKey', [], {'related_name': '"{\'class\': \'host\', \'app_label\': \'main\'}(class)s_created"', 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}), + 'creation_date': ('django.db.models.fields.DateField', [], {'auto_now_add': 'True', 'blank': 'True'}), + 'description': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'inventory': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'hosts'", 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': "orm['main.Inventory']"}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '512'}), + 'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'host_tags'", 'blank': 'True', 'to': "orm['main.Tag']"}) + }, + 'main.inventory': { + 'Meta': {'object_name': 'Inventory'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'audit_trail': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'inventory_audit_trails'", 'blank': 'True', 'to': "orm['main.AuditTrail']"}), + 'created_by': ('django.db.models.fields.related.ForeignKey', [], {'related_name': '"{\'class\': \'inventory\', \'app_label\': \'main\'}(class)s_created"', 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}), + 'creation_date': ('django.db.models.fields.DateField', [], {'auto_now_add': 'True', 'blank': 'True'}), + 'description': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '512'}), + 'organization': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'inventories'", 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': "orm['main.Organization']"}), + 'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'inventory_tags'", 'blank': 'True', 'to': "orm['main.Tag']"}) + }, + 'main.launchjob': { + 'Meta': {'object_name': 'LaunchJob'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'audit_trail': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'launchjob_audit_trails'", 'blank': 'True', 'to': "orm['main.AuditTrail']"}), + 'created_by': ('django.db.models.fields.related.ForeignKey', [], {'related_name': '"{\'class\': \'launchjob\', \'app_label\': \'main\'}(class)s_created"', 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}), + 'creation_date': ('django.db.models.fields.DateField', [], {'auto_now_add': 'True', 'blank': 'True'}), + 'credential': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'launch_jobs'", 'on_delete': 'models.SET_NULL', 'default': 'None', 'to': "orm['main.Credential']", 'blank': 'True', 'null': 'True'}), + 'description': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'inventory': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'launch_jobs'", 'on_delete': 'models.SET_NULL', 'default': 'None', 'to': "orm['main.Inventory']", 'blank': 'True', 'null': 'True'}), + 'job_type': ('django.db.models.fields.CharField', [], {'max_length': '64'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '512'}), + 'project': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'launch_jobs'", 'on_delete': 'models.SET_NULL', 'default': 'None', 'to': u"orm['main.Project']", 'blank': 'True', 'null': 'True'}), + 'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'launchjob_tags'", 'blank': 'True', 'to': "orm['main.Tag']"}), + 'user': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'launch_jobs'", 'on_delete': 'models.SET_NULL', 'default': 'None', 'to': u"orm['auth.User']", 'blank': 'True', 'null': 'True'}) + }, + 'main.launchjobstatus': { + 'Meta': {'object_name': 'LaunchJobStatus'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'audit_trail': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'launchjobstatus_audit_trails'", 'blank': 'True', 'to': "orm['main.AuditTrail']"}), + 'celery_task': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'launch_job_statuses'", 'on_delete': 'models.SET_NULL', 'default': 'None', 'to': u"orm['djcelery.TaskMeta']", 'blank': 'True', 'null': 'True'}), + 'created_by': ('django.db.models.fields.related.ForeignKey', [], {'related_name': '"{\'class\': \'launchjobstatus\', \'app_label\': \'main\'}(class)s_created"', 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}), + 'creation_date': ('django.db.models.fields.DateField', [], {'auto_now_add': 'True', 'blank': 'True'}), + 'description': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'launch_job': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'launch_job_statuses'", 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': "orm['main.LaunchJob']"}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '512'}), + 'result_stderr': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + 'result_stdout': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + 'status': ('django.db.models.fields.CharField', [], {'default': "'new'", 'max_length': '20'}), + 'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'launchjobstatus_tags'", 'blank': 'True', 'to': "orm['main.Tag']"}) + }, + 'main.organization': { + 'Meta': {'object_name': 'Organization'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'admins': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'admin_of_organizations'", 'blank': 'True', 'to': u"orm['auth.User']"}), + 'audit_trail': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'organization_audit_trails'", 'blank': 'True', 'to': "orm['main.AuditTrail']"}), + 'created_by': ('django.db.models.fields.related.ForeignKey', [], {'related_name': '"{\'class\': \'organization\', \'app_label\': \'main\'}(class)s_created"', 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}), + 'creation_date': ('django.db.models.fields.DateField', [], {'auto_now_add': 'True', 'blank': 'True'}), + 'description': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '512'}), + 'projects': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'organizations'", 'blank': 'True', 'to': u"orm['main.Project']"}), + 'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'organization_tags'", 'blank': 'True', 'to': "orm['main.Tag']"}), + 'users': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'organizations'", 'blank': 'True', 'to': u"orm['auth.User']"}) + }, + 'main.permission': { + 'Meta': {'object_name': 'Permission'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'audit_trail': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'permission_audit_trails'", 'blank': 'True', 'to': "orm['main.AuditTrail']"}), + 'created_by': ('django.db.models.fields.related.ForeignKey', [], {'related_name': '"{\'class\': \'permission\', \'app_label\': \'main\'}(class)s_created"', 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}), + 'creation_date': ('django.db.models.fields.DateField', [], {'auto_now_add': 'True', 'blank': 'True'}), + 'description': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'job_type': ('django.db.models.fields.CharField', [], {'max_length': '64'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '512'}), + 'project': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'permissions'", 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['main.Project']"}), + 'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'permission_tags'", 'blank': 'True', 'to': "orm['main.Tag']"}), + 'team': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'permissions'", 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': "orm['main.Team']"}), + 'user': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'permissions'", 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}) + }, + u'main.project': { + 'Meta': {'object_name': 'Project'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'audit_trail': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'project_audit_trails'", 'blank': 'True', 'to': "orm['main.AuditTrail']"}), + 'created_by': ('django.db.models.fields.related.ForeignKey', [], {'related_name': '"{\'class\': \'project\', \'app_label\': u\'main\'}(class)s_created"', 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}), + 'creation_date': ('django.db.models.fields.DateField', [], {'auto_now_add': 'True', 'blank': 'True'}), + 'default_playbook': ('django.db.models.fields.CharField', [], {'max_length': '1024'}), + 'description': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'inventories': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'projects'", 'blank': 'True', 'to': "orm['main.Inventory']"}), + 'local_repository': ('django.db.models.fields.CharField', [], {'max_length': '1024'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '512'}), + 'scm_type': ('django.db.models.fields.CharField', [], {'max_length': '64'}), + 'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'project_tags'", 'blank': 'True', 'to': "orm['main.Tag']"}) + }, + 'main.tag': { + 'Meta': {'object_name': 'Tag'}, + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'max_length': '512'}) + }, + 'main.team': { + 'Meta': {'object_name': 'Team'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'audit_trail': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'team_audit_trails'", 'blank': 'True', 'to': "orm['main.AuditTrail']"}), + 'created_by': ('django.db.models.fields.related.ForeignKey', [], {'related_name': '"{\'class\': \'team\', \'app_label\': \'main\'}(class)s_created"', 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}), + 'creation_date': ('django.db.models.fields.DateField', [], {'auto_now_add': 'True', 'blank': 'True'}), + 'description': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '512'}), + 'organization': ('django.db.models.fields.related.ManyToManyField', [], {'related_name': "'teams'", 'symmetrical': 'False', 'to': "orm['main.Organization']"}), + 'projects': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'teams'", 'blank': 'True', 'to': u"orm['main.Project']"}), + 'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'team_tags'", 'blank': 'True', 'to': "orm['main.Tag']"}), + 'users': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'teams'", 'blank': 'True', 'to': u"orm['auth.User']"}) + }, + 'main.variabledata': { + 'Meta': {'object_name': 'VariableData'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'audit_trail': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'variabledata_audit_trails'", 'blank': 'True', 'to': "orm['main.AuditTrail']"}), + 'created_by': ('django.db.models.fields.related.ForeignKey', [], {'related_name': '"{\'class\': \'variabledata\', \'app_label\': \'main\'}(class)s_created"', 'null': 'True', 'on_delete': 'models.SET_NULL', 'to': u"orm['auth.User']"}), + 'creation_date': ('django.db.models.fields.DateField', [], {'auto_now_add': 'True', 'blank': 'True'}), + 'data': ('django.db.models.fields.TextField', [], {}), + 'description': ('django.db.models.fields.TextField', [], {'default': "''", 'blank': 'True'}), + 'group': ('django.db.models.fields.related.ForeignKey', [], {'default': 'None', 'related_name': "'variable_data'", 'null': 'True', 'blank': 'True', 'to': "orm['main.Group']"}), + 'host': ('django.db.models.fields.related.ForeignKey', [], {'default': 'None', 'related_name': "'variable_data'", 'null': 'True', 'blank': 'True', 'to': "orm['main.Host']"}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '512'}), + 'tags': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'variabledata_tags'", 'blank': 'True', 'to': "orm['main.Tag']"}) + } + } + + complete_apps = ['main'] \ No newline at end of file diff --git a/lib/main/models/__init__.py b/lib/main/models/__init__.py index 8df6f715ce..371309358a 100644 --- a/lib/main/models/__init__.py +++ b/lib/main/models/__init__.py @@ -15,13 +15,15 @@ # You should have received a copy of the GNU General Public License # along with Ansible Commander. If not, see . - +import datetime from django.db import models from django.db.models import CASCADE, SET_NULL, PROTECT from django.utils.translation import ugettext_lazy as _ from django.core.urlresolvers import reverse from django.contrib.auth.models import User import exceptions +from jsonfield import JSONField +from djcelery.models import TaskMeta # TODO: jobs and events model TBD # TODO: reporting model TBD @@ -597,8 +599,13 @@ class LaunchJob(CommonModel): job_type = models.CharField(max_length=64, choices=JOB_TYPE_CHOICES) def start(self): + """Create a new launch job status and start the task via celery.""" from lib.main.tasks import run_launch_job - return run_launch_job.delay(self.pk) + launch_job_status = self.launch_job_statuses.create(name='Launch Job Status %s' % datetime.datetime.now().isoformat()) + task_result = run_launch_job.delay(launch_job_status.pk) + launch_job_status.celery_task = TaskMeta.objects.get(task_id=task_result.task_id) + launch_job_status.save() + return launch_job_status # project has one default playbook but really should have a list of playbooks and flags ... @@ -637,16 +644,61 @@ class LaunchJob(CommonModel): # TODO: Events class LaunchJobStatus(CommonModel): + ''' + Status for a single run of a launch job. + ''' + + STATUS_CHOICES = [ + ('new', _('New')), + ('pending', _('Pending')), + ('running', _('Running')), + ('successful', _('Successful')), + ('failed', _('Failed')), + ] class Meta: app_label = 'main' verbose_name_plural = _('launch job statuses') launch_job = models.ForeignKey('LaunchJob', null=True, on_delete=SET_NULL, related_name='launch_job_statuses') - status = models.IntegerField() - result_data = models.TextField() + status = models.CharField(max_length=20, choices=STATUS_CHOICES, default='new') + result_stdout = models.TextField(blank=True, default='') + result_stderr = models.TextField(blank=True, default='') + celery_task = models.ForeignKey('djcelery.TaskMeta', related_name='launch_job_statuses', blank=True, null=True, default=None, on_delete=SET_NULL) +class LaunchJobStatusEvent(models.Model): + ''' + A single event/message logged from the callback when running a job. + ''' + + EVENT_TYPES = [ + ('runner_on_failed', _('Runner on Failed')), + ('runner_on_ok', _('Runner on OK')), + ('runner_on_error', _('Runner on Error')), + ('runner_on_skipped', _('Runner on Skipped')), + ('runner_on_unreachable', _('Runner on Unreachable')), + ('runner_on_no_hosts', _('Runner on No Hosts')), + ('runner_on_async_poll', _('Runner on Async Poll')), + ('runner_on_async_ok', _('Runner on Async OK')), + ('runner_on_async_failed', _('Runner on Async Failed')), + ('playbook_on_start', _('Playbook on Start')), + ('playbook_on_notify', _('Playbook on Notify')), + ('playbook_on_task_start', _('Playbook on Task Start')), + ('playbook_on_vars_prompt', _('Playbook on Vars Prompt')), + ('playbook_on_setup', _('Playbook on Setup')), + ('playbook_on_import_for_host', _('Playbook on Import for Host')), + ('playbook_on_not_import_for_host', _('Playbook on Not Import for Host')), + ('playbook_on_play_start', _('Playbook on Play Start')), + ('playbook_on_stats', _('Playbook on Stats')), + ] + + class Meta: + app_label = 'main' + abstract = True + + launch_job_status = models.ForeignKey('LaunchJobEvent', related_name='launch_job_status_events', on_delete=CASCADE) + created = models.DateTimeField(auto_now_add=True) + event = models.CharField(max_length=100, choices=EVENT_TYPES) + event_data = JSONField(blank=True, default='') # TODO: reporting (MPD) - - diff --git a/lib/main/tasks.py b/lib/main/tasks.py index 39139d6dc2..b9ff2161d9 100644 --- a/lib/main/tasks.py +++ b/lib/main/tasks.py @@ -21,15 +21,22 @@ from celery import task from lib.main.models import * @task(name='run_launch_job') -def run_launch_job(launch_job_pk): - launch_job = LaunchJob.objects.get(pk=launch_job_pk) - os.environ['ACOM_INVENTORY'] = str(launch_job.inventory.pk) +def run_launch_job(launch_job_status_pk): + launch_job_status = LaunchJobStatus.objects.get(pk=launch_job_status_pk) + launch_job = launch_job_status.launch_job + plugin_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', + 'plugins', 'callback')) inventory_script = os.path.abspath(os.path.join(os.path.dirname(__file__), - 'management', 'commands', 'acom_inventory.py')) + 'management', 'commands', + 'acom_inventory.py')) + env = dict(os.environ.items()) + env['ACOM_LAUNCH_JOB_STATUS_ID'] = str(launch_job_status.pk) + env['ACOM_INVENTORY_ID'] = str(launch_job.inventory.pk) + env['ANSIBLE_CALLBACK_PLUGINS'] = plugin_dir playbook = launch_job.project.default_playbook - cmd = ['ansible-playbook', '-i', inventory_script, '-v'] + cmdline = ['ansible-playbook', '-i', inventory_script, '-v'] if False: # local mode - cmd.extend(['-c', 'local']) - cmd.append(playbook) - subprocess.check_call(cmd) - # FIXME: Do stuff here! + cmdline.extend(['-c', 'local']) + cmdline.append(playbook) + subprocess.check_call(cmdline, env=env) + # FIXME: Capture stdout/stderr diff --git a/lib/main/tests/__init__.py b/lib/main/tests/__init__.py index d3ec092ade..99f0a3a03d 100644 --- a/lib/main/tests/__init__.py +++ b/lib/main/tests/__init__.py @@ -1,4 +1,23 @@ +# (c) 2013, AnsibleWorks +# +# This file is part of Ansible Commander +# +# Ansible Commander is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible Commander is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible Commander. If not, see . + + from lib.main.tests.organizations import OrganizationsTest from lib.main.tests.users import UsersTest from lib.main.tests.inventory import InventoryTest - +from lib.main.tests.commands import AcomInventoryTest +from lib.main.tests.tasks import RunLaunchJobTest diff --git a/lib/main/tests/commands.py b/lib/main/tests/commands.py new file mode 100644 index 0000000000..d7b15475a8 --- /dev/null +++ b/lib/main/tests/commands.py @@ -0,0 +1,82 @@ +# (c) 2013, AnsibleWorks +# +# This file is part of Ansible Commander +# +# Ansible Commander is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible Commander is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible Commander. If not, see . + + +import json +import StringIO +import sys +from django.core.management import call_command +from django.core.management.base import CommandError +from lib.main.models import * +from lib.main.tests.base import BaseTest + +class BaseCommandTest(BaseTest): + ''' + Base class for tests that run management commands. + ''' + + def run_command(self, name, *args, **options): + ''' + Run a management command and capture its stdout/stderr along with any + exceptions. + ''' + options.setdefault('verbosity', 1) + options.setdefault('interactive', False) + original_stdout = sys.stdout + original_stderr = sys.stderr + sys.stdout = StringIO.StringIO() + sys.stderr = StringIO.StringIO() + result = None + try: + result = call_command(name, *args, **options) + except Exception, e: + result = e + except SystemExit, e: + result = e + finally: + captured_stdout = sys.stdout.getvalue() + captured_stderr = sys.stderr.getvalue() + sys.stdout = original_stdout + sys.stderr = original_stderr + return result, captured_stdout, captured_stderr + +class AcomInventoryTest(BaseCommandTest): + ''' + Test cases for acom_inventory management command. + ''' + + def setUp(self): + pass + + def test_without_inventory_id(self): + result, stdout, stderr = self.run_command('acom_inventory', list=True) + self.assertTrue(isinstance(result, CommandError)) + self.assertEqual(json.loads(stdout), {}) + + def test_with_inventory_id_as_argument(self): + result, stdout, stderr = self.run_command('acom_inventory', list=True, + inventory=1) + self.assertTrue(isinstance(result, CommandError)) + self.assertEqual(json.loads(stdout), {}) + + def test_with_inventory_id_in_environment(self): + pass + + def test_with_invalid_inventory_id(self): + pass + + \ No newline at end of file diff --git a/lib/main/tests/organizations.py b/lib/main/tests/organizations.py index 4608b9a61e..b568843434 100644 --- a/lib/main/tests/organizations.py +++ b/lib/main/tests/organizations.py @@ -365,4 +365,3 @@ class OrganizationsTest(BaseTest): self.delete(self.collection(), expect=405, auth=self.get_super_credentials()) # TODO: tests for tag disassociation - diff --git a/lib/main/tests/tasks.py b/lib/main/tests/tasks.py new file mode 100644 index 0000000000..7695d731ac --- /dev/null +++ b/lib/main/tests/tasks.py @@ -0,0 +1,28 @@ +# (c) 2013, AnsibleWorks +# +# This file is part of Ansible Commander +# +# Ansible Commander is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible Commander is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible Commander. If not, see . + + +from lib.main.models import * +from lib.main.tests.base import BaseTest + +class RunLaunchJobTest(BaseTest): + ''' + Test cases for run_launch_job celery task. + ''' + + def setUp(self): + pass diff --git a/lib/plugins/callback/acom_callback.py b/lib/plugins/callback/acom_callback.py new file mode 100644 index 0000000000..11f307c27a --- /dev/null +++ b/lib/plugins/callback/acom_callback.py @@ -0,0 +1,86 @@ +# (c) 2013, AnsibleWorks +# +# This file is part of Ansible Commander +# +# Ansible Commander is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible Commander is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible Commander. If not, see . + + +class CallbackModule(object): + ''' + Stub callback module for logging ansible-playbook events. + ''' + + def _log_event(self, event, *args, **kwargs): + print '====', event, args, kwargs + # FIXME: Push these events back to the server. + + def on_any(self, *args, **kwargs): + pass + + def runner_on_failed(self, host, res, ignore_errors=False): + self._log_event('runner_on_failed', host, res, ignore_errors) + + def runner_on_ok(self, host, res): + self._log_event('runner_on_ok', host, res) + + def runner_on_error(self, host, msg): + self._log_event('runner_on_error', host, msg) + + def runner_on_skipped(self, host, item=None): + self._log_event('runner_on_skipped', host, item) + + def runner_on_unreachable(self, host, res): + self._log_event('runner_on_unreachable', host, res) + + def runner_on_no_hosts(self): + self._log_event('runner_on_no_hosts') + + def runner_on_async_poll(self, host, res, jid, clock): + self._log_event('runner_on_async_poll', host, res, jid, clock) + + def runner_on_async_ok(self, host, res, jid): + self._log_event('runner_on_async_ok', host, res, jid) + + def runner_on_async_failed(self, host, res, jid): + self._log_event('runner_on_async_failed', host, res, jid) + + def playbook_on_start(self): + self._log_event('playbook_on_start') + + def playbook_on_notify(self, host, handler): + self._log_event('playbook_on_notify') + + def playbook_on_task_start(self, name, is_conditional): + self._log_event('playbook_on_task_start', name, is_conditional) + + def playbook_on_vars_prompt(self, varname, private=True, prompt=None, encrypt=None, confirm=False, salt_size=None, salt=None, default=None): + self._log_event('playbook_on_vars_prompt', varname, private, prompt, encrypt, confirm, salt_size, salt, default) + + def playbook_on_setup(self): + self._log_event('playbook_on_setup') + + def playbook_on_import_for_host(self, host, imported_file): + self._log_event('playbook_on_import_for_host', host, imported_file) + + def playbook_on_not_import_for_host(self, host, missing_file): + self._log_event('playbook_on_not_import_for_host', host, missing_file) + + def playbook_on_play_start(self, pattern): + self._log_event('playbook_on_play_start', pattern) + + def playbook_on_stats(self, stats): + d = {} + for attr in ('changed', 'dark', 'failures', 'ok', 'processed', 'skipped'): + d[attr] = getattr(stats, attr) + self._log_event('playbook_on_stats', d)