diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0e7dd6c..d680f85 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -60,6 +60,7 @@ repos: - plumbum - pytest - pydantic + - types-PyYAML - repo: https://github.com/codespell-project/codespell rev: "v2.2.5" diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..b0f41c6 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,571 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold to be exceeded before program exits with error. +fail-under=10.0 + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the ignore-list. The +# regex matches against paths and can be in Posix or Windows format. +ignore-paths=^.*/fasthep_flow/_version.py$ + +# Files or directories matching the regex patterns are skipped. The regex +# matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.10 + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + import-outside-toplevel, + fixme, + super-init-not-called + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'error', 'warning', 'refactor', and 'convention' +# which contain the number of messages in each category, as well as 'statement' +# which is the total number of statements analyzed. This score is used by the +# global evaluation report (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=no + +# Signatures are removed from the similarity computation +ignore-signatures=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx= + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the 'python-enchant' package. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear and the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# class is considered mixin if its name matches the mixin-class-rgx option. +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins ignore-mixin- +# members is set to 'yes' +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +#notes-rgx= + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=BaseException, + Exception diff --git a/README.md b/README.md index 04f2f0f..8b2af1e 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,10 @@ ## Examples +```bash +fasthep-flow execute docs/examples/hello_world.yaml +``` + ## Contributing ## License diff --git a/mypy.ini b/mypy.ini index 7a35df0..7aace11 100644 --- a/mypy.ini +++ b/mypy.ini @@ -36,3 +36,7 @@ implicit_reexport = true [mypy-prefect.*] ignore_missing_imports = true implicit_reexport = true + +[mypy-prefect_dask.*] +ignore_missing_imports = true +implicit_reexport = true diff --git a/pyproject.toml b/pyproject.toml index 7514b5a..f3a8563 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -32,6 +32,7 @@ dependencies = [ "hydra-core", "plumbum", "prefect", + "prefect-dask", "pyyaml >=5.4", "omegaconf >=2.1", "typer >=0.4", diff --git a/src/fasthep_flow/_version.pyi b/src/fasthep_flow/_version.pyi index 91744f9..e232c84 100644 --- a/src/fasthep_flow/_version.pyi +++ b/src/fasthep_flow/_version.pyi @@ -1,3 +1,4 @@ +"""Type hints for the version module.""" from __future__ import annotations version: str diff --git a/src/fasthep_flow/cli.py b/src/fasthep_flow/cli.py index d80e737..1576bac 100644 --- a/src/fasthep_flow/cli.py +++ b/src/fasthep_flow/cli.py @@ -1,3 +1,4 @@ +"""Command line interface for fasthep-flow.""" from __future__ import annotations from pathlib import Path @@ -7,6 +8,7 @@ import typer from .config import FlowConfig, load_config +from .orchestration import prefect_workflow from .workflow import Workflow app = typer.Typer() @@ -43,7 +45,7 @@ def print_defaults() -> None: context_settings={"ignore_unknown_options": True, "allow_extra_args": True} ) def execute( - config: Path, overrides: Annotated[list[str] | None, typer.Argument()] = None + config: Path, overrides: Annotated[list[str] | None, typer.Argument([])] = None ) -> None: """Execute a config file.""" typer.echo(f"Executing {config}...") @@ -51,7 +53,10 @@ def execute( # initialize hydra cfg = init_config(config, overrides) workflow = Workflow(config=cfg) - workflow.run() + flow = prefect_workflow(workflow) + results = flow() + # results = workflow.run() + typer.echo(f"Results: {results}") @app.command("list") diff --git a/src/fasthep_flow/config.py b/src/fasthep_flow/config.py index 7243a97..2935dca 100644 --- a/src/fasthep_flow/config.py +++ b/src/fasthep_flow/config.py @@ -1,3 +1,5 @@ +"""Definitions for the configuration for describing the workflow.""" + from __future__ import annotations import importlib @@ -22,20 +24,21 @@ class StageConfig: @field_validator("type") @classmethod - def validate_type(cls, v: str) -> str: - """Validate the type field. Any specified type needs to be a Python class that can be imported""" + def validate_type(cls, value: str) -> str: + """Validate the type field + Any specified type needs to be a Python class that can be imported""" # Split the string to separate the module from the class name - module_path, class_name = v.rsplit(".", 1) + module_path, class_name = value.rsplit(".", 1) try: # Import the module mod = importlib.import_module(module_path) # this must be a class getattr(mod, class_name) - except ImportError as e: + except ImportError as previous_error: msg = f"Could not import {module_path}.{class_name}" - raise ValueError(msg) from e + raise ValueError(msg) from previous_error # Return the original string if everything is fine - return v + return value def resolve(self) -> Any: """Resolve the stage to a class.""" diff --git a/src/fasthep_flow/operators/__init__.py b/src/fasthep_flow/operators/__init__.py index 98e13d9..6af9d94 100644 --- a/src/fasthep_flow/operators/__init__.py +++ b/src/fasthep_flow/operators/__init__.py @@ -1,3 +1,4 @@ +"""Module for defining basic operators.""" from __future__ import annotations from .base import Operator diff --git a/src/fasthep_flow/operators/base.py b/src/fasthep_flow/operators/base.py index 60f92d5..7ef62b1 100644 --- a/src/fasthep_flow/operators/base.py +++ b/src/fasthep_flow/operators/base.py @@ -1,3 +1,4 @@ +"""Definition of the Operator protocol.""" from __future__ import annotations from typing import Any, Protocol @@ -5,7 +6,8 @@ class Operator(Protocol): """The base class for all operators. - Only named parameters are allowed, since we need to have a way to pass the YAML configuration to the operator. + Only named parameters are allowed, + since we need to have a way to pass the YAML configuration to the operator. """ def __call__(self, **kwargs: Any) -> dict[str, Any]: diff --git a/src/fasthep_flow/operators/bash.py b/src/fasthep_flow/operators/bash.py index 19eaed8..394dd1c 100644 --- a/src/fasthep_flow/operators/bash.py +++ b/src/fasthep_flow/operators/bash.py @@ -1,3 +1,4 @@ +"""Bash related operators.""" from __future__ import annotations from typing import Any diff --git a/src/fasthep_flow/orchestration.py b/src/fasthep_flow/orchestration.py new file mode 100644 index 0000000..4963fd7 --- /dev/null +++ b/src/fasthep_flow/orchestration.py @@ -0,0 +1,47 @@ +"""Orchestration module for the fasthep-flow package. +This module contains functions to convert a fasthep-flow workflow into various other workflows, +e.g. Prefect, NetworkX, etc., to either execute them or visualize them. +""" + +from __future__ import annotations + +from typing import Any + +from .workflow import Workflow + + +def get_runner(runner: str) -> Any: + """Get the task runner for the given name.""" + from prefect.task_runners import ConcurrentTaskRunner, SequentialTaskRunner + from prefect_dask import DaskTaskRunner + + runners: dict[str, Any] = { + "Dask": DaskTaskRunner, + "Sequential": SequentialTaskRunner, + "Concurrent": ConcurrentTaskRunner, + } + + return runners[runner] + + +def prefect_workflow(workflow: Workflow) -> Any: + """Convert a workflow into a Prefect flow.""" + from prefect import Flow, Task + + def prefect_wrapper() -> Any: + """Function to execute all tasks in the workflow.""" + for task in workflow.tasks: + # TODO: add subflows + prefect_task = Task(task.payload, name=task.name) + prefect_task() + + return Flow( + prefect_wrapper, + name="config name", + flow_run_name="fasthep-flow", + version="0.0.1", + ) + + +# def networkx_workflow(workflow: Workflow): +# """Convert a workflow into a networkx directed graph.""" diff --git a/src/fasthep_flow/workflow.py b/src/fasthep_flow/workflow.py index 6b160d1..885172f 100644 --- a/src/fasthep_flow/workflow.py +++ b/src/fasthep_flow/workflow.py @@ -1,43 +1,50 @@ +"""Workflow and Task classes to define and execute a compute graph.""" from __future__ import annotations +from dataclasses import dataclass from typing import Any from .config import FlowConfig +@dataclass +class Task: + """Wrapper for any compute task implementation we want to support.""" + + name: str + type: str + kwargs: dict[str, Any] + payload: Any + + def __call__(self) -> Any: + return self.payload() + + +@dataclass class Workflow: - """Wrapper for any compute graph implementation we want to support. Currently using Prefect.""" + """Wrapper for any compute graph implementation we want to support.""" - tasks: list[ - Any - ] # this should be prefect.Task, but that's not working with pydantic v2 for now + tasks: list[Task] # TODO: Maybe this should be an OrderedDict def __init__(self, config: FlowConfig) -> None: - from prefect import Task # pylint: disable=import-outside-toplevel - stages = config.stages self.tasks = [] for stage in stages: self.tasks.append( Task( - stage.resolve(), name=stage.name, + type=stage.type, + kwargs=stage.kwargs if stage.kwargs is not None else {}, + payload=stage.resolve() if hasattr(stage, "resolve") else None, + # TODO: pass information about the task's dependencies and execution environment ) ) - def __call__(self) -> None: + def __call__(self) -> Any: + """Function to execute all tasks in the workflow.""" + for task in self.tasks: + yield task.payload() + + def run(self) -> Any: """Function to execute all tasks in the workflow.""" - for t in self.tasks: - t() - - def run(self) -> None: - """Function to execute the workflow. Wraps __call__ to convert the workflow into a Prefect flow.""" - from prefect import Flow # pylint: disable=import-outside-toplevel - - f = Flow( - self.__call__, - name="config name", - flow_run_name="fasthep-flow", - version="0.0.1", - ) - f() + return list(self()) diff --git a/tests/conftest.py b/tests/conftest.py index b62ccf6..7e27fa0 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,8 +1,10 @@ from __future__ import annotations from pathlib import Path +from typing import Any import pytest +import yaml current_dir = Path(__file__).parent @@ -16,3 +18,8 @@ def simple_config_yaml() -> Path: def simple_config(simple_config_yaml) -> str: with Path.open(simple_config_yaml, "r") as file: return file.read() + + +@pytest.fixture() +def simple_dict_config(simple_config) -> Any: + return yaml.safe_load(simple_config) diff --git a/tests/test_workflow.py b/tests/test_workflow.py new file mode 100644 index 0000000..9682b9a --- /dev/null +++ b/tests/test_workflow.py @@ -0,0 +1,31 @@ +from __future__ import annotations + +import pytest + +from fasthep_flow import FlowConfig, Workflow + + +@pytest.fixture() +def config(simple_dict_config): + return FlowConfig.from_dictconfig(simple_dict_config) + + +def test_create_workflow(config): + workflow = Workflow(config=config) + assert workflow.tasks + assert len(workflow.tasks) == 1 + task = workflow.tasks[0] + assert task.name == "printEcho" + assert task.type == "fasthep_flow.operators.BashOperator" + params = task.kwargs + assert params["bash_command"] == "echo" + assert params["arguments"] == ["Hello World!"] + + +def test_run_workflow(config): + workflow = Workflow(config=config) + results = workflow.run() + assert results + assert len(results) == 1 + result = results[0] + assert result["stdout"] == "Hello World!\n"