def _post_signal_tokens(self):
"""Add some signal tokens to the master."""
request = ModifyRequest(updates=[])
signal = Signal(action=Signal.EXIT)
name = Name(signal='exit')
signal_token = Token(name=name.get_signal_token_name())
signal_token.data = pickle.dumps(signal)
request.updates.append(signal_token)
signal = Signal(action=Signal.DRAIN)
name.signal = 'drain'
name.workflow = 'some_workflow'
signal_token = Token(name=name.get_signal_token_name())
signal_token.data = pickle.dumps(signal)
request.updates.append(signal_token)
name.instance = '123'
signal_token = Token(name=name.get_signal_token_name())
signal_token.data = pickle.dumps(signal)
request.updates.append(signal_token)
signal = Signal(action=Signal.ABORT)
name.signal = 'abort'
signal_token = Token(name=name.get_signal_token_name())
signal_token.data = pickle.dumps(signal)
request.updates.append(signal_token)
client = self._factory.get_client()
client.modify(request)
def _generate_signal_tokens(workflows):
result = []
for w in range(0, workflows, 2):
workflow = 'workflow_%d' % w
signal = Signal(Signal.DRAIN)
name = Name(workflow=workflow,
signal=Signal.action_to_string(signal.action))
result.append(
Token(name=name.get_signal_token_name(),
version=10000000000 * w,
data=pickle.dumps(signal)))
return result
def is_signal_set(self, workflow, instance, action):
"""Check if a signal is set.
Args:
workflow: The workflow whose signal should be checked. If None,
signals at the global level are checked.
instance: The workflow instance whose signal should be checked. If
not None, a matching workflow name must be provided.
If None, signals at the workflow and the global level are
checked.
action: The signal action to check.
Returns:
True iff the signal exists in the specified context.
"""
for (workflow_name, instance_name) in [(workflow, instance),
(workflow, None),
(None, None)]:
name = Name(workflow=workflow_name, instance=instance_name,
signal=Signal.action_to_string(action))
token_name = name.get_signal_token_name()
tokens = self._store.read_tokens(token_name)
assert len(tokens) <= 1
if tokens:
return True
return False
def is_signal_set(self, workflow, instance, action):
"""Check if a signal is set.
Args:
workflow: The workflow whose signal should be checked. If None,
signals at the global level are checked.
instance: The workflow instance whose signal should be checked. If
not None, a matching workflow name must be provided.
If None, signals at the workflow and the global level are
checked.
action: The signal action to check.
Returns:
True iff the signal exists in the specified context.
"""
for (workflow_name, instance_name) in [(workflow, instance),
(workflow, None), (None, None)]:
name = Name(workflow=workflow_name,
instance=instance_name,
signal=Signal.action_to_string(action))
token_name = name.get_signal_token_name()
tokens = self._store.read_tokens(token_name)
assert len(tokens) <= 1
if tokens:
return True
return False
def _generate_signal_tokens(workflows):
result = []
for w in range(0, workflows, 2):
workflow = 'workflow_%d' % w
signal = Signal(Signal.DRAIN)
name = Name(workflow=workflow,
signal=Signal.action_to_string(signal.action))
result.append(Token(name=name.get_signal_token_name(),
version=10000000000 * w,
data=pickle.dumps(signal)))
return result
def _move_job_token_to_waiting(self, job, succeeded):
"""Move the owned job token to the waiting group.
If the job succeeded, also post events to job outputs. If the job
failed or it is the final job (a job with no outputs), post an archive
signal to finish the workflow.
Args:
job: The job that should be stored in the data field of the waiting
job token.
succeeded: True if the job succeeded, otherwise False.
"""
assert self._owned_job_token
name = Name.from_job_token_name(self._owned_job_token.name)
name.job_state = Name.WAITING_STATE
waiting_job_token = Token(name=name.get_job_token_name(),
priority=self._owned_job_token.priority,
data=pickle.dumps(job))
request = ModifyRequest(deletes=[self._owned_job_token],
updates=[waiting_job_token])
if succeeded:
request.updates.extend(self._get_output_event_tokens(job))
if not job.outputs or not succeeded:
# This is either the only job in the workflow with no outputs or a
# failed job. In either case, the workflow is done.
signaller = Signaller(self._client,
workflow=name.workflow,
instance=name.instance)
if not signaller.is_action_set(Signal.ARCHIVE):
signal_name = Name(workflow=name.workflow,
instance=name.instance,
signal=Signal.action_to_string(
Signal.ARCHIVE))
signal = Signal(Signal.ARCHIVE)
signal_token = Token(name=signal_name.get_signal_token_name())
signal_token.data = pickle.dumps(signal)
request.updates.append(signal_token)
self._send_request(request)
def test_run(self, job_executor_mock):
self._post_job_tokens()
self._post_workflow_start_event_token()
job_executor_mock.from_job.side_effect = WorkerTestCase._from_job
self._worker._test_only_end_if_no_runnable = True
self._worker.run()
with mock.patch('pinball.workflow.archiver.time') as time_patch:
# add one day
time_patch.time.return_value = time.time() + 24 * 60 * 60
self._worker.run()
parent_job_token_name = Name(workflow='some_workflow',
instance='12345',
job_state=Name.WAITING_STATE,
job='parent_job').get_job_token_name()
child_job_token_name = Name(workflow='some_workflow',
instance='12345',
job_state=Name.WAITING_STATE,
job='child_job').get_job_token_name()
signal_string = Signal.action_to_string(Signal.ARCHIVE)
signal_token_name = Name(workflow='some_workflow',
instance='12345',
signal=signal_string).get_signal_token_name()
token_names = [parent_job_token_name,
child_job_token_name,
signal_token_name]
self._verify_archived_token_names(token_names)
self.assertEqual(2, job_executor_mock.from_job.call_count)
parent_token = self._get_stored_token(parent_job_token_name)
job = pickle.loads(parent_token.data)
self.assertEqual(1, len(job.history))
execution_record = job.history[0]
self.assertEqual(0, execution_record.exit_code)
self.assertEqual(1234567, execution_record.end_time)
child_token = self._get_stored_token(child_job_token_name)
job = pickle.loads(child_token.data)
self.assertEqual(1, len(job.history))
execution_record = job.history[0]
self.assertEqual(0, execution_record.exit_code)
self.assertEqual(1234567, execution_record.end_time)
signal_token = self._get_stored_token(signal_token_name)
signal = pickle.loads(signal_token.data)
self.assertEqual(Signal.ARCHIVE, signal.action)
def test_run(self, job_executor_mock):
self._post_job_tokens()
self._post_workflow_start_event_token()
job_executor_mock.from_job.side_effect = WorkerTestCase._from_job
self._worker._test_only_end_if_no_runnable = True
self._worker.run()
with mock.patch('pinball.workflow.archiver.time') as time_patch:
# add one day
time_patch.time.return_value = time.time() + 24 * 60 * 60
self._worker.run()
parent_job_token_name = Name(workflow='some_workflow',
instance='12345',
job_state=Name.WAITING_STATE,
job='parent_job').get_job_token_name()
child_job_token_name = Name(workflow='some_workflow',
instance='12345',
job_state=Name.WAITING_STATE,
job='child_job').get_job_token_name()
signal_string = Signal.action_to_string(Signal.ARCHIVE)
signal_token_name = Name(workflow='some_workflow',
instance='12345',
signal=signal_string).get_signal_token_name()
token_names = [
parent_job_token_name, child_job_token_name, signal_token_name
]
self._verify_archived_token_names(token_names)
self.assertEqual(2, job_executor_mock.from_job.call_count)
parent_token = self._get_stored_token(parent_job_token_name)
job = pickle.loads(parent_token.data)
self.assertEqual(1, len(job.history))
execution_record = job.history[0]
self.assertEqual(0, execution_record.exit_code)
self.assertEqual(1234567, execution_record.end_time)
child_token = self._get_stored_token(child_job_token_name)
job = pickle.loads(child_token.data)
self.assertEqual(1, len(job.history))
execution_record = job.history[0]
self.assertEqual(0, execution_record.exit_code)
self.assertEqual(1234567, execution_record.end_time)
signal_token = self._get_stored_token(signal_token_name)
signal = pickle.loads(signal_token.data)
self.assertEqual(Signal.ARCHIVE, signal.action)
def _get_signal(self, workflow, instance, action, active):
signal = Signal.action_to_string(action)
name = Name(workflow=workflow, instance=instance, signal=signal)
signal_token_name = name.get_signal_token_name()
if active:
tokens = self._store.read_active_tokens(
name_prefix=signal_token_name)
else:
tokens = self._store.read_archived_tokens(
name_prefix=signal_token_name)
if not tokens:
return None
assert len(tokens) == 1
assert tokens[0].name == signal_token_name
return pickle.loads(tokens[0].data)
def _get_signal(self, workflow, instance, action, active):
signal = Signal.action_to_string(action)
name = Name(workflow=workflow, instance=instance, signal=signal)
signal_token_name = name.get_signal_token_name()
if active:
tokens = self._store.read_active_tokens(
name_prefix=signal_token_name)
else:
tokens = self._store.read_archived_tokens(
name_prefix=signal_token_name)
if not tokens:
return None
assert len(tokens) == 1
assert tokens[0].name == signal_token_name
return pickle.loads(tokens[0].data)
def _has_abort_token(self, tokens):
"""Check if a list of tokens contains an abort token.
Args:
tokens: The list of tokens to check.
Returns:
True iff the list contains an abort token.
"""
abort_signal = Signal.action_to_string(Signal.ABORT)
abort_name = Name(workflow=self._workflow, instance=self._instance, signal=abort_signal)
abort_token_name = abort_name.get_signal_token_name()
for token in tokens:
if token.name == abort_token_name:
return True
return False
def _move_job_token_to_waiting(self, job, succeeded):
"""Move the owned job token to the waiting group.
If the job succeeded, also post events to job outputs. If the job
failed or it is the final job (a job with no outputs), post an archive
signal to finish the workflow.
Args:
job: The job that should be stored in the data field of the waiting
job token.
succeeded: True if the job succeeded, otherwise False.
"""
assert self._owned_job_token
name = Name.from_job_token_name(self._owned_job_token.name)
name.job_state = Name.WAITING_STATE
waiting_job_token = Token(name=name.get_job_token_name(),
priority=self._owned_job_token.priority,
data=pickle.dumps(job))
request = ModifyRequest(deletes=[self._owned_job_token],
updates=[waiting_job_token])
if succeeded:
request.updates.extend(self._get_output_event_tokens(job))
if not job.outputs or not succeeded:
# This is either the only job in the workflow with no outputs or a
# failed job. In either case, the workflow is done.
signaller = Signaller(self._client,
workflow=name.workflow,
instance=name.instance)
if not signaller.is_action_set(Signal.ARCHIVE):
signal_name = Name(
workflow=name.workflow,
instance=name.instance,
signal=Signal.action_to_string(Signal.ARCHIVE))
signal = Signal(Signal.ARCHIVE)
signal_token = Token(name=signal_name.get_signal_token_name())
signal_token.data = pickle.dumps(signal)
request.updates.append(signal_token)
self._send_request(request)
