stackamole-xblock 9.4.0__py3-none-any.whl

fake/common/djangoapps/student/models.py

@@ -0,0 +1,15 @@
+from django.contrib.auth.models import User
+from django.db import models
+
+
+class AnonymousUserId(models.Model):
+    """
+    Pared down from:
+
+    edx-platform/common/djangoapps/student/models.py:AnonymousUserId
+
+    This is so we don't have to install all of edx-platform just to test it.
+
+    """
+    user = models.ForeignKey(User, db_index=True, on_delete=models.CASCADE)
+    anonymous_user_id = models.CharField(unique=True, max_length=32)

requirements/base.txt

@@ -0,0 +1,25 @@
+apscheduler<4
+cliff<=4.7
+dogpile.cache<=1.3
+keystoneauth1<=5.8
+openstacksdk<=4.1
+osc-lib<=3.1
+os-client-config<=2.1
+oslo.config<=9.7.1
+oslo.serialization<=5.5
+oslo.utils<=7.4
+oslo.i18n<6.6
+paramiko>=4.0,<4.1
+pymongo<=4.4.0 # keep in sync with edx-platform
+python-heatclient<=4.0
+python-keystoneclient<=5.5
+python-novaclient<=18.7
+tenacity<=9.0
+
+# for stackamole_guacamole_client
+django<=5.2.13
+channels>=4.3,<4.4
+daphne<=4.0.0
+mysqlclient<=2.2.8  # keep in sync with edx-platform
+jsonfield>=3.2.0,<4   # keep in sync with edx-platform
+pyguacamole>=0.11

requirements/flake8.txt

@@ -0,0 +1 @@
+flake8

requirements/setup.txt

@@ -0,0 +1,3 @@
+-r base.txt
+setuptools-scm
+bumpversion

requirements/test.txt

@@ -0,0 +1,19 @@
+-r base.txt
+
+# These package versions must be kept in sync with edx-platform as much as possible.
+xblock-sdk<0.9.0;python_version<"3.9"
+xblock-sdk;python_version>="3.9"
+six==1.16.0
+lazy<=1.5
+openedx-django-pyfs>=3.8.0
+sqlparse>=0.4.1,<0.5
+web-fragments<=2.0.0
+edx-opaque-keys<=3.0.0
+
+# dependencies of supported nested XBlocks
+path.py>=12.4
+
+# Tooling
+ddt
+nose
+coverage

samples/hot/sample-template.yaml

@@ -0,0 +1,427 @@
+heat_template_version: 2014-10-16
+
+description: |
+  Sample lab environment.
+  - Consists of one deployment host (deploy) and three regular hosts
+    (daisy, eric, frank).
+  - Provides two separate networks.
+  - Installs an apt proxy on the deploy node for quicker updates
+  - Waits for cloud-init provisioning to finish before reports CREATE_COMPLETE
+  - Creates cron job to sync time with hardware clock, to work around stack
+    suspension desync
+  - Starts screen on connection
+
+parameters:
+  flavor:
+    type: string
+    description: Flavor to use for servers
+    default: m1.medium.e
+  public_net_id:
+    type: string
+    description: Public network ID
+    default: 62954df1-05bb-42e5-9960-ca921cccaeeb
+  image:
+    type: string
+    description: Image ID or name
+    default: ubuntu-14.04.3-server-cloudimg
+  ubuntu_mirror:
+    type: string
+    description: Ubuntu package archive mirror
+    default: mirrors.se.eu.kernel.org
+  timeout:
+    type: number
+    description: Timeout for stack creation to finish
+    default: 900
+
+resources:
+  all_done:
+    type: OS::Heat::WaitCondition
+    properties:
+      handle: {get_resource: all_done_handle}
+      count: 4
+      timeout: {get_param: timeout}
+
+  all_done_handle:
+    type: OS::Heat::WaitConditionHandle
+
+  proxy_ready:
+    type: OS::Heat::WaitCondition
+    properties:
+      handle: {get_resource: proxy_ready_handle}
+      count: 1
+      timeout: {get_param: timeout}
+
+  proxy_ready_handle:
+    type: OS::Heat::WaitConditionHandle
+
+  deploy_config:
+    type: OS::Heat::CloudConfig
+    properties:
+      cloud_config:
+        ### bootcmd: runs arbitrary commands early in the boot sequence
+        bootcmd:
+          - apt-get update
+          - apt-get -y install --no-install-recommends apt-cacher-ng
+          - { get_attr: ['proxy_ready_handle', 'curl_cli'] }
+        ## users: defines users, sets passwords and SSH authorized keys, and
+        ### enables sudo privileges.
+        users:
+          - default
+          - name: training
+            gecos: Training User
+            groups: users,adm
+            ssh-authorized-keys:
+              - { get_attr: [ training_key, public_key ] }
+            lock-passwd: false
+            shell: /bin/bash
+            sudo: ALL=(ALL) NOPASSWD:ALL
+        ### mounts: enables and disables mount points
+        #mounts:
+        #  - [ 'vdb', null ]
+        ### write_files: writes arbitrary files
+        write_files:
+          - path: /etc/cron.d/hwclock
+            permissions: '0644'
+            content: |
+              # /etc/cron.d/hwclock: periodically sync the system time to the hardware clock
+              SHELL=/bin/sh
+              PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
+              */5 * * * *   root	hwclock -s
+          - path: /etc/hosts
+            permissions: '0644'
+            content: |
+              127.0.0.1 localhost
+              192.168.122.100 deploy.example.com deploy
+              192.168.122.114 daisy.example.com daisy
+              192.168.122.115 eric.example.com eric
+              192.168.122.116 frank.example.com frank
+          - path: /etc/network/interfaces.d/eth1.cfg
+            permissions: '0644'
+            content: |
+              auto eth1
+              iface eth1 inet dhcp
+          - path: /etc/ntp.conf
+            permissions: '0644'
+            content: |
+              driftfile /var/lib/ntp/ntp.drift
+              statistics loopstats peerstats clockstats
+              filegen loopstats file loopstats type day enable
+              filegen peerstats file peerstats type day enable
+              filegen clockstats file clockstats type day enable
+              server 0.ubuntu.pool.ntp.org iburst
+              server 1.ubuntu.pool.ntp.org iburst
+              server 2.ubuntu.pool.ntp.org iburst
+              server 3.ubuntu.pool.ntp.org iburst
+              server ntp.ubuntu.com
+              restrict -4 default kod notrap nomodify nopeer noquery
+              restrict -6 default kod notrap nomodify nopeer noquery
+              restrict 127.0.0.1
+              restrict ::1
+          - path: /home/training/.ssh/id_rsa
+            permissions: '0600'
+            content: { get_attr: [ training_key, private_key ] }
+          - path: /home/training/.profile
+            permissions: '0644'
+            content: |
+              exec /usr/bin/screen -xRR
+        apt_proxy: "http://localhost:3142"
+        apt_mirror:
+          str_replace:
+            template: http://%mirror/ubuntu
+            params:
+              "%mirror": { get_param: ubuntu_mirror }
+        ### package_update: refresh package on first boot
+        package_update: false
+        ### package_upgrade: runs package update on first boot
+        package_upgrade: true
+        ### packages: installs packages
+        packages:
+          - attr
+          - ntp
+          - screen
+        runcmd:
+          - chown -R training:training /home/training
+          - chsh -s /bin/bash training
+          - { get_attr: ['all_done_handle', 'curl_cli'] }
+
+  host_config:
+    type: OS::Heat::CloudConfig
+    properties:
+      cloud_config:
+        ## users: defines users, sets passwords and SSH authorized keys, and
+        ### enables sudo privileges.
+        users:
+          - default
+          - name: training
+            gecos: Training User
+            groups: users,adm
+            ssh-authorized-keys:
+              - { get_attr: [ training_key, public_key ] }
+            lock-passwd: false
+            shell: /bin/bash
+            sudo: ALL=(ALL) NOPASSWD:ALL
+        ### bootcmd: runs arbitrary commands early in the boot sequence
+        # bootcmd:
+        ### mounts: enables and disables mount points
+        #mounts:
+        #  - [ 'vdb', null ]
+        ### write_files: writes arbitrary files
+        write_files:
+          - path: /etc/cron.d/ntpdate
+            permissions: '0644'
+            content: |
+              # /etc/cron.d/ntpdate: periodically sync the system time to the NTP server
+              SHELL=/bin/sh
+              PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
+              */5 * * * *   root	ntpdate deploy
+          - path: /etc/hosts
+            permissions: '0644'
+            content: |
+              127.0.0.1 localhost
+              192.168.122.100 deploy.example.com deploy
+              192.168.122.114 daisy.example.com daisy
+              192.168.122.115 eric.example.com eric
+              192.168.122.116 frank.example.com frank
+          - path: /etc/network/interfaces.d/eth1.cfg
+            permissions: '0644'
+            content: |
+              auto eth1
+              iface eth1 inet dhcp
+          - path: /home/training/.ssh/id_rsa
+            permissions: '0600'
+            content: { get_attr: [ training_key, private_key ] }
+        apt_proxy: "http://deploy:3142"
+        apt_mirror:
+          str_replace:
+            template: http://%mirror/ubuntu
+            params:
+              "%mirror": { get_param: ubuntu_mirror }
+        ### package_update: refresh package on first boot
+        package_update: true
+        ### package_upgrade: runs package update on first boot
+        package_upgrade: true
+        ### packages: installs packages
+        packages:
+          - screen
+          - attr
+        runcmd:
+          - chown -R training:training /home/training
+          - chsh -s /bin/bash training
+          - { get_attr: ['all_done_handle', 'curl_cli'] }
+
+  server_security_group:
+    type: OS::Neutron::SecurityGroup
+    properties:
+      description: Neutron security group rules
+      name: server_security_group
+      rules:
+      - remote_mode: 'remote_group_id'
+        remote_group_id:
+        direction: ingress
+      - remote_ip_prefix: 0.0.0.0/0
+        protocol: tcp
+        direction: ingress
+        port_range_min: 22
+        port_range_max: 22
+      - remote_ip_prefix: 0.0.0.0/0
+        protocol: icmp
+
+  training_key:
+    type: OS::Nova::KeyPair
+    properties:
+      name: { get_param: 'OS::stack_name' }
+      save_private_key: true
+
+  management_net:
+    type: OS::Neutron::Net
+    properties:
+      name: management-net
+
+  management_sub_net:
+    type: OS::Neutron::Subnet
+    properties:
+      name: management-sub-net
+      network_id: { get_resource: management_net }
+      cidr: 192.168.122.0/24
+      gateway_ip: 192.168.122.1
+      dns_nameservers:
+        - 8.8.8.8
+        - 8.8.4.4
+      enable_dhcp: true
+      allocation_pools:
+        - start: "192.168.122.2"
+          end: "192.168.122.50"
+
+  router:
+    type: OS::Neutron::Router
+
+  router_gateway:
+    type: OS::Neutron::RouterGateway
+    properties:
+      router_id: { get_resource: router }
+      network_id: { get_param: public_net_id }
+
+  router_interface:
+    type: OS::Neutron::RouterInterface
+    properties:
+      router_id: { get_resource: router }
+      subnet_id: { get_resource: management_sub_net }
+
+  data_net:
+    type: OS::Neutron::Net
+    properties:
+      name: data-net
+
+  data_sub_net:
+    type: OS::Neutron::Subnet
+    properties:
+      name: data-sub-net
+      network_id: { get_resource: data_net }
+      cidr: 192.168.133.0/24
+      gateway_ip: ""
+      dns_nameservers:
+        - 8.8.8.8
+        - 8.8.4.4
+      enable_dhcp: true
+      allocation_pools:
+        - start: "192.168.133.2"
+          end: "192.168.133.50"
+
+  deploy:
+    type: OS::Nova::Server
+    properties:
+      name: deploy
+      image: { get_param: image }
+      flavor: { get_param: flavor }
+      user_data:  { get_resource: deploy_config }
+      user_data_format: RAW
+      networks:
+        - port: { get_resource: deploy_management_port }
+        - port: { get_resource: deploy_data_port }
+
+  deploy_management_port:
+    type: OS::Neutron::Port
+    properties:
+      network_id: { get_resource: management_net }
+      fixed_ips:
+        - ip_address: 192.168.122.100
+      security_groups:
+        - { get_resource: server_security_group }
+
+  deploy_data_port:
+    type: OS::Neutron::Port
+    properties:
+      network_id: { get_resource: data_net }
+      fixed_ips:
+        - ip_address: 192.168.133.100
+
+  deploy_floating_ip:
+    type: OS::Neutron::FloatingIP
+    properties:
+      floating_network_id: { get_param: public_net_id }
+      port_id: { get_resource: deploy_management_port }
+      fixed_ip_address: 192.168.122.100
+
+  daisy:
+    type: OS::Nova::Server
+    properties:
+      name: daisy
+      image: { get_param: image }
+      flavor: { get_param: flavor }
+      user_data:  { get_resource: host_config }
+      user_data_format: RAW
+      metadata:
+        wait_condition_data: { get_attr: [ proxy_ready, data ] }
+      networks:
+        - port: { get_resource: daisy_management_port }
+        - port: { get_resource: daisy_data_port }
+
+  daisy_management_port:
+    type: OS::Neutron::Port
+    properties:
+      network_id: { get_resource: management_net }
+      fixed_ips:
+        - ip_address: 192.168.122.114
+      security_groups:
+        - { get_resource: server_security_group }
+
+  daisy_data_port:
+    type: OS::Neutron::Port
+    properties:
+      network_id: { get_resource: data_net }
+      fixed_ips:
+        - ip_address: 192.168.133.114
+
+  eric:
+    type: OS::Nova::Server
+    properties:
+      name: eric
+      image: { get_param: image }
+      flavor: { get_param: flavor }
+      user_data:  { get_resource: host_config }
+      user_data_format: RAW
+      metadata:
+        wait_condition_data: { get_attr: [ proxy_ready, data ] }
+      networks:
+        - port: { get_resource: eric_management_port }
+        - port: { get_resource: eric_data_port }
+
+  eric_management_port:
+    type: OS::Neutron::Port
+    properties:
+      network_id: { get_resource: management_net }
+      fixed_ips:
+        - ip_address: 192.168.122.115
+      security_groups:
+        - { get_resource: server_security_group }
+
+  eric_data_port:
+    type: OS::Neutron::Port
+    properties:
+      network_id: { get_resource: data_net }
+      fixed_ips:
+        - ip_address: 192.168.133.115
+
+  frank:
+    type: OS::Nova::Server
+    properties:
+      name: frank
+      image: { get_param: image }
+      flavor: { get_param: flavor }
+      user_data:  { get_resource: host_config }
+      user_data_format: RAW
+      metadata:
+        wait_condition_data: { get_attr: [ proxy_ready, data ] }
+      networks:
+        - port: { get_resource: frank_management_port }
+        - port: { get_resource: frank_data_port }
+
+  frank_management_port:
+    type: OS::Neutron::Port
+    properties:
+      network_id: { get_resource: management_net }
+      fixed_ips:
+        - ip_address: 192.168.122.116
+      security_groups:
+        - { get_resource: server_security_group }
+
+  frank_data_port:
+    type: OS::Neutron::Port
+    properties:
+      network_id: { get_resource: data_net }
+      fixed_ips:
+        - ip_address: 192.168.133.116
+
+outputs:
+  public_ip:
+    description: Floating IP address of deploy in public network
+    value: { get_attr: [ deploy_floating_ip, floating_ip_address ] }
+  private_key:
+    description: Training private key
+    value: { get_attr: [ training_key, private_key ] }
+  reboot_on_resume:
+    description: Servers to reboot upon resume
+    value:
+      - { get_resource: daisy }
+      - { get_resource: eric }
+      - { get_resource: frank }

src/pip-delete-this-directory.txt

@@ -0,0 +1,5 @@
+This file is placed here by pip to indicate the source was put
+here by pip.
+
+Once this package is successfully installed this source code will be
+deleted (unless you remove this file).

stackamole/__init__.py

@@ -0,0 +1,8 @@
+from importlib import metadata
+# __version__ attribute as suggested by (deferred) PEP 396:
+# https://www.python.org/dev/peps/pep-0396/
+#
+# Single-source package definition as suggested (among several
+# options) by:
+# https://packaging.python.org/guides/single-sourcing-package-version/
+__version__ = metadata.version('stackamole-xblock')

stackamole/admin.py

@@ -0,0 +1,130 @@
+"""
+Admin registration for stackamole Xblock models
+"""
+from django import forms
+from django.contrib import admin
+
+from .common import (
+    DELETE_COMPLETE,
+    SUSPEND_COMPLETE,
+    VALID_STATES,
+    get_xblock_settings
+)
+from .models import Stack, StackLog
+
+
+@admin.action(description="Mark selected stacks as SUSPEND_COMPLETE")
+def mark_suspended(modeladmin, request, queryset):
+    """
+    Mark selected stacks as successfully suspended.
+
+    """
+    queryset.update(status=SUSPEND_COMPLETE)
+
+
+@admin.action(description="Mark selected stacks as DELETE_COMPLETE")
+def mark_deleted(modeladmin, request, queryset):
+    """
+    Mark selected stacks as deleted, and reset the provider.
+
+    """
+    queryset.update(status=DELETE_COMPLETE, provider="")
+
+
+@admin.action(description="Clear stacklog for selected stacks")
+def clear_stacklog(self, request, queryset):
+    logs = StackLog.objects.filter(stack_id__in=queryset.values('id'))
+    logs.delete()
+    self.message_user(
+        request,
+        f'Stacklog cleared for {queryset.count()} stacks!')
+
+
+def student_email(stack):
+    """
+    Display the learner email for admin page.
+
+    """
+    if stack.learner:
+        return stack.learner.email
+    else:
+        return ""
+
+
+student_email.short_description = "Email"
+
+
+class StackAdminForm(forms.ModelForm):
+    """
+    Custom form for constructing `state` and `provider` choices dynamically
+    without the need to modify the model.
+
+    """
+    class Meta:
+        model = Stack
+        exclude = ['id']
+
+    provider = forms.ChoiceField(required=False)
+    status = forms.ChoiceField()
+    delete_by = forms.DateTimeField(required=False)
+
+    def __init__(self, *args, **kwargs):
+        super(StackAdminForm, self).__init__(*args, **kwargs)
+
+        # Gather provider choices.  If the record has `providers` set
+        # (signifying the course author limited which providers this course can
+        # use), only let the user pick from those.  Otherwise, allow any
+        # providers configured in the system.
+        if (self.instance and
+                len(self.instance.providers)):
+            provider_choices = [""] + [p["name"] for p in
+                                       self.instance.providers]
+        else:
+            settings = get_xblock_settings()
+            providers = settings.get("providers", {})
+            provider_choices = [""] + list(providers)
+
+        self.fields["provider"].choices = [(i, i) for i in provider_choices]
+        self.fields["status"].choices = [("", "")] + \
+                                        [(i, i) for i in VALID_STATES]
+
+
+class StackAdmin(admin.ModelAdmin):
+    """
+    Custom stack admin class.  Uses a custom form, enables searching and
+    filtering, and totally excludes fields used by the XBlock solely to
+    communicate with tasks or jobs.  Of the remaining fields, only `status` and
+    `provider` should be editable.
+
+    Adding stacks manually is forbidden, but deleting records is allowed.  A
+    custom action allows marking stacks as `DELETE_COMPLETE` in bulk.
+
+    """
+    form = StackAdminForm
+    list_display = ("name", "course_id", student_email, "status", "provider",
+                    "launch_timestamp",)
+    list_filter = ("course_id", "status", "provider",)
+    list_editable = ("status", "provider")
+    list_select_related = True
+    actions = [mark_suspended, mark_deleted, clear_stacklog]
+    search_fields = (
+        "name", "course_id", "learner__email", "status", "provider")
+    readonly_fields = ("name", student_email, "course_id", "run", "protocol",
+                       "port", "ip", "launch_timestamp", "suspend_timestamp",
+                       "suspend_by", "created_on", "error_msg", "delete_age",)
+    exclude = ("student_id", "providers", "hook_script", "hook_events",
+               "launch_task_id", "user", "key", "password", "learner")
+    ordering = ("-launch_timestamp",)
+
+    def get_changelist_form(self, request, **kwargs):
+        return StackAdminForm
+
+    def has_add_permission(self, request, obj=None):
+        """
+        Adding stacks manually is not supported.
+
+        """
+        return False
+
+
+admin.site.register(Stack, StackAdmin)