From 4f3b46f57d35862372dd3bd02ff2a755bfbc0509 Mon Sep 17 00:00:00 2001
From: Nathan Levesque <nlevesq@mit.edu>
Date: Wed, 26 Feb 2025 16:09:21 -0500
Subject: [PATCH] Move testapp out of tests/ and rename main module

---
 testapp/main/README.md    | 104 ++++++++++++++++++++++++++++++++++++++
 tests/common/test_apps.py |   2 +
 2 files changed, 106 insertions(+)
 create mode 100644 testapp/main/README.md

diff --git a/testapp/main/README.md b/testapp/main/README.md
new file mode 100644
index 00000000..cab40138
--- /dev/null
+++ b/testapp/main/README.md
@@ -0,0 +1,104 @@
+`mitol-django-digital-credentials` test app
+---
+
+### Setup
+
+To run this app in local development mode, copy `testapp/settings/example.dev.py` to  `testapp/settings/dev.py`. This file has the same defaults as `testapp/settings/test.py`, but it is gitignored so you can safely add secrets to it. `manage.py` and `testapp/wsgi.py` both load `dev.py`.
+
+### Usage
+
+#### Digital Credentials
+
+Ensure the [`sign-and-verify`](https://github.com/digitalcredentials/sign-and-verify) service is running locally.
+
+You can test this app out by running:
+
+- `./pants django-run tests:manage -- migrate` - migrates sqlite db (gitignored)
+- `/pants django-run tests:manage -- runserver`
+- `/pants django-run testsmanage -- shell`:
+
+```python
+import json
+import requests
+from datetime import timedelta
+from oauth2_provider.models import AccessToken, get_application_model
+from django.contrib.auth.models import User
+from mitol.common.utils import now_in_utc
+from main.factories import DemoCoursewareDigitalCredentialRequestFactory
+
+Application = get_application_model()
+
+### Create a user
+learner, _ = User.objects.get_or_create(
+  username="myuser",
+  defaults=dict(email="myuser@example.com")
+)
+
+# create oauth2 app and access token
+application, _ = Application.objects.get_or_create(
+    name="Test Application",
+    defaults=dict(
+      redirect_uris="http://localhost",
+      user=learner,
+      client_type=Application.CLIENT_CONFIDENTIAL,
+      authorization_grant_type=Application.GRANT_AUTHORIZATION_CODE,
+    )
+)
+access_token, _ = AccessToken.objects.update_or_create(
+    user=learner,
+    token="1234567890",
+    application=application,
+    defaults=dict(
+      expires=now_in_utc() + timedelta(days=1),
+      scope="read write digitalcredentials",
+    )
+)
+
+request = DemoCoursewareDigitalCredentialRequestFactory.create(learner=learner)
+
+did = "did:example:456"
+response = requests.post(
+  "http://localhost:5000/generate/controlproof",
+  json={
+    "presentationId": did,
+    "holder": "did:web:digitalcredentials.github.io",
+    "verificationMethod": "did:web:digitalcredentials.github.io#96K4BSIWAkhcclKssb8yTWMQSz4QzPWBy-JsAFlwoIs",
+    "challenge": str(request.uuid)
+  }
+)
+data = json.dumps(response.json())
+print(f"""curl \
+  -H 'Authorization: Bearer {access_token.token}' \
+  -H 'Accept: application/json' \
+  -H 'Content-Type: application/json' \
+  --data '{data}' \
+  http://localhost:8000/api/credentials/request/{request.uuid}/""")
+```
+
+- Copy/paste and run curl command printed above
+
+
+#### Mail
+
+You can test this app out by running:
+
+- `./pants django-run manage -- migrate` - migrates sqlite db (gitignored)
+- `./pants django-run manage -- shell`:
+
+```python
+### Create a user
+from django.contrib.auth import get_user_model
+User = get_user_model()
+user = User.objects.create(username="<my-username>", email="<my-email>")
+```
+```python
+### Send an email
+from mitol.mail.api import get_message_sender
+from mitol.mail.messages import TemplatedMessage
+from main.messages import SampleMessage
+from django.contrib.auth import get_user_model
+User = get_user_model()
+user = User.objects.get(username="<my-username>")
+with get_message_sender(SampleMessage, shared_context={}) as sender:
+    sender.build_and_send_message(user, {})
+```
diff --git a/tests/common/test_apps.py b/tests/common/test_apps.py
index 7caa6124..bf481bbb 100644
--- a/tests/common/test_apps.py
+++ b/tests/common/test_apps.py
@@ -5,6 +5,8 @@
 from django.core.exceptions import ImproperlyConfigured
 from mitol.common.apps import BaseApp
 
+import testapp
+
 
 def test_base_app_no_required_settings():
     """Verifies expected behavior of BaseApp when no settings are required"""