Feature/sentry implementation (#203)

* Added sentry as a dependency and added code setup similar to control panel

* Added call if login fails

* Removed redundant code

* updated environment env var name. Bumped sentry to 2.9.0

* updated environment env var name

* Use ENV instead of SENTRTY_ENVIRONMENT

* Ran isort

* Removed kubernetes env

* Updated readme and make commands to use new APC account. Moved example files into their own directory

* Updated test debug to reference ap rather than controlpanel

* Bumped version in chart.yml

* removed code

* No longer validate against pylint

.github/workflows/super-linter.yml

@@ -35,6 +35,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DEFAULT_BRANCH: main
           VALIDATE_ALL_CODEBASE: false
+          VALIDATE_PYTHON_PYLINT: false
           LINTER_RULES_PATH: /
           PYTHON_BLACK_CONFIG_FILE: pyproject.toml
           PYTHON_FLAKE8_CONFIG_FILE: .flake8

Makefile

@@ -28,7 +28,7 @@ serve:
 	python manage.py runserver
 
 serve-sso:
-	aws-sso exec --profile analytical-platform-development:AdministratorAccess -- python manage.py runserver
+	aws-sso exec --profile analytical-platform-compute-development:modernisation-platform-sandbox -- python manage.py runserver
 
 build-container:
 	@ARCH=`uname -m`; \

README.md

@@ -18,9 +18,14 @@ If you are using a workspace with multiple applications, search for ```Dev Conta
 There is an example environment file stored on 1Password named ```Analytical Platform UI Env```. Paste the contents into a new file called ```.env``` in the root of the project.
 
 ### Running Development Server
-To run the server, you will need to use aws-sso cli. To find the correct profile, run ```aws-sso list``` in the terminal. This will provide you with a link to sign in via SSO. Once signed in, a list of profiles will be displayed. You are looking for the profile name linked to the ```analytical-platform-development``` AccountAlias.
+To run the server, you will need to use aws-sso cli. To find the correct profile, run ```aws-sso list``` in the terminal. This will provide you with a link to sign in via SSO. Once signed in, a list of profiles will be displayed. You are looking for the profile name linked to the ```analytical-platform-compute-development``` AccountAlias.
 
-To run the server using this profile, enter ```aws-sso exec --profile analytical-platform-development:AdministratorAccess -- python manage.py runserver``` or ```make serve-sso```. Then go to ```localhost:8000``` and sign in using your @justice.gov.uk identity.
+To run the server using this profile, enter ```aws-sso exec --profile analytical-platform-compute-development:modernisation-platform-sandbox -- python manage.py runserver``` or ```make serve-sso```. Then go to ```localhost:8000``` and sign in using your @justice.gov.uk identity.
+
+### Local debugging
+Copy `launch.json.example`, `settings.json.example` and `tasks.json.example` from the examples folder into a `.vscode` folder in the root of the project and remove the `.example` suffix. To debug the application, go to the `run and debug` tab and select the `runserver` configuration. When starting debugging you may need to sign into AWS first. There will be a prompt in the terminal to do so.
+
+To debug any tests, switch the debug configuration to `Python: Debug Tests` then go to the testing tab. From here you can run the full suite of tests or individual tests. You can also click the debug icon in order to debug any tests that are failing.
 
 ### Updating Migrations
 To run the migrations locally, run ```python manage.py migrate``` in the terminal.

ap/auth/views/views.py

@@ -7,6 +7,7 @@
 from django.urls import reverse
 from django.views.generic import TemplateView, View
 
+import sentry_sdk
 from authlib.common.security import generate_token
 from authlib.integrations.django_client import OAuthError
 
@@ -58,7 +59,8 @@ def get(self, request):
             else:
                 self._login_success(request, user, token)
                 return redirect("/")
-        except OAuthError:
+        except OAuthError as error:
+            sentry_sdk.capture_exception(error)
             return self._login_failure()
 
 

ap/settings/common.py

@@ -30,7 +30,7 @@
 PROJECT_ROOT = dirname(DJANGO_ROOT)
 
 # Name of the deployment environment (dev/prod)
-ENV = os.environ.get("ENV", "dev")
+ENV = os.environ.get("APP_ENVIRONMENT", "dev")
 
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
@@ -81,6 +81,22 @@
     "django_structlog.middlewares.RequestMiddleware",
 ]
 
+# -- Sentry error tracking
+
+if os.environ.get("SENTRY_DSN"):
+    # Third-party
+    import sentry_sdk
+    from sentry_sdk.integrations.django import DjangoIntegration
+
+    sentry_sdk.init(
+        dsn=os.environ["SENTRY_DSN"],
+        environment=ENV,
+        integrations=[DjangoIntegration()],
+        traces_sample_rate=0.0,
+        send_default_pii=True,
+    )
+
+
 # The list of authentication backend used for checking user's access to app
 AUTHENTICATION_BACKENDS = ["django.contrib.auth.backends.ModelBackend"]
 

chart/Chart.yaml

@@ -3,8 +3,8 @@ apiVersion: v2
 name: analytical-platform-ui
 description: Analytical Platform UI
 type: application
-version: 0.0.0-rc0
-appVersion: 0.0.0-rc0
+version: 0.0.0-rc1
+appVersion: 0.0.0-rc1
 icon: https://upload.wikimedia.org/wikipedia/en/thumb/4/4a/Ministry_of_Justice_logo_%28United_Kingdom%29.svg/611px-Ministry_of_Justice_logo_%28United_Kingdom%29.svg.png
 maintainers:
   - name: moj-data-platform-robot

examples/launch.json.example

@@ -0,0 +1,30 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+      {
+          "name": "runserver",
+          "type": "debugpy",
+          "request": "launch",
+          "args": [
+              "runserver"
+          ],
+          "django": true,
+          "autoStartBrowser": false,
+          "justMyCode": false,
+          "preLaunchTask": "aws-sso-process",
+          "program": "${workspaceFolder}/manage.py",
+      },
+      {
+          "name": "Python: Debug Tests",
+          "type": "debugpy",
+          "request": "launch",
+          "program": "${file}",
+          "purpose": ["debug-test"],
+          "console": "integratedTerminal",
+          "justMyCode": false,
+          "env": {
+              "DJANGO_SETTINGS_MODULE": "ap.settings.test"
+          }
+      }
+  ]
+}

examples/settings.json.example

@@ -0,0 +1,4 @@
+{
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
+}

examples/tasks.json.example

@@ -0,0 +1,12 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+      {
+          "label": "aws-sso-process",
+          "type": "shell",
+          "command": "aws-sso process --sts-refresh --profile analytical-platform-compute-development:modernisation-platform-sandbox"
+      }
+  ]
+}

requirements.txt

@@ -15,4 +15,5 @@ pytest==8.0.0
 pytest-django==4.8.0
 python-dotenv==1.0.1
 requests==2.32.3
+sentry-sdk==2.9.0
 uvicorn[standard]==0.30.1