Merge ~athos-ribeiro/ubuntu-archive-tools:checkrdepends-remote into ubuntu-archive-tools:main

[Athos Ribeiro]

- Allow using checkrdepends through an archive URL instead of a local base directory.
- Allow checking Debian reverse dependencies
- Move to argparse (optparse is deprecated)
- document examples in --help

Note that while performing changes, I tried to keep the function signatures to avoid disrupting any automation using the script.

I wonder if it would make sense to use the archive URL as the default for `-B` and set the default value of `ports` to false.

[Athos Ribeiro (athos-ribeiro)]

BTW, the reason I use checkrdepends instead of reverse-depends some times is that it supports verifying virtual packages, e.g.,

checkrdepends --no-ports -B 'http://archive.ubuntu.com/ubuntu' --binary phpapi-20230831

and I am not aware if this is currently supported in reverse-depends.

Unmerged commits

aa9f557... by Athos Ribeiro on 2024-03-19

checkrdepends: document new behavior for -B option

13e526b... by Athos Ribeiro on 2024-03-19

checkrdepends: document examples

d260a46... by Athos Ribeiro on 2024-03-19

checkrdepends: move to argparse

optparse was deprecated in python 3.2 in favor of argparse. Let's use it
instead.

09c9197... by Athos Ribeiro on 2024-03-19

checkrdepends: allow checking Debian rdeps

8168517... by Athos Ribeiro on 2024-03-19

utils: allow read_tag_file to parse remote files

This enables passing URLS to checkrdepends to use it from remote
repositories instead of keeping local copies.

diff --git a/checkrdepends b/checkrdepends
index a49bd7b..ada537e 100755
--- a/checkrdepends
+++ b/checkrdepends
@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from collections import defaultdict
-import optparse
+import argparse
 import os
 import re
 import sys
@@ -23,9 +23,15 @@ import sys
 from utils import read_tag_file
 
 
+EXAMPLE_USAGE='''Examples:
+    %(prog)s --no-ports -B 'http://archive.ubuntu.com/ubuntu' postgresql-common
+    %(prog)s -B 'http://ports.ubuntu.com/ubuntu-ports' -a arm64 -a armhf -a ppc64el -a riscv64 -a s390x postgresql-common
+    %(prog)s --no-ports -B 'http://deb.debian.org/debian' --vendor debian -s sid symfony
+'''
+
 default_base = '/home/ubuntu-archive/mirror/ubuntu'
 default_suite = 'noble'
-components = ('main', 'restricted', 'universe', 'multiverse')
+default_vendor = 'ubuntu'
 
 # Cut-down RE from deb822.PkgRelation.
 re_dep = re.compile(r'^\s*([a-zA-Z0-9.+\-]{2,})')
@@ -45,7 +51,10 @@ def parse_relation_packages(raw):
             yield dep, dep_list
 
 
-def primary_arches(suite):
+def primary_arches(opts):
+    if opts.vendor == 'debian':
+        return ('all', 'amd64', 'i386')
+
     return ('amd64', 'i386')
 
 
@@ -129,10 +138,13 @@ def read_di(debs, path):
 
 
 def pockets(opts):
-    if '-' in opts.suite:
+    if '-' in opts.suite or opts.suite in ('sid', 'unstable'):
         return ('',)
-    else:
+    elif opts.vendor == 'ubuntu':
         return ('', '-updates', '-security', '-backports')
+    elif opts.vendor == 'debian':
+        # TODO: support debian security (different archive)
+        return ('', '-updates', '-backports')
 
 
 def render_dep(name, field, arch, why):
@@ -147,12 +159,19 @@ def render_dep(name, field, arch, why):
 
 
 def search(opts, pkgs):
+    if opts.vendor == 'ubuntu':
+        components = ('main', 'restricted', 'universe', 'multiverse')
+    elif opts.vendor == 'debian':
+        components = ('main', 'contrib', 'non-free', 'non-free-firmware')
+    else:
+        raise ValueError(f"unsupported vendor {opts.vendor}")
+
     for pocket in pockets(opts):
         pocket_base = '%s/dists/%s%s' % (opts.archive_base, opts.suite, pocket)
         if opts.arches:
             arches = opts.arches
         else:
-            arches = list(primary_arches(opts.suite))
+            arches = list(primary_arches(opts))
             if opts.ports:
                 arches.extend(ports_arches(opts.suite))
 
@@ -241,32 +260,38 @@ def search(opts, pkgs):
 
 
 def main():
-    parser = optparse.OptionParser(usage='%prog [options] pkg [...]')
-    parser.add_option('-B', '--archive-base', dest='archive_base',
-                      help=('archive base directory (default: %s)' %
+    parser = argparse.ArgumentParser(usage='%(prog)s [options] pkg [...]',
+                                     epilog=EXAMPLE_USAGE,
+                                     formatter_class=argparse.RawDescriptionHelpFormatter)
+    parser.add_argument('packages', nargs='+')
+    parser.add_argument('-B', '--archive-base', dest='archive_base',
+                      help=('archive base directory or URL (default: %s)' %
                             default_base),
                       default=default_base)
-    parser.add_option('-s', '--suite', dest='suite',
+    parser.add_argument('-s', '--suite', dest='suite',
                       help='suite to check (default: %s)' % default_suite,
                       default=default_suite)
-    parser.add_option('-a', '--arch', dest='arches', action='append',
+    parser.add_argument('-a', '--arch', dest='arches', action='append',
                       help='check only this architecture '
                            '(may be given multiple times)')
-    parser.add_option('-b', '--binary', dest='binary', action='store_true',
+    parser.add_argument('-b', '--binary', dest='binary', action='store_true',
                       help='treat arguments as binary packages, not source')
-    parser.add_option('--no-ports', dest='ports',
+    parser.add_argument('--no-ports', dest='ports',
                       default=True, action='store_false',
                       help='skip ports architectures')
-    parser.add_option('-d', '--directory', dest='directory', metavar='DIR',
+    parser.add_argument('-d', '--directory', dest='directory', metavar='DIR',
                       help='output to directory DIR (one file per package) '
                            'instead of standard output')
-    opts, args = parser.parse_args()
+    parser.add_argument('-V', '--vendor', dest='vendor',
+                      help='distro to check (default: %s; supported: ubuntu,debian)' % default_vendor,
+                      default=default_vendor)
+    args = parser.parse_args()
 
     if 'CHECKRDEPENDS_PROFILE' in os.environ:
         import profile
-        profile.run('search(opts, args)')
+        profile.run('search(args, args.packages)')
     else:
-        search(opts, args)
+        search(args, args.packages)
 
 
 if __name__ == '__main__':
diff --git a/utils.py b/utils.py
index b529317..ea7a5c2 100644
--- a/utils.py
+++ b/utils.py
@@ -22,6 +22,7 @@ import gzip
 import os
 import re
 import tempfile
+import urllib.error
 import urllib.request
 
 import apt_pkg
@@ -40,6 +41,12 @@ except ImportError:
 
 def read_tag_file(path, pkg=None):
     tmp = tempfile.NamedTemporaryFile(prefix='checkrdepends.', delete=False)
+    if path.startswith(('http://', 'https://')):
+        try:
+            path = urllib.request.urlopen(path)
+        except urllib.error.HTTPError as e:
+            print(f'Error while fetching "{path}": {e}')
+            raise
     try:
         compressed = gzip.open(path)
         try: