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
|
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import json
from testinfra.modules.base import Module
class Package(Module):
"""Test packages status and version"""
def __init__(self, name):
self.name = name
super().__init__()
@property
def is_installed(self):
"""Test if the package is installed
>>> host.package("nginx").is_installed
True
Supported package systems:
- apk (Alpine)
- apt (Debian, Ubuntu, ...)
- brew (macOS)
- pacman (Arch, Manjaro )
- pkg (FreeBSD)
- pkg_info (NetBSD)
- pkg_info (OpenBSD)
- rpm (RHEL, RockyLinux, Fedora, ...)
"""
raise NotImplementedError
@property
def release(self):
"""Return the release specific info from the package version
>>> host.package("nginx").release
'1.el6'
"""
raise NotImplementedError
@property
def version(self):
"""Return package version as returned by the package system
>>> host.package("nginx").version
'1.2.1-2.2+wheezy3'
"""
raise NotImplementedError
def __repr__(self):
return f"<package {self.name}>"
@classmethod
def get_module_class(cls, host):
if host.system_info.type == "windows":
return ChocolateyPackage
if host.system_info.type == "freebsd":
return FreeBSDPackage
if host.system_info.type in ("openbsd", "netbsd"):
return OpenBSDPackage
if host.system_info.distribution in ("debian", "ubuntu"):
return DebianPackage
if host.system_info.distribution and (
host.system_info.distribution.lower()
in (
"almalinux",
"centos",
"cloudlinux",
"fedora",
"ol",
"opensuse-leap",
"opensuse-tumbleweed",
"rhel",
"rocky",
)
):
return RpmPackage
if host.system_info.distribution in ("arch", "manjarolinux"):
return ArchPackage
if host.exists("apk"):
return AlpinePackage
# Fallback conditions
if host.exists("dpkg-query"):
return DebianPackage
if host.exists("rpm"):
return RpmPackage
if host.exists("brew"):
return HomebrewPackage
raise NotImplementedError
class DebianPackage(Package):
@property
def is_installed(self):
result = self.run_test("dpkg-query -f '${Status}' -W %s", self.name)
if result.rc == 1:
return False
out = result.stdout.strip().split()
installed_status = ["ok", "installed"]
return out[0] in ["install", "hold"] and out[1:3] == installed_status
@property
def release(self):
raise NotImplementedError
@property
def version(self):
out = self.check_output("dpkg-query -f '${Status} ${Version}' -W %s", self.name)
splitted = out.split()
assert splitted[0].lower() in (
"install",
"hold",
), f"The package {self.name} is not installed, dpkg-query output: {out}"
return splitted[3]
class FreeBSDPackage(Package):
@property
def is_installed(self):
EX_UNAVAILABLE = 69
return (
self.run_expect([0, EX_UNAVAILABLE], "pkg query %%n %s", self.name).rc == 0
)
@property
def release(self):
raise NotImplementedError
@property
def version(self):
return self.check_output("pkg query %%v %s", self.name)
class OpenBSDPackage(Package):
@property
def is_installed(self):
return self.run_test("pkg_info -e %s", f"{self.name}-*").rc == 0
@property
def release(self):
raise NotImplementedError
@property
def version(self):
out = self.check_output("pkg_info -e %s", f"{self.name}-*")
# OpenBSD: inst:zsh-5.0.5p0
# NetBSD: zsh-5.0.7nb1
return out.split(self.name + "-", 1)[1]
class RpmPackage(Package):
@property
def is_installed(self):
result = self.run_test("rpm -q --quiet %s 2>&1", self.name)
if result.succeeded:
return True
elif result.failed and result.stdout == "":
return False
else:
raise RuntimeError(
f"Could not check if RPM package '{self.name}' is installed. {result.stdout}"
)
@property
def version(self):
return self.check_output('rpm -q --queryformat="%%{VERSION}" %s', self.name)
@property
def release(self):
return self.check_output('rpm -q --queryformat="%%{RELEASE}" %s', self.name)
class AlpinePackage(Package):
@property
def is_installed(self):
return self.run_test("apk -e info %s", self.name).rc == 0
@property
def version(self):
out = self.check_output("apk -e -v info %s", self.name).split("-")
return out[-2]
@property
def release(self):
out = self.check_output("apk -e -v info %s", self.name).split("-")
return out[-1]
class ArchPackage(Package):
@property
def is_installed(self):
return self.run_test("pacman -Q %s", self.name).rc == 0
@property
def version(self):
out = self.check_output("pacman -Q %s", self.name).split(" ")
return out[1]
@property
def release(self):
raise NotImplementedError
class ChocolateyPackage(Package):
@property
def is_installed(self):
return self.run_test("choco info -lo %s", self.name).rc == 0
@property
def version(self):
_, version = self.check_output("choco info -lo %s -r", self.name).split("|", 1)
return version
@property
def release(self):
raise NotImplementedError
class HomebrewPackage(Package):
@property
def is_installed(self):
info = self.check_output("brew info --formula --json %s", self.name)
return len(json.loads(info)[0]["installed"]) > 0
@property
def version(self):
info = self.check_output("brew info --formula --json %s", self.name)
version = json.loads(info)[0]["installed"][0]["version"]
return version
@property
def release(self):
raise NotImplementedError
|