def test_housekeeping_with_xtrigger_satisfied():
"""The housekeeping method makes sure only satisfied xtrigger function
are kept."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
xtrig = SubFuncContext(label="get_name",
func_name="get_name",
func_args=[],
func_kwargs={})
xtrigger_mgr.add_trig("get_name", xtrig)
xtrig.out = "[\"True\", {\"name\": \"Yossarian\"}]"
tdef = TaskDef(name="foo",
rtcfg=None,
run_mode="live",
start_point=1,
spawn_ahead=False)
tdef.xtrig_labels.add("get_name")
start_point = ISO8601Point('20000101T0000+05')
itask = TaskProxy(tdef=tdef, start_point=start_point)
xtrigger_mgr.collate([itask])
# pretend the function has been activated
xtrigger_mgr.active.append(xtrig.get_signature())
xtrigger_mgr.callback(xtrig)
assert xtrigger_mgr.sat_xtrig
xtrigger_mgr.housekeep()
# here we still have the same number as before
assert xtrigger_mgr.sat_xtrig
# however, we have no xclock trigger satisfied
assert not xtrigger_mgr.sat_xclock
def test_satisfy_xclock_unsatisfied_xclock():
"""Test satisfy_xclock for an unsatisfied clock trigger."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
# the clock xtrigger
xtrig = SubFuncContext(label="wall_clock",
func_name="wall_clock",
func_args=[],
func_kwargs={})
xtrig.out = "[\"True\", \"1\"]"
xtrigger_mgr.add_clock("wall_clock", xtrig)
# create a task
tdef = TaskDef(name="foo",
rtcfg=None,
run_mode="live",
start_point=1,
spawn_ahead=False)
tdef.xclock_label = "wall_clock"
# cycle point for task proxy
init()
start_point = ISO8601Point('20000101T0000+05')
# create task proxy
itask = TaskProxy(tdef=tdef, start_point=start_point)
itask.state.xclock = "wall_clock", False # satisfied?
# we are defining in the state of the TaskProxy. that its xclock trigger
# has **not** been satisfied.
assert not xtrigger_mgr.sat_xclock
xtrigger_mgr.satisfy_xclock(itask)
# as it was satisfied by the satisfy_clock function, we must have its
# signature in the dict. NB the signature is not the same as
# get_signature(), as it is actually the signature for that moment
# when it was satisfied.
assert xtrigger_mgr.sat_xclock
def test_satisfy_xclock_satisfied_xclock():
"""Test satisfy_xclock for a satisfied clock trigger."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
# the clock xtrigger
xtrig = SubFuncContext(label="wall_clock",
func_name="wall_clock",
func_args=[],
func_kwargs={})
xtrig.out = "[\"True\", \"1\"]"
xtrigger_mgr.add_clock("wall_clock", xtrig)
# create a task
tdef = TaskDef(name="foo",
rtcfg=None,
run_mode="live",
start_point=1,
spawn_ahead=False)
tdef.xclock_label = "wall_clock"
# cycle point for task proxy
init()
start_point = ISO8601Point('20000101T0000+05')
# create task proxy
itask = TaskProxy(tdef=tdef, start_point=start_point)
itask.state.xclock = "wall_clock", True # satisfied?
# we are defining in the state of the TaskProxy. that its xclock trigger
# has been satisfied, without actually adding it to the right dict.
assert not xtrigger_mgr.sat_xclock
xtrigger_mgr.satisfy_xclock(itask)
# as it was already satisfied, the function should return immediately,
# without touching sat_xclock, therefore, it must remain empty
assert not xtrigger_mgr.sat_xclock
def test_housekeeping_with_xclock_satisfied():
"""The housekeeping method makes sure only satisfied xclock function
are kept."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
# the clock xtrigger
xtrig = SubFuncContext(label="wall_clock",
func_name="wall_clock",
func_args=[],
func_kwargs={})
xtrig.out = "[\"True\", \"1\"]"
xtrigger_mgr.add_clock("wall_clock", xtrig)
# create a task
tdef = TaskDef(name="foo",
rtcfg=None,
run_mode="live",
start_point=1,
spawn_ahead=False)
tdef.xclock_label = "wall_clock"
# cycle point for task proxy
# TODO: we need to call init, before we can use ISO8601 points in Cylc,
# why?
init()
start_point = ISO8601Point('20000101T0000+05')
# create task proxy
itask = TaskProxy(tdef=tdef, start_point=start_point)
itask.state.xclock = "wall_clock", False # satisfied?
# satisfy xclock
xtrigger_mgr.satisfy_xclock(itask)
# tally
xtrigger_mgr.collate([itask])
assert xtrigger_mgr.sat_xclock
xtrigger_mgr.housekeep()
# here we still have the same number as before
assert xtrigger_mgr.sat_xclock
def test_constructor():
"""Test creating a XtriggerManager, and its initial state."""
xtrigger_mgr = XtriggerManager(suite="suitea", user="******")
# the dict with clock xtriggers starts empty
assert not xtrigger_mgr.clockx_map
# the dict with normal xtriggers starts empty
assert not xtrigger_mgr.functx_map
def test_load_invalid_xtrigger_for_restart():
"""Test loading an invalid xtrigger for restart.
It simulates that the DB has a value that is not valid JSON.
"""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
row = "get_name", "{name: \"function\"}" # missing double quotes
with pytest.raises(ValueError):
xtrigger_mgr.load_xtrigger_for_restart(row_idx=0, row=row)
def test_load_xtrigger_for_restart():
"""Test loading a xtrigger for restart.
The function is loaded from database, where the value is formatted
as JSON."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
row = "get_name", "{\"name\": \"function\"}"
xtrigger_mgr.load_xtrigger_for_restart(row_idx=0, row=row)
assert xtrigger_mgr.sat_xtrig["get_name"]["name"] == "function"
def xtrigger_mgr() -> XtriggerManager:
"""A fixture to build an XtriggerManager which uses a mocked proc_pool,
and uses a mocked broadcast_mgr."""
return XtriggerManager(
suite="sample_suite",
user="******",
proc_pool=Mock(put_command=lambda *a, **k: True),
broadcast_mgr=Mock(put_broadcast=lambda *a, **k: True),
data_store_mgr=DataStoreMgr(create_autospec(Scheduler)))
def xtrigger_mgr() -> XtriggerManager:
"""A fixture to build an XtriggerManager that ignores validation.
Returns:
XtriggerManager: an XtriggerManager that ignores validation
"""
xtrigger_mgr = XtriggerManager(suite="suitea", user="******")
xtrigger_mgr.validate_xtrigger = lambda fn, fdir: True
return xtrigger_mgr
def test_add_xtrigger():
"""Test for adding a xtrigger."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
xtrig = SubFuncContext(label="echo",
func_name="echo",
func_args=["name", "age"],
func_kwargs={"location": "soweto"})
xtrigger_mgr.add_trig("xtrig", xtrig)
assert xtrig == xtrigger_mgr.functx_map["xtrig"]
def test_check_xtriggers():
"""Test check_xtriggers call.
check_xtriggers does pretty much the same as collate. The
difference is that besides tallying on all the xtriggers and
clock xtriggers available, it then proceeds to trying to
satisfy them."""
xtrigger_mgr = XtriggerManager(suite="sample_suite",
user="******",
proc_pool=MockedProcPool())
# add a xtrigger
# that will cause all_xtrig to be populated, but not all_xclock
get_name = SubFuncContext(label="get_name",
func_name="get_name",
func_args=[],
func_kwargs={})
xtrigger_mgr.add_trig("get_name", get_name)
get_name.out = "[\"True\", {\"name\": \"Yossarian\"}]"
tdef1 = TaskDef(name="foo",
rtcfg=None,
run_mode="live",
start_point=1,
spawn_ahead=False)
tdef1.xtrig_labels.add("get_name")
start_point = ISO8601Point('20000101T0000+05')
itask1 = TaskProxy(tdef=tdef1, start_point=start_point)
itask1.state.xtriggers["get_name"] = False # satisfied?
# add a clock xtrigger
# that will cause both all_xclock to be populated but not all_xtrig
wall_clock = SubFuncContext(label="wall_clock",
func_name="wall_clock",
func_args=[],
func_kwargs={})
wall_clock.out = "[\"True\", \"1\"]"
xtrigger_mgr.add_clock("wall_clock", wall_clock)
# create a task
tdef2 = TaskDef(name="foo",
rtcfg=None,
run_mode="live",
start_point=1,
spawn_ahead=False)
tdef2.xclock_label = "wall_clock"
init()
start_point = ISO8601Point('20000101T0000+05')
# create task proxy
itask2 = TaskProxy(tdef=tdef2, start_point=start_point)
itask2.state.xclock = "wall_clock", False # satisfied?
xtrigger_mgr.check_xtriggers([itask1, itask2])
assert xtrigger_mgr.sat_xclock
assert xtrigger_mgr.all_xclock
# won't be satisfied, as it is async, we are are not calling callback
assert not xtrigger_mgr.sat_xtrig
assert xtrigger_mgr.all_xtrig
def test_add_xtrigger_with_params():
"""Test for adding a xtrigger."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
xtrig = SubFuncContext(
label="echo",
func_name="echo",
func_args=["name", "%(point)s"],
func_kwargs={"%(location)s": "soweto"} # no problem with the key!
)
xtrigger_mgr.add_trig("xtrig", xtrig)
assert xtrig == xtrigger_mgr.functx_map["xtrig"]
def test_add_clock_xtrigger():
"""Test for adding a clock xtrigger. Clock xtriggers go to a different
dict than normal xtriggers. This is useful as the execution varies
for clock/non-clock xtriggers (e.g. sync vs. async)."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
xtrig = SubFuncContext(label="wall_clock",
func_name="wall_clock",
func_args=[],
func_kwargs={})
xtrigger_mgr.add_clock("xtrig", xtrig)
assert xtrig == xtrigger_mgr.clockx_map["xtrig"]
def test_callback():
"""Test callback."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
get_name = SubFuncContext(label="get_name",
func_name="get_name",
func_args=[],
func_kwargs={})
get_name.out = "[\"True\", \"1\"]"
xtrigger_mgr.active.append(get_name.get_signature())
xtrigger_mgr.callback(get_name)
# this means that the xtrigger was satisfied
assert xtrigger_mgr.sat_xtrig
def test_callback_not_active():
"""Test callback with no active contexts."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
# calling callback with a SubFuncContext with none active
# results in a ValueError
get_name = SubFuncContext(label="get_name",
func_name="get_name",
func_args=[],
func_kwargs={})
with pytest.raises(ValueError):
xtrigger_mgr.callback(get_name)
def test_collate():
"""Test that collate properly tallies the totals of current xtriggers."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
xtrigger_mgr.collate(itasks=[])
assert not xtrigger_mgr.all_xclock
assert not xtrigger_mgr.all_xtrig
# add a xtrigger
# that will cause all_xtrig to be populated, but not all_xclock
get_name = SubFuncContext(label="get_name",
func_name="get_name",
func_args=[],
func_kwargs={})
xtrigger_mgr.add_trig("get_name", get_name)
get_name.out = "[\"True\", {\"name\": \"Yossarian\"}]"
tdef = TaskDef(name="foo",
rtcfg=None,
run_mode="live",
start_point=1,
spawn_ahead=False)
tdef.xtrig_labels.add("get_name")
start_point = ISO8601Point('20000101T0000+05')
itask = TaskProxy(tdef=tdef, start_point=start_point)
itask.state.xtriggers["get_name"] = get_name
xtrigger_mgr.collate([itask])
assert not xtrigger_mgr.all_xclock
assert xtrigger_mgr.all_xtrig
# add a clock xtrigger
# that will cause both all_xclock to be populated but not all_xtrig
wall_clock = SubFuncContext(label="wall_clock",
func_name="wall_clock",
func_args=[],
func_kwargs={})
wall_clock.out = "[\"True\", \"1\"]"
xtrigger_mgr.add_clock("wall_clock", wall_clock)
# create a task
tdef = TaskDef(name="foo",
rtcfg=None,
run_mode="live",
start_point=1,
spawn_ahead=False)
tdef.xclock_label = "wall_clock"
init()
start_point = ISO8601Point('20000101T0000+05')
# create task proxy
itask = TaskProxy(tdef=tdef, start_point=start_point)
itask.state.xclock = "wall_clock", True
xtrigger_mgr.collate([itask])
assert xtrigger_mgr.all_xclock
assert not xtrigger_mgr.all_xtrig
def xtrigger_mgr_procpool() -> XtriggerManager:
"""A fixture to build an XtriggerManager that ignores validation,
and uses a mocked proc_pool.
Returns:
XtriggerManager: an XtriggerManager that ignores validation and
uses a mocked proc_pool
"""
xtrigger_mgr = XtriggerManager(suite="suitea",
user="******",
proc_pool=MockedProcPool())
xtrigger_mgr.validate_xtrigger = lambda fn, fdir: True
return xtrigger_mgr
def test_housekeeping_nothing_satisfied():
"""The housekeeping method makes sure only satisfied xtrigger function
are kept."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
row = "get_name", "{\"name\": \"function\"}"
# now XtriggerManager#sat_xtrigger will contain the get_name xtrigger
xtrigger_mgr.load_xtrigger_for_restart(row_idx=0, row=row)
# but we have nothing in the XtriggerManager#all_xclock, which means
# nothing was satisfied yet
xtrigger_mgr.all_xclock.clear()
assert xtrigger_mgr.sat_xtrig
xtrigger_mgr.housekeep()
assert not xtrigger_mgr.sat_xtrig
def test_callback_invalid_json():
"""Test callback with invalid JSON."""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
get_name = SubFuncContext(label="get_name",
func_name="get_name",
func_args=[],
func_kwargs={})
get_name.out = "{no_quotes: \"mom!\"}"
xtrigger_mgr.active.append(get_name.get_signature())
xtrigger_mgr.callback(get_name)
# this means that the xtrigger was not satisfied
# TODO: this means site admins are only aware of this if they
# look at the debug log. Is that OK?
assert not xtrigger_mgr.sat_xtrig
def xtrigger_mgr_procpool_broadcast() -> XtriggerManager:
"""A fixture to build an XtriggerManager that ignores validation,
uses a mocked proc_pool, and uses a mocked broadacast_mgr.
Returns:
XtriggerManager: an XtriggerManager that ignores validation,
uses a mocked proc_pool, and uses a mocked broadacast_mgr
"""
xtrigger_mgr = XtriggerManager(suite="sample_suite",
user="******",
proc_pool=MockedProcPool(),
broadcast_mgr=MockedBroadcastMgr(
suite_db_mgr=None, data_store_mgr=None))
xtrigger_mgr.validate_xtrigger = lambda fn, fdir: True
return xtrigger_mgr
def test_add_xtrigger_with_unkonwn_params():
"""Test for adding a xtrigger with an unknown parameter.
The XTriggerManager contains a list of specific parameters that are
available in the function template.
Values that are not strings raise a TypeError during regex matching, but
are ignored, so we should not have any issue with TypeError.
If a value in the format %(foo)s appears in the parameters, and 'foo'
is not in this list of parameters, then a ValueError is expected.
"""
xtrigger_mgr = XtriggerManager(suite="sample_suite", user="******")
xtrig = SubFuncContext(label="echo",
func_name="echo",
func_args=[1, "name", "%(what_is_this)s"],
func_kwargs={"location": "soweto"})
with pytest.raises(ValueError):
xtrigger_mgr.add_trig("xtrig", xtrig)
# TODO: is it intentional? At the moment when we fail to validate the
# function parameters, we add it to the dict anyway.
assert xtrigger_mgr.functx_map["xtrig"] == xtrig
def test_satisfy_xtrigger():
"""Test satisfy_xtriggers"""
# the XtriggerManager instance
xtrigger_mgr = XtriggerManager(
suite="sample_suite",
user="******",
proc_pool=MockedProcPool(),
broadcast_mgr=MockedBroadcastMgr(suite_db_mgr=None))
# the echo1 xtrig (not satisfied)
echo1_xtrig = SubFuncContext(label="echo1",
func_name="echo1",
func_args=[],
func_kwargs={})
echo1_xtrig.out = "[\"True\", {\"name\": \"herminia\"}]"
xtrigger_mgr.add_trig("echo1", echo1_xtrig)
# the echo2 xtrig (satisfied through callback later)
echo2_xtrig = SubFuncContext(label="echo2",
func_name="echo2",
func_args=[],
func_kwargs={})
echo2_xtrig.out = "[\"True\", {\"name\": \"herminia\"}]"
xtrigger_mgr.add_trig("echo2", echo2_xtrig)
# create a task
tdef = TaskDef(name="foo",
rtcfg=None,
run_mode="live",
start_point=1,
spawn_ahead=False)
tdef.xtrig_labels.add("echo1")
tdef.xtrig_labels.add("echo2")
# cycle point for task proxy
init()
start_point = ISO8601Point('20000101T0000+05')
# create task proxy
itask = TaskProxy(tdef=tdef, start_point=start_point)
# we start with no satisfied xtriggers, and nothing active
assert len(xtrigger_mgr.sat_xtrig) == 0
assert len(xtrigger_mgr.active) == 0
# after calling satisfy_xtriggers the first time, we get two active
xtrigger_mgr.satisfy_xtriggers(itask)
assert len(xtrigger_mgr.sat_xtrig) == 0
assert len(xtrigger_mgr.active) == 2
# calling satisfy_xtriggers again does not change anything
xtrigger_mgr.satisfy_xtriggers(itask)
assert len(xtrigger_mgr.sat_xtrig) == 0
assert len(xtrigger_mgr.active) == 2
# now we call callback manually as the proc_pool we passed is a mock
# then both should be satisfied
xtrigger_mgr.callback(echo1_xtrig)
xtrigger_mgr.callback(echo2_xtrig)
# so both were satisfied, and nothing is active
assert len(xtrigger_mgr.sat_xtrig) == 2
assert len(xtrigger_mgr.active) == 0
# calling satisfy_xtriggers again still does not change anything
xtrigger_mgr.satisfy_xtriggers(itask)
assert len(xtrigger_mgr.sat_xtrig) == 2
assert len(xtrigger_mgr.active) == 0