Skip to content

Commit

Permalink
commands: log command validation errors (#6164)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliver-sanders authored Jul 2, 2024
1 parent 821ecc0 commit 6d31111
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
1 change: 1 addition & 0 deletions cylc/flow/network/resolvers.py
Original file line number Diff line number Diff line change
Expand Up @@ -761,6 +761,7 @@ async def _mutation_mapper(
except Exception as exc:
# NOTE: keep this exception vague to prevent a bad command taking
# down the scheduler
LOG.warning(f'{log1}\n{exc.__class__.__name__}: {exc}')
if cylc.flow.flags.verbosity > 1:
LOG.exception(exc) # log full traceback in debug mode
return (False, str(exc))
Expand Down
56 changes: 56 additions & 0 deletions tests/integration/test_resolvers.py
Original file line number Diff line number Diff line change
Expand Up @@ -250,3 +250,59 @@ async def test_command_logging(mock_flow, caplog, log_filter):
await mock_flow.resolvers._mutation_mapper("put_messages", kwargs, meta)
assert log_filter(
caplog, contains='Command "put_messages" received from Dr Spock')


async def test_command_validation_failure(
mock_flow,
caplog,
flow_args,
monkeypatch,
):
"""It should log command validation failures server side."""
caplog.set_level(logging.DEBUG, None)
flow_args['workflows'].append(
{
'user': mock_flow.owner,
'workflow': mock_flow.name,
'workflow_sel': None,
}
)

# submit a command with invalid arguments:
async def submit_invalid_command(verbosity=0):
nonlocal caplog, mock_flow, flow_args
monkeypatch.setattr('cylc.flow.flags.verbosity', verbosity)
caplog.clear()
return await mock_flow.resolvers.mutator(
None,
'stop',
flow_args,
{'task': 'cycle/task/job', 'mode': 'not-a-mode'},
{},
)

# submitting the invalid command should result in this error
msg = 'This command does not take job ids:\n * cycle/task/job'

# test submitting the command at *default* verbosity
response = await submit_invalid_command()

# the error should be sent back to the client:
assert response[0]['response'][1] == msg
# it should also be logged by the server:
assert caplog.records[-1].levelno == logging.WARNING
assert msg in caplog.records[-1].message

# test submitting the command at *debug* verbosity
response = await submit_invalid_command(verbosity=2)

# the error should be sent back to the client:
assert response[0]['response'][1] == msg
# it should be logged at the server
assert caplog.records[-2].levelno == logging.WARNING
assert msg in caplog.records[-2].message
# the traceback should also be logged
# (note traceback gets logged at the ERROR level and shows up funny in
# caplog)
assert caplog.records[-1].levelno == logging.ERROR
assert msg in caplog.records[-1].message

0 comments on commit 6d31111

Please sign in to comment.