summaryrefslogtreecommitdiff
path: root/tests/integration_tests/modules/test_user_events.py
blob: 79d8802221b05b2c980a3f450ac3cc863de9cda8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
"""Test user-overridable events.

This is currently limited to applying network config on BOOT events.
"""

import re

import pytest
import yaml

from tests.integration_tests.instances import IntegrationInstance
from tests.integration_tests.integration_settings import PLATFORM


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)


@pytest.mark.skipif(
    PLATFORM
    not in ["lxd_container", "lxd_vm", "ec2", "gce", "oci", "openstack"],
    reason="Default boot events testing is datasource specific",
)
def test_boot_event_disabled_by_default(client: IntegrationInstance):
    log = client.read_from_file("/var/log/cloud-init.log")
    if "network config is disabled" in log:
        pytest.skip("network config disabled. Test doesn't apply")
    assert "Applying network configuration" in log
    assert "dummy0" not in client.execute("ls /sys/class/net")

    _add_dummy_bridge_to_netplan(client)
    client.execute("rm /var/log/cloud-init.log")

    client.restart()
    log2 = client.read_from_file("/var/log/cloud-init.log")

    if "cache invalid in datasource" in log2:
        # Invalid cache will get cleared, meaning we'll create a new
        # "instance" and apply networking config, so events aren't
        # really relevant here
        pytest.skip("Test only valid for existing instances")

    # We attempt to apply network config twice on every boot.
    # Ensure neither time works.
    assert 2 == len(
        re.findall(
            r"Event Denied: scopes=\['network'\] EventType=boot[^-]", log2
        )
    )
    assert 2 == log2.count(
        "Event Denied: scopes=['network'] EventType=boot-legacy"
    )
    assert 2 == log2.count(
        "No network config applied. Neither a new instance"
        " nor datasource network update allowed"
    )

    assert "dummy0" in client.execute("ls /sys/class/net")


def _test_network_config_applied_on_reboot(client: IntegrationInstance):
    log = client.read_from_file("/var/log/cloud-init.log")
    if "network config is disabled" in log:
        pytest.skip("network config disabled. Test doesn't apply")
    assert "Applying network configuration" in log
    assert "dummy0" not in client.execute("ls /sys/class/net")

    _add_dummy_bridge_to_netplan(client)
    client.execute('echo "" > /var/log/cloud-init.log')
    client.restart()

    log = client.read_from_file("/var/log/cloud-init.log")
    if "cache invalid in datasource" in log:
        # Invalid cache will get cleared, meaning we'll create a new
        # "instance" and apply networking config, so events aren't
        # really relevant here
        pytest.skip("Test only valid for existing instances")

    assert "Event Allowed: scope=network EventType=boot" in log
    assert "Applying network configuration" in log
    assert "dummy0" not in client.execute("ls /sys/class/net")


@pytest.mark.skipif(
    PLATFORM != "azure",
    reason=(
        f"{PLATFORM} doesn't support updates every boot event by default "
        "(or hasn't been testing for it)."
    ),
)
def test_boot_event_enabled_by_default(client: IntegrationInstance):
    _test_network_config_applied_on_reboot(client)


USER_DATA = """\
#cloud-config
updates:
  network:
    when: [boot]
"""


@pytest.mark.user_data(USER_DATA)
def test_boot_event_enabled(client: IntegrationInstance):
    _test_network_config_applied_on_reboot(client)