updates for birdhouse-deploy 2.4.0

Author: mishaschwartz

marble_client/client.py

@@ -16,8 +16,6 @@
 
 __all__ = ["MarbleClient"]
 
-JUPYTERLAB_ENV_VARIABLES = ("PAVICS_HOST_URL", "JUPYTERHUB_API_URL", "JUPYTERHUB_USER", "JUPYTERHUB_API_TOKEN")
-
 
 def check_jupyterlab(f):
     """
@@ -26,10 +24,15 @@ def check_jupyterlab(f):
 
     This is used as a pre-check for functions that only work in a Marble Jupyterlab
     environment.
+
+    Note that this checks if either the BIRDHOUSE_HOST_URL or PAVICS_HOST_URL are present to support
+    versions of birdhouse-deploy prior to 2.4.0.
     """
     @wraps(f)
     def wrapper(*args, **kwargs):
-        if all(os.getenv(jupyter_var) for jupyter_var in JUPYTERLAB_ENV_VARIABLES):
+        birdhouse_host_var = ("PAVICS_HOST_URL", "BIRDHOUSE_HOST_URL")
+        jupyterhub_env_vars = ("JUPYTERHUB_API_URL", "JUPYTERHUB_USER", "JUPYTERHUB_API_TOKEN")
+        if any(os.getenv(var) for var in birdhouse_host_var) and all(os.getenv(var) for var in jupyterhub_env_vars):
             return f(*args, **kwargs)
         raise JupyterEnvironmentError("Not in a Marble jupyterlab environment")
     return wrapper
@@ -72,7 +75,8 @@ def this_node(self) -> MarbleNode:
 
         Note that this function only works in a Marble Jupyterlab environment.
         """
-        url_string = os.getenv("PAVICS_HOST_URL")
+        # PAVICS_HOST_URL is the deprecated variable used in older versions (<2.4.0) of birdhouse-deploy
+        url_string = os.getenv("BIRDHOUSE_HOST_URL", os.getenv("PAVICS_HOST_URL"))
         host_url = urlparse(url_string)
         for node in self.nodes.values():
             if urlparse(node.url).hostname == host_url.hostname:

pyproject.toml

@@ -36,4 +36,5 @@ line-length = 120
 [tool.pytest.ini_options]
 markers = [
     "load_from_cache: marks tests that should load the registry from a cached version",
+    "jupyterlab_environment: marks tests that test features that are only available in a Marble jupyterlab environment"
 ]

tests/conftest.py

@@ -95,7 +95,7 @@ def first_url(registry_content):
 def jupyterlab_environment(request, monkeypatch, first_url, requests_mock):
     if "jupyterlab_environment" in request.keywords:
         kwargs = request.keywords["jupyterlab_environment"].kwargs
-        monkeypatch.setenv("PAVICS_HOST_URL", kwargs.get("url", first_url))
+        monkeypatch.setenv("BIRDHOUSE_HOST_URL", kwargs.get("url", first_url))
 
         jupyterhub_api_url = kwargs.get("jupyterhub_api_url", "http://jupyterhub.example.com")
         jupyterhub_user = kwargs.get("jupyterhub_user", "example_user")