feat(executors): add config name and metadata support

Author: AndreyMarkinPPC

libs/executors/garf/executors/config.py

@@ -30,15 +30,32 @@
 from typing_extensions import Self
 
 
+class ConfigMetadata(pydantic.BaseModel):
+  """Contains optional metadata on config.
+
+  Attributes:
+    description: Brief description of workflow.
+    version: Version of workflow.
+  """
+
+  description: str | None = None
+  version: str | None = None
+
+
 class Config(pydantic.BaseModel):
   """Stores necessary parameters for one or multiple API sources.
 
   Attributes:
     source: Mapping between API source alias and execution parameters.
+    global_parameters: Common parameters for each source.
+    name: Optional name of config.
+    metadata: Optional metadata for config.
   """
 
   sources: dict[str, ExecutionContext]
   global_parameters: ExecutionContext | None = None
+  name: str | None = None
+  metadata: ConfigMetadata = ConfigMetadata()
 
   @classmethod
   def from_file(cls, path: str | pathlib.Path | os.PathLike[str]) -> Config:

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

@@ -178,6 +178,10 @@ class Workflow(pydantic.BaseModel):
   Attributes:
     steps: Contains one or several fetcher executions.
     context: Query and fetcher parameters to overwrite in steps.
+    execution_config: Optional config for running workflow.
+    prefix: Optional location of workflow.
+    name: Optional name of workflow.
+    metadata: Optional metadata.
   """
 
   steps: list[ExecutionStep]

libs/executors/garf/executors/workflows/workflow_runner.py

@@ -83,6 +83,11 @@ def run(
       workflow_attributes.update({'workflow.name': name})
     if version := self.workflow.metadata.version:
       workflow_attributes.update({'workflow.version': version})
+    if config := self.workflow.execution_config:
+      if config_version := config.metadata.version:
+        workflow_attributes.update({'config.version': config_version})
+      if config_name := config.name:
+        workflow_attributes.update({'config.name': config_name})
     if workflow_attributes:
       span.set_attributes(workflow_attributes)
     self.workflow.compile()

libs/executors/tests/unit/test_config.py

@@ -20,6 +20,7 @@ class TestConfig:
   def test_from_file_returns_correct_context_from_data(self, tmp_path):
     tmp_config = tmp_path / 'config.yaml'
     data = {
+      'name': 'test_config',
       'sources': {
         'api': {
           'query_parameters': {
@@ -38,7 +39,8 @@ def test_from_file_returns_correct_context_from_data(self, tmp_path):
             'destination_folder': '/tmp',
           },
         }
-      }
+      },
+      'metadata': {'version': '0.0.0'},
     }
     with open(tmp_config, 'w', encoding='utf-8') as f:
       yaml.dump(data, f, encoding='utf-8')
@@ -49,6 +51,7 @@ def test_from_file_returns_correct_context_from_data(self, tmp_path):
   def test_save_returns_correct_data(self, tmp_path):
     tmp_config = tmp_path / 'config.yaml'
     data = {
+      'name': 'test_config',
       'sources': {
         'api': {
           'query_parameters': {
@@ -67,7 +70,8 @@ def test_save_returns_correct_data(self, tmp_path):
             'destination_folder': '/tmp',
           },
         }
-      }
+      },
+      'metadata': {'version': '0.0.0'},
     }
     config = Config(**data)
     config.save(tmp_config)