forked from NetworkManager/NetworkManager
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest-client.py
More file actions
executable file
·3100 lines (2709 loc) · 106 KB
/
test-client.py
File metadata and controls
executable file
·3100 lines (2709 loc) · 106 KB
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
# coding: utf-8
from __future__ import print_function
###############################################################################
#
# This test starts NetworkManager stub service in a user D-Bus session,
# and runs nmcli against it. The output is recorded and compared to a pre-generated
# expected output (src/tests/client/test-client.check-on-disk/*.expected) which
# is also committed to git.
#
###############################################################################
#
# HOWTO: Regenerate output
#
# When adjusting the tests, or when making changes to nmcli that intentionally
# change the output, the expected output must be regenerated.
#
# For that, you'd setup your system correctly (see SETUP below) and then simply:
#
# $ meson -Ddocs=true --prefix=/tmp/nm1 build
# $ ninja -C build
# $ ninja -C build install
# $ NM_TEST_REGENERATE=1 ninja -C build test
# $ git diff ... ; git add ...
# # The previous step regenerated the expected output. Review the changes
# # and consider whether they are correct. Then commit the changes to git.
#
# Beware that you need to install the sources, and beware to choose a prefix that doesn't
# mess up your system (see SETUP below).
#
# SETUP: For regenerating the output, the translations must work. First
# test whether the following works:
#
# 1) LANG=pl_PL.UTF-8 /usr/bin/nmcli --version
# # Ensure that Polish output works for the system-installed nmcli.
# # If not, you should ensure that `locale -a` reports the Polish
# # locale. If that is not the case, how to enable the locale depends on
# # your distro.
# #
# # On Debian, you might do:
# # sed -i 's/^# \(pl_PL.UTF-8 .*\)$/\1/p' /etc/locale.gen
# # locale-gen pl_PL.UTF-8
# # On Fedora, you might install `glibc-langpack-pl` package.
#
# 2) LANG=pl_PL.UTF-8 ./src/nmcli/nmcli --version
# # Ensure that the built nmcli has Polish locale working. If not,
# # you probably need to first `make install` the application at the
# # correct prefix. Take care to configure the build with the desired
# # prefix, like `meson setup build --prefix=/opt/tmp`. Usually, you want to avoid
# # using /usr as prefix, because that might overwrite files from your
# # package management system.
#
###############################################################################
#
# Environment variables to configure test:
# (optional) The build dir. Optional, mainly used to find the nmcli binary (in case
# ENV_NM_TEST_CLIENT_NMCLI_PATH is not set.
ENV_NM_TEST_CLIENT_BUILDDIR = "NM_TEST_CLIENT_BUILDDIR"
# (optional) Path to nmcli. By default, it looks for nmcli in build dir.
# In particular, you can test also a nmcli binary installed somewhere else.
ENV_NM_TEST_CLIENT_NMCLI_PATH = "NM_TEST_CLIENT_NMCLI_PATH"
# (optional) Path to nm-cloud-setup. By default, it looks for nm-cloud-setup
# in build dir.
ENV_NM_TEST_CLIENT_CLOUD_SETUP_PATH = "NM_TEST_CLIENT_CLOUD_SETUP_PATH"
# (optional) The test also compares tranlsated output (l10n). This requires,
# that you first install the translation in the right place. So, by default,
# if a test for a translation fails, it will mark the test as skipped, and not
# fail the tests. Under the assumption, that the test cannot succeed currently.
# By setting NM_TEST_CLIENT_CHECK_L10N=1, you can force a failure of the test.
ENV_NM_TEST_CLIENT_CHECK_L10N = "NM_TEST_CLIENT_CHECK_L10N"
# Regenerate the .expected files. Instead of asserting, rewrite the files
# on disk with the expected output.
ENV_NM_TEST_REGENERATE = "NM_TEST_REGENERATE"
# whether the file location should include the line number. That is useful
# only for debugging, to correlate the expected output with the test.
# Obviously, since the expected output is commited to git without line numbers,
# you'd have to first NM_TEST_REGENERATE the test expected data, with line
# numbers enabled.
ENV_NM_TEST_WITH_LINENO = "NM_TEST_WITH_LINENO"
# Log pexpect output to stderr, for debuging
ENV_NM_TEST_LOG_PEXPECT = "NM_TEST_LOG_PEXPECT"
ENV_NM_TEST_ASAN_OPTIONS = "NM_TEST_ASAN_OPTIONS"
ENV_NM_TEST_LSAN_OPTIONS = "NM_TEST_LSAN_OPTIONS"
ENV_NM_TEST_UBSAN_OPTIONS = "NM_TEST_UBSAN_OPTIONS"
# Run nmcli under valgrind. If unset, we honor NMTST_USE_VALGRIND instead.
# Valgrind is always disabled, if NM_TEST_REGENERATE is enabled.
ENV_NM_TEST_VALGRIND = "NM_TEST_VALGRIND"
ENV_LIBTOOL = "LIBTOOL"
###############################################################################
import collections
import dbus
import dbus.mainloop.glib
import dbus.service
import errno
import fcntl
import io
import itertools
import os
import random
import re
import shlex
import signal
import socket
import subprocess
import sys
import tempfile
import time
import unittest
import gi
try:
from gi.repository import GLib
except ImportError:
GLib = None
try:
gi.require_version("NM", "1.0")
except ValueError:
NM = None
else:
try:
from gi.repository import NM
except ImportError:
NM = None
try:
import pexpect
except ImportError:
pexpect = None
try:
from http.server import HTTPServer
from http.server import BaseHTTPRequestHandler
from http.client import HTTPConnection, HTTPResponse
except ImportError:
HTTPServer = None
###############################################################################
class PathConfiguration:
@staticmethod
def srcdir():
# this is the directory where the test script itself lies.
# Based on this directory, we find other parts that we expect
# in the source repository.
return os.path.dirname(os.path.abspath(__file__))
@staticmethod
def top_srcdir():
return os.path.abspath(PathConfiguration.srcdir() + "/../../..")
@staticmethod
def test_networkmanager_service_path():
v = os.path.abspath(
PathConfiguration.top_srcdir() + "/tools/test-networkmanager-service.py"
)
assert os.path.exists(v), 'Cannot find test server at "%s"' % (v)
return v
@staticmethod
def test_cloud_meta_mock_path():
v = os.path.abspath(
PathConfiguration.top_srcdir() + "/tools/test-cloud-meta-mock.py"
)
assert os.path.exists(v), 'Cannot find cloud metadata mock server at "%s"' % (v)
return v
@staticmethod
def canonical_script_filename():
p = "src/tests/client/test-client.py"
assert (PathConfiguration.top_srcdir() + "/" + p) == os.path.abspath(__file__)
return p
###############################################################################
dbus_session_inited = False
_DEFAULT_ARG = object()
_UNSTABLE_OUTPUT = object()
###############################################################################
class Util:
_signal_no_lookup = {
1: "SIGHUP",
2: "SIGINT",
3: "SIGQUIT",
4: "SIGILL",
5: "SIGTRAP",
6: "SIGABRT",
8: "SIGFPE",
9: "SIGKILL",
11: "SIGSEGV",
12: "SIGSYS",
13: "SIGPIPE",
14: "SIGALRM",
15: "SIGTERM",
16: "SIGURG",
17: "SIGSTOP",
18: "SIGTSTP",
19: "SIGCONT",
20: "SIGCHLD",
21: "SIGTTIN",
22: "SIGTTOU",
23: "SIGPOLL",
24: "SIGXCPU",
25: "SIGXFSZ",
26: "SIGVTALRM",
27: "SIGPROF",
30: "SIGUSR1",
31: "SIGUSR2",
}
@classmethod
def signal_no_to_str(cls, sig):
s = cls._signal_no_lookup.get(sig, None)
if s is None:
return "<unknown %d>" % (sig)
return s
@staticmethod
def python_has_version(major, minor=0):
return sys.version_info[0] > major or (
sys.version_info[0] == major and sys.version_info[1] >= minor
)
@staticmethod
def is_string(s):
if Util.python_has_version(3):
t = str
else:
t = basestring
return isinstance(s, t)
@staticmethod
def is_bool(s, defval=False):
if s is None:
return defval
if isinstance(s, int):
return s != 0
if isinstance(s, str):
if s.lower() in ["1", "y", "yes", "true", "on"]:
return True
if s.lower() in ["0", "n", "no", "false", "off"]:
return False
raise ValueError('Argument "%s" is not a boolean' % (s,))
@staticmethod
def as_bytes(s):
if Util.is_string(s):
return s.encode("utf-8")
assert isinstance(s, bytes)
return s
@staticmethod
def memoize_nullary(nullary_func):
result = []
def closure():
if not result:
result.append(nullary_func())
return result[0]
return closure
_find_unsafe = re.compile(
r"[^\w@%+=:,./-]", re.ASCII if sys.version_info[0] >= 3 else 0
).search
@staticmethod
def shlex_quote(s):
# Reimplement shlex.quote().
if Util.python_has_version(3, 3):
return shlex.quote(s)
if not s:
return "''"
if Util._find_unsafe(s) is None:
return s
return "'" + s.replace("'", "'\"'\"'") + "'"
@staticmethod
def shlex_join(args):
# Reimplement shlex.join()
return " ".join(Util.shlex_quote(s) for s in args)
@staticmethod
def popen_wait(p, timeout=0):
(res, b_stdout, b_stderr) = Util.popen_wait_read(
p, timeout=timeout, read_std_pipes=False
)
return res
@staticmethod
def popen_wait_read(p, timeout=0, read_std_pipes=True):
start = NM.utils_get_timestamp_msec()
delay = 0.0005
b_stdout = b""
b_stderr = b""
res = None
while True:
if read_std_pipes:
b_stdout += Util.buffer_read(p.stdout)
b_stderr += Util.buffer_read(p.stderr)
if p.poll() is not None:
res = p.returncode
break
if timeout == 0:
break
assert timeout > 0
remaining = timeout - ((NM.utils_get_timestamp_msec() - start) / 1000.0)
if remaining <= 0:
break
delay = min(delay * 2, remaining, 0.05)
time.sleep(delay)
return (res, b_stdout, b_stderr)
@staticmethod
def buffer_read(buf):
b = b""
while True:
try:
b1 = buf.read()
except io.BlockingIOError:
b1 = b""
except IOError:
b1 = b""
if not b1:
return b
b += b1
@staticmethod
def buffer_set_nonblock(buf):
fd = buf.fileno()
fl = fcntl.fcntl(fd, fcntl.F_GETFL)
fcntl.fcntl(fd, fcntl.F_SETFL, fl | os.O_NONBLOCK)
@staticmethod
def random_job(jobs):
jobs = list(jobs)
l = len(jobs)
t = l * (l + 1) / 2
while True:
# we return a random jobs from the list, but the indexes at the front of
# the list are more likely. The idea is, that those jobs were started first,
# and are expected to complete first. As we poll, we want to check more frequently
# on the elements at the beginning of the list...
#
# Let's assign probabilities with an arithmetic series.
# That is, if there are 16 jobs, then the first gets weighted
# with 16, the second with 15, then 14, and so on, until the
# last has weight 1. That means, the first element is 16 times
# more probable than the last.
# Element at idx (starting with 0) is picked with probability
# 1 / (l*(l+1)/2) * (l - idx)
r = random.random() * t
idx = 0
rx = 0
while True:
rx += l - idx
if rx >= r or idx == l - 1:
yield jobs[idx]
break
idx += 1
@staticmethod
def iter_single(itr, min_num=1, max_num=1):
itr = list(itr)
n = 0
v = None
for c in itr:
n += 1
if n > 1:
break
v = c
if n < min_num:
raise AssertionError(
"Expected at least %s elements, but %s found" % (min_num, n)
)
if n > max_num:
raise AssertionError(
"Expected at most %s elements, but %s found" % (max_num, n)
)
return v
@staticmethod
def file_read(filename):
try:
with open(filename, "rb") as f:
return f.read()
except:
return None
@staticmethod
def file_read_expected(filename):
results_expect = []
content_expect = Util.file_read(filename)
try:
base_idx = 0
size_prefix = "size: ".encode("utf8")
while True:
if not content_expect[base_idx : base_idx + 10].startswith(size_prefix):
raise Exception("Unexpected token")
j = base_idx + len(size_prefix)
i = j
if Util.python_has_version(3, 0):
eol = ord("\n")
else:
eol = "\n"
while content_expect[i] != eol:
i += 1
i = i + 1 + int(content_expect[j:i])
results_expect.append(content_expect[base_idx:i])
if len(content_expect) == i:
break
base_idx = i
except Exception as e:
results_expect = None
return content_expect, results_expect
@staticmethod
def _replace_text_match_join(split_arr, replacement):
yield split_arr[0]
for t in split_arr[1:]:
yield (replacement,)
yield t
@staticmethod
def ReplaceTextSimple(search, replacement):
# This gives a function that can be used by Util.replace_text().
# The function replaces an input bytes string @t. It must either return
# a bytes string, a list containing bytes strings and/or 1-tuples (the
# latter containing one bytes string).
# The 1-tuple acts as a placeholder for atomic text, that cannot be replaced
# a second time.
#
# Search for replace_text_fcn in Util.replace_text() where this is called.
replacement = Util.as_bytes(replacement)
if callable(search):
search_fcn = search
else:
search_fcn = lambda: search
def replace_fcn(t):
assert isinstance(t, bytes)
search_txt = search_fcn()
if search_txt is None:
return t
search_txt = Util.as_bytes(search_txt)
return Util._replace_text_match_join(t.split(search_txt), replacement)
return replace_fcn
@staticmethod
def ReplaceTextRegex(pattern, replacement):
# See ReplaceTextSimple.
pattern = Util.as_bytes(pattern)
replacement = Util.as_bytes(replacement)
p = re.compile(pattern)
return lambda t: Util._replace_text_match_join(p.split(t), replacement)
@staticmethod
def replace_text(text, replace_arr):
if not replace_arr:
return text
needs_encode = Util.python_has_version(3) and Util.is_string(text)
if needs_encode:
text = text.encode("utf-8")
text = [text]
for replace_text_fcn in replace_arr:
text2 = []
for t in text:
# tuples are markers for atomic strings. They won't be replaced a second
# time.
if not isinstance(t, tuple):
t = replace_text_fcn(t)
if isinstance(t, bytes) or isinstance(t, tuple):
text2.append(t)
else:
text2.extend(t)
text = text2
bb = b"".join([(t[0] if isinstance(t, tuple) else t) for t in text])
if needs_encode:
bb = bb.decode("utf-8")
return bb
@staticmethod
def replace_text_sort_list(lst, replace_arr):
lst = [(Util.replace_text(elem, replace_arr), elem) for elem in lst]
lst = sorted(lst)
lst = [tup[1] for tup in lst]
return list(lst)
@staticmethod
def debug_dbus_interface():
# this is for printf debugging, not used in actual code.
os.system(
"busctl --user --verbose call org.freedesktop.NetworkManager /org/freedesktop org.freedesktop.DBus.ObjectManager GetManagedObjects | cat"
)
@staticmethod
def iter_nmcli_output_modes():
for mode in [[], ["--mode", "tabular"], ["--mode", "multiline"]]:
for fmt in [[], ["--pretty"], ["--terse"]]:
for color in [[], ["--color", "yes"]]:
yield mode + fmt + color
@staticmethod
def valgrind_check_log(valgrind_log, logname):
if valgrind_log is None:
return
fd, name = valgrind_log
os.close(fd)
if not os.path.isfile(name):
raise Exception("valgrind log %s unexpectedly does not exist" % (name,))
if os.path.getsize(name) != 0:
out = subprocess.run(
[
"sed",
"-e",
r"/^--[0-9]\+-- WARNING: unhandled .* syscall: /,/^--[0-9]\+-- it at http.*\.$/d",
name,
],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
)
if out.returncode != 0:
raise Exception('Calling "sed" to search valgrind log failed')
if out.stdout:
print("valgrind log %s for %s is not empty:" % (name, logname))
print("\n%s\n" % (out.stdout.decode("utf-8", errors="replace"),))
raise Exception("valgrind log %s unexpectedly is not empty" % (name,))
os.remove(name)
@staticmethod
def pexpect_expect_all(pexp, *pattern_list):
# This will call "pexpect.expect()" on pattern_list,
# expecting all entries to match exactly once, in any
# order.
pattern_list = list(pattern_list)
while pattern_list:
idx = pexp.expect(pattern_list)
del pattern_list[idx]
@staticmethod
def skip_without_pexpect(_func=None):
if _func is None:
if pexpect is None:
raise unittest.SkipTest("pexpect not available")
return
def f(*a, **kw):
Util.skip_without_pexpect()
_func(*a, **kw)
return f
@staticmethod
def skip_without_dbus_session(_func=None):
if _func is None:
if not dbus_session_inited:
raise unittest.SkipTest(
"Own D-Bus session for testing is not initialized. Do you have dbus-run-session available?"
)
return
def f(*a, **kw):
Util.skip_without_dbus_session()
_func(*a, **kw)
return f
@staticmethod
def skip_without_NM(_func=None):
if _func is None:
if NM is None:
raise unittest.SkipTest(
"gi.NM is not available. Did you build with introspection?"
)
return
def f(*a, **kw):
Util.skip_without_NM()
_func(*a, **kw)
return f
@staticmethod
def cmd_create_env(
lang="C",
calling_num=None,
fatal_warnings=_DEFAULT_ARG,
extra_env=None,
):
if lang == "C":
language = ""
elif lang == "de_DE.utf8":
language = "de"
elif lang == "pl_PL.UTF-8":
language = "pl"
else:
raise AssertionError("invalid language %s" % (lang))
env = {}
for k in [
"LD_LIBRARY_PATH",
"DBUS_SESSION_BUS_ADDRESS",
"LIBNM_CLIENT_DEBUG",
"LIBNM_CLIENT_DEBUG_FILE",
]:
val = os.environ.get(k, None)
if val is not None:
env[k] = val
env["LANG"] = lang
env["LANGUAGE"] = language
env["LIBNM_USE_SESSION_BUS"] = "1"
env["LIBNM_USE_NO_UDEV"] = "1"
env["TERM"] = "linux"
env["ASAN_OPTIONS"] = conf.get(ENV_NM_TEST_ASAN_OPTIONS)
env["LSAN_OPTIONS"] = conf.get(ENV_NM_TEST_LSAN_OPTIONS)
env["LBSAN_OPTIONS"] = conf.get(ENV_NM_TEST_UBSAN_OPTIONS)
env["XDG_CONFIG_HOME"] = PathConfiguration.srcdir()
if calling_num is not None:
env["NM_TEST_CALLING_NUM"] = str(calling_num)
if fatal_warnings is _DEFAULT_ARG or fatal_warnings:
env["G_DEBUG"] = "fatal-warnings"
if extra_env is not None:
for k, v in extra_env.items():
env[k] = v
return env
@staticmethod
def cmd_create_argv(cmd_path, args, with_valgrind=None):
if with_valgrind is None:
with_valgrind = conf.get(ENV_NM_TEST_VALGRIND)
valgrind_log = None
cmd = conf.get(cmd_path)
if with_valgrind:
valgrind_log = tempfile.mkstemp(prefix="nm-test-client-valgrind.")
argv = [
"valgrind",
"--quiet",
"--error-exitcode=37",
"--leak-check=full",
"--gen-suppressions=all",
(
"--suppressions="
+ PathConfiguration.top_srcdir()
+ "/valgrind.suppressions"
),
"--num-callers=100",
"--log-file=" + valgrind_log[1],
cmd,
]
libtool = conf.get(ENV_LIBTOOL)
if libtool:
argv = list(libtool) + ["--mode=execute"] + argv
else:
argv = [cmd]
argv.extend(args)
return argv, valgrind_log
@staticmethod
def get_nmcli_version():
ver = NM.utils_version()
micro = ver & 0xFF
minor = (ver >> 8) & 0xFF
major = ver >> 16
return "%s.%s.%s" % (major, minor, micro)
###############################################################################
class Configuration:
def __init__(self):
self._values = {}
def get(self, name):
v = self._values.get(name, None)
if name in self._values:
return v
if name == ENV_NM_TEST_CLIENT_BUILDDIR:
v = os.environ.get(
ENV_NM_TEST_CLIENT_BUILDDIR, PathConfiguration.top_srcdir()
)
if not os.path.isdir(v):
raise Exception("Missing builddir. Set NM_TEST_CLIENT_BUILDDIR?")
elif name == "ENV_NM_TEST_CLIENT_NMCLI_UNCHECKED_PATH":
v = os.environ.get(ENV_NM_TEST_CLIENT_NMCLI_PATH, None)
if v is None:
try:
v = os.path.abspath(
self.get(ENV_NM_TEST_CLIENT_BUILDDIR) + "/src/nmcli/nmcli"
)
except:
pass
elif name == ENV_NM_TEST_CLIENT_NMCLI_PATH:
v = self.get("ENV_NM_TEST_CLIENT_NMCLI_UNCHECKED_PATH")
if not os.path.exists(v):
raise Exception("Missing nmcli binary. Set NM_TEST_CLIENT_NMCLI_PATH?")
elif name == ENV_NM_TEST_CLIENT_CLOUD_SETUP_PATH:
v = os.environ.get(ENV_NM_TEST_CLIENT_CLOUD_SETUP_PATH, None)
if v is None:
try:
v = os.path.abspath(
self.get(ENV_NM_TEST_CLIENT_BUILDDIR)
+ "/src/nm-cloud-setup/nm-cloud-setup"
)
except:
pass
if not os.path.exists(v):
raise Exception(
"Missing nm-cloud-setup binary. Set NM_TEST_CLIENT_CLOUD_SETUP_PATH?"
)
elif name == ENV_NM_TEST_CLIENT_CHECK_L10N:
# if we test locales other than 'C', the output of nmcli depends on whether
# nmcli can load the translations. Unfortunately, I cannot find a way to
# make gettext use the po/*.gmo files from the build-dir.
#
# hence, such tests only work, if you also issue `make-install`
#
# Only by setting NM_TEST_CLIENT_CHECK_L10N=1, these tests are included
# as well.
v = Util.is_bool(os.environ.get(ENV_NM_TEST_CLIENT_CHECK_L10N, None))
elif name == ENV_NM_TEST_REGENERATE:
# in the "regenerate" mode, the tests will rewrite the files on disk against
# which we assert. That is useful, if there are intentional changes and
# we want to regenerate the expected output.
v = Util.is_bool(os.environ.get(ENV_NM_TEST_REGENERATE, None))
elif name == ENV_NM_TEST_WITH_LINENO:
v = Util.is_bool(os.environ.get(ENV_NM_TEST_WITH_LINENO, None))
elif name == ENV_NM_TEST_LOG_PEXPECT:
v = Util.is_bool(os.environ.get(ENV_NM_TEST_LOG_PEXPECT, None))
elif name == ENV_NM_TEST_VALGRIND:
if self.get(ENV_NM_TEST_REGENERATE):
v = False
else:
v = os.environ.get(ENV_NM_TEST_VALGRIND, None)
if v:
v = Util.is_bool(v)
else:
v = Util.is_bool(os.environ.get("NMTST_USE_VALGRIND", None))
elif name in [
ENV_NM_TEST_ASAN_OPTIONS,
ENV_NM_TEST_LSAN_OPTIONS,
ENV_NM_TEST_UBSAN_OPTIONS,
]:
v = os.environ.get(name, None)
if v is None:
if name == ENV_NM_TEST_ASAN_OPTIONS:
v = "detect_leaks=1"
# v += ' fast_unwind_on_malloc=false'
elif name == ENV_NM_TEST_LSAN_OPTIONS:
v = ""
elif name == ENV_NM_TEST_UBSAN_OPTIONS:
v = "print_stacktrace=1:halt_on_error=1"
else:
assert False
elif name == ENV_LIBTOOL:
v = os.environ.get(name, None)
if v is None:
v = os.path.abspath(
os.path.dirname(self.get("ENV_NM_TEST_CLIENT_NMCLI_UNCHECKED_PATH"))
+ "/../../libtool"
)
if not os.path.isfile(v):
v = None
else:
v = [v]
elif not v:
v = None
else:
v = shlex.split(v)
else:
raise Exception()
self._values[name] = v
return v
conf = Configuration()
###############################################################################
class NMStubServer:
@staticmethod
def _conn_get_main_object(conn):
try:
return conn.get_object(
"org.freedesktop.NetworkManager", "/org/freedesktop/NetworkManager"
)
except:
return None
def __init__(self, seed, version=None):
service_path = PathConfiguration.test_networkmanager_service_path()
self._conn = dbus.SessionBus()
env = os.environ.copy()
env["NM_TEST_NETWORKMANAGER_SERVICE_SEED"] = seed
if version is not None:
env["NM_TEST_NETWORKMANAGER_SERVICE_VERSION"] = version
else:
env["NM_TEST_NETWORKMANAGER_SERVICE_VERSION"] = Util.get_nmcli_version()
p = subprocess.Popen(
[sys.executable, service_path], stdin=subprocess.PIPE, env=env
)
start = NM.utils_get_timestamp_msec()
while True:
if p.poll() is not None:
p.stdin.close()
if p.returncode == 77:
raise unittest.SkipTest(
"the stub service %s exited with status 77" % (service_path)
)
raise Exception(
"the stub service %s exited unexpectedly" % (service_path)
)
nmobj = self._conn_get_main_object(self._conn)
if nmobj is not None:
break
if (NM.utils_get_timestamp_msec() - start) >= 4000:
p.stdin.close()
p.kill()
Util.popen_wait(p, 1)
raise Exception(
"after starting stub service the D-Bus name was not claimed in time"
)
self._nmobj = nmobj
self._nmiface = dbus.Interface(
nmobj, "org.freedesktop.NetworkManager.LibnmGlibTest"
)
self._p = p
def shutdown(self, kill_mode="random"):
conn = self._conn
p = self._p
self._nmobj = None
self._nmiface = None
self._conn = None
self._p = None
# The test stub service watches stdin and will do a proper
# shutdown when it closes. That means, to send signals about
# going away.
# On the other hand, just killing it will cause the process
# from dropping off the bus.
if kill_mode == "kill":
p.kill()
elif kill_mode == "stdin-close":
p.stdin.close()
else:
assert kill_mode == "random"
ops = [p.stdin.close, p.kill]
random.shuffle(ops)
ops[0]()
r = random.random()
if r < 0.75:
if r < 0.5:
time.sleep(r * 0.2)
ops[1]()
if Util.popen_wait(p, 1) is None:
raise Exception("Stub service did not exit in time")
p.stdin.close()
if self._conn_get_main_object(conn) is not None:
raise Exception(
"Stub service is not still here although it should shut down"
)
class _MethodProxy:
def __init__(self, parent, method_name):
self._parent = parent
self._method_name = method_name
def __call__(self, *args, **kwargs):
dbus_iface = kwargs.pop("dbus_iface", None)
if dbus_iface is None:
dbus_iface = self._parent._nmiface
method = dbus_iface.get_dbus_method(self._method_name)
if kwargs:
# for convenience, we allow the caller to specify arguments
# as kwargs. In this case, we construct a a{sv} array as last argument.
args = list(args)
args.append(kwargs)
return method(*args)
def __getattr__(self, member):
if not member.startswith("op_"):
raise AttributeError(member)
return self._MethodProxy(self, member[3:])
def addConnection(self, connection, do_verify_strict=True):
return self.op_AddConnection(connection, do_verify_strict)
def findConnections(self, **kwargs):
if kwargs:
lst = self.op_FindConnections(**kwargs)
else:
lst = self.op_FindConnections({})
return list([(str(elem[0]), str(elem[1]), str(elem[2])) for elem in lst])
def findConnectionUuid(self, con_id, required=True):
try:
u = Util.iter_single(self.findConnections(con_id=con_id))[1]
assert u, "Invalid uuid %s" % (u)
except Exception as e:
if not required:
return None
raise AssertionError(
"Unexpectedly not found connection %s: %s" % (con_id, str(e))
)
return u
def ReplaceTextConUuid(self, con_name, replacement):
return Util.ReplaceTextSimple(
Util.memoize_nullary(lambda: self.findConnectionUuid(con_name)),
replacement,
)
def setProperty(self, path, propname, value, iface_name=None):
if iface_name is None:
iface_name = ""
self.op_SetProperties([(path, [(iface_name, [(propname, value)])])])
def addAndActivateConnection(
self, connection, device, specific_object="", delay=None
):
if delay is not None:
self.op_SetActiveConnectionStateChangedDelay(device, delay)
nm_iface = self._conn_get_main_object(self._conn)
self.op_AddAndActivateConnection(
connection, device, specific_object, dbus_iface=nm_iface
)
###############################################################################
class AsyncProcess:
def __init__(self, args, env, complete_cb, max_waittime_msec=20000):
self._args = list(args)
self._env = env
self._complete_cb = complete_cb
self._max_waittime_msec = max_waittime_msec
def start(self):
if not hasattr(self, "_p"):
self._p_start_timestamp = NM.utils_get_timestamp_msec()
self._p_stdout_buf = b""
self._p_stderr_buf = b""
self._p = subprocess.Popen(
self._args,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
env=self._env,
)
Util.buffer_set_nonblock(self._p.stdout)
Util.buffer_set_nonblock(self._p.stderr)
def _timeout_remaining_time(self):
# note that we call this during poll() and wait_and_complete().
# we don't know the exact time when the process terminated,
# so this is only approximately correct, if we call poll/wait
# frequently.
# Worst case, we will think that the process did not time out,
# when in fact it was running longer than max-waittime.
return self._max_waittime_msec - (
NM.utils_get_timestamp_msec() - self._p_start_timestamp
)