#294: ScriptLanguageContainer.deploy misses https configuration (#302)

fixes #294

Author: tomuben

.github/workflows/tests-ordinary-integration.yml

@@ -36,6 +36,8 @@ jobs:
             extra_param: "--package-manager conda --compression-strategy gzip"
           - file: itest_slc.py
             extra_param: "--package-manager pip --compression-strategy none"
+          - file: itest_slc.py
+            extra_param: "--package-manager pip --compression-strategy none --bucketfs-protocol https"
 
     steps:
 

doc/changes/unreleased.md

@@ -4,6 +4,10 @@
 
 This release updates dependencies enabling PyExasol versions ≥ 1.0.
 
+## Bugs
+
+ *  #294: ScriptLanguageContainer.deploy misses https configuration
+
 ## Documentation
 
 * #287: working examples for functional UI

exasol/nb_connector/slc/script_language_container.py

@@ -5,6 +5,7 @@
 from pathlib import (
     Path,
 )
+from typing import Any
 
 import requests
 from exasol.slc import api as exaslct_api
@@ -25,6 +26,7 @@
     Workspace,
     current_directory,
 )
+from exasol.nb_connector.utils import optional_str_to_bool
 
 PipPackageDefinition = namedtuple("PipPackageDefinition", ["pkg", "version"])
 CondaPackageDefinition = namedtuple("CondaPackageDefinition", ["pkg", "version"])
@@ -193,7 +195,7 @@ def deploy(self):
         Deploys the current script-languages-container to the database and
         stores the activation string in the Secure Configuration Storage.
         """
-        bfs_params = {
+        bfs_params: dict[str, Any] = {
             k: self.secrets.get(v)
             for k, v in [
                 ("bucketfs_host", CKey.bfs_host_name),
@@ -204,6 +206,15 @@ def deploy(self):
                 ("bucket", CKey.bfs_bucket),
             ]
         }
+        bucketfs_use_https = optional_str_to_bool(self.secrets.get(CKey.bfs_encryption))
+        if bucketfs_use_https is not None:
+            bfs_params["bucketfs_use_https"] = bucketfs_use_https
+        use_ssl_cert_validation = optional_str_to_bool(self.secrets.get(CKey.cert_vld))
+        if use_ssl_cert_validation is not None:
+            bfs_params["use_ssl_cert_validation"] = use_ssl_cert_validation
+        ssl_cert_path = self.secrets.get(CKey.trusted_ca)
+        if ssl_cert_path is not None:
+            bfs_params["ssl_cert_path"] = ssl_cert_path
 
         with current_directory(self.checkout_dir):
             result = exaslct_api.deploy(

poetry.lock

@@ -28,7 +28,7 @@ sqlalchemy = [ "sqlalchemy-exasol (>=5.0.0, <6)" ]
 pyexasol = [ "pyexasol (>=0.26.0, <2)" ]
 bucketfs = [ "exasol-bucketfs (>=1.0.1, <3)" ]
 docker-db = [
-  "exasol-integration-test-docker-environment (>=4, <5)",
+  "exasol-integration-test-docker-environment (>=4.4.1, <5)",
   "ifaddr (>=0.2.0, <0.3)",
 ]
 # The version of SLCT is dictated by its usage in the python-extension-common,

pyproject.toml

@@ -0,0 +1,14 @@
+import enum
+
+
+class BucketFSProtocol(enum.Enum):
+    """
+    Supported protocols for BucketFS.
+    """
+
+    HTTP = "http"
+    HTTPS = "https"
+
+    def __str__(self):
+        # this allows using `choices` in argparse
+        return self.value

test/bucketfs_protocol.py

@@ -1,4 +1,5 @@
 from collections.abc import Iterator
+from test.bucketfs_protocol import BucketFSProtocol
 from test.package_manager import PackageManager
 from test.utils.integration_test_utils import sample_db_file
 
@@ -39,6 +40,15 @@ def pytest_addoption(parser):
         help="Compression Strategy to use",
     )
 
+    parser.addoption(
+        "--bucketfs-protocol",
+        action="store",
+        type=BucketFSProtocol,
+        choices=list(BucketFSProtocol),
+        default="https",
+        help="BucketFS Protocol to use for SLC tests",
+    )
+
 
 @pytest.fixture(scope="session")
 def package_manager(request) -> PackageManager:
@@ -50,3 +60,9 @@ def package_manager(request) -> PackageManager:
 def compression_strategy(request) -> CompressionStrategy:
     val = request.config.getoption("--compression-strategy")
     return CompressionStrategy(val)
+
+
+@pytest.fixture(scope="session")
+def bucketfs_protocol(request) -> BucketFSProtocol:
+    val = request.config.getoption("--bucketfs-protocol")
+    return BucketFSProtocol(val)

test/conftest.py

@@ -3,14 +3,19 @@
 from collections.abc import Iterator
 from pathlib import Path
 from tempfile import TemporaryDirectory
+from test.bucketfs_protocol import BucketFSProtocol
 from test.package_manager import PackageManager
 from test.utils.integration_test_utils import setup_itde_module
 
 import pytest
 from docker.models.images import Image as DockerImage
 from exasol.slc.models.compression_strategy import CompressionStrategy
 from exasol_integration_test_docker_environment.lib.docker import ContextDockerClient
+from exasol_integration_test_docker_environment.lib.models.api_errors import (
+    TaskRuntimeError,
+)
 
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
 from exasol.nb_connector.language_container_activation import (
     open_pyexasol_connection_with_lang_definitions,
 )
@@ -154,7 +159,30 @@ def expected_activation_key(slc: ScriptLanguageContainer) -> str:
     )
 
 
-@pytest.mark.dependency(name="deploy_slc")
+@pytest.fixture(scope="module")
+def configure_bucketfs_protocol(bucketfs_protocol, secrets_module: Secrets):
+    if bucketfs_protocol == BucketFSProtocol.HTTPS:
+        secrets_module.save(CKey.bfs_encryption, "True")
+        secrets_module.save(CKey.cert_vld, "False")
+        secrets_module.save(CKey.bfs_port, "2581")
+
+
+@pytest.mark.dependency(name="deploy_cert_fails")
+def test_deploy_cert_fails(
+    sample_slc: ScriptLanguageContainer,
+    setup_itde_module,
+    secrets_module,
+    bucketfs_protocol,
+    configure_bucketfs_protocol,
+):
+    if bucketfs_protocol == BucketFSProtocol.HTTPS:
+        secrets_module.save(CKey.cert_vld, "True")
+        with pytest.raises(TaskRuntimeError):
+            sample_slc.deploy()
+        secrets_module.save(CKey.cert_vld, "False")
+
+
+@pytest.mark.dependency(name="deploy_slc", depends=["deploy_cert_fails"])
 def test_deploy(sample_slc: ScriptLanguageContainer, setup_itde_module):
     sample_slc.deploy()
     assert sample_slc.activation_key == expected_activation_key(sample_slc)