Skip to content

Commit

Permalink
feat(test): add test django application
Browse files Browse the repository at this point in the history
  • Loading branch information
Brian Caffey committed May 8, 2021
1 parent 37be43a commit 8c4037a
Show file tree
Hide file tree
Showing 12 changed files with 274 additions and 5 deletions.
2 changes: 2 additions & 0 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ new DjangoCdk(scope: Construct, id: string, props: DjangoCdkProps)

Name | Type | Description
-----|------|-------------
**cluster** | <code>[Cluster](#aws-cdk-aws-ecs-cluster)</code> | <span></span>
**image** | <code>[ContainerImage](#aws-cdk-aws-ecs-containerimage)</code> | <span></span>
**staticFileBucket** | <code>[Bucket](#aws-cdk-aws-s3-bucket)</code> | <span></span>
**vpc** | <code>[IVpc](#aws-cdk-aws-ec2-ivpc)</code> | <span></span>

Expand Down
6 changes: 6 additions & 0 deletions src/database/index.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
import * as ec2 from '@aws-cdk/aws-ec2';
import * as rds from '@aws-cdk/aws-rds';
import * as secretsmanager from '@aws-cdk/aws-secretsmanager';
import * as cdk from '@aws-cdk/core';


export interface RdsPostgresInstanceProps {
readonly vpc: ec2.IVpc;
readonly secret: secretsmanager.ISecret;
}

export class RdsPostgresInstance extends cdk.Construct {
Expand Down Expand Up @@ -33,6 +35,10 @@ export class RdsPostgresInstance extends cdk.Construct {
vpcPlacement: { subnetType: ec2.SubnetType.ISOLATED },
port: 5432,
securityGroups: [rdsSecurityGroup],
credentials: {
username: 'postgres',
password: props.secret.secretValue,
},
});
this.rdsPostgresInstance = rdsPostgresInstance;
}
Expand Down
36 changes: 32 additions & 4 deletions src/django-cdk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@ import * as ec2 from '@aws-cdk/aws-ec2';
import * as ecs from '@aws-cdk/aws-ecs';
import * as patterns from '@aws-cdk/aws-ecs-patterns';
import * as s3 from '@aws-cdk/aws-s3';
import * as secretsmanager from '@aws-cdk/aws-secretsmanager';
import * as cdk from '@aws-cdk/core';
import { RdsPostgresInstance } from './database';
import { managementCommandTask } from './tasks';
import { ApplicationVpc } from './vpc';


Expand All @@ -23,6 +25,9 @@ export class DjangoCdk extends cdk.Construct {

public staticFileBucket: s3.Bucket;
public vpc: ec2.IVpc;
public cluster: ecs.Cluster;
public image: ecs.ContainerImage;
private secret: secretsmanager.ISecret;

constructor(scope: cdk.Construct, id: string, props: DjangoCdkProps) {
super(scope, id);
Expand Down Expand Up @@ -51,7 +56,7 @@ export class DjangoCdk extends cdk.Construct {
/**
* ECS cluster
*/
const cluster = new ecs.Cluster(scope, 'EcsCluster', { vpc: this.vpc });
this.cluster = new ecs.Cluster(scope, 'EcsCluster', { vpc: this.vpc });

/**
* task definition construct
Expand All @@ -62,15 +67,31 @@ export class DjangoCdk extends cdk.Construct {
memoryMiB: '512',
});

const database = new RdsPostgresInstance(scope, 'RdsPostgresInstance', { vpc: this.vpc });
/**
* Secret used for RDS postgres password
*/
this.secret = new secretsmanager.Secret(scope, 'dbSecret', {
secretName: 'dbSecret',
});

/**
* Container image used in web API, celery worker and management task containers
*/
this.image = new ecs.AssetImage(props.imageDirectory);

const database = new RdsPostgresInstance(scope, 'RdsPostgresInstance', {
vpc: this.vpc,
secret: this.secret,
});

const environment: { [key: string]: string } = {
AWS_STORAGE_BUCKET_NAME: staticFilesBucket.bucketName,
POSTGRES_SERVICE_HOST: database.rdsPostgresInstance.dbInstanceEndpointAddress,
POSTGRES_PASSWORD: this.secret.secretValue.toString(),
};

const container = taskDefinition.addContainer('backendContainer', {
image: new ecs.AssetImage(props.imageDirectory),
image: this.image,
environment,
command: props.webCommand,
});
Expand All @@ -88,11 +109,18 @@ export class DjangoCdk extends cdk.Construct {
vpc: this.vpc,
});

// const collectstaticTask =
new managementCommandTask(scope, 'migrate', {
image: this.image,
command: ['python3', 'manage.py', 'migrate', '--no-input'],
appSecurityGroup,
});

/**
* ECS load-balanced fargate service
*/
const albfs = new patterns.ApplicationLoadBalancedFargateService(scope, 'AlbFargateService', {
cluster,
cluster: this.cluster,
taskDefinition,
securityGroups: [appSecurityGroup],
});
Expand Down
33 changes: 33 additions & 0 deletions src/tasks/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// import * as ec2 from '@aws-cdk/aws-ec2';
import { ISecurityGroup } from '@aws-cdk/aws-ec2';
import * as ecs from '@aws-cdk/aws-ecs';
import * as cdk from '@aws-cdk/core';

export interface managementCommandTaskProps {
/**
* Options to configure a Django Management Command Task
*/
readonly command: string[];
readonly bucketName?: string[];
readonly appSecurityGroup: ISecurityGroup;
readonly image: ecs.ContainerImage;
}

export class managementCommandTask extends cdk.Construct {

constructor(scope: cdk.Construct, id: string, props: managementCommandTaskProps) {
super(scope, id);


const taskDefinition = new ecs.TaskDefinition(scope, `TaskDefinitionFor${id}`, {
compatibility: ecs.Compatibility.FARGATE,
cpu: '256',
memoryMiB: '512',
});

taskDefinition.addContainer(`TaskContainer${id}`, {
image: props.image,
command: props.command,
});
}
}
1 change: 1 addition & 0 deletions test/backend/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.env
1 change: 0 additions & 1 deletion test/backend/Dockerfile

This file was deleted.

22 changes: 22 additions & 0 deletions test/backend/manage.py
Original file line number Diff line number Diff line change
@@ -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', 'proj.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()
Empty file added test/backend/proj/__init__.py
Empty file.
16 changes: 16 additions & 0 deletions test/backend/proj/asgi.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
ASGI config for proj 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/3.2/howto/deployment/asgi/
"""

import os

from django.core.asgi import get_asgi_application

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'proj.settings')

application = get_asgi_application()
125 changes: 125 additions & 0 deletions test/backend/proj/settings.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
"""
Django settings for proj project.
Generated by 'django-admin startproject' using Django 3.2.2.
For more information on this file, see
https://docs.djangoproject.com/en/3.2/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/3.2/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/3.2/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = 'django-insecure-paad2rqhgk&j62m)s1^%amlqild=6#znj#*yclo7k2t*8u(=)2'

# 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',
]

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 = 'proj.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 = 'proj.wsgi.application'


# Database
# https://docs.djangoproject.com/en/3.2/ref/settings/#databases

DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': BASE_DIR / 'db.sqlite3',
}
}


# Password validation
# https://docs.djangoproject.com/en/3.2/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/3.2/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/3.2/howto/static-files/

STATIC_URL = '/static/'

# Default primary key field type
# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field

DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
21 changes: 21 additions & 0 deletions test/backend/proj/urls.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
"""proj URL Configuration
The `urlpatterns` list routes URLs to views. For more information please see:
https://docs.djangoproject.com/en/3.2/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),
]
16 changes: 16 additions & 0 deletions test/backend/proj/wsgi.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
WSGI config for proj 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/3.2/howto/deployment/wsgi/
"""

import os

from django.core.wsgi import get_wsgi_application

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'proj.settings')

application = get_wsgi_application()

0 comments on commit 8c4037a

Please sign in to comment.