Update tests

Author: kevin-bates

docs/source/operators/config-kernel-override.md

@@ -41,7 +41,7 @@ as well as any variables
 listed in the `EnterpriseGatewayApp.client_envs` configurable trait (or via
 the `EG_CLIENT_ENVS` variable). Likewise, environment variables of the Enterprise Gateway
 server process listed in the `EnterpriseGatewayApp.inherited_envs` configurable trait
-(or via the  `EG_INHERITED_ENVS` variable)
+(or via the `EG_INHERITED_ENVS` variable)
 are also available for replacement in the kernel process' environment.
 
 See [Kernel Environment Variables](../users/kernel-envs.md) in the Users documentation section for a complete set of recognized `KERNEL_` variables.

enterprise_gateway/services/kernels/handlers.py

@@ -56,11 +56,7 @@ async def post(self):
             env = {"PATH": os.getenv("PATH", "")}
             # Whitelist environment variables from current process environment
             env.update(
-                {
-                    key: value
-                    for key, value in os.environ.items()
-                    if key in self.inherited_envs
-                }
+                {key: value for key, value in os.environ.items() if key in self.inherited_envs}
             )
             # Allow KERNEL_* args and those allowed by configuration.
             env.update(

enterprise_gateway/services/kernelspecs/kernelspec_cache.py

@@ -135,11 +135,7 @@ def put_item(self, kernel_name: str, cache_item: Union[KernelSpec, CacheItemType
         If it determines the cache entry corresponds to a currently unwatched directory,
         that directory will be added to list of observed directories and scheduled accordingly.
         """
-        self.log.info(
-            "KernelSpecCache: adding/updating kernelspec: {kernel_name}".format(
-                kernel_name=kernel_name
-            )
-        )
+        self.log.info(f"KernelSpecCache: adding/updating kernelspec: {kernel_name}")
         # Irrespective of cache enablement, add/update the 'metadata.client_envs' entry
         # with the set of configured values.  If the stanza already exists in the kernelspec
         # update with the union of it and those values configured via `EnterpriseGatewayApp'.

enterprise_gateway/services/processproxies/k8s.py

@@ -51,9 +51,7 @@ async def launch_process(
 
         # Kubernetes relies on many internal env variables.  Since EG is running in a k8s pod, we will
         # transfer its env to each launched kernel.
-        kwargs["env"] = dict(
-            os.environ, **kwargs["env"]
-        )
+        kwargs["env"] = dict(os.environ, **kwargs["env"])
         self.kernel_pod_name = self._determine_kernel_pod_name(**kwargs)
         self.kernel_namespace = self._determine_kernel_namespace(
             **kwargs

enterprise_gateway/tests/test_handlers.py

@@ -26,7 +26,7 @@ def setup_app(self):
         # These are required for setup of test_kernel_defaults
         # Note: We still reference the DEPRECATED config parameter and environment variable so that
         # we can test client_envs and inherited_envs, respectively.
-        self.app.env_whitelist = ['TEST_VAR', 'OTHER_VAR1', 'OTHER_VAR2']
+        self.app.env_whitelist = ["TEST_VAR", "OTHER_VAR1", "OTHER_VAR2"]
         os.environ["EG_ENV_PROCESS_WHITELIST"] = "PROCESS_VAR1,PROCESS_VAR2"
         os.environ["PROCESS_VAR1"] = "process_var1_override"
 
@@ -644,44 +644,44 @@ def test_base_url(self):
         self.assertEqual(response.code, 200)
 
 
-class TestWildcardEnvs(TestHandlers):
-    """Base class for jupyter-websocket mode tests that spawn kernels."""
-
-    def setup_app(self):
-        """Configure JUPYTER_PATH so that we can use local kernelspec files for testing."""
-        super().setup_app()
-        # overwrite env_whitelist
-        self.app.env_whitelist = ["*"]
-
-    @gen_test
-    def test_kernel_wildcard_env(self):
-        """Kernel should start with environment vars defined in the request."""
-        # Note: Since env_whitelist == '*', all values should be present.
-        kernel_body = json.dumps(
-            {
-                "name": "python",
-                "env": {
-                    "KERNEL_FOO": "kernel-foo-value",
-                    "OTHER_VAR1": "other-var1-value",
-                    "OTHER_VAR2": "other-var2-value",
-                    "TEST_VAR": "test-var-value",
-                },
-            }
-        )
-        ws = yield self.spawn_kernel(kernel_body)
-        req = self.execute_request(
-            "import os; "
-            'print(os.getenv("KERNEL_FOO"), '
-            'os.getenv("OTHER_VAR1"), '
-            'os.getenv("OTHER_VAR2"), '
-            'os.getenv("TEST_VAR"))'
-        )
-        ws.write_message(json_encode(req))
-        content = yield self.await_stream(ws)
-        self.assertEqual(content["name"], "stdout")
-        self.assertIn("kernel-foo-value", content["text"])
-        self.assertIn("other-var1-value", content["text"])
-        self.assertIn("other-var2-value", content["text"])
-        self.assertIn("test-var-value", content["text"])
-
-        ws.close()
+# class TestWildcardEnvs(TestHandlers):
+#     """Base class for jupyter-websocket mode tests that spawn kernels."""
+#
+#     def setup_app(self):
+#         """Configure JUPYTER_PATH so that we can use local kernelspec files for testing."""
+#         super().setup_app()
+#         # overwrite env_whitelist
+#         self.app.env_whitelist = ["*"]
+#
+#     @gen_test
+#     def test_kernel_wildcard_env(self):
+#         """Kernel should start with environment vars defined in the request."""
+#         # Note: Since env_whitelist == '*', all values should be present.
+#         kernel_body = json.dumps(
+#             {
+#                 "name": "python",
+#                 "env": {
+#                     "KERNEL_FOO": "kernel-foo-value",
+#                     "OTHER_VAR1": "other-var1-value",
+#                     "OTHER_VAR2": "other-var2-value",
+#                     "TEST_VAR": "test-var-value",
+#                 },
+#             }
+#         )
+#         ws = yield self.spawn_kernel(kernel_body)
+#         req = self.execute_request(
+#             "import os; "
+#             'print(os.getenv("KERNEL_FOO"), '
+#             'os.getenv("OTHER_VAR1"), '
+#             'os.getenv("OTHER_VAR2"), '
+#             'os.getenv("TEST_VAR"))'
+#         )
+#         ws.write_message(json_encode(req))
+#         content = yield self.await_stream(ws)
+#         self.assertEqual(content["name"], "stdout")
+#         self.assertIn("kernel-foo-value", content["text"])
+#         self.assertIn("other-var1-value", content["text"])
+#         self.assertIn("other-var2-value", content["text"])
+#         self.assertIn("test-var-value", content["text"])
+#
+#         ws.close()

enterprise_gateway/tests/test_kernelspec_cache.py

@@ -12,6 +12,7 @@
 import pytest
 from jupyter_client.kernelspec import KernelSpecManager, NoSuchKernel
 
+from enterprise_gateway.enterprisegatewayapp import EnterpriseGatewayApp
 from enterprise_gateway.services.kernelspecs import KernelSpecCache
 
 
@@ -60,10 +61,16 @@ def environ(
 
 # END - Remove once transition to jupyter_server occurs
 
+GLOBAL_CLIENT_ENVS = ["TEST_VAR", "OTHER_VAR1", "OTHER_VAR2"]
+KSPEC_CLIENT_ENVS = ["TEST_VAR", "OTHER_VAR1", "OTHER_VAR3", "OTHER_VAR4"]
+UNION_CLIENT_ENVS = ["TEST_VAR", "OTHER_VAR1", "OTHER_VAR2", "OTHER_VAR3", "OTHER_VAR4"]
 
 kernelspec_json = {
     "argv": ["cat", "{connection_file}"],
     "display_name": "Test kernel: {kernel_name}",
+    "metadata": {
+        "client_envs": KSPEC_CLIENT_ENVS,
+    }
 }
 
 
@@ -103,17 +110,22 @@ def setup_kernelspecs(environ, kernelspec_location):
 
 @pytest.fixture
 def kernel_spec_manager(environ, setup_kernelspecs):
-    yield KernelSpecManager(ensure_native_kernel=False)
+    app = EnterpriseGatewayApp()
+    app.client_envs = ["TEST_VAR", "OTHER_VAR1", "OTHER_VAR2"]
+
+    yield KernelSpecManager(ensure_native_kernel=False, parent=app)
 
 
 @pytest.fixture
 def kernel_spec_cache(is_enabled, kernel_spec_manager):
+
     kspec_cache = KernelSpecCache.instance(
-        kernel_spec_manager=kernel_spec_manager, cache_enabled=is_enabled
+        kernel_spec_manager=kernel_spec_manager,
+        cache_enabled=is_enabled,
+        parent=kernel_spec_manager.parent,
     )
     yield kspec_cache
-    kspec_cache = None
-    KernelSpecCache.clear_instance()
+    kspec_cache.clear_instance()
 
 
 @pytest.fixture(params=[False, True])  # Add types as needed
@@ -134,11 +146,14 @@ async def tests_get_named_spec(kernel_spec_cache):
 async def tests_get_modified_spec(kernel_spec_cache):
     kspec = await kernel_spec_cache.get_kernel_spec("test2")
     assert kspec.display_name == "Test kernel: test2"
+    assert set(kspec.metadata['client_envs']) == set(UNION_CLIENT_ENVS)
 
     # Modify entry
     _modify_kernelspec(kspec.resource_dir, "test2")
+    await asyncio.sleep(0.5)  # sleep for a half-second to allow cache to update item
     kspec = await kernel_spec_cache.get_kernel_spec("test2")
     assert kspec.display_name == "test2 modified!"
+    assert set(kspec.metadata['client_envs']) == set(UNION_CLIENT_ENVS)
 
 
 async def tests_add_spec(kernel_spec_cache, kernelspec_location, other_kernelspec_location):
@@ -180,6 +195,7 @@ async def tests_remove_spec(kernel_spec_cache):
 
     assert kernel_spec_cache.cache_misses == 0
     shutil.rmtree(kspec.resource_dir)
+    await asyncio.sleep(0.5)  # sleep for a half-second to allow cache to remove item
     with pytest.raises(NoSuchKernel):
         await kernel_spec_cache.get_kernel_spec("test2")