1
diff --git a/docs/metadata.yaml b/docs/metadata.yaml
2
index 4fabdd1..82bf35f 100644
3
--- a/docs/metadata.yaml
4
+++ b/docs/metadata.yaml
5
@@ -27,6 +27,8 @@ navigation:
6
27
    children:
27
    children:
7
28
      - title: Snap Configuration
28
      - title: Snap Configuration
8
29
        children:
29
        children:
9
30
          - title: Ethernet Support
10
31
            location: reference/configuration/ethernet_support.md
11
30
          - title: Debug
32
          - title: Debug
12
31
            location: reference/snap-configuration/debug.md
33
            location: reference/snap-configuration/debug.md
13
32
          - title: Wake on WLAN
34
          - title: Wake on WLAN
14
diff --git a/docs/reference/configuration/ethernet_support.md b/docs/reference/configuration/ethernet_support.md
15
33
new file mode 100644
35
new file mode 100644
16
index 0000000..fbc5929
17
--- /dev/null
18
+++ b/docs/reference/configuration/ethernet_support.md
19
@@ -0,0 +1,47 @@
20
1
---
21
2
title: Ethernet Support
22
3
table_of_contents: true
23
4
---
24
5
25
6
# Ethernet Support
26
7
27
8
*Available since:* 1.2.2-12
28
9
29
10
The NetworkManager snap provides a configuration option to adjust
30
11
if it should manage ethernet network connections.
31
12
32
13
By default the NetworkManager snap **does not** manage ethernet network
33
14
devices as it would conflict with the default network management in
34
15
Ubuntu Core which is handled by [netplan](https://launchpad.net/netplan) and
35
16
[networkd](https://www.freedesktop.org/software/systemd/man/systemd-networkd.service.html).
36
17
37
18
## Enable Ethernet Support
38
19
39
20
To enable management of ethernet network devices the snap provides the
40
21
*ethernet.enable* configuration option.
41
22
42
23
This configuration option accepts the following values
43
24
44
25
 * **false (default):** Ethernet support is disabled. All network
45
26
 devices matching the expression 'en*' or 'eth*' will be ignored.
46
27
 * **true:** All ethernet devices available on the system will be
47
28
 managed by NetworkManager. networkd will not manage any of these
48
29
 anymore.
49
30
50
31
Changing the *ethernet* configuration option needs a reboot of the
51
32
device it's running on.
52
33
53
34
After the device has rebooted ethernet support is enabled NetworkManager will
54
35
take over management of all available ethernet network devices on the device.
55
36
56
37
NetworkManager will reuse existing configurations files from */etc/netplan*
57
38
when ethernet support is enabled. Those will marked as immutable inside
58
39
NetworkManager and any changes need to be written manually into the relevant
59
40
files in */etc/netplan*.
60
41
61
42
Example:
62
43
63
44
```
64
45
 $ snap set network-manager ethernet.enable=true
65
46
 $ sudo reboot
66
47
```
67
diff --git a/docs/reference/snap-configuration/wowlan.md b/docs/reference/snap-configuration/wowlan.md
68
index d245062..2ae0791 100644
69
--- a/docs/reference/snap-configuration/wowlan.md
70
+++ b/docs/reference/snap-configuration/wowlan.md
71
@@ -5,6 +5,8 @@ table_of_contents: True
72
5
5
73
6
# Wake on WLAN
6
# Wake on WLAN
74
7
7
75
8
*Available since:* 1.2.2-11
76
9
77
8
Wake on WLAN (called WoWLAN in the following) is a feature which allows a device
10
Wake on WLAN (called WoWLAN in the following) is a feature which allows a device
78
9
to be woken up from standby power states to faciliate device management. It is based
11
to be woken up from standby power states to faciliate device management. It is based
79
10
on the well well-established standard for Wake on LAN. The functionality is not entirely
12
on the well well-established standard for Wake on LAN. The functionality is not entirely
80
diff --git a/hooks/configure b/hooks/configure
81
index fd39ee4..386528a 100755
82
--- a/hooks/configure
83
+++ b/hooks/configure
84
@@ -78,6 +78,23 @@ switch_wifi_wake_on_wlan() {
85
78
  fi
78
  fi
86
79
}
79
}
87
80
80
88
81
switch_ethernet() {
89
82
  case "$1" in
90
83
    true)
91
84
      cat <<EOF > /etc/netplan/00-default-nm-renderer.yaml
92
85
network:
93
86
  renderer: NetworkManager
94
87
EOF
95
88
      ;;
96
89
    false)
97
90
      rm -f /etc/netplan/00-default-nm-renderer.yaml
98
91
      ;;
99
92
    *)
100
93
      echo "ERROR: Invalid value provided for ethernet"
101
94
      exit 1
102
95
  esac
103
96
}
104
97
105
81
switch_debug_enable() {
98
switch_debug_enable() {
106
82
  DEBUG_FILE=$SNAP_DATA/.debug_enabled
99
  DEBUG_FILE=$SNAP_DATA/.debug_enabled
107
83
  # $1 true/false for enabling/disabling debug log level in nm
100
  # $1 true/false for enabling/disabling debug log level in nm
108
@@ -115,6 +132,18 @@ else
109
115
  switch_wifi_wake_on_wlan disabled ""
132
  switch_wifi_wake_on_wlan disabled ""
110
116
fi
133
fi
111
117
134
112
135
value=`snapctl get ethernet.enable`
113
136
if [ -n "$value" ]; then
114
137
  switch_ethernet $value
115
138
else
116
139
  if [ -e /etc/netplan/00-default-nm-renderer.yaml ]; then
117
140
    value=true
118
141
  else
119
142
    value=false
120
143
  fi
121
144
  snapctl set ethernet.enable=$value
122
145
fi
123
146
124
118
value=$(snapctl get debug.enable)
147
value=$(snapctl get debug.enable)
125
119
if [ -n "$value" ]; then
148
if [ -n "$value" ]; then
126
120
  switch_debug_enable $value
149
  switch_debug_enable $value
127
diff --git a/run-tests.sh b/run-tests.sh
128
index 4f18f03..f069bfb 100755
129
--- a/run-tests.sh
130
+++ b/run-tests.sh
131
@@ -66,5 +66,11 @@ else
132
66
	clone_tests_extras
66
	clone_tests_extras
133
67
fi
67
fi
134
68
68
135
69
# Any project-specific options for test-runner should be specified in
136
70
# .tests_config under EXTRA_ARGS
137
71
if [ -e ".tests_config" ]; then
138
72
    . .tests_config
139
73
fi
140
74
141
69
echo "INFO: Executing tests runner"
75
echo "INFO: Executing tests runner"
143
70
cd $TESTS_EXTRAS_PATH && ./tests-runner.sh "$@"
76
cd $TESTS_EXTRAS_PATH && ./tests-runner.sh "$@" "$EXTRA_ARGS"
144
diff --git a/snapcraft.yaml b/snapcraft.yaml
145
index a7c2ea9..38a7895 100644
146
--- a/snapcraft.yaml
147
+++ b/snapcraft.yaml
148
@@ -14,10 +14,6 @@ grade: stable
149
14
slots:
14
slots:
150
15
  service: network-manager
15
  service: network-manager
151
16
16
152
17
hooks:
153
18
  configure:
154
19
    plugs: [nmcli]
155
20
156
21
plugs:
17
plugs:
157
22
  nmcli: network-manager
18
  nmcli: network-manager
158
23
  wpa:
19
  wpa:
159
@@ -25,6 +21,12 @@ plugs:
160
25
    bus: system
21
    bus: system
161
26
    name: fi.w1.wpa_supplicant1
22
    name: fi.w1.wpa_supplicant1
162
27
23
163
24
hooks:
164
25
  configure:
165
26
    plugs:
166
27
      - nmcli
167
28
      - network-setup-control
168
29
169
28
apps:
30
apps:
170
29
  nmcli:
31
  nmcli:
171
30
    command: usr/bin/nmcli
32
    command: usr/bin/nmcli
172
diff --git a/tests/lib/prepare.sh b/tests/lib/prepare.sh
173
index ffdd477..33886eb 100644
174
--- a/tests/lib/prepare.sh
175
+++ b/tests/lib/prepare.sh
176
@@ -28,8 +28,9 @@ rm -f /home/network-manager/nm-state.tar.gz
177
28
28
178
29
snap_install network-manager
29
snap_install network-manager
179
30
# FIXME: Until the store snap-declaration is updated we need to connect
30
# FIXME: Until the store snap-declaration is updated we need to connect
181
31
# this plug manually.
31
# this plugs manually.
182
32
snap connect network-manager:firewall-control
32
snap connect network-manager:firewall-control
183
33
snap connect network-manager:network-setup-control
184
33
34
185
34
# Snapshot of the current snapd state for a later restore
35
# Snapshot of the current snapd state for a later restore
186
35
systemctl stop snapd.service snapd.socket
36
systemctl stop snapd.service snapd.socket
187
diff --git a/tests/lib/utilities.sh b/tests/lib/utilities.sh
188
index b82593a..10a955a 100644
189
--- a/tests/lib/utilities.sh
190
+++ b/tests/lib/utilities.sh
191
@@ -20,10 +20,15 @@ switch_netplan_to_network_manager() {
192
20
		return 0
20
		return 0
193
21
	fi
21
	fi
194
22
22
196
23
	cat <<-EOF > /etc/netplan/00-default-nm-renderer.yaml
23
	# set ethernet.enable in case the snap is already installed
197
24
	if snap list | grep -q network-manager ; then
198
25
		snap set network-manager ethernet.enable=true
199
26
	else
200
27
		cat << EOF > /etc/netplan/00-default-nm-renderer.yaml
201
24
network:
28
network:
202
25
  renderer: NetworkManager
29
  renderer: NetworkManager
204
26
	EOF
30
EOF
205
31
	fi
206
27
}
32
}
207
28
33
208
29
switch_netplan_to_networkd() {
34
switch_netplan_to_networkd() {
209
@@ -31,7 +36,12 @@ switch_netplan_to_networkd() {
210
31
		return 0
36
		return 0
211
32
	fi
37
	fi
212
33
38
214
34
	rm /etc/netplan/00-default-nm-renderer.yaml
39
	# unset ethernet.enable in case the snap is already installed
215
40
	if snap list | grep -q network-manager ; then
216
41
		snap set network-manager ethernet.enable=false
217
42
	else
218
43
		rm /etc/netplan/00-default-nm-renderer.yaml
219
44
	fi
220
35
}
45
}
221
36
46
222
37
# waits for a service to be active. Besides that, waits enough
47
# waits for a service to be active. Besides that, waits enough
223
@@ -75,7 +85,7 @@ wait_for_network_manager() {
224
75
}
85
}
225
76
86
226
77
stop_after_first_reboot() {
87
stop_after_first_reboot() {
228
78
	if [ $SPREAD_REBOOT -eq 1 ] ; then
88
	if [ $SPREAD_REBOOT -gt 0 ] ; then
229
79
		exit 0
89
		exit 0
230
80
	fi
90
	fi
231
81
}
91
}
232
diff --git a/tests/main/aliases/task.yaml b/tests/main/aliases/task.yaml
233
index f3fd040..1ae0e05 100644
234
--- a/tests/main/aliases/task.yaml
235
+++ b/tests/main/aliases/task.yaml
236
@@ -5,12 +5,7 @@ execute: |
237
5
    # have them approved from the store in our snap-declaration assertion.
5
    # have them approved from the store in our snap-declaration assertion.
238
6
    test ! -e /snap/bin/nmcli
6
    test ! -e /snap/bin/nmcli
239
7
7
246
8
    snapd_version=$(snap version | awk '/^snapd / {print $2; exit}')
8
    snap alias $SNAP_NAME.nmcli nmcli
241
9
    target=$SNAP_NAME.nmcli
242
10
    if dpkg --compare-versions $snapd_version lt 2.25 ; then
243
11
        target=$SNAP_NAME
244
12
    fi
245
13
    snap alias $target nmcli
247
14
9
248
15
    test -e /snap/bin/nmcli
10
    test -e /snap/bin/nmcli
249
16
11
250
diff --git a/tests/main/conf-ethernet-support/task.yaml b/tests/main/conf-ethernet-support/task.yaml
251
17
new file mode 100644
12
new file mode 100644
252
index 0000000..5816a2b
253
--- /dev/null
254
+++ b/tests/main/conf-ethernet-support/task.yaml
255
@@ -0,0 +1,55 @@
256
1
summary: Verify ethernet support can be enabled via configuration option
257
2
258
3
execute: |
259
4
    . $TESTSLIB/utilities.sh
260
5
261
6
    # We need to have the network-setup-control interface available as
262
7
    # otherwise the hook can't do its job
263
8
    snap interfaces | grep network-setup-control
264
9
265
10
    case "$SPREAD_REBOOT" in
266
11
        0)
267
12
            # We should now have the interface available
268
13
            snap interfaces | grep network-setup-control
269
14
270
15
            # In the default setup NetworkManager doesn't take over ethernet
271
16
            wait_for_network_manager
272
17
273
18
            /snap/bin/network-manager.nmcli d | grep 'eth0.*unmanaged'
274
19
275
20
            # By default ethernet is disabled
276
21
            test "`snap get network-manager ethernet.enable`" = "false"
277
22
278
23
            # Enable ethernet support requires us to reboot two times to get
279
24
            # things into a right state.
280
25
            snap set network-manager ethernet.enable=true
281
26
            test "`snap get network-manager ethernet.enable`" = "true"
282
27
283
28
            REBOOT
284
29
            ;;
285
30
        1)
286
31
            wait_for_network_manager
287
32
288
33
            # NetworkManager now controls eth0 and networkd does not
289
34
            /snap/bin/network-manager.nmcli d | grep 'eth0.*connected'
290
35
            # ... and we're running with the netplan configuration
291
36
            /snap/bin/network-manager.nmcli d | grep 'netplan-eth0'
292
37
            networkctl status eth0 | grep 'State: routable'
293
38
294
39
            # Now lets switch back to network by using the configuration
295
40
            # item again and doing another reboot.
296
41
            snap set network-manager ethernet.enable=false
297
42
            test "`snap get network-manager ethernet.enable`" = "false"
298
43
            REBOOT
299
44
            ;;
300
45
        2)
301
46
            wait_for_network_manager
302
47
303
48
            # networkd manages eth0 and NetworkManager does not
304
49
            networkctl | grep 'eth0.*routable'
305
50
            /snap/bin/network-manager.nmcli d | grep 'eth0.*unmanaged'
306
51
            ;;
307
52
        *)
308
53
            exit 1
309
54
            ;;
310
55
    esac
311
diff --git a/tests/main/set-hostname/task.yaml b/tests/main/set-hostname/task.yaml
312
index ddcabd9..69b27c8 100644
313
--- a/tests/main/set-hostname/task.yaml
314
+++ b/tests/main/set-hostname/task.yaml
315
@@ -1,6 +1,10 @@
316
1
summary: Verify we can modify the hostname of the system
1
summary: Verify we can modify the hostname of the system
317
2
2
318
3
execute: |
3
execute: |
319
4
    . "$TESTSLIB/utilities.sh"
320
5
321
6
    wait_for_network_manager
322
7
323
4
    # Print out current hostname for nm and hostnamed to have a reference
8
    # Print out current hostname for nm and hostnamed to have a reference
324
5
    # for debugging later.
9
    # for debugging later.
325
6
    /snap/bin/network-manager.nmcli general hostname
10
    /snap/bin/network-manager.nmcli general hostname
Status:	Merged
Approved by:	Roberto Mier Escandon on 2017-10-18
Approved revision:	742ee696683b570c6553cdab706dea4c068ff699
Merged at revision:	e52b1341a936bb549c2e0edf3886225932c142ec
Proposed branch:	~morphis/snappy-hwe-snaps/+git/network-manager:feature/enable-ethernet-config-item
Merge into:	~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager:master
Diff against target:	325 lines (+169/-16) 11 files modified docs/metadata.yaml (+2/-0) docs/reference/configuration/ethernet_support.md (+47/-0) docs/reference/snap-configuration/wowlan.md (+2/-0) hooks/configure (+29/-0) run-tests.sh (+7/-1) snapcraft.yaml (+6/-4) tests/lib/prepare.sh (+2/-1) tests/lib/utilities.sh (+14/-4) tests/main/aliases/task.yaml (+1/-6) tests/main/conf-ethernet-support/task.yaml (+55/-0) tests/main/set-hostname/task.yaml (+4/-0)
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Simon Fels			Approve on 2017-10-18
System Enablement Bot	continuous-integration	2017-02-10	Approve on 2017-10-18
Roberto Mier Escandon (community)			Approve on 2017-10-17
Konrad Zapałowicz (community)	code		Needs Fixing on 2017-02-13
Review via email: mp+316935@code.launchpad.net