validate spec and allow descriptions to be null

flatironinstitute · Mar 19, 2024 · dde8738 · dde8738
1 parent b6b3807
commit dde8738
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 8 deletions.
diff --git a/python/dendro/common/dendro_types.py b/python/dendro/common/dendro_types.py
@@ -9,7 +9,7 @@ class DendroProjectUser(BaseModel):
 class DendroProject(BaseModel):
     projectId: str
     name: str
-    description: str
+    description: Union[str, None] = None
     ownerId: str
     users: List[DendroProjectUser]
     publiclyReadable: bool
@@ -39,29 +39,29 @@ class DendroJobOutputFile(BaseModel):
 
 class ComputeResourceSpecProcessorParameter(BaseModel):
     name: str
-    description: str
+    description: Union[str, None] = None
     type: str
     default: Union[Any, None] = None
     options: Union[List[str], List[int], None] = None
     secret: bool = False
 
 class ComputeResourceSpecProcessorInput(BaseModel):
     name: str
-    description: str
+    description: Union[str, None] = None
     list: bool = False
 
 class ComputeResourceSpecProcessorInputFolder(BaseModel):
     name: str
-    description: str
+    description: Union[str, None] = None
     list: bool = False
 
 class ComputeResourceSpecProcessorOutput(BaseModel):
     name: str
-    description: str
+    description: Union[str, None] = None
 
 class ComputeResourceSpecProcessorOutputFolder(BaseModel):
     name: str
-    description: str
+    description: Union[str, None] = None
 
 class ComputeResourceSpecProcessorAttribute(BaseModel):
     name: str
@@ -72,7 +72,7 @@ class ComputeResourceSpecProcessorTag(BaseModel):
 
 class ComputeResourceSpecProcessor(BaseModel):
     name: str
-    description: str
+    description: Union[str, None] = None
     inputs: List[ComputeResourceSpecProcessorInput]
     inputFolders: Union[List[ComputeResourceSpecProcessorInputFolder], None] = None
     outputs: List[ComputeResourceSpecProcessorOutput]
@@ -170,7 +170,7 @@ class DendroComputeResourceApp(BaseModel):
 
 class ComputeResourceSpecApp(BaseModel):
     name: str
-    description: str
+    description: Union[str, None] = None
     processors: List[ComputeResourceSpecProcessor]
     appImage: Union[str, None] = None
     appExecutable: Union[str, None] = None

diff --git a/python/dendro/sdk/App.py b/python/dendro/sdk/App.py
@@ -10,6 +10,7 @@
 from .InputFolder import InputFolder
 from .OutputFile import OutputFile
 from .OutputFolder import OutputFolder
+from ..common.dendro_types import ComputeResourceSpecApp
 
 
 class DendroAppException(Exception):
@@ -181,6 +182,11 @@ def get_spec(self):
             'executable': self._app_executable,
             'processors': processors
         }
+        # Validate the spec
+        try:
+            ComputeResourceSpecApp(**spec)
+        except Exception as e:
+            raise Exception(f'Error validating spec:\n {e}')
         return spec
 
     @staticmethod