def _customize_envionment(client: IntegrationInstance):
client.write_to_file(
"/etc/cloud/cloud.cfg.d/99-detect-lxd.cfg",
"datasource_list: [LXD]\n",
)
client.execute("cloud-init clean --logs")
client.restart()
def _customize_envionment(client: IntegrationInstance):
# Assert our platform can detect LXD during sytemd generator timeframe.
ds_id_log = client.execute("cat /run/cloud-init/ds-identify.log").stdout
assert "check for 'LXD' returned found" in ds_id_log
# At some point Jammy will fail this test. We want to be informed
# when Jammy images no longer ship NoCloud template files (LP: #1958460).
assert "check for 'NoCloud' returned found" in ds_id_log
if client.settings.PLATFORM == "lxd_vm":
# ds-identify runs at systemd generator time before /dev/lxd/sock.
# Assert we can expected artifact which indicates LXD is viable.
result = client.execute("cat /sys/class/dmi/id/board_name")
if not result.ok:
raise AssertionError(
"Missing expected /sys/class/dmi/id/board_name")
if "LXD" != result.stdout:
raise AssertionError(f"DMI board_name is not LXD: {result.stdout}")
# Having multiple datasources prevents ds-identify from short-circuiting
# detection logic with a log like:
# single entry in datasource_list (LXD) use that.
# Also, NoCloud is detected during init-local timeframe.
# If there is a race on VMs where /dev/lxd/sock is not setup in init-local
# cloud-init will fallback to NoCloud and fail this test.
client.write_to_file(
"/etc/cloud/cloud.cfg.d/99-detect-lxd-first.cfg",
"datasource_list: [LXD, NoCloud]\n",
)
client.execute("cloud-init clean --logs")
client.restart()
def _customize_envionment(client: IntegrationInstance):
# Insert our "disable_network_config" file here
client.write_to_file(
"/etc/cloud/cloud.cfg.d/99-disable-network-config.cfg",
"network: {config: disabled}\n",
)
client.execute("cloud-init clean --logs")
client.restart()
def custom_client(client: IntegrationInstance,
tmpdir) -> Iterator[IntegrationInstance]:
client.write_to_file(f"/etc/cloud/cloud.cfg.d/{CUSTOM_CLOUD_DIR_FN}",
CUSTOM_CLOUD_DIR)
client.execute(f"rm -rf {DEFAULT_CLOUD_DIR}") # Remove previous cloud_dir
client.execute("cloud-init clean --logs")
client.restart()
yield client
def _customize_environment(client: IntegrationInstance):
# Insert our "disable_network_activation" file here
client.write_to_file(
"/etc/cloud/cloud.cfg.d/99-disable-network-activation.cfg",
"disable_network_activation: true\n",
)
client.execute("cloud-init clean --logs")
client.restart()
def _add_dummy_bridge_to_netplan(client: IntegrationInstance):
# Update netplan configuration to ensure it doesn't change on reboot
netplan = yaml.safe_load(
client.execute("cat /etc/netplan/50-cloud-init.yaml"))
# Just a dummy bridge to do nothing
try:
netplan["network"]["bridges"]["dummy0"] = {"dhcp4": False}
except KeyError:
netplan["network"]["bridges"] = {"dummy0": {"dhcp4": False}}
dumped_netplan = yaml.dump(netplan)
client.write_to_file("/etc/netplan/50-cloud-init.yaml", dumped_netplan)
def _add_dummy_bridge_to_netplan(client: IntegrationInstance):
# Update netplan configuration to ensure it doesn't change on reboot
netplan = yaml.safe_load(
client.execute('cat /etc/netplan/50-cloud-init.yaml'))
# Just a dummy bridge to do nothing
try:
netplan['network']['bridges']['dummy0'] = {'dhcp4': False}
except KeyError:
netplan['network']['bridges'] = {'dummy0': {'dhcp4': False}}
dumped_netplan = yaml.dump(netplan)
client.write_to_file('/etc/netplan/50-cloud-init.yaml', dumped_netplan)
def test_disk_setup_when_mounted(
self, create_disk, client: IntegrationInstance
):
"""Test lp-1920939.
We insert an extra disk into our VM, format it to have two partitions,
modify our cloud config to mount devices before disk setup, and modify
our userdata to setup a single partition on the disk.
This allows cloud-init to attempt disk setup on a mounted partition.
When blockdev is in use, it will fail with
"blockdev: ioctl error on BLKRRPART: Device or resource busy" along
with a warning and a traceback. When partprobe is in use, everything
should work successfully.
"""
log = client.read_from_file("/var/log/cloud-init.log")
self._verify_first_disk_setup(client, log)
# Ensure NoCloud gets detected on reboot
client.execute("mkdir -p /var/lib/cloud/seed/nocloud-net/")
client.execute("touch /var/lib/cloud/seed/nocloud-net/meta-data")
client.write_to_file(
"/etc/cloud/cloud.cfg.d/99_nocloud.cfg",
"datasource_list: [ NoCloud ]\n",
)
# Update our userdata and cloud.cfg to mount then perform new disk
# setup
client.write_to_file(
"/var/lib/cloud/seed/nocloud-net/user-data",
UPDATED_PARTPROBE_USERDATA,
)
client.execute(
"sed -i 's/write-files/write-files\\n - mounts/' "
"/etc/cloud/cloud.cfg"
)
client.execute("cloud-init clean --logs")
client.restart()
# Assert new setup works as expected
verify_clean_log(log)
lsblk = json.loads(client.execute("lsblk --json"))
sdb = [x for x in lsblk["blockdevices"] if x["name"] == "sdb"][0]
assert len(sdb["children"]) == 1
assert sdb["children"][0]["name"] == "sdb1"
if "mountpoint" in sdb["children"][0]:
assert sdb["children"][0]["mountpoint"] == "/mnt3"
else:
assert sdb["children"][0]["mountpoints"] == ["/mnt3"]
def test_datasource_rbx_no_stacktrace(client: IntegrationInstance):
client.write_to_file(
"/etc/cloud/cloud.cfg.d/90_dpkg.cfg",
"datasource_list: [ RbxCloud, NoCloud, LXD ]\n",
)
client.write_to_file(
"/etc/cloud/ds-identify.cfg",
"policy: enabled\n",
)
client.execute("cloud-init clean --logs")
client.restart()
log = client.read_from_file("/var/log/cloud-init.log")
verify_clean_log(log)
assert "Failed to load metadata and userdata" not in log
assert ("Getting data from <class 'cloudinit.sources.DataSourceRbxCloud."
"DataSourceRbxCloud'> failed" not in log)
def test_frequency_override(client: IntegrationInstance):
# Some pre-checks
assert ("running config-scripts-user with frequency once-per-instance"
in client.read_from_file("/var/log/cloud-init.log"))
assert client.read_from_file("/var/tmp/hi").strip().count("hi") == 1
# Change frequency of scripts-user to always
config = client.read_from_file("/etc/cloud/cloud.cfg")
new_config = config.replace("- scripts-user", "- [ scripts-user, always ]")
client.write_to_file("/etc/cloud/cloud.cfg", new_config)
client.restart()
# Ensure the script was run again
assert ("running config-scripts-user with frequency always"
in client.read_from_file("/var/log/cloud-init.log"))
assert client.read_from_file("/var/tmp/hi").strip().count("hi") == 2
def test_datasource_rbx_no_stacktrace(client: IntegrationInstance):
client.write_to_file(
'/etc/cloud/cloud.cfg.d/90_dpkg.cfg',
'datasource_list: [ RbxCloud, NoCloud ]\n',
)
client.write_to_file(
'/etc/cloud/ds-identify.cfg',
'policy: enabled\n',
)
client.execute('cloud-init clean --logs')
client.restart()
log = client.read_from_file('/var/log/cloud-init.log')
assert 'WARNING' not in log
assert 'Traceback' not in log
assert 'Failed to load metadata and userdata' not in log
assert ("Getting data from <class 'cloudinit.sources.DataSourceRbxCloud."
"DataSourceRbxCloud'> failed") not in log
def test_nocloud_seedfrom_vendordata(client: IntegrationInstance):
seed_dir = '/var/tmp/test_seed_dir'
result = client.execute(
"mkdir {seed_dir} && "
"touch {seed_dir}/user-data && "
"touch {seed_dir}/meta-data && "
"echo 'seedfrom: {seed_dir}/' > "
"/var/lib/cloud/seed/nocloud-net/meta-data".format(seed_dir=seed_dir)
)
assert result.return_code == 0
client.write_to_file(
'{}/vendor-data'.format(seed_dir),
VENDOR_DATA,
)
client.execute('cloud-init clean --logs')
client.restart(raise_on_cloudinit_failure=True)
assert 'seeded_vendordata_test_file' in client.execute('ls /var/tmp')
def test_nocloud_seedfrom_vendordata(client: IntegrationInstance):
seed_dir = "/var/tmp/test_seed_dir"
result = client.execute(
"mkdir {seed_dir} && "
"touch {seed_dir}/user-data && "
"touch {seed_dir}/meta-data && "
"echo 'seedfrom: {seed_dir}/' > "
"/var/lib/cloud/seed/nocloud-net/meta-data".format(seed_dir=seed_dir))
assert result.return_code == 0
client.write_to_file(
"{}/vendor-data".format(seed_dir),
VENDOR_DATA,
)
client.execute("cloud-init clean --logs")
client.restart()
assert client.execute("cloud-init status").ok
assert "seeded_vendordata_test_file" in client.execute("ls /var/tmp")
def test_disk_setup_when_mounted(
self, create_disk, client: IntegrationInstance
):
"""Test lp-1920939.
We insert an extra disk into our VM, format it to have two partitions,
modify our cloud config to mount devices before disk setup, and modify
our userdata to setup a single partition on the disk.
This allows cloud-init to attempt disk setup on a mounted partition.
When blockdev is in use, it will fail with
"blockdev: ioctl error on BLKRRPART: Device or resource busy" along
with a warning and a traceback. When partprobe is in use, everything
should work successfully.
"""
log = client.read_from_file('/var/log/cloud-init.log')
self._verify_first_disk_setup(client, log)
# Update our userdata and cloud.cfg to mount then perform new disk
# setup
client.write_to_file(
'/var/lib/cloud/seed/nocloud-net/user-data',
UPDATED_PARTPROBE_USERDATA,
)
client.execute(
"sed -i 's/write-files/write-files\\n - mounts/' "
"/etc/cloud/cloud.cfg"
)
client.execute('cloud-init clean --logs')
client.restart()
# Assert new setup works as expected
assert 'Traceback' not in log
assert 'WARN' not in log
lsblk = json.loads(client.execute('lsblk --json'))
sdb = [x for x in lsblk['blockdevices'] if x['name'] == 'sdb'][0]
assert len(sdb['children']) == 1
assert sdb['children'][0]['name'] == 'sdb1'
assert sdb['children'][0]['mountpoint'] == '/mnt3'
def _customize_envionment(client: IntegrationInstance):
# Assert our platform can detect LXD during systemd generator timeframe.
ds_id_log = client.execute("cat /run/cloud-init/ds-identify.log").stdout
assert "check for 'LXD' returned found" in ds_id_log
if client.settings.PLATFORM == "lxd_vm":
# ds-identify runs at systemd generator time before /dev/lxd/sock.
# Assert we can expected artifact which indicates LXD is viable.
result = client.execute("cat /sys/class/dmi/id/board_name")
if not result.ok:
raise AssertionError(
"Missing expected /sys/class/dmi/id/board_name")
if "LXD" != result.stdout:
raise AssertionError(f"DMI board_name is not LXD: {result.stdout}")
# Having multiple datasources prevents ds-identify from short-circuiting
# detection logic with a log like:
# single entry in datasource_list (LXD) use that.
# Also, NoCloud is detected during init-local timeframe.
# If there is a race on VMs where /dev/lxd/sock is not setup in init-local
# cloud-init will fallback to NoCloud and fail this test.
client.write_to_file(
"/etc/cloud/cloud.cfg.d/99-detect-lxd-first.cfg",
"datasource_list: [LXD, NoCloud]\n",
)
# This is also to ensure that NoCloud can be detected
if ImageSpecification.from_os_image().release == "jammy":
# Add nocloud-net seed files because Jammy no longer delivers NoCloud
# (LP: #1958460).
client.execute("mkdir -p /var/lib/cloud/seed/nocloud-net")
client.write_to_file("/var/lib/cloud/seed/nocloud-net/meta-data", "")
client.write_to_file("/var/lib/cloud/seed/nocloud-net/user-data",
"#cloud-config\n{}")
client.execute("cloud-init clean --logs")
client.restart()
