1
diff --git a/cloudinit/net/netplan.py b/cloudinit/net/netplan.py
2
index 7444ae3..825fe83 100644
3
--- a/cloudinit/net/netplan.py
4
+++ b/cloudinit/net/netplan.py
5
@@ -10,6 +10,21 @@ from cloudinit import log as logging
6
10
from cloudinit import util
10
from cloudinit import util
7
11
from cloudinit.net import SYS_CLASS_NET, get_devicelist
11
from cloudinit.net import SYS_CLASS_NET, get_devicelist
8
12
12
9
13
KNOWN_SNAPD_CONFIG = b"""\
10
14
# This is the initial network config.
11
15
# It can be overwritten by cloud-init or console-conf.
12
16
network:
13
17
    version: 2
14
18
    ethernets:
15
19
        all-en:
16
20
            match:
17
21
                name: "en*"
18
22
            dhcp4: true
19
23
        all-eth:
20
24
            match:
21
25
                name: "eth*"
22
26
            dhcp4: true
23
27
"""
24
13
28
25
14
LOG = logging.getLogger(__name__)
29
LOG = logging.getLogger(__name__)
26
15
NET_CONFIG_TO_V2 = {
30
NET_CONFIG_TO_V2 = {
27
@@ -154,6 +169,28 @@ def _extract_bond_slaves_by_name(interfaces, entry, bond_master):
28
154
        entry.update({'interfaces': bond_slave_names})
169
        entry.update({'interfaces': bond_slave_names})
29
155
170
30
156
171
31
172
def _clean_default(target=None):
32
173
    # clean out any known default files and derived files in target
33
174
    # LP: #1675576
34
175
    tpath = util.target_path(target, "etc/netplan/00-snapd-config.yaml")
35
176
    if not os.path.isfile(tpath):
36
177
        return
37
178
    content = util.load_file(tpath, decode=False)
38
179
    if content != KNOWN_SNAPD_CONFIG:
39
180
        return
40
181
41
182
    derived = [util.target_path(target, f) for f in (
42
183
               'run/systemd/network/10-netplan-all-en.network',
43
184
               'run/systemd/network/10-netplan-all-eth.network',
44
185
               'run/systemd/generator/netplan.stamp')]
45
186
    existing = [f for f in derived if os.path.isfile(f)]
46
187
    LOG.debug("removing known config '%s' and derived existing files: %s",
47
188
              tpath, existing)
48
189
49
190
    for f in [tpath] + existing:
50
191
        os.unlink(f)
51
192
52
193
53
157
class Renderer(renderer.Renderer):
194
class Renderer(renderer.Renderer):
54
158
    """Renders network information in a /etc/netplan/network.yaml format."""
195
    """Renders network information in a /etc/netplan/network.yaml format."""
55
159
196
56
@@ -166,6 +203,7 @@ class Renderer(renderer.Renderer):
57
166
                                       'etc/netplan/50-cloud-init.yaml')
203
                                       'etc/netplan/50-cloud-init.yaml')
58
167
        self.netplan_header = config.get('netplan_header', None)
204
        self.netplan_header = config.get('netplan_header', None)
59
168
        self._postcmds = config.get('postcmds', False)
205
        self._postcmds = config.get('postcmds', False)
60
206
        self.clean_default = config.get('clean_default', True)
61
169
207
62
170
    def render_network_state(self, target, network_state):
208
    def render_network_state(self, target, network_state):
63
171
        # check network state for version
209
        # check network state for version
64
@@ -182,6 +220,8 @@ class Renderer(renderer.Renderer):
65
182
            header += "\n"
220
            header += "\n"
66
183
        util.write_file(fpnplan, header + content)
221
        util.write_file(fpnplan, header + content)
67
184
222
68
223
        if self.clean_default:
69
224
            _clean_default(target=target)
70
185
        self._netplan_generate(run=self._postcmds)
225
        self._netplan_generate(run=self._postcmds)
71
186
        self._net_setup_link(run=self._postcmds)
226
        self._net_setup_link(run=self._postcmds)
72
187
227
73
diff --git a/tests/unittests/test_net.py b/tests/unittests/test_net.py
74
index 4f07d80..bfd04ba 100644
75
--- a/tests/unittests/test_net.py
76
+++ b/tests/unittests/test_net.py
77
@@ -974,12 +974,14 @@ iface eth0 inet dhcp
78
974
974
79
975
class TestNetplanNetRendering(CiTestCase):
975
class TestNetplanNetRendering(CiTestCase):
80
976
976
81
977
    @mock.patch("cloudinit.net.netplan._clean_default")
82
977
    @mock.patch("cloudinit.net.sys_dev_path")
978
    @mock.patch("cloudinit.net.sys_dev_path")
83
978
    @mock.patch("cloudinit.net.read_sys_net")
979
    @mock.patch("cloudinit.net.read_sys_net")
84
979
    @mock.patch("cloudinit.net.get_devicelist")
980
    @mock.patch("cloudinit.net.get_devicelist")
85
980
    def test_default_generation(self, mock_get_devicelist,
981
    def test_default_generation(self, mock_get_devicelist,
86
981
                                mock_read_sys_net,
982
                                mock_read_sys_net,
88
982
                                mock_sys_dev_path):
983
                                mock_sys_dev_path,
89
984
                                mock_clean_default):
90
983
        tmp_dir = self.tmp_dir()
985
        tmp_dir = self.tmp_dir()
91
984
        _setup_test(tmp_dir, mock_get_devicelist,
986
        _setup_test(tmp_dir, mock_get_devicelist,
92
985
                    mock_read_sys_net, mock_sys_dev_path)
987
                    mock_read_sys_net, mock_sys_dev_path)
93
@@ -1013,6 +1015,69 @@ network:
94
1013
            set-name: eth1000
1015
            set-name: eth1000
95
1014
"""
1016
"""
96
1015
        self.assertEqual(expected.lstrip(), contents.lstrip())
1017
        self.assertEqual(expected.lstrip(), contents.lstrip())
97
1018
        self.assertEqual(1, mock_clean_default.call_count)
98
1019
99
1020
100
1021
class TestNetplanCleanDefault(CiTestCase):
101
1022
    snapd_known_path = 'etc/netplan/00-snapd-config.yaml'
102
1023
    snapd_known_content = textwrap.dedent("""\
103
1024
        # This is the initial network config.
104
1025
        # It can be overwritten by cloud-init or console-conf.
105
1026
        network:
106
1027
            version: 2
107
1028
            ethernets:
108
1029
                all-en:
109
1030
                    match:
110
1031
                        name: "en*"
111
1032
                    dhcp4: true
112
1033
                all-eth:
113
1034
                    match:
114
1035
                        name: "eth*"
115
1036
                    dhcp4: true
116
1037
        """)
117
1038
    stub_known = {
118
1039
        'run/systemd/network/10-netplan-all-en.network': 'foo-en',
119
1040
        'run/systemd/network/10-netplan-all-eth.network': 'foo-eth',
120
1041
        'run/systemd/generator/netplan.stamp': 'stamp',
121
1042
    }
122
1043
123
1044
    def test_clean_known_config_cleaned(self):
124
1045
        content = {self.snapd_known_path: self.snapd_known_content, }
125
1046
        content.update(self.stub_known)
126
1047
        tmpd = self.tmp_dir()
127
1048
        files = sorted(populate_dir(tmpd, content))
128
1049
        netplan._clean_default(target=tmpd)
129
1050
        found = [t for t in files if os.path.exists(t)]
130
1051
        self.assertEqual([], found)
131
1052
132
1053
    def test_clean_unknown_config_not_cleaned(self):
133
1054
        content = {self.snapd_known_path: self.snapd_known_content, }
134
1055
        content.update(self.stub_known)
135
1056
        content[self.snapd_known_path] += "# user put a comment\n"
136
1057
        tmpd = self.tmp_dir()
137
1058
        files = sorted(populate_dir(tmpd, content))
138
1059
        netplan._clean_default(target=tmpd)
139
1060
        found = [t for t in files if os.path.exists(t)]
140
1061
        self.assertEqual(files, found)
141
1062
142
1063
    def test_clean_known_config_cleans_only_expected(self):
143
1064
        astamp = "run/systemd/generator/another.stamp"
144
1065
        anet = "run/systemd/network/10-netplan-all-lo.network"
145
1066
        ayaml = "etc/netplan/01-foo-config.yaml"
146
1067
        content = {
147
1068
            self.snapd_known_path: self.snapd_known_content,
148
1069
            astamp: "stamp",
149
1070
            anet: "network",
150
1071
            ayaml: "yaml",
151
1072
        }
152
1073
        content.update(self.stub_known)
153
1074
154
1075
        tmpd = self.tmp_dir()
155
1076
        files = sorted(populate_dir(tmpd, content))
156
1077
        netplan._clean_default(target=tmpd)
157
1078
        found = [t for t in files if os.path.exists(t)]
158
1079
        expected = [util.target_path(tmpd, f) for f in (astamp, anet, ayaml)]
159
1080
        self.assertEqual(sorted(expected), found)
160
1016
1081
161
1017
1082
162
1018
class TestNetplanPostcommands(CiTestCase):
1083
class TestNetplanPostcommands(CiTestCase):
Reviewer	Review Type	Date Requested	Status
Server Team CI bot	continuous-integration		Approve on 2017-03-30
Ryan Harper		2017-03-30	Approve on 2017-03-30
Review via email: mp+321471@code.launchpad.net