e4d72dd981
* luks_device.py: Allow manipulate LUKS containers with label or UUID - Allow create a LUKS2 container format with label support - Allow manipulate (open, close, modify) an LUKS container based on both label (LUKS2 format) or UUID instead of using devices only. Fixes: #58973 Signed-off-by: Alexandre Mulatinho <alex@mulatinho.net> * test_luks_device.py: organizing tests to support labels - Add label on some tests and fix errors reported by Shippable Signed-off-by: Alexandre Mulatinho <alex@mulatinho.net> * luks_device.py: adjusting versions and messages - Modifying version_added from 2.9 to 2.10 - Fixing some messages - Created a changelog fragment - Moving blkid from scope Fixes #58973 Signed-off-by: Alexandre Mulatinho <alex@mulatinho.net>
264 lines
10 KiB
Python
264 lines
10 KiB
Python
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
import pytest
|
|
from ansible.modules.crypto import luks_device
|
|
from units.compat.mock import patch
|
|
from ansible.module_utils import basic
|
|
|
|
|
|
class DummyModule(object):
|
|
# module to mock AnsibleModule class
|
|
def __init__(self):
|
|
self.params = dict()
|
|
|
|
def fail_json(self, msg=""):
|
|
raise ValueError(msg)
|
|
|
|
def get_bin_path(self, command, dummy):
|
|
return command
|
|
|
|
|
|
# ===== Handler & CryptHandler methods tests =====
|
|
|
|
def test_generate_luks_name(monkeypatch):
|
|
module = DummyModule()
|
|
monkeypatch.setattr(luks_device.Handler, "_run_command",
|
|
lambda x, y: [0, "UUID", ""])
|
|
crypt = luks_device.CryptHandler(module)
|
|
assert crypt.generate_luks_name("/dev/dummy") == "luks-UUID"
|
|
|
|
|
|
def test_get_container_name_by_device(monkeypatch):
|
|
module = DummyModule()
|
|
monkeypatch.setattr(luks_device.Handler, "_run_command",
|
|
lambda x, y: [0, "crypt container_name", ""])
|
|
crypt = luks_device.CryptHandler(module)
|
|
assert crypt.get_container_name_by_device("/dev/dummy") == "container_name"
|
|
|
|
|
|
def test_get_container_device_by_name(monkeypatch):
|
|
module = DummyModule()
|
|
monkeypatch.setattr(luks_device.Handler, "_run_command",
|
|
lambda x, y: [0, "device: /dev/luksdevice", ""])
|
|
crypt = luks_device.CryptHandler(module)
|
|
assert crypt.get_container_device_by_name("dummy") == "/dev/luksdevice"
|
|
|
|
|
|
def test_run_luks_remove(monkeypatch):
|
|
def run_command_check(self, command):
|
|
# check that wipefs command is actually called
|
|
assert command[0] == "wipefs"
|
|
return [0, "", ""]
|
|
|
|
module = DummyModule()
|
|
monkeypatch.setattr(luks_device.CryptHandler,
|
|
"get_container_name_by_device",
|
|
lambda x, y: None)
|
|
monkeypatch.setattr(luks_device.Handler,
|
|
"_run_command",
|
|
run_command_check)
|
|
crypt = luks_device.CryptHandler(module)
|
|
crypt.run_luks_remove("dummy")
|
|
|
|
|
|
# ===== ConditionsHandler methods data and tests =====
|
|
|
|
# device, key, state, is_luks, label, expected
|
|
LUKS_CREATE_DATA = (
|
|
("dummy", "key", "present", False, None, True),
|
|
(None, "key", "present", False, None, False),
|
|
(None, "key", "present", False, "labelName", True),
|
|
("dummy", None, "present", False, None, False),
|
|
("dummy", "key", "absent", False, None, False),
|
|
("dummy", "key", "opened", True, None, False),
|
|
("dummy", "key", "closed", True, None, False),
|
|
("dummy", "key", "present", True, None, False))
|
|
|
|
# device, state, is_luks, expected
|
|
LUKS_REMOVE_DATA = (
|
|
("dummy", "absent", True, True),
|
|
(None, "absent", True, False),
|
|
("dummy", "present", True, False),
|
|
("dummy", "absent", False, False))
|
|
|
|
# device, key, state, name, name_by_dev, expected
|
|
LUKS_OPEN_DATA = (
|
|
("dummy", "key", "present", "name", None, False),
|
|
("dummy", "key", "absent", "name", None, False),
|
|
("dummy", "key", "closed", "name", None, False),
|
|
("dummy", "key", "opened", "name", None, True),
|
|
(None, "key", "opened", "name", None, False),
|
|
("dummy", None, "opened", "name", None, False),
|
|
("dummy", "key", "opened", "name", "name", False),
|
|
("dummy", "key", "opened", "beer", "name", "exception"))
|
|
|
|
# device, dev_by_name, name, name_by_dev, state, label, expected
|
|
LUKS_CLOSE_DATA = (
|
|
("dummy", "dummy", "name", "name", "present", None, False),
|
|
("dummy", "dummy", "name", "name", "absent", None, False),
|
|
("dummy", "dummy", "name", "name", "opened", None, False),
|
|
("dummy", "dummy", "name", "name", "closed", None, True),
|
|
(None, "dummy", "name", "name", "closed", None, True),
|
|
("dummy", "dummy", None, "name", "closed", None, True),
|
|
(None, "dummy", None, "name", "closed", None, False))
|
|
|
|
# device, key, new_key, state, label, expected
|
|
LUKS_ADD_KEY_DATA = (
|
|
("dummy", "key", "new_key", "present", None, True),
|
|
(None, "key", "new_key", "present", "labelName", True),
|
|
(None, "key", "new_key", "present", None, False),
|
|
("dummy", None, "new_key", "present", None, False),
|
|
("dummy", "key", None, "present", None, False),
|
|
("dummy", "key", "new_key", "absent", None, "exception"))
|
|
|
|
# device, remove_key, state, label, expected
|
|
LUKS_REMOVE_KEY_DATA = (
|
|
("dummy", "key", "present", None, True),
|
|
(None, "key", "present", None, False),
|
|
(None, "key", "present", "labelName", True),
|
|
("dummy", None, "present", None, False),
|
|
("dummy", "key", "absent", None, "exception"))
|
|
|
|
|
|
@pytest.mark.parametrize("device, keyfile, state, is_luks, label, expected",
|
|
((d[0], d[1], d[2], d[3], d[4], d[5])
|
|
for d in LUKS_CREATE_DATA))
|
|
def test_luks_create(device, keyfile, state, is_luks, label, expected,
|
|
monkeypatch):
|
|
module = DummyModule()
|
|
|
|
module.params["device"] = device
|
|
module.params["keyfile"] = keyfile
|
|
module.params["state"] = state
|
|
module.params["label"] = label
|
|
|
|
monkeypatch.setattr(luks_device.CryptHandler, "is_luks",
|
|
lambda x, y: is_luks)
|
|
crypt = luks_device.CryptHandler(module)
|
|
if device is None:
|
|
monkeypatch.setattr(luks_device.Handler, "get_device_by_label",
|
|
lambda x, y: [0, "/dev/dummy", ""])
|
|
try:
|
|
conditions = luks_device.ConditionsHandler(module, crypt)
|
|
assert conditions.luks_create() == expected
|
|
except ValueError:
|
|
assert expected == "exception"
|
|
|
|
|
|
@pytest.mark.parametrize("device, state, is_luks, expected",
|
|
((d[0], d[1], d[2], d[3])
|
|
for d in LUKS_REMOVE_DATA))
|
|
def test_luks_remove(device, state, is_luks, expected, monkeypatch):
|
|
module = DummyModule()
|
|
|
|
module.params["device"] = device
|
|
module.params["state"] = state
|
|
|
|
monkeypatch.setattr(luks_device.CryptHandler, "is_luks",
|
|
lambda x, y: is_luks)
|
|
crypt = luks_device.CryptHandler(module)
|
|
try:
|
|
conditions = luks_device.ConditionsHandler(module, crypt)
|
|
assert conditions.luks_remove() == expected
|
|
except ValueError:
|
|
assert expected == "exception"
|
|
|
|
|
|
@pytest.mark.parametrize("device, keyfile, state, name, "
|
|
"name_by_dev, expected",
|
|
((d[0], d[1], d[2], d[3], d[4], d[5])
|
|
for d in LUKS_OPEN_DATA))
|
|
def test_luks_open(device, keyfile, state, name, name_by_dev,
|
|
expected, monkeypatch):
|
|
module = DummyModule()
|
|
module.params["device"] = device
|
|
module.params["keyfile"] = keyfile
|
|
module.params["state"] = state
|
|
module.params["name"] = name
|
|
|
|
monkeypatch.setattr(luks_device.CryptHandler,
|
|
"get_container_name_by_device",
|
|
lambda x, y: name_by_dev)
|
|
monkeypatch.setattr(luks_device.CryptHandler,
|
|
"get_container_device_by_name",
|
|
lambda x, y: device)
|
|
monkeypatch.setattr(luks_device.Handler, "_run_command",
|
|
lambda x, y: [0, device, ""])
|
|
crypt = luks_device.CryptHandler(module)
|
|
try:
|
|
conditions = luks_device.ConditionsHandler(module, crypt)
|
|
assert conditions.luks_open() == expected
|
|
except ValueError:
|
|
assert expected == "exception"
|
|
|
|
|
|
@pytest.mark.parametrize("device, dev_by_name, name, name_by_dev, "
|
|
"state, label, expected",
|
|
((d[0], d[1], d[2], d[3], d[4], d[5], d[6])
|
|
for d in LUKS_CLOSE_DATA))
|
|
def test_luks_close(device, dev_by_name, name, name_by_dev, state,
|
|
label, expected, monkeypatch):
|
|
module = DummyModule()
|
|
module.params["device"] = device
|
|
module.params["name"] = name
|
|
module.params["state"] = state
|
|
module.params["label"] = label
|
|
|
|
monkeypatch.setattr(luks_device.CryptHandler,
|
|
"get_container_name_by_device",
|
|
lambda x, y: name_by_dev)
|
|
monkeypatch.setattr(luks_device.CryptHandler,
|
|
"get_container_device_by_name",
|
|
lambda x, y: dev_by_name)
|
|
crypt = luks_device.CryptHandler(module)
|
|
try:
|
|
conditions = luks_device.ConditionsHandler(module, crypt)
|
|
assert conditions.luks_close() == expected
|
|
except ValueError:
|
|
assert expected == "exception"
|
|
|
|
|
|
@pytest.mark.parametrize("device, keyfile, new_keyfile, state, label, expected",
|
|
((d[0], d[1], d[2], d[3], d[4], d[5])
|
|
for d in LUKS_ADD_KEY_DATA))
|
|
def test_luks_add_key(device, keyfile, new_keyfile, state, label, expected, monkeypatch):
|
|
module = DummyModule()
|
|
module.params["device"] = device
|
|
module.params["keyfile"] = keyfile
|
|
module.params["new_keyfile"] = new_keyfile
|
|
module.params["state"] = state
|
|
module.params["label"] = label
|
|
|
|
monkeypatch.setattr(luks_device.Handler, "get_device_by_label",
|
|
lambda x, y: [0, "/dev/dummy", ""])
|
|
|
|
try:
|
|
conditions = luks_device.ConditionsHandler(module, module)
|
|
assert conditions.luks_add_key() == expected
|
|
except ValueError:
|
|
assert expected == "exception"
|
|
|
|
|
|
@pytest.mark.parametrize("device, remove_keyfile, state, label, expected",
|
|
((d[0], d[1], d[2], d[3], d[4])
|
|
for d in LUKS_REMOVE_KEY_DATA))
|
|
def test_luks_remove_key(device, remove_keyfile, state, label, expected, monkeypatch):
|
|
|
|
module = DummyModule()
|
|
module.params["device"] = device
|
|
module.params["remove_keyfile"] = remove_keyfile
|
|
module.params["state"] = state
|
|
module.params["label"] = label
|
|
|
|
monkeypatch.setattr(luks_device.Handler, "get_device_by_label",
|
|
lambda x, y: [0, "/dev/dummy", ""])
|
|
monkeypatch.setattr(luks_device.Handler, "_run_command",
|
|
lambda x, y: [0, device, ""])
|
|
|
|
crypt = luks_device.CryptHandler(module)
|
|
try:
|
|
conditions = luks_device.ConditionsHandler(module, crypt)
|
|
assert conditions.luks_remove_key() == expected
|
|
except ValueError:
|
|
assert expected == "exception"
|