Add team parameter support to the authorize URL generators (#1345)

Author: seratch

integration_tests/web/test_issue_594.py

@@ -76,7 +76,9 @@ def test_no_preview_image(self):
             external_id=external_id,
             external_url=external_url,
             title="Slack (Wikipedia)",
-            indexable_file_contents="Slack is a proprietary business communication platform developed by Slack Technologies.".encode("utf-8"),
+            indexable_file_contents="Slack is a proprietary business communication platform developed by Slack Technologies.".encode(
+                "utf-8"
+            ),
         )
         self.assertIsNotNone(creation)
 

slack_sdk/oauth/authorize_url_generator/__init__.py

@@ -17,7 +17,7 @@ def __init__(
         self.user_scopes = user_scopes
         self.authorization_url = authorization_url
 
-    def generate(self, state: str) -> str:
+    def generate(self, state: str, team: Optional[str] = None) -> str:
         scopes = ",".join(self.scopes) if self.scopes else ""
         user_scopes = ",".join(self.user_scopes) if self.user_scopes else ""
         url = (
@@ -29,6 +29,8 @@ def generate(self, state: str) -> str:
         )
         if self.redirect_uri is not None:
             url += f"&redirect_uri={self.redirect_uri}"
+        if team is not None:
+            url += f"&team={team}"
         return url
 
 
@@ -48,7 +50,7 @@ def __init__(
         self.scopes = scopes
         self.authorization_url = authorization_url
 
-    def generate(self, state: str, nonce: Optional[str] = None) -> str:
+    def generate(self, state: str, nonce: Optional[str] = None, team: Optional[str] = None) -> str:
         scopes = ",".join(self.scopes) if self.scopes else ""
         url = (
             f"{self.authorization_url}?"
@@ -58,6 +60,8 @@ def generate(self, state: str, nonce: Optional[str] = None) -> str:
             f"scope={scopes}&"
             f"redirect_uri={self.redirect_uri}"
         )
+        if team is not None:
+            url += f"&team={team}"
         if nonce is not None:
             url += f"&nonce={nonce}"
         return url

tests/slack_sdk/oauth/authorize_url_generator/test_generator.py

@@ -1,6 +1,6 @@
 import unittest
 
-from slack_sdk.oauth import AuthorizeUrlGenerator
+from slack_sdk.oauth import AuthorizeUrlGenerator, OpenIDConnectAuthorizeUrlGenerator
 
 
 class TestGenerator(unittest.TestCase):
@@ -28,5 +28,45 @@ def test_base_url(self):
             authorization_url="https://www.example.com/authorize",
         )
         url = generator.generate("state-value")
-        expected = "https://www.example.com/authorize?state=state-value&client_id=111.222&scope=chat:write,commands&user_scope=search:read"
+        expected = (
+            "https://www.example.com/authorize"
+            "?state=state-value"
+            "&client_id=111.222"
+            "&scope=chat:write,commands"
+            "&user_scope=search:read"
+        )
+        self.assertEqual(expected, url)
+
+    def test_team(self):
+        generator = AuthorizeUrlGenerator(
+            client_id="111.222",
+            scopes=["chat:write", "commands"],
+            user_scopes=["search:read"],
+        )
+        url = generator.generate(state="state-value", team="T12345")
+        expected = (
+            "https://slack.com/oauth/v2/authorize"
+            "?state=state-value"
+            "&client_id=111.222"
+            "&scope=chat:write,commands&user_scope=search:read"
+            "&team=T12345"
+        )
+        self.assertEqual(expected, url)
+
+    def test_openid_connect(self):
+        generator = OpenIDConnectAuthorizeUrlGenerator(
+            client_id="111.222",
+            redirect_uri="https://www.example.com/oidc/callback",
+            scopes=["openid"],
+        )
+        url = generator.generate(state="state-value", nonce="nnn", team="T12345")
+        expected = (
+            "https://slack.com/openid/connect/authorize"
+            "?response_type=code&state=state-value"
+            "&client_id=111.222"
+            "&scope=openid"
+            "&redirect_uri=https://www.example.com/oidc/callback"
+            "&team=T12345"
+            "&nonce=nnn"
+        )
         self.assertEqual(expected, url)