mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-08-23 15:57:23 -04:00
Run on Paas
This commit is contained in:
4
.gitignore
vendored
4
.gitignore
vendored
@@ -64,13 +64,9 @@ target/
|
|||||||
app/assets/stylesheets/govuk_template/.sass-cache/
|
app/assets/stylesheets/govuk_template/.sass-cache/
|
||||||
.sass-cache/
|
.sass-cache/
|
||||||
cache/
|
cache/
|
||||||
app/static
|
|
||||||
node_modules
|
node_modules
|
||||||
bower_components
|
bower_components
|
||||||
app/templates/govuk_template.html
|
|
||||||
npm-debug.log
|
npm-debug.log
|
||||||
|
|
||||||
environment.sh
|
environment.sh
|
||||||
.envrc
|
.envrc
|
||||||
|
|
||||||
app/version.py
|
|
||||||
|
|||||||
104
Makefile
104
Makefile
@@ -8,7 +8,8 @@ APP_VERSION_FILE = app/version.py
|
|||||||
GIT_BRANCH ?= $(shell git symbolic-ref --short HEAD 2> /dev/null || echo "detached")
|
GIT_BRANCH ?= $(shell git symbolic-ref --short HEAD 2> /dev/null || echo "detached")
|
||||||
GIT_COMMIT ?= $(shell git rev-parse HEAD)
|
GIT_COMMIT ?= $(shell git rev-parse HEAD)
|
||||||
|
|
||||||
DOCKER_BUILDER_IMAGE_NAME = govuk/notify-admin-builder
|
DOCKER_IMAGE_TAG := $(shell cat docker/VERSION)
|
||||||
|
DOCKER_BUILDER_IMAGE_NAME = govuk/notify-admin-builder:${DOCKER_IMAGE_TAG}
|
||||||
|
|
||||||
BUILD_TAG ?= notifications-admin-manual
|
BUILD_TAG ?= notifications-admin-manual
|
||||||
BUILD_NUMBER ?= 0
|
BUILD_NUMBER ?= 0
|
||||||
@@ -20,6 +21,10 @@ DOCKER_CONTAINER_PREFIX = ${USER}-${BUILD_TAG}
|
|||||||
CODEDEPLOY_PREFIX ?= notifications-admin
|
CODEDEPLOY_PREFIX ?= notifications-admin
|
||||||
CODEDEPLOY_APP_NAME ?= notify-admin
|
CODEDEPLOY_APP_NAME ?= notify-admin
|
||||||
|
|
||||||
|
CF_API ?= api.cloud.service.gov.uk
|
||||||
|
CF_ORG ?= govuk-notify
|
||||||
|
CF_SPACE ?= ${DEPLOY_ENV}
|
||||||
|
|
||||||
.PHONY: help
|
.PHONY: help
|
||||||
help:
|
help:
|
||||||
@cat $(MAKEFILE_LIST) | grep -E '^[a-zA-Z_-]+:.*?## .*$$' | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
|
@cat $(MAKEFILE_LIST) | grep -E '^[a-zA-Z_-]+:.*?## .*$$' | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
|
||||||
@@ -28,8 +33,8 @@ help:
|
|||||||
venv: venv/bin/activate ## Create virtualenv if it does not exist
|
venv: venv/bin/activate ## Create virtualenv if it does not exist
|
||||||
|
|
||||||
venv/bin/activate:
|
venv/bin/activate:
|
||||||
test -d venv || virtualenv venv
|
test -d venv || virtualenv venv -p python3
|
||||||
./venv/bin/pip install pip-accel
|
. venv/bin/activate && pip install pip-accel
|
||||||
|
|
||||||
.PHONY: check-env-vars
|
.PHONY: check-env-vars
|
||||||
check-env-vars: ## Check mandatory environment variables
|
check-env-vars: ## Check mandatory environment variables
|
||||||
@@ -38,6 +43,12 @@ check-env-vars: ## Check mandatory environment variables
|
|||||||
$(if ${AWS_ACCESS_KEY_ID},,$(error Must specify AWS_ACCESS_KEY_ID))
|
$(if ${AWS_ACCESS_KEY_ID},,$(error Must specify AWS_ACCESS_KEY_ID))
|
||||||
$(if ${AWS_SECRET_ACCESS_KEY},,$(error Must specify AWS_SECRET_ACCESS_KEY))
|
$(if ${AWS_SECRET_ACCESS_KEY},,$(error Must specify AWS_SECRET_ACCESS_KEY))
|
||||||
|
|
||||||
|
.PHONY: sandbox
|
||||||
|
sandbox: ## Set environment to sandbox
|
||||||
|
$(eval export DEPLOY_ENV=sandbox)
|
||||||
|
$(eval export DNS_NAME="cloudapps.digital")
|
||||||
|
@true
|
||||||
|
|
||||||
.PHONY: preview
|
.PHONY: preview
|
||||||
preview: ## Set environment to preview
|
preview: ## Set environment to preview
|
||||||
$(eval export DEPLOY_ENV=preview)
|
$(eval export DEPLOY_ENV=preview)
|
||||||
@@ -62,7 +73,7 @@ dependencies: venv ## Install build dependencies
|
|||||||
npm install
|
npm install
|
||||||
npm rebuild node-sass
|
npm rebuild node-sass
|
||||||
mkdir -p ${PIP_ACCEL_CACHE}
|
mkdir -p ${PIP_ACCEL_CACHE}
|
||||||
PIP_ACCEL_CACHE=${PIP_ACCEL_CACHE} ./venv/bin/pip-accel install -r requirements_for_test.txt
|
. venv/bin/activate && PIP_ACCEL_CACHE=${PIP_ACCEL_CACHE} pip-accel install -r requirements_for_test.txt
|
||||||
|
|
||||||
.PHONY: generate-version-file
|
.PHONY: generate-version-file
|
||||||
generate-version-file: ## Generates the app version file
|
generate-version-file: ## Generates the app version file
|
||||||
@@ -70,8 +81,8 @@ generate-version-file: ## Generates the app version file
|
|||||||
|
|
||||||
.PHONY: build
|
.PHONY: build
|
||||||
build: dependencies generate-version-file ## Build project
|
build: dependencies generate-version-file ## Build project
|
||||||
./venv/bin/pip-accel wheel --wheel-dir=wheelhouse -r requirements.txt
|
|
||||||
npm run build
|
npm run build
|
||||||
|
. venv/bin/activate && PIP_ACCEL_CACHE=${PIP_ACCEL_CACHE} pip-accel wheel --wheel-dir=wheelhouse -r requirements.txt
|
||||||
|
|
||||||
.PHONY: build-codedeploy-artifact
|
.PHONY: build-codedeploy-artifact
|
||||||
build-codedeploy-artifact: ## Build the deploy artifact for CodeDeploy
|
build-codedeploy-artifact: ## Build the deploy artifact for CodeDeploy
|
||||||
@@ -109,17 +120,16 @@ deploy-check-autoscaling-processes: check-aws-vars ## Returns with the number of
|
|||||||
|
|
||||||
.PHONY: coverage
|
.PHONY: coverage
|
||||||
coverage: venv ## Create coverage report
|
coverage: venv ## Create coverage report
|
||||||
./venv/bin/coveralls
|
. venv/bin/activate && coveralls
|
||||||
|
|
||||||
.PHONY: prepare-docker-build-image
|
.PHONY: prepare-docker-build-image
|
||||||
prepare-docker-build-image: ## Prepare the Docker builder image
|
prepare-docker-build-image: ## Prepare the Docker builder image
|
||||||
mkdir -p ${PIP_ACCEL_CACHE}
|
mkdir -p ${PIP_ACCEL_CACHE}
|
||||||
make -C docker build-build-image
|
make -C docker build
|
||||||
|
|
||||||
.PHONY: build-with-docker
|
define run_docker_container
|
||||||
build-with-docker: prepare-docker-build-image ## Build inside a Docker container
|
|
||||||
@docker run -i --rm \
|
@docker run -i --rm \
|
||||||
--name "${DOCKER_CONTAINER_PREFIX}-build" \
|
--name "${DOCKER_CONTAINER_PREFIX}-${1}" \
|
||||||
-v `pwd`:/var/project \
|
-v `pwd`:/var/project \
|
||||||
-v ${PIP_ACCEL_CACHE}:/var/project/cache/pip-accel \
|
-v ${PIP_ACCEL_CACHE}:/var/project/cache/pip-accel \
|
||||||
-e GIT_COMMIT=${GIT_COMMIT} \
|
-e GIT_COMMIT=${GIT_COMMIT} \
|
||||||
@@ -130,31 +140,6 @@ build-with-docker: prepare-docker-build-image ## Build inside a Docker container
|
|||||||
-e https_proxy="${HTTPS_PROXY}" \
|
-e https_proxy="${HTTPS_PROXY}" \
|
||||||
-e HTTPS_PROXY="${HTTPS_PROXY}" \
|
-e HTTPS_PROXY="${HTTPS_PROXY}" \
|
||||||
-e NO_PROXY="${NO_PROXY}" \
|
-e NO_PROXY="${NO_PROXY}" \
|
||||||
${DOCKER_BUILDER_IMAGE_NAME} \
|
|
||||||
make build
|
|
||||||
|
|
||||||
.PHONY: test-with-docker
|
|
||||||
test-with-docker: prepare-docker-build-image ## Run tests inside a Docker container
|
|
||||||
@docker run -i --rm \
|
|
||||||
--name "${DOCKER_CONTAINER_PREFIX}-test" \
|
|
||||||
-v `pwd`:/var/project \
|
|
||||||
-e GIT_COMMIT=${GIT_COMMIT} \
|
|
||||||
-e BUILD_NUMBER=${BUILD_NUMBER} \
|
|
||||||
-e BUILD_URL=${BUILD_URL} \
|
|
||||||
-e http_proxy="${HTTP_PROXY}" \
|
|
||||||
-e HTTP_PROXY="${HTTP_PROXY}" \
|
|
||||||
-e https_proxy="${HTTPS_PROXY}" \
|
|
||||||
-e HTTPS_PROXY="${HTTPS_PROXY}" \
|
|
||||||
-e NO_PROXY="${NO_PROXY}" \
|
|
||||||
${DOCKER_BUILDER_IMAGE_NAME} \
|
|
||||||
make test
|
|
||||||
|
|
||||||
# FIXME: CIRCLECI=1 is an ugly hack because the coveralls-python library sends the PR link only this way
|
|
||||||
.PHONY: coverage-with-docker
|
|
||||||
coverage-with-docker: prepare-docker-build-image ## Generates coverage report inside a Docker container
|
|
||||||
@docker run -i --rm \
|
|
||||||
--name "${DOCKER_CONTAINER_PREFIX}-coverage" \
|
|
||||||
-v `pwd`:/var/project \
|
|
||||||
-e COVERALLS_REPO_TOKEN=${COVERALLS_REPO_TOKEN} \
|
-e COVERALLS_REPO_TOKEN=${COVERALLS_REPO_TOKEN} \
|
||||||
-e CIRCLECI=1 \
|
-e CIRCLECI=1 \
|
||||||
-e CI_NAME=${CI_NAME} \
|
-e CI_NAME=${CI_NAME} \
|
||||||
@@ -162,17 +147,52 @@ coverage-with-docker: prepare-docker-build-image ## Generates coverage report in
|
|||||||
-e CI_BUILD_URL=${BUILD_URL} \
|
-e CI_BUILD_URL=${BUILD_URL} \
|
||||||
-e CI_BRANCH=${GIT_BRANCH} \
|
-e CI_BRANCH=${GIT_BRANCH} \
|
||||||
-e CI_PULL_REQUEST=${CI_PULL_REQUEST} \
|
-e CI_PULL_REQUEST=${CI_PULL_REQUEST} \
|
||||||
-e http_proxy="${HTTP_PROXY}" \
|
-e CF_API="${CF_API}" \
|
||||||
-e HTTP_PROXY="${HTTP_PROXY}" \
|
-e CF_USERNAME="${CF_USERNAME}" \
|
||||||
-e https_proxy="${HTTPS_PROXY}" \
|
-e CF_PASSWORD="${CF_PASSWORD}" \
|
||||||
-e HTTPS_PROXY="${HTTPS_PROXY}" \
|
-e CF_ORG="${CF_ORG}" \
|
||||||
-e NO_PROXY="${NO_PROXY}" \
|
-e CF_SPACE="${CF_SPACE}" \
|
||||||
${DOCKER_BUILDER_IMAGE_NAME} \
|
${DOCKER_BUILDER_IMAGE_NAME} \
|
||||||
make coverage
|
${2}
|
||||||
|
endef
|
||||||
|
|
||||||
|
.PHONY: build-with-docker
|
||||||
|
build-with-docker: prepare-docker-build-image ## Build inside a Docker container
|
||||||
|
$(call run_docker_container,build,make build)
|
||||||
|
|
||||||
|
.PHONY: test-with-docker
|
||||||
|
test-with-docker: prepare-docker-build-image ## Run tests inside a Docker container
|
||||||
|
$(call run_docker_container,test,make test)
|
||||||
|
|
||||||
|
# FIXME: CIRCLECI=1 is an ugly hack because the coveralls-python library sends the PR link only this way
|
||||||
|
.PHONY: coverage-with-docker
|
||||||
|
coverage-with-docker: prepare-docker-build-image ## Generates coverage report inside a Docker container
|
||||||
|
$(call run_docker_container,coverage,make coverage)
|
||||||
|
|
||||||
.PHONY: clean-docker-containers
|
.PHONY: clean-docker-containers
|
||||||
clean-docker-containers: ## Clean up any remaining docker containers
|
clean-docker-containers: ## Clean up any remaining docker containers
|
||||||
docker rm -f $(shell docker ps -q -f "name=${DOCKER_CONTAINER_PREFIX}") 2> /dev/null || true
|
docker rm -f $(shell docker ps -q -f "name=${DOCKER_CONTAINER_PREFIX}") 2> /dev/null || true
|
||||||
|
|
||||||
|
.PHONY: clean
|
||||||
clean:
|
clean:
|
||||||
rm -rf node_modules cache target venv .coverage
|
rm -rf node_modules cache target venv .coverage wheelhouse
|
||||||
|
|
||||||
|
.PHONY: cf-login
|
||||||
|
cf-login: ## Log in to Cloud Foundry
|
||||||
|
$(if ${CF_USERNAME},,$(error Must specify CF_USERNAME))
|
||||||
|
$(if ${CF_PASSWORD},,$(error Must specify CF_PASSWORD))
|
||||||
|
$(if ${CF_SPACE},,$(error Must specify CF_SPACE))
|
||||||
|
@echo "Logging in to Cloud Foundry on ${CF_API}"
|
||||||
|
@cf login -a "${CF_API}" -u ${CF_USERNAME} -p "${CF_PASSWORD}" -o "${CF_ORG}" -s "${CF_SPACE}"
|
||||||
|
|
||||||
|
.PHONY: cf-deploy
|
||||||
|
cf-deploy: cf-login ## Deploys the app to Cloud Foundry
|
||||||
|
$(eval export ORIG_INSTANCES=$(shell cf curl /v2/apps/$(shell cf app --guid notify-admin) | jq -r ".entity.instances"))
|
||||||
|
@echo "Original instance count: ${ORIG_INSTANCES}"
|
||||||
|
cf check-manifest notify-admin -f manifest-${CF_SPACE}.yml
|
||||||
|
cf zero-downtime-push notify-admin -f manifest-${CF_SPACE}.yml
|
||||||
|
cf scale -i ${ORIG_INSTANCES} notify-admin
|
||||||
|
|
||||||
|
.PHONY: cf-deploy-with-docker
|
||||||
|
cf-deploy-with-docker: prepare-docker-build-image ## Deploys the app to Cloud Foundry from a new Docker container
|
||||||
|
$(call run_docker_container,cf-deploy,make cf-deploy)
|
||||||
|
|||||||
3
app/.gitignore
vendored
Normal file
3
app/.gitignore
vendored
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
/version.py
|
||||||
|
/templates/govuk_template.html
|
||||||
|
/static
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
import urllib
|
import urllib
|
||||||
|
import json
|
||||||
from datetime import datetime, timedelta, timezone
|
from datetime import datetime, timedelta, timezone
|
||||||
from time import monotonic
|
from time import monotonic
|
||||||
|
|
||||||
@@ -72,11 +73,17 @@ current_service = LocalProxy(partial(_lookup_req_object, 'service'))
|
|||||||
|
|
||||||
|
|
||||||
def create_app():
|
def create_app():
|
||||||
from config import configs
|
from app.config import configs
|
||||||
|
|
||||||
application = Flask(__name__)
|
application = Flask(__name__)
|
||||||
|
|
||||||
application.config.from_object(configs[os.environ['NOTIFY_ENVIRONMENT']])
|
if os.getenv('VCAP_APPLICATION') is not None:
|
||||||
|
vcap_application = json.loads(os.environ.get('VCAP_APPLICATION'))
|
||||||
|
notify_environment = vcap_application['space_name']
|
||||||
|
else:
|
||||||
|
notify_environment = os.environ['NOTIFY_ENVIRONMENT']
|
||||||
|
|
||||||
|
application.config.from_object(configs[notify_environment])
|
||||||
|
|
||||||
init_app(application)
|
init_app(application)
|
||||||
statsd_client.init_app(application)
|
statsd_client.init_app(application)
|
||||||
|
|||||||
45
app/cloudfoundry_config.py
Normal file
45
app/cloudfoundry_config.py
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
"""
|
||||||
|
Extracts cloudfoundry config from its json and populates the environment variables that we would expect to be populated
|
||||||
|
on local/aws boxes
|
||||||
|
"""
|
||||||
|
|
||||||
|
import os
|
||||||
|
import json
|
||||||
|
|
||||||
|
|
||||||
|
def extract_cloudfoundry_config():
|
||||||
|
vcap_services = json.loads(os.environ['VCAP_SERVICES'])
|
||||||
|
set_config_env_vars(vcap_services)
|
||||||
|
|
||||||
|
|
||||||
|
def set_config_env_vars(vcap_services):
|
||||||
|
for s in vcap_services['user-provided']:
|
||||||
|
if s['name'] == 'notify-config':
|
||||||
|
extract_notify_config(s)
|
||||||
|
elif s['name'] == 'notify-aws':
|
||||||
|
extract_notify_aws_config(s)
|
||||||
|
elif s['name'] == 'hosted-graphite':
|
||||||
|
extract_hosted_graphite_config(s)
|
||||||
|
elif s['name'] == 'deskpro':
|
||||||
|
extract_deskpro_config(s)
|
||||||
|
|
||||||
|
|
||||||
|
def extract_notify_config(notify_config):
|
||||||
|
os.environ['ADMIN_CLIENT_SECRET'] = notify_config['credentials']['admin_client_secret']
|
||||||
|
os.environ['API_HOST_NAME'] = notify_config['credentials']['api_host_name']
|
||||||
|
os.environ['SECRET_KEY'] = notify_config['credentials']['secret_key']
|
||||||
|
os.environ['DANGEROUS_SALT'] = notify_config['credentials']['dangerous_salt']
|
||||||
|
|
||||||
|
|
||||||
|
def extract_notify_aws_config(aws_config):
|
||||||
|
os.environ['AWS_ACCESS_KEY_ID'] = aws_config['credentials']['aws_access_key_id']
|
||||||
|
os.environ['AWS_SECRET_ACCESS_KEY'] = aws_config['credentials']['aws_secret_access_key']
|
||||||
|
|
||||||
|
|
||||||
|
def extract_hosted_graphite_config(hosted_graphite_config):
|
||||||
|
os.environ['STATSD_PREFIX'] = hosted_graphite_config['credentials']['statsd_prefix']
|
||||||
|
|
||||||
|
|
||||||
|
def extract_deskpro_config(deskpro_config):
|
||||||
|
os.environ['DESKPRO_API_HOST'] = deskpro_config['credentials']['api_host']
|
||||||
|
os.environ['DESKPRO_API_KEY'] = deskpro_config['credentials']['api_key']
|
||||||
@@ -2,6 +2,13 @@ import os
|
|||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
|
|
||||||
|
|
||||||
|
if os.environ.get('VCAP_SERVICES'):
|
||||||
|
# on cloudfoundry, config is a json blob in VCAP_SERVICES - unpack it, and populate
|
||||||
|
# standard environment variables from it
|
||||||
|
from app.cloudfoundry_config import extract_cloudfoundry_config
|
||||||
|
extract_cloudfoundry_config()
|
||||||
|
|
||||||
|
|
||||||
class Config(object):
|
class Config(object):
|
||||||
ADMIN_CLIENT_SECRET = os.environ['ADMIN_CLIENT_SECRET']
|
ADMIN_CLIENT_SECRET = os.environ['ADMIN_CLIENT_SECRET']
|
||||||
API_HOST_NAME = os.environ['API_HOST_NAME']
|
API_HOST_NAME = os.environ['API_HOST_NAME']
|
||||||
@@ -9,13 +16,15 @@ class Config(object):
|
|||||||
DANGEROUS_SALT = os.environ['DANGEROUS_SALT']
|
DANGEROUS_SALT = os.environ['DANGEROUS_SALT']
|
||||||
DESKPRO_API_HOST = os.environ['DESKPRO_API_HOST']
|
DESKPRO_API_HOST = os.environ['DESKPRO_API_HOST']
|
||||||
DESKPRO_API_KEY = os.environ['DESKPRO_API_KEY']
|
DESKPRO_API_KEY = os.environ['DESKPRO_API_KEY']
|
||||||
|
|
||||||
# Hosted graphite statsd prefix
|
# Hosted graphite statsd prefix
|
||||||
STATSD_PREFIX = os.getenv('STATSD_PREFIX')
|
STATSD_PREFIX = os.getenv('STATSD_PREFIX')
|
||||||
|
|
||||||
|
DEBUG = False
|
||||||
|
|
||||||
DESKPRO_DEPT_ID = 5
|
DESKPRO_DEPT_ID = 5
|
||||||
DESKPRO_ASSIGNED_AGENT_TEAM_ID = 5
|
DESKPRO_ASSIGNED_AGENT_TEAM_ID = 5
|
||||||
|
|
||||||
DEBUG = False
|
|
||||||
ADMIN_CLIENT_USER_NAME = 'notify-admin'
|
ADMIN_CLIENT_USER_NAME = 'notify-admin'
|
||||||
ASSETS_DEBUG = False
|
ASSETS_DEBUG = False
|
||||||
AWS_REGION = 'eu-west-1'
|
AWS_REGION = 'eu-west-1'
|
||||||
@@ -112,10 +121,26 @@ class Live(Config):
|
|||||||
NOTIFY_ENVIRONMENT = 'live'
|
NOTIFY_ENVIRONMENT = 'live'
|
||||||
|
|
||||||
|
|
||||||
|
class CloudFoundryConfig(Config):
|
||||||
|
# debug on true is a less than ideal hack to enable stdout/stderr logging
|
||||||
|
# TODO: replace this!
|
||||||
|
DEBUG = True
|
||||||
|
|
||||||
|
|
||||||
|
# CloudFoundry sandbox
|
||||||
|
class Sandbox(CloudFoundryConfig):
|
||||||
|
HTTP_PROTOCOL = 'https'
|
||||||
|
HEADER_COLOUR = '#F499BE' # $baby-pink
|
||||||
|
STATSD_ENABLED = True
|
||||||
|
CSV_UPLOAD_BUCKET_NAME = 'cf-sandbox-notifications-csv-upload'
|
||||||
|
NOTIFY_ENVIRONMENT = 'sandbox'
|
||||||
|
|
||||||
|
|
||||||
configs = {
|
configs = {
|
||||||
'development': Development,
|
'development': Development,
|
||||||
'test': Test,
|
'test': Test,
|
||||||
'preview': Preview,
|
'preview': Preview,
|
||||||
'staging': Staging,
|
'staging': Staging,
|
||||||
'live': Live
|
'live': Live,
|
||||||
|
'sandbox': Sandbox
|
||||||
}
|
}
|
||||||
@@ -36,6 +36,7 @@ RUN \
|
|||||||
libcairo2-dev \
|
libcairo2-dev \
|
||||||
libmagickwand-dev \
|
libmagickwand-dev \
|
||||||
ghostscript \
|
ghostscript \
|
||||||
|
jq \
|
||||||
|
|
||||||
&& echo "Install nodejs" \
|
&& echo "Install nodejs" \
|
||||||
&& cd /tmp \
|
&& cd /tmp \
|
||||||
@@ -52,4 +53,12 @@ RUN \
|
|||||||
awscli \
|
awscli \
|
||||||
wheel
|
wheel
|
||||||
|
|
||||||
|
RUN \
|
||||||
|
echo "Install Cloud Foundry CLI" \
|
||||||
|
&& curl -sSL "https://cli.run.pivotal.io/stable?release=debian64&source=github" -o /tmp/cloudfoundry-cli.deb \
|
||||||
|
&& dpkg -i /tmp/cloudfoundry-cli.deb \
|
||||||
|
&& cf install-plugin -r CF-Community -f "autopilot" \
|
||||||
|
&& cf install-plugin -r CF-Community -f "blue-green-deploy" \
|
||||||
|
&& cf install-plugin -r CF-Community -f "antifreeze"
|
||||||
|
|
||||||
WORKDIR /var/project
|
WORKDIR /var/project
|
||||||
@@ -1,17 +1,23 @@
|
|||||||
.DEFAULT_GOAL := help
|
.DEFAULT_GOAL := help
|
||||||
SHELL := /bin/bash
|
SHELL := /bin/bash
|
||||||
|
DOCKER_IMAGE_TAG := $(shell cat VERSION)
|
||||||
|
|
||||||
.PHONY: help
|
.PHONY: help
|
||||||
help:
|
help:
|
||||||
@cat $(MAKEFILE_LIST) | grep -E '^[a-zA-Z_-]+:.*?## .*$$' | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
|
@cat $(MAKEFILE_LIST) | grep -E '^[a-zA-Z_-]+:.*?## .*$$' | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
|
||||||
|
|
||||||
.PHONY: build-build-image
|
.PHONY: build
|
||||||
build-build-image:
|
build:
|
||||||
docker build \
|
docker build \
|
||||||
--pull \
|
--pull \
|
||||||
--build-arg HTTP_PROXY="${HTTP_PROXY}" \
|
--build-arg HTTP_PROXY="${HTTP_PROXY}" \
|
||||||
--build-arg HTTPS_PROXY="${HTTP_PROXY}" \
|
--build-arg HTTPS_PROXY="${HTTP_PROXY}" \
|
||||||
--build-arg NO_PROXY="${NO_PROXY}" \
|
--build-arg NO_PROXY="${NO_PROXY}" \
|
||||||
-f Dockerfile-build \
|
-t govuk/notify-admin-builder:${DOCKER_IMAGE_TAG} \
|
||||||
-t govuk/notify-admin-builder \
|
|
||||||
.
|
.
|
||||||
|
|
||||||
|
.PHONY: bash
|
||||||
|
bash:
|
||||||
|
docker run -it --rm \
|
||||||
|
govuk/notify-admin-builder \
|
||||||
|
bash
|
||||||
|
|||||||
1
docker/VERSION
Normal file
1
docker/VERSION
Normal file
@@ -0,0 +1 @@
|
|||||||
|
2
|
||||||
16
manifest-preview.yml
Normal file
16
manifest-preview.yml
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
applications:
|
||||||
|
- name: notify-admin
|
||||||
|
buildpack: python_buildpack
|
||||||
|
command: gunicorn -w 5 -b 0.0.0.0:$PORT wsgi
|
||||||
|
services:
|
||||||
|
- notify-aws
|
||||||
|
- notify-config
|
||||||
|
- hosted-graphite
|
||||||
|
- deskpro
|
||||||
|
routes:
|
||||||
|
- route: notify-admin-preview.cloudapps.digital
|
||||||
|
- route: admin-paas.notify.works
|
||||||
|
instances: 1
|
||||||
|
memory: 512M
|
||||||
16
manifest-production.yml
Normal file
16
manifest-production.yml
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
applications:
|
||||||
|
- name: notify-admin
|
||||||
|
buildpack: python_buildpack
|
||||||
|
command: gunicorn -w 5 -b 0.0.0.0:$PORT wsgi
|
||||||
|
services:
|
||||||
|
- notify-aws
|
||||||
|
- notify-config
|
||||||
|
- hosted-graphite
|
||||||
|
- deskpro
|
||||||
|
routes:
|
||||||
|
- route: notify-admin-production.cloudapps.digital
|
||||||
|
- route: admin-paas.notifications.service.gov.uk
|
||||||
|
instances: 2
|
||||||
|
memory: 2048M
|
||||||
15
manifest-sandbox.yml
Normal file
15
manifest-sandbox.yml
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
applications:
|
||||||
|
- name: notify-admin
|
||||||
|
buildpack: python_buildpack
|
||||||
|
command: gunicorn -w 5 -b 0.0.0.0:$PORT wsgi
|
||||||
|
services:
|
||||||
|
- notify-aws
|
||||||
|
- notify-config
|
||||||
|
- hosted-graphite
|
||||||
|
- deskpro
|
||||||
|
routes:
|
||||||
|
- route: notify-admin-sandbox.cloudapps.digital
|
||||||
|
instances: 1
|
||||||
|
memory: 512M
|
||||||
16
manifest-staging.yml
Normal file
16
manifest-staging.yml
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
applications:
|
||||||
|
- name: notify-admin
|
||||||
|
buildpack: python_buildpack
|
||||||
|
command: gunicorn -w 5 -b 0.0.0.0:$PORT wsgi
|
||||||
|
services:
|
||||||
|
- notify-aws
|
||||||
|
- notify-config
|
||||||
|
- hosted-graphite
|
||||||
|
- deskpro
|
||||||
|
routes:
|
||||||
|
- route: notify-admin-staging.cloudapps.digital
|
||||||
|
- route: admin-paas.staging-notify.works
|
||||||
|
instances: 2
|
||||||
|
memory: 2048M
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
cffi==1.9.1
|
||||||
ago==0.0.8
|
ago==0.0.8
|
||||||
Flask==0.10.1
|
Flask==0.10.1
|
||||||
Flask-Script==2.0.5
|
Flask-Script==2.0.5
|
||||||
@@ -22,6 +23,8 @@ pyexcel-xlsx==0.1.0
|
|||||||
pyexcel-ods3==0.1.1
|
pyexcel-ods3==0.1.1
|
||||||
pytz==2016.4
|
pytz==2016.4
|
||||||
wand==0.4.4
|
wand==0.4.4
|
||||||
|
gunicorn==19.6.0
|
||||||
|
whitenoise==1.0.6 #manages static assets
|
||||||
|
|
||||||
git+https://github.com/alphagov/notifications-python-client.git@3.0.1#egg=notifications-python-client==3.0.1
|
git+https://github.com/alphagov/notifications-python-client.git@3.0.1#egg=notifications-python-client==3.0.1
|
||||||
|
|
||||||
|
|||||||
1
runtime.txt
Normal file
1
runtime.txt
Normal file
@@ -0,0 +1 @@
|
|||||||
|
python-3.5.2
|
||||||
119
tests/app/test_cloudfoundry_config.py
Normal file
119
tests/app/test_cloudfoundry_config.py
Normal file
@@ -0,0 +1,119 @@
|
|||||||
|
import os
|
||||||
|
import json
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from app.cloudfoundry_config import extract_cloudfoundry_config, set_config_env_vars
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def notify_config():
|
||||||
|
return {
|
||||||
|
'name': 'notify-config',
|
||||||
|
'credentials': {
|
||||||
|
'api_host_name': 'api host name',
|
||||||
|
'admin_client_secret': 'admin client secret',
|
||||||
|
'secret_key': 'secret key',
|
||||||
|
'dangerous_salt': 'dangerous salt',
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def aws_config():
|
||||||
|
return {
|
||||||
|
'name': 'notify-aws',
|
||||||
|
'credentials': {
|
||||||
|
'aws_access_key_id': 'aws access key id',
|
||||||
|
'aws_secret_access_key': 'aws secret access key',
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def hosted_graphite_config():
|
||||||
|
return {
|
||||||
|
'name': 'hosted-graphite',
|
||||||
|
'credentials': {
|
||||||
|
'statsd_prefix': 'statsd prefix'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def deskpro_config():
|
||||||
|
return {
|
||||||
|
'name': 'deskpro',
|
||||||
|
'credentials': {
|
||||||
|
'api_host': 'deskpro api host',
|
||||||
|
'api_key': 'deskpro api key'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def cloudfoundry_config(
|
||||||
|
notify_config,
|
||||||
|
aws_config,
|
||||||
|
hosted_graphite_config,
|
||||||
|
deskpro_config,
|
||||||
|
):
|
||||||
|
return {
|
||||||
|
'user-provided': [
|
||||||
|
notify_config,
|
||||||
|
aws_config,
|
||||||
|
hosted_graphite_config,
|
||||||
|
deskpro_config,
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def cloudfoundry_environ(monkeypatch, cloudfoundry_config):
|
||||||
|
monkeypatch.setenv('VCAP_SERVICES', json.dumps(cloudfoundry_config))
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.usefixtures('os_environ', 'cloudfoundry_environ')
|
||||||
|
def test_set_config_env_vars_ignores_unknown_configs(cloudfoundry_config):
|
||||||
|
cloudfoundry_config['foo'] = {'credentials': {'foo': 'foo'}}
|
||||||
|
cloudfoundry_config['user-provided'].append({
|
||||||
|
'name': 'bar', 'credentials': {'bar': 'bar'}
|
||||||
|
})
|
||||||
|
|
||||||
|
set_config_env_vars(cloudfoundry_config)
|
||||||
|
|
||||||
|
assert 'foo' not in os.environ
|
||||||
|
assert 'bar' not in os.environ
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.usefixtures('os_environ', 'cloudfoundry_environ')
|
||||||
|
def test_notify_config():
|
||||||
|
extract_cloudfoundry_config()
|
||||||
|
|
||||||
|
assert os.environ['API_HOST_NAME'] == 'api host name'
|
||||||
|
assert os.environ['ADMIN_CLIENT_SECRET'] == 'admin client secret'
|
||||||
|
assert os.environ['SECRET_KEY'] == 'secret key'
|
||||||
|
assert os.environ['DANGEROUS_SALT'] == 'dangerous salt'
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.usefixtures('os_environ', 'cloudfoundry_environ')
|
||||||
|
def test_aws_config():
|
||||||
|
extract_cloudfoundry_config()
|
||||||
|
|
||||||
|
assert os.environ['AWS_ACCESS_KEY_ID'] == 'aws access key id'
|
||||||
|
assert os.environ['AWS_SECRET_ACCESS_KEY'] == 'aws secret access key'
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.usefixtures('os_environ', 'cloudfoundry_environ')
|
||||||
|
def test_hosted_graphite_config():
|
||||||
|
extract_cloudfoundry_config()
|
||||||
|
|
||||||
|
assert os.environ['STATSD_PREFIX'] == 'statsd prefix'
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.usefixtures('os_environ', 'cloudfoundry_environ')
|
||||||
|
def test_deskpro_config():
|
||||||
|
extract_cloudfoundry_config()
|
||||||
|
|
||||||
|
assert os.environ['DESKPRO_API_HOST'] == 'deskpro api host'
|
||||||
|
assert os.environ['DESKPRO_API_KEY'] == 'deskpro api key'
|
||||||
58
tests/app/test_config.py
Normal file
58
tests/app/test_config.py
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
import os
|
||||||
|
import importlib
|
||||||
|
from unittest import mock
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from app import config
|
||||||
|
|
||||||
|
|
||||||
|
def cf_conf():
|
||||||
|
os.environ['API_HOST_NAME'] = 'cf'
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def reload_config():
|
||||||
|
"""
|
||||||
|
Reset config, by simply re-running config.py from a fresh environment
|
||||||
|
"""
|
||||||
|
old_env = os.environ.copy()
|
||||||
|
|
||||||
|
yield
|
||||||
|
|
||||||
|
os.environ = old_env
|
||||||
|
importlib.reload(config)
|
||||||
|
|
||||||
|
|
||||||
|
def test_load_cloudfoundry_config_if_available(monkeypatch, reload_config):
|
||||||
|
os.environ['API_HOST_NAME'] = 'env'
|
||||||
|
monkeypatch.setenv('VCAP_SERVICES', 'some json blob')
|
||||||
|
|
||||||
|
with mock.patch('app.cloudfoundry_config.extract_cloudfoundry_config', side_effect=cf_conf) as cf_config:
|
||||||
|
# reload config so that its module level code (ie: all of it) is re-instantiated
|
||||||
|
importlib.reload(config)
|
||||||
|
|
||||||
|
assert cf_config.called
|
||||||
|
|
||||||
|
assert os.environ['API_HOST_NAME'] == 'cf'
|
||||||
|
assert config.Config.API_HOST_NAME == 'cf'
|
||||||
|
|
||||||
|
|
||||||
|
def test_load_config_if_cloudfoundry_not_available(monkeypatch, reload_config):
|
||||||
|
os.environ['API_HOST_NAME'] = 'env'
|
||||||
|
|
||||||
|
monkeypatch.delenv('VCAP_SERVICES', raising=False)
|
||||||
|
|
||||||
|
with mock.patch('app.cloudfoundry_config.extract_cloudfoundry_config') as cf_config:
|
||||||
|
# reload config so that its module level code (ie: all of it) is re-instantiated
|
||||||
|
importlib.reload(config)
|
||||||
|
|
||||||
|
assert not cf_config.called
|
||||||
|
|
||||||
|
assert os.environ['API_HOST_NAME'] == 'env'
|
||||||
|
assert config.Config.API_HOST_NAME == 'env'
|
||||||
|
|
||||||
|
|
||||||
|
def test_cloudfoundry_config_has_different_defaults():
|
||||||
|
# these should always be set on Sandbox
|
||||||
|
assert config.Sandbox.DEBUG is True
|
||||||
@@ -1,8 +1,16 @@
|
|||||||
|
import os
|
||||||
from datetime import date, datetime, timedelta
|
from datetime import date, datetime, timedelta
|
||||||
from unittest.mock import Mock
|
from unittest.mock import Mock
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
from notifications_python_client.errors import HTTPError
|
||||||
|
|
||||||
from app import create_app
|
from app import create_app
|
||||||
|
from app.notify_client.models import (
|
||||||
|
User,
|
||||||
|
InvitedUser
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
from . import (
|
from . import (
|
||||||
service_json,
|
service_json,
|
||||||
@@ -14,14 +22,10 @@ from . import (
|
|||||||
notification_json,
|
notification_json,
|
||||||
invite_json,
|
invite_json,
|
||||||
sample_uuid,
|
sample_uuid,
|
||||||
generate_uuid, single_notification_json)
|
generate_uuid,
|
||||||
from app.notify_client.models import (
|
single_notification_json
|
||||||
User,
|
|
||||||
InvitedUser
|
|
||||||
)
|
)
|
||||||
|
|
||||||
from notifications_python_client.errors import HTTPError
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope='session')
|
@pytest.fixture(scope='session')
|
||||||
def app_(request):
|
def app_(request):
|
||||||
@@ -1340,3 +1344,15 @@ def logged_in_client(
|
|||||||
):
|
):
|
||||||
client.login(active_user_with_permissions)
|
client.login(active_user_with_permissions)
|
||||||
yield client
|
yield client
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def os_environ():
|
||||||
|
"""
|
||||||
|
clear os.environ, and restore it after the test runs
|
||||||
|
"""
|
||||||
|
# for use whenever you expect code to edit environment variables
|
||||||
|
old_env = os.environ.copy()
|
||||||
|
os.environ = {}
|
||||||
|
yield
|
||||||
|
os.environ = old_env
|
||||||
|
|||||||
12
wsgi.py
12
wsgi.py
@@ -1,12 +1,18 @@
|
|||||||
from credstash import getAllSecrets
|
from credstash import getAllSecrets
|
||||||
|
from whitenoise import WhiteNoise
|
||||||
import os
|
import os
|
||||||
|
|
||||||
# on aws get secrets and export to env
|
# On AWS get secrets and export to env, skip this on Cloud Foundry
|
||||||
os.environ.update(getAllSecrets(region="eu-west-1"))
|
if os.getenv('VCAP_SERVICES') is None:
|
||||||
|
os.environ.update(getAllSecrets(region="eu-west-1"))
|
||||||
|
|
||||||
from app import create_app # noqa
|
from app import create_app # noqa
|
||||||
|
|
||||||
application = create_app()
|
PROJECT_ROOT = os.path.dirname(os.path.abspath(__file__))
|
||||||
|
STATIC_ROOT = os.path.join(PROJECT_ROOT, 'app', 'static')
|
||||||
|
STATIC_URL = 'static/'
|
||||||
|
|
||||||
|
application = WhiteNoise(create_app(), STATIC_ROOT, STATIC_URL)
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
application.run()
|
application.run()
|
||||||
|
|||||||
Reference in New Issue
Block a user