Add support for zypper Closes #566.

.github/labels-extra.json

@@ -89,6 +89,11 @@
     "color": "#bfdadc",
     "description": "vscode"
   },
+  {
+    "name": "📦 manager: zypper",
+    "color": "#bfdadc",
+    "description": "zypper"
+  },
   {
     "name": "🔌 bar-plugin",
     "color": "#fef2c0",

.github/workflows/labeller-content-based.yaml

@@ -154,8 +154,13 @@ jobs:
                "keywords": ["vscode"]},
 
               {"labels": [
+                "📦 manager: zypper",
                 "🖥 platform: Linux"],
-               "keywords": ["linux", "ubuntu", "debian"]},
+               "keywords": ["zypper"]},
+
+              {"labels": [
+                "🖥 platform: Linux"],
+               "keywords": ["linux", "ubuntu", "debian", "suse", "opensuse", "arch", "gentoo"]},
 
               {"labels": [
                 "🖥 platform: macOS"],

.github/workflows/labeller-file-based.yaml

@@ -88,4 +88,8 @@ jobs:
 
         "📦 manager: vscode":
           - meta_package_manager/managers/vscode*
-          - meta_package_manager/tests/*vscode*
+          - meta_package_manager/tests/*vscode*
+
+        "📦 manager: zypper":
+          - meta_package_manager/managers/zypper*
+          - meta_package_manager/tests/*zypper*

.github/workflows/tests.yaml

@@ -165,6 +165,13 @@ jobs:
         run: |
           sudo apt install --yes dnf
 
+      # Zypper
+      - name: Linux - Install Zypper
+        # XXX Zypper has been added in Ubuntu 20.04, not before.
+        if: matrix.os == 'ubuntu-20.04'
+        run: |
+          sudo apt install --yes zypper
+
       # Snap
       - name: Linux - Upgrade Snapd
         if: runner.os == 'Linux'

changelog.md

@@ -6,6 +6,7 @@
 This version is not released yet and is under active development.
 ```
 
+- \[zypper\] Add `zypper` support for Suse and OpenSuse. Closes {issue}`566`.
 - \[emerge\] Add `emerge` support.
 - \[steamcmd\] Add `steamcmd` support. Refs {issue}`10`.
 - \[bar-plugin\] Add new `DEFAULT_FONT` and `MONOSPACE_FONT` variable.

docs/meta_package_manager.managers.rst

@@ -140,6 +140,14 @@ meta\_package\_manager.managers.yarn module
    :undoc-members:
    :show-inheritance:
 
+meta\_package\_manager.managers.zypper module
+---------------------------------------------
+
+.. automodule:: meta_package_manager.managers.zypper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

meta_package_manager/managers/zypper.py

@@ -0,0 +1,260 @@
+# Copyright Kevin Deldycke <[email protected]> and contributors.
+# All Rights Reserved.
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+import re
+from itertools import groupby
+from operator import itemgetter
+
+import xmltodict
+from click_extra.platform import LINUX
+
+from ..base import PackageManager
+from ..version import parse_version
+
+
+class Zypper(PackageManager):
+    """
+    Documentation:
+    - https://en.opensuse.org/Portal:Zypper
+    - https://documentation.suse.com/smart/linux/html/concept-zypper/index.html
+    - https://opensuse.github.io/openSUSE-docs-revamped-temp/zypper/
+
+    See other command equivalences at: https://wiki.archlinux.org/title/Pacman/Rosetta
+    """
+
+    platforms = frozenset({LINUX})
+
+    requirement = "1.14.0"
+
+    pre_args = ("--no-color", "--no-abbrev", "--non-interactive", "--no-cd", "--no-refresh")
+
+    version_regex = r"zypper\s+(?P<version>\S+)"
+    """
+    .. code-block:: shell-session
+
+        ► zypper --version
+        zypper 1.14.11
+    """
+
+    def _search(self, *args):
+        """Utility method to parse and interpret results of the ``zypper search`` command.
+
+        This is reused by the ``installed`` and ``search`` operations.
+
+        .. code-block:: shell-session
+
+            ► zypper --no-color --no-abbrev --non-interactive --no-cd --no-refresh --xmlout search --details --type package [*args]
+            <?xml version='1.0'?>
+            <stream>
+                <message type="info">Loading repository data...</message>
+                <message type="info">Reading installed packages...</message>
+
+                <search-result version="0.0">
+                    <solvable-list>
+                        <solvable status="installed" name="aaa_base" kind="package"
+                            edition="12.12-bp12.3.1" arch="x86_64"/>
+
+                        <solvable status="installed" name="adwaita-icon-theme" kind="package"
+                            edition="1.0.3-bp153.1.1" arch="x86_64"/>
+                        <solvable status="other-version" name="adwaita-icon-theme" kind="package"
+                            edition="1.0.1-bp153.1.1" arch="x86_64"/>
+
+                        <solvable status="not-installed" name="kopete-devel" kind="package"
+                            edition="20.04.2-bp153.2.5.1" arch="x86_64" repository="Update"/>
+                        <solvable status="not-installed" name="kopete-devel" kind="package"
+                            edition="20.04.2-bp153.2.2.1" arch="x86_64" repository="Update"/>
+                        <solvable status="not-installed" name="kopete-devel" kind="package"
+                            edition="20.04.2-bp153.2.2.1" arch="x86_64" repository="Debug"/>
+                        <solvable status="not-installed" name="kopete-devel" kind="package"
+                            edition="20.04.2-bp153.2.5.1" arch="i586" repository="Update"/>
+                        <solvable status="not-installed" name="kopete-devel" kind="package"
+                            edition="20.04.2-bp153.2.2.1" arch="i586" repository="Update"/>
+
+                        (...)
+                    </solvable-list>
+                </search-result>
+            </stream>
+        """
+        output = self.run_cli(
+            "--xmlout",
+            "search",
+            # --details is the only option that is providing the package's version...
+            "--details",
+            # ...but comes with duplicate results due to source packages, different arch and old releases.
+            # So we filters them out to only keep proper packages.
+            "--type", "package",
+            # Additional search arguments.
+            *args,
+        )
+
+        package_list = xmltodict.parse(output).get('stream', {}).get('search-result', {}).get('solvable-list', {}).get('solvable', [])
+
+        # Group packages by ID.
+        key_func = itemgetter('@name')
+
+        # Skip old packages reported in the results as 'other-version'.
+        fresh_packages = sorted(
+            (p for p in package_list if p.get('@status') != 'other-version'),
+            key=key_func
+        )
+
+        # Returns the highest version for a package ID among all repositories and arch variations.
+        for key, group in groupby(fresh_packages, key_func):
+            yield {
+                'id': key,
+                'version': max((parse_version(p['@edition']) for p in group))
+            }
+
+    @property
+    def installed(self):
+        """Fetch installed packages.
+
+        .. code-block:: shell-session
+
+            ► zypper --no-color --no-abbrev --non-interactive --no-cd --no-refresh --xmlout search --details --type package --installed-only
+        """
+        installed = {}
+
+        for package in self._search("--installed-only"):
+            package_id = package['id']
+            installed[package_id] = {
+                "id": package_id,
+                "name": package_id,
+                "installed_version": package['version'],
+            }
+
+        return installed
+
+    @property
+    def outdated(self):
+        """Fetch outdated packages.
+
+        .. code-block:: shell-session
+
+            ► zypper --no-color --no-abbrev --non-interactive --no-cd --no-refresh --xmlout list-updates
+            <?xml version='1.0'?>
+            <stream>
+                <message type="info">Loading repository data...</message>
+                <message type="info">Reading installed packages...</message>
+                <update-status version="0.6">
+                    <update-list>
+                        <update name="git" kind="package"
+                            edition="2.34.1-10.9.1" edition-old="2.26.2-3.34.1" arch="x86_64">
+                            <summary>Fast, scalable revision control system</summary>
+                            <description>
+                                Blah blah blah...
+                            </description>
+                            <license/>
+                            <source url="http://download.opensuse.org/updata/leap/15.3/sle" alias="repo-sle-update"/>
+                        </update>
+                        (...)
+                    </update-list>
+                </update-status>
+            </stream>
+        """
+        outdated = {}
+
+        output = self.run_cli("--xmlout", "list-updates")
+
+        package_list = xmltodict.parse(output).get('stream', {}).get('update-status', {}).get('update-list', {}).get('update', [])
+
+        for package in package_list:
+            package_id = package['@name']
+            outdated[package_id] = {
+                "id": package_id,
+                "name": package_id,
+                "latest_version": parse_version(package['@edition']),
+                "installed_version": parse_version(package['@edition-old']),
+            }
+        return outdated
+
+    def search(self, query, extended, exact):
+        """Fetch matching packages.
+
+        .. code-block:: shell-session
+
+            ► zypper --no-color --no-abbrev --non-interactive --no-cd --no-refresh --xmlout search --details --type package kopete
+
+        .. code-block:: shell-session
+
+            ► zypper --no-color --no-abbrev --non-interactive --no-cd --no-refresh --xmlout search --details --type package --search-description kopete
+
+        .. code-block:: shell-session
+
+            ► zypper --no-color --no-abbrev --non-interactive --no-cd --no-refresh --xmlout search --details --type package --match-exact kopete
+
+        .. code-block:: shell-session
+
+            ► zypper --no-color --no-abbrev --non-interactive --no-cd --no-refresh --xmlout search --details --type package --search-description --match-exact kopete
+        """
+        matches = {}
+
+        search_param = []
+        if extended:
+            search_param.append("--search-description")
+        if exact:
+            search_param.append("--match-exact")
+
+        for package in self._search(*search_param, query):
+            package_id = package['id']
+            matches[package_id] = {
+                "id": package_id,
+                "name": package_id,
+                "installed_version": package['version'],
+            }
+
+        return matches
+
+    def install(self, package_id):
+        """Install one package.
+
+        .. code-block:: shell-session
+
+            ► sudo zypper --no-color --no-abbrev --non-interactive --no-cd --no-refresh install kopete
+        """
+        return self.run_cli("install", package_id, sudo=True)
+
+    def upgrade_cli(self, package_id=None):
+        """Generates the CLI to upgrade all packages (default) or only the one provided as parameter.
+
+        .. code-block:: shell-session
+
+            ► sudo zypper --no-color --no-abbrev --non-interactive --no-cd --no-refresh update
+
+        .. code-block:: shell-session
+
+            ► sudo zypper --no-color --no-abbrev --non-interactive --no-cd --no-refresh update kopete
+        """
+        return self.build_cli("update", package_id, sudo=True)
+
+    def sync(self):
+        """Sync package metadata.
+
+        .. code-block:: shell-session
+
+            ► sudo zypper --no-color --no-abbrev --non-interactive --no-cd --no-refresh refresh
+        """
+        self.run_cli("refresh", sudo=True)
+
+    def cleanup(self):
+        """Removes things we don't need anymore.
+
+        .. code-block:: shell-session
+
+            ► sudo zypper --no-color --no-abbrev --non-interactive --no-cd --no-refresh clean
+        """
+        self.run_cli("clean", sudo=True)

meta_package_manager/tests/test_cli_install.py

@@ -62,6 +62,7 @@ def test_no_package_id(self, invoke):
         "steamcmd": "",
         "vscode": "tamasfe.even-better-toml",
         "yarn": "markdown",
+        "zypper": "git",
     }
     assert set(PACKAGE_IDS) == set(pool.all_manager_ids)
 

meta_package_manager/tests/test_pool.py

@@ -25,7 +25,7 @@
 
 def test_manager_count():
     """Check all implemented package managers are accounted for, and unique."""
-    assert len(pool) == 20
+    assert len(pool) == 21
     assert len(pool) == len(pool.all_manager_ids)
     assert pool.all_manager_ids == tuple(sorted(set(pool)))