added e2e test for oauth1

Author: opaduchak

addon_service/migrations/0002_oauth1clientconfig_and_more.py

@@ -0,0 +1,55 @@
+# Generated by Django 4.2.7 on 2024-07-02 13:13
+
+import django.db.models.deletion
+from django.db import (
+    migrations,
+    models,
+)
+
+import addon_service.common.str_uuid_field
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("addon_service", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="OAuth1ClientConfig",
+            fields=[
+                (
+                    "id",
+                    addon_service.common.str_uuid_field.StrUUIDField(
+                        default=addon_service.common.str_uuid_field.str_uuid4,
+                        editable=False,
+                        primary_key=True,
+                        serialize=False,
+                    ),
+                ),
+                ("created", models.DateTimeField(editable=False)),
+                ("modified", models.DateTimeField()),
+                ("request_token_url", models.URLField()),
+                ("auth_url", models.URLField()),
+                ("access_token_url", models.URLField()),
+                ("client_key", models.CharField(null=True)),
+                ("client_secret", models.CharField(null=True)),
+            ],
+            options={
+                "verbose_name": "OAuth1 Client Config",
+                "verbose_name_plural": "OAuth1 Client Configs",
+            },
+        ),
+        migrations.AddField(
+            model_name="externalstorageservice",
+            name="oauth1_client_config",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="external_storage_services",
+                to="addon_service.oauth1clientconfig",
+            ),
+        ),
+    ]

addon_service/migrations/0003_authorizedstorageaccount_is_oauth1_ready.py

@@ -0,0 +1,23 @@
+# Generated by Django 4.2.7 on 2024-07-03 11:01
+
+from django.db import (
+    migrations,
+    models,
+)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("addon_service", "0002_oauth1clientconfig_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="authorizedstorageaccount",
+            name="is_oauth1_ready",
+            field=models.BooleanField(
+                blank=True, null=True, verbose_name="addon_service.OAuth2TokenMetadata"
+            ),
+        ),
+    ]

addon_service/tests/_factories.py

@@ -36,6 +36,17 @@ class Meta:
     client_secret = factory.Faker("word")
 
 
+class OAuth1ClientConfigFactory(DjangoModelFactory):
+    class Meta:
+        model = db.OAuth1ClientConfig
+
+    auth_url = "https://api.example/auth/"
+    access_token_url = "https://osf.example/oauth/access"
+    request_token_url = "https://api.example.com/oauth/request"
+    client_key = factory.Faker("word")
+    client_secret = factory.Faker("word")
+
+
 class AddonOperationInvocationFactory(DjangoModelFactory):
     class Meta:
         model = db.AddonOperationInvocation
@@ -64,7 +75,6 @@ class Meta:
     max_concurrent_downloads = factory.Faker("pyint")
     max_upload_mb = factory.Faker("pyint")
     int_addon_imp = known_imps.get_imp_number(known_imps.get_imp_by_name("BLARG"))
-    oauth2_client_config = factory.SubFactory(OAuth2ClientConfigFactory)
     supported_scopes = ["service.url/grant_all"]
 
     @classmethod
@@ -89,6 +99,27 @@ def _create(
         )
 
 
+class ExternalStorageOAuth2ServiceFactory(ExternalStorageServiceFactory):
+    oauth2_client_config = factory.SubFactory(OAuth2ClientConfigFactory)
+
+
+class ExternalStorageOAuth1ServiceFactory(ExternalStorageServiceFactory):
+    oauth1_client_config = factory.SubFactory(OAuth1ClientConfigFactory)
+
+    @classmethod
+    def _create(
+        cls,
+        model_class,
+        credentials_format=CredentialsFormats.OAUTH1A,
+        service_type=ServiceTypes.PUBLIC,
+        *args,
+        **kwargs,
+    ):
+        return super()._create(
+            model_class, credentials_format, service_type, *args, **kwargs
+        )
+
+
 class AuthorizedStorageAccountFactory(DjangoModelFactory):
     class Meta:
         model = db.AuthorizedStorageAccount
@@ -112,7 +143,9 @@ def _create(
         account = super()._create(
             model_class=model_class,
             external_storage_service=external_storage_service
-            or ExternalStorageServiceFactory(credentials_format=credentials_format),
+            or ExternalStorageOAuth2ServiceFactory(
+                credentials_format=credentials_format
+            ),
             account_owner=account_owner or UserReferenceFactory(),
             *args,
             **kwargs,

addon_service/tests/_helpers.py

@@ -3,8 +3,14 @@
 import secrets
 from collections import defaultdict
 from http import HTTPStatus
-from typing import Any
-from unittest.mock import patch
+from typing import (
+    TYPE_CHECKING,
+    Any,
+)
+from unittest.mock import (
+    AsyncMock,
+    patch,
+)
 from urllib.parse import (
     parse_qs,
     urlparse,
@@ -20,6 +26,10 @@
 from addon_service.common.aiohttp_session import get_singleton_client_session
 
 
+if TYPE_CHECKING:
+    from addon_service.tests._factories import ExternalStorageOAuth1ServiceFactory
+
+
 class MockOSF:
     _configured_caller_uri: str | None = None
     _permissions: dict[str, dict[str, str | bool]]
@@ -45,13 +55,17 @@ def __init__(self, permissions=None):
 
     @contextlib.contextmanager
     def mocking(self):
-        with patch(
-            "addon_service.authentication.GVCombinedAuthentication.authenticate",
-            side_effect=self._mock_user_check,
-        ), patch(
-            "addon_service.common.osf.has_osf_permission_on_resource",
-            side_effect=self._mock_resource_check,
-        ), patch_encryption_key_derivation():
+        with (
+            patch(
+                "addon_service.authentication.GVCombinedAuthentication.authenticate",
+                side_effect=self._mock_user_check,
+            ),
+            patch(
+                "addon_service.common.osf.has_osf_permission_on_resource",
+                side_effect=self._mock_resource_check,
+            ),
+            patch_encryption_key_derivation(),
+        ):
             yield self
 
     def configure_assumed_caller(self, caller_uri):
@@ -159,6 +173,79 @@ async def _route_post(self, url, *args, **kwargs):
             raise RuntimeError(f"Received unrecognized endpoint {url}")
 
 
+@dataclasses.dataclass
+class MockServiceProvider:
+    _external_service: "ExternalStorageOAuth1ServiceFactory"
+    _static_request_token: str
+    _static_request_secret: str
+    _static_verifier: str
+    _static_oauth_token: str
+    _static_oauth_secret: str
+
+    def __post_init__(self):
+        if self._external_service.oauth1_client_config is not None:
+            self._access_token_url = (
+                self._external_service.oauth1_client_config.access_token_url
+            )
+            self._request_token_url = (
+                self._external_service.oauth1_client_config.request_token_url
+            )
+
+    @property
+    def auth_url(self):
+        return self._external_service.auth_url
+
+    def set_internal_client(self, client):
+        """Attach a DRF APIClient for making requests internally"""
+        self._internal_client = client
+
+    @contextlib.asynccontextmanager
+    async def amocking(self):
+        client_session = await get_singleton_client_session()
+        with (
+            patch.object(client_session, "get", new=self._route_get),
+            patch.object(client_session, "post", new=self._route_post),
+        ):
+            yield self
+
+    @contextlib.contextmanager
+    def mocking(self):
+        with patch(
+            "addon_service.oauth1.utils.get_singleton_client_session",
+            AsyncMock(return_value=AsyncMock(post=self._route_post)),
+        ):
+            yield self
+
+    def initiate_oauth_exchange(self):
+        self._internal_client.get(
+            reverse("oauth1-callback"),
+            {"oauth_token": "oauth_token", "oauth_verifier": "oauth_verifier"},
+        )
+        return _FakeAiohttpResponse()
+
+    @contextlib.asynccontextmanager
+    async def _route_post(self, url, *args, **kwargs):
+        if url.startswith(self._access_token_url):
+            yield _FakeAiohttpResponse(
+                status=HTTPStatus.CREATED,
+                data={
+                    "oauth_token": self._static_oauth_token,
+                    "oauth_token_secret": self._static_oauth_secret,
+                },
+            )
+        elif url.startswith(self._request_token_url):
+            yield _FakeAiohttpResponse(
+                status=HTTPStatus.CREATED,
+                data={
+                    "oauth_token": self._static_request_token,
+                    "oauth_token_secret": self._static_request_secret,
+                    "oauth_verifier": self._static_verifier,
+                },
+            )
+        else:
+            raise RuntimeError(f"Received unrecognized endpoint {url}")
+
+
 @dataclasses.dataclass
 class _FakeAiohttpResponse:
     status: HTTPStatus = HTTPStatus.OK