#186: Refactoring/186 integration tests for correctness of udf path generation #186 (#239)

Integration test for udf path correctness

Author: jana-selva

.github/workflows/slow-checks.yml

@@ -28,7 +28,7 @@ jobs:
           SAAS_HOST: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_HOST }}
           SAAS_ACCOUNT_ID: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_ACCOUNT_ID }}
           SAAS_PAT: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_PAT }}
-        run: poetry run -- pytest --backend=all test/integration
+        run: poetry run -- pytest --backend=onprem test/integration
 
 #      - name: Upload Artifacts
 #        uses: actions/upload-artifact@v4.6.2

doc/changes/unreleased.md

@@ -1 +1,4 @@
 # Unreleased
+
+## Refactorings
+ * #186: Integration test for correctness of UDF path generation

doc/developer_guide/developer_guide.rst

@@ -59,7 +59,7 @@ infrastructure which are creating costs for the database instances temporarily
 created during test execution.
 
 Group G2 is guarded by a dedicated `GitHub Enviroment
-<https://docs.github.com/en/actions/how-tos/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment#required-reviewers>`_
+<https://docs.github.com/en/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments>`_
 requiring **manual approval** before these tests are executed.
 
 Each of the groups results in a final gating GitHub workflow job that is added to the branch protection of branch ``main``.
@@ -93,4 +93,4 @@ The `exasol-toolbox` provides nox tasks to semi-automate the release process:
     nox -s release:trigger
 
 For further information, please refer to the `exasol-toolbox`'s page `How to Release
-<https://exasol.github.io/python-toolbox/main/user_guide/how_to_release.html>`_.
+<https://exasol.github.io/python-toolbox/main/>`_.

test/integration/test_service_onprem.py

@@ -5,19 +5,28 @@
     ByteString,
     Iterable,
 )
-from contextlib import contextmanager
+from contextlib import (
+    closing,
+    contextmanager,
+)
 from inspect import cleandoc
 from test.integration.conftest import (
     File,
     delete_file,
 )
+from textwrap import dedent
 from typing import (
     Tuple,
     Union,
 )
 
+import pyexasol
 import pytest
 import requests
+from exasol.pytest_backend import (
+    BACKEND_ONPREM,
+    BACKEND_SAAS,
+)
 
 from exasol.bucketfs import (
     Bucket,
@@ -315,3 +324,93 @@ def test_any_log_message_get_emitted(httpserver, caplog):
     ]
     # The log level DEBUG should emit at least one log message
     assert log_records
+
+
+def test_upload_and_udf_path(
+    backend_aware_bucketfs_params, backend_aware_database_params, backend
+):
+    # Upload file to BucketFS
+    file_name = "Uploaded-File-From-Integration-test.bin"
+
+    if backend == BACKEND_ONPREM:
+        bucket = Bucket(
+            name=backend_aware_bucketfs_params["bucket_name"],
+            service_name=backend_aware_bucketfs_params["service_name"],
+            password=backend_aware_bucketfs_params["password"],
+            username=backend_aware_bucketfs_params["username"],
+            verify=backend_aware_bucketfs_params["verify"],
+            service=backend_aware_bucketfs_params["url"],
+        )
+    elif backend == BACKEND_SAAS:
+        bucket = SaaSBucket(
+            url=backend_aware_bucketfs_params["url"],
+            account_id=backend_aware_bucketfs_params["account_id"],
+            database_id=backend_aware_bucketfs_params["database_id"],
+            pat=backend_aware_bucketfs_params["pat"],
+        )
+    content = "".join("1" for _ in range(0, 10))
+    try:
+        bucket.upload(file_name, content)
+        assert file_name in bucket.files, "File upload failed"
+
+        # Generate UDF path
+        udf_path = bucket.udf_path
+        assert udf_path is not None, "UDF path generation failed"
+
+        conn = pyexasol.connect(**backend_aware_database_params)
+
+        conn.execute("CREATE SCHEMA IF NOT EXISTS transact;")
+        conn.execute("open schema transact;")
+
+        # Create UDF SQL
+        create_udf_sql = dedent(
+            f"""
+        --/
+        CREATE OR REPLACE PYTHON3 SCALAR 
+        SCRIPT CHECK_FILE_EXISTS_UDF(file_path VARCHAR(200000)) 
+        RETURNS BOOLEAN AS
+        import os
+        def run(ctx):
+            return os.path.exists(ctx.file_path)
+        /
+        """
+        )
+        conn.execute(create_udf_sql)
+        # Verify the path exists inside the UDF
+        result = conn.execute(f"SELECT CHECK_FILE_EXISTS_UDF('{udf_path}')").fetchone()[
+            0
+        ]
+        assert result == True
+
+        # return the content of the file
+        create_read_udf_sql = dedent(
+            f"""
+               --/
+               CREATE OR REPLACE PYTHON3 SCALAR 
+               SCRIPT READ_FILE_CONTENT_UDF(file_path VARCHAR(200000)) 
+               RETURNS VARCHAR(200000) AS
+               def run(ctx):
+                   with open(ctx.file_path, 'rb') as f:
+                       return f.read().decode('utf-8', errors='replace')
+               /
+               """
+        )
+        conn.execute(create_read_udf_sql)
+
+        file_content = conn.execute(
+            f"SELECT READ_FILE_CONTENT_UDF('{udf_path}/{file_name}')"
+        ).fetchone()[0]
+        assert file_content == content
+    except Exception as e:
+        print(e)
+
+    finally:
+        # cleanup
+        _, _ = delete_file(
+            bucket._service,
+            bucket.name,
+            bucket._username,
+            bucket._password,
+            file_name,
+        )
+        pass