42-test-padznich

.dockerignore

@@ -0,0 +1,4 @@
+**/node_modules
+fortytwo/local_settings.py.example
+frontend/dist
+frontend/manifest.json

.editorconfig

@@ -0,0 +1,29 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+max_line_length = 120
+trim_trailing_whitespace = true
+indent_style = space
+quote_type = single
+curly_bracket_next_line	= true
+spaces_around_operators = true
+1indent_brace_style = TBS
+
+[*.html]
+indent_size = 4
+quote_type = double
+
+[*.py]
+indent_size = 4
+
+[Makefile]
+indent_style = tab
+
+[*.{js, jsx, vue}]
+indent_size = 2
+
+[{package.json, .travis.yml}]
+indent_size = 2

.env.example

@@ -0,0 +1,4 @@
+# Remove the variable and all commands in Makefile will use docker
+USE_LOCAL=1
+# If you want deploy app on heroku makefile have "h-deploy" goal, set app name here
+HEROKU_APP_NAME=

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 120
+exclude = *migrations*,fortytwo_test_task/settings/__init__.py,fortytwo_test_task/settings/test.py
+max-complexity = 6

.gitignore

@@ -14,3 +14,11 @@ build
 media
 static
 *.dat
+.env
+.idea/
+fortytwo/local_settings.py
+frontend/node_modules/*
+frontend/dist/*
+frontend/manifest.json
+.coverage
+staticroot

Dockerfile

@@ -0,0 +1,18 @@
+# A single container to publish/run your app on a server
+
+FROM node:15-alpine AS frontend
+WORKDIR /app
+ADD ./frontend /app
+RUN yarn install && yarn build
+
+FROM python:3-alpine
+WORKDIR /app
+ADD . /app
+RUN apk update \
+    && pip install gunicorn \
+    && pip install -r requirements/base.txt \
+    && rm -rf /var/cache/apk/*
+COPY --from=frontend /app ./frontend
+RUN python manage.py collectstatic --noinput
+
+CMD docker/backend-cmd.sh

Makefile

@@ -1,18 +1,94 @@
-MANAGE=django-admin.py
-SETTINGS=fortytwo_test_task.settings
+ifneq (,$(wildcard ./.env))
+	include .env
+	export
+endif
 
-test:
-	PYTHONPATH=`pwd` DJANGO_SETTINGS_MODULE=$(SETTINGS) $(MANAGE) test
+DOCKER_CMD_PREFIX=./docker/compose.sh
+ifeq (,$(USE_LOCAL))
+	MANAGE=$(DOCKER_CMD_PREFIX) run --rm backend python manage.py
+else
+	MANAGE=python manage.py
+endif
+TEST_SETTINGS=fortytwo.test_settings
+TEST_APP=apps/
 
+# Dev servers
 run:
-	PYTHONPATH=`pwd` DJANGO_SETTINGS_MODULE=$(SETTINGS) $(MANAGE) runserver
-
-syncdb:
-	PYTHONPATH=`pwd` DJANGO_SETTINGS_MODULE=$(SETTINGS) $(MANAGE) syncdb --noinput
+	@echo Starting http://127.0.0.1:8000
+ifeq (,$(USE_LOCAL))
+	$(DOCKER_CMD_PREFIX) up
+else
+	(trap 'kill 0' SIGINT; $(MANAGE) runserver & yarn --cwd frontend serve)
+endif
 
+# Database
 migrate:
-	PYTHONPATH=`pwd` DJANGO_SETTINGS_MODULE=$(SETTINGS) $(MANAGE) migrate
+	$(MANAGE) migrate --noinput
+
+migrations:
+	$(MANAGE) makemigrations
+
+createcachetable:
+	@echo Creating cache table
+	$(MANAGE) createcachetable
+
+initproject: migrate createcachetable
+
+# Testing
+shell:
+	@echo Starting shell...
+	$(MANAGE) shell
+
+cmd=black apps && flake8 apps
+lint:
+ifeq (,$(USE_LOCAL))
+	$(DOCKER_CMD_PREFIX) run backend sh -c "$(cmd)"
+else
+	$(cmd)
+endif
+
+djangotest:
+	$(MANAGE) test --settings=$(TEST_SETTINGS) $(TEST_APP) --noinput
+
+coverage:
+	coverage run manage.py test --settings=$(TEST_SETTINGS) $(TEST_APP) && coverage report -i
+
+test: lint djangotest
 
 collectstatic:
-	PYTHONPATH=`pwd` DJANGO_SETTINGS_MODULE=$(SETTINGS) $(MANAGE) collectstatic --noinput
-.PHONY: test syncdb migrate
+	@echo Collecting static files
+	$(MANAGE) collectstatic --noinput
+
+eslint:
+ifeq (,$(USE_LOCAL))
+	$(DOCKER_CMD_PREFIX) run frontend sh -c "yarn --cwd /app/frontend lint src --fix"
+else
+	yarn --cwd frontend lint src --fix
+endif
+
+# Deploy
+DEPLOY_CONT_ID=fortytwotesttask
+build:
+ifeq (,$(USE_LOCAL))
+	docker build --tag=$(DEPLOY_CONT_ID):latest .
+else
+	yarn --cwd frontend install
+	yarn --cwd frontend build
+	$(MAKE) collectstatic
+endif
+
+server:
+ifeq (,$(USE_LOCAL))
+	docker run -p=8000:8000 --rm --name $(DEPLOY_CONT_ID) $(DEPLOY_CONT_ID):latest
+else
+	./docker/backend-cmd.sh
+endif
+
+h-deploy:
+ifeq (,$(HEROKU_APP_NAME))
+	@echo Missing HEROKU_APP_NAME env var
+else
+	@echo Deploying on heroku
+	heroku container:push web --app $(HEROKU_APP_NAME)
+	heroku container:release web --app $(HEROKU_APP_NAME)
+endif

README.md

@@ -1,17 +1,15 @@
 42-test template
 ===========================
 
-A Django 1.6+ project template
+A Django 3+ project template
 
-Use fortytwo_test_task.settings when deploying with getbarista.com
+### System requirements
+* global: yarn, node (tested on v15), python>=3.7 (tested on 3.9) *OR* docker
 
-### Recomendations
-* apps in apps/ folder
-* use per-app templates folders
-* use per-app static folders
-* use migrations
-* use settings.local for different environments
-* common templates live in templates/
-* common static lives in assets/
+### Code/deployment requirements
 * management commands should be proxied to single word make commands, e.g make test
+* app should be deployed on a server of your choice (heroku, pythonanywhere, aws, etc.)
 
+### Initial setup
+You can develop app in docker container or directly on host, check `.env.example`
+Most usable commands are proxied in the `Makefile`

apps/__init__.py

@@ -1 +0,0 @@
-

apps/hello/admin.py

@@ -1,3 +0,0 @@
-from django.contrib import admin
-
-# Register your models here.

apps/hello/api/urls.py

@@ -0,0 +1,9 @@
+from django.urls import path
+
+from apps.hello.api.views import PingView
+
+app_name = "api_hello"
+
+urlpatterns = [
+    path("ping/", PingView.as_view(), name="ping"),
+]

apps/hello/api/views.py

@@ -0,0 +1,7 @@
+from rest_framework import views, status
+from rest_framework.response import Response
+
+
+class PingView(views.APIView):
+    def get(self, request, **kwargs):
+        return Response({"status": True}, status=status.HTTP_200_OK)

apps/hello/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class HelloConfig(AppConfig):
+    name = "apps.hello"

apps/hello/models.py

@@ -1,3 +0,0 @@
-from django.db import models
-
-# Create your models here.

apps/hello/tests/test_api.py

@@ -0,0 +1,11 @@
+from rest_framework.test import APITestCase
+from django.shortcuts import reverse
+
+
+class HelloAPITest(APITestCase):
+    def test_ping(self):
+        """
+        endpoint is accessible and always return same status
+        """
+        response = self.client.get(reverse("api_hello:ping"))
+        self.assertTrue(response.json()["status"])

docker-compose.yaml

@@ -0,0 +1,24 @@
+version: "3.7"
+
+services:
+  backend:
+    build:
+      context: .
+      dockerfile: docker/backend.Dockerfile
+    container_name: backend
+    restart: always
+    volumes:
+      - .:/app
+    ports:
+      - 8000:8000
+
+  frontend:
+    build:
+      context: .
+      dockerfile: docker/frontend.Dockerfile
+    container_name: frontend
+    volumes:
+      - .:/app
+    ports:
+      - 3000:3000
+    user: ${CURRENT_UID}

docker/backend-cmd.sh

@@ -0,0 +1,3 @@
+python manage.py migrate --noinput
+python manage.py createcachetable
+gunicorn fortytwo.wsgi -b 0.0.0.0:"${PORT:-8000}" --reload

docker/backend.Dockerfile

@@ -0,0 +1,12 @@
+FROM python:3-alpine
+
+WORKDIR /app
+COPY . /app
+
+# gcc, libc-dev are flake8 (typed-ast) deps
+RUN apk update \
+    && apk add make gcc libc-dev \
+    && pip install -r requirements/dev.txt \
+    && rm -rf /var/cache/apk/*
+
+CMD docker/backend-cmd.sh

docker/compose.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env sh
+set -x
+# If first argument 'exec' or 'run' adds --user flag, or sets CURRENT_UID flag so you can use it inside your scripts
+
+G_U_ID=$(id -u):$(id -g)
+FIRST_ARG=$1
+shift
+[ "$FIRST_ARG" = "exec" ] || [ "$FIRST_ARG" = "run" ] && FIRST_ARG="$FIRST_ARG --user $G_U_ID"
+# shellcheck disable=SC2086
+CURRENT_UID=$G_U_ID docker-compose $FIRST_ARG "$@"

docker/frontend-cmd.sh

@@ -0,0 +1 @@
+yarn --cwd /app/frontend serve

docker/frontend.Dockerfile

@@ -0,0 +1,7 @@
+FROM node:15-alpine
+
+WORKDIR /app
+COPY . /app
+RUN yarn --cwd /app/frontend install
+
+CMD docker/frontend-cmd.sh