summaryrefslogtreecommitdiff
path: root/cloudinit/net/activators.py
blob: 34fee3bf47c41a68fb9e5f668bd15fd58d19e1ac (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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# This file is part of cloud-init. See LICENSE file for license information.
import logging
import os
from abc import ABC, abstractmethod
from typing import Iterable, List, Type

from cloudinit import subp
from cloudinit import util
from cloudinit.net.eni import available as eni_available
from cloudinit.net.netplan import available as netplan_available
from cloudinit.net.network_state import NetworkState
from cloudinit.net.sysconfig import NM_CFG_FILE


LOG = logging.getLogger(__name__)


class NetworkActivator(ABC):
    @staticmethod
    @abstractmethod
    def available() -> bool:
        raise NotImplementedError()

    @staticmethod
    @abstractmethod
    def bring_up_interface(device_name: str) -> bool:
        raise NotImplementedError()

    @classmethod
    def bring_up_interfaces(cls, device_names: Iterable[str]) -> bool:
        all_succeeded = True
        for device in device_names:
            if not cls.bring_up_interface(device):
                all_succeeded = False
        return all_succeeded

    @classmethod
    def bring_up_all_interfaces(cls, network_state: NetworkState) -> bool:
        return cls.bring_up_interfaces(
            [i['name'] for i in network_state.iter_interfaces()]
        )


class IfUpDownActivator(NetworkActivator):
    # Note that we're not overriding bring_up_interfaces to pass something
    # like ifup --all because it isn't supported everywhere.
    # E.g., NetworkManager has a ifupdown plugin that requires the name
    # of a specific connection.
    @staticmethod
    def available(target=None) -> bool:
        """Return true if ifupdown can be used on this system."""
        return eni_available(target=target)

    @staticmethod
    def bring_up_interface(device_name: str) -> bool:
        """Bring up interface using ifup."""
        cmd = ['ifup', device_name]
        LOG.debug("Attempting to run bring up interface %s using command %s",
                  device_name, cmd)
        try:
            (_out, err) = subp.subp(cmd)
            if len(err):
                LOG.warning("Running %s resulted in stderr output: %s",
                            cmd, err)
            return True
        except subp.ProcessExecutionError:
            util.logexc(LOG, "Running interface command %s failed", cmd)
            return False


class NetworkManagerActivator(NetworkActivator):
    @staticmethod
    def available(target=None) -> bool:
        config_present = os.path.isfile(
            subp.target_path(target, path=NM_CFG_FILE)
        )
        nmcli_present = subp.which('nmcli', target=target)
        return config_present and bool(nmcli_present)

    @staticmethod
    def bring_up_interface(device_name: str) -> bool:
        try:
            subp.subp(['nmcli', 'connection', 'up', device_name])
        except subp.ProcessExecutionError:
            util.logexc(LOG, "nmcli failed to bring up {}".format(device_name))
            return False
        return True


class NetplanActivator(NetworkActivator):
    @staticmethod
    def available(target=None) -> bool:
        return netplan_available(target=target)

    @staticmethod
    def _apply_netplan():
        LOG.debug('Applying current netplan config')
        try:
            subp.subp(['netplan', 'apply'], capture=True)
        except subp.ProcessExecutionError:
            util.logexc(LOG, "netplan apply failed")
            return False
        return True

    @staticmethod
    def bring_up_interface(device_name: str) -> bool:
        LOG.debug("Calling 'netplan apply' rather than "
                  "bringing up individual interfaces")
        return NetplanActivator._apply_netplan()

    @staticmethod
    def bring_up_interfaces(device_names: Iterable[str]) -> bool:
        LOG.debug("Calling 'netplan apply' rather than "
                  "bringing up individual interfaces")
        return NetplanActivator._apply_netplan()

    @staticmethod
    def bring_up_all_interfaces(network_state: NetworkState) -> bool:
        return NetplanActivator._apply_netplan()


# This section is mostly copied and pasted from renderers.py. An abstract
# version to encompass both seems overkill at this point
DEFAULT_PRIORITY = [
    IfUpDownActivator,
    NetworkManagerActivator,
    NetplanActivator,
]


def search_activator(
    priority=None, target=None
) -> List[Type[NetworkActivator]]:
    if priority is None:
        priority = DEFAULT_PRIORITY

    unknown = [i for i in priority if i not in DEFAULT_PRIORITY]
    if unknown:
        raise ValueError(
            "Unknown activators provided in priority list: %s" % unknown)

    return [activator for activator in priority if activator.available(target)]


def select_activator(priority=None, target=None) -> Type[NetworkActivator]:
    found = search_activator(priority, target)
    if not found:
        if priority is None:
            priority = DEFAULT_PRIORITY
        tmsg = ""
        if target and target != "/":
            tmsg = " in target=%s" % target
        raise RuntimeError(
            "No available network activators found%s. Searched "
            "through list: %s" % (tmsg, priority))
    return found[0]