Test new features (#68)

* Test seam client with api_key

* Update test/seam/test_api_key.py

Co-authored-by: Evan Sosenko <evan@getseam.com>

* Update test_api_key.py

* Add PAT test

* Update test fn name

* Replace relative imports with absolute ones in tests

* Add test_env.py

* ci: Format code

* Add server fixture to get test endpoint and seed

* Use endpoint and seed from new server test fixture

* ci: Format code

* Fix access token key used to access the seeded value

---------

Co-authored-by: Evan Sosenko <evan@getseam.com>
Co-authored-by: Seam Bot <devops@getseam.com>

Author: 3 people

package-lock.json

@@ -9,7 +9,7 @@
     "start": "fake-seam-connect --seed"
   },
   "devDependencies": {
-    "@seamapi/fake-seam-connect": "1.65.5",
+    "@seamapi/fake-seam-connect": "1.66.0",
     "@seamapi/nextlove-sdk-generator": "1.13.1",
     "@seamapi/types": "1.178.0",
     "del": "^7.1.0",

package.json

@@ -1,10 +1,35 @@
 import socket
+from urllib.parse import urljoin
 import pytest
 import subprocess
 import time
 import os
-from seam import Seam
 from contextlib import contextmanager
+import niquests as requests
+from seam import Seam
+
+
+@pytest.fixture(scope="function")
+def server():
+    port = get_port()
+    os.environ["PORT"] = str(port)
+
+    with subprocess_popen(["npm", "run", "start"]):
+        # Allow some time for the server to start
+        time.sleep(0.5)
+
+        endpoint = f"http://localhost:{port}"
+        seed = get_seed(endpoint)
+
+        yield endpoint, seed
+
+
+@pytest.fixture(scope="function")
+def seam(server):
+    endpoint, seed = server
+    seam = Seam(endpoint=endpoint, api_key=seed["seam_apikey1_token"])
+
+    yield seam
 
 
 def get_port():
@@ -27,21 +52,6 @@ def subprocess_popen(*args):
             process.kill()
 
 
-@pytest.fixture(scope="function")
-def fake_seam_connect_server():
-    port = get_port()
-    os.environ["PORT"] = str(port)
-
-    with subprocess_popen(["npm", "run", "start"]):
-        # Allow some time for the server to start
-        time.sleep(0.5)
-
-        endpoint = f"http://localhost:{port}"
-
-        yield endpoint
-
-
-@pytest.fixture(scope="function")
-def seam(fake_seam_connect_server):
-    seam = Seam(endpoint=fake_seam_connect_server, api_key="seam_apikey1_token")
-    yield seam
+def get_seed(endpoint):
+    seed_url = urljoin(endpoint, "/_fake/default_seed")
+    return requests.get(seed_url).json()

test/conftest.py

@@ -0,0 +1,47 @@
+import pytest
+from seam import Seam
+from seam.auth import SeamHttpInvalidTokenError
+
+
+def test_seam_client_from_api_key_returns_instance_authorized_with_api_key(
+    server,
+):
+    endpoint, seed = server
+    seam = Seam.from_api_key(seed["seam_apikey1_token"], endpoint=endpoint)
+    devices = seam.devices.list()
+
+    assert len(devices) > 0
+
+
+def test_seam_client_constructor_returns_instance_authorized_with_api_key(
+    server,
+):
+    endpoint, seed = server
+    seam = Seam(api_key=seed["seam_apikey1_token"], endpoint=endpoint)
+    devices = seam.devices.list()
+
+    assert len(devices) > 0
+
+
+def test_seam_client_constructor_interprets_single_string_argument_as_api_key(server):
+    _, seed = server
+    seam = Seam(seed["seam_apikey1_token"])
+
+    assert seam is not None
+
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"api_key"):
+        Seam(api_key="some-invalid-key-format")
+
+
+def test_seam_client_checks_api_key_format():
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"Unknown"):
+        Seam.from_api_key("some-invalid-key-format")
+
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"JWT"):
+        Seam.from_api_key("ey")
+
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"Client Session Token"):
+        Seam.from_api_key("seam_cst_token")
+
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"Access Token"):
+        Seam.from_api_key("seam_at")

test/seam/test_api_key.py

@@ -0,0 +1,105 @@
+import os
+import pytest
+from seam import Seam
+from seam.options import SeamHttpInvalidOptionsError
+
+
+# Cleanup environment variables before and after each test
+def cleanup_env():
+    os.environ.pop("SEAM_API_KEY", None)
+    os.environ.pop("SEAM_ENDPOINT", None)
+    os.environ.pop("SEAM_API_URL", None)
+
+
+@pytest.fixture(autouse=True)
+def run_around_tests():
+    cleanup_env()
+    yield
+    cleanup_env()
+
+
+def test_seam_client_constructor_uses_seam_api_key_env_variable(server):
+    endpoint, seed = server
+    os.environ["SEAM_API_KEY"] = seed["seam_apikey1_token"]
+    seam = Seam(endpoint=endpoint)
+
+    devices = seam.devices.list()
+    assert len(devices) > 0
+
+
+def test_seam_client_api_key_option_overrides_env_variables(server):
+    endpoint, seed = server
+    os.environ["SEAM_API_KEY"] = "some-invalid-api-key-1"
+    seam = Seam(api_key=seed["seam_apikey1_token"], endpoint=endpoint)
+
+    devices = seam.devices.list()
+    assert len(devices) > 0
+
+
+def test_seam_client_api_key_option_as_first_argument_overrides_env_variables():
+    os.environ["SEAM_API_KEY"] = "some-invalid-api-key-2"
+    seam = Seam("seam_apikey_token")
+    assert seam is not None
+
+
+def test_seam_client_constructor_requires_seam_api_key_when_passed_no_argument():
+    with pytest.raises(SeamHttpInvalidOptionsError, match=r"api_key"):
+        Seam()
+
+
+def test_seam_client_seam_endpoint_env_variable_is_used_first(server):
+    endpoint, seed = server
+    os.environ["SEAM_API_URL"] = "https://example.com"
+    os.environ["SEAM_ENDPOINT"] = endpoint
+    seam = Seam(api_key=seed["seam_apikey1_token"])
+
+    devices = seam.devices.list()
+    assert len(devices) > 0
+
+
+def test_seam_client_seam_api_url_env_variable_is_used_as_fallback(server):
+    endpoint, seed = server
+    os.environ["SEAM_API_URL"] = endpoint
+    seam = Seam(api_key=seed["seam_apikey1_token"])
+
+    devices = seam.devices.list()
+    assert len(devices) > 0
+
+
+def test_seam_client_endpoint_option_overrides_env_variables(server):
+    endpoint, seed = server
+    os.environ["SEAM_API_URL"] = "https://example.com"
+    os.environ["SEAM_ENDPOINT"] = "https://example.com"
+    seam = Seam(api_key=seed["seam_apikey1_token"], endpoint=endpoint)
+
+    devices = seam.devices.list()
+    assert len(devices) > 0
+
+
+def test_seam_client_seam_endpoint_env_variable_is_used_with_from_api_key(
+    server,
+):
+    endpoint, seed = server
+    os.environ["SEAM_API_URL"] = "https://example.com"
+    os.environ["SEAM_ENDPOINT"] = endpoint
+    seam = Seam.from_api_key(seed["seam_apikey1_token"])
+
+    devices = seam.devices.list()
+    assert len(devices) > 0
+
+
+@pytest.mark.xfail(reason="Fake does not support personal access token.")
+def test_seam_client_seam_api_key_env_variable_is_ignored_with_personal_access_token(
+    server,
+):
+    endpoint, seed = server
+    os.environ["SEAM_API_KEY"] = seed["seam_apikey1_token"]
+
+    seam = Seam.from_personal_access_token(
+        seed["seam_at1_token"],
+        seed["seed_workspace_1"],
+        endpoint=endpoint,
+    )
+
+    devices = seam.devices.list()
+    assert len(devices) > 0

test/seam/test_env.py

@@ -0,0 +1,34 @@
+import pytest
+from seam import Seam
+from seam.auth import SeamHttpInvalidTokenError
+from seam.seam_multi_workspace import SeamMultiWorkspace
+
+
+def test_seam_client_checks_personal_access_token_format():
+    workspace_id = "e4203e37-e569-4a5a-bfb7-e3e8de66161d"
+
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"Unknown"):
+        Seam.from_personal_access_token("some-invalid-key-format", workspace_id)
+
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"Unknown"):
+        Seam.from_personal_access_token("seam_apikey_token", workspace_id)
+
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"Client Session Token"):
+        Seam.from_personal_access_token("seam_cst", workspace_id)
+
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"JWT"):
+        Seam.from_personal_access_token("ey", workspace_id)
+
+
+def test_seam_multi_workspace_client_checks_personal_access_token_format():
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"Unknown"):
+        SeamMultiWorkspace.from_personal_access_token("some-invalid-key-format")
+
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"Unknown"):
+        SeamMultiWorkspace.from_personal_access_token("seam_apikey_token")
+
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"Client Session Token"):
+        SeamMultiWorkspace.from_personal_access_token("seam_cst")
+
+    with pytest.raises(SeamHttpInvalidTokenError, match=r"JWT"):
+        SeamMultiWorkspace.from_personal_access_token("ey")

test/test_init_seam.py test/seam/test_init_seam.pytest/test_init_seam.py renamed to test/seam/test_init_seam.py

@@ -1,13 +1,11 @@
-import random
-import string
-from seam import Seam, SeamMultiWorkspace
+from seam import SeamMultiWorkspace
 
 
-def test_workspaces_create(seam: Seam):
-    r = "".join(random.choices(string.ascii_uppercase + string.digits, k=10))
+def test_workspaces_create(server):
+    endpoint, seed = server
     seam = SeamMultiWorkspace(
-        endpoint=f"https://{r}.fakeseamconnect.seam.vc",
-        personal_access_token="seam_at1_shorttoken_longtoken",
+        endpoint=endpoint,
+        personal_access_token=seed["seam_at1_token"],
     )
 
     workspace = seam.workspaces.create(