#263: Extended language_definitions.json with deprecation fields (#264)

fixes #263
fixes #243

Author: tomuben

.gitignore

@@ -145,3 +145,5 @@ TAGS
 
 .lint.json
 .lint.txt
+
+*.dot

doc/changes/changes_1.1.0.md

@@ -9,6 +9,7 @@ t.b.d.
 ## Features
 
  - #245: Implemented support for Json for language definition
+ - #263: Extended language_definitions.json with deprecation fields
 
 ## Refactoring
 
@@ -17,3 +18,7 @@ t.b.d.
  - #256: Fixed type hints
  - #358: Minimize disk space during export
  - #253: Fixed help text for exaslct
+
+## Documentation
+
+ - #243: Removed incomplete title in user guide

doc/user_guide/user_guide.md

@@ -159,6 +159,3 @@ exaslct clean-all-images
 
 **Please note that this script does not delete the Linux image that is used as basis for the images that were build in the previous steps.
 Furthermore, this command doesn't delete cached files in the output directory. The default path for the output directory is .build-output.**
-
-
-## Use

exasol/slc/models/language_definition_common.py

@@ -1,4 +1,4 @@
-from dataclasses import dataclass
+import datetime
 from enum import Enum
 from pathlib import PurePosixPath
 from typing import List
@@ -31,3 +31,14 @@ class UdfClientRelativePath(BaseModel):
 
     def __str__(self) -> str:
         return str(self.executable)
+
+
+class DeprecationInfo(BaseModel):
+    """
+    Deprecation info for the language.
+    For example: deprecation_date="2024-10-31" default_changed_to="Java 17"
+    """
+
+    deprecation_date: datetime.date
+
+    default_changed_to: str

exasol/slc/models/language_definition_model.py

@@ -1,9 +1,10 @@
 from dataclasses import dataclass
-from typing import List
+from typing import List, Optional
 
 from pydantic import BaseModel
 
 from exasol.slc.models.language_definition_common import (
+    DeprecationInfo,
     SLCLanguage,
     SLCParameter,
     UdfClientRelativePath,
@@ -22,6 +23,7 @@ class LanguageDefinition(BaseModel):
     language: SLCLanguage
     parameters: List[SLCParameter]
     udf_client_path: UdfClientRelativePath
+    deprecation: Optional[DeprecationInfo]
 
 
 class LanguageDefinitionsModel(BaseModel):

test/resources/flavors/real-test-flavor/real_flavor_base/language_definitions.json

@@ -8,6 +8,10 @@
       "parameters": [],
       "udf_client_path": {
         "executable": "/exaudf/exaudfclient"
+      },
+      "deprecation": {
+        "deprecation_date": "2024-10-31",
+        "default_changed_to": "Java 17"
       }
     }
   ]

test/test_docker_api_language_def_json.py

@@ -1,3 +1,4 @@
+import datetime
 import json
 import shutil
 import tarfile
@@ -16,6 +17,7 @@
 from exasol.slc.api import build
 from exasol.slc.internal.utils.docker_utils import find_images_by_tag
 from exasol.slc.models.language_definition_common import (
+    DeprecationInfo,
     SLCLanguage,
     UdfClientRelativePath,
 )
@@ -121,6 +123,8 @@ def test_docker_build(self) -> None:
             images[0].id, "build_info/language_definitions.json"
         )
         model = LanguageDefinitionsModel.model_validate_json(lang_def_json)
+        print(model)
+
         self.assertEqual(
             model,
             LanguageDefinitionsModel(
@@ -134,6 +138,10 @@ def test_docker_build(self) -> None:
                             executable=PurePosixPath("/exaudf/exaudfclient")
                         ),
                         parameters=[],
+                        deprecation=DeprecationInfo(
+                            deprecation_date=datetime.datetime(2024, 10, 31),
+                            default_changed_to="Java 17",
+                        ),
                     )
                 ],
             ),
@@ -162,6 +170,75 @@ def test_docker_build_invalid_lang_def_json(self):
                 target_docker_repository_name=self.test_environment.docker_repository_name,
             )
 
+    def test_docker_build_without_deprecation_info(self):
+        flavor_path = exaslct_utils.get_test_flavor()
+        with TemporaryDirectory() as d:
+            temp_flavor_path = Path(d) / "test_flavor"
+            shutil.copytree(flavor_path, temp_flavor_path)
+
+            lang_def_json_path = (
+                temp_flavor_path / "flavor_base" / "language_definitions.json"
+            )
+            orig_lang_def_json = lang_def_json_path.read_text()
+            lang_def_invalid = json.loads(orig_lang_def_json)
+            lang_def_invalid["language_definitions"][0].update({"deprecation": None})
+            with open(lang_def_json_path, "w") as f:
+                f.write(json.dumps(lang_def_invalid))
+
+            image_infos = build(
+                flavor_path=(str(temp_flavor_path),),
+                source_docker_repository_name=self.test_environment.docker_repository_name,
+                target_docker_repository_name=self.test_environment.docker_repository_name,
+            )
+
+        assert len(image_infos) == 1
+        images = find_images_by_tag(
+            self.docker_client,
+            lambda tag: tag.startswith(self.test_environment.docker_repository_name),
+        )
+        self.assertTrue(
+            len(images) > 0,
+            f"Did not found images for repository "
+            f"{self.test_environment.docker_repository_name} in list {images}",
+        )
+        print("image_infos", image_infos.keys())
+        image_infos_for_test_flavor = image_infos[str(temp_flavor_path)]
+        image_info: ImageInfo = image_infos_for_test_flavor["release"]
+
+        expected_prefix = f"{image_info.target_repository_name}:{image_info.target_tag}"
+        images = find_images_by_tag(
+            self.docker_client, lambda tag: tag.startswith(expected_prefix)
+        )
+        self.assertTrue(
+            len(images) == 1,
+            f"Did not found image for goal 'release' with prefix {expected_prefix} in list {images}",
+        )
+
+        lang_def_json = self.read_file_from_docker_image(
+            images[0].id, "build_info/language_definitions.json"
+        )
+        model = LanguageDefinitionsModel.model_validate_json(lang_def_json)
+        print(model)
+
+        self.assertEqual(
+            model,
+            LanguageDefinitionsModel(
+                schema_version=1,
+                language_definitions=[
+                    LanguageDefinition(
+                        protocol="localzmq+protobuf",
+                        aliases=["JAVA"],
+                        language=SLCLanguage.Java,
+                        udf_client_path=UdfClientRelativePath(
+                            executable=PurePosixPath("/exaudf/exaudfclient")
+                        ),
+                        parameters=[],
+                        deprecation=None,
+                    )
+                ],
+            ),
+        )
+
 
 if __name__ == "__main__":
     unittest.main()