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
|
# 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/>.
from typing import Callable, Optional
from unittest.mock import Mock
import pytest
from pytest import param
from cylc.flow.cycling import PointBase
from cylc.flow.cycling.integer import IntegerPoint
from cylc.flow.cycling.iso8601 import ISO8601Point
from cylc.flow.flow_mgr import FlowNums
from cylc.flow.id import Tokens
from cylc.flow.task_proxy import TaskProxy
from cylc.flow.taskdef import TaskDef
@pytest.mark.parametrize(
'itask_point, offset_str, expected',
[
param( # date -u -d 19700101 "+%s"
ISO8601Point('19700101T00Z'), 'PT0M', 0, id="zero epoch"
),
param( # 2025 is not a leap year: Jan 1 + P2M = P59D
ISO8601Point('20250101T00Z'), 'PT0M', 1735689600, id="nonleap base"
),
param(
ISO8601Point('20250101T00Z'), 'P59D', 1740787200, id="nonleap off1"
),
param(
ISO8601Point('20250101T00Z'), 'P2M', 1740787200, id="nonleap off2"
),
param( # 2024 is a leap year: Jan 1 + P2M = P60D
ISO8601Point('20240101T00Z'), 'PT0M', 1704067200, id="leap base"
),
param(
ISO8601Point('20240101T00Z'), 'P60D', 1709251200, id="leap off1"
),
param(
ISO8601Point('20240101T00Z'), 'P2M', 1709251200, id="leap off2"
),
]
)
def test_get_clock_trigger_time(
itask_point: PointBase,
offset_str: str,
expected: int,
set_cycling_type: Callable
) -> None:
"""Test get_clock_trigger_time() for exact and inexact offsets."""
set_cycling_type(itask_point.TYPE)
mock_itask = Mock(
point=itask_point.standardise(),
clock_trigger_times={}
)
assert TaskProxy.get_clock_trigger_time(
mock_itask, mock_itask.point, offset_str) == expected
@pytest.mark.parametrize(
'name_str, expected',
[('beer', True),
('FAM', True),
('root', True),
('horse', False),
('F*', True),
('*', True)]
)
def test_name_match(name_str: str, expected: bool):
"""Test TaskProxy.name_match().
For a task named "beer" in family "FAM".
"""
mock_tdef = Mock(namespace_hierarchy=['root', 'FAM', 'beer'])
mock_tdef.name = 'beer'
mock_itask = Mock(tdef=mock_tdef)
assert TaskProxy.name_match(mock_itask, name_str) is expected
@pytest.mark.parametrize(
'status_str, expected',
[param('waiting', True, id="Basic"),
param('w*', False, id="Globs don't work"),
param(None, True, id="None always matches")]
)
def test_status_match(status_str: Optional[str], expected: bool):
"""Test TaskProxy.status_match().
For a task with status "waiting".
"""
mock_itask = Mock(state=Mock(status='waiting'))
assert TaskProxy.status_match(mock_itask, status_str) is expected
@pytest.mark.parametrize('itask_flow_nums, flow_nums, expected', [
param({1, 2}, {2}, {2}, id="subset"),
param({2}, {1, 2}, {2}, id="superset"),
param({1, 2}, {3, 4}, set(), id="disjoint"),
param({1, 2}, set(), {1, 2}, id="all-matches-num"),
param(set(), {1, 2}, set(), id="num-doesnt-match-none"),
param(set(), set(), set(), id="all-doesnt-match-none"),
])
def test_match_flows(
itask_flow_nums: FlowNums, flow_nums: FlowNums, expected: FlowNums
):
mock_itask = Mock(flow_nums=itask_flow_nums)
assert TaskProxy.match_flows(mock_itask, flow_nums) == expected
def test_match_flows_copy():
"""Test that this method does not return the same reference as
itask.flow_nums, otherwise you could end up unexpectedly mutating
itask.flow_nums."""
mock_itask = Mock(flow_nums={1, 2})
result = TaskProxy.match_flows(mock_itask, set())
assert result == mock_itask.flow_nums
assert result is not mock_itask.flow_nums
def test_job_tokens():
itask = TaskProxy(
Tokens('wflow'),
TaskDef('foo', {}, None, None),
IntegerPoint('10'),
submit_num=3,
)
assert str(itask.job_tokens) == 'wflow//10/foo/03'
|