|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +from collections.abc import ( |
| 4 | + Iterator, |
| 5 | + Mapping, |
| 6 | +) |
| 7 | +from functools import cached_property |
| 8 | +from pathlib import Path |
| 9 | +from typing import ( |
| 10 | + Annotated, |
| 11 | + Final, |
| 12 | +) |
| 13 | + |
| 14 | +from pydantic import BaseModel |
| 15 | + |
| 16 | +from exasol.toolbox.config import BaseConfig |
| 17 | +from exasol.toolbox.util.workflows import logger |
| 18 | +from exasol.toolbox.util.workflows.exceptions import ( |
| 19 | + InvalidWorkflowPatcherEntryError, |
| 20 | + NotMaintainedWorkflowError, |
| 21 | + YamlKeyError, |
| 22 | +) |
| 23 | +from exasol.toolbox.util.workflows.patch_workflow import ( |
| 24 | + WorkflowCommentedMap, |
| 25 | + WorkflowPatcher, |
| 26 | +) |
| 27 | +from exasol.toolbox.util.workflows.templates import ( |
| 28 | + WORKFLOW_TEMPLATE_OPTIONS, |
| 29 | + validate_workflow_name, |
| 30 | +) |
| 31 | +from exasol.toolbox.util.workflows.workflow import Workflow |
| 32 | + |
| 33 | +ALL: Final[str] = "all" |
| 34 | +WorkflowChoice = Annotated[ |
| 35 | + str, f"Should be a value from {[ALL, *WORKFLOW_TEMPLATE_OPTIONS.keys()]}" |
| 36 | +] |
| 37 | +WORKFLOW_CHOICES: Final[list[str]] = [ALL, *WORKFLOW_TEMPLATE_OPTIONS.keys()] |
| 38 | + |
| 39 | + |
| 40 | +class WorkflowOrchestrator(BaseModel): |
| 41 | + """Orchestrate workflow rendering, comparison, and writing.""" |
| 42 | + |
| 43 | + workflow_choice: WorkflowChoice |
| 44 | + config: BaseConfig |
| 45 | + |
| 46 | + @cached_property |
| 47 | + def templates(self) -> Mapping[str, Path]: |
| 48 | + """ |
| 49 | + A mapping of workflow templates names to paths. This can be a single |
| 50 | + item or all workflow templates. |
| 51 | + """ |
| 52 | + if self.workflow_choice == ALL: |
| 53 | + return WORKFLOW_TEMPLATE_OPTIONS |
| 54 | + return {self.workflow_choice: WORKFLOW_TEMPLATE_OPTIONS[self.workflow_choice]} |
| 55 | + |
| 56 | + @cached_property |
| 57 | + def workflow_patcher(self) -> WorkflowPatcher | None: |
| 58 | + if not self.config.github_workflow_patcher_yaml: |
| 59 | + return None |
| 60 | + return WorkflowPatcher( |
| 61 | + github_template_dict=self.config.github_template_dict, |
| 62 | + file_path=self.config.github_workflow_patcher_yaml, |
| 63 | + ) |
| 64 | + |
| 65 | + def _extract_workflow_patch( |
| 66 | + self, workflow_name: str |
| 67 | + ) -> WorkflowCommentedMap | None: |
| 68 | + """ |
| 69 | + Return the patch data for a workflow, or ``None`` if no patcher is configured. |
| 70 | + """ |
| 71 | + if self.workflow_patcher is None: |
| 72 | + return None |
| 73 | + return self.workflow_patcher.extract_by_workflow(workflow_name=workflow_name) |
| 74 | + |
| 75 | + def _is_new_project(self) -> bool: |
| 76 | + """ |
| 77 | + A project is considered new if no YML files are present in the GitHub directory. |
| 78 | + """ |
| 79 | + return not any(self.config.github_workflow_directory.glob("*.yml")) |
| 80 | + |
| 81 | + def _iter_workflows(self) -> Iterator[Workflow]: |
| 82 | + logger.info(f"Selected workflow(s) to update: {list(self.templates.keys())}") |
| 83 | + is_new_project = self._is_new_project() |
| 84 | + for workflow_name, template_path in self.templates.items(): |
| 85 | + patch_yaml = self._extract_workflow_patch(workflow_name=workflow_name) |
| 86 | + |
| 87 | + if self._skip_workflow(workflow_name, is_new_project): |
| 88 | + continue |
| 89 | + |
| 90 | + yield self._load_workflow( |
| 91 | + template_path=template_path, patch_yaml=patch_yaml |
| 92 | + ) |
| 93 | + |
| 94 | + def _load_workflow( |
| 95 | + self, template_path: Path, patch_yaml: WorkflowCommentedMap | None |
| 96 | + ): |
| 97 | + try: |
| 98 | + return Workflow.load_from_template( |
| 99 | + template_path=template_path, |
| 100 | + output_directory=self.config.github_workflow_directory, |
| 101 | + github_template_dict=self.config.github_template_dict, |
| 102 | + patch_yaml=patch_yaml, |
| 103 | + ) |
| 104 | + except YamlKeyError as ex: |
| 105 | + raise InvalidWorkflowPatcherEntryError( |
| 106 | + file_path=self.config.github_workflow_patcher_yaml, # type: ignore |
| 107 | + entry=ex.entry, |
| 108 | + ) from ex |
| 109 | + |
| 110 | + def _skip_workflow(self, workflow_name: str, is_new_project: bool) -> bool: |
| 111 | + """ |
| 112 | + Return ``True`` if the workflow should be skipped because it is not maintained |
| 113 | + by the PTB, otherwise return ``False``. |
| 114 | + """ |
| 115 | + try: |
| 116 | + validate_workflow_name(workflow_name) |
| 117 | + except NotMaintainedWorkflowError: |
| 118 | + if not is_new_project: |
| 119 | + logger.debug( |
| 120 | + "Skipping not-maintained workflow in older project: %s", |
| 121 | + workflow_name, |
| 122 | + ) |
| 123 | + return True |
| 124 | + return False |
| 125 | + |
| 126 | + def generate_workflows(self) -> None: |
| 127 | + """ |
| 128 | + Render the selected workflows and write them to disk. |
| 129 | + """ |
| 130 | + for workflow in self._iter_workflows(): |
| 131 | + workflow.write_to_file() |
0 commit comments