feat(executors): add workflow name and metadata

Author: AndreyMarkinPPC

libs/executors/garf/executors/workflows/workflow.py

@@ -155,6 +155,23 @@ def context(self) -> ExecutionContext:
     )
 
 
+class WorkflowMetadata(pydantic.BaseModel):
+  """Contains optional metadata on workflow.
+
+  Attributes:
+    description: Brief description of workflow.
+    version: Version of workflow.
+    required_garf_version: Minimal required version of garf-executors package.
+    required_fetchers:
+      Fetchers needed for workflow with minimal required version.
+  """
+
+  description: str | None = None
+  version: str | None = None
+  required_garf_version: str | None = None
+  required_fetchers: dict[str, str] | None = None
+
+
 class Workflow(pydantic.BaseModel):
   """Orchestrates execution of queries for multiple fetchers.
 
@@ -169,6 +186,8 @@ class Workflow(pydantic.BaseModel):
   prefix: str | pathlib.Path | None = pydantic.Field(
     default=None, excluded=True
   )
+  name: str | None = None
+  metadata: WorkflowMetadata = WorkflowMetadata()
 
   def model_post_init(self, __context__) -> None:
     if self.execution_config:
@@ -215,8 +234,11 @@ def from_file(
     try:
       if isinstance(path, str):
         path = pathlib.Path(path)
+      metadata = data.get('metadata') or WorkflowMetadata()
       return Workflow(
         steps=data.get('steps'),
+        name=data.get('name') or str(path.stem),
+        metadata=metadata,
         context=context,
         prefix=path.parent,
         execution_config=config.Config.from_file(config_file)

libs/executors/tests/unit/workflows/test_workflow.py

@@ -55,7 +55,9 @@ class TestWorkflow:
           'destination_folder': '/tmp',
         },
       }
-    ]
+    ],
+    'name': 'test workflow',
+    'metadata': {'description': 'Test Workflow'},
   }
 
   def test_from_file_returns_correct_context_from_data(self, tmp_path):
@@ -64,13 +66,18 @@ def test_from_file_returns_correct_context_from_data(self, tmp_path):
       yaml.dump(self.data, f, encoding='utf-8')
     workflow = Workflow.from_file(tmp_workflow)
     expected_workflow = Workflow(
-      steps=self.data.get('steps'), prefix=tmp_workflow.parent
+      steps=self.data.get('steps'),
+      name='test workflow',
+      metadata={
+        'description': 'Test Workflow',
+      },
+      prefix=tmp_workflow.parent,
     )
     assert workflow == expected_workflow
 
   def test_save_returns_correct_data(self, tmp_path):
     tmp_workflow = tmp_path / 'workflow.yaml'
-    workflow = Workflow(steps=self.data.get('steps'))
+    workflow = Workflow(**self.data)
     workflow.save(tmp_workflow)
     with open(tmp_workflow, 'r', encoding='utf-8') as f:
       workflow_data = yaml.safe_load(f)

libs/executors/tests/unit/workflows/test_workflow.yaml

@@ -8,6 +8,14 @@ common_context: &empty_context
       macro: {}
       template: {}
 
+name: test_workflow
+metadata:
+  description: Test Workflow
+  version: 0.0.0
+  required_garf_version: 0.0.0
+  required_fetchers:
+    google-ads: 0.0.0
+
 steps:
   - alias: test
     fetcher: fake