stackamole-xblock 9.4.0__py3-none-any.whl

stackamole/migrations/0004_auto_20190715_1053.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.15 on 2019-07-15 10:53
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('stackamole', '0003_blanks'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='stacklog',
+            name='stack',
+        ),
+        migrations.AddField(
+            model_name='stacklog',
+            name='stack_id',
+            field=models.IntegerField(db_index=True, null=True),
+        ),
+    ]

stackamole/migrations/0005_auto_20190811_1555.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.18 on 2019-08-11 15:55
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+import jsonfield.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('stackamole', '0004_auto_20190715_1053'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='stack',
+            name='hook_events',
+            field=jsonfield.fields.JSONField(default="null"),
+        ),
+        migrations.AddField(
+            model_name='stack',
+            name='hook_script',
+            field=models.CharField(max_length=256, null=True),
+        ),
+        migrations.AddField(
+            model_name='stack',
+            name='providers',
+            field=jsonfield.fields.JSONField(default="null"),
+        ),
+        migrations.AddField(
+            model_name='stack',
+            name='run',
+            field=models.CharField(blank=True, max_length=50),
+        ),
+        migrations.AddField(
+            model_name='stacklog',
+            name='hook_events',
+            field=jsonfield.fields.JSONField(default="null"),
+        ),
+        migrations.AddField(
+            model_name='stacklog',
+            name='hook_script',
+            field=models.CharField(max_length=256, null=True),
+        ),
+        migrations.AddField(
+            model_name='stacklog',
+            name='providers',
+            field=jsonfield.fields.JSONField(default="null"),
+        ),
+        migrations.AddField(
+            model_name='stacklog',
+            name='run',
+            field=models.CharField(blank=True, max_length=50),
+        ),
+    ]

stackamole/migrations/0006_auto_20200107_1332.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.21 on 2020-01-07 13:32
+from __future__ import unicode_literals
+
+from django.db import migrations
+import jsonfield.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('stackamole', '0005_auto_20190811_1555'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='stack',
+            name='hook_events',
+            field=jsonfield.fields.JSONField(default=dict),
+        ),
+        migrations.RunSQL(
+            "UPDATE stackamole_stack SET hook_events = '{}' WHERE hook_events = '\"null\"';",  # noqa: E501
+            "UPDATE stackamole_stack SET hook_events = '\"null\"' WHERE hook_events = '{}';",  # noqa: E501
+        ),
+        migrations.AlterField(
+            model_name='stack',
+            name='providers',
+            field=jsonfield.fields.JSONField(default=list),
+        ),
+        migrations.RunSQL(
+            "UPDATE stackamole_stack SET providers = '[]' WHERE providers = '\"null\"';",  # noqa: E501
+            "UPDATE stackamole_stack SET providers = '\"null\"' WHERE providers = '[]';",  # noqa: E501
+        ),
+        migrations.AlterField(
+            model_name='stacklog',
+            name='hook_events',
+            field=jsonfield.fields.JSONField(default=dict),
+        ),
+        migrations.AlterField(
+            model_name='stacklog',
+            name='providers',
+            field=jsonfield.fields.JSONField(default=list),
+        ),
+    ]

stackamole/migrations/0007_add_delete_by_and_delete_age.py

@@ -0,0 +1,34 @@
+# Generated by Django 2.2.16 on 2020-11-04 13:35
+
+from django.db import migrations, models
+import stackamole.models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('stackamole', '0006_auto_20200107_1332'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='stack',
+            name='delete_age',
+            field=models.IntegerField(null=True),
+        ),
+        migrations.AddField(
+            model_name='stack',
+            name='delete_by',
+            field=models.DateTimeField(db_index=True, default=stackamole.models.default_delete_by_timestamp, null=True),  # noqa E501
+        ),
+        migrations.AddField(
+            model_name='stacklog',
+            name='delete_age',
+            field=models.IntegerField(null=True),
+        ),
+        migrations.AddField(
+            model_name='stacklog',
+            name='delete_by',
+            field=models.DateTimeField(db_index=True, default=stackamole.models.default_delete_by_timestamp, null=True),  # noqa E501
+        ),
+    ]

stackamole/migrations/0008_add_database_defaults_for_stack_key_and_password.py

@@ -0,0 +1,23 @@
+# Generated by Django 2.2.19 on 2021-03-25 17:08
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('stackamole', '0007_add_delete_by_and_delete_age'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='stack',
+            name='key',
+            field=models.TextField(blank=True, default=''),
+        ),
+        migrations.AlterField(
+            model_name='stack',
+            name='password',
+            field=models.CharField(blank=True, default='', max_length=128),
+        ),
+    ]

stackamole/migrations/0009_add_null_true_for_key_and_password.py

@@ -0,0 +1,23 @@
+# Generated by Django 2.2.16 on 2021-03-30 11:28
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('stackamole', '0008_add_database_defaults_for_stack_key_and_password'),  # noqa E501
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='stack',
+            name='key',
+            field=models.TextField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='stack',
+            name='password',
+            field=models.CharField(blank=True, max_length=128, null=True),
+        ),
+    ]

stackamole/migrations/0010_add_user_foreign_key.py

@@ -0,0 +1,52 @@
+from django.conf import settings
+from django.core.exceptions import ObjectDoesNotExist
+from django.db import migrations, models
+import django.db.models.deletion
+
+import logging
+logger = logging.getLogger(__name__)
+
+
+class Migration(migrations.Migration):
+
+    def backfill_learner(apps, schema_editor):
+        """
+        Use the 'student_id' to link stacks to the User model.
+        """
+        Stack = apps.get_model("stackamole", "Stack")
+        AnonymousUserId = apps.get_model("student", "AnonymousUserId")
+        for stack in Stack.objects.all():
+            try:
+                stack.learner = AnonymousUserId.objects.get(
+                    anonymous_user_id=stack.student_id).user
+                stack.save(update_fields=['learner'])
+            except ObjectDoesNotExist:
+                logger.warning('Unable to link stack to user: '
+                               f'{stack.name}')
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('stackamole', '0009_add_null_true_for_key_and_password'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='stack',
+            name='learner',
+            field=models.ForeignKey(
+                db_constraint=False,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.RunPython(backfill_learner),
+        migrations.AlterField(
+            model_name='stack',
+            name='learner',
+            field=models.ForeignKey(
+                db_constraint=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                to=settings.AUTH_USER_MODEL),
+        ),
+    ]

stackamole/migrations/0011_allow_null_for_learner.py

@@ -0,0 +1,29 @@
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('stackamole', '0010_add_user_foreign_key'),
+    ]
+
+    # Because 0010_add_user_foreign_key was buggy in several releases,
+    # and those set the field to be NOT NULL, what we have to do here
+    # is undo that. For an installation that undergoes both
+    # 0010_add_user_foreign_key and this migration in a fixed release,
+    # this AlterField will be a no-op. For one that ran
+    # 0010_add_user_foreign_key from a broken release and thus had its
+    # field set to NOT NULL, this will allow NULL values.
+    operations = [
+        migrations.AlterField(
+            model_name='stack',
+            name='learner',
+            field=models.ForeignKey(
+                db_constraint=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                to=settings.AUTH_USER_MODEL),
+        ),
+    ]

stackamole/migrations/0012_add_suspend_by.py

@@ -0,0 +1,21 @@
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('stackamole', '0011_allow_null_for_learner'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='stack',
+            name='suspend_by',
+            field=models.DateTimeField(db_index=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='stacklog',
+            name='suspend_by',
+            field=models.DateTimeField(db_index=True, null=True),
+        ),
+    ]

stackamole/migrations/0013_migrate_app_label.py

@@ -0,0 +1,71 @@
+from django.db import migrations
+
+# Rename the 'hastexo' tables to 'stackamole' to access labs created
+# prior to the project rename.
+
+OLD_APP_LABEL = 'hastexo'
+NEW_APP_LABEL = 'stackamole'
+
+
+def migrate_tables(apps, schema_editor):
+    connection = schema_editor.connection
+    existing_tables = connection.introspection.table_names()
+
+    if 'hastexo_stack' in existing_tables:
+        with connection.cursor() as cursor:
+            # stackamole_* tables were created just now and contain no data,
+            # confirm empty and drop
+            cursor.execute("SELECT COUNT(*) FROM stackamole_stack")
+            if cursor.fetchone()[0] > 0:
+                raise Exception(
+                    "'hastexo_stack' exists & 'stackamole_stack' contains "
+                    "data; this scenario is out of scope for automated "
+                    "migration.")
+            cursor.execute("DROP TABLE stackamole_stacklog")
+            cursor.execute("DROP TABLE stackamole_stack")
+            # rename hastexo_* tables to stackamole_*
+            cursor.execute(
+                "ALTER TABLE hastexo_stacklog RENAME TO stackamole_stacklog")
+            cursor.execute(
+                "ALTER TABLE hastexo_stack RENAME TO stackamole_stack")
+
+
+def migrate_contenttypes(apps, schema_editor):
+    ContentType = apps.get_model('contenttypes', 'ContentType')
+    db = schema_editor.connection.alias
+    if ContentType.objects.using(db).filter(app_label=OLD_APP_LABEL).exists():
+        # remove the stackamole content types that were just auto-created
+        ContentType.objects.using(db).filter(app_label=NEW_APP_LABEL).delete()
+        # rename 'hastexo' content types to 'stackamole'
+        ContentType.objects.using(db).filter(app_label=OLD_APP_LABEL).update(
+            app_label=NEW_APP_LABEL)
+
+
+def migrate_migration_records(apps, schema_editor):
+    # delete now orphaned 'hastexo' migration records
+    schema_editor.connection.cursor().execute(
+        "DELETE FROM django_migrations WHERE app = 'hastexo'"
+    )
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('stackamole', '0012_add_suspend_by'),
+    ]
+
+    # One way migration only from 'hastexo' to 'stackamole'
+    operations = [
+        migrations.RunPython(
+            migrate_tables,
+            migrations.RunPython.noop,
+        ),
+        migrations.RunPython(
+            migrate_contenttypes,
+            migrations.RunPython.noop,
+        ),
+        migrations.RunPython(
+            migrate_migration_records,
+            migrations.RunPython.noop,
+        ),
+    ]

stackamole/models.py

@@ -0,0 +1,106 @@
+from django.conf import settings as django_settings
+from django.db import models
+from django.utils import timezone
+from jsonfield.fields import JSONField
+
+SETTINGS_KEY = 'stackamole'
+DEFAULT_SETTINGS = {"delete_age": 14}
+
+
+def default_delete_by_timestamp():
+    # load the default delete_age value from settings
+    try:
+        settings = django_settings.XBLOCK_SETTINGS.get(
+            SETTINGS_KEY,
+            DEFAULT_SETTINGS
+        )
+    except AttributeError:
+        settings = DEFAULT_SETTINGS
+
+    # create a delete_by timestamp based on the delete_age from settings
+    delete_by = timezone.now() + timezone.timedelta(
+        days=settings.get("delete_age", 14))
+
+    return delete_by
+
+
+class StackCommon(models.Model):
+    """
+    Abstract class that defines a stack record's common fields.
+
+    """
+    class Meta:
+        abstract = True
+
+    name = models.CharField(max_length=64, db_index=True)
+    student_id = models.CharField(max_length=40, db_index=True)
+    course_id = models.CharField(max_length=50, db_index=True)
+    run = models.CharField(max_length=50, blank=True)
+    provider = models.CharField(max_length=32, blank=True)
+    providers = JSONField(default=list)
+    hook_script = models.CharField(max_length=256, null=True)
+    hook_events = JSONField(default=dict)
+    protocol = models.CharField(max_length=32, blank=True)
+    port = models.IntegerField(null=True)
+    status = models.CharField(max_length=32, blank=True, db_index=True)
+    error_msg = models.CharField(max_length=256, blank=True)
+    ip = models.GenericIPAddressField(null=True)
+    user = models.CharField(max_length=32, blank=True)
+    launch_task_id = models.CharField(max_length=40, blank=True)
+    launch_timestamp = models.DateTimeField(null=True, db_index=True)
+    suspend_timestamp = models.DateTimeField(null=True, db_index=True)
+    suspend_by = models.DateTimeField(null=True, db_index=True)
+    created_on = models.DateTimeField(auto_now_add=True, db_index=True)
+    delete_age = models.IntegerField(null=True)
+    delete_by = models.DateTimeField(null=True, db_index=True,
+                                     default=default_delete_by_timestamp)
+
+
+class Stack(StackCommon):
+    """
+    Stores Heat stack data that needs to be queried across XBlock instances.
+
+    """
+    class Meta:
+        app_label = 'stackamole'
+        unique_together = (('student_id', 'course_id', 'name'),)
+
+    key = models.TextField(blank=True, null=True)
+    password = models.CharField(max_length=128, blank=True, null=True)
+    learner = models.ForeignKey(django_settings.AUTH_USER_MODEL,
+                                null=True,
+                                db_index=True,
+                                on_delete=models.PROTECT)
+
+    def __init__(self, *args, **kwargs):
+        super(Stack, self).__init__(*args, **kwargs)
+
+        # Save previous status
+        self.prev_status = self.status
+
+    def save(self, *args, **kwargs):
+        super(Stack, self).save(*args, **kwargs)
+
+        # Populate the log if there was a status change
+        if self.status and self.status != self.prev_status:
+            self.prev_status = self.status
+
+            log_fields = {'stack_id': self.id}
+            for field in StackCommon._meta.get_fields():
+                if field.name == 'created_on':
+                    continue
+                log_fields[field.name] = getattr(self, field.name)
+
+            log = StackLog(**log_fields)
+            log.save()
+
+
+class StackLog(StackCommon):
+    """
+    A log of stack model changes.
+
+    """
+    class Meta:
+        app_label = 'stackamole'
+
+    stack_id = models.IntegerField(null=True, db_index=True)

stackamole/openstack.py

@@ -0,0 +1,132 @@
+from keystoneauth1.identity import generic
+from keystoneauth1 import session as kssession
+from heatclient import client as heat_client
+from novaclient import client as nova_client
+
+
+class OpenStackWrapper(object):
+    """
+    A meta-class for wrapping OpenStack services.
+
+    """
+    os_options = (
+        'os_auth_url',
+        'os_auth_token',
+        'os_username',
+        'os_password',
+        'os_user_id',
+        'os_user_domain_id',
+        'os_user_domain_name',
+        'os_tenant_id',
+        'os_tenant_name',
+        'os_project_id',
+        'os_project_name',
+        'os_project_domain_id',
+        'os_project_domain_name',
+        'os_region_name'
+    )
+
+    service_type = None
+    endpoint_type = None
+    api_version = None
+    options = {}
+
+    def __init__(self, **options):
+        # Set OpenStack options
+        for os_option in self.os_options:
+            self.options[os_option] = options.get(os_option)
+
+    def get_keystone_auth(self):
+        keystone_session = kssession.Session(verify=True)
+        if self.options['os_auth_token']:
+            kwargs = {
+                'token': self.options['os_auth_token'],
+                'auth_url': self.options['os_auth_url']
+            }
+            keystone_auth = generic.Token(**kwargs)
+        else:
+            project_id = self.options['os_project_id'] or self.options['os_tenant_id']  # noqa: E501
+            project_name = self.options['os_project_name'] or self.options['os_tenant_name']  # noqa: E501
+            kwargs = {
+                'username': self.options['os_username'],
+                'user_id': self.options['os_user_id'],
+                'user_domain_id': self.options['os_user_domain_id'],
+                'user_domain_name': self.options['os_user_domain_name'],
+                'password': self.options['os_password'],
+                'auth_url': self.options['os_auth_url'],
+                'project_id': project_id,
+                'project_name': project_name,
+                'project_domain_id': self.options['os_project_domain_id'],
+                'project_domain_name': self.options['os_project_domain_name'],
+            }
+            keystone_auth = generic.Password(**kwargs)
+
+        return (keystone_session, keystone_auth)
+
+
+class HeatWrapper(OpenStackWrapper):
+    """
+    A class that wraps the Heat service for the Stackamole XBlock.
+
+    """
+    def __init__(self, **options):
+        self.service_type = 'orchestration'
+        self.endpoint_type = 'publicURL'
+        self.api_version = '1'
+
+        super(HeatWrapper, self).__init__(**options)
+
+    def get_client(self):
+        """
+        This function is based, with minor changes, on the official OpenStack
+        Heat client's shell implementation.  Specifically,
+        python-heatclient/heatclient/shell.py.
+
+        """
+        keystone_session, keystone_auth = self.get_keystone_auth()
+
+        kwargs = {
+            'auth_url': self.options['os_auth_url'],
+            'session': keystone_session,
+            'auth': keystone_auth,
+            'service_type': self.service_type,
+            'endpoint_type': self.endpoint_type,
+            'region_name': self.options['os_region_name'],
+            'username': self.options['os_username'],
+            'password': self.options['os_password']
+        }
+
+        return heat_client.Client(self.api_version, **kwargs)
+
+
+class NovaWrapper(OpenStackWrapper):
+    """
+    A class that wraps the Compute service for the Stackamole XBlock.
+
+    """
+    def __init__(self, **options):
+        self.service_type = 'compute'
+        self.endpoint_type = 'publicURL'
+        self.api_version = '2.2'
+
+        super(NovaWrapper, self).__init__(**options)
+
+    def get_client(self):
+        keystone_session, keystone_auth = self.get_keystone_auth()
+        return nova_client.Client(
+            self.api_version,
+            self.options['os_username'],
+            self.options['os_password'],
+            project_id=self.options['os_project_id'],
+            project_name=self.options['os_project_name'],
+            user_id=self.options['os_user_id'],
+            auth_url=self.options['os_auth_url'],
+            region_name=self.options['os_region_name'],
+            endpoint_type=self.endpoint_type,
+            service_type=self.service_type,
+            session=keystone_session,
+            auth=keystone_auth,
+            project_domain_id=self.options['os_project_domain_id'],
+            project_domain_name=self.options['os_project_domain_name'],
+            user_domain_id=self.options['os_user_domain_id'],
+            user_domain_name=self.options['os_user_domain_name'])