Code test

sulami · sulami · commit 06a700925c06 · 2018-02-14T17:32:45.000Z
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,2 @@
+.git
+*.pyc
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+*.pyc
+.vagrant
+*.log
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,9 @@
+FROM alpine:3.6
+
+RUN apk add --update py3-pip python3 postgresql postgresql-dev zlib-dev libjpeg-turbo-dev gcc python3-dev musl-dev make \
+ && pip3 install --upgrade pip
+RUN if [[ ! -e /usr/bin/python ]]; then ln -sf /usr/bin/python3 /usr/bin/python; fi
+
+WORKDIR /srv/python-code-test
+ADD requirements.in /srv/python-code-test/
+RUN pip3 install -r requirements.in
diff --git a/README.md b/README.md
@@ -0,0 +1,59 @@
+# Ostmodern Python Code Test
+
+The goal of this exercise is to test that you know your way around Django and
+REST APIs. Approach it the way you would an actual long-term project.
+
+The idea is to build a platform on which your users can buy and sell Starships.
+To make this process more transparent, it has been decided to source some
+technical information about the Starships on sale from the [Starship
+API](https://swapi.co/documentation#starships).
+
+A Django project some initial data models have been created already. You may need
+to do some additional data modelling to satify the requirements.
+
+## Getting started
+
+* This test works with either
+  [Docker](https://docs.docker.com/compose/install/#install-compose) or
+  [Vagrant](https://www.vagrantup.com/downloads.html)
+* Get the code from `https://github.com/ostmodern/python-code-test`
+* Do all your work in your own `develop` branch
+* Once you have downloaded the code the following commands will get the site up
+  and running
+
+```shell
+# For Docker
+docker-compose up
+# You can run `manage.py` commands using the `./manapy` wrapper
+
+# For Vagrant
+vagrant up
+vagrant ssh
+# Inside the box
+./manage.py runserver 0.0.0.0:8008
+```
+* The default Django "It worked!" page should now be available at
+  http://localhost:8008/
+
+## Tasks
+
+Your task is to build a JSON-based REST API for your frontend developers to
+consume. You have built a list of user stories with your colleagues, but you get
+to decide how to design the API. Remember that the frontend developers will need
+some documentation of your API to understand how to use it.
+
+We do not need you to implement users or authentication, to reduce the amount of
+time this exercise will take to complete. You may use any external libraries you
+require.
+
+* We need to be able to import all existing
+  [Starships](https://swapi.co/documentation#starships) to the provided Starship
+  Model
+* A potential buyer can browse all Starships
+* A potential buyer can browse all the listings for a given `starship_class`
+* A potential buyer can sort listings by price or time of listing
+* To list a Starship as for sale, the user should supply the Starship name and
+  list price
+* A seller can deactivate and reactivate their listing
+
+After you are done, create a release branch in your repo and send us the link.
diff --git a/Vagrantfile b/Vagrantfile
@@ -0,0 +1,18 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+    config.vm.box = "ubuntu/xenial64"
+
+    # Django runserver networking
+    config.vm.network "forwarded_port", guest: 8008, host: 8008
+
+    config.vm.provision "shell", path:"./scripts/setup-server.sh"
+
+    config.vm.provider :virtualbox do |vb, override|
+        vb.memory = 512
+    end
+end
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,18 @@
+version: "3"
+services:
+  code-test:
+    build:
+      context: .
+    command: "scripts/runserver"
+    volumes:
+      - .:/srv/python-code-test
+    ports:
+      - "8008:8008"
+    links:
+      - postgresql
+  postgresql:
+    image: postgres:9.6
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: postgres
diff --git a/manage.py b/manage.py
@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testsite.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)
diff --git a/manapy b/manapy
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+docker-compose run --rm code-test ./manage.py $*
diff --git a/requirements.in b/requirements.in
@@ -0,0 +1,3 @@
+django>=1.11,<2.0
+Pillow>=3.4.1,<3.5
+psycopg2>=2.6.2,<2.7
diff --git a/scripts/runserver b/scripts/runserver
@@ -0,0 +1,10 @@
+#!/bin/sh
+
+until PGPASSWORD=postgres psql --host postgresql --username postgres -c '\l' > /dev/null; do
+  echo "Postgres is unavailable - sleeping"
+  sleep 1
+done
+
+export PYTHONUNBUFFERED=0
+./manage.py migrate
+./manage.py runserver 0.0.0.0:8008
diff --git a/scripts/setup-server-user.sh b/scripts/setup-server-user.sh
@@ -0,0 +1,33 @@
+#!/bin/bash
+# VirtualEnv and Django setup
+
+USER=ubuntu
+
+# Set up virtualenv directory for the user if required
+if [ ! -d /home/$USER/.virtualenvs ]; then
+    mkdir /home/$USER/.virtualenvs
+fi
+
+# write all the profile stuff for the user if required
+grep -q virtualenvs /home/$USER/.bashrc
+if [ $? -ne 0 ]; then
+    echo -e "\033[0;31m > Updating profile file\033[0m"
+    echo "source ~/.virtualenvs/code-test/bin/activate" >> /home/$USER/.bashrc
+    echo "cd /vagrant/" >> /home/$USER/.bashrc
+fi
+
+echo -e "\033[0;34m > Setting up virtualenv\033[0m"
+export WORKON_HOME=/home/$USER/.virtualenvs
+export PIP_VIRTUALENV_BASE=/home/$USER/.virtualenvs
+python3 -m venv $PIP_VIRTUALENV_BASE/code-test
+source $PIP_VIRTUALENV_BASE/code-test/bin/activate
+
+# install requirements
+echo -e "\033[0;34m > Installing the pip requirements.\033[0m"
+$PIP_VIRTUALENV_BASE/code-test/bin/pip install -U pip
+$PIP_VIRTUALENV_BASE/code-test/bin/pip install wheel==0.29.0
+$PIP_VIRTUALENV_BASE/code-test/bin/pip install -r /vagrant/requirements.in
+
+# setup db state
+cd /vagrant
+./manage.py migrate
diff --git a/scripts/setup-server.sh b/scripts/setup-server.sh
@@ -0,0 +1,15 @@
+#!/bin/bash
+USER=ubuntu
+
+apt-get update
+apt-get install -y git vim build-essential python3.5-dev python3-venv \
+  libncurses5-dev fabric postgresql-9.5 postgresql-server-dev-9.5 \
+  libjpeg62-dev zlib1g-dev libfreetype6-dev
+
+sudo -u postgres psql -c "CREATE DATABASE postgres ENCODING='UTF8' TEMPLATE=template0;"
+sudo -u postgres psql -c "CREATE USER ubuntu;"
+sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE postgres TO ubuntu;"
+sudo -u postgres psql -c "ALTER USER ubuntu CREATEDB;"
+
+chmod +x /vagrant/scripts/setup-server-user.sh
+sudo -H -u $USER /vagrant/scripts/setup-server-user.sh
diff --git a/shiptrader/__init__.py b/shiptrader/__init__.py
diff --git a/shiptrader/admin.py b/shiptrader/admin.py
@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.
diff --git a/shiptrader/migrations/0001_initial.py b/shiptrader/migrations/0001_initial.py
@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.9 on 2018-01-16 13:15
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Listing',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=255)),
+                ('price', models.IntegerField()),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Starship',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('starship_class', models.CharField(max_length=255)),
+                ('manufacturer', models.CharField(max_length=255)),
+                ('length', models.FloatField()),
+                ('hyperdrive_rating', models.FloatField()),
+                ('cargo_capacity', models.BigIntegerField()),
+                ('crew', models.IntegerField()),
+                ('passengers', models.IntegerField()),
+            ],
+        ),
+        migrations.AddField(
+            model_name='listing',
+            name='ship_type',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='listings', to='shiptrader.Starship'),
+        ),
+    ]
diff --git a/shiptrader/migrations/__init__.py b/shiptrader/migrations/__init__.py
diff --git a/shiptrader/models.py b/shiptrader/models.py
@@ -0,0 +1,19 @@
+from django.db import models
+
+
+class Starship(models.Model):
+    starship_class = models.CharField(max_length=255)
+    manufacturer = models.CharField(max_length=255)
+
+    length = models.FloatField()
+    hyperdrive_rating = models.FloatField()
+    cargo_capacity = models.BigIntegerField()
+
+    crew = models.IntegerField()
+    passengers = models.IntegerField()
+
+
+class Listing(models.Model):
+    name = models.CharField(max_length=255)
+    ship_type = models.ForeignKey(Starship, related_name='listings')
+    price = models.IntegerField()
diff --git a/shiptrader/tests.py b/shiptrader/tests.py
@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.
diff --git a/shiptrader/views.py b/shiptrader/views.py
@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.
diff --git a/testsite/__init__.py b/testsite/__init__.py
diff --git a/testsite/settings.py b/testsite/settings.py
diff --git a/testsite/urls.py b/testsite/urls.py
diff --git a/testsite/wsgi.py b/testsite/wsgi.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#!/bin/bash`
	`2`	`+`
	`3`	`+docker-compose run --rm code-test ./manage.py $*`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+django>=1.11,<2.0`
	`2`	`+Pillow>=3.4.1,<3.5`
	`3`	`+psycopg2>=2.6.2,<2.7`