Add pre_values and Jinja strict mode

src/ibek/definition.py

@@ -131,7 +131,14 @@ class EntityDefinition(BaseSettings):
         description="The arguments IOC instance should supply", default=()
     )
     values: Sequence[Value] = Field(
-        description="Calculated values to use as additional arguments", default=()
+        description="Calculated values to use as additional arguments "
+        "With Jinja evaluation after all Args",
+        default=(),
+    )
+    pre_values: Sequence[Value] = Field(
+        description="Calculated values to use as additional arguments "
+        "With Jinja evaluation before all Args",
+        default=(),
     )
     databases: Sequence[Database] = Field(
         description="Databases to instantiate", default=[]

src/ibek/entity_factory.py

@@ -10,7 +10,7 @@
 
 from pydantic import create_model, field_validator
 from pydantic.fields import FieldInfo
-from pydantic_core import PydanticUndefined
+from pydantic_core import PydanticUndefined, ValidationError
 from ruamel.yaml.main import YAML
 
 from .args import EnumArg, IdArg, ObjectArg
@@ -41,12 +41,16 @@ def make_entity_models(self, definition_yaml: List[Path]) -> List[Type[Entity]]:
         for definition in definition_yaml:
             support_dict = YAML(typ="safe").load(definition)
 
-            Support.model_validate(support_dict)
+            try:
+                Support.model_validate(support_dict)
 
-            # deserialize the support module definition file
-            support = Support(**support_dict)
-            # make Entity classes described in the support module definition file
-            self._make_entity_models(support)
+                # deserialize the support module definition file
+                support = Support(**support_dict)
+                # make Entity classes described in the support module definition file
+                self._make_entity_models(support)
+            except ValidationError:
+                print(f"PYDANTIC VALIDATION ERROR IN {definition}")
+                raise
 
         return list(self._entity_models.values())
 
@@ -71,6 +75,12 @@ def add_arg(name, typ, description, default):
         # fully qualified name of the Entity class including support module
         full_name = f"{support.module}.{definition.name}"
 
+        # add in the calculated values Jinja Templates as Fields in the Entity
+        # these are the pre_values that should be Jinja rendered before any
+        # Args (or post values)
+        for value in definition.pre_values:
+            add_arg(value.name, str, value.description, value.value)
+
         # add in each of the arguments as a Field in the Entity
         for arg in definition.args:
             full_arg_name = f"{full_name}.{arg.name}"

src/ibek/gen_scripts.py

@@ -5,7 +5,7 @@
 import logging
 from typing import List, Sequence, Tuple
 
-from jinja2 import Template
+from jinja2 import StrictUndefined, Template
 
 from ibek.utils import UTILS
 
@@ -31,7 +31,13 @@ def create_db_script(
 
         templates = renderer.render_database(extra_databases)
 
-        return Template(jinja_txt).render(templates=templates)
+        try:
+            return Template(jinja_txt).render(
+                templates=templates, undefined=StrictUndefined
+            )
+        except Exception:
+            print(f"ERROR RENDERING DATABASE TEMPLATE:\n{templates}")
+            raise
 
 
 def create_boot_script(entities: Sequence[Entity]) -> str:
@@ -44,7 +50,12 @@ def create_boot_script(entities: Sequence[Entity]) -> str:
     renderer = Render()
 
     return template.render(
+        # old name for global context for backward compatibility
         __utils__=UTILS,
+        # new short name for global context
+        _ctx_=UTILS,
+        # put variables created with set/get directly in the context
+        **UTILS.variables,
         env_var_elements=renderer.render_environment_variable_elements(entities),
         script_elements=renderer.render_pre_ioc_init_elements(entities),
         post_ioc_init_elements=renderer.render_post_ioc_init_elements(entities),

src/ibek/ioc_cmds/docker.py

@@ -1,5 +1,4 @@
 import os
-import shutil
 import subprocess
 from pathlib import Path
 from typing import List
@@ -35,16 +34,8 @@ def handle_command(context: Path, tokens: List[str], step, start):
         os.chdir(tokens[1])
     elif docker_action == "COPY":
         print("COPY", tokens)
-        src = context / (Path(tokens[1]))
-        dest = (Path.cwd() / Path(tokens[2])).absolute()
-        if src == dest:
-            print("SKIPPING copy of same path")
-        else:
-            print(f"copying {src} to {dest}")
-            if src.is_file():
-                shutil.copy(src, dest)
-            else:
-                shutil.copytree(src, dest, dirs_exist_ok=True)
+        # skipping because in devcontainer the project folder is already mounted
+        # where the destination copy is supposed to go inside the container
     elif docker_action == "FROM":
         if "runtime_prep" in tokens:
             print("\n== Aborting before destructive runtime prep stage. ==\n")

src/ibek/render_db.py

@@ -76,7 +76,7 @@ def add_database(self, database: Database, entity: Entity) -> None:
 
             for arg, value in database.args.items():
                 if value is None:
-                    if arg not in entity.__dict__:
+                    if arg not in entity.__dict__ and arg not in UTILS.variables:
                         raise ValueError(
                             f"database arg '{arg}' in database template "
                             f"'{database.file}' not found in context"

src/ibek/utils.py

@@ -12,7 +12,7 @@
 from pathlib import Path
 from typing import Any, Dict, Mapping
 
-from jinja2 import Template
+from jinja2 import StrictUndefined, Template
 
 
 @dataclass
@@ -32,6 +32,12 @@ def increment(self, count: int):
                 f"Counter {self.current} exceeded stop value of {self.stop}"
             )
 
+    def __repr__(self) -> str:
+        return str(self.current)
+
+    def __str__(self) -> str:
+        return str(self.current)
+
 
 class Utils:
     """
@@ -43,6 +49,10 @@ def __init__(self: "Utils"):
         self.ioc_name: str = ""
         self.__reset__()
 
+        # old names for backward compatibility
+        self.set_var = self.set
+        self.get_var = self.get
+
     def __reset__(self: "Utils"):
         """
         Reset all saved state. For use in testing where more than one
@@ -69,13 +79,15 @@ def get_env(self, key: str) -> str:
         """
         return os.environ.get(key, "")
 
-    def set_var(self, key: str, value: Any):
+    def set(self, key: str, value: Any) -> Any:
         """create a global variable for our jinja context"""
         self.variables[key] = value
+        return value
 
-    def get_var(self, key: str) -> Any:
+    def get(self, key: str, default="") -> Any:
         """get the value a global variable for our jinja context"""
-        return self.variables.get(key, "")
+        # default is used to set an initial value if the variable is not set
+        return self.variables.get(key, default)
 
     def counter(
         self, name: str, start: int = 0, stop: int = 65535, inc: int = 1
@@ -110,10 +122,15 @@ def render(self, context: Any, template_text: Any) -> str:
             return template_text
 
         try:
-            jinja_template = Template(template_text)
+            jinja_template = Template(template_text, undefined=StrictUndefined)
             return jinja_template.render(
                 context,
+                # old name for global context for backward compatibility
                 __utils__=self,
+                # new short name for global context
+                _ctx_=self,
+                # put variables created with set/get directly in the context
+                **self.variables,
                 ioc_yaml_file_name=self.file_name,
                 ioc_name=self.ioc_name,
             )