#354: convert utils/jupysql_init from ipynb to py (#355)

#354: convert utils/jupysql_init from ipynb to py  (#355)

Author: jana-selva

doc/changes/unreleased.md

@@ -1,3 +1,4 @@
 # Unreleased
+    * #354: converted utils/jupysql_init from ipynb to py
 
 ## Summary

exasol/nb_connector/ui/jupysql_init.py

@@ -0,0 +1,25 @@
+# Initializing a JupySQL session
+# This script is not intended to be run independently.
+# It brings in the sql magic and performs common DB initialization steps,
+# including opening the default schema and activating
+# UDF languages at the session level.
+
+from IPython import get_ipython
+
+from exasol.nb_connector.connections import open_sqlalchemy_connection
+from exasol.nb_connector.language_container_activation import get_activation_sql
+
+
+def init_jupysql(ai_lab_config):
+    open_sqlalchemy_connection(ai_lab_config)
+    ipy = get_ipython()
+    if ipy is None:
+        raise RuntimeError(
+            "Not running inside IPython. Magic commands will not execute."
+        )
+    ipy.run_line_magic("load_ext", "sql")
+    ipy.run_line_magic("sql", "engine")
+    ipy.run_line_magic("config", "SqlMagic.short_errors = False")
+    ipy.run_line_magic("sql", f"OPEN SCHEMA {ai_lab_config.db_schema}")
+    activation_sql = get_activation_sql(ai_lab_config)
+    ipy.run_line_magic("sql", activation_sql)

test/integration/ui/test_jupysql_python_integration.py

@@ -0,0 +1,31 @@
+from pathlib import Path
+
+import pytest
+
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
+from exasol.nb_connector.secret_store import Secrets
+from exasol.nb_connector.ui import jupysql_init
+from exasol.nb_connector.ui.jupysql_init import init_jupysql
+
+
+def test_jupysql_python_execution(tmp_path):
+    config_path = tmp_path / "dummy_config_store.sqlite"
+    store_password = "store_password"
+    secrets = Secrets(config_path, master_password=store_password)
+    secrets.save(CKey.db_schema, "SCHEMA")
+    secrets.save(CKey.db_host_name, "localhost")
+    secrets.save(CKey.db_port, "8563")
+    secrets.save(CKey.db_user, "user")
+    secrets.save(CKey.db_password, "password")
+    secrets.save(CKey.storage_backend, "onprem")
+    ai_lab_config = Secrets(Path(config_path), store_password)
+    orig_get_ipython = jupysql_init.get_ipython
+    jupysql_init.get_ipython = lambda: None
+    try:
+        with pytest.raises(
+            RuntimeError,
+            match="Not running inside IPython. Magic commands will not execute.",
+        ):
+            init_jupysql(ai_lab_config)
+    finally:
+        jupysql_init.get_ipython = orig_get_ipython

test/unit/ui/test_jupysql_init_unit.py

@@ -0,0 +1,47 @@
+from unittest.mock import (
+    MagicMock,
+    call,
+    patch,
+)
+
+import pytest
+
+from exasol.nb_connector.ui import jupysql_init
+
+
+def test_init_jupysql_ipython_none():
+    """This test is checking if proper error is coming when IPython is not there, like in normal python only."""
+    with (
+        patch("exasol.nb_connector.ui.jupysql_init.get_ipython", return_value=None),
+        patch("exasol.nb_connector.ui.jupysql_init.open_sqlalchemy_connection"),
+    ):
+        with pytest.raises(
+            RuntimeError,
+            match="Not running inside IPython. Magic commands will not execute.",
+        ):
+            jupysql_init.init_jupysql(MagicMock())
+
+
+def test_init_jupysql_ipython_magics():
+    """This test is checking if all magic commands are running properly when IPython is there, like in notebook."""
+    mock_ipy = MagicMock()
+    with patch(
+        "exasol.nb_connector.ui.jupysql_init.get_ipython", return_value=mock_ipy
+    ):
+        with (
+            patch("exasol.nb_connector.ui.jupysql_init.open_sqlalchemy_connection"),
+            patch(
+                "exasol.nb_connector.ui.jupysql_init.get_activation_sql",
+                return_value="MOCK_SQL",
+            ),
+        ):
+            mock_config = MagicMock()
+            mock_config.db_schema = "MOCK_SCHEMA"
+            jupysql_init.init_jupysql(mock_config)
+            assert mock_ipy.mock_calls == [
+                call.run_line_magic("load_ext", "sql"),
+                call.run_line_magic("sql", "engine"),
+                call.run_line_magic("config", "SqlMagic.short_errors = False"),
+                call.run_line_magic("sql", "OPEN SCHEMA MOCK_SCHEMA"),
+                call.run_line_magic("sql", "MOCK_SQL"),
+            ]