Merge pull request #519 from open5e/228-consider-designing-a-post-dep…

…loyment-smoke-test

228 consider designing a post deployment smoke test

.github/workflows/build_and_deploy.yml

@@ -51,3 +51,7 @@ jobs:
         env:
           DIGITALOCEAN_TOKEN: ${{ secrets.DIGITALOCEAN_TOKEN }}
         run: ./scripts/do_app_deploy.sh
+      - name: Run Smoke Test
+        run: | 
+          APP_URL=$(jq -r '.app.live_url' ./app.json)
+          python3 ./scripts/smoke_test.py --url $APP_URL

scripts/smoke_test.py

@@ -0,0 +1,37 @@
+import argparse
+import requests
+# This is the smoke test.
+
+# Inputs: url
+
+# Outputs: Whether any of the basic pages end up in a 500 error.
+
+# Pass if not
+
+def main():
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument('-u', '--url',
+        help='URL of the site to check.')
+
+    args = parser.parse_args()
+    print("For a given input url, this goes and checks the root, and the /v1 and /v2")
+    print("paths for 200 response codes. It is intended to be run post-deploy.")
+
+    # Check the root url.
+    assert requests.get(args.url).status_code == 200 
+
+    # Check the /v1 paths
+    assert requests.get(args.url+'/v1/').status_code == 200
+    v1_endpoints = requests.get(args.url+'/v1/?format=json').json()
+    for value in v1_endpoints.values():
+        assert requests.get(value).status_code == 200
+
+    # Checking the /v2 paths
+    assert requests.get(args.url+'/v2/').status_code == 200
+    v2_endpoints = requests.get(args.url+'/v2/?format=json').json()
+    for value in v2_endpoints.values():
+        assert requests.get(value).status_code == 200
+
+if __name__ == '__main__':
+    main()