add mock server from consent

examples/mock/Caddyfile

@@ -0,0 +1,33 @@
+{$SITE_ADDRESS}:80, {$SITE_ADDRESS}:443 {
+
+
+  @api {
+    path /api/*
+  }
+
+  route @api {
+    uri strip_prefix /api
+    reverse_proxy {
+      to consent:8000
+    }
+    openapi {
+      spec /consent-openapi.yaml
+      log_error
+      check {
+        req_params req_body
+        # When we are ready to handle validation of the body:
+        # req_params req_body resp_body
+      }
+      validate_servers
+    }
+  }
+
+
+  handle_errors {
+    respond @api "Resource: {http.request.orig_uri}. Error: {openapi.error}" {openapi.status_code}  {
+      close
+    }
+  }
+
+  respond "all is OK"
+}

examples/mock/Dockerfile_app

@@ -0,0 +1,14 @@
+FROM python:3
+
+# This is a mock app. It's okay to run pip as root inside a docker container
+ENV PIP_ROOT_USER_ACTION=ignore
+
+COPY examples/mock/djangoapp/requirements.txt /requirements.txt
+
+RUN python3 -m pip install pip --upgrade && pip install -r /requirements.txt
+
+ADD ./examples/mock/djangoapp/ /djangoapp
+
+WORKDIR "/djangoapp/"
+
+CMD ./entrypoint.sh

examples/mock/Dockerfile_caddy

@@ -0,0 +1,13 @@
+FROM caddy:2-builder AS builder
+
+RUN xcaddy build --with github.com/chukmunnlee/caddy-openapi
+
+FROM caddy:2-alpine
+
+COPY --from=builder /usr/bin/caddy /usr/bin/caddy
+
+COPY examples/mock/Caddyfile /etc/caddy/Caddyfile
+
+COPY api/consent-openapi.yaml /consent-openapi.yaml
+
+CMD ["caddy", "run", "--config", "/etc/caddy/Caddyfile"]

examples/mock/README.md

@@ -0,0 +1,25 @@
+# GovStack Consent BB - mock
+
+A stand-alone docker-compose configuration simulating the Consent BB
+specification.
+
+## Running the mock implementation
+
+The mock application can be run on a local Docker environment using the
+following command:
+
+```
+docker-compose up
+```
+
+After this, you can visit for instance https://localhost:8888/api/org/policy/ --
+notice that Caddy produces a self-signed SSL certificate that you have to
+accept.
+
+## Components of the mock app
+
+- An HTTP server (Caddy)
+- The Consent BB OpenAPI spec
+- A Caddy module for validating OpenAPI specs (caddy-openapi)
+- Mocked static responses for static endpoints
+- A mock application written in Django for dynamic endpoints

examples/mock/djangoapp/consentbb/app/admin.py

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

examples/mock/djangoapp/consentbb/app/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class AppConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'consentbb.app'
+    label = 'app'

examples/mock/djangoapp/consentbb/app/models.py

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

examples/mock/djangoapp/consentbb/app/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

examples/mock/djangoapp/consentbb/app/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

examples/mock/djangoapp/consentbb/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for consentapp project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'consentapp.settings')
+
+application = get_asgi_application()

examples/mock/djangoapp/consentbb/settings.py

@@ -0,0 +1,124 @@
+"""
+Django settings for consentbb project.
+
+Generated by 'django-admin startproject' using Django 4.0.5.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.0/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-02@!!e3b$w_mzw^q90vhb1q#ke^%s$^njrgxxuma+0e%f0k)%w'
+
+# 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',
+    'consentbb.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 = 'consentbb.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 = 'consentbb.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/4.0/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.0/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/4.0/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.0/howto/static-files/
+
+STATIC_URL = 'static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.0/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

examples/mock/djangoapp/consentbb/urls.py

@@ -0,0 +1,21 @@
+"""consentapp URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/4.0/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+]

examples/mock/djangoapp/consentbb/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for consentapp 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/4.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'consentapp.settings')
+
+application = get_wsgi_application()

examples/mock/djangoapp/entrypoint.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# This is the entrypoint used by the docker container
+
+python manage.py runserver 0.0.0.0:8000

examples/mock/djangoapp/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'consentbb.settings')
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        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?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

examples/mock/djangoapp/requirements.txt

@@ -0,0 +1 @@
+django==4.0.5

examples/mock/docker-compose.yml

@@ -0,0 +1,34 @@
+version: '3'
+
+services:
+  consent:
+    image: consent_bb_mock_app
+    expose:
+      - 8000
+    networks:
+      - web
+    build:
+      context: ../../
+      dockerfile: examples/mock/Dockerfile_app
+
+  caddy:
+    image: consent_bb_mock_http
+    ports:
+      - '8080:80'
+      - '8888:443'
+    environment:
+      - SITE_ADDRESS=localhost
+    volumes:
+      - caddy:/data
+    networks:
+      - web
+    build:
+      context: ../../
+      dockerfile: examples/mock/Dockerfile_caddy
+
+volumes:
+  caddy:
+
+networks:
+  web:
+    driver: bridge