def test_unattached_error_message(self, m_getuid, uid,
expected_error_template, FakeConfig):
"""Check that root user gets unattached message."""
m_getuid.return_value = uid
cfg = FakeConfig()
with pytest.raises(exceptions.UserFacingError) as err:
args = mock.MagicMock()
args.names = ["esm-infra"]
action_disable(args, cfg)
assert (expected_error_template.format(
name="esm-infra") == err.value.msg)
def test_invalid_service_error_message(self, m_getuid, uid,
expected_error_template):
"""Check invalid service name results in custom error message."""
m_getuid.return_value = uid
cfg = FakeConfig.for_attached_machine()
with pytest.raises(exceptions.UserFacingError) as err:
args = mock.MagicMock()
args.name = "bogus"
action_disable(args, cfg)
assert (expected_error_template.format(operation="disable",
name="bogus") == err.value.msg)
def test_invalid_service_names(self, m_getuid, names, FakeConfig):
m_getuid.return_value = 0
expected_error_tmpl = status.MESSAGE_INVALID_SERVICE_OP_FAILURE_TMPL
cfg = FakeConfig.for_attached_machine()
with pytest.raises(exceptions.UserFacingError) as err:
args = mock.MagicMock()
args.names = names
action_disable(args, cfg)
assert (expected_error_tmpl.format(
operation="disable",
name=", ".join(sorted(names))) == err.value.msg)
def test_invalid_service_error_message(self, m_getuid, uid,
expected_error_template, FakeConfig,
event):
"""Check invalid service name results in custom error message."""
m_getuid.return_value = uid
cfg = FakeConfig.for_attached_machine()
args = mock.MagicMock()
if not uid:
expected_error = expected_error_template.format(
operation="disable",
invalid_service="bogus",
service_msg=ALL_SERVICE_MSG,
)
else:
expected_error = expected_error_template
with pytest.raises(exceptions.UserFacingError) as err:
args.service = ["bogus"]
action_disable(args, cfg)
assert expected_error.msg == err.value.msg
args.assume_yes = True
args.format = "json"
with pytest.raises(SystemExit):
with mock.patch.object(event, "_event_logger_mode",
event_logger.EventLoggerMode.JSON):
with mock.patch.object(event, "set_event_mode"):
fake_stdout = io.StringIO()
with contextlib.redirect_stdout(fake_stdout):
main_error_handler(action_disable)(args, cfg)
expected = {
"_schema_version":
event_logger.JSON_SCHEMA_VERSION,
"result":
"failure",
"errors": [{
"message": expected_error.msg,
"message_code": expected_error.name,
"service": None,
"type": "system",
}],
"failed_services": [],
"needs_reboot":
False,
"processed_services": [],
"warnings": [],
}
assert expected == json.loads(fake_stdout.getvalue())
def test_entitlement_instantiated_and_disabled(
self,
m_entitlements,
_m_getuid,
disable_return,
return_code,
assume_yes,
):
m_entitlement_cls = mock.Mock()
m_entitlement = m_entitlement_cls.return_value
m_entitlement.disable.return_value = disable_return
m_cfg = mock.Mock()
m_entitlements.ENTITLEMENT_CLASS_BY_NAME = {
"testitlement": m_entitlement_cls
}
args_mock = mock.Mock()
args_mock.name = "testitlement"
args_mock.assume_yes = assume_yes
ret = action_disable(args_mock, m_cfg)
assert [mock.call(m_cfg, assume_yes=assume_yes)
] == m_entitlement_cls.call_args_list
expected_disable_call = mock.call()
assert [expected_disable_call] == m_entitlement.disable.call_args_list
assert return_code == ret
assert 1 == m_cfg.status.call_count
def test_entitlements_not_found_disabled_and_enabled(
self, m_entitlements, _m_getuid, assume_yes):
expected_error_tmpl = status.MESSAGE_INVALID_SERVICE_OP_FAILURE_TMPL
num_calls = 2
m_ent1_cls = mock.Mock()
m_ent1_obj = m_ent1_cls.return_value
m_ent1_obj.disable.return_value = False
m_ent2_cls = mock.Mock()
m_ent2_obj = m_ent2_cls.return_value
m_ent2_obj.disable.return_value = False
m_ent3_cls = mock.Mock()
m_ent3_obj = m_ent3_cls.return_value
m_ent3_obj.disable.return_value = True
m_entitlements.ENTITLEMENT_CLASS_BY_NAME = {
"ent2": m_ent2_cls,
"ent3": m_ent3_cls,
}
m_cfg = mock.Mock()
args_mock = mock.Mock()
args_mock.names = ["ent1", "ent2", "ent3"]
args_mock.assume_yes = assume_yes
with pytest.raises(exceptions.UserFacingError) as err:
action_disable(args_mock, m_cfg)
assert (expected_error_tmpl.format(operation="disable",
name="ent1") == err.value.msg)
for m_ent_cls in [m_ent2_cls, m_ent3_cls]:
assert [mock.call(m_cfg, assume_yes=assume_yes)
] == m_ent_cls.call_args_list
expected_disable_call = mock.call()
for m_ent in [m_ent2_obj, m_ent3_obj]:
assert [expected_disable_call] == m_ent.disable.call_args_list
assert 0 == m_ent1_obj.call_count
assert num_calls == m_cfg.status.call_count
def test_lock_file_exists(self, m_subp, m_getuid, FakeConfig, event):
"""Check inability to disable if operation in progress holds lock."""
cfg = FakeConfig().for_attached_machine()
args = mock.MagicMock()
expected_error = messages.LOCK_HELD_ERROR.format(
lock_request="ua disable", lock_holder="ua enable", pid="123")
with open(cfg.data_path("lock"), "w") as stream:
stream.write("123:ua enable")
with pytest.raises(exceptions.LockHeldError) as err:
args.service = ["esm-infra"]
action_disable(args, cfg)
assert [mock.call(["ps", "123"])] == m_subp.call_args_list
assert expected_error.msg == err.value.msg
args.assume_yes = True
args.format = "json"
with pytest.raises(SystemExit):
with mock.patch.object(event, "_event_logger_mode",
event_logger.EventLoggerMode.JSON):
with mock.patch.object(event, "set_event_mode"):
fake_stdout = io.StringIO()
with contextlib.redirect_stdout(fake_stdout):
main_error_handler(action_disable)(args, cfg)
expected = {
"_schema_version":
event_logger.JSON_SCHEMA_VERSION,
"result":
"failure",
"errors": [{
"message": expected_error.msg,
"message_code": expected_error.name,
"service": None,
"type": "system",
}],
"failed_services": [],
"needs_reboot":
False,
"processed_services": [],
"warnings": [],
}
assert expected == json.loads(fake_stdout.getvalue())
def test_entitlement_instantiated_and_disabled(
self,
m_entitlements,
_m_getuid,
disable_return,
return_code,
assume_yes,
names,
):
entitlements_cls = []
entitlements_obj = []
m_entitlements.ENTITLEMENT_CLASS_BY_NAME = {}
for entitlement_name in names:
m_entitlement_cls = mock.Mock()
m_entitlement = m_entitlement_cls.return_value
m_entitlement.disable.return_value = disable_return
m_entitlements.ENTITLEMENT_CLASS_BY_NAME[
entitlement_name] = m_entitlement_cls
entitlements_obj.append(m_entitlement)
entitlements_cls.append(m_entitlement_cls)
m_cfg = mock.Mock()
args_mock = mock.Mock()
args_mock.names = names
args_mock.assume_yes = assume_yes
ret = action_disable(args_mock, m_cfg)
for m_entitlement_cls in entitlements_cls:
assert [mock.call(m_cfg, assume_yes=assume_yes)
] == m_entitlement_cls.call_args_list
expected_disable_call = mock.call()
for m_entitlement in entitlements_obj:
assert [expected_disable_call
] == m_entitlement.disable.call_args_list
assert return_code == ret
assert len(entitlements_cls) == m_cfg.status.call_count
def test_entitlement_instantiated_and_disabled(
self,
m_status,
m_valid_services,
m_entitlement_factory,
_m_getuid,
disable_return,
return_code,
assume_yes,
service,
tmpdir,
capsys,
event,
FakeConfig,
):
entitlements_cls = []
entitlements_obj = []
ent_dict = {}
m_valid_services.return_value = []
if not disable_return:
fail = CanDisableFailure(
CanDisableFailureReason.ALREADY_DISABLED,
message=messages.NamedMessage("test-code", "test"),
)
else:
fail = None
for entitlement_name in service:
m_entitlement_cls = mock.Mock()
m_entitlement = m_entitlement_cls.return_value
m_entitlement.disable.return_value = (disable_return, fail)
entitlements_obj.append(m_entitlement)
entitlements_cls.append(m_entitlement_cls)
m_valid_services.return_value.append(entitlement_name)
ent_dict[entitlement_name] = m_entitlement_cls
type(m_entitlement).name = mock.PropertyMock(
return_value=entitlement_name)
def factory_side_effect(cfg, name, ent_dict=ent_dict):
return ent_dict.get(name)
m_entitlement_factory.side_effect = factory_side_effect
cfg = FakeConfig.for_attached_machine()
args_mock = mock.Mock()
args_mock.service = service
args_mock.assume_yes = assume_yes
with mock.patch.object(cfg, "check_lock_info", return_value=(-1, "")):
ret = action_disable(args_mock, cfg=cfg)
for m_entitlement_cls in entitlements_cls:
assert [mock.call(cfg, assume_yes=assume_yes)
] == m_entitlement_cls.call_args_list
expected_disable_call = mock.call()
for m_entitlement in entitlements_obj:
assert [expected_disable_call
] == m_entitlement.disable.call_args_list
assert return_code == ret
assert len(entitlements_cls) == m_status.call_count
cfg = FakeConfig.for_attached_machine()
args_mock.assume_yes = True
args_mock.format = "json"
with mock.patch.object(event, "_event_logger_mode",
event_logger.EventLoggerMode.JSON):
with mock.patch.object(event, "set_event_mode"):
with mock.patch.object(cfg,
"check_lock_info",
return_value=(-1, "")):
fake_stdout = io.StringIO()
with contextlib.redirect_stdout(fake_stdout):
ret = action_disable(args_mock, cfg=cfg)
expected = {
"_schema_version": event_logger.JSON_SCHEMA_VERSION,
"result": "success" if disable_return else "failure",
"errors": [],
"failed_services": [] if disable_return else service,
"needs_reboot": False,
"processed_services": service if disable_return else [],
"warnings": [],
}
if not disable_return:
expected["errors"] = [{
"message": "test",
"message_code": "test-code",
"service": ent_name,
"type": "service",
} for ent_name in service]
assert return_code == ret
assert expected == json.loads(fake_stdout.getvalue())
def test_entitlements_not_found_disabled_and_enabled(
self,
m_status,
m_valid_services,
m_entitlement_factory,
_m_getuid,
assume_yes,
tmpdir,
event,
FakeConfig,
):
expected_error_tmpl = messages.INVALID_SERVICE_OP_FAILURE
num_calls = 2
m_ent1_cls = mock.Mock()
m_ent1_obj = m_ent1_cls.return_value
m_ent1_obj.disable.return_value = (
False,
CanDisableFailure(
CanDisableFailureReason.ALREADY_DISABLED,
message=messages.NamedMessage("test-code", "test"),
),
)
type(m_ent1_obj).name = mock.PropertyMock(return_value="ent1")
m_ent2_cls = mock.Mock()
m_ent2_obj = m_ent2_cls.return_value
m_ent2_obj.disable.return_value = (
False,
CanDisableFailure(
CanDisableFailureReason.ALREADY_DISABLED,
message=messages.NamedMessage("test-code2", "test2"),
),
)
type(m_ent2_obj).name = mock.PropertyMock(return_value="ent2")
m_ent3_cls = mock.Mock()
m_ent3_obj = m_ent3_cls.return_value
m_ent3_obj.disable.return_value = (True, None)
type(m_ent3_obj).name = mock.PropertyMock(return_value="ent3")
def factory_side_effect(cfg, name):
if name == "ent2":
return m_ent2_cls
if name == "ent3":
return m_ent3_cls
return None
m_entitlement_factory.side_effect = factory_side_effect
m_valid_services.return_value = ["ent2", "ent3"]
cfg = FakeConfig.for_attached_machine()
args_mock = mock.Mock()
args_mock.service = ["ent1", "ent2", "ent3"]
args_mock.assume_yes = assume_yes
with pytest.raises(exceptions.UserFacingError) as err:
with mock.patch.object(cfg,
"check_lock_info",
return_value=(-1, "")):
action_disable(args_mock, cfg=cfg)
assert (expected_error_tmpl.format(
operation="disable",
invalid_service="ent1",
service_msg="Try ent2, ent3.",
).msg == err.value.msg)
for m_ent_cls in [m_ent2_cls, m_ent3_cls]:
assert [mock.call(cfg, assume_yes=assume_yes)
] == m_ent_cls.call_args_list
expected_disable_call = mock.call()
for m_ent in [m_ent2_obj, m_ent3_obj]:
assert [expected_disable_call] == m_ent.disable.call_args_list
assert 0 == m_ent1_obj.call_count
assert num_calls == m_status.call_count
cfg = FakeConfig.for_attached_machine()
args_mock.assume_yes = True
args_mock.format = "json"
with pytest.raises(SystemExit):
with mock.patch.object(event, "_event_logger_mode",
event_logger.EventLoggerMode.JSON):
with mock.patch.object(event, "set_event_mode"):
with mock.patch.object(cfg,
"check_lock_info",
return_value=(-1, "")):
fake_stdout = io.StringIO()
with contextlib.redirect_stdout(fake_stdout):
main_error_handler(action_disable)(args_mock,
cfg=cfg)
expected = {
"_schema_version":
event_logger.JSON_SCHEMA_VERSION,
"result":
"failure",
"errors": [
{
"message": "test2",
"message_code": "test-code2",
"service": "ent2",
"type": "service",
},
{
"message": ("Cannot disable unknown service 'ent1'.\n"
"Try ent2, ent3."),
"message_code":
"invalid-service-or-failure",
"service":
None,
"type":
"system",
},
],
"failed_services": ["ent2"],
"needs_reboot":
False,
"processed_services": ["ent3"],
"warnings": [],
}
assert expected == json.loads(fake_stdout.getvalue())
