From 048668da5a2f53308a785997cc438126a1738938 Mon Sep 17 00:00:00 2001 From: Nicolas Setton Date: Sat, 6 May 2017 22:38:32 -0400 Subject: [PATCH] Initial revision --- .gitignore | 2 + app/__init__.py | 0 app/admin.py | 6 + app/apps.py | 8 ++ app/migrations/__init__.py | 0 app/models.py | 6 + app/tests.py | 6 + app/views.py | 6 + compile_server/__init__.py | 0 compile_server/app/__init__.py | 0 compile_server/app/admin.py | 6 + compile_server/app/apps.py | 8 ++ compile_server/app/management/__init__.py | 0 .../app/management/commands/__init__.py | 0 .../app/management/commands/fill_examples.py | 24 ++++ compile_server/app/migrations/0001_initial.py | 23 +++ .../0002_example_resource_tooloutput.py | 39 ++++++ compile_server/app/migrations/__init__.py | 0 compile_server/app/models.py | 48 +++++++ compile_server/app/serializers.py | 31 ++++ compile_server/app/tests.py | 6 + compile_server/app/views.py | 59 ++++++++ compile_server/settings.py | 132 ++++++++++++++++++ compile_server/urls.py | 44 ++++++ compile_server/wsgi.py | 16 +++ design/notes.txt | 5 + langserv.gpr | 24 ++++ manage.py | 22 +++ 28 files changed, 521 insertions(+) create mode 100644 .gitignore create mode 100644 app/__init__.py create mode 100644 app/admin.py create mode 100644 app/apps.py create mode 100644 app/migrations/__init__.py create mode 100644 app/models.py create mode 100644 app/tests.py create mode 100644 app/views.py create mode 100644 compile_server/__init__.py create mode 100644 compile_server/app/__init__.py create mode 100644 compile_server/app/admin.py create mode 100644 compile_server/app/apps.py create mode 100644 compile_server/app/management/__init__.py create mode 100644 compile_server/app/management/commands/__init__.py create mode 100644 compile_server/app/management/commands/fill_examples.py create mode 100644 compile_server/app/migrations/0001_initial.py create mode 100644 compile_server/app/migrations/0002_example_resource_tooloutput.py create mode 100644 compile_server/app/migrations/__init__.py create mode 100644 compile_server/app/models.py create mode 100644 compile_server/app/serializers.py create mode 100644 compile_server/app/tests.py create mode 100644 compile_server/app/views.py create mode 100644 compile_server/settings.py create mode 100644 compile_server/urls.py create mode 100644 compile_server/wsgi.py create mode 100644 design/notes.txt create mode 100644 langserv.gpr create mode 100755 manage.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8d57caf --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*.pyc +db.sqlite3 diff --git a/app/__init__.py b/app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/admin.py b/app/admin.py new file mode 100644 index 0000000..13be29d --- /dev/null +++ b/app/admin.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +from django.contrib import admin + +# Register your models here. diff --git a/app/apps.py b/app/apps.py new file mode 100644 index 0000000..210f2a4 --- /dev/null +++ b/app/apps.py @@ -0,0 +1,8 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +from django.apps import AppConfig + + +class AppConfig(AppConfig): + name = 'app' diff --git a/app/migrations/__init__.py b/app/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/models.py b/app/models.py new file mode 100644 index 0000000..1dfab76 --- /dev/null +++ b/app/models.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +from django.db import models + +# Create your models here. diff --git a/app/tests.py b/app/tests.py new file mode 100644 index 0000000..5982e6b --- /dev/null +++ b/app/tests.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +from django.test import TestCase + +# Create your tests here. diff --git a/app/views.py b/app/views.py new file mode 100644 index 0000000..e784a0b --- /dev/null +++ b/app/views.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +from django.shortcuts import render + +# Create your views here. diff --git a/compile_server/__init__.py b/compile_server/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/compile_server/app/__init__.py b/compile_server/app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/compile_server/app/admin.py b/compile_server/app/admin.py new file mode 100644 index 0000000..13be29d --- /dev/null +++ b/compile_server/app/admin.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +from django.contrib import admin + +# Register your models here. diff --git a/compile_server/app/apps.py b/compile_server/app/apps.py new file mode 100644 index 0000000..210f2a4 --- /dev/null +++ b/compile_server/app/apps.py @@ -0,0 +1,8 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +from django.apps import AppConfig + + +class AppConfig(AppConfig): + name = 'app' diff --git a/compile_server/app/management/__init__.py b/compile_server/app/management/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/compile_server/app/management/commands/__init__.py b/compile_server/app/management/commands/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/compile_server/app/management/commands/fill_examples.py b/compile_server/app/management/commands/fill_examples.py new file mode 100644 index 0000000..2584ec8 --- /dev/null +++ b/compile_server/app/management/commands/fill_examples.py @@ -0,0 +1,24 @@ +# The manage.py command to enter examples in the database. +# This is meant to be used by the administrators of the project only. +import os +from django.core.management.base import BaseCommand + + +class Command(BaseCommand): + + def add_arguments(self, parser): + parser.add_argument('--remove_all', const=True, default=False, + action='store_const', + help='remove all examples from the database') + + parser.add_argument('--dirs', nargs='+', type=str, + help='add the examples found in the given dirs') + + def handle(self, *args, **options): + + if 'remove_all' in + + #where = options['add_dir'] + + #if not os.path.isdir(where): + # print "Pass a directory to --dir" diff --git a/compile_server/app/migrations/0001_initial.py b/compile_server/app/migrations/0001_initial.py new file mode 100644 index 0000000..9dc3810 --- /dev/null +++ b/compile_server/app/migrations/0001_initial.py @@ -0,0 +1,23 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.11 on 2017-05-05 17:06 +from __future__ import unicode_literals + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ] + + operations = [ + migrations.CreateModel( + name='Program', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('code', models.TextField()), + ], + ), + ] diff --git a/compile_server/app/migrations/0002_example_resource_tooloutput.py b/compile_server/app/migrations/0002_example_resource_tooloutput.py new file mode 100644 index 0000000..7ec5130 --- /dev/null +++ b/compile_server/app/migrations/0002_example_resource_tooloutput.py @@ -0,0 +1,39 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.11 on 2017-05-06 01:37 +from __future__ import unicode_literals + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('app', '0001_initial'), + ] + + operations = [ + migrations.CreateModel( + name='Example', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('name', models.TextField(unique=True)), + ('description', models.TextField()), + ], + ), + migrations.CreateModel( + name='Resource', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('name', models.TextField()), + ('contents', models.TextField()), + ], + ), + migrations.CreateModel( + name='ToolOutput', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('status', models.IntegerField()), + ('output', models.TextField()), + ], + ), + ] diff --git a/compile_server/app/migrations/__init__.py b/compile_server/app/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/compile_server/app/models.py b/compile_server/app/models.py new file mode 100644 index 0000000..3747bef --- /dev/null +++ b/compile_server/app/models.py @@ -0,0 +1,48 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +from django.db import models + +# Create your models here. + + +class Program(models.Model): + """That's a program for ya!""" + + # The code + code = models.TextField() + + +class ToolOutput(models.Model): + """The result on running a tool on a program""" + + # The exit code + status = models.IntegerField() + + # The complete raw output + output = models.TextField() + + +class Resource(models.Model): + """This represents a file or a directory. + """ + + # Base name of the resource + name = models.TextField() + + # The contents of the resource + contents = models.TextField() + + # TODO: if necessary (not sure it is) we can add + # fields to represent a hierarchy of resources. + + +class Example(models.Model): + """One example to present to the user. + """ + + # The unique name of the example + name = models.TextField(unique=True) + + # A description + description = models.TextField() diff --git a/compile_server/app/serializers.py b/compile_server/app/serializers.py new file mode 100644 index 0000000..c28bb0a --- /dev/null +++ b/compile_server/app/serializers.py @@ -0,0 +1,31 @@ +from django.contrib.auth.models import User, Group +from rest_framework import serializers +from compile_server.app.models import Program + + +class UserSerializer(serializers.HyperlinkedModelSerializer): + class Meta: + model = User + fields = ('url', 'username', 'email', 'groups') + + +class GroupSerializer(serializers.HyperlinkedModelSerializer): + class Meta: + model = Group + fields = ('url', 'name') + + +class ProgramSerializer(serializers.Serializer): + class Meta: + model = Program + fields = ('code') + + code = serializers.CharField(style={'base_template': 'textarea.html'}) + + def create(self, validated_data): + return Snippet.objects.create(**validated_data) + + def update(self, instance, validated_data): + instance.code = validated_data.get('code', instance.code) + instance.save() # do we actually want to save programs? + return instance diff --git a/compile_server/app/tests.py b/compile_server/app/tests.py new file mode 100644 index 0000000..5982e6b --- /dev/null +++ b/compile_server/app/tests.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +from django.test import TestCase + +# Create your tests here. diff --git a/compile_server/app/views.py b/compile_server/app/views.py new file mode 100644 index 0000000..cc5d096 --- /dev/null +++ b/compile_server/app/views.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +import json + +from django.shortcuts import render + +# Create your views here. + +from django.contrib.auth.models import User, Group +from rest_framework import viewsets, status +from rest_framework.decorators import api_view +from rest_framework.response import Response +from compile_server.app.serializers import (UserSerializer, + GroupSerializer, + ProgramSerializer) + +from compile_server.app.models import Program + + +class UserViewSet(viewsets.ModelViewSet): + """ + API endpoint that allows users to be viewed or edited. + """ + queryset = User.objects.all().order_by('-date_joined') + serializer_class = UserSerializer + + +class GroupViewSet(viewsets.ModelViewSet): + """ + API endpoint that allows groups to be viewed or edited. + """ + queryset = Group.objects.all() + serializer_class = GroupSerializer + + +class ProgramSet(viewsets.ModelViewSet): + """View/Edit""" + queryset = Program.objects.all() + serializer_class = ProgramSerializer + + +@api_view(['POST']) +def check_program(request): + received_json = json.loads(request.body) + p = Program(code=received_json['program']) + serializer = ProgramSerializer(p) + + return Response(serializer.data) + + +@api_view(['GET']) +def examples(request): + return Response() + + +@api_view(['GET']) +def example(request, name): + return Response() diff --git a/compile_server/settings.py b/compile_server/settings.py new file mode 100644 index 0000000..44ff743 --- /dev/null +++ b/compile_server/settings.py @@ -0,0 +1,132 @@ +""" +Django settings for compile_server project. + +Generated by 'django-admin startproject' using Django 1.11. + +For more information on this file, see +https://docs.djangoproject.com/en/1.11/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/1.11/ref/settings/ +""" + +import os + +# Build paths inside the project like this: os.path.join(BASE_DIR, ...) +BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'ci!nks6jg!qxsk2gc1hpdld=&kxqqqotm)(5$^ork&=o#t3+v$' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = [] + + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + + 'rest_framework', + 'compile_server.app' +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', +] + +ROOT_URLCONF = 'compile_server.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'compile_server.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/1.11/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), + } +} + + +# Password validation +# https://docs.djangoproject.com/en/1.11/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', + }, +] + + +# Internationalization +# https://docs.djangoproject.com/en/1.11/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_L10N = True + +USE_TZ = True + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/1.11/howto/static-files/ + +STATIC_URL = '/static/' + +REST_FRAMEWORK = { + 'DEFAULT_PERMISSION_CLASSES': [ + # Deactivating authentication! + # TODO: in production, authenticate? ... or not, after all + # 'rest_framework.permissions.IsAdminUser', + ], + 'PAGE_SIZE': 10 +} diff --git a/compile_server/urls.py b/compile_server/urls.py new file mode 100644 index 0000000..625b481 --- /dev/null +++ b/compile_server/urls.py @@ -0,0 +1,44 @@ +"""compile_server URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/1.11/topics/http/urls/ +Examples: +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: url(r'^$', views.home, name='home') +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: url(r'^$', Home.as_view(), name='home') +Including another URLconf + 1. Import the include() function: from django.conf.urls import url, include + 2. Add a URL to urlpatterns: url(r'^blog/', include('blog.urls')) +""" +from django.conf.urls import url, include +from django.contrib import admin + +from rest_framework import routers + +from compile_server.app import views + +router = routers.DefaultRouter() +router.register(r'users', views.UserViewSet) +router.register(r'groups', views.GroupViewSet) +router.register(r'programs', views.ProgramSet) + +urlpatterns = [ + url(r'^', include(router.urls)), + url(r'^api-auth/', include('rest_framework.urls', + namespace='rest_framework')), + url(r'^admin/', admin.site.urls), + + # Check one program + url(r'^check_program/', views.check_program), + + url(r'^examples/', views.examples), + + # Get a list of the examples + url(r'^examples/', views.examples), + + # Get the details on one example + url(r'^example/([^/])+', views.example), +] diff --git a/compile_server/wsgi.py b/compile_server/wsgi.py new file mode 100644 index 0000000..b8280ce --- /dev/null +++ b/compile_server/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for compile_server project. + +It exposes the WSGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/1.11/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "compile_server.settings") + +application = get_wsgi_application() diff --git a/design/notes.txt b/design/notes.txt new file mode 100644 index 0000000..ee7f9cd --- /dev/null +++ b/design/notes.txt @@ -0,0 +1,5 @@ +Notes just for myself + +# Command to use curl to check a program +# Add -u : when using authentication +curl -H 'Accept: application/json; indent=4' http://127.0.0.1:8000/check_program/ --data "{\"program\": \"hello\"}" --header "Content-Type:application/json" diff --git a/langserv.gpr b/langserv.gpr new file mode 100644 index 0000000..61d59f0 --- /dev/null +++ b/langserv.gpr @@ -0,0 +1,24 @@ +project langserv is + + for Languages use ("Python", "Text"); + + package Naming is + for Implementation_Suffix ("Text") use ".txt"; + end Naming; + + for Source_Dirs use (-- The django base + ".", + "compile_server", + + -- The actual app + "compile_server/app", + + -- Where the manage.py custom commands are + "compile_server/app/management/commands", + + -- Some design docs + "design" + ); + + +end langserv; diff --git a/manage.py b/manage.py new file mode 100755 index 0000000..55c3f57 --- /dev/null +++ b/manage.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +import os +import sys + +if __name__ == "__main__": + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "compile_server.settings") + try: + from django.core.management import execute_from_command_line + except ImportError: + # The above import may fail for some other reason. Ensure that the + # issue is really that Django is missing to avoid masking other + # exceptions on Python 2. + try: + import django + except ImportError: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) + raise + execute_from_command_line(sys.argv)