Add plugin for Open Build Service (OBS) #2541

ddstreet · 2025-12-04T05:41:01Z

This adds a 'obs' plugin to allow adding repos provided by the Open Build Service (OBS), i.e. https://build.opensuse.org/

The user interface is very similar to the COPR plugin; the same commands are provided (enable, disable, remove, list, debug). The main difference is the format of the repository "id":

for COPR, the format is [HUB/]OWNER/PROJECT [CHROOT]
for OBS the format is [HUB/]PROJECT/REPONAME

The HUB part is the same for both of them, i.e. the hostname (or shortname) of the webui/api of the service; if not specified the default (build.opensuse.org) is used, just like the COPR plugin.

The COPR repos will always have a OWNER that owns a specific PROJECT, and the OBS repos will also have some kind of OWNER, but the field doesn't have any fixed format; it can be "home:user" or "system:systemd" or other formats. The OBS repos also can have any number of levels of PROJECT, including none at all (e.g. "home:user" can have a repo, "home:user:subproject1" can have a repo also, "home:user:subproject1:subsubproject2" can also, etc.). It makes more sense, to me at least, to simply roll the OWNER and PROJECT(s) together as a single PROJECT (with each level delimited by colons; and this is how OBS presents it to users).

The OBS plugin also differs from COPR by including the actual repo name as the REPONAME in the id. The repo name roughly corresponds to the COPR "chroot" (e.g. "fedora-rawhide-ppc64le"), but the repo isn't arch-specific (technically it is, but OBS repos aren't separated by arch like COPR repos are, so most repos have multiple archs enabled), and the repo name isn't guessable based on the local system. Users can name their repos whatever they want.

One other note; when the plugin is provided a repo spec (i.e. PROJECT/REPONAME), it forms a URL to the OBS repo's "repository state" HTML web page, and downloads it, and then parses it (using libxml2 HTML parsing) to extract the HREF to the repo download URL. I don't think this is ideal, but it's required because of 2 reasons:

While the OBS does have an API, none of its methods are usable anonymously (at least, not in any of my testing using the standard api.opensuse.org). Even if this was changed, the plugin should still work with other "hubs" (i.e. other instances of OBS), which may not allow anonymous API access.
The URL to the repos is unfortunately not predictable, as it's up to the specific configuration of each OBS instance. The main OBS instance uses an entirely different hostname (https://download.opensuse.org) while other instances of OBS most likely just use the same hostname with a dedicated path to the download area.

Finally, this of course doesn't have any translations for the plugin, although I did add a .pot file.

Fixes: #2540

ddstreet · 2025-12-04T05:47:34Z

This works around openSUSE/open-build-service#3153 by doing the HTML parsing (as mentioned in the descripion).

Conan-Kudo

This is a great start (though scraping the web page is gross, it is the only way for now...), this is just a first glance of things to fix.

Conan-Kudo · 2025-12-04T11:41:57Z

dnf5-plugins/obs_plugin/obs_constants.hpp

+#include <libdnf5/utils/bgettext/bgettext-mark-domain.h>
+
+static const char * const OBS_COMMAND_DESCRIPTION =
+    _("Manage Obs repositories (add-ons provided by users/community/third-party)");


Please consistently use OBS or Open Build Service, and not Obs.

updated, i think i got all of them but please let me know if i missed any

Conan-Kudo · 2025-12-04T11:42:46Z

dnf5-plugins/obs_plugin/obs_constants.hpp

+    _("Enabling a Obs repository. Please note that this repository is not part\n"
+      "of the main distribution, and quality may vary.\n"
+      "\n"
+      "The Fedora Project does not exercise any power over the contents of\n"


Since the default is actually the openSUSE Build Service, this needs to be "The openSUSE Project"

Conan-Kudo · 2025-12-04T11:42:59Z

dnf5-plugins/obs_plugin/obs_constants.hpp

+      "this repository, and packages are not held to any quality or security\n"
+      "level.\n"
+      "\n"
+      "Please do not file bug reports about these packages in Fedora\n"


Fedora->openSUSE.

Conan-Kudo · 2025-12-04T11:43:28Z

dnf5-plugins/obs_plugin/obs_constants.hpp

+      "the main Obs repository (they provide runtime dependencies).\n"
+      "\n"
+      "Be aware that the note about quality and bug-reporting\n"
+      "above applies here too, Fedora Project doesn't control the\n"


Fedora Project -> the openSUSE Project

ddstreet · 2025-12-04T18:18:40Z

per above comments, changed all 'Obs' -> 'OBS' in comments and strings, as well as 'Fedora' -> 'openSUSE' in strings

ddstreet · 2025-12-04T18:19:48Z

another update to remove and adjust some code comments

ddstreet · 2025-12-04T18:22:02Z

update to remove OBS_EXTERNAL_DEPS_WARNING which was leftover from copying the code from the copr plugin; it's not needed since OBS repos don't have external deps. Also adjust the plugin description string.

Conan-Kudo · 2025-12-04T18:23:20Z

Technically OBS repos could, but it's hard to identify them and it's better off not worrying about it.

This is similar to the COPR plugin, but for the OBS service. Fixes: rpm-software-management#2540

ddstreet · 2025-12-04T18:30:15Z

updated the pot file

Conan-Kudo · 2025-12-04T18:35:22Z

Wouldn't it make sense to also add a key like download_url_prefix to the config where this can be set instead of scraping the web site for this?

It's largely formulaic after you get to the https://download.opensuse.org/repositories/ part. This also makes it far less messy for third-party OBS instances.

Conan-Kudo · 2025-12-04T18:38:55Z

And we can assume the default for systems that we don't have this defined to be http://<hostname>:82/, since that's the default for the OBS appliance.

ddstreet · 2025-12-04T18:48:47Z

Wouldn't it make sense to also add a key like download_url_prefix to the config where this can be set instead of scraping the web site for this?

It's largely formulaic after you get to the https://download.opensuse.org/repositories/ part. This also makes it far less messy for third-party OBS instances.

good point, i'll add that in. with that (and the hostname:82 default) we can probably skip the html parsing completely, or at least move it to a fallback attempt.

Conan-Kudo · 2025-12-04T18:52:48Z

Yeah, that should be last-resort code.

ppisar · 2025-12-05T10:00:51Z

I'm glad you find DNF5 attractive to write new plugins for it. But this code looks more focused on Open Build Service than on DNF5. I.e. I foresee future changes in this code because of OBS rather than because of DNF5. Also testing this plugin will be probably tightly coupled to real OBS which DNF5 project cannot provide.

In my opinion, this plugin should be maintained in a separate repository. (I have the same opinion about a COPR plugin.) At the end, that's the point of plugins, to be maintained separately. It would be also healthy for the DNF5 project because it will forced DNF5 to maintain API/ABI properly.

ddstreet requested a review from a team as a code owner December 4, 2025 05:41

ddstreet requested review from m-blaha and removed request for a team December 4, 2025 05:41

ddstreet force-pushed the obs branch from 3bd19a4 to 359a3b9 Compare December 4, 2025 05:54

Conan-Kudo requested changes Dec 4, 2025

View reviewed changes

Conan-Kudo mentioned this pull request Dec 4, 2025

RFE: Public (non-authenticated) API call for getting .repo file contents openSUSE/open-build-service#3153

Open

ddstreet force-pushed the obs branch from 359a3b9 to 660f349 Compare December 4, 2025 18:13

ddstreet force-pushed the obs branch from 660f349 to 0413092 Compare December 4, 2025 18:19

ddstreet force-pushed the obs branch from 0413092 to 462cd7d Compare December 4, 2025 18:20

ddstreet added 5 commits December 4, 2025 13:29

Add plugin for Open Build Service (OBS) repos

1f02005

This is similar to the COPR plugin, but for the OBS service. Fixes: rpm-software-management#2540

Add tests for OBS plugin

fd37a38

Add man page for OBS plugin

121e72c

Update spec file with Obs plugin

1a45785

Disable Obs translation packaging, since it is not available yet

4ccce12

ddstreet force-pushed the obs branch from 462cd7d to 4ccce12 Compare December 4, 2025 18:29

Add plugin for Open Build Service (OBS) #2541

Are you sure you want to change the base?

Add plugin for Open Build Service (OBS) #2541

Uh oh!

Conversation

ddstreet commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ddstreet commented Dec 4, 2025

Uh oh!

Conan-Kudo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ddstreet commented Dec 4, 2025

Uh oh!

ddstreet commented Dec 4, 2025

Uh oh!

ddstreet commented Dec 4, 2025

Uh oh!

Conan-Kudo commented Dec 4, 2025

Uh oh!

ddstreet commented Dec 4, 2025

Uh oh!

Conan-Kudo commented Dec 4, 2025

Uh oh!

Conan-Kudo commented Dec 4, 2025

Uh oh!

ddstreet commented Dec 4, 2025

Uh oh!

Conan-Kudo commented Dec 4, 2025

Uh oh!

ppisar commented Dec 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ddstreet commented Dec 4, 2025 •

edited

Loading