Repository navigation
Expand file tree
/
Copy pathtest_update.py
More file actions
824 lines (711 loc) · 34.6 KB
/
Copy pathtest_update.py
File metadata and controls
824 lines (711 loc) · 34.6 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
"""Tests für den Update-Helfer. Ein kleiner Server spielt die GitHub-API (Commits, Prüfungen, Git-Baum, Tarball),
systemctl ist ein Platzhalter-Skript.
Aufruf: python3 -m unittest discover -s tests -v
"""
import base64
import datetime
import hashlib
import http.server
import io
import json
import os
import subprocess
import sys
import tarfile
import tempfile
import threading
import time
import unittest
import urllib.parse
HERE = os.path.dirname(os.path.abspath(__file__))
REPO = os.path.dirname(HERE)
sys.path.insert(0, os.path.join(REPO, "updater"))
import irl4you_update as U # noqa: E402
FAKE_SYSTEMCTL = r'''#!/usr/bin/env python3
import json, os, sys
d = os.path.dirname(os.path.abspath(__file__))
with open(os.path.join(d, "systemctl.log"), "a") as f:
f.write(" ".join(sys.argv[1:]) + "\n")
try:
st = json.load(open(os.path.join(d, "systemctl.json")))
except Exception:
st = {}
args = [a for a in sys.argv[1:] if not a.startswith("--")]
if args and args[0] == "show":
u = sys.argv[-1]
print("loaded" if u in st.get("known", ["pipbox.service", "pipbox-send.service"]) else "not-found")
sys.exit(0)
if args and args[0] == "is-active":
on = args[1] in st.get("active", ["pipbox.service"])
print("active" if on else "inactive")
sys.exit(0 if on else 3)
sys.exit(0)
'''
HOOK_OK = '''#!/bin/sh
echo "$IRL4YOU_ACTION $IRL4YOU_VERSION prev=$IRL4YOU_PREVIOUS" >> "$IRL4YOU_ROOT/../hooks.log"
'''
HOOK_FAIL = '''#!/bin/sh
echo "$IRL4YOU_ACTION $IRL4YOU_VERSION prev=$IRL4YOU_PREVIOUS" >> "$IRL4YOU_ROOT/../hooks.log"
echo kaputt >&2
exit 4
'''
def blob_sha(data):
return hashlib.sha1(b"blob %d\0" % len(data) + data).hexdigest()
def repo_files(version="2.0.0", hook=HOOK_OK, manifest=None, irl=None):
"""Dateien eines Commits: Pfad -> Text/Bytes oder ("link", Ziel)."""
m = {"name": "irl4you", "version": "@VERSION@", "min_updater": 1, "restart": ["pipbox.service"],
"health_units": ["pipbox.service"], "reboot": False}
m.update(manifest or {})
files = {"VERSION": version + "\n", "irl4you/server.py": "print('hallo %s')\n&quo
E870
t; % version,
"irl4you/web/static": ("link", "../server.py"),
"release/hooks/install": hook, "release/hooks/health": "#!/bin/sh\nexit 0\n",
"release/manifest.json": json.dumps(m), "updater/irl4you_update.py": "# platzhalter\n",
"updater/update.conf.example": "[update]\n"}
files.update(irl or {})
return {k: v for k, v in files.items() if v is not None}
def as_bytes(v):
return v if isinstance(v, bytes) else v.encode()
class FakeGitHub:
def __init__(self, repo="IRL4YOU/IRL4YOU-BOX"):
self.repo = repo
self.commits = [] # neuester zuerst
self.redirect = False
self.requests = []
self.log = [] # (Pfad, Abfrage, If-None-Match, Antwortcode)
self.etags = False
self._n = 0
fake = self
class H(http.server.BaseHTTPRequestHandler):
def log_message(self, *a):
pass
def do_GET(self):
u = urllib.parse.urlsplit(self.path)
q = urllib.parse.parse_qs(u.query)
fake.requests.append((self.headers.get("Host"), u.path, self.headers.get("Authorization")))
fake.log.append([u.path, u.query, self.headers.get("If-None-Match"), 200])
base = "/repos/%s/" % fake.repo
p = u.path
if p == base + "commits" and "path" in q:
return self.js(fake.version_commits(q["sha"][0]))
if p == base + "contents/VERSION":
c = fake.find(q["ref"][0])
data = as_bytes(c["files"]["VERSION"]) if c else None
return self.js({"content": base64.b64encode(data).decode()}) if data else self.js({}, 404)
if p.startswith(base + "compare/"):
a, b = p.rsplit("/", 1)[1].split("...")
ia, ib = fake.index(a), fake.index(b)
return self.js({"ahead_by": ia - ib}) if ia is not None and ib is not None else self.js({}, 404)
if p == base + "commits":
body = json.dumps([fake.api(c) for c in fake.commits][:int(q.get("per_page", ["30"])[0])]).encode()
if fake.etags:
tag = '"%s"' % hashlib.sha1(body).hexdigest()
if self.headers.get("If-None-Match") == tag:
fake.log[-1][3] = 304
self.send_response(304)
self.end_headers()
return
return self.send(200, body, "application/json", {"ETag": tag})
return self.send(200, body, "application/json")
if p.startswith(base + "commits/") and p.endswith("/check-runs"):
c = fake.find(p.split("/")[-2])
return self.js({"check_runs": fake.runs(c)}) if c else self.js({}, 404)
if p.startswith(base + "commits/"):
c = fake.find(p.rsplit("/", 1)[1])
return self.js(fake.api(c)) if c else self.js({}, 404)
if p.startswith(base + "git/trees/"):
c = fake.find(p.rsplit("/", 1)[1])
return self.js(fake.tree(c)) if c else self.js({}, 404)
if p.startswith(base + "tarball/"):
c = fake.find(p.rsplit("/", 1)[1])
if not c:
return self.js({}, 404)
if fake.redirect:
self.send_response(302)
self.send_header("Location", "http://localhost:%d/blob/%s" % (fake.port, c["sha"]))
self.end_headers()
return
return self.send(200, fake.tarball(c), "application/gzip")
if p.startswith("/blob/"):
return self.send(200, fake.tarball(fake.find(p.rsplit("/", 1)[1])), "application/gzip")
self.js({}, 404)
def js(self, obj, code=200):
self.send(code, json.dumps(obj).encode(), "application/json")
def send(self, code, data, ctype, extra=None):
self.send_response(code)
for k, v in (extra or {}).items():
self.send_header(k, v)
self.send_header("Content-Type", ctype)
self.send_header("Content-Length", str(len(data)))
self.end_headers()
self.wfile.write(data)
self.httpd = http.server.ThreadingHTTPServer(("127.0.0.1", 0), H)
self.port = self.httpd.server_address[1]
threading.Thread(target=self.httpd.serve_forever, daemon=True).start()
def close(self):
self.httpd.shutdown()
self.httpd.server_close()
def add(self, version="2.0.0", message=None, ci="success", age=3600, files=None, tamper=None, extra=None, **kw):
"""Neuer Commit an der Spitze. tamper: Pfad -> Bytes (nur im Tarball) oder None (fehlt im Tarball)."""
self._n += 1
files = files if files is not None else repo_files(version, **kw)
sha = hashlib.sha1(("%d%s" % (self._n, sorted(files))).encode()).hexdigest()
date = datetime.datetime.fromtimestamp(time.time() - age, datetime.timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
c = {"sha": sha, "message": message or "Commit %d" % self._n, "date": date, "files": files, "ci": ci,
"tamper": tamper or {}, "extra": extra or []}
self.commits.insert(0, c)
return c
def index(self, sha):
for i, c in enumerate(self.commits):
if c["sha"] == sha:
return i
return None
def version_commits(self, sha):
"""Neuester Commit ab sha abwärts, der VERSION ändert (Release)."""
i = self.index(sha)
out = []
for j in range(i, len(self.commits)):
below = self.commits[j + 1]["files"].get("VERSION") if j + 1 < len(self.commits) else None
if self.commits[j]["files"].get("VERSION") != below:
out.append(self.api(self.commits[j]))
return out
def find(self, ref):
for c in self.commits:
if c["sha"].startswith(ref):
return c
return None
@staticmethod
def api(c):
return {"sha": c["sha"], "commit": {"message": c["message"], "committer": {"date": c["date"]}}}
@staticmethod
def runs(c):
return {"success": [{"status": "completed", "conclusion": "success"}],
"failure": [{"status": "completed", "conclusion": "failure"}],
"pending": [{"status": "in_progress", "conclusion": None}], "none": []}[c["ci"]]
@staticmethod
def tree(c):
out = []
for path, v in sorted(c["files"].items()):
if isinstance(v, tuple):
out.append({"path": path, "mode": "120000", "type": "blob", "sha": blob_sha(v[1].encode())})
else:
out.append({"path": path, "mode": "100644", "type": "blob", "sha": blob_sha(as_bytes(v))})
return {"sha": c["sha"], "tree": out, "truncated": False}
@staticmethod
def tarball(c):
buf = io.BytesIO()
top = "o-r-%s/" % c["sha"][:7]
with tarfile.open(fileobj=buf, mode="w:gz", format=tarfile.PAX_FORMAT, pax_headers={"comment": c["sha"]}) as tar:
for path, v in c["files"].items():
if path in c["tamper"] and c["tamper"][path] is None:
continue
ti = tarfile.TarInfo(top + path)
if isinstance(v, tuple):
ti.type, ti.linkname = tarfile.SYMTYPE, v[1]
tar.addfile(ti)
continue
data = c["tamper"].get(path, as_bytes(v))
ti.size = len(data)
ti.mode = 0o755 if path.startswith("release/hooks/") else 0o644
tar.addfile(ti, io.BytesIO(data))
for f in c["extra"]:
ti, data = f(top)
tar.addfile(ti, io.BytesIO(data) if data is not None else None)
return buf.getvalue()
class Base(unittest.TestCase):
def setUp(self):
self.tmp = tempfile.mkdtemp()
self.gh = FakeGitHub()
self.addCleanup(self.gh.close)
self.addCleanup(subprocess.run, ["rm", "-rf", self.tmp])
bindir = os.path.join(self.tmp, "bin")
os.makedirs(bindir)
self.sysctl = os.path.join(bindir, "systemctl")
with open(self.sysctl, "w") as f:
f.write(FAKE_SYSTEMCTL)
os.chmod(self.sysctl, 0o755)
self.set_units(["pipbox.service"])
self.overrides = {
"api": "http://127.0.0.1:%d" % self.gh.port, "allow_insecure_api": "true",
"root": os.path.join(self.tmp, "opt", "irl4you"), "extra_link": os.path.join(self.tmp, "opt", "pipbox"),
"state_dir": os.path.join(self.tmp, "state"), "status_file": os.path.join(self.tmp, "run", "status.json"),
"request_file": os.path.join(self.tmp, "state", "swupdate-request"),
"log_file": os.path.join(self.tmp, "update.log"), "token_file": "", "busy_processes": "",
"busy_units": "pipbox-send.service", "systemctl": self.sysctl, "health_timeout": "0", "min_free_mb": "1",
}
self.u = self.make()
def make(self, **kw):
return U.Updater(U.Config(path=None, overrides=dict(self.overrides, **kw)), sleep=lambda s: None)
def set_units(self, active, known=None):
st = {"active": active}
if known is not None:
st["known"] = known
with open(os.path.join(os.path.dirname(self.sysctl), "systemctl.json"), "w") as f:
json.dump(st, f)
def calls(self):
try:
with open(os.path.join(os.path.dirname(self.sysctl), "systemctl.log")) as f:
return f.read().splitlines()
except OSError:
return []
def
10BC8
hooks(self):
try:
with open(os.path.join(self.tmp, "opt", "hooks.log")) as f:
return f.read().splitlines()
except OSError:
return []
def status(self):
return self.u.load_status()
def on_disk(self):
return sorted(os.listdir(os.path.join(self.tmp, "opt", "irl4you", "releases")))
def rid(self, c):
return c["sha"][:12]
class TestConfig(unittest.TestCase):
def test_https_required(self):
with self.assertRaises(U.Refuse):
U.Config(path=None, overrides={"api": "http://example.org"})
def test_bad_repo_and_branch(self):
for k, v in (("repo", "a/b/../c"), ("branch", "../x"), ("branch", "a b")):
with self.assertRaises(U.Refuse):
U.Config(path=None, overrides={k: v})
def test_defaults_leave_room_for_slow_health_checks(self):
c = U.Config(path=None)
self.assertGreaterEqual(c.health_timeout, 120) # health.sh der Oberfläche braucht im schlechtesten Fall ~54 s
self.assertGreaterEqual(c.hook_timeout, 300)
def test_file(self):
with tempfile.NamedTemporaryFile("w", suffix=".conf", delete=False) as f:
f.write("[update]\nrepo = foo/bar\nbranch = dev\nauto_install = true\nrequire_ci = false\n")
self.addCleanup(os.remove, f.name)
c = U.Config(path=f.name)
self.assertEqual((c.repo, c.branch, c.auto_install, c.require_ci), ("foo/bar", "dev", True, False))
self.assertEqual(c.extra_link, "/opt/pipbox")
class TestCheck(Base):
def test_notes_between_installed_and_tip(self):
c1 = self.gh.add(message="Erster Stand")
self.u.install()
c2 = self.gh.add("2.0.1", message="Zweiter Stand\n\nMit Einzelheiten")
c3 = self.gh.add("2.0.2", message="Dritter Stand")
latest, avail = self.u.check()
self.assertEqual((latest, avail), (c3["sha"], True))
s = self.status()
self.assertEqual(s["state"], "idle")
self.assertEqual(s["notes"], "- Dritter Stand\n- Zweiter Stand")
self.assertEqual(s["latest"], c3["sha"][:7])
self.assertEqual([r["version"] for r in s["releases"]], [c["sha"][:7] for c in (c3, c2, c1)])
self.assertIn("Mit Einzelheiten", s["releases"][1]["notes"])
def test_history_one_entry_per_commit_with_version_without_trailers(self):
self.gh.add("2.0.0", message="Erster Stand")
self.u.install()
self.gh.add("2.0.1", message="Zweiter\n\nEinzelheit\n\nCo-Authored-By: X <x@example.com>\nClaude-Session: https://x")
c3 = self.gh.add("2.0.2", message="Dritter")
self.u.check()
s = self.status()
self.assertEqual([r["label"] for r in s["releases"]], ["2.0.2", "2.0.1", "2.0.0"])
self.assertEqual(s["latest_version"], "2.0.2")
self.assertEqual(s["releases"][1]["notes"], "Zweiter\n\nEinzelheit")
self.assertNotIn("Co-Authored", json.dumps(s))
def test_up_to_date(self):
self.gh.add()
self.u.install()
self.assertEqual(self.u.check()[1], False)
self.assertEqual(self.status()["message"], "IRL4YOU ist aktuell.")
def test_ci_gate(self):
self.gh.add(ci="pending")
self.assertEqual(self.u.check()[1], False)
self.assertIn("geprüft", self.status()["message"])
self.gh.commits[0]["ci"] = "failure"
self.assertEqual(self.u.check()[1], False)
self.assertIn("fehlgeschlagen", self.status()["message"])
self.assertEqual(self.make(require_ci="false").check()[1], True)
def test_no_ci_configured(self):
self.gh.add(ci="none", age=3600)
self.assertEqual(self.u.check()[1], True)
self.gh.add(ci="none", age=5)
self.assertEqual(self.u.check()[1], False)
def test_idle_check_costs_no_quota(self):
"""Nichts Neues: bedingte Anfrage (304, zählt nicht zur Grenze), Versionsnummern aus der Ablage, keine weiteren Anfragen."""
self.gh.etags = True
self.gh.add("2.0.0", message="Erster")
self.gh.add("2.0.1", message="Zweiter")
self.u.install()
self.u.check()
self.gh.log.clear()
self.assertEqual(self.u.check()[1], False)
self.assertEqual([(p.rsplit("/", 1)[-1], code) for p, q, inm, code in self.gh.log], [("commits", 304)])
self.assertEqual(self.status()["latest_version"], "2.0.1")
def test_new_commit_few_requests_and_numbers_cached(self):
self.gh.etags = True
self.gh.add("2.0.0")
self.u.install()
self.gh.add("2.0.0", message="Zwei")
self.gh.log.clear()
self.assertEqual(self.u.check()[1], True)
first = len(self.gh.log)
self.assertLessEqual(first, 8)
self.gh.log.clear()
self.u.check()
self.assertLessEqual(len(self.gh.log), 2) # Commitliste (bedingt) und Prüfungen des neuen Stands, keine Versionsabfragen mehr
def test_no_number_no_install_with_zero(self):
"""Ist die dritte Stelle nicht ermittelbar, wird nicht mit 0 installiert."""
self.gh.add("2.0.0")
self.gh.add("2.0.0", message="Zwei")
orig = self.u.build_number
self.u.build_number = lambda sha: (_ for _ in ()).throw(U.Refuse("GitHub lehnt die Anfrage ab (403)"))
self.assertNotEqual(self.u.run("install"), 0)
self.assertIsNone(self.u.active_id())
self.u.build_number = orig
def test_empty_branch(self):
self.assertEqual(self.u.run("check"), 2)
class TestInstall(Base):
def test_first_install(self):
c = self.gh.add()
self.assertTrue(self.u.install())
root, rid = self.overrides["root"], self.rid(c)
self.assertEqual(os.readlink(os.path.join(root, "current")), os.path.join(root, "releases", rid))
self.assertEqual(os.readlink(self.overrides["extra_link"]), os.path.join(root, "current"))
with open(os.path.join(self.overrides["extra_link"], "server.py")) as f:
self.assertIn("2.0.0", f.read())
cur = os.path.join(root, "current")
self.assertTrue(os.path.islink(os.path.join(cur, "web", "static")))
self.assertTrue(os.access(os.path.join(cur, "hooks", "install"), os.X_OK))
self.assertTrue(os.path.isfile(os.path.join(cur, "updater", "irl4you_update.py")))
with open(os.path.join(cur, "manifest.json")) as f:
m = json.load(f)
self.assertEqual((m["version"], m["commit"]), ("2.0.0", c["sha"]))
self.assertEqual(self.hooks(), ["install 2.0.0 prev="])
self.assertIn("restart pipbox.service", self.calls())
s = self.status()
self.assertEqual((s["state"], s["progress"], s["version"]), ("done", 100, "2.0.0"))
self.assertEqual(self.on_disk(), [rid])
def test_update_and_prune(self):
cs = []
for v in ("2.0.0", "2.0.1", "2.0.2", "2.0.3"):
cs.append(self.gh.add(v))
self.assertTrue(self.u.install(), v)
self.assertEqual(self.u.active_id(), self.rid(cs[3]))
self.assertEqual(self.u.previous_id(), self.rid(cs[2]))
self.assertEqual(self.on_disk(), sorted(self.rid(c) for c in cs[1:]))
self.assertEqual(self.hooks()[-1], "install 2.0.3 prev=%s" % self.rid(cs[2]))
def test_wechsel_auf_kleinere_versionsnummer(self):
"""Umstellung 2.0.0-rc.4 -> 0.1.0: massgeblich ist die Commit-Reihenfolge, nicht die Versionsnummer."""
self.gh.add("2.0.0-rc.4")
self.assertTrue(self.u.install())
c = self.gh.add("0.1.0")
self.assertEqual(self.u.run("install"), 0)
self.assertEqual(self.u.active_id(), self.rid(c))
self.assertEqual(self.status()["version"], "0.1.0")
self.assertEqual(self.hooks()[-1].split()[:2], ["install", "0.1.0"])
def test_dritte_stelle_zaehlt_commits_seit_release(self):
self.gh.add("0.2")
self.assertTrue(self.u.install())
self.assertEqual(self.status()["version"].split(" ")[0], "0.2.0")
for _ in range(3):
self.gh.add("0.2")
self.assertTrue(self.u.install())
self.assertEqual(self.status()["version"].split(" ")[0], "0.2.3")
self.gh.add("0.3")
self.assertTrue(self.u.install())
self.assertEqual(self.status()["version"].split(" ")[0], "0.3.0")
def test_not_newer(self):
self.gh.add()
self.u.install()
self.assertEqual(self.u.run("install"), 2)
self.assertIn("Keine neuere Version", self.status()["message"])
def test_ci_pending_blocks_but_explicit_sha_does_not(self):
c = self.gh.add(ci="pending")
self.assertEqual(self.u.run("install"), 2)
self.assertIn("geprüft", self.status()["message"])
self.assertTrue(self.u.install(c["sha"]))
def test_tampered_file(self):
c0 = self.gh.add()
self.u.install()
self.gh.add("2.0.1", tamper={"irl4you/server.py": b"print('boese')\n"})
self.assertEqual(self.u.run("install"), 2)
self.assertIn("stimmt nicht mit dem Commit überein", self.status()["message"])
self.assertEqual(self.u.active_id(), self.rid(c0))
self.assertEqual(self.on_disk(), [self.rid(c0)])
def test_extra_file(self):
def f(top):
ti = tarfile.TarInfo(top + "irl4you/zusatz.py")
ti.size = 1
return ti, b"x"
self.gh.add(extra=[f])
self.assertEqual(self.u.run("install"), 2)
self.assertIn("gehört nicht zum Commit", self.status()["message"])
def test_missing_file(self):
self.gh.add(tamper={"irl4you/server.py": None})
self.assertEqual(self.u.run("install"), 2)
self.assertIn("fehlen", self.status()["message"])
def test_hook_fails_rolls_back(self):
c0 = self.gh.add()
self.u.install()
c1 = self.gh.add("2.0.1", hook=HOOK_FAIL)
self.assertFalse(self.u.install())
self.assertEqual(self.u.active_id(), self.rid(c0))
self.assertEqual(self.hooks()[-2:], ["install 2.0.1 prev=%s" % self.rid(c0), "rollback 2.0.0 prev=%s" % self.rid(c1)])
self.assertEqual(self.status()["state"], "failed")
self.assertEqual(self.on_disk(), [self.rid(c0)])
with open(self.overrides["log_file"]) as f:
self.assertIn("kaputt", f.read())
def test_service_down_rolls_back(self):
c0 = self.gh.add()
self.u.install()
self.gh.add("2.0.1")
self.set_units([])
self.assertFalse(self.u.install())
self.assertEqual(self.u.active_id(), self.rid(c0))
self.assertTrue(self.hooks()[-1].startswith("rollback 2.0.0"))
def test_missing_units_are_skipped(self):
"""Basis-System ohne pipbox.service: Gesundheitsprüfung und Neustart überspringen den Dienst, das Update gelingt."""
self.set_units([], known=[])
c = self.gh.add()
self.assertTrue(self.u.install())
self.assertEqual(self.u.active_id(), self.rid(c))
self.assertNotIn("restart pipbox.service", self.calls())
s = self.status()
self.assertEqual((s["state"], s["skipped_units"]), ("done", ["pipbox.service"]))
self.assertIn("pipbox.service", s["message"])
with open(self.overrides["log_file"]) as f:
self.assertIn("Dienst pipbox.service ist auf dieser B
8
ox nicht
10BC8
eingerichtet", f.read())
def test_missing_unit_does_not_hide_a_broken_one(self):
self.set_units([], known=["pipbox.service"]) # eingerichtet, läuft aber nicht
self.gh.add(manifest={"health_units": ["pipbox.service", "gibt-es-nicht.service"]})
self.assertFalse(self.u.install())
self.assertEqual(self.status()["state"], "failed")
def test_slow_health_hook_is_not_cut_off_by_health_timeout(self):
c = self.gh.add(files=repo_files(irl={"irl4you/hooks_dummy": "x"}))
files = repo_files()
files["release/hooks/health"] = "#!/bin/sh\nsleep 3\nexit 0\n"
self.gh.commits[0]["files"] = files
self.assertTrue(self.make(health_timeout="1").install())
self.assertEqual(self.u.active_id(), self.rid(c))
def test_hook_failure_still_rolls_back_without_units(self):
self.set_units([], known=[])
c0 = self.gh.add()
self.u.install()
self.gh.add("2.0.1", hook=HOOK_FAIL)
self.assertFalse(self.u.install())
self.assertEqual(self.u.active_id(), self.rid(c0))
def test_not_while_sending(self):
self.gh.add()
self.set_units(["pipbox.service", "pipbox-send.service"])
self.assertEqual(self.u.run("install"), 2)
self.assertIn("gesendet", self.status()["message"])
self.assertIsNone(self.u.active_id())
def test_manifest_problems(self):
for man, text in (({"min_updater": 99}, "neueren Update-Helfer"),
({"restart": ["pipbox.service; reboot"]}, "restart"),
({"name": "anders"}, "kein IRL4YOU-Paket")):
self.gh.add(manifest=man)
self.assertEqual(self.u.run("install"), 2, man)
self.assertIn(text, self.status()["message"])
def test_missing_irl4you_dir(self):
files = repo_files()
files.pop("irl4you/server.py")
files.pop("irl4you/web/static")
self.gh.add(files=files)
self.assertEqual(self.u.run("install"), 2)
self.assertIn("irl4you/", self.status()["message"])
def test_size_limit(self):
self.gh.add()
u = self.make(max_download_mb="0")
self.assertEqual(u.run("install"), 2)
self.assertIn("größer als erlaubt", u.load_status()["message"])
def test_extra_link_real_dir(self):
os.makedirs(self.overrides["extra_link"])
self.gh.add()
self.assertFalse(self.u.install())
self.assertEqual(self.status()["state"], "failed")
self.assertTrue(os.path.isdir(self.overrides["extra_link"]) and not os.path.islink(self.overrides["extra_link"]))
def test_reboot_flag(self):
self.gh.add(manifest={"reboot": True})
self.u.install()
self.assertTrue(self.status()["reboot_required"])
def test_debs(self):
self.gh.add(irl={"irl4you/debs/irl4you-wifi-8821cu_1.0_arm64.deb": b"deb"})
self.assertTrue(self.u.install())
self.assertTrue(os.path.isfile(os.path.join(self.overrides["root"], "current", "debs", "irl4you-wifi-8821cu_1.0_arm64.deb")))
def test_only_debs_in_debs(self):
self.gh.add(irl={"irl4you/debs/evil.sh": b"#!/bin/sh"})
self.assertEqual(self.u.run("install"), 2)
self.assertIn("nur .deb", self.status()["message"])
class TestUnsafeArchives(Base):
def attempt(self, factory):
self.gh.add(extra=[factory])
self.assertEqual(self.u.run("install"), 2, self.status())
self.assertIsNone(self.u.active_id())
self.assertFalse(os.path.exists(os.path.join(self.tmp, "evil")))
def test_path_traversal(self):
def f(top):
ti = tarfile.TarInfo("../../../../evil")
ti.size = 1
return ti, b"x"
self.attempt(f)
def test_absolute_path(self):
def f(top):
ti = tarfile.TarInfo(os.path.join(self.tmp, "evil"))
ti.size = 1
return ti, b"x"
self.attempt(f)
def test_symlink_out(self):
def f(top):
ti = tarfile.TarInfo(top + "etc")
ti.type, ti.linkname = tarfile.SYMTYPE, "/etc"
return ti, None
self.attempt(f)
def test_symlink_relative_out(self):
def f(top):
ti = tarfile.TarInfo(top + "a/b")
ti.type, ti.linkname = tarfile.SYMTYPE, "../../../evil"
return ti, None
self.attempt(f)
def test_device(self):
def f(top):
ti = tarfile.TarInfo(top + "dev")
ti.type = tarfile.CHRTYPE
return ti, None
self.attempt(f)
def test_hardlink(self):
def f(top):
ti = tarfile.TarInfo(top + "hl")
ti.type, ti.linkname = tarfile.LNKTYPE, "VERSION"
return ti, None
self.attempt(f)
def test_two_top_dirs(self):
def f(top):
ti = tarfile.TarInfo("zweiter-ordner/x")
ti.size = 1
return ti, b"x"
self.attempt(f)
class TestRollbackSwitch(Base):
def setUp(self):
super().setUp()
self.cs = []
for v in ("2.0.0", "2.0.1"):
self.cs.append(self.gh.add(v))
self.u.install()
def test_rollback_and_forward(self):
self.assertEqual(self.u.run("rollback"), 0)
self.assertEqual(self.u.active_id(), self.rid(self.cs[0]))
self.assertEqual(self.u.previous_id(), self.rid(self.cs[1]))
self.assertEqual(self.hooks()[-1], "switch 2.0.0 prev=%s" % self.rid(self.cs[1]))
self.assertEqual(self.u.run("rollback"), 0)
self.assertEqual(self.u.active_id(), self.rid(self.cs[1]))
def test_switch_local_by_short_and_full_sha(self):
self.assertEqual(self.u.run("switch", self.cs[0]["sha"][:7]), 0)
self.assertEqual(self.u.active_id(), self.rid(self.cs[0]))
self.assertEqual(self.u.run("switch", self.cs[1]["sha"]), 0)
self.assertEqual(self.u.active_id(), self.rid(self.cs[1]))
def test_switch_remote_older(self):
for v in ("2.0.2", "2.0.3"):
self.cs.append(self.gh.add(v))
self.u.install()
self.assertNotIn(self.rid(self.cs[0]), self.on_disk())
self.assertEqual(self.u.run("switch", self.cs[0]["sha"]), 0, self.status())
self.assertEqual(self.u.active_id(), self.rid(self.cs[0]))
def test_switch_unknown(self):
self.assertEqual(self.u.run("switch", "9" * 40), 2)
self.assertIn("nicht gefunden", self.status()["message"])
def test_switch_current_refused(self):
self.assertEqual(self.u.run("switch", self.cs[1]["sha"][:10]), 2)
def test_rollback_without_previous(self):
os.remove(os.path.join(self.overrides["state_dir"], "previous"))
self.assertEqual(self.u.run("rollback"), 2)
class TestAuto(Base):
def test_only_reports_by_default(self):
self.gh.add()
self.u.auto()
self.assertIsNone(self.u.active_id())
self.assertTrue(self.status()["available"])
def test_installs_when_allowed(self):
c = self.gh.add()
self.make(auto_install="true").auto()
self.assertEqual(self.u.active_id(), self.rid(c))
def test_waits_for_ci(self):
self.gh.add(ci="pending")
self.make(auto_install="true").auto()
self.assertIsNone(self.u.active_id())
def test_waits_while_sending(self):
self.gh.add()
self.set_units(["pipbox.service", "pipbox-send.service"])
self.make(auto_install="true").auto()
self.assertIsNone(self.u.active_id())
class TestRequest(Base):
def req(self, text):
os.makedirs(self.overrides["state_dir"], exist_ok=True)
with open(self.overrides["request_file"], "w") as f:
f.write(text)
r = self.u.read_request()
self.assertFalse(os.path.exists(self.overrides["request_file"]))
return r
def test_valid(self):
self.assertEqual(self.req("install\n"), ("install", ""))
self.assertEqual(self.req("check"), ("check", ""))
self.assertEqual(self.req("switch\nabcdef1\n"), ("switch", "abcdef1"))
self.assertEqual(self.req("rollback\n"), ("rollback", ""))
def test_invalid(self):
for t in ("reboot", "install\nabcdef1", "switch", "switch\n2.0.1", "switch\nabc", "switch\nabcdef1\nextra",
"switch\n../../x", "check; rm -rf /", ""):
self.assertEqual(self.req(t), (None, None), t)
def test_symlink_ignored(self):
os.makedirs(self.overrides["state_dir"], exist_ok=True)
target = os.path.join(self.tmp, "secret")
with open(target, "w") as f:
f.write("install")
os.symlink(target, self.overrides["request_file"])
self.assertEqual(self.u.read_request(), (None, None))
self.assertTrue(os.path.exists(target))
class TestToken(Base):
def token_file(self, mode=0o600):
p = os.path.join(self.tmp, "token")
with open(p, "w") as f:
f.write("geheim123\n")
os.chmod(p, mode)
return p
def test_token_sent_to_api_not_to_redirect(self):
self.gh.add()
self.gh.redirect = True
self.assertTrue(self.make(token_file=self.token_file()).install())
api = [r for r in self.gh.requests if not r[1].startswith("/blob/")]
blob = [r for r in self.gh.requests if r[1].startswith("/blob/")]
self.assertTrue(api and blob)
self.assertTrue(all(r[2] == "Bearer geheim123" for r in api))
self.assertTrue(all(r[2] is None and r[0].startswith("localhost") for r in blob))
with open(self.overrides["log_file"]) as f:
self.assertNotIn("geheim123", f.read())
def test_token_file_must_be_private(self):
self.gh.add()
u = self.make(token_file=self.token_file(0o644))
self.assertEqual(u.run("check"), 2)
self.assertIn("chmod 600", u.load_status()["message"])
def test_missing_token_file_is_public_mode(self):
self.gh.add()
self.assertEqual(self.make(token_file=os
5602
.path.join(self.tmp, "fehlt")).check()[1], True)
self.assertTrue(all(r[2] is None for r in self.gh.requests))
class TestShippedFiles(unittest.TestCase):
def test_scripts_parse(self):
for p in ("irl4you/install/system-install.sh", "irl4you/install/system-base-fixes.sh", "irl4you/install/zz-irl4you-boot",
"release/hooks/install", "release/hooks/health"):
subprocess.run(["sh", "-n", os.path.join(REPO, p)], check=True)
def test_system_install_calls_base_fixes_and_debs(self):
with open(os.path.join(REPO, "irl4you/install/system-install.sh")) as f:
text = f.read()
self.assertIn("system-base-fixes.sh", text)
self.assertIn("debs/*.deb", text)
def test_repo_assembles_to_valid_package(self):
d = tempfile.mkdtemp()
self.addCleanup(subprocess.run, ["rm", "-rf", d])
dest = os.path.join(d, "pkg")
sha = "a" * 40
version = U.Updater.assemble(REPO, dest, sha)
m = U.Updater.read_manifest(dest, sha)
self.assertEqual(m["version"], version)
self.assertEqual(m["restart"], ["pipbox.service", "pipbox-rtmpstat.service", "pipbox-dji.service", "pipbox-hdmi.service", "pipbox-health.service", "pipbox-arp.service"])
for p in ("hooks/install", "hooks/health", "updater/irl4you_update.py", "updater/systemd/irl4you-update.path",
"install/system-install.sh", "install/zz-irl4you-boot", "VERSION"):
self.assertTrue(os.path.isfile(os.path.join(dest, p)), p)
self.assertTrue(os.access(os.path.join(dest, "hooks/install"), os.X_OK))
def test_default_config_example_loads(self):
c = U.Config(path=os.path.join(REPO, "updater", "update.conf.example"))
self.assertEqual((c.repo, c.branch, c.require_ci, c.auto_install), ("IRL4YOU/IRL4YOU-BOX", "main", True, False))
if __name__ == "__main__":
unittest.main()