def test_search_install_source_dirs(
filename: str, expected_err: Optional[Tuple[Type[Exception], str]],
tmp_path: Path, mock_glbl_cfg: Callable):
"""Test search_install_source_dirs().
Params:
filename: A file to insert into one of the source dirs.
expected_err: Exception and message expected to be raised.
"""
horse_dir = Path(tmp_path, 'horse')
horse_dir.mkdir()
sheep_dir = Path(tmp_path, 'sheep')
source_dir = sheep_dir.joinpath('baa', 'baa')
source_dir.mkdir(parents=True)
source_dir_file = source_dir.joinpath(filename)
source_dir_file.touch()
mock_glbl_cfg(
'cylc.flow.workflow_files.glbl_cfg',
f'''
[install]
source dirs = {horse_dir}, {sheep_dir}
'''
)
if expected_err:
err, msg = expected_err
with pytest.raises(err) as exc:
search_install_source_dirs('baa/baa')
assert msg in str(exc.value)
else:
flow_file = search_install_source_dirs('baa/baa')
assert flow_file == source_dir
def test_search_install_source_dirs_empty(mock_glbl_cfg: Callable):
"""Test search_install_source_dirs() when no source dirs configured."""
mock_glbl_cfg(
'cylc.flow.workflow_files.glbl_cfg',
'''
[install]
source dirs =
'''
)
with pytest.raises(WorkflowFilesError) as exc:
search_install_source_dirs('foo')
assert str(exc.value) == (
"Cannot find workflow as 'global.cylc[install]source dirs' "
"does not contain any paths")
def install(
parser: COP, opts: 'Values', reg: Optional[str] = None
) -> None:
if opts.no_run_name and opts.run_name:
parser.error(
"options --no-run-name and --run-name are mutually exclusive.")
if reg is None:
source = opts.source
else:
if opts.source:
parser.error("REG and --directory are mutually exclusive.")
source = search_install_source_dirs(reg)
flow_name = opts.flow_name or reg
for entry_point in iter_entry_points(
'cylc.pre_configure'
):
try:
if source:
entry_point.resolve()(srcdir=source, opts=opts)
else:
from pathlib import Path
entry_point.resolve()(srcdir=Path().cwd(), opts=opts)
except Exception as exc:
# NOTE: except Exception (purposefully vague)
# this is to separate plugin from core Cylc errors
raise PluginError(
'cylc.pre_configure',
entry_point.name,
exc
) from None
source_dir, rundir, _flow_name = install_workflow(
flow_name=flow_name,
source=source,
run_name=opts.run_name,
no_run_name=opts.no_run_name,
no_symlinks=opts.no_symlinks
)
for entry_point in iter_entry_points(
'cylc.post_install'
):
try:
entry_point.resolve()(
srcdir=source_dir,
opts=opts,
rundir=str(rundir)
)
except Exception as exc:
# NOTE: except Exception (purposefully vague)
# this is to separate plugin from core Cylc errors
raise PluginError(
'cylc.post_install',
entry_point.name,
exc
) from None
def install(parser: COP, opts: 'Values', reg: Optional[str] = None) -> None:
if opts.no_run_name and opts.run_name:
raise UserInputError(
"options --no-run-name and --run-name are mutually exclusive.")
if reg is None:
source = opts.source
else:
if opts.source:
raise UserInputError(
"WORKFLOW_NAME and --directory are mutually exclusive.")
source = search_install_source_dirs(reg)
workflow_name = opts.workflow_name or reg
for entry_point in iter_entry_points('cylc.pre_configure'):
try:
if source:
entry_point.resolve()(srcdir=source, opts=opts)
else:
from pathlib import Path
entry_point.resolve()(srcdir=Path().cwd(), opts=opts)
except Exception as exc:
# NOTE: except Exception (purposefully vague)
# this is to separate plugin from core Cylc errors
raise PluginError('cylc.pre_configure', entry_point.name,
exc) from None
cli_symdirs: Optional[Dict[str, Dict[str, Any]]] = None
if opts.symlink_dirs == '':
cli_symdirs = {}
elif opts.symlink_dirs:
cli_symdirs = parse_cli_sym_dirs(opts.symlink_dirs)
source_dir, rundir, _workflow_name = install_workflow(
workflow_name=workflow_name,
source=source,
run_name=opts.run_name,
no_run_name=opts.no_run_name,
cli_symlink_dirs=cli_symdirs)
for entry_point in iter_entry_points('cylc.post_install'):
try:
entry_point.resolve()(srcdir=source_dir,
opts=opts,
rundir=str(rundir))
except Exception as exc:
# NOTE: except Exception (purposefully vague)
# this is to separate plugin from core Cylc errors
raise PluginError('cylc.post_install', entry_point.name,
exc) from None