mirror of
https://github.com/GSA/notifications-api.git
synced 2026-09-11 18:38:14 -04:00
Merge pull request #2 from 18F/local-dev-upgrades
add devcontainer configs and docker network orchestration
This commit is contained in:
@@ -69,6 +69,8 @@ target/
|
|||||||
*.DS_Store
|
*.DS_Store
|
||||||
environment.sh
|
environment.sh
|
||||||
.envrc
|
.envrc
|
||||||
|
.env
|
||||||
|
.env*
|
||||||
|
|
||||||
celerybeat-schedule
|
celerybeat-schedule
|
||||||
|
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ NOTIFY_CREDENTIALS ?= ~/.notify-credentials
|
|||||||
bootstrap: generate-version-file ## Set up everything to run the app
|
bootstrap: generate-version-file ## Set up everything to run the app
|
||||||
pip3 install -r requirements_for_test.txt
|
pip3 install -r requirements_for_test.txt
|
||||||
createdb notification_api || true
|
createdb notification_api || true
|
||||||
(. environment.sh && flask db upgrade) || true
|
(flask db upgrade) || true
|
||||||
|
|
||||||
.PHONY: bootstrap-with-docker
|
.PHONY: bootstrap-with-docker
|
||||||
bootstrap-with-docker: ## Build the image to run the app in Docker
|
bootstrap-with-docker: ## Build the image to run the app in Docker
|
||||||
@@ -33,11 +33,12 @@ bootstrap-with-docker: ## Build the image to run the app in Docker
|
|||||||
|
|
||||||
.PHONY: run-flask
|
.PHONY: run-flask
|
||||||
run-flask: ## Run flask
|
run-flask: ## Run flask
|
||||||
. environment.sh && flask run -p 6011
|
flask run -p 6011 --host=0.0.0.0
|
||||||
|
|
||||||
.PHONY: run-celery
|
.PHONY: run-celery
|
||||||
run-celery: ## Run celery
|
run-celery: ## Run celery, TODO remove purge for staging/prod
|
||||||
. environment.sh && celery \
|
celery -A run_celery.notify_celery purge -f
|
||||||
|
celery \
|
||||||
-A run_celery.notify_celery worker \
|
-A run_celery.notify_celery worker \
|
||||||
--pidfile="/tmp/celery.pid" \
|
--pidfile="/tmp/celery.pid" \
|
||||||
--loglevel=INFO \
|
--loglevel=INFO \
|
||||||
@@ -49,9 +50,9 @@ run-celery-with-docker: ## Run celery in Docker container (useful if you can't i
|
|||||||
|
|
||||||
.PHONY: run-celery-beat
|
.PHONY: run-celery-beat
|
||||||
run-celery-beat: ## Run celery beat
|
run-celery-beat: ## Run celery beat
|
||||||
. environment.sh && celery \
|
celery \
|
||||||
-A run_celery.notify_celery beat \
|
-A run_celery.notify_celery beat \
|
||||||
--loglevel=INFO
|
--loglevel=INFO
|
||||||
|
|
||||||
.PHONY: run-celery-beat-with-docker
|
.PHONY: run-celery-beat-with-docker
|
||||||
run-celery-beat-with-docker: ## Run celery beat in Docker container (useful if you can't install pycurl locally)
|
run-celery-beat-with-docker: ## Run celery beat in Docker container (useful if you can't install pycurl locally)
|
||||||
|
|||||||
@@ -164,7 +164,7 @@ def ses_notification_callback(reference):
|
|||||||
'processingTimeMillis': 2003,
|
'processingTimeMillis': 2003,
|
||||||
'recipients': ['success@simulator.amazonses.com'],
|
'recipients': ['success@simulator.amazonses.com'],
|
||||||
'remoteMtaIp': '123.123.123.123',
|
'remoteMtaIp': '123.123.123.123',
|
||||||
'reportingMTA': 'a7-32.smtp-out.eu-west-1.amazonses.com',
|
'reportingMTA': 'a7-32.smtp-out.us-west-2.amazonses.com',
|
||||||
'smtpResponse': '250 2.6.0 Message received',
|
'smtpResponse': '250 2.6.0 Message received',
|
||||||
'timestamp': '2017-11-17T12:14:03.646Z'
|
'timestamp': '2017-11-17T12:14:03.646Z'
|
||||||
},
|
},
|
||||||
@@ -201,7 +201,7 @@ def ses_notification_callback(reference):
|
|||||||
'messageId': reference,
|
'messageId': reference,
|
||||||
'sendingAccountId': '12341234',
|
'sendingAccountId': '12341234',
|
||||||
'source': '"TEST" <TEST@notify.works>',
|
'source': '"TEST" <TEST@notify.works>',
|
||||||
'sourceArn': 'arn:aws:ses:eu-west-1:12341234:identity/notify.works',
|
'sourceArn': 'arn:aws:ses:us-west-2:12341234:identity/notify.works',
|
||||||
'sourceIp': '0.0.0.1',
|
'sourceIp': '0.0.0.1',
|
||||||
'timestamp': '2017-11-17T12:14:01.643Z'
|
'timestamp': '2017-11-17T12:14:01.643Z'
|
||||||
},
|
},
|
||||||
@@ -211,14 +211,14 @@ def ses_notification_callback(reference):
|
|||||||
return {
|
return {
|
||||||
'Type': 'Notification',
|
'Type': 'Notification',
|
||||||
'MessageId': '8e83c020-1234-1234-1234-92a8ee9baa0a',
|
'MessageId': '8e83c020-1234-1234-1234-92a8ee9baa0a',
|
||||||
'TopicArn': 'arn:aws:sns:eu-west-1:12341234:ses_notifications',
|
'TopicArn': 'arn:aws:sns:us-west-2:12341234:ses_notifications',
|
||||||
'Subject': None,
|
'Subject': None,
|
||||||
'Message': json.dumps(ses_message_body),
|
'Message': json.dumps(ses_message_body),
|
||||||
'Timestamp': '2017-11-17T12:14:03.710Z',
|
'Timestamp': '2017-11-17T12:14:03.710Z',
|
||||||
'SignatureVersion': '1',
|
'SignatureVersion': '1',
|
||||||
'Signature': '[REDACTED]',
|
'Signature': '[REDACTED]',
|
||||||
'SigningCertUrl': 'https://sns.eu-west-1.amazonaws.com/SimpleNotificationService-[REDACTED].pem',
|
'SigningCertUrl': 'https://sns.us-west-2.amazonaws.com/SimpleNotificationService-[REDACTED].pem',
|
||||||
'UnsubscribeUrl': 'https://sns.eu-west-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=[REACTED]',
|
'UnsubscribeUrl': 'https://sns.us-west-2.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=[REACTED]',
|
||||||
'MessageAttributes': {}
|
'MessageAttributes': {}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -244,7 +244,7 @@ def _ses_bounce_callback(reference, bounce_type):
|
|||||||
}],
|
}],
|
||||||
'feedbackId': '0102015fc9e676fb-12341234-1234-1234-1234-9301e86a4fa8-000000',
|
'feedbackId': '0102015fc9e676fb-12341234-1234-1234-1234-9301e86a4fa8-000000',
|
||||||
'remoteMtaIp': '123.123.123.123',
|
'remoteMtaIp': '123.123.123.123',
|
||||||
'reportingMTA': 'dsn; a7-31.smtp-out.eu-west-1.amazonses.com',
|
'reportingMTA': 'dsn; a7-31.smtp-out.us-west-2.amazonses.com',
|
||||||
'timestamp': '2017-11-17T12:14:05.131Z'
|
'timestamp': '2017-11-17T12:14:05.131Z'
|
||||||
},
|
},
|
||||||
'mail': {
|
'mail': {
|
||||||
@@ -280,7 +280,7 @@ def _ses_bounce_callback(reference, bounce_type):
|
|||||||
'messageId': reference,
|
'messageId': reference,
|
||||||
'sendingAccountId': '12341234',
|
'sendingAccountId': '12341234',
|
||||||
'source': '"TEST" <TEST@notify.works>',
|
'source': '"TEST" <TEST@notify.works>',
|
||||||
'sourceArn': 'arn:aws:ses:eu-west-1:12341234:identity/notify.works',
|
'sourceArn': 'arn:aws:ses:us-west-2:12341234:identity/notify.works',
|
||||||
'sourceIp': '0.0.0.1',
|
'sourceIp': '0.0.0.1',
|
||||||
'timestamp': '2017-11-17T12:14:03.000Z'
|
'timestamp': '2017-11-17T12:14:03.000Z'
|
||||||
},
|
},
|
||||||
@@ -289,13 +289,13 @@ def _ses_bounce_callback(reference, bounce_type):
|
|||||||
return {
|
return {
|
||||||
'Type': 'Notification',
|
'Type': 'Notification',
|
||||||
'MessageId': '36e67c28-1234-1234-1234-2ea0172aa4a7',
|
'MessageId': '36e67c28-1234-1234-1234-2ea0172aa4a7',
|
||||||
'TopicArn': 'arn:aws:sns:eu-west-1:12341234:ses_notifications',
|
'TopicArn': 'arn:aws:sns:us-west-2:12341234:ses_notifications',
|
||||||
'Subject': None,
|
'Subject': None,
|
||||||
'Message': json.dumps(ses_message_body),
|
'Message': json.dumps(ses_message_body),
|
||||||
'Timestamp': '2017-11-17T12:14:05.149Z',
|
'Timestamp': '2017-11-17T12:14:05.149Z',
|
||||||
'SignatureVersion': '1',
|
'SignatureVersion': '1',
|
||||||
'Signature': '[REDACTED]', # noqa
|
'Signature': '[REDACTED]', # noqa
|
||||||
'SigningCertUrl': 'https://sns.eu-west-1.amazonaws.com/SimpleNotificationService-[REDACTED]].pem',
|
'SigningCertUrl': 'https://sns.us-west-2.amazonaws.com/SimpleNotificationService-[REDACTED]].pem',
|
||||||
'UnsubscribeUrl': 'https://sns.eu-west-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=[REDACTED]]',
|
'UnsubscribeUrl': 'https://sns.us-west-2.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=[REDACTED]]',
|
||||||
'MessageAttributes': {}
|
'MessageAttributes': {}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ class CBCProxyClient:
|
|||||||
if app.config.get('CBC_PROXY_ENABLED'):
|
if app.config.get('CBC_PROXY_ENABLED'):
|
||||||
self._lambda_client = boto3.client(
|
self._lambda_client = boto3.client(
|
||||||
'lambda',
|
'lambda',
|
||||||
region_name='eu-west-2',
|
region_name='us-west-2',
|
||||||
aws_access_key_id=app.config['CBC_PROXY_AWS_ACCESS_KEY_ID'],
|
aws_access_key_id=app.config['CBC_PROXY_AWS_ACCESS_KEY_ID'],
|
||||||
aws_secret_access_key=app.config['CBC_PROXY_AWS_SECRET_ACCESS_KEY'],
|
aws_secret_access_key=app.config['CBC_PROXY_AWS_SECRET_ACCESS_KEY'],
|
||||||
)
|
)
|
||||||
|
|||||||
+7
-6
@@ -137,7 +137,7 @@ class Config(object):
|
|||||||
###########################
|
###########################
|
||||||
|
|
||||||
NOTIFY_ENVIRONMENT = 'development'
|
NOTIFY_ENVIRONMENT = 'development'
|
||||||
AWS_REGION = 'eu-west-1'
|
AWS_REGION = 'us-west-2'
|
||||||
INVITATION_EXPIRATION_DAYS = 2
|
INVITATION_EXPIRATION_DAYS = 2
|
||||||
NOTIFY_APP_NAME = 'api'
|
NOTIFY_APP_NAME = 'api'
|
||||||
SQLALCHEMY_RECORD_QUERIES = False
|
SQLALCHEMY_RECORD_QUERIES = False
|
||||||
@@ -153,6 +153,8 @@ class Config(object):
|
|||||||
MAX_VERIFY_CODE_COUNT = 5
|
MAX_VERIFY_CODE_COUNT = 5
|
||||||
MAX_FAILED_LOGIN_COUNT = 10
|
MAX_FAILED_LOGIN_COUNT = 10
|
||||||
|
|
||||||
|
SES_STUB_URL = None # TODO: set to a URL in env and remove this to use a stubbed SES service
|
||||||
|
|
||||||
# be careful increasing this size without being sure that we won't see slowness in pysftp
|
# be careful increasing this size without being sure that we won't see slowness in pysftp
|
||||||
MAX_LETTER_PDF_ZIP_FILESIZE = 40 * 1024 * 1024 # 40mb
|
MAX_LETTER_PDF_ZIP_FILESIZE = 40 * 1024 * 1024 # 40mb
|
||||||
MAX_LETTER_PDF_COUNT_PER_ZIP = 500
|
MAX_LETTER_PDF_COUNT_PER_ZIP = 500
|
||||||
@@ -381,9 +383,8 @@ class Config(object):
|
|||||||
# these environment vars aren't defined in the manifest so to set them on paas use `cf set-env`
|
# these environment vars aren't defined in the manifest so to set them on paas use `cf set-env`
|
||||||
MMG_URL = os.environ.get("MMG_URL", "https://api.mmg.co.uk/jsonv2a/api.php")
|
MMG_URL = os.environ.get("MMG_URL", "https://api.mmg.co.uk/jsonv2a/api.php")
|
||||||
FIRETEXT_URL = os.environ.get("FIRETEXT_URL", "https://www.firetext.co.uk/api/sendsms/json")
|
FIRETEXT_URL = os.environ.get("FIRETEXT_URL", "https://www.firetext.co.uk/api/sendsms/json")
|
||||||
SES_STUB_URL = os.environ.get("SES_STUB_URL")
|
|
||||||
|
|
||||||
AWS_REGION = 'eu-west-1'
|
AWS_REGION = 'us-west-2'
|
||||||
|
|
||||||
CBC_PROXY_ENABLED = True
|
CBC_PROXY_ENABLED = True
|
||||||
CBC_PROXY_AWS_ACCESS_KEY_ID = os.environ.get('CBC_PROXY_AWS_ACCESS_KEY_ID', '')
|
CBC_PROXY_AWS_ACCESS_KEY_ID = os.environ.get('CBC_PROXY_AWS_ACCESS_KEY_ID', '')
|
||||||
@@ -428,9 +429,9 @@ class Development(Config):
|
|||||||
|
|
||||||
NOTIFY_ENVIRONMENT = 'development'
|
NOTIFY_ENVIRONMENT = 'development'
|
||||||
NOTIFY_LOG_PATH = 'application.log'
|
NOTIFY_LOG_PATH = 'application.log'
|
||||||
NOTIFY_EMAIL_DOMAIN = "notify.tools"
|
NOTIFY_EMAIL_DOMAIN = "dispostable.com"
|
||||||
|
|
||||||
SQLALCHEMY_DATABASE_URI = os.getenv('SQLALCHEMY_DATABASE_URI', 'postgresql://localhost/notification_api')
|
SQLALCHEMY_DATABASE_URI = os.getenv('SQLALCHEMY_DATABASE_URI', 'postgresql://postgres:chummy@db:5432/notification_api')
|
||||||
REDIS_URL = os.getenv('REDIS_URL', 'redis://localhost:6379/0')
|
REDIS_URL = os.getenv('REDIS_URL', 'redis://localhost:6379/0')
|
||||||
|
|
||||||
ANTIVIRUS_ENABLED = os.getenv('ANTIVIRUS_ENABLED') == '1'
|
ANTIVIRUS_ENABLED = os.getenv('ANTIVIRUS_ENABLED') == '1'
|
||||||
@@ -466,7 +467,7 @@ class Test(Development):
|
|||||||
LETTER_SANITISE_BUCKET_NAME = 'test-letters-sanitise'
|
LETTER_SANITISE_BUCKET_NAME = 'test-letters-sanitise'
|
||||||
|
|
||||||
# this is overriden in jenkins and on cloudfoundry
|
# this is overriden in jenkins and on cloudfoundry
|
||||||
SQLALCHEMY_DATABASE_URI = os.getenv('SQLALCHEMY_DATABASE_URI', 'postgresql://localhost/test_notification_api')
|
SQLALCHEMY_DATABASE_URI = os.getenv('SQLALCHEMY_DATABASE_URI', 'postgresql://postgres:chummy@db:5432/notification_api')
|
||||||
|
|
||||||
CELERY = {
|
CELERY = {
|
||||||
**Config.CELERY,
|
**Config.CELERY,
|
||||||
|
|||||||
+2
-2
@@ -122,7 +122,7 @@ class User(db.Model):
|
|||||||
state = db.Column(db.String, nullable=False, default='pending')
|
state = db.Column(db.String, nullable=False, default='pending')
|
||||||
platform_admin = db.Column(db.Boolean, nullable=False, default=False)
|
platform_admin = db.Column(db.Boolean, nullable=False, default=False)
|
||||||
current_session_id = db.Column(UUID(as_uuid=True), nullable=True)
|
current_session_id = db.Column(UUID(as_uuid=True), nullable=True)
|
||||||
auth_type = db.Column(db.String, db.ForeignKey('auth_type.name'), index=True, nullable=False, default=SMS_AUTH_TYPE)
|
auth_type = db.Column(db.String, db.ForeignKey('auth_type.name'), index=True, nullable=False, default=EMAIL_AUTH_TYPE)
|
||||||
email_access_validated_at = db.Column(
|
email_access_validated_at = db.Column(
|
||||||
db.DateTime, index=False, unique=False, nullable=False, default=datetime.datetime.utcnow
|
db.DateTime, index=False, unique=False, nullable=False, default=datetime.datetime.utcnow
|
||||||
)
|
)
|
||||||
@@ -1841,7 +1841,7 @@ class InvitedUser(db.Model):
|
|||||||
db.ForeignKey('auth_type.name'),
|
db.ForeignKey('auth_type.name'),
|
||||||
index=True,
|
index=True,
|
||||||
nullable=False,
|
nullable=False,
|
||||||
default=SMS_AUTH_TYPE
|
default=EMAIL_AUTH_TYPE
|
||||||
)
|
)
|
||||||
folder_permissions = db.Column(JSONB(none_as_null=True), nullable=False, default=[])
|
folder_permissions = db.Column(JSONB(none_as_null=True), nullable=False, default=[])
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,42 @@
|
|||||||
|
{
|
||||||
|
"name": "notification-api",
|
||||||
|
"dockerComposeFile": "../docker-compose.devcontainer.yml",
|
||||||
|
"service": "dev",
|
||||||
|
"workspaceFolder": "/workspace",
|
||||||
|
"shutdownAction": "stopCompose",
|
||||||
|
"remoteEnv": {
|
||||||
|
"PATH": "/home/vscode/.local/bin:${containerEnv:PATH}" // give our installed Python modules precedence
|
||||||
|
},
|
||||||
|
"settings": {
|
||||||
|
"[python]": {
|
||||||
|
"editor.formatOnSave": true
|
||||||
|
},
|
||||||
|
"python.linting.enabled": true,
|
||||||
|
"python.linting.pylintEnabled": true,
|
||||||
|
"python.pythonPath": "/usr/local/bin/python"
|
||||||
|
},
|
||||||
|
"features": {
|
||||||
|
"docker-from-docker": {
|
||||||
|
"version": "latest",
|
||||||
|
"moby": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"extensions": [
|
||||||
|
"ms-python.black-formatter",
|
||||||
|
"donjayamanne.python-extension-pack",
|
||||||
|
"ms-azuretools.vscode-docker",
|
||||||
|
"ms-python.vscode-pylance",
|
||||||
|
"eamodio.gitlens",
|
||||||
|
"wholroyd.jinja",
|
||||||
|
"pmbenjamin.vscode-snyk",
|
||||||
|
"visualstudioexptteam.vscodeintellicode",
|
||||||
|
"yzhang.markdown-all-in-one",
|
||||||
|
"ms-ossdata.vscode-postgresql",
|
||||||
|
"GitHub.copilot",
|
||||||
|
"ms-vsliveshare.vsliveshare",
|
||||||
|
"mtxr.sqltools",
|
||||||
|
"mtxr.sqltools-driver-pg",
|
||||||
|
],
|
||||||
|
"postCreateCommand": "notify-dev-entrypoint.sh",
|
||||||
|
"remoteUser": "vscode"
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
FROM mcr.microsoft.com/vscode/devcontainers/python:0-3.9
|
||||||
|
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get -y install --no-install-recommends \
|
||||||
|
apt-utils \
|
||||||
|
postgresql-client \
|
||||||
|
2>&1 \
|
||||||
|
&& apt-get -y install \
|
||||||
|
curl \
|
||||||
|
emacs \
|
||||||
|
exa \
|
||||||
|
fd-find \
|
||||||
|
git \
|
||||||
|
iproute2 \
|
||||||
|
less \
|
||||||
|
libsodium-dev \
|
||||||
|
lsb-release \
|
||||||
|
man-db \
|
||||||
|
manpages \
|
||||||
|
net-tools \
|
||||||
|
openssh-client \
|
||||||
|
procps \
|
||||||
|
sudo \
|
||||||
|
tldr \
|
||||||
|
unzip \
|
||||||
|
vim \
|
||||||
|
&& apt-get autoremove -y \
|
||||||
|
&& apt-get clean -y \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# Upgrade pip
|
||||||
|
RUN pip install --upgrade pip
|
||||||
|
|
||||||
|
COPY devcontainer-api/scripts/notify-dev-entrypoint.sh /usr/local/bin/
|
||||||
|
COPY devcontainer-api/scripts/notify-worker-entrypoint.sh /usr/local/bin/
|
||||||
|
|
||||||
|
ENV SHELL /bin/zsh
|
||||||
|
|
||||||
|
EXPOSE 8000
|
||||||
|
EXPOSE 6011
|
||||||
+18
@@ -0,0 +1,18 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -ex
|
||||||
|
|
||||||
|
###################################################################
|
||||||
|
# This script will get executed *once* the Docker container has
|
||||||
|
# been built. Commands that need to be executed with all available
|
||||||
|
# tools and the filesystem mount enabled should be located here.
|
||||||
|
#
|
||||||
|
# The PostgreSQL Docker image has an extension mechanism that does
|
||||||
|
# not necessitate to override the entrypoint or main command. One
|
||||||
|
# simply has to copy a shell script into the
|
||||||
|
# /docker-entrypoint-initdb.d/ initialization folder.
|
||||||
|
###################################################################
|
||||||
|
|
||||||
|
# Notify database setup.
|
||||||
|
createdb --user=postgres notification_api
|
||||||
|
|
||||||
|
wall "The db container entrypoint setup is complete!"
|
||||||
+43
@@ -0,0 +1,43 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
set -ex
|
||||||
|
|
||||||
|
###################################################################
|
||||||
|
# This script will get executed *once* the Docker container has
|
||||||
|
# been built. Commands that need to be executed with all available
|
||||||
|
# tools and the filesystem mount enabled should be located here.
|
||||||
|
###################################################################
|
||||||
|
|
||||||
|
# Define aliases
|
||||||
|
echo -e "\n\n# User's Aliases" >> ~/.zshrc
|
||||||
|
echo -e "alias fd=fdfind" >> ~/.zshrc
|
||||||
|
echo -e "alias l='ls -al --color'" >> ~/.zshrc
|
||||||
|
echo -e "alias ls='exa'" >> ~/.zshrc
|
||||||
|
echo -e "alias l='exa -alh'" >> ~/.zshrc
|
||||||
|
echo -e "alias ll='exa -alh@ --git'" >> ~/.zshrc
|
||||||
|
echo -e "alias lt='exa -al -T -L 2'" >> ~/.zshrc
|
||||||
|
|
||||||
|
# # Kubectl aliases and command autocomplete
|
||||||
|
# echo -e "alias k='kubectl'" >> ~/.zshrc
|
||||||
|
# echo -e "alias k-staging='aws eks --region ca-central-1 update-kubeconfig --name notification-canada-ca-staging-eks-cluster'" >> ~/.zshrc
|
||||||
|
# echo -e "alias k-prod='aws eks --region ca-central-1 update-kubeconfig --name notification-canada-ca-production-eks-cluster'" >> ~/.zshrc
|
||||||
|
# echo -e "source <(kubectl completion zsh)" >> ~/.zshrc
|
||||||
|
# echo -e "complete -F __start_kubectl k" >> ~/.zshrc
|
||||||
|
|
||||||
|
cd /workspace
|
||||||
|
|
||||||
|
# Warm up git index prior to display status in prompt else it will
|
||||||
|
# be quite slow on every invocation of starship.
|
||||||
|
git status
|
||||||
|
|
||||||
|
make generate-version-file
|
||||||
|
pip3 install -r requirements.txt
|
||||||
|
pip3 install -r requirements_for_test.txt
|
||||||
|
|
||||||
|
# Install virtualenv to support running the isolated make freeze-requirements from within the devcontainer
|
||||||
|
pip3 install virtualenv
|
||||||
|
|
||||||
|
# Upgrade schema of the notification_api database
|
||||||
|
flask db upgrade
|
||||||
|
|
||||||
|
# Run flask server
|
||||||
|
# make run-flask
|
||||||
+40
@@ -0,0 +1,40 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
set -ex
|
||||||
|
|
||||||
|
###################################################################
|
||||||
|
# This script will get executed *once* the Docker container has
|
||||||
|
# been built. Commands that need to be executed with all available
|
||||||
|
# tools and the filesystem mount enabled should be located here.
|
||||||
|
###################################################################
|
||||||
|
|
||||||
|
# Define aliases
|
||||||
|
echo -e "\n\n# User's Aliases" >> ~/.zshrc
|
||||||
|
echo -e "alias fd=fdfind" >> ~/.zshrc
|
||||||
|
echo -e "alias l='ls -al --color'" >> ~/.zshrc
|
||||||
|
echo -e "alias ls='exa'" >> ~/.zshrc
|
||||||
|
echo -e "alias l='exa -alh'" >> ~/.zshrc
|
||||||
|
echo -e "alias ll='exa -alh@ --git'" >> ~/.zshrc
|
||||||
|
echo -e "alias lt='exa -al -T -L 2'" >> ~/.zshrc
|
||||||
|
|
||||||
|
# # Kubectl aliases and command autocomplete
|
||||||
|
# echo -e "alias k='kubectl'" >> ~/.zshrc
|
||||||
|
# echo -e "alias k-staging='aws eks --region ca-central-1 update-kubeconfig --name notification-canada-ca-staging-eks-cluster'" >> ~/.zshrc
|
||||||
|
# echo -e "alias k-prod='aws eks --region ca-central-1 update-kubeconfig --name notification-canada-ca-production-eks-cluster'" >> ~/.zshrc
|
||||||
|
# echo -e "source <(kubectl completion zsh)" >> ~/.zshrc
|
||||||
|
# echo -e "complete -F __start_kubectl k" >> ~/.zshrc
|
||||||
|
|
||||||
|
cd /workspace
|
||||||
|
|
||||||
|
# Warm up git index prior to display status in prompt else it will
|
||||||
|
# be quite slow on every invocation of starship.
|
||||||
|
git status
|
||||||
|
|
||||||
|
make generate-version-file
|
||||||
|
pip3 install -r requirements.txt
|
||||||
|
pip3 install -r requirements_for_test.txt
|
||||||
|
|
||||||
|
# Install virtualenv to support running the isolated make freeze-requirements from within the devcontainer
|
||||||
|
pip3 install virtualenv
|
||||||
|
|
||||||
|
# Run Celery worker
|
||||||
|
# make run-celery
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
{
|
||||||
|
"name": "notification-api",
|
||||||
|
"dockerComposeFile": "../docker-compose.devcontainer.yml",
|
||||||
|
"service": "worker",
|
||||||
|
"workspaceFolder": "/workspace",
|
||||||
|
"shutdownAction": "stopCompose",
|
||||||
|
"remoteEnv": {
|
||||||
|
"PATH": "/home/vscode/.local/bin:${containerEnv:PATH}" // give our installed Python modules precedence
|
||||||
|
},
|
||||||
|
"settings": {
|
||||||
|
"[python]": {
|
||||||
|
"editor.formatOnSave": true
|
||||||
|
},
|
||||||
|
"python.linting.enabled": true,
|
||||||
|
"python.linting.pylintEnabled": true,
|
||||||
|
"python.pythonPath": "/usr/local/bin/python"
|
||||||
|
},
|
||||||
|
"features": {
|
||||||
|
"docker-from-docker": {
|
||||||
|
"version": "latest",
|
||||||
|
"moby": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"extensions": [
|
||||||
|
"ms-python.black-formatter",
|
||||||
|
"donjayamanne.python-extension-pack",
|
||||||
|
"ms-azuretools.vscode-docker",
|
||||||
|
"ms-python.vscode-pylance",
|
||||||
|
"eamodio.gitlens",
|
||||||
|
"wholroyd.jinja",
|
||||||
|
"pmbenjamin.vscode-snyk",
|
||||||
|
"visualstudioexptteam.vscodeintellicode",
|
||||||
|
"yzhang.markdown-all-in-one",
|
||||||
|
"ms-ossdata.vscode-postgresql",
|
||||||
|
"GitHub.copilot",
|
||||||
|
"ms-vsliveshare.vsliveshare",
|
||||||
|
"mtxr.sqltools",
|
||||||
|
"mtxr.sqltools-driver-pg",
|
||||||
|
],
|
||||||
|
"postCreateCommand": "notify-worker-entrypoint.sh",
|
||||||
|
"remoteUser": "vscode"
|
||||||
|
}
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
version: '3'
|
||||||
|
|
||||||
|
services:
|
||||||
|
db:
|
||||||
|
container_name: db
|
||||||
|
image: postgres:13.4
|
||||||
|
volumes:
|
||||||
|
- ./devcontainer-api/initdb:/docker-entrypoint-initdb.d
|
||||||
|
environment:
|
||||||
|
PGGSSENCMODE: disable
|
||||||
|
POSTGRES_USER: postgres
|
||||||
|
POSTGRES_PASSWORD: chummy
|
||||||
|
POSTGRES_HOST_AUTH_METHOD: trust
|
||||||
|
ports:
|
||||||
|
- "5432:5432"
|
||||||
|
expose:
|
||||||
|
- "5432"
|
||||||
|
command:
|
||||||
|
- "postgres"
|
||||||
|
- "-c"
|
||||||
|
- "listen_addresses=*"
|
||||||
|
restart: always
|
||||||
|
redis:
|
||||||
|
container_name: redis
|
||||||
|
image: redis:6.2
|
||||||
|
restart: always
|
||||||
|
command: sh -c "rm -f /data/dump.rdb && redis-server --port 6380" # disable persistence
|
||||||
|
ports:
|
||||||
|
- "6380:6380"
|
||||||
|
expose:
|
||||||
|
- "6380"
|
||||||
|
dev:
|
||||||
|
container_name: dev
|
||||||
|
image: dev-notification-api
|
||||||
|
build:
|
||||||
|
context: .
|
||||||
|
dockerfile: devcontainer-api/Dockerfile
|
||||||
|
env_file: .env
|
||||||
|
volumes:
|
||||||
|
- .:/workspace:cached
|
||||||
|
command: sleep infinity
|
||||||
|
ports:
|
||||||
|
- 6011:6011
|
||||||
|
expose:
|
||||||
|
- "6011"
|
||||||
|
depends_on:
|
||||||
|
- db
|
||||||
|
- redis
|
||||||
|
links:
|
||||||
|
- db
|
||||||
|
restart: always
|
||||||
|
worker:
|
||||||
|
container_name: worker
|
||||||
|
image: dev-notification-api
|
||||||
|
build:
|
||||||
|
context: .
|
||||||
|
dockerfile: devcontainer-api/Dockerfile
|
||||||
|
env_file: .env
|
||||||
|
volumes:
|
||||||
|
- .:/workspace:cached
|
||||||
|
command: sleep infinity
|
||||||
|
depends_on:
|
||||||
|
- db
|
||||||
|
- redis
|
||||||
|
- dev
|
||||||
|
links:
|
||||||
|
- db
|
||||||
|
|
||||||
|
networks:
|
||||||
|
default:
|
||||||
|
name: notify-network
|
||||||
|
external: true
|
||||||
@@ -25,18 +25,18 @@ def upgrade():
|
|||||||
password = hashpw(str(uuid.uuid4()))
|
password = hashpw(str(uuid.uuid4()))
|
||||||
op.get_bind()
|
op.get_bind()
|
||||||
user_insert = """INSERT INTO users (id, name, email_address, created_at, failed_login_count, _password, mobile_number, state, platform_admin)
|
user_insert = """INSERT INTO users (id, name, email_address, created_at, failed_login_count, _password, mobile_number, state, platform_admin)
|
||||||
VALUES ('{}', 'Notify service user', 'notify-service-user@digital.cabinet-office', '{}', 0,'{}', '+441234123412', 'active', False)
|
VALUES ('{}', 'Notify service user', 'testsender@dispostable.com', '{}', 0,'{}', '+441234123412', 'active', False)
|
||||||
"""
|
"""
|
||||||
op.execute(user_insert.format(user_id, datetime.utcnow(), password))
|
op.execute(user_insert.format(user_id, datetime.utcnow(), password))
|
||||||
service_history_insert = """INSERT INTO services_history (id, name, created_at, active, message_limit, restricted, research_mode, email_from, created_by_id, reply_to_email_address, version)
|
service_history_insert = """INSERT INTO services_history (id, name, created_at, active, message_limit, restricted, research_mode, email_from, created_by_id, reply_to_email_address, version)
|
||||||
VALUES ('{}', 'Notify service', '{}', True, 1000, False, False, 'notify@digital.cabinet-office.gov.uk',
|
VALUES ('{}', 'Notify service', '{}', True, 1000, False, False, 'testsender@dispostable.com',
|
||||||
'{}', 'notify@digital.cabinet-office.gov.uk', 1)
|
'{}', 'testsender@dispostable.com', 1)
|
||||||
|
|
||||||
"""
|
"""
|
||||||
op.execute(service_history_insert.format(service_id, datetime.utcnow(), user_id))
|
op.execute(service_history_insert.format(service_id, datetime.utcnow(), user_id))
|
||||||
service_insert = """INSERT INTO services (id, name, created_at, active, message_limit, restricted, research_mode, email_from, created_by_id, reply_to_email_address, version)
|
service_insert = """INSERT INTO services (id, name, created_at, active, message_limit, restricted, research_mode, email_from, created_by_id, reply_to_email_address, version)
|
||||||
VALUES ('{}', 'Notify service', '{}', True, 1000, False, False, 'notify@digital.cabinet-office.gov.uk',
|
VALUES ('{}', 'Notify service', '{}', True, 1000, False, False, 'testsender@dispostable.com',
|
||||||
'{}', 'notify@digital.cabinet-office.gov.uk', 1)
|
'{}', 'testsender@dispostable.com', 1)
|
||||||
"""
|
"""
|
||||||
op.execute(service_insert.format(service_id, datetime.utcnow(), user_id))
|
op.execute(service_insert.format(service_id, datetime.utcnow(), user_id))
|
||||||
user_to_service_insert = """INSERT INTO user_to_service (user_id, service_id) VALUES ('{}', '{}')"""
|
user_to_service_insert = """INSERT INTO user_to_service (user_id, service_id) VALUES ('{}', '{}')"""
|
||||||
|
|||||||
@@ -16,8 +16,8 @@ import sqlalchemy as sa
|
|||||||
service_id = 'd6aa2c68-a2d9-4437-ab19-3ae8eb202553'
|
service_id = 'd6aa2c68-a2d9-4437-ab19-3ae8eb202553'
|
||||||
def upgrade():
|
def upgrade():
|
||||||
op.get_bind()
|
op.get_bind()
|
||||||
op.execute("update services set email_from = 'gov.uk.notify' where id = '{}'".format(service_id))
|
op.execute("update services set email_from = 'testsender' where id = '{}'".format(service_id))
|
||||||
op.execute("update services_history set email_from = 'gov.uk.notify' where id = '{}'".format(service_id))
|
op.execute("update services_history set email_from = 'testsender' where id = '{}'".format(service_id))
|
||||||
|
|
||||||
|
|
||||||
def downgrade():
|
def downgrade():
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ import sqlalchemy as sa
|
|||||||
def upgrade():
|
def upgrade():
|
||||||
op.execute("""
|
op.execute("""
|
||||||
UPDATE users
|
UPDATE users
|
||||||
SET email_address = 'notify-service-user@digital.cabinet-office.gov.uk'
|
SET email_address = 'testsender@dispostable.com'
|
||||||
WHERE email_address = 'notify-service-user@digital.cabinet-office'
|
WHERE email_address = 'notify-service-user@digital.cabinet-office'
|
||||||
""")
|
""")
|
||||||
|
|
||||||
@@ -26,5 +26,5 @@ def downgrade():
|
|||||||
op.execute("""
|
op.execute("""
|
||||||
UPDATE users
|
UPDATE users
|
||||||
SET email_address = 'notify-service-user@digital.cabinet-office'
|
SET email_address = 'notify-service-user@digital.cabinet-office'
|
||||||
WHERE email_address = 'notify-service-user@digital.cabinet-office.gov.uk'
|
WHERE email_address = 'testsender@dispostable.com'
|
||||||
""")
|
""")
|
||||||
|
|||||||
@@ -64,7 +64,7 @@ It’s only an emergency if:
|
|||||||
* a 500 response code appears when you try to send messages using the API
|
* a 500 response code appears when you try to send messages using the API
|
||||||
|
|
||||||
If you have one of these emergencies, email details to:
|
If you have one of these emergencies, email details to:
|
||||||
ooh-gov-uk-notify-support@digital.cabinet-office.gov.uk
|
testsender@dispostable.com
|
||||||
|
|
||||||
^Only use this email address for out of hours emergencies. Don’t share this address with people outside of your team.
|
^Only use this email address for out of hours emergencies. Don’t share this address with people outside of your team.
|
||||||
|
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ def upgrade():
|
|||||||
INSERT INTO service_email_reply_to
|
INSERT INTO service_email_reply_to
|
||||||
(id, service_id, email_address, is_default, created_at)
|
(id, service_id, email_address, is_default, created_at)
|
||||||
VALUES
|
VALUES
|
||||||
('{}','{}', 'notify+1@digital.cabinet-office.gov.uk', 'f', NOW())
|
('{}','{}', 'testsender@dispostable.com', 'f', NOW())
|
||||||
""".format(EMAIL_REPLY_TO_ID, NOTIFY_SERVICE_ID))
|
""".format(EMAIL_REPLY_TO_ID, NOTIFY_SERVICE_ID))
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ cachetools==5.1.0
|
|||||||
beautifulsoup4==4.11.1
|
beautifulsoup4==4.11.1
|
||||||
lxml==4.8.0
|
lxml==4.8.0
|
||||||
Werkzeug==2.0.3 # pyup: <2.1.0 # later versions are not compatible with the version of flask-sqlalchemy we have pinned
|
Werkzeug==2.0.3 # pyup: <2.1.0 # later versions are not compatible with the version of flask-sqlalchemy we have pinned
|
||||||
|
python-dotenv==0.20.0
|
||||||
|
|
||||||
notifications-python-client==6.3.0
|
notifications-python-client==6.3.0
|
||||||
|
|
||||||
|
|||||||
@@ -77,6 +77,8 @@ docopt==0.6.2
|
|||||||
# via notifications-python-client
|
# via notifications-python-client
|
||||||
docutils==0.16
|
docutils==0.16
|
||||||
# via awscli
|
# via awscli
|
||||||
|
python-dotenv==0.20.0
|
||||||
|
# via -r requirements.in
|
||||||
eventlet==0.33.1
|
eventlet==0.33.1
|
||||||
# via gunicorn
|
# via gunicorn
|
||||||
flask==2.1.2
|
flask==2.1.2
|
||||||
|
|||||||
+39
@@ -0,0 +1,39 @@
|
|||||||
|
# Debug
|
||||||
|
DEBUG=True
|
||||||
|
ANTIVIRUS_ENABLED=0
|
||||||
|
NOTIFY_ENVIRONMENT=development
|
||||||
|
NOTIFICATION_QUEUE_PREFIX=local_dev_10x
|
||||||
|
STATSD_HOST=localhost
|
||||||
|
SES_STUB_URL=None
|
||||||
|
NOTIFY_APP_NAME=api
|
||||||
|
NOTIFY_EMAIL_DOMAIN=dispostable.com
|
||||||
|
|
||||||
|
# secrets that internal apps, such as the admin app or document download, must use to authenticate with the API
|
||||||
|
ADMIN_CLIENT_ID=notify-admin
|
||||||
|
GOVUK_ALERTS_CLIENT_ID=govuk-alerts
|
||||||
|
|
||||||
|
# Flask
|
||||||
|
FLASK_APP=application.py
|
||||||
|
FLASK_ENV=development
|
||||||
|
WERKZEUG_DEBUG_PIN=off
|
||||||
|
SECRET_KEY=dev-notify-secret-key
|
||||||
|
DANGEROUS_SALT=dev-notify-salt
|
||||||
|
|
||||||
|
# URL of admin app
|
||||||
|
ADMIN_BASE_URL=http://0.0.0.0:6012
|
||||||
|
|
||||||
|
# URL of api app (on AWS this is the internal api endpoint)
|
||||||
|
API_HOST_NAME=http://0.0.0.0:6011
|
||||||
|
|
||||||
|
# URL of redis instance
|
||||||
|
REDIS_URL=redis://redis:6380
|
||||||
|
REDIS_ENABLED=1
|
||||||
|
|
||||||
|
# DB conection string, this is overriden in jenkins and on cloudfoundry
|
||||||
|
SQLALCHEMY_DATABASE_URI=postgresql://postgres:chummy@db:5432/notification_api
|
||||||
|
SQLALCHEMY_DATABASE_TEST_URI=postgresql://postgres:chummy@db:5432/test_notification_api
|
||||||
|
|
||||||
|
# AWS
|
||||||
|
AWS_REGION=us-west-2
|
||||||
|
AWS_ACCESS_KEY_ID=
|
||||||
|
AWS_SECRET_ACCESS_KEY=
|
||||||
@@ -65,7 +65,7 @@ function start_application {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function start_aws_logs_agent {
|
function start_aws_logs_agent {
|
||||||
exec aws logs push --region eu-west-1 --config-file /home/vcap/app/awslogs.conf &
|
exec aws logs push --region us-west-2 --config-file /home/vcap/app/awslogs.conf &
|
||||||
AWSLOGS_AGENT_PID=$!
|
AWSLOGS_AGENT_PID=$!
|
||||||
echo "AWS logs agent pid: ${AWSLOGS_AGENT_PID}"
|
echo "AWS logs agent pid: ${AWSLOGS_AGENT_PID}"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -102,7 +102,7 @@ function start_application {
|
|||||||
|
|
||||||
function start_aws_logs_agent {
|
function start_aws_logs_agent {
|
||||||
echo "Starting aws logs agent..."
|
echo "Starting aws logs agent..."
|
||||||
exec aws logs push --region eu-west-1 --config-file /home/vcap/app/awslogs.conf &
|
exec aws logs push --region us-west-2 --config-file /home/vcap/app/awslogs.conf &
|
||||||
AWSLOGS_AGENT_PID=$!
|
AWSLOGS_AGENT_PID=$!
|
||||||
echo "AWS logs agent pid: ${AWSLOGS_AGENT_PID}"
|
echo "AWS logs agent pid: ${AWSLOGS_AGENT_PID}"
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user