add visitor model and api

.gitlab-ci.yml

@@ -1,7 +1,6 @@
 variables:
   CI_PROJECT_DIR: "."
   CI_REGISTRY_IMAGE: hub.ducoterra.net/ducoterra/mysite
-  DEPLOY: test
 
 stages:
   - build
@@ -17,34 +16,61 @@ build:
     name: gcr.io/kaniko-project/executor:debug
     entrypoint: [""]
   script:
+    - echo $DEPLOY
     - /kaniko/executor --context $CI_PROJECT_DIR --dockerfile $CI_PROJECT_DIR/Dockerfile --destination $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG
 
 test:
+  stage: test
   only:
     variables:
     - $CI_COMMIT_TAG
-  stage: test
   image:
     name: $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG
     entrypoint: [""]
   script:
     - python manage.py test
 
-deploy:
+deploy_to_test:
+  variables:
+    DEPLOY: test
+  stage: deploy
   only:
     variables:
     - $CI_COMMIT_TAG
-  stage: deploy
   image:
-    name: debian:latest
+    name: debian:10
     entrypoint: [""]
   script:
-    - echo $CI_REGISTRY_IMAGE
     - apt -qq update >> /dev/null && apt -qq install -y curl gettext >> /dev/null
     - curl -LO https://storage.googleapis.com/kubernetes-release/release/`curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt`/bin/linux/amd64/kubectl
     - chmod +x ./kubectl
-    - envsubst < k8s/deploy.yaml > out.yaml
+    - mkdir /deploy
-    - mv out.yaml k8s/deploy.yaml
+    - for f in $(find k8s -regex '.*\.ya*ml'); do envsubst < $f > "/deploy/$(basename $f)"; done
-    - ./kubectl apply -f k8s
+    - for f in $(find k8s/test -regex '.*\.ya*ml'); do envsubst < $f > "/deploy/$(basename $f)"; done
+    - ./kubectl apply -f /deploy
     - ./kubectl rollout status deploy $DEPLOY
-    - ./kubectl exec $(./kubectl get pods --selector=app=$DEPLOY --output=jsonpath='{.items[*].metadata.name}') -- python manage.py migrate
+    - POD=$(./kubectl get pods --selector=app=$DEPLOY --output=jsonpath='{.items[*].metadata.name}')
+    - ./kubectl exec $POD -- python manage.py migrate
+
+deploy_to_prod:
+  variables:
+    DEPLOY: prod
+  stage: deploy
+  only:
+    variables:
+    - $CI_COMMIT_TAG
+  when: manual
+  image:
+    name: debian:10
+    entrypoint: [""]
+  script:
+    - apt -qq update >> /dev/null && apt -qq install -y curl gettext >> /dev/null
+    - curl -LO https://storage.googleapis.com/kubernetes-release/release/`curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt`/bin/linux/amd64/kubectl
+    - chmod +x ./kubectl
+    - mkdir /deploy
+    - for f in $(find k8s -regex '.*\.ya*ml'); do envsubst < $f > "/deploy/$(basename $f)"; done
+    - for f in $(find k8s/prod -regex '.*\.ya*ml'); do envsubst < $f > "/deploy/$(basename $f)"; done
+    - ./kubectl apply -f /deploy
+    - ./kubectl rollout status deploy $DEPLOY
+    - POD=$(./kubectl get pods --selector=app=$DEPLOY --output=jsonpath='{.items[*].metadata.name}')
+    - ./kubectl exec $POD -- python manage.py migrate

.vscode/launch.json

@@ -5,7 +5,7 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "Python: Django",
+            "name": "Test",
             "type": "python",
             "request": "launch",
             "program": "${workspaceFolder}/manage.py",
@@ -13,6 +13,17 @@
                 "test",
             ],
             "django": true
+        },
+        {
+            "name": "Run Server",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/manage.py",
+            "args": [
+                "runserver",
+                "--noreload"
+            ],
+            "django": true
         }
     ]
 }

Dockerfile

@@ -6,12 +6,12 @@ COPY api api
 COPY ui ui
 COPY manage.py manage.py
 COPY requirements.txt requirements.txt
+RUN pip install -r requirements.txt
 
 RUN useradd -ms /bin/bash django
 RUN chown -R django .
 
 USER django
-RUN pip install -r requirements.txt --user
 RUN python manage.py collectstatic
 
 CMD ["gunicorn","-b",":8000", "-w", "4", "config.wsgi"]

README.md

@@ -3,3 +3,22 @@
 My CI testing pipeline for a django project.
 
 [![pipeline status](http://gitlab.ducoterra.net/ducoterra/ci_builder/badges/master/pipeline.svg)](http://gitlab.ducoterra.net/ducoterra/ci_builder/-/commits/master)
+
+## Django Environment Variables
+
+### Django Secret
+
+```bash
+kubectl create secret generic django-secrets --from-literal=SECRET_KEY=$(python -c "import secrets ; print(secrets.token_urlsafe(32))")
+```
+
+### Django Allowed Hosts
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  ALLOWED_HOSTS: localhost,test.ducoterra.net
+```

api/migrations/0002_auto_20200426_1517.py

@@ -0,0 +1,25 @@
+# Generated by Django 3.0.5 on 2020-04-26 15:17
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Visitor',
+            fields=[
+                ('name', models.CharField(max_length=255, primary_key=True, serialize=False)),
+                ('clicked', models.IntegerField(blank=True, default=0)),
+                ('first_pressed', models.DateTimeField(auto_now_add=True)),
+                ('last_pressed', models.DateTimeField(auto_now=True)),
+            ],
+        ),
+        migrations.DeleteModel(
+            name='Snippet',
+        ),
+    ]

api/migrations/0003_auto_20200426_1526.py

@@ -0,0 +1,23 @@
+# Generated by Django 3.0.5 on 2020-04-26 15:26
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0002_auto_20200426_1517'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='visitor',
+            name='first_pressed',
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='visitor',
+            name='last_pressed',
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+    ]

api/models.py

@@ -1,19 +1,11 @@
 from django.db import models
-from pygments.lexers import get_all_lexers
+from datetime import datetime
-from pygments.styles import get_all_styles
 
-LEXERS = [item for item in get_all_lexers() if item[1]]
+class Visitor(models.Model):
-LANGUAGE_CHOICES = sorted([(item[1][0], item[0]) for item in LEXERS])
+    name = models.CharField(
-STYLE_CHOICES = sorted([(item, item) for item in get_all_styles()])
+        primary_key=True,
-
+        max_length = 255
-
+    )
-class Snippet(models.Model):
+    clicked = models.IntegerField(default = 0, blank=True)
-    created = models.DateTimeField(auto_now_add=True)
+    first_pressed = models.DateTimeField(blank=True, null=True)
-    title = models.CharField(max_length=100, blank=True, default='')
+    last_pressed = models.DateTimeField(blank=True, null=True)
-    code = models.TextField()
-    linenos = models.BooleanField(default=False)
-    language = models.CharField(choices=LANGUAGE_CHOICES, default='python', max_length=100)
-    style = models.CharField(choices=STYLE_CHOICES, default='friendly', max_length=100)
-
-    class Meta:
-        ordering = ['created']

api/serializers.py

@@ -1,29 +1,23 @@
 from rest_framework import serializers
-from .models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES
+from .models import *
 
 
-class SnippetSerializer(serializers.Serializer):
+class VisitorSerializer(serializers.Serializer):
-    id = serializers.IntegerField(read_only=True)
+    name = serializers.CharField(required=True)
-    title = serializers.CharField(required=False, allow_blank=True, max_length=100)
+    clicked = serializers.IntegerField(read_only=True)
-    code = serializers.CharField(style={'base_template': 'textarea.html'})
+    first_pressed = serializers.DateTimeField(read_only=True)
-    linenos = serializers.BooleanField(required=False)
+    last_pressed = serializers.DateTimeField(read_only=True)
-    language = serializers.ChoiceField(choices=LANGUAGE_CHOICES, default='python')
-    style = serializers.ChoiceField(choices=STYLE_CHOICES, default='friendly')
 
     def create(self, validated_data):
         """
-        Create and return a new `Snippet` instance, given the validated data.
+        Create and return a new `Visitor` instance, given the validated data.
         """
-        return Snippet.objects.create(**validated_data)
+        return Visitor.objects.create(**validated_data)
 
     def update(self, instance, validated_data):
         """
         Update and return an existing `Snippet` instance, given the validated data.
         """
-        instance.title = validated_data.get('title', instance.title)
+        instance.name = validated_data.get('name', instance.name)
-        instance.code = validated_data.get('code', instance.code)
-        instance.linenos = validated_data.get('linenos', instance.linenos)
-        instance.language = validated_data.get('language', instance.language)
-        instance.style = validated_data.get('style', instance.style)
         instance.save()
         return instance

api/tests.py

@@ -1,42 +1,53 @@
 from django.contrib.auth.models import AnonymousUser, User
 from django.test import RequestFactory, TestCase
+from django.db.utils import IntegrityError
 
-from .views import SnippetList, SnippetDetail
+from .views import *
 
 class SimpleTest(TestCase):
     def setUp(self):
         # Every test needs access to the request factory.
         self.factory = RequestFactory()
-        self.user = User.objects.create_user(
+        # self.user = User.objects.create_user(
-            username='testuser', email='test@test.test', password='testpass')
+        #     username='testuser', email='test@test.test', password='testpass')
 
-    def test_snippets(self):
+    def test_list_visitors(self):
         # Create an instance of a GET request.
-        request = self.factory.get('/snippets')
+        request = self.factory.get('/visitors')
 
         # Recall that middleware are not supported. You can simulate a
         # logged-in user by setting request.user manually.
-        request.user = self.user
+        # request.user = self.user
 
         # Or you can simulate an anonymous user by setting request.user to
         # an AnonymousUser instance.
         # request.user = AnonymousUser()
 
         # Test my_view() as if it were deployed at /customer/details
-        response = SnippetList.as_view()(request)
+        response = VisitorList.as_view()(request)
         # Use this syntax for class-based views.
         # response = MyView.as_view()(request)
         self.assertEqual(response.status_code, 200)
 
 
-        request = self.factory.post('/snippets', data={
+    def test_add_visitor(self):
-            'title': 'test1',
+        request = self.factory.post('/visitors', data={
-            'code': '() => {console.log("hello")};',
+            'name': 'test',
-            'lineos': False,
-            'language': 'js',
-            'style': 'abap'
             },
             content_type='application/json'
         )
-        response = SnippetList.as_view()(request)
+        response = VisitorList.as_view()(request)
         self.assertEqual(response.status_code, 201)
+
+        vis = Visitor.objects.get(name='test')
+        self.assertEqual(vis.clicked, 0)
+        self.assertIsNone(vis.first_pressed)
+        self.assertIsNone(vis.last_pressed)
+
+        with self.assertRaises(IntegrityError):
+            request = self.factory.post('/visitors', data={
+                'name': 'test',
+                },
+                content_type='application/json'
+            )
+            response = VisitorList.as_view()(request)

api/urls.py

@@ -3,8 +3,8 @@ from rest_framework.urlpatterns import format_suffix_patterns
 from . import views
 
 urlpatterns = [
-    path('snippets/', views.SnippetList.as_view()),
+    path('visitor/', views.VisitorList.as_view()),
-    path('snippets/<int:pk>/', views.SnippetDetail.as_view()),
+    path('visitor/<str:pk>/', views.VisitorDetail.as_view()),
 ]
 
 urlpatterns = format_suffix_patterns(urlpatterns)

api/views.py

@@ -1,15 +1,15 @@
-from .models import Snippet
+from .models import *
-from .serializers import SnippetSerializer
+from .serializers import *
 from rest_framework import generics
 
 
-class SnippetList(generics.ListCreateAPIView):
+class VisitorList(generics.ListCreateAPIView):
     # Add comments here
-    queryset = Snippet.objects.all()
+    queryset = Visitor.objects.all()
-    serializer_class = SnippetSerializer
+    serializer_class = VisitorSerializer
 
 
-class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
+class VisitorDetail(generics.RetrieveUpdateDestroyAPIView):
     # Add comments here
-    queryset = Snippet.objects.all()
+    queryset = Visitor.objects.all()
-    serializer_class = SnippetSerializer
+    serializer_class = VisitorSerializer

config/settings.py

@@ -20,13 +20,12 @@ BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 # See https://docs.djangoproject.com/en/3.0/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = 'b8fi9=f-qj=@-#1iru34-f@a6pzfysgrf(1n_&d=ur%!1w$q*w'
+SECRET_KEY = os.getenv("SECRET_KEY")
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True if os.getenv("DEBUG") == "True" else False
 
-ALLOWED_HOSTS = ["localhost", "test.ducoterra.net"]
+ALLOWED_HOSTS = os.getenv("ALLOWED_HOSTS", "localhost").split(",")
-
 
 # Application definition
 

config/urls.py

@@ -18,7 +18,7 @@ from django.urls import path, include
 from django.http import JsonResponse
 
 urlpatterns = [
-    path('', include('api.urls')),
+    path('api/', include('api.urls')),
     path('', include('ui.urls')),
-    path('admin/', admin.site.urls),
+    # path('admin/', admin.site.urls),
 ]

k8s/configmap.yaml

@@ -0,0 +1,6 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: $DEPLOY
+data:
+  ALLOWED_HOSTS: localhost,$DEPLOY.ducoterra.net

k8s/deploy.yaml

@@ -1,22 +1,27 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: test
+  name: $DEPLOY
 spec:
   selector:
     matchLabels:
-      app: test
+      app: $DEPLOY
   template:
     metadata:
       labels:
-        app: test
+        app: $DEPLOY
     spec:
       containers:
-      - name: test
+      - name: $DEPLOY
         image: $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG
+        envFrom:
+        - configMapRef:
+            name: $DEPLOY
+        - secretRef:
+            name: django-secrets
         volumeMounts:
           - mountPath: /app/db
-            name: test
+            name: $DEPLOY
         resources:
           limits:
             memory: "256Mi"
@@ -27,6 +32,6 @@ spec:
         ports:
         - containerPort: 8000
       volumes:
-        - name: test
+        - name: $DEPLOY
           persistentVolumeClaim:
-            claimName: test
+            claimName: $DEPLOY

k8s/prod/ingress.yaml

@@ -3,18 +3,18 @@ kind: Ingress
 metadata:
   annotations:
     ingress.kubernetes.io/ssl-redirect: "true"
-  name: test
+  name: $DEPLOY
 spec:
   tls:
   - hosts:
-    - test.ducoterra.net
+    - $DEPLOY.ducoterra.net
     secretName: letsencrypt
   rules:
-  - host: test.ducoterra.net
+  - host: $DEPLOY.ducoterra.net
     http:
       paths:
       - backend:
-          serviceName: test
+          serviceName: $DEPLOY
           servicePort: 8000
 
 ---
@@ -22,17 +22,17 @@ spec:
 apiVersion: traefik.containo.us/v1alpha1
 kind: IngressRoute
 metadata:
-  name: test-external-tls
+  name: $DEPLOY-external-tls
 spec:
   entryPoints:
     - websecure
   tls:
     secretName: letsencrypt
   routes:
-  - match: Host(`test.ducoterra.net`)
+  - match: Host(`$DEPLOY.ducoterra.net`)
     kind: Rule
     services:
-    - name: test
+    - name: $DEPLOY
       port: 8000
 
 ---
@@ -40,15 +40,15 @@ spec:
 apiVersion: traefik.containo.us/v1alpha1
 kind: IngressRoute
 metadata:
-  name: test-external-web
+  name: $DEPLOY-external-web
 spec:
   entryPoints:
     - web
   routes:
-  - match: Host(`test.ducoterra.net`)
+  - match: Host(`$DEPLOY.ducoterra.net`)
     kind: Rule
     services:
-    - name: test
+    - name: $DEPLOY
       port: 8000
     middlewares:
       - name: httpsredirect

k8s/pvc.yaml

@@ -1,7 +1,7 @@
 apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
-  name: test
+  name: $DEPLOY
 spec:
   storageClassName: nfs-encrypted
   accessModes:

k8s/service.yaml

@@ -1,10 +1,10 @@
 apiVersion: v1
 kind: Service
 metadata:
-  name: test
+  name: $DEPLOY
 spec:
   selector:
-    app: test
+    app: $DEPLOY
   ports:
   - port: 8000
     targetPort: 8000

k8s/test/ingress.yaml

@@ -0,0 +1,18 @@
+apiVersion: networking.k8s.io/v1beta1
+kind: Ingress
+metadata:
+  annotations:
+    ingress.kubernetes.io/ssl-redirect: "true"
+  name: $DEPLOY
+spec:
+  tls:
+  - hosts:
+    - $DEPLOY.ducoterra.net
+    secretName: letsencrypt
+  rules:
+  - host: $DEPLOY.ducoterra.net
+    http:
+      paths:
+      - backend:
+          serviceName: $DEPLOY
+          servicePort: 8000

manage.py

@@ -6,6 +6,7 @@ import sys
 
 def main():
     os.environ.setdefault('DEBUG', 'True')
+    os.environ.setdefault('SECRET_KEY', 'SeVOOxOHISQZv82RfCPds0B2l8M6jGju4G8F-GcuSrc')
     os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
     try:
         from django.core.management import execute_from_command_line

ui/static/ui/button.css

@@ -0,0 +1,18 @@
+html, body { 
+    height: 100%;
+    width: 100%;
+    position: fixed;
+    overflow: hidden;
+}
+
+.section, .container {
+    height: 100%;
+}
+
+.container {
+    display: flex;
+    justify-content: center;
+    flex-direction: column;
+    align-items: center;
+    text-align: center;
+}

ui/static/ui/button.js

@@ -1,26 +1,12 @@
-function getCookie(name) {
+const csrftoken = getCookie('csrftoken');
-    var cookieValue = null;
+const button = document.getElementById("BUTTON");
-    if (document.cookie && document.cookie !== '') {
+const count = document.getElementById("COUNT");
-        var cookies = document.cookie.split(';');
-        for (var i = 0; i < cookies.length; i++) {
-            var cookie = cookies[i].trim();
-            // Does this cookie string begin with the name we want?
-            if (cookie.substring(0, name.length + 1) === (name + '=')) {
-                cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
-                break;
-            }
-        }
-    }
-    return cookieValue;
-}
-
-var csrftoken = getCookie('csrftoken');
-var button = document.getElementById("BUTTON");
-var count = document.getElementById("COUNT");
 
+// when button is clicked submit an empty post request
 button.addEventListener("click", event => {
     button.disabled = true;
-    fetch('/button', {
+    button.classList.add("is-loading");
+    fetch('/button/', {
         method: 'POST',
         headers: {
             'Content-Type': 'application/json',
@@ -34,7 +20,9 @@ button.addEventListener("click", event => {
             count.innerText = data.pressed;
         }).finally(() => {
             button.disabled = false;
+            button.classList.remove("is-loading");
         });
 });
 
+// when the page is loaded automatically select the button
 button.focus();

ui/static/ui/helper.js

@@ -0,0 +1,16 @@
+// get cookies when fetching with django
+function getCookie(name) {
+    var cookieValue = null;
+    if (document.cookie && document.cookie !== '') {
+        var cookies = document.cookie.split(';');
+        for (var i = 0; i < cookies.length; i++) {
+            var cookie = cookies[i].trim();
+            // Does this cookie string begin with the name we want?
+            if (cookie.substring(0, name.length + 1) === (name + '=')) {
+                cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
+                break;
+            }
+        }
+    }
+    return cookieValue;
+}

ui/templates/ui/button.html

@@ -7,10 +7,10 @@
 {% endblock %}
 
 {% block js %}
+<script src="{% static 'ui/helper.js' %}"></script>
 <script src="{% static 'ui/button.js' %}"></script>
 {% endblock %}
 
-
 {% block body %}
 <section class="section">
     <div class="container">

ui/tests.py

@@ -11,13 +11,13 @@ class SimpleTest(TestCase):
             username='testuser', email='test@test.test', password='testpass')
 
     def test_button(self):
-        # Create an instance of a GET request.
+        # Test button page returns 200
-        request = self.factory.get('/snippets')
+        request = self.factory.get('/button')
-        request.user = self.user
         request.session = self.client.session
         response = button(request)
         self.assertEqual(response.status_code, 200)
         
+        # Test button post returns 200 and increments button to 1
         request = self.factory.post(
             '/button',
             data={},
@@ -28,6 +28,7 @@ class SimpleTest(TestCase):
         self.assertEqual(response.status_code, 200)
         self.assertEqual(request.session.get('pressed'), 1)
 
+        # Test second click increments button to 2
         response = button(request)
         self.assertEqual(response.status_code, 200)
         self.assertEqual(request.session.get('pressed'), 2)

ui/urls.py

@@ -2,5 +2,5 @@ from django.urls import path
 from . import views
 
 urlpatterns = [
-    path('button', views.button, name = 'button'),
+    path('button/', views.button, name = 'button'),
 ]