def test_boot_environment_created(root_dataset):
parent_dataset = zfs_utility.dataset_parent(root_dataset)
boot_environment = f"zedenv-{datetime.datetime.now().isoformat()}"
verbose = True
existing = None
zedenv.cli.create.zedenv_create(parent_dataset, root_dataset,
boot_environment, verbose, existing)
assert zfs_utility.dataset_exists(f"{parent_dataset}/{boot_environment}")
def zedenv_create(parent_dataset: str, root_dataset: str,
boot_environment: str, verbose: bool,
existing: Optional[str], bootloader: Optional[str]):
"""
:Parameters:
parent_dataset : str
Dataset boot environment root, commonly 'zpool/ROOT'.
root_dataset : str
Current boot dataset.
boot_environment : str
Name of new boot environment, e.g. default-02
verbose : bool
Print information verbosely.
existing : bool
Create boot environment from certain dataset.
:return:
"""
ZELogger.verbose_log(
{
"level": "INFO",
"message": "Creating Boot Environment:\n"
}, verbose)
# Remove the final part of the data set after the last / and add new name
boot_environment_dataset = f"{parent_dataset}/{boot_environment}"
zpool = zedenv.lib.be.dataset_pool(boot_environment_dataset)
current_be = None
try:
current_be = pyzfscmds.utility.dataset_child_name(
zedenv.lib.be.bootfs_for_pool(zpool))
except RuntimeError:
ZELogger.log(
{
"level": "EXCEPTION",
"message": f"Failed to get active boot environment'\n"
},
exit_on_error=True)
bootloader_plugin = None
if bootloader:
bootloader_plugin = zedenv.lib.configure.get_bootloader(
boot_environment, current_be, bootloader, verbose, False, False,
parent_dataset)
ZELogger.verbose_log(
{
"level": "INFO",
"message": f"Using plugin {bootloader}\n"
}, verbose)
if zfs_utility.dataset_exists(boot_environment_dataset):
ZELogger.log(
{
"level":
"EXCEPTION",
"message":
f"Failed to create {boot_environment_dataset}, already exists."
},
exit_on_error=True)
# Getting snapshot for clone
clone_sources = get_clones(root_dataset, existing)
ZELogger.verbose_log(
{
"level":
"INFO",
"message":
f"Getting properties of {boot_environment_dataset} for clones {clone_sources}\n"
}, verbose)
for source in clone_sources:
if source['datasetchild'] == '':
be_clone = f"{boot_environment_dataset}"
else:
be_clone = f"{boot_environment_dataset}/{source['datasetchild']}"
try:
pyzfscmds.cmd.zfs_clone(source['snapshot'],
be_clone,
properties=source['properties'])
except RuntimeError as e:
ZELogger.log(
{
"level":
"EXCEPTION",
"message": (f"Failed to create {boot_environment_dataset}",
f" from {clone_sources['snapshot']}")
},
exit_on_error=True)
if bootloader_plugin:
try:
bootloader_plugin.post_create()
except RuntimeWarning as err:
ZELogger.verbose_log(
{
"level":
"WARNING",
"message":
f"During {bootloader_plugin.bootloader} post create the following"
f" occurred:\n\n{err}\nContinuing creation.\n"
}, verbose)
except RuntimeError as err:
ZELogger.log(
{
"level":
"EXCEPTION",
"message":
f"During {bootloader_plugin.bootloader} post create the following "
f"occurred:\n\n{err}\nStopping creation.\n"
},
exit_on_error=True)
except AttributeError:
ZELogger.verbose_log(
{
"level":
"INFO",
"message":
f"Tried to run {bootloader_plugin.bootloader} 'post create', "
f"not implemented.\n"
}, verbose)
def get_clones(root_dataset: str, existing: Optional[str]) -> list:
parent_dataset = zfs_utility.dataset_parent(root_dataset)
clone_data = []
list_dataset = None # Dataset we are listing clones under
if existing:
existing_dataset = f"{parent_dataset}/{existing}"
if zfs_utility.is_snapshot(existing_dataset):
snap_suffix = existing_dataset.rsplit('@', 1)[-1]
list_dataset = zfs_utility.snapshot_parent_dataset(
existing_dataset)
else:
if zfs_utility.dataset_exists(existing_dataset):
snap_suffix = zedenv.lib.be.snapshot(existing, parent_dataset)
list_dataset = f"{parent_dataset}/{existing}"
else:
ZELogger.log(
{
"level": "EXCEPTION",
"message":
f"The dataset {existing_dataset} doesn't exist."
},
exit_on_error=True)
else:
snap_suffix = zedenv.lib.be.snapshot(
zfs_utility.dataset_child_name(root_dataset), parent_dataset)
list_dataset = root_dataset
clones = None
try:
clones = pyzfscmds.cmd.zfs_list(list_dataset,
recursive=True,
columns=["name"])
except RuntimeError as e:
ZELogger.log(
{
"level": "EXCEPTION",
"message": f"Failed to list datasets under {root_dataset}."
},
exit_on_error=True)
for c in [line for line in clones.splitlines()]:
if zfs_utility.dataset_exists(f"{c}@{snap_suffix}",
zfs_type="snapshot"):
if c == list_dataset:
child = ""
else:
child = zfs_utility.dataset_child_name(c)
clone_props = zedenv.lib.be.properties(c, [["canmount", "off"]])
clone_data.append({
"snapshot": f"{c}@{snap_suffix}",
"properties": clone_props,
"datasetchild": child
})
else:
ZELogger.log(
{
"level": "EXCEPTION",
"message": f"Failed to find snapshot {c}@{snap_suffix}."
},
exit_on_error=True)
return clone_data
def zedenv_create(parent_dataset: str, root_dataset: str,
boot_environment: str, verbose: bool,
existing: Optional[str]):
"""
:Parameters:
parent_dataset : str
Dataset boot environment root, commonly 'zpool/ROOT'.
root_dataset : str
Current boot dataset.
boot_environment : str
Name of new boot environment, e.g. default-02
verbose : bool
Print information verbosely.
existing : bool
Create boot environment from certain dataset.
:return:
"""
ZELogger.verbose_log(
{
"level": "INFO",
"message": "Creating Boot Environment:\n"
}, verbose)
# Remove the final part of the data set after the last / and add new name
boot_environment_dataset = f"{parent_dataset}/{boot_environment}"
if zfs_utility.dataset_exists(boot_environment_dataset):
ZELogger.log(
{
"level":
"EXCEPTION",
"message":
f"Failed to create {boot_environment_dataset}, already exists."
},
exit_on_error=True)
# Getting snapshot for clone
clone_sources = get_clones(root_dataset, existing)
ZELogger.verbose_log(
{
"level":
"INFO",
"message":
f"Getting properties of {boot_environment_dataset} for clones {clone_sources}\n"
}, verbose)
for source in clone_sources:
if source['datasetchild'] == '':
be_clone = f"{boot_environment_dataset}"
else:
be_clone = f"{boot_environment_dataset}/{source['datasetchild']}"
try:
pyzfscmds.cmd.zfs_clone(source['snapshot'],
be_clone,
properties=source['properties'])
except RuntimeError as e:
ZELogger.log(
{
"level":
"EXCEPTION",
"message": (f"Failed to create {boot_environment_dataset}",
f" from {clone_sources['snapshot']}")
},
exit_on_error=True)