mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-11 11:41:32 -07:00
New LUKS devices management module (#48991)
* New LUKS devices management module - new module that uses cryptsetup (LUKS) functions for management of encrypted devices - unit tests included * New LUKS devices management module - modified interface by removing 'open' option and moving its functionality into 'state' option
This commit is contained in:
japokorn
John R Barker
parent
0c8c72a0bf
commit
68d43130d0
3 changed files with 744 additions and 0 deletions
225
test/units/modules/crypto/test_luks_device.py
Normal file
225
test/units/modules/crypto/test_luks_device.py
Normal file
|
|
@ -0,0 +1,225 @@
|
|||
import pytest
|
||||
from ansible.modules.crypto import luks_device
|
||||
|
||||
|
||||
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, expected
|
||||
LUKS_CREATE_DATA = (
|
||||
("dummy", "key", "present", False, True),
|
||||
(None, "key", "present", False, False),
|
||||
("dummy", None, "present", False, False),
|
||||
("dummy", "key", "absent", False, False),
|
||||
("dummy", "key", "opened", True, False),
|
||||
("dummy", "key", "closed", True, False),
|
||||
("dummy", "key", "present", True, 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, expected
|
||||
LUKS_CLOSE_DATA = (
|
||||
("dummy", "dummy", "name", "name", "present", False),
|
||||
("dummy", "dummy", "name", "name", "absent", False),
|
||||
("dummy", "dummy", "name", "name", "opened", False),
|
||||
("dummy", "dummy", "name", "name", "closed", True),
|
||||
(None, "dummy", "name", "name", "closed", True),
|
||||
("dummy", "dummy", None, "name", "closed", True),
|
||||
(None, "dummy", None, "name", "closed", False))
|
||||
|
||||
# device, key, new_key, state, expected
|
||||
LUKS_ADD_KEY_DATA = (
|
||||
("dummy", "key", "new_key", "present", True),
|
||||
(None, "key", "new_key", "present", False),
|
||||
("dummy", None, "new_key", "present", False),
|
||||
("dummy", "key", None, "present", False),
|
||||
("dummy", "key", "new_key", "absent", "exception"))
|
||||
|
||||
# device, remove_key, state, expected
|
||||
LUKS_REMOVE_KEY_DATA = (
|
||||
("dummy", "key", "present", True),
|
||||
(None, "key", "present", False),
|
||||
("dummy", None, "present", False),
|
||||
("dummy", "key", "absent", "exception"))
|
||||
|
||||
|
||||
@pytest.mark.parametrize("device, keyfile, state, is_luks, expected",
|
||||
((d[0], d[1], d[2], d[3], d[4])
|
||||
for d in LUKS_CREATE_DATA))
|
||||
def test_luks_create(device, keyfile, state, is_luks, expected, monkeypatch):
|
||||
module = DummyModule()
|
||||
|
||||
module.params["device"] = device
|
||||
module.params["keyfile"] = keyfile
|
||||
module.params["state"] = state
|
||||
|
||||
monkeypatch.setattr(luks_device.CryptHandler, "is_luks",
|
||||
lambda x, y: is_luks)
|
||||
crypt = luks_device.CryptHandler(module)
|
||||
conditions = luks_device.ConditionsHandler(module, crypt)
|
||||
assert conditions.luks_create() == expected
|
||||
|
||||
|
||||
@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)
|
||||
conditions = luks_device.ConditionsHandler(module, crypt)
|
||||
assert conditions.luks_remove() == expected
|
||||
|
||||
|
||||
@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)
|
||||
crypt = luks_device.CryptHandler(module)
|
||||
conditions = luks_device.ConditionsHandler(module, crypt)
|
||||
try:
|
||||
assert conditions.luks_open() == expected
|
||||
except ValueError:
|
||||
assert expected == "exception"
|
||||
|
||||
|
||||
@pytest.mark.parametrize("device, dev_by_name, name, name_by_dev, "
|
||||
"state, expected",
|
||||
((d[0], d[1], d[2], d[3], d[4], d[5])
|
||||
for d in LUKS_CLOSE_DATA))
|
||||
def test_luks_close(device, dev_by_name, name, name_by_dev, state,
|
||||
expected, monkeypatch):
|
||||
module = DummyModule()
|
||||
module.params["device"] = device
|
||||
module.params["name"] = name
|
||||
module.params["state"] = state
|
||||
|
||||
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)
|
||||
conditions = luks_device.ConditionsHandler(module, crypt)
|
||||
assert conditions.luks_close() == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize("device, keyfile, new_keyfile, state, expected",
|
||||
((d[0], d[1], d[2], d[3], d[4])
|
||||
for d in LUKS_ADD_KEY_DATA))
|
||||
def test_luks_add_key(device, keyfile, new_keyfile, state, expected, monkeypatch):
|
||||
module = DummyModule()
|
||||
module.params["device"] = device
|
||||
module.params["keyfile"] = keyfile
|
||||
module.params["new_keyfile"] = new_keyfile
|
||||
module.params["state"] = state
|
||||
|
||||
conditions = luks_device.ConditionsHandler(module, module)
|
||||
try:
|
||||
assert conditions.luks_add_key() == expected
|
||||
except ValueError:
|
||||
assert expected == "exception"
|
||||
|
||||
|
||||
@pytest.mark.parametrize("device, remove_keyfile, state, expected",
|
||||
((d[0], d[1], d[2], d[3])
|
||||
for d in LUKS_REMOVE_KEY_DATA))
|
||||
def test_luks_remove_key(device, remove_keyfile, state, expected, monkeypatch):
|
||||
|
||||
module = DummyModule()
|
||||
module.params["device"] = device
|
||||
module.params["remove_keyfile"] = remove_keyfile
|
||||
module.params["state"] = state
|
||||
|
||||
conditions = luks_device.ConditionsHandler(module, module)
|
||||
try:
|
||||
assert conditions.luks_remove_key() == expected
|
||||
except ValueError:
|
||||
assert expected == "exception"
|
||||
Loading…
Add table
Add a link
Reference in a new issue