IN-323 - mock sirius public api (#7)

* Mock sirius for LPA endpoints
* Mock secrets manager
* run local version in docker inc mock sirius and mock secrets manager

Author: jmackown

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": null,
     "lines": null
   },
-  "generated_at": "2020-08-04T16:40:33Z",
+  "generated_at": "2020-08-04T13:24:40Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -58,7 +58,7 @@
       {
         "hashed_secret": "dc724af18fbdd4e59189f5fe768a5f8311527050",
         "is_verified": false,
-        "line_number": 38,
+        "line_number": 60,
         "type": "Secret Keyword"
       }
     ]

README.md

@@ -22,7 +22,22 @@ LPA related functions.
 
 ## Local Environment
 
-Information about spinning up the local environment
+#### Running flask app locally, aka the quick way
+
+1. Start a virtual environment
+1. Add all the env vars: `source .env`
+1. `cd lambda_functions/v1/functions/lpa/app`
+1. flask run
+1. Endpoints should be available on `http://localhost:5000`
+
+#### Running everything in Docker
+
+1. In the root folder: `docker-compose up`
+1. Wait a minute
+1. `cd mock_aws_services`
+1. `python create_secret.py`
+    * steps 3 & 4 are temporary, test data will soon be inserted automatically
+1. Endpoints should be available on `http://0.0.0.0:4343`
 
 ## Unit Tests
 

docker-compose.yml

@@ -24,11 +24,33 @@ services:
       #Uncomment these two options for debugging purposes:
       # PACT_BROKER_WEBHOOK_HOST_WHITELIST: circleci.com
       # PACT_BROKER_LOG_LEVEL: DEBUG
+  mock-sirius:
+    build:
+      context: ./mock_sirius_backend
+      dockerfile: Dockerfile
+    environment:
+      - MOCKING_ENV
+    volumes:
+      - ./mock_sirius_backend/:/var/www/mock_sirius_backend/
+    ports:
+      - "5001:5001"
+  motoserver:
+    build:
+      context: ./mock_aws_services
+      dockerfile: Dockerfile
+    ports:
+      - "4584:4584"
   api_gateway:
     build:
       context: ./lambda_functions/v1
     ports:
       - "4343:4343"
+    links:
+      - mock-sirius
+      - motoserver
+    depends_on:
+      - mock-sirius
+      - motoserver
     volumes:
       - ./lambda_functions/v1/:/var/www/lambda_functions/v1/
     environment:
@@ -39,6 +61,10 @@ services:
       AWS_SECURITY_TOKEN: testing
       AWS_SESSION_TOKEN: testing
       AWS_DEFAULT_REGION: eu-west-1
+      SIRIUS_BASE_URL: http://mock-sirius:5001
+      SIRIUS_API_VERSION: v1
+      SESSION_DATA: publicapi@opgtest.com
+      LOCALSTACK_HOST: motoserver
     networks:
       default:
         aliases:

lambda_functions/v1/Dockerfile

@@ -0,0 +1,25 @@
+FROM python:3.8-slim-buster
+WORKDIR /var/www/lambda_functions/v1
+
+
+
+# Install Python Dependencies
+
+COPY requirements requirements
+RUN cat ./requirements/*.txt | uniq | grep -v "#" > ./requirements/local-requirements.txt
+RUN pip install -r ./requirements/local-requirements.txt
+
+EXPOSE 4343
+
+WORKDIR /var/www/lambda_functions/v1/functions/lpa/app
+
+
+
+ENV FLASK_APP "lpa_local.py"
+ENV FLASK_ENV "development"
+ENV FLASK_DEBUG True
+
+CMD flask run --host=0.0.0.0 --port=4343
+
+
+

lambda_functions/v1/functions/__init__.py

@@ -6,4 +6,7 @@ def create_app(Flask):
 
     app.register_blueprint(api_blueprint)
 
+    routes = [str(p) for p in app.url_map.iter_rules()]
+    print(f"routes: {routes}")
+
     return app

lambda_functions/v1/functions/lpa/__init__.py

@@ -9,7 +9,7 @@
 
 logger = custom_logger("")
 
-version = os.getenv("API_VERSION")
+version = "v1"
 print(f"version: {version}")
 api = Blueprint("api", __name__, url_prefix=f"/{version}")
 

lambda_functions/v1/functions/lpa/app/__init__.py

@@ -4,9 +4,12 @@
 
 import boto3
 import jwt
+import localstack_client.session
+
 import requests
 from botocore.exceptions import ClientError
 
+
 from .helpers import custom_logger
 
 logger = custom_logger("sirius_service")
@@ -55,11 +58,20 @@ def get_secret(environment):
     """
 
     secret_name = f"{environment}/jwt-key"
-    print(f"secret_name: {secret_name}")
     region_name = "eu-west-1"
 
-    session = boto3.session.Session()
-    client = session.client(service_name="secretsmanager", region_name=region_name)
+    try:
+        if os.environ["ENVIRONMENT"] == "local":
+            current_session = localstack_client.session.Session()
+
+        else:
+            current_session = boto3.session.Session()
+    except KeyError:
+        current_session = boto3.session.Session()
+
+    client = current_session.client(
+        service_name="secretsmanager", region_name=region_name
+    )
 
     try:
         get_secret_value_response = client.get_secret_value(SecretId=secret_name)

lambda_functions/v1/functions/lpa/app/api/resources.py

@@ -2,6 +2,3 @@
 from flask import Flask
 
 lambda_handler = create_app(Flask)
-
-routes = [str(p) for p in lambda_handler.url_map.iter_rules()]
-print(f"routes: {routes}")

lambda_functions/v1/functions/lpa/app/api/sirius_service.py

@@ -13,3 +13,5 @@ pyjwt
 hypothesis
 validators
 yarl
+localstack-client
+tenacity

lambda_functions/v1/functions/lpa/app/lpa_local.py

@@ -0,0 +1,9 @@
+FROM python:alpine
+
+RUN apk add --no-cache gcc musl-dev libffi-dev openssl-dev && \
+    pip install moto[server] && \
+    apk del gcc musl-dev libffi-dev openssl-dev
+
+
+CMD moto_server secretsmanager -H 0.0.0.0 -p 4584
+

lambda_functions/v1/requirements/dev-requirements.txt

@@ -0,0 +1,29 @@
+import json
+from tenacity import retry
+import requests
+
+url = "http://0.0.0.0:4584/?Action=CreateSecret"
+
+
+payload = {
+    "Name": "local/jwt-key",
+    "Description": "Secret for local testing with Docker",
+    "SecretString": "this_is_a_secret_string",
+    "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
+}
+
+headers = {"Content-Type": "application/json"}
+
+
+@retry
+def insert_secret():
+    print("Trying....")
+    response = requests.request("POST", url, headers=headers, data=json.dumps(payload))
+    if response.status_code > 300:
+        print("Container not ready yet")
+        raise ConnectionError
+    else:
+        print(response.text.encode("utf8"))
+
+
+insert_secret()

mock_aws_services/Dockerfile

@@ -0,0 +1,13 @@
+# our base image
+FROM python:3.6-slim
+
+WORKDIR /var/www/
+COPY requirements.txt .
+RUN pip install -r requirements.txt
+
+
+
+ENV FLASK_APP=mock_sirius_backend/app.py
+ENV FLASK_ENV=development
+
+CMD ["python", "mock_sirius_backend/app.py"]

mock_aws_services/create_secret.py

@@ -0,0 +1,66 @@
+from ..utilities import load_data
+
+from textwrap import wrap
+
+
+def handle_lpa_get(query_params):
+
+    if "lpaonlinetoolid" in query_params:
+        lpa_online_tool_id = query_params["lpaonlinetoolid"]
+        print(f"using lpa online tool with id {lpa_online_tool_id}")
+
+        if lpa_online_tool_id[0] == "A":
+            print(f"test_id is a valid lpa-online-tool id: {lpa_online_tool_id}")
+
+            response_data = load_data(
+                parent_folder="lpas",
+                filename="lpa_online_tool_response.json",
+                as_json=False,
+            )
+
+            response_data["onlineLpaId"] = lpa_online_tool_id
+
+            response_data = [response_data]
+
+            return 200, response_data
+
+        elif lpa_online_tool_id[:5] == "crash":
+            print("oh no you crashed sirius")
+
+            response_code = lpa_online_tool_id[-3:]
+
+            return response_code, f"Sirius broke bad - error {response_code}"
+
+        else:
+            print(f"{lpa_online_tool_id} is not a lpa-online-tool id")
+            return 404, ""
+
+    elif "uid" in query_params:
+
+        sirius_uid = str(query_params["uid"])
+
+        print(f"using use my lpa with id {sirius_uid}")
+
+        if sirius_uid[0] == "7":
+            print(f"test_id is a valid sirius uid: {sirius_uid}")
+
+            response_data = load_data(
+                parent_folder="lpas", filename="use_an_lpa_response.json", as_json=False
+            )
+
+            response_data["uid"] = "-".join(wrap(sirius_uid, 4))
+
+            response_data = [response_data]
+
+            return 200, response_data
+
+        elif len(sirius_uid) == 3:
+            print("oh no you crashed sirius")
+
+            response_code = sirius_uid
+
+            return response_code, f"Sirius broke bad - error {response_code}"
+
+        else:
+            print(f"{sirius_uid} is not a sirius uid")
+            return 404, ""

mock_sirius_backend/Dockerfile

@@ -0,0 +1,7 @@
+{
+    "onlineLpaId": "A39721583862",
+    "receiptDate": "2017-04-11",
+    "registrationDate": null,
+    "rejectedDate": null,
+    "status": "Pending"
+}