HorlogeSkynet/archey4
HorlogeSkynet/archey4
1
0
Fork 0
mirror of https://github.com/HorlogeSkynet/archey4 synced 2025-06-08 04:00:14 +02:00
Code Issues Packages Releases Wiki Activity

[PACKAGES] Shows counts divided by package managers

Browse Source
This commit is contained in:
Enrico Bravi 2024-05-17 23:28:20 +02:00 committed by GitHub
parent 55b97affd1
commit 5114c7caa2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 145 additions and 41 deletions

10
README.md

@ -310,7 +310,15 @@ Below stand further descriptions for each available (default) option :
// Set it to `false` to allow compatibility with non-Unicode locales.
"use_unicode": true
},
{ "type": "Packages" },
{
"type": "Packages",
// Set to `true` to sum up all installed package counts.
"combine_total": false,
// Set to `false` not to join all packages tool counts on the same line.
"one_line": true,
// Set to `true` to include tools with no installed package.
"show_zeros": false
},
{
"type": "Temperature",
// The character to display between the temperature value and the unit (as '°' in 53.2°C).

3
apparmor.profile

@ -73,15 +73,18 @@ profile archey4 /usr/{,local/}bin/archey{,4} {
# [Packages] entry
/{,usr/}bin/ls rix,
/{,usr/}bin/apk PUx,
#/{,usr/}bin/apt PUx,
/{,usr/}bin/dnf PUx,
/{,usr/}bin/dpkg PUx,
/{,usr/}bin/emerge PUx,
/usr/{,local/}bin/flatpak PUx,
/{,usr/}bin/nix-env PUx,
/{,usr/}bin/pacman PUx,
/{,usr/}bin/pacstall PUx,
/{,usr/}bin/pkgin PUx,
/{,usr/}bin/port PUx,
/{,usr/}bin/rpm PUx,
/usr/{,local/}bin/snap PUx,
/{,usr/}bin/yum PUx,
/{,usr/}bin/zypper PUx,

47
archey/entries/packages.py

@ -26,7 +26,8 @@ PACKAGES_TOOLS = (
{"cmd": ("dnf", "list", "installed"), "skew": 1},
{"cmd": ("dpkg", "--get-selections")},
{"cmd": ("emerge", "-ep", "world"), "skew": 5},
{"cmd": ("ls", "-1", get_homebrew_cellar_path())}, # Homebrew.
{"cmd": ("flatpak", "list"), "skew": 1},
{"cmd": ("ls", "-1", get_homebrew_cellar_path()), "name": "homebrew"},
{"cmd": ("nix-env", "-q")},
{"cmd": ("pacman", "-Q")},
{"cmd": ("pacstall", "-L")},
@ -39,7 +40,8 @@ PACKAGES_TOOLS = (
{"cmd": ("pkgin", "list")},
{"cmd": ("port", "installed"), "skew": 1},
{"cmd": ("rpm", "-qa")},
{"cmd": ("ls", "-1", "/var/log/packages/")}, # SlackWare.
{"cmd": ("ls", "-1", "/var/log/packages/"), "name": "slackware"},
{"cmd": ("snap", "list", "--all"), "skew": 1},
{"cmd": ("yum", "list", "installed"), "skew": 2},
{"cmd": ("zypper", "search", "-i"), "skew": 5},
)
@ -53,6 +55,8 @@ class Packages(Entry):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.value = {}
for packages_tool in PACKAGES_TOOLS:
packages_tool = typing.cast(dict, packages_tool)
if (
@ -77,17 +81,40 @@ class Packages(Entry):
continue
# Here we *may* use `\n` as `universal_newlines` has been set.
if self.value:
self.value += results.count("\n")
else:
self.value = results.count("\n")
count = results.count("\n")
# If any, deduct output skew present due to the packages tool itself.
if "skew" in packages_tool:
self.value -= packages_tool["skew"]
count -= packages_tool["skew"]
pkg_tool_name = packages_tool.get("name", packages_tool["cmd"][0])
# For DPKG only, remove any not purged package.
if packages_tool["cmd"][0] == "dpkg":
self.value -= results.count("deinstall")
if pkg_tool_name == "dpkg":
count -= results.count("deinstall")
# Let's just loop over, in case there are multiple package managers.
self.value[pkg_tool_name] = count
def output(self, output) -> None:
"""Adds the entry to `output` after pretty-formatting packages tool counts"""
if not self.value:
# Fall back on the default behavior if no temperatures were detected.
super().output(output)
return
if self.options.get("combine_total"):
output.append(self.name, str(sum(self.value.values())))
return
entries = []
for pkg_tool_name, count in self.value.items():
if count > 0 or self.options.get("show_zeros"):
entries.append(f"({pkg_tool_name}) {count}")
if self.options.get("one_line", True):
# One-line output is enabled : Join the results !
output.append(self.name, ", ".join(entries))
else:
# One-line output has been disabled, add one entry per item.
for entry in entries:
output.append(self.name, entry)

119
archey/test/entries/test_archey_packages.py

@ -2,7 +2,7 @@
import unittest
from unittest.mock import DEFAULT as DEFAULT_SENTINEL
from unittest.mock import MagicMock, patch
from unittest.mock import MagicMock, call, patch
from archey.configuration import DEFAULT_CONFIG
from archey.distributions import Distributions
@ -41,7 +41,7 @@ readline-8.0.1-r0 x86_64 {{readline}} (GPL-2.0-or-later) [installed]
"""Simple test for the APK packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("apk")
self.assertEqual(Packages().value, 8)
self.assertDictEqual(Packages().value, {"apk": 8})
@patch(
"archey.entries.packages.check_output",
@ -57,7 +57,7 @@ GraphicsMagick.x86_64 1.3.26-3.fc26 @@commandline
"""Simple test for the DNF packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("dnf")
self.assertEqual(Packages().value, 4)
self.assertDictEqual(Packages().value, {"dnf": 4})
@patch(
"archey.entries.packages.check_output",
@ -75,7 +75,7 @@ alien install
"""Simple test for the DPKG packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("dpkg")
self.assertEqual(Packages().value, 6)
self.assertDictEqual(Packages().value, {"dpkg": 6})
@patch(
"archey.entries.packages.check_output",
@ -97,7 +97,23 @@ USE="pam -static-libs" ABI_X86="(64) -32 (-x32)" \n\
"""Simple test for the Emerge packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("emerge")
self.assertEqual(Packages().value, 5)
self.assertDictEqual(Packages().value, {"emerge": 5})
@patch(
"archey.entries.packages.check_output",
return_value="""\
Name Application ID Version Branch Origin Installation
Discord com.discordapp.Discord 0.0.35 stable flathub system
Xournal++ com.github.xournalpp.xournalpp 1.2.2 stable flathub system
draw.io com.jgraph.drawio.desktop 22.0.2 stable flathub system
Extension Manager com.mattjakeman.ExtensionManager 0.4.2 stable flathub system
""",
)
def test_match_with_flatpak(self, check_output_mock):
"""Simple test for the Flatpak packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("flatpak")
self.assertDictEqual(Packages().value, {"flatpak": 4})
@patch(
"archey.entries.packages.check_output",
@ -112,7 +128,7 @@ python3.8-pip-20.1
"""Simple test for the Emerge packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("nix-env")
self.assertEqual(Packages().value, 4)
self.assertDictEqual(Packages().value, {"nix-env": 4})
@patch(
"archey.entries.packages.check_output",
@ -127,7 +143,7 @@ argon2 20171227-3
"""Simple test for the Pacman packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("pacman")
self.assertEqual(Packages().value, 4)
self.assertDictEqual(Packages().value, {"pacman": 4})
@patch(
"archey.entries.packages.check_output",
@ -147,7 +163,7 @@ xz-5.2.4 LZMA compression and decompression tools
"""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)
self.assertDictEqual(Packages().value, {"pkg_info": 9})
@patch("archey.entries.packages.Distributions.get_local", return_value=Distributions.FREEBSD)
@patch(
@ -167,7 +183,7 @@ readline-8.0.4 Library for editing command lines as they are typ
"""Simple test for the FreeBSD `pkg` package manager"""
check_output_mock.side_effect = self._check_output_side_effect("pkg")
self.assertEqual(Packages().value, 8)
self.assertDictEqual(Packages().value, {"pkg": 8})
@patch(
"archey.entries.packages.check_output",
@ -191,7 +207,7 @@ pkgin-20.12.1nb1 Apt / yum like tool for managing pkgsrc binary packages
"""Simple test for the (NetBSD) `pkgin` package manager"""
check_output_mock.side_effect = self._check_output_side_effect("pkgin")
self.assertEqual(Packages().value, 13)
self.assertDictEqual(Packages().value, {"pkgin": 13})
@patch(
"archey.entries.packages.check_output",
@ -217,7 +233,7 @@ The following ports are currently installed:
"""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)
self.assertDictEqual(Packages().value, {"port": 14})
@patch(
"archey.entries.packages.check_output",
@ -232,7 +248,7 @@ MySQL-client-3.23.57-1
"""Simple test for the RPM packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("rpm")
self.assertEqual(Packages().value, 4)
self.assertDictEqual(Packages().value, {"rpm": 4})
@patch(
"archey.entries.packages.check_output",
@ -249,7 +265,7 @@ ModemManager-glib.x86_64 1.6.0-2.el7 @base \n\
"""Simple test for the Yum packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("yum")
self.assertEqual(Packages().value, 4)
self.assertDictEqual(Packages().value, {"yum": 4})
@patch(
"archey.entries.packages.check_output",
@ -270,13 +286,13 @@ i | at | A Job Manager | package \n\
"""Simple test for the Zypper packages manager"""
check_output_mock.side_effect = self._check_output_side_effect("zypper")
self.assertEqual(Packages().value, 5)
self.assertDictEqual(Packages().value, {"zypper": 5})
@patch(
"archey.entries.packages.PACKAGES_TOOLS",
new=(
{"cmd": ("pkg_tool_1")},
{"cmd": ("pkg_tool_2"), "skew": 2},
{"cmd": ("pkg_tool_1",), "name": "acae_loot_42"},
{"cmd": ("pkg_tool_2",), "skew": 2},
),
)
@patch(
@ -296,23 +312,68 @@ sample_package_2_2
)
def test_multiple_package_managers(self, _):
"""Simple test for multiple packages managers"""
self.assertEqual(Packages().value, 4)
self.assertDictEqual(Packages().value, {"acae_loot_42": 2, "pkg_tool_2": 2})
@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()
def test_various_output_configuration(self):
"""Test `output` overloading based on user preferences combination"""
packages_instance_mock = HelperMethods.entry_mock(Packages)
output_mock = MagicMock()
packages.output(output_mock)
self.assertIsNone(packages.value)
self.assertEqual(
output_mock.append.call_args[0][1], DEFAULT_CONFIG["default_strings"]["not_detected"]
)
packages_instance_mock.value = {"pkg_tool_0": 0, "pkg_tool_18": 18, "pkg_tool_42": 42}
with self.subTest("Single-line fully-combined output."):
packages_instance_mock.options["combine_total"] = True
Packages.output(packages_instance_mock, output_mock)
output_mock.append.assert_called_once_with("Packages", "60")
output_mock.reset_mock()
with self.subTest("Single-line combined output (without zero counts)."):
packages_instance_mock.options["combine_total"] = False
packages_instance_mock.options["one_line"] = True
packages_instance_mock.options["show_zeros"] = False
Packages.output(packages_instance_mock, output_mock)
output_mock.append.assert_called_once_with(
"Packages", "(pkg_tool_18) 18, (pkg_tool_42) 42"
)
output_mock.reset_mock()
with self.subTest("Single-line combined output (with zero counts)."):
packages_instance_mock.options["show_zeros"] = True
Packages.output(packages_instance_mock, output_mock)
output_mock.append.assert_called_once_with(
"Packages", "(pkg_tool_0) 0, (pkg_tool_18) 18, (pkg_tool_42) 42"
)
output_mock.reset_mock()
with self.subTest("Multi-lines output (with zero counts)."):
packages_instance_mock.options["one_line"] = False
Packages.output(packages_instance_mock, output_mock)
self.assertEqual(output_mock.append.call_count, 3)
output_mock.append.assert_has_calls(
[
call("Packages", "(pkg_tool_0) 0"),
call("Packages", "(pkg_tool_18) 18"),
call("Packages", "(pkg_tool_42) 42"),
]
)
output_mock.reset_mock()
with self.subTest("No available packages tool."):
packages_instance_mock.value = {}
Packages.output(packages_instance_mock, output_mock)
output_mock.append.assert_called_once_with(
"Packages", DEFAULT_CONFIG["default_strings"]["not_detected"]
)
@staticmethod
def _check_output_side_effect(pkg_manager_cmd=None):

7
config.json

@ -30,7 +30,12 @@
"type": "Terminal",
"use_unicode": true
},
{ "type": "Packages" },
{
"type": "Packages",
"combine_total": false,
"one_line": true,
"show_zeros": false
},
{
"type": "Temperature",
"char_before_unit": " ",