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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
# THIS FILE IS PART OF THE CYLC WORKFLOW ENGINE.
# Copyright (C) NIWA & British Crown (Met Office) & Contributors.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""Test cylc install."""
import pytest
from pathlib import Path
from typing import Callable, Tuple
from cylc.flow.async_util import pipe
from cylc.flow.scripts import scan
from cylc.flow.workflow_files import WorkflowFiles
from cylc.flow.scripts.install import (
InstallOptions,
install_cli
)
from .network.test_scan import init_flows
from .utils.entry_points import EntryPointWrapper
SRV_DIR = Path(WorkflowFiles.Service.DIRNAME)
CONTACT = Path(WorkflowFiles.Service.CONTACT)
RUN_N = Path(WorkflowFiles.RUN_N)
INSTALL = Path(WorkflowFiles.Install.DIRNAME)
INSTALLED_MSG = "INSTALLED {wfrun} from"
WF_ACTIVE_MSG = '1 run of "{wf}" is already active:'
BAD_CONTACT_MSG = "Bad contact file:"
@pytest.fixture()
def patch_graphql_query(
monkeypatch: pytest.MonkeyPatch
):
# Define a mocked graphql_query pipe function.
@pipe
async def _graphql_query(flow, fields, filters=None):
flow.update({"status": "running"})
return flow
# Swap out the function that cylc.flow.scripts.scan.
monkeypatch.setattr(
'cylc.flow.scripts.scan.graphql_query',
_graphql_query,
)
@pytest.fixture()
def src_run_dirs(
mock_glbl_cfg: Callable,
monkeypatch: pytest.MonkeyPatch,
tmp_path: Path
) -> Tuple[Path, Path]:
"""Create some workflow source and run dirs for testing.
Source dirs:
<tmp-src>/w1
<tmp-src>/w2
Run dir:
<tmp-run>/w1/run1
"""
tmp_src_path = tmp_path / 'cylc-src'
tmp_run_path = tmp_path / 'cylc-run'
tmp_src_path.mkdir()
tmp_run_path.mkdir()
init_flows(
tmp_run_path=tmp_run_path,
running=('w1/run1',),
tmp_src_path=tmp_src_path,
src=('w1', 'w2')
)
mock_glbl_cfg(
'cylc.flow.install.glbl_cfg',
f'''
[install]
source dirs = {tmp_src_path}
'''
)
monkeypatch.setattr('cylc.flow.pathutil._CYLC_RUN_DIR', tmp_run_path)
return tmp_src_path, tmp_run_path
async def test_install_scan_no_ping(
src_run_dirs: Tuple[Path, Path],
capsys: pytest.CaptureFixture,
caplog: pytest.LogCaptureFixture
) -> None:
"""At install, running intances should be reported.
Ping = False case: don't query schedulers.
"""
opts = InstallOptions()
opts.no_ping = True
await install_cli(opts, id_='w1')
out = capsys.readouterr().out
assert INSTALLED_MSG.format(wfrun='w1/run2') in out
assert WF_ACTIVE_MSG.format(wf='w1') in out
# Empty contact file faked with "touch":
assert f"{BAD_CONTACT_MSG} w1/run1" in caplog.text
await install_cli(opts, id_='w2')
out = capsys.readouterr().out
assert WF_ACTIVE_MSG.format(wf='w2') not in out
assert INSTALLED_MSG.format(wfrun='w2/run1') in out
async def test_install_scan_ping(
src_run_dirs: Tuple[Path, Path],
capsys: pytest.CaptureFixture,
caplog: pytest.LogCaptureFixture,
patch_graphql_query: Callable
) -> None:
"""At install, running intances should be reported.
Ping = True case: but mock scan's scheduler query method.
"""
opts = InstallOptions()
opts.no_ping = False
await install_cli(opts, id_='w1')
out = capsys.readouterr().out
assert INSTALLED_MSG.format(wfrun='w1/run2') in out
assert WF_ACTIVE_MSG.format(wf='w1') in out
assert scan.FLOW_STATE_SYMBOLS["running"] in out
# Empty contact file faked with "touch":
assert f"{BAD_CONTACT_MSG} w1/run1" in caplog.text
await install_cli(opts, id_='w2')
out = capsys.readouterr().out
assert INSTALLED_MSG.format(wfrun='w2/run1') in out
assert WF_ACTIVE_MSG.format(wf='w2') not in out
async def test_install_gets_back_compat_mode_for_plugins(
src_run_dirs: Tuple[Path, Path],
monkeypatch: pytest.MonkeyPatch,
capcall,
capsys: pytest.CaptureFixture,
):
"""Assert that cylc install will detect whether a workflow
should use back compat mode _before_ running pre_configure plugins
so that those plugins can use that information.
"""
# track calls of the check_deprecation method
# (this is the thing that sets cylc.flow.flags.back_compat)
check_deprecation_calls = capcall(
'cylc.flow.scripts.install.check_deprecation'
)
@EntryPointWrapper
def failIfDeprecated(*args, **kwargs):
"""A fake Cylc Plugin entry point"""
# print the number of times the check_deprecation method has been
# called
print(f'CALLS={len(check_deprecation_calls)}')
# return a blank result
return {
'env': {},
'template_variables': {},
}
# Monkeypatch our fake entry point into iter_entry_points:
monkeypatch.setattr(
'cylc.flow.plugins.iter_entry_points',
lambda namespace: (
[failIfDeprecated] if namespace == 'cylc.pre_configure' else []
)
)
# install the workflow
opts = InstallOptions()
await install_cli(opts, id_='w1')
# ensure the check_deprecation method was called before the plugin was run
assert 'CALLS=1' in capsys.readouterr()[0]
|
