archey4/archey/test/entries/test_archey_packages.py
Michael Bromilow d17dfc7d29
Tests cleanup
2024-04-13 21:00:40 +01:00

329 lines
12 KiB
Python

"""Test module for Archey's installed system packages detection module"""
import unittest
from unittest.mock import DEFAULT as DEFAULT_SENTINEL
from unittest.mock import patch
from archey.distributions import Distributions
from archey.entries.packages import Packages
from archey.test.entries import HelperMethods
class TestPackagesEntry(unittest.TestCase):
"""
Here, we mock the `check_output` calls and check afterwards
that the outputs are correct.
Sorry for the code style, mocking this class is pretty boring.
Note: Due to the presence of trailing spaces, we may have to manually
"inject" the OS line separator in some mocked outputs.
"""
def setUp(self):
# Clear cache filled by `functools.lru_cache` decorator.
Distributions.get_local.cache_clear()
@patch(
"archey.entries.packages.check_output",
return_value="""\
sqlite-libs-3.30.1-r1 x86_64 {{sqlite}} (Public-Domain) [installed]
musl-1.1.24-r2 x86_64 {{musl}} (MIT) [installed]
libbz2-1.0.8-r1 x86_64 {{bzip2}} (bzip2-1.0.6) [installed]
gdbm-1.13-r1 x86_64 {{gdbm}} (GPL) [installed]
ncurses-libs-6.1_p20200118-r3 x86_64 {{ncurses}} (MIT) [installed]
zlib-1.2.11-r3 x86_64 {{zlib}} (Zlib) [installed]
apk-tools-2.10.4-r3 x86_64 {{apk}-tools} (GPL2) [installed]
readline-8.0.1-r0 x86_64 {{readline}} (GPL-2.0-or-later) [installed]
""",
)
def test_match_with_apk(self, check_output_mock):
"""Simple test for the APK packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("apk")
self.assertEqual(Packages().value, 8)
@patch(
"archey.entries.packages.check_output",
return_value="""\
Installed Packages
GConf2.x86_64 3.2.6-17.fc26 @@commandline
GeoIP.x86_64 1.6.11-1.fc26 @@commandline
GeoIP-GeoLite-data.noarch 2017.07-1.fc26 @@commandline
GraphicsMagick.x86_64 1.3.26-3.fc26 @@commandline
""",
)
def test_match_with_dnf(self, check_output_mock):
"""Simple test for the DNF packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("dnf")
self.assertEqual(Packages().value, 4)
@patch(
"archey.entries.packages.check_output",
return_value="""\
accountsservice install
acl install
adb install
adduser install
adwaita-icon-theme install
albatross-gtk-theme deinstall
alien install
""",
)
def test_match_with_dpkg(self, check_output_mock):
"""Simple test for the DPKG packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("dpkg")
self.assertEqual(Packages().value, 6)
@patch(
"archey.entries.packages.check_output",
return_value="""\
These are the packages that would be merged, in order:
Calculating dependencies ... done!
[ebuild U ] sys-libs/glibc-2.25-r10 [2.25-r9]
[ebuild R ] sys-apps/busybox-1.28.0 \n\
[ebuild N ] sys-libs/libcap-2.24-r2 \
USE="pam -static-libs" ABI_X86="(64) -32 (-x32)" \n\
[ebuild U ] app-misc/pax-utils-1.2.2-r2 [1.1.7]
[ebuild R ] x11-misc/shared-mime-info-1.9 \n\
""",
)
def test_match_with_emerge(self, check_output_mock):
"""Simple test for the Emerge packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("emerge")
self.assertEqual(Packages().value, 5)
@patch(
"archey.entries.packages.check_output",
return_value="""\
nix-2.3.4
nss-cacert-3.49.2
python3-3.8.2
python3.8-pip-20.1
""",
)
def test_match_with_nix_env(self, check_output_mock):
"""Simple test for the Emerge packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("nix-env")
self.assertEqual(Packages().value, 4)
@patch(
"archey.entries.packages.check_output",
return_value="""\
acl 2.2.52-4
archey4 v4.3.3-1
archlinux-keyring 20180108-1
argon2 20171227-3
""",
)
def test_match_with_pacman(self, check_output_mock):
"""Simple test for the Pacman packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("pacman")
self.assertEqual(Packages().value, 4)
@patch(
"archey.entries.packages.check_output",
return_value="""\
bzip2-1.0.8 block-sorting file compressor, unencumbered
gettext-runtime-0.20.1p0 GNU gettext runtime libraries and programs
intel-firmware-20191115v0 microcode update binaries for Intel CPUs
libffi-3.2.1p5 Foreign Function Interface
libiconv-1.16p0 character set conversion library
python-3.7.4 interpreted object-oriented programming language
quirks-3.187 exceptions to pkg_add rules
sqlite3-3.29.0 embedded SQL implementation
xz-5.2.4 LZMA compression and decompression tools
""",
)
def test_match_with_pkg_info(self, check_output_mock):
"""Simple test for the OpenBSD `pkg_*` package manager"""
check_output_mock.side_effect = self._check_output_side_effect("pkg_info")
self.assertEqual(Packages().value, 9)
@patch("archey.entries.packages.Distributions.get_local", return_value=Distributions.FREEBSD)
@patch(
"archey.entries.packages.check_output",
return_value="""\
gettext-runtime-0.20.1 GNU gettext runtime libraries and programs
indexinfo-0.3.1 Utility to regenerate the GNU info page index
libffi-3.2.1_3 Foreign Function Interface
pkg-1.13.2 Package manager
python-3.7_3,2 "meta-port" for the default version of Python interpreter
python3-3_3 The "meta-port" for version 3 of the Python interpreter
python37-3.7.7 Interpreted object-oriented programming language
readline-8.0.4 Library for editing command lines as they are typed
""",
)
def test_match_with_pkg(self, check_output_mock, _):
"""Simple test for the FreeBSD `pkg` package manager"""
check_output_mock.side_effect = self._check_output_side_effect("pkg")
self.assertEqual(Packages().value, 8)
@patch(
"archey.entries.packages.check_output",
return_value="""\
desktop-file-utils-0.26 Utilities to manage desktop entries
glib2-2.68.2 Some useful routines for C programming (glib2)
hicolor-icon-theme-0.17nb1 Standard icon theme called hicolor
htop-3.0.5 Enhanced version of top utility
libffi-3.3nb5 Foreign function interface
libslang2-2.2.4nb3 Routines for rapid alpha-numeric terminal applications development
mc-4.8.26nb1 User-friendly file manager and visual shell
nano-5.7 Small and friendly text editor (a free replacement for Pico)
ncurses-6.2nb3 CRT screen handling and optimization package
ncursesw-6.2 Wide character CRT screen handling and optimization package
pcre-8.44 Perl Compatible Regular Expressions library
pkg_install-20210410 Package management and administration tools for pkgsrc
pkgin-20.12.1nb1 Apt / yum like tool for managing pkgsrc binary packages
""",
)
def test_match_with_pkgin(self, check_output_mock):
"""Simple test for the (NetBSD) `pkgin` package manager"""
check_output_mock.side_effect = self._check_output_side_effect("pkgin")
self.assertEqual(Packages().value, 13)
@patch(
"archey.entries.packages.check_output",
return_value="""\
The following ports are currently installed:
a52dec @0.7.4_0 (active)
adns @1.4_0 (active)
apache2 @2.2.27_0+preforkmpm (active)
apr @1.5.1_0 (active)
apr-util @1.5.3_0 (active)
aquaterm @1.1.1_0 (active)
asciidoc @8.6.9_1+python27 (active)
xz @5.0.5_0 (active)
yasm @1.2.0_0 (active)
ykpers @1.12.0_0 (active)
youtube-dl @2014.07.25.1_0+python27
yubico-c-client @2.12_0
yubico-pam @2.16_0
zlib @1.2.8_0 (active)
""",
)
def test_match_with_macports(self, check_output_mock):
"""Simple test for the MacPorts CLI client (`port`) package manager"""
check_output_mock.side_effect = self._check_output_side_effect("port")
self.assertEqual(Packages().value, 14)
@patch(
"archey.entries.packages.check_output",
return_value="""\
cdrecord-2.01-10.7.el5
bluez-libs-3.7-1.1
setarch-2.0-1.1
MySQL-client-3.23.57-1
""",
)
def test_match_with_rpm(self, check_output_mock):
"""Simple test for the RPM packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("rpm")
self.assertEqual(Packages().value, 4)
@patch(
"archey.entries.packages.check_output",
return_value="""\
Loaded plugins: fastestmirror, langpacks
Installed Packages
GConf2.x86_64 3.2.6-8.el7 @base/$releasever
GeoIP.x86_64 1.5.0-11.el7 @base \n\
ModemManager.x86_64 1.6.0-2.el7 @base \n\
ModemManager-glib.x86_64 1.6.0-2.el7 @base \n\
""",
)
def test_match_with_yum(self, check_output_mock):
"""Simple test for the Yum packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("yum")
self.assertEqual(Packages().value, 4)
@patch(
"archey.entries.packages.check_output",
return_value="""\
Loading repository data...
Reading installed packages...
S | Name | Summary | Type \n\
---+---------------+-------------------------------------+------------
i+ | 5201 | Recommended update for xdg-utils | patch \n\
i | GeoIP-data | Free GeoLite country-data for GeoIP | package \n\
i | make | GNU make | package \n\
i | GNOME Nibbles | Guide a worm around a maze | application
i | at | A Job Manager | package \n\
""",
)
def test_match_with_zypper(self, check_output_mock):
"""Simple test for the Zypper packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("zypper")
self.assertEqual(Packages().value, 5)
@patch(
"archey.entries.packages.PACKAGES_TOOLS",
new=(
{"cmd": ("pkg_tool_1")},
{"cmd": ("pkg_tool_2"), "skew": 2},
),
)
@patch(
"archey.entries.packages.check_output",
side_effect=[
"""\
sample_package_1_1
sample_package_1_2
""",
"""\
Incredible list of installed packages:
sample_package_2_1
sample_package_2_2
""",
],
)
def test_multiple_package_managers(self, _):
"""Simple test for multiple packages managers"""
self.assertEqual(Packages().value, 4)
@patch("archey.entries.packages.check_output")
@HelperMethods.patch_clean_configuration
def test_no_packages_manager(self, check_output_mock):
"""No packages manager is available at the moment..."""
check_output_mock.side_effect = self._check_output_side_effect()
packages = Packages()
self.assertIsNone(packages.value)
@staticmethod
def _check_output_side_effect(pkg_manager_cmd=None):
"""Internal helper method to facilitate `check_output` mocking"""
def _check_output(args, stderr, env, universal_newlines): # pylint: disable=unused-argument
"""
This closure is a drop-replacement for our `check_output` call.
If the _called_ program is `pkg_manager_cmd`, patched `return_value` will be returned.
If not, `FileNotFoundError` would be raised.
"""
if args[0] == pkg_manager_cmd:
return DEFAULT_SENTINEL
raise FileNotFoundError
return _check_output
if __name__ == "__main__":
unittest.main()