Merge pull request #59 from Komalis/feat/add-jinja2-render-command

feat: big cleanup in templating ecs file

Author: Komalis

easyecs/cli.py

@@ -33,6 +33,7 @@
 from easyecs.helpers.settings import (
     compute_hash_ecs_file,
     delete_hash,
+    ecs_file_to_yaml,
     load_settings,
     read_ecs_file,
     save_hash,
@@ -394,5 +395,11 @@ def click_version() -> None:
     print(data["tool"]["poetry"]["version"])
 
 
+@entrypoint.command(name="render", help="Show a rendered ecs file")
+@options.file_name
+def click_render(file_name: str) -> None:
+    print(ecs_file_to_yaml(file_name))
+
+
 if __name__ == "__main__":
     entrypoint()

easyecs/helpers/settings.py

@@ -1,6 +1,7 @@
 import hashlib
 import json
 import os
+import re
 import yaml
 from jinja2 import Environment, FileSystemLoader
 
@@ -15,13 +16,33 @@
 from easyecs.model.ecs import EcsFileModel
 
 
-def read_ecs_file(file_name: str) -> EcsFileModel:
+def backport_old_format_to_new_format(data: str) -> str:
+    # This function will be deprecated in the future.
+    old_format_pattern = r"{{ ?\.(\w+) ?}}"
+    matches = re.findall(old_format_pattern, data)
+    for match in matches:
+        print(
+            f"{Color.RED}Old template format has been found {{{{.{match}}}}}, please"
+            f" update it to {{{{ {match} }}}}, it will be deprecated in a near"
+            f" future.{Color.END}"
+        )
+    new_data = re.sub(old_format_pattern, r"{{ \1 }}", data)
+    return new_data
+
+
+def ecs_file_to_yaml(file_name: str) -> str:
     env = Environment(loader=FileSystemLoader("."))
     with open(file_name) as f:
         data = f.read()
+        data = backport_old_format_to_new_format(data)
         template = env.from_string(data)
         rendered_template = template.render(**os.environ)
-        rendered_data = yaml.safe_load(rendered_template)
+    return rendered_template
+
+
+def read_ecs_file(file_name: str) -> EcsFileModel:
+    rendered_template = ecs_file_to_yaml(file_name)
+    rendered_data = yaml.safe_load(rendered_template)
     return EcsFileModel(**rendered_data)
 
 

easyecs/model/ecs.py

@@ -4,7 +4,6 @@
 from pydantic import BaseModel, computed_field, field_validator, model_validator
 from pathlib import Path
 
-from easyecs.helpers.common import template_with_env_var
 from easyecs.helpers.exceptions import FileNotFoundException
 
 
@@ -28,11 +27,10 @@ class EcsFileRoleModel(BaseModel):
     @field_validator("arn")
     def set_arn(cls, arn):
         arn_pattern: str = r"^arn:aws:iam::\d{0,12}:role\/[\w\d_\/.-]*$"
-        parsed_arn = template_with_env_var(arn)
         assert re.match(
-            arn_pattern, parsed_arn
-        ), f"Role ARN does not respect arn pattern : {parsed_arn}"
-        return parsed_arn
+            arn_pattern, arn
+        ), f"Role ARN does not respect arn pattern : {arn}"
+        return arn
 
     @field_validator("statements")
     def validate_unique_sid(cls, statements):
@@ -80,11 +78,8 @@ class EcsFileVolumeModel(BaseModel):
 
     @field_validator("id")
     def set_id(cls, id):
-        parsed_id = template_with_env_var(id)
-        assert parsed_id.startswith(
-            "fs-"
-        ), f"EFS ID should start with fs- instead got {parsed_id}"
-        return parsed_id
+        assert id.startswith("fs-"), f"EFS ID should start with fs- instead got {id}"
+        return id
 
 
 class EcsFileContainerHealthCheckModel(BaseModel):
@@ -126,10 +121,6 @@ def validate_volumes(cls, volumes):
             resolved_volumes.append(f"{resolved_from_dir}/{resolved_from_file}:{_to}")
         return resolved_volumes
 
-    @field_validator("image")
-    def validate_image(cls, image):
-        return template_with_env_var(image)
-
 
 class EcsTaskDefinitionModel(BaseModel):
     resources: EcsFileResourcesModel

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "easyecs"
-version = "0.16.0"
+version = "0.16.1"
 description = ""
 authors = ["BONVARLET Benjamin <benjaminbonvarlet96@gmail.com>"]
 readme = "README.md"

tests/model/test_validation.py

@@ -1,4 +1,3 @@
-import os
 from typing import Union
 import pytest
 from pydantic import ValidationError
@@ -87,10 +86,6 @@ def test_single_tty_validation():
             "arn:aws:iam::123456789012:role/S3Access",
             "arn:aws:iam::123456789012:role/S3Access",
         ),
-        (
-            "arn:aws:iam::123456789012:role/{{.USER}}",
-            "arn:aws:iam::123456789012:role/" + os.getenv("USER"),
-        ),
     ],
 )
 def test_arn_validation(test_input: str, expected: Union[str, ValidationError]):