tests: Add tests for multitenancy functions and improve interface

Author: KShivendu

coreDriverInterfaceSupported.json

@@ -1,6 +1,6 @@
 {
   "_comment": "contains a list of core-driver interfaces branch names that this core supports",
   "versions": [
-    "2.21"
+    "3.0"
   ]
-}
+}

supertokens_python/recipe/multitenancy/api/implementation.py

@@ -48,7 +48,7 @@ async def login_methods_get(
         provider_configs_from_core = tenant_config_res.third_party.providers
 
         merged_providers = merge_providers_from_core_and_static(
-            tenant_id, provider_configs_from_core, provider_inputs_from_static
+            provider_configs_from_core, provider_inputs_from_static
         )
 
         final_provider_list: List[ThirdPartyProvider] = []

supertokens_python/recipe/multitenancy/asyncio/__init__.py

@@ -76,7 +76,7 @@ async def list_all_tenants(
 async def create_or_update_third_party_config(
     tenant_id: Optional[str],
     config: ProviderConfig,
-    skip_validation: Optional[bool],
+    skip_validation: Optional[bool] = None,
     user_context: Optional[Dict[str, Any]] = None,
 ) -> CreateOrUpdateThirdPartyConfigOkResult:
     if user_context is None:

supertokens_python/recipe/multitenancy/interfaces.py

@@ -173,13 +173,6 @@ async def delete_third_party_config(
     ) -> DeleteThirdPartyConfigOkResult:
         pass
 
-    # TODO: Should this be removed?
-    @abstractmethod
-    async def list_third_party_configs_for_third_party_id(
-        self, third_party_id: str, user_context: Dict[str, Any]
-    ) -> ListThirdPartyConfigsForThirdPartyIdOkResult:
-        pass
-
     # user tenant association
     @abstractmethod
     async def associate_user_to_tenant(

supertokens_python/recipe/multitenancy/recipe.py

@@ -226,7 +226,7 @@ async def login_methods_get(
         provider_configs_from_core = tenant_config.third_party.providers
 
         merged_providers = merge_providers_from_core_and_static(
-            tenant_id, provider_configs_from_core, provider_inputs_from_static
+            provider_configs_from_core, provider_inputs_from_static
         )
 
         final_provider_list: List[ThirdPartyProvider] = []

supertokens_python/recipe/multitenancy/syncio/__init__.py

@@ -61,7 +61,7 @@ def list_all_tenants(user_context: Optional[Dict[str, Any]] = None):
 def create_or_update_third_party_config(
     tenant_id: Optional[str],
     config: ProviderConfig,
-    skip_validation: Optional[bool],
+    skip_validation: Optional[bool] = None,
     user_context: Optional[Dict[str, Any]] = None,
 ):
     if user_context is None:

tests/multitenancy/test_tenants_crud.py

@@ -0,0 +1,183 @@
+# Copyright (c) 2023, VRAI Labs and/or its affiliates. All rights reserved.
+#
+# This software is licensed under the Apache License, Version 2.0 (the
+# "License") as published by the Apache Software Foundation.
+#
+# You may not use this file except in compliance with the License. You may
+# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+from fastapi import FastAPI
+from pytest import mark, fixture
+from starlette.testclient import TestClient
+
+from supertokens_python import init
+from supertokens_python.framework.fastapi import get_middleware
+from supertokens_python.recipe import emailpassword, multitenancy, session
+from tests.utils import setup_function, teardown_function, get_st_init_args, start_st
+
+_ = setup_function
+_ = teardown_function
+
+pytestmark = mark.asyncio
+
+from supertokens_python.recipe.multitenancy.asyncio import (
+    create_or_update_tenant,
+    list_all_tenants,
+    get_tenant,
+    delete_tenant,
+    create_or_update_third_party_config,
+    delete_third_party_config,
+    associate_user_to_tenant,
+    dissociate_user_from_tenant,
+)
+from supertokens_python.recipe.emailpassword.asyncio import sign_up, get_user_by_id
+from supertokens_python.recipe.emailpassword.interfaces import SignUpOkResult
+from supertokens_python.recipe.multitenancy.interfaces import TenantConfig
+from supertokens_python.recipe.thirdparty.provider import (
+    ProviderConfig,
+    ProviderClientConfig,
+)
+
+
+@fixture(scope="function")
+async def client():
+    app = FastAPI()
+    app.add_middleware(get_middleware())
+
+    return TestClient(app)
+
+
+async def test_tenant_crud():
+    args = get_st_init_args([multitenancy.init()])
+    init(**args)
+    start_st()
+
+    await create_or_update_tenant("t1", TenantConfig(email_password_enabled=True))
+    await create_or_update_tenant("t2", TenantConfig(passwordless_enabled=True))
+    await create_or_update_tenant("t3", TenantConfig(third_party_enabled=True))
+
+    tenants = await list_all_tenants()
+    assert len(tenants.tenants) == 4
+
+    t1_config = await get_tenant("t1")
+    assert t1_config.email_password.enabled is True
+    assert t1_config.passwordless.enabled is False
+    assert t1_config.third_party.enabled is False
+    assert t1_config.core_config == {}
+
+    t2_config = await get_tenant("t2")
+    assert t2_config.email_password.enabled is False
+    assert t2_config.passwordless.enabled is True
+    assert t2_config.third_party.enabled is False
+    assert t2_config.core_config == {}
+
+    t3_config = await get_tenant("t3")
+    assert t3_config.email_password.enabled is False
+    assert t3_config.passwordless.enabled is False
+    assert t3_config.third_party.enabled is True
+    assert t3_config.core_config == {}
+
+    # update tenant1 to add passwordless:
+    await create_or_update_tenant("t1", TenantConfig(passwordless_enabled=True))
+    t1_config = await get_tenant("t1")
+    assert t1_config.email_password.enabled is True
+    assert t1_config.passwordless.enabled is True
+    assert t1_config.third_party.enabled is False
+    assert t1_config.core_config == {}
+
+    # update tenant1 to add thirdparty:
+    await create_or_update_tenant("t1", TenantConfig(third_party_enabled=True))
+    t1_config = await get_tenant("t1")
+    assert t1_config.email_password.enabled is True
+    assert t1_config.passwordless.enabled is True
+    assert t1_config.third_party.enabled is True
+    assert t1_config.core_config == {}
+
+    # delete tenant2:
+    await delete_tenant("t2")
+    tenants = await list_all_tenants()
+    assert len(tenants.tenants) == 2
+    assert "t2" not in tenants.tenants
+
+
+async def test_tenant_thirdparty_config():
+    args = get_st_init_args([multitenancy.init()])
+    init(**args)
+    start_st()
+
+    await create_or_update_tenant("t1", TenantConfig(email_password_enabled=True))
+    await create_or_update_third_party_config(
+        "t1",
+        config=ProviderConfig(
+            third_party_id="google",
+            name="Google",
+            clients=[ProviderClientConfig(client_id="abcd")],
+        ),
+    )
+
+    tenant_config = await get_tenant("t1")
+
+    assert len(tenant_config.third_party.providers) == 1
+    assert tenant_config.third_party.providers[0].third_party_id == "google"
+    assert tenant_config.third_party.providers[0].clients is not None
+    assert len(tenant_config.third_party.providers[0].clients) == 1
+    assert tenant_config.third_party.providers[0].clients[0] == "abcd"
+
+    # update thirdparty config
+    await create_or_update_third_party_config(
+        "t1",
+        ProviderConfig(
+            third_party_id="google",
+            name="Custom name",
+            clients=[ProviderClientConfig(client_id="efgh")],
+        ),
+    )
+
+    tenant_config = await get_tenant("t1")
+    assert len(tenant_config.third_party.providers) == 1
+    assert tenant_config.third_party.providers[0].third_party_id == "google"
+    assert tenant_config.third_party.providers[0].name == "Custom name"
+    assert tenant_config.third_party.providers[0].clients is not None
+    assert len(tenant_config.third_party.providers[0].clients) == 1
+    assert tenant_config.third_party.providers[0].clients[0] == "efgh"
+
+    # delete thirdparty config
+    await delete_third_party_config("t1", "google")
+
+    tenant_config = await get_tenant("t1")
+    assert len(tenant_config.third_party.providers) == 0
+
+
+async def test_user_association_and_disassociation_with_tenants():
+    args = get_st_init_args([session.init(), emailpassword.init(), multitenancy.init()])
+    init(**args)
+    start_st()
+
+    await create_or_update_tenant("t1", TenantConfig(email_password_enabled=True))
+    await create_or_update_tenant("t2", TenantConfig(passwordless_enabled=True))
+    await create_or_update_tenant("t3", TenantConfig(third_party_enabled=True))
+
+    signup_response = await sign_up("[email protected]", "password1")
+    assert isinstance(signup_response, SignUpOkResult)
+    user_id = signup_response.user.user_id
+
+    await associate_user_to_tenant("t1", user_id)
+    await associate_user_to_tenant("t2", user_id)
+    await associate_user_to_tenant("t3", user_id)
+
+    user = await get_user_by_id(user_id)
+    assert user is not None
+    assert len(user.tenant_ids) == 4  # public + 3 tenants
+
+    await dissociate_user_from_tenant("t1", user_id)
+    await dissociate_user_from_tenant("t2", user_id)
+    await dissociate_user_from_tenant("t3", user_id)
+
+    user = await get_user_by_id(user_id)
+    assert user is not None
+    assert len(user.tenant_ids) == 1  # public only