-
Notifications
You must be signed in to change notification settings - Fork 105
/
test_examples.py
179 lines (148 loc) · 6.72 KB
/
test_examples.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
import importlib
import os
import pkgutil
import sys
from pathlib import Path
from typing import Dict, List
import examples.workflows as hera_examples
import examples.workflows.upstream as hera_upstream_examples
import pytest
import requests
import yaml
from hera.workflows import (
CronWorkflow as HeraCronWorkflow,
Workflow as HeraWorkflow,
WorkflowTemplate as HeraWorkflowTemplate,
)
from hera.workflows.models import (
CronWorkflow as ModelCronWorkflow,
Workflow as ModelWorkflow,
WorkflowTemplate as ModelWorkflowTemplate,
)
from hera.workflows.script import InlineScriptConstructor
ARGO_EXAMPLES_URL = "https://github.com/argoproj/argo-workflows/main/examples"
HERA_REGENERATE = os.environ.get("HERA_REGENERATE")
CI_MODE = os.environ.get("CI")
LOWEST_SUPPORTED_PY_VERSION = (3, 9)
def _generate_yaml(path: Path) -> bool:
if sys.version_info[0] == LOWEST_SUPPORTED_PY_VERSION[0] and sys.version_info[1] > LOWEST_SUPPORTED_PY_VERSION[1]:
# Generate yamls on lowest supported python version only
return False
if CI_MODE:
return False
if HERA_REGENERATE:
return True
return not path.exists()
def _transform_workflow(obj):
w = ModelWorkflow.parse_obj(obj)
w.metadata.annotations = {}
w.metadata.labels = {}
if w.spec.templates is not None:
w.spec.templates.sort(key=lambda t: t.name)
for t in w.spec.templates:
if t.script:
t.script.source = InlineScriptConstructor._roundtrip(t.script.source)
return w.dict()
def _transform_workflow_template(obj):
w = ModelWorkflowTemplate.parse_obj(obj)
w.metadata.annotations = {}
w.metadata.labels = {}
if w.spec.templates is not None:
w.spec.templates.sort(key=lambda t: t.name)
for t in w.spec.templates:
if t.script:
t.script.source = InlineScriptConstructor._roundtrip(t.script.source)
return w.dict()
def _transform_cron_workflow(obj):
wt = ModelCronWorkflow.parse_obj(obj)
wt.spec.workflow_spec.templates.sort(key=lambda t: t.name)
wt.metadata.annotations = {}
wt.metadata.labels = {}
for t in wt.spec.workflow_spec.templates:
if t.script:
t.script.source = InlineScriptConstructor._roundtrip(t.script.source)
return wt.dict()
def _compare_workflows(hera_workflow, w1: Dict, w2: Dict):
if isinstance(hera_workflow, HeraCronWorkflow):
assert _transform_cron_workflow(w1) == _transform_cron_workflow(w2)
elif isinstance(hera_workflow, HeraWorkflowTemplate):
assert _transform_workflow_template(w1) == _transform_workflow_template(w2)
elif isinstance(hera_workflow, HeraWorkflow):
assert _transform_workflow(w1) == _transform_workflow(w2)
else:
assert False, f"Unsupported workflow type {hera_workflow}"
def _get_examples() -> List:
"""Return tuple of example's parent path, its full module and its filename (without ".py")."""
modules = [
(filefinder.path, module)
for filefinder, module, ispkg in pkgutil.walk_packages(hera_examples.__path__, hera_examples.__name__ + ".")
if not ispkg
]
return [(path, module, module.split(".")[-1]) for path, module in modules if "upstream" not in module]
@pytest.mark.parametrize(
"path,module_name,filename",
[
pytest.param(
path,
module_name,
filename,
id=filename,
)
for path, module_name, filename in _get_examples()
],
)
def test_hera_output(path, module_name, filename, global_config_fixture):
# GIVEN
global_config_fixture.host = "http://hera.testing"
workflow = importlib.import_module(module_name).w
generated_yaml_path = Path(path) / f"{filename.replace('_', '-')}.yaml"
# WHEN
output = workflow.to_dict()
# THEN
if _generate_yaml(generated_yaml_path):
generated_yaml_path.write_text(yaml.dump(output, sort_keys=False, default_flow_style=False))
# Check there have been no regressions from the generated yaml committed in the repo
assert generated_yaml_path.exists()
_compare_workflows(workflow, output, yaml.safe_load(generated_yaml_path.read_text()))
if isinstance(workflow, HeraWorkflowTemplate):
assert workflow == HeraWorkflowTemplate.from_dict(workflow.to_dict())
assert workflow == HeraWorkflowTemplate.from_yaml(workflow.to_yaml())
elif isinstance(workflow, HeraCronWorkflow):
assert workflow == HeraCronWorkflow.from_dict(workflow.to_dict())
assert workflow == HeraCronWorkflow.from_yaml(workflow.to_yaml())
elif isinstance(workflow, HeraWorkflow):
assert workflow == HeraWorkflow.from_dict(workflow.to_dict())
assert workflow == HeraWorkflow.from_yaml(workflow.to_yaml())
@pytest.mark.parametrize("module_name", [name for _, name, _ in pkgutil.iter_modules(hera_upstream_examples.__path__)])
def test_hera_output_upstream(module_name, global_config_fixture):
# GIVEN
global_config_fixture.host = "http://hera.testing"
workflow = importlib.import_module(f"examples.workflows.upstream.{module_name}").w
generated_yaml_path = Path(hera_upstream_examples.__file__).parent / f"{module_name.replace('_', '-')}.yaml"
upstream_yaml_path = (
Path(hera_upstream_examples.__file__).parent / f"{module_name.replace('_', '-')}.upstream.yaml"
)
# WHEN
output = workflow.to_dict()
# THEN - generate the yaml if HERA_REGENERATE or it does not exist
if _generate_yaml(generated_yaml_path):
generated_yaml_path.write_text(yaml.dump(output, sort_keys=False, default_flow_style=False))
if _generate_yaml(upstream_yaml_path):
upstream_yaml_path.write_text(
requests.get(f"{ARGO_EXAMPLES_URL}/{module_name.replace('__', '/').replace('_', '-')}.yaml").text
)
# Check there have been no regressions from the generated yaml
assert generated_yaml_path.exists()
_compare_workflows(workflow, output, yaml.safe_load(generated_yaml_path.read_text()))
# Check there have been no regressions with the upstream source
assert upstream_yaml_path.exists()
_compare_workflows(workflow, output, yaml.safe_load(upstream_yaml_path.read_text()))
if isinstance(workflow, HeraWorkflowTemplate):
assert workflow == HeraWorkflowTemplate.from_dict(workflow.to_dict())
assert workflow == HeraWorkflowTemplate.from_yaml(workflow.to_yaml())
elif isinstance(workflow, HeraCronWorkflow):
assert workflow == HeraCronWorkflow.from_dict(workflow.to_dict())
assert workflow == HeraCronWorkflow.from_yaml(workflow.to_yaml())
elif isinstance(workflow, HeraWorkflow):
assert workflow == HeraWorkflow.from_dict(workflow.to_dict())
assert workflow == HeraWorkflow.from_yaml(workflow.to_yaml())