#266: SLCParameter should be only key/value pairs (#267)

tomuben · web-flow · commit d0caf9dd94c6 · 2025-02-04T11:32:25.000-03:00
fixes #266
diff --git a/.github/workflows/check_version.yaml b/.github/workflows/check_version.yaml
diff --git a/doc/changes/changelog.md b/doc/changes/changelog.md
@@ -1,6 +1,7 @@
 # Changes
 
 * [unreleased](unreleased.md)
+* [2.0.0](changes_2.0.0)
 * [1.1.0](changes_1.1.0.md)
 * [1.0.0](changes_1.0.0.md)
 * [0.21.0](changes_0.21.0.md)
diff --git a/doc/changes/changes_2.0.0.md b/doc/changes/changes_2.0.0.md
@@ -0,0 +1,11 @@
+# 2.0.0 - 2025-02-04
+
+Code name: Fixed Language Definition Model
+
+## Summary
+
+This release has a small fix for the Language Definition Model and increases it's schema version to 2.
+
+## Refactorings
+
+ - #266: Fix SLCParameter and LanguageDefinition
diff --git a/exasol/slc/internal/tasks/upload/language_def_parser.py b/exasol/slc/internal/tasks/upload/language_def_parser.py
@@ -27,7 +27,7 @@ def _parse_builtin_language_definition(url: str) -> BuiltInLanguageDefinitionURL
 
 
 def _build_udf_client_abs_path_from_fragments(
-    fragment_parts: Tuple[str, ...]
+    fragment_parts: Tuple[str, ...],
 ) -> UdfClientBucketPath:
     if len(fragment_parts) < 4:
         raise ValueError(
@@ -101,8 +101,9 @@ def parse_language_definition(
     if parsed_url.hostname:
         raise ValueError(f"Invalid language definition: '{lang_def}'")
     slc_parameters = [
-        SLCParameter(key=key, value=value)
+        SLCParameter(key=key, value=v)
         for key, value in parse_qs(parsed_url.query).items()
+        for v in value
     ]
     try:
         udf_client_path = _parse_udf_client_path(parsed_url.fragment)
diff --git a/exasol/slc/models/language_definition_common.py b/exasol/slc/models/language_definition_common.py
@@ -1,7 +1,6 @@
 import datetime
 from enum import Enum
 from pathlib import PurePosixPath
-from typing import List
 
 from pydantic import BaseModel
 
@@ -18,7 +17,7 @@ class SLCParameter(BaseModel):
     """
 
     key: str
-    value: List[str]
+    value: str
 
 
 class UdfClientRelativePath(BaseModel):
diff --git a/exasol/slc/models/language_definition_components.py b/exasol/slc/models/language_definition_components.py
@@ -50,7 +50,7 @@ class LanguageDefinitionURL:
     udf_client_path: Union[UdfClientBucketPath, UdfClientRelativePath]
 
     def __str__(self) -> str:
-        query_params = {p.key: v for p in self.parameters for v in p.value}
+        query_params = [(p.key, p.value) for p in self.parameters]
         query_string = urlencode(query_params)
         url = urlunparse(
             ParseResult(
diff --git a/exasol/slc/models/language_definition_model.py b/exasol/slc/models/language_definition_model.py
@@ -10,7 +10,7 @@
     UdfClientRelativePath,
 )
 
-LANGUAGE_DEFINITON_SCHEMA_VERSION = 1
+LANGUAGE_DEFINITON_SCHEMA_VERSION = 2
 
 
 class LanguageDefinition(BaseModel):
@@ -20,7 +20,6 @@ class LanguageDefinition(BaseModel):
 
     protocol: str
     aliases: List[str]
-    language: SLCLanguage
     parameters: List[SLCParameter]
     udf_client_path: UdfClientRelativePath
     deprecation: Optional[DeprecationInfo]
diff --git a/exasol/slc/version.py b/exasol/slc/version.py
@@ -4,8 +4,8 @@
 #   * or "poetry run version-check <path/version.py> --fix"
 # Do not edit this file manually!
 # If you need to change the version, do so in the project.toml, e.g. by using `poetry version X.Y.Z`.
-MAJOR = 1
-MINOR = 1
+MAJOR = 2
+MINOR = 0
 PATCH = 0
 VERSION = f"{MAJOR}.{MINOR}.{PATCH}"
 __version__ = VERSION
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "exasol-script-languages-container-tool"
-version = "1.1.0"
+version = "2.0.0"
 description = "Script Languages Container Tool"
 
 license = "MIT"
diff --git a/test/resources/flavors/real-test-flavor/real_flavor_base/language_definitions.json b/test/resources/flavors/real-test-flavor/real_flavor_base/language_definitions.json
@@ -1,11 +1,10 @@
 {
-  "schema_version": 1,
+  "schema_version": 2,
   "language_definitions": [
     {
       "protocol": "localzmq+protobuf",
       "aliases": ["JAVA"],
-      "language": "java",
-      "parameters": [],
+      "parameters": [{"key": "lang", "value": "java"}],
       "udf_client_path": {
         "executable": "/exaudf/exaudfclient"
       },
diff --git a/test/test_docker_api_language_def_json.py b/test/test_docker_api_language_def_json.py
@@ -19,6 +19,7 @@
 from exasol.slc.models.language_definition_common import (
     DeprecationInfo,
     SLCLanguage,
+    SLCParameter,
     UdfClientRelativePath,
 )
 from exasol.slc.models.language_definition_model import (
@@ -128,16 +129,15 @@ def test_docker_build(self) -> None:
         self.assertEqual(
             model,
             LanguageDefinitionsModel(
-                schema_version=1,
+                schema_version=2,
                 language_definitions=[
                     LanguageDefinition(
                         protocol="localzmq+protobuf",
                         aliases=["JAVA"],
-                        language=SLCLanguage.Java,
+                        parameters=[SLCParameter(key="lang", value="java")],
                         udf_client_path=UdfClientRelativePath(
                             executable=PurePosixPath("/exaudf/exaudfclient")
                         ),
-                        parameters=[],
                         deprecation=DeprecationInfo(
                             deprecation_date=datetime.datetime(2024, 10, 31),
                             default_changed_to="Java 17",
@@ -223,16 +223,15 @@ def test_docker_build_without_deprecation_info(self):
         self.assertEqual(
             model,
             LanguageDefinitionsModel(
-                schema_version=1,
+                schema_version=2,
                 language_definitions=[
                     LanguageDefinition(
                         protocol="localzmq+protobuf",
                         aliases=["JAVA"],
-                        language=SLCLanguage.Java,
+                        parameters=[SLCParameter(key="lang", value="java")],
                         udf_client_path=UdfClientRelativePath(
                             executable=PurePosixPath("/exaudf/exaudfclient")
                         ),
-                        parameters=[],
                         deprecation=None,
                     )
                 ],
diff --git a/test/test_lang_definitions_builder.py b/test/test_lang_definitions_builder.py
@@ -58,7 +58,7 @@ def test_without_custom_alias_without_builtin(self):
                                 "some_path/my_release/exaudf/exaudfclient_py3"
                             ),
                         ),
-                        parameters=[SLCParameter(key="lang", value=["python"])],
+                        parameters=[SLCParameter(key="lang", value="python")],
                     ),
                 )
             ],
@@ -98,7 +98,7 @@ def test_without_custom_alias_with_builtin(self):
                                 "some_path/my_release/exaudf/exaudfclient_py3"
                             ),
                         ),
-                        parameters=[SLCParameter(key="lang", value=["python"])],
+                        parameters=[SLCParameter(key="lang", value="python")],
                     ),
                 ),
                 LanguageDefinitionComponents(
@@ -154,7 +154,7 @@ def test_with_custom_alias_with_builtin(self):
                                 "some_path/my_release/exaudf/exaudfclient_py3"
                             ),
                         ),
-                        parameters=[SLCParameter(key="lang", value=["python"])],
+                        parameters=[SLCParameter(key="lang", value="python")],
                     ),
                 ),
                 LanguageDefinitionComponents(
diff --git a/test/unit/test_language_def_parser.py b/test/unit/test_language_def_parser.py
