|
| 1 | +#!/usr/bin/env python |
| 2 | +# -*- coding: utf-8 -*- |
| 3 | +# |
| 4 | +# Copyright (c) 2024-2025 The WfCommons Team. |
| 5 | +# |
| 6 | +# This program is free software: you can redistribute it and/or modify |
| 7 | +# it under the terms of the GNU General Public License as published by |
| 8 | +# the Free Software Foundation, either version 3 of the License, or |
| 9 | +# (at your option) any later version. |
| 10 | + |
| 11 | +import pathlib |
| 12 | +import shutil |
| 13 | + |
| 14 | +from logging import Logger |
| 15 | +from typing import Optional, Union |
| 16 | + |
| 17 | +from .abstract_translator import Translator |
| 18 | +from ...common import Workflow |
| 19 | + |
| 20 | +this_dir = pathlib.Path(__file__).resolve().parent |
| 21 | + |
| 22 | + |
| 23 | +class MakeflowTranslator(Translator): |
| 24 | + """ |
| 25 | + A WfFormat parser for creating Makeflow workflow applications. |
| 26 | +
|
| 27 | + :param workflow: Workflow benchmark object or path to the workflow benchmark JSON instance. |
| 28 | + :type workflow: Union[Workflow, pathlib.Path], |
| 29 | + :param logger: The logger where to log information/warning or errors (optional). |
| 30 | + :type logger: Logger |
| 31 | + """ |
| 32 | + def __init__(self, |
| 33 | + workflow: Union[Workflow, pathlib.Path], |
| 34 | + logger: Optional[Logger] = None) -> None: |
| 35 | + """Create an object of the translator.""" |
| 36 | + super().__init__(workflow, logger) |
| 37 | + self._script = "" |
| 38 | + |
| 39 | + def translate(self, output_folder: pathlib.Path) -> None: |
| 40 | + """ |
| 41 | + Translate a workflow benchmark description (WfFormat) into an actual workflow application. |
| 42 | +
|
| 43 | + :param output_folder: The path to the folder in which the workflow benchmark will be generated. |
| 44 | + :type output_folder: pathlib.Path |
| 45 | + """ |
| 46 | + |
| 47 | + # Generate code |
| 48 | + self._generate_code() |
| 49 | + |
| 50 | + # write benchmark files |
| 51 | + output_folder.mkdir(parents=True) |
| 52 | + with open(output_folder.joinpath("workflow.makeflow"), "w") as fp: |
| 53 | + fp.write(self._script) |
| 54 | + |
| 55 | + # additional files |
| 56 | + self._copy_binary_files(output_folder) |
| 57 | + self._generate_input_files(output_folder) |
| 58 | + |
| 59 | + # README file |
| 60 | + self._write_readme_file(output_folder) |
| 61 | + |
| 62 | + def _generate_code(self): |
| 63 | + """ |
| 64 | + Generate the Makeflow code |
| 65 | +
|
| 66 | + :return: the code |
| 67 | + :rtype: str |
| 68 | + """ |
| 69 | + self._script = "# Makeflow workflow specification\n\n" |
| 70 | + for task_name, task in self.workflow.tasks.items(): |
| 71 | + make_clause = "" |
| 72 | + # output files |
| 73 | + for output_file in task.output_files: |
| 74 | + make_clause += f"{output_file.file_id} " |
| 75 | + make_clause += ": " |
| 76 | + # input files |
| 77 | + for input_file in task.input_files: |
| 78 | + make_clause += f"{input_file.file_id} " |
| 79 | + make_clause += "\n" |
| 80 | + make_clause += "\t" |
| 81 | + make_clause += task.program + " " + " ".join(task.args) |
| 82 | + make_clause += "\n" |
| 83 | + self._script += make_clause + "\n\n" |
| 84 | + return |
| 85 | + |
| 86 | + # OLD CODE FOR TASK VINE... |
| 87 | + # args = [] |
| 88 | + # for a in task.args: |
| 89 | + # if "--output-files" in a: |
| 90 | + # args.append(f"--output-files {output_spec}") |
| 91 | + # elif "--input-files" in a: |
| 92 | + # args.append(f"--input-files {input_spec}") |
| 93 | + # else: |
| 94 | + # args.append(a) |
| 95 | + # args = " ".join(f"{a}" for a in args) |
| 96 | + |
| 97 | + |
| 98 | + def _write_readme_file(self, output_folder: pathlib.Path) -> None: |
| 99 | + """ |
| 100 | + Write the README file. |
| 101 | +
|
| 102 | + :param output_folder: The path of the output folder. |
| 103 | + :type output_folder: pathlib.Path |
| 104 | + """ |
| 105 | + readme_file_path = output_folder.joinpath("README") |
| 106 | + with open(readme_file_path, "w") as out: |
| 107 | + out.write(f"In directory {str(output_folder)}:\n") |
| 108 | + out.write(f" - The Makeflow input file: " |
| 109 | + f" workflow.makeflow\n") |
| 110 | + out.write(f" - Run the workflow: " |
| 111 | + f" makeflow workflow.makeflow\n") |
0 commit comments