From 345840bb1c28cd34f433ec1465a74ed12a886560 Mon Sep 17 00:00:00 2001
From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com>
Date: Tue, 1 Apr 2025 16:06:37 +0200
Subject: [PATCH] added exception for missing environment variable

---
 client/ayon_core/pipeline/anatomy/__init__.py |  2 ++
 .../ayon_core/pipeline/anatomy/exceptions.py  |  5 +++++
 client/ayon_core/pipeline/anatomy/roots.py    | 22 ++++++++++++++-----
 3 files changed, 24 insertions(+), 5 deletions(-)

diff --git a/client/ayon_core/pipeline/anatomy/__init__.py b/client/ayon_core/pipeline/anatomy/__init__.py
index 336d09ccaa..7000f51495 100644
--- a/client/ayon_core/pipeline/anatomy/__init__.py
+++ b/client/ayon_core/pipeline/anatomy/__init__.py
@@ -1,5 +1,6 @@
 from .exceptions import (
     ProjectNotSet,
+    RootMissingEnv,
     RootCombinationError,
     TemplateMissingKey,
     AnatomyTemplateUnsolved,
@@ -9,6 +10,7 @@ from .anatomy import Anatomy
 
 __all__ = (
     "ProjectNotSet",
+    "RootMissingEnv",
     "RootCombinationError",
     "TemplateMissingKey",
     "AnatomyTemplateUnsolved",
diff --git a/client/ayon_core/pipeline/anatomy/exceptions.py b/client/ayon_core/pipeline/anatomy/exceptions.py
index 39f116baf0..24df0e3046 100644
--- a/client/ayon_core/pipeline/anatomy/exceptions.py
+++ b/client/ayon_core/pipeline/anatomy/exceptions.py
@@ -5,6 +5,11 @@ class ProjectNotSet(Exception):
     """Exception raised when is created Anatomy without project name."""
 
 
+class RootMissingEnv(KeyError):
+    """Raised when root requires environment variables which is not filled."""
+    pass
+
+
 class RootCombinationError(Exception):
     """This exception is raised when templates has combined root types."""
 
diff --git a/client/ayon_core/pipeline/anatomy/roots.py b/client/ayon_core/pipeline/anatomy/roots.py
index c7b9ff8ebc..bd09a9fe51 100644
--- a/client/ayon_core/pipeline/anatomy/roots.py
+++ b/client/ayon_core/pipeline/anatomy/roots.py
@@ -2,9 +2,11 @@ import os
 import platform
 import numbers
 
-from ayon_core.lib import Logger
+from ayon_core.lib import Logger, StringTemplate
 from ayon_core.lib.path_templates import FormatObject
 
+from .exceptions import RootMissingEnv
+
 
 class RootItem(FormatObject):
     """Represents one item or roots.
@@ -21,7 +23,7 @@ class RootItem(FormatObject):
             multi root setup otherwise None value is expected.
     """
     def __init__(self, parent, root_raw_data, name):
-        super(RootItem, self).__init__()
+        super().__init__()
         self._log = None
         lowered_platform_keys = {
             key.lower(): value
@@ -38,9 +40,19 @@ class RootItem(FormatObject):
         # WARNING: Using environment variables in roots is not considered
         #   as production safe. Some features may not work as expected, for
         #   example USD resolver or site sync.
-        self.value = lowered_platform_keys[current_platform].format_map(
-            os.environ
-        )
+        try:
+            self.value = lowered_platform_keys[current_platform].format_map(
+                os.environ
+            )
+        except KeyError:
+            result = StringTemplate(self.value).format(os.environ.copy())
+            is_are = "is" if len(result.missing_keys) == 1 else "are"
+            missing_keys = ", ".join(result.missing_keys)
+            raise RootMissingEnv(
+                f"Root \"{name}\" requires environment variable/s"
+                f" {missing_keys} which {is_are} not available."
+            )
+
         self.clean_value = self._clean_root(self.value)
 
     def __format__(self, *args, **kwargs):