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
|
# This file is part of Cockpit.
#
# Copyright (C) 2017 Red Hat, Inc.
#
# Cockpit is free software; you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 2.1 of the License, or
# (at your option) any later version.
#
# Cockpit is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Cockpit; If not, see <http://www.gnu.org/licenses/>.
import logging
import os
import textwrap
from testlib import MachineCase
class PackageCase(MachineCase):
def setUp(self):
super().setUp()
self.repo_dir = os.path.join(self.vm_tmpdir, "repo")
if self.machine.ostree_image:
logging.warning("PackageCase: OSTree images can't install additional packages")
return
# expected backend; hardcode this on image names to check the auto-detection
if self.machine.image.startswith("debian") or self.machine.image.startswith("ubuntu"):
self.backend = "apt"
self.primary_arch = "all"
self.secondary_arch = "amd64"
elif self.machine.image.startswith("fedora") or self.machine.image.startswith("rhel-") or self.machine.image.startswith("centos-"):
self.backend = "dnf"
self.primary_arch = "noarch"
self.secondary_arch = "x86_64"
elif self.machine.image == "arch":
self.backend = "alpm"
self.primary_arch = "any"
self.secondary_arch = "x86_64"
else:
raise NotImplementedError("unknown image " + self.machine.image)
if "debian" in self.image or "ubuntu" in self.image:
# PackageKit refuses to work when offline, and main interface is not managed by NM on these images
self.machine.execute("nmcli con add type dummy con-name fake ifname fake0 ip4 1.2.3.4/24 gw4 1.2.3.1")
self.addCleanup(self.machine.execute, "nmcli con delete fake")
# HACK: packagekit often hangs on shutdown; https://bugzilla.redhat.com/show_bug.cgi?id=1717185
self.write_file("/etc/systemd/system/packagekit.service.d/timeout.conf", "[Service]\nTimeoutStopSec=5\n")
self.addCleanup(self.machine.execute, "systemctl stop packagekit; systemctl reset-failed packagekit || true")
# disable all existing repositories to avoid hitting the network
if self.backend == "apt":
self.restore_dir("/var/lib/apt", reboot_safe=True)
self.restore_dir("/var/cache/apt", reboot_safe=True)
self.restore_dir("/etc/apt", reboot_safe=True)
self.machine.execute("echo > /etc/apt/sources.list; rm -f /etc/apt/sources.list.d/*; apt-get clean; apt-get update")
elif self.backend == "alpm":
self.restore_dir("/var/lib/pacman", reboot_safe=True)
self.restore_dir("/var/cache/pacman", reboot_safe=True)
self.restore_dir("/etc/pacman.d", reboot_safe=True)
self.restore_dir("/var/lib/PackageKit/alpm", reboot_safe=True)
self.restore_file("/etc/pacman.conf")
self.restore_file("/etc/pacman.d/mirrorlist")
self.restore_file("/usr/share/libalpm/hooks/90-packagekit-refresh.hook")
self.machine.execute("rm /etc/pacman.conf /etc/pacman.d/mirrorlist /var/lib/pacman/sync/* /usr/share/libalpm/hooks/90-packagekit-refresh.hook")
self.machine.execute("test -d /var/lib/PackageKit/alpm && rm -r /var/lib/PackageKit/alpm || true") # Drop alpm state directory as it interferes with running offline
# Initial config for installation
empty_repo_dir = '/var/lib/cockpittest/empty'
config = f"""
[options]
Architecture = auto
HoldPkg = pacman glibc
[empty]
SigLevel = Never
Server = file://{empty_repo_dir}
"""
# HACK: Setup empty repo for packagekit
self.machine.execute(f"mkdir -p {empty_repo_dir} || true")
self.machine.execute(f"repo-add {empty_repo_dir}/empty.db.tar.gz")
self.machine.write("/etc/pacman.conf", config)
# Clean up possible leftover lockfile
self.machine.execute("""
if [ -f /var/lib/pacman/db.lck ]; then
fuser -k /var/lib/pacman/db.lck || true;
rm /var/lib/pacman/db.lck;
fi
""")
self.machine.execute("pacman -Sy")
else:
self.restore_dir("/etc/yum.repos.d", reboot_safe=True)
self.restore_dir("/var/cache/dnf", reboot_safe=True)
self.machine.execute("rm -rf /etc/yum.repos.d/* /var/cache/dnf/*")
# have PackageKit start from a clean slate
self.machine.execute("systemctl stop packagekit")
self.machine.execute("systemctl kill --signal=SIGKILL packagekit || true; rm -rf /var/cache/PackageKit")
self.machine.execute("systemctl reset-failed packagekit || true")
self.restore_file("/var/lib/PackageKit/transactions.db")
if self.image in ["debian-stable", "debian-testing"]:
# PackageKit tries to resolve some DNS names, but our test VM is offline; temporarily disable the name server to fail quickly
self.machine.execute("mv /etc/resolv.conf /etc/resolv.conf.test")
self.addCleanup(self.machine.execute, "mv /etc/resolv.conf.test /etc/resolv.conf")
# reset automatic updates
if self.backend == 'dnf':
self.machine.execute("systemctl disable --now dnf-automatic dnf-automatic-install "
"dnf-automatic.service dnf-automatic-install.timer")
self.machine.execute("rm -r /etc/systemd/system/dnf-automatic* && systemctl daemon-reload || true")
self.updateInfo = {}
# HACK: kpatch check sometimes complains that we don't set up a full repo in unrelated tests
self.allow_browser_errors("Could not determine kpatch packages:.*repodata updates was not complete")
#
# Helper functions for creating packages/repository
#
def createPackage(self, name, version, release, install=False,
postinst=None, depends="", content=None, arch=None, provides=None, **updateinfo):
"""Create a dummy package in repo_dir on self.machine
If install is True, install the package. Otherwise, update the package
index in repo_dir.
"""
if provides:
provides = f"Provides: {provides}"
else:
provides = ""
if self.backend == "apt":
self.createDeb(name, version + '-' + release, depends, postinst, install, content, arch, provides)
elif self.backend == "alpm":
self.createPacmanPkg(name, version, release, depends, postinst, install, content, arch, provides)
else:
self.createRpm(name, version, release, depends, postinst, install, content, arch, provides)
if updateinfo:
self.updateInfo[(name, version, release)] = updateinfo
def createDeb(self, name, version, depends, postinst, install, content, arch, provides):
"""Create a dummy deb in repo_dir on self.machine
If install is True, install the package. Otherwise, update the package
index in repo_dir.
"""
m = self.machine
if arch is None:
arch = self.primary_arch
deb = f"{self.repo_dir}/{name}_{version}_{arch}.deb"
if postinst:
postinstcode = f"printf '#!/bin/sh\n{postinst}' > /tmp/b/DEBIAN/postinst; chmod 755 /tmp/b/DEBIAN/postinst"
else:
postinstcode = ''
if content is not None:
for path, data in content.items():
dest = "/tmp/b/" + path
m.execute(f"mkdir -p '{os.path.dirname(dest)}'")
if isinstance(data, dict):
m.execute(f"cp '{data['path']}' '{dest}'")
else:
m.write(dest, data)
m.execute(f"mkdir -p {self.repo_dir}")
m.write("/tmp/b/DEBIAN/control", textwrap.dedent(f"""
Package: {name}
Version: {version}
Priority: optional
Section: test
Maintainer: foo
Depends: {depends}
Architecture: {arch}
Description: dummy {name}
{provides}
"""))
cmd = f"""set -e
{postinstcode}
touch /tmp/b/stamp-{name}-{version}
dpkg -b /tmp/b {deb}
rm -r /tmp/b
"""
if install:
cmd += "dpkg -i " + deb
m.execute(cmd)
self.addCleanup(m.execute, f"dpkg -P --force-depends --force-remove-reinstreq {name} 2>/dev/null || true")
def createRpm(self, name, version, release, requires, post, install, content, arch, provides):
"""Create a dummy rpm in repo_dir on self.machine
If install is True, install the package. Otherwise, update the package
index in repo_dir.
"""
if post:
postcode = '\n%%post\n' + post
else:
postcode = ''
if requires:
requires = f"Requires: {requires}\n"
if arch is None:
arch = self.primary_arch
installcmds = f"touch $RPM_BUILD_ROOT/stamp-{name}-{version}-{release}\n"
installedfiles = f"/stamp-{name}-{version}-{release}\n"
if content is not None:
for path, data in content.items():
installcmds += f'mkdir -p $(dirname "$RPM_BUILD_ROOT/{path}")\n'
if isinstance(data, dict):
installcmds += f"cp {data['path']} \"$RPM_BUILD_ROOT/{path}\""
else:
installcmds += f'cat >"$RPM_BUILD_ROOT/{path}" <<\'EOF\'\n' + data + '\nEOF\n'
installedfiles += f"{path}\n"
architecture = ""
if arch == self.primary_arch:
architecture = f"BuildArch: {self.primary_arch}"
spec = f"""
Summary: dummy {name}
Name: {name}
Version: {version}
Release: {release}
License: BSD
{provides}
{architecture}
{requires}
%%install
{installcmds}
%%description
Test package.
%%files
{installedfiles}
{postcode}
"""
self.machine.write("/tmp/spec", spec)
cmd = """
rpmbuild --quiet -bb /tmp/spec
mkdir -p {0}
cp ~/rpmbuild/RPMS/{4}/*.rpm {0}
rm -rf ~/rpmbuild
"""
if install:
cmd += "rpm -i {0}/{1}-{2}-{3}.*.rpm"
self.machine.execute(cmd.format(self.repo_dir, name, version, release, arch))
self.addCleanup(self.machine.execute, f"rpm -e --nodeps {name} 2>/dev/null || true")
def createPacmanPkg(self, name, version, release, requires, postinst, install, content, arch, provides):
"""Create a dummy pacman package in repo_dir on self.machine
If install is True, install the package. Otherwise, update the package
index in repo_dir.
"""
if arch is None:
arch = 'any'
sources = ""
installcmds = 'package() {\n'
if content is not None:
sources = "source=("
files = 0
for path, data in content.items():
p = os.path.dirname(path)
installcmds += f'mkdir -p $pkgdir{p}\n'
if isinstance(data, dict):
dpath = data["path"]
file = os.path.basename(dpath)
sources += file
files += 1
# TODO: hardcoded /tmp
self.machine.execute(f'cp {data["path"]} /tmp/{file}')
installcmds += f'cp {file} $pkgdir{path}\n'
else:
installcmds += f'cat >"$pkgdir{path}" <<\'EOF\'\n' + data + '\nEOF\n'
sources += ")"
# Always stamp a file
installcmds += f"touch $pkgdir/stamp-{name}-{version}-{release}\n"
installcmds += '}'
pkgbuild = f"""
pkgname={name}
pkgver={version}
pkgdesc="dummy {name}"
pkgrel={release}
arch=({arch})
depends=({requires})
{sources}
{installcmds}
"""
if postinst:
postinstcode = f"""
post_install() {{
{postinst}
}}
post_upgrade() {{
post_install $*
}}
"""
self.machine.write(f"/tmp/{name}.install", postinstcode)
pkgbuild += f"\ninstall={name}.install\n"
self.machine.write("/tmp/PKGBUILD", pkgbuild)
cmd = """
cd /tmp/
su builder -c "makepkg --cleanbuild --clean --force --nodeps --skipinteg --noconfirm"
"""
if install:
cmd += f"pacman -U --overwrite '*' --noconfirm {name}-{version}-{release}-{arch}.pkg.tar.zst\n"
cmd += f"mkdir -p {self.repo_dir}\n"
cmd += f"mv *.pkg.tar.zst {self.repo_dir}\n"
# Clean up packaging files
cmd += "rm PKGBUILD\n"
if postinst:
cmd += f"rm /tmp/{name}.install"
self.machine.execute(cmd)
self.addCleanup(self.machine.execute, f"pacman -Rdd --noconfirm {name} 2>/dev/null || true")
def createAptChangelogs(self):
# apt metadata has no formal field for bugs/CVEs, they are parsed from the changelog
for ((pkg, ver, rel), info) in self.updateInfo.items():
changes = info.get("changes", "some changes")
if info.get("bugs"):
changes += f" (Closes: {', '.join([('#' + str(b)) for b in info['bugs']])})"
if info.get("cves"):
changes += "\n * " + ", ".join(info["cves"])
path = f"{self.repo_dir}/changelogs/{pkg[0]}/{pkg}/{pkg}_{ver}-{rel}"
contents = f"""{pkg} ({ver}-{rel}) unstable; urgency=medium
* {changes}
-- Joe Developer <joe@example.com> Wed, 31 May 2017 14:52:25 +0200
"""
self.machine.execute(f"mkdir -p $(dirname {path}); echo '{contents}' > {path}")
def createYumUpdateInfo(self):
xml = '<?xml version="1.0" encoding="UTF-8"?>\n<updates>\n'
for ((pkg, ver, rel), info) in self.updateInfo.items():
refs = ""
for b in info.get("bugs", []):
refs += f' <reference href="https://bugs.example.com?bug={b}" id="{b}" title="Bug#{b} Description" type="bugzilla"/>\n'
for c in info.get("cves", []):
refs += f' <reference href="https://www.cve.org/CVERecord?id={c}" id="{c}" title="{c}" type="cve"/>\n'
if info.get("securitySeverity"):
refs += ' <reference href="https://access.redhat.com/security/updates/classification/#{0}" id="" title="" type="other"/>\n'.format(info[
"securitySeverity"])
for e in info.get("errata", []):
refs += f' <reference href="https://access.redhat.com/errata/{e}" id="{e}" title="{e}" type="self"/>\n'
xml += """ <update from="test@example.com" status="stable" type="{severity}" version="2.0">
<id>UPDATE-{pkg}-{ver}-{rel}</id>
<title>{pkg} {ver}-{rel} update</title>
<issued date="2017-01-01 12:34:56"/>
<description>{desc}</description>
<references>
{refs}
</references>
<pkglist>
<collection short="0815">
<package name="{pkg}" version="{ver}" release="{rel}" epoch="0" arch="noarch">
<filename>{pkg}-{ver}-{rel}.noarch.rpm</filename>
</package>
</collection>
</pkglist>
</update>
""".format(pkg=pkg, ver=ver, rel=rel, refs=refs,
desc=info.get("changes", ""), severity=info.get("severity", "bugfix"))
xml += '</updates>\n'
return xml
def addPackageSet(self, name):
self.machine.execute(f"mkdir -p {self.repo_dir}; cp /var/lib/package-sets/{name}/* {self.repo_dir}")
def enableRepo(self):
if self.backend == "apt":
self.createAptChangelogs()
self.machine.execute(f"""echo 'deb [trusted=yes] file://{self.repo_dir} /' > /etc/apt/sources.list.d/test.list
cd {self.repo_dir}; apt-ftparchive packages . > Packages
xz -c Packages > Packages.xz
O=$(apt-ftparchive -o APT::FTPArchive::Release::Origin=cockpittest release .); echo "$O" > Release
echo 'Changelogs: http://localhost:12345/changelogs/@CHANGEPATH@' >> Release
""")
pid = self.machine.spawn(f"cd {self.repo_dir}; exec python3 -m http.server 12345", "changelog")
# pid will not be present for rebooting tests
self.addCleanup(self.machine.execute, "kill %i || true" % pid)
self.machine.wait_for_cockpit_running(port=12345) # wait for changelog HTTP server to start up
elif self.backend == "alpm":
self.machine.execute(f"""cd {self.repo_dir}
repo-add {self.repo_dir}/testrepo.db.tar.gz *.pkg.tar.zst
""")
config = f"""
[testrepo]
SigLevel = Never
Server = file://{self.repo_dir}
"""
if 'testrepo' not in self.machine.execute('grep testrepo /etc/pacman.conf || true'):
self.machine.write("/etc/pacman.conf", config, append=True)
else:
self.machine.execute("""printf '[updates]\nname=cockpittest\nbaseurl=file://{0}\nenabled=1\ngpgcheck=0\n' > /etc/yum.repos.d/cockpittest.repo
echo '{1}' > /tmp/updateinfo.xml
createrepo_c {0}
modifyrepo_c /tmp/updateinfo.xml {0}/repodata
dnf clean all""".format(self.repo_dir, self.createYumUpdateInfo()))
|