Gracefully handle packages breaking because of soname bumps (#1116)

Fixes #893. Changes:
* New action: "pmbootstrap pkgrel_bump"
* pmbootstrap detects missing soname depends when trying to install
  anyting, and suggests "pkgrel_bump --auto" to fix it
* Testcase test_soname_bump.py checks the pmOS binary package repo
  for soname breakage, so we see it when CI runs for new PRs
* libsamsung-ipc: bump pkgrel because of soname bump

test/test_pkgrel_bump.py

@@ -0,0 +1,172 @@
+"""
+Copyright 2018 Oliver Smith
+
+This file is part of pmbootstrap.
+
+pmbootstrap 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 3 of the License, or
+(at your option) any later version.
+
+pmbootstrap 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 pmbootstrap.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+"""
+This file tests pmb.helper.pkgrel_bump
+"""
+
+import glob
+import os
+import pytest
+import sys
+
+# Import from parent directory
+pmb_src = os.path.realpath(os.path.join(os.path.dirname(__file__) + "/.."))
+sys.path.append(pmb_src)
+import pmb.helpers.pkgrel_bump
+import pmb.helpers.logging
+
+
+@pytest.fixture
+def args(request):
+    import pmb.parse
+    sys.argv = ["pmbootstrap.py", "chroot"]
+    args = pmb.parse.arguments()
+    args.log = args.work + "/log_testsuite.txt"
+    pmb.helpers.logging.init(args)
+    request.addfinalizer(args.logfd.close)
+    return args
+
+
+def pmbootstrap(args, tmpdir, parameters, zero_exit=True):
+    """
+    Helper function for running pmbootstrap inside the fake work folder (created
+    by setup() below) with the binary repo disabled and with the testdata
+    configured as aports.
+
+    :param parameters: what to pass to pmbootstrap, e.g. ["build", "testlib"]
+    :param zero_exit: expect pmbootstrap to exit with 0 (no error)
+    """
+    # Run pmbootstrap
+    aports = tmpdir + "/_aports"
+    config = tmpdir + "/_pmbootstrap.cfg"
+
+    try:
+        pmb.helpers.run.user(args, ["./pmbootstrap.py", "--work=" + tmpdir,
+                                    "--mirror-pmOS=", "--aports=" + aports,
+                                    "--config=" + config] + parameters,
+                             working_dir=pmb_src)
+
+    # Verify that it exits as desired
+    except Exception as exc:
+        if zero_exit:
+            raise RuntimeError("pmbootstrap failed") from exc
+        else:
+            return
+    if not zero_exit:
+        raise RuntimeError("Expected pmbootstrap to fail, but it did not!")
+
+
+def setup_work(args, tmpdir):
+    """
+    Create fake work folder in tmpdir with everything symlinked except for the
+    built packages. The aports testdata gets copied to the tempfolder as
+    well, so it can be modified during testing.
+    """
+    # Clean the chroots, and initialize the build chroot in the native chroot.
+    # We do this before creating the fake work folder, because then all packages
+    # are still present.
+    os.chdir(pmb_src)
+    pmb.helpers.run.user(args, ["./pmbootstrap.py", "-y", "zap"])
+    pmb.helpers.run.user(args, ["./pmbootstrap.py", "build_init"])
+    pmb.helpers.run.user(args, ["./pmbootstrap.py", "shutdown"])
+
+    # Link everything from work (except for "packages") to the tmpdir
+    for path in glob.glob(args.work + "/*"):
+        if os.path.basename(path) != "packages":
+            pmb.helpers.run.user(args, ["ln", "-s", path, tmpdir + "/"])
+
+    # Copy testdata and selected device aport
+    for folder in ["device", "main"]:
+        pmb.helpers.run.user(args, ["mkdir", "-p", args.aports, tmpdir +
+                                    "/_aports/" + folder])
+    pmb.helpers.run.user(args, ["cp", "-r", args.aports + "/device/device-" +
+                                args.device, tmpdir + "/_aports/device"])
+    for pkgname in ["testlib", "testapp"]:
+        pmb.helpers.run.user(args, ["cp", "-r",
+                                    "test/testdata/pkgrel_bump/aports/" + pkgname,
+                                    tmpdir + "/_aports/main/" + pkgname])
+
+    # Empty packages folder
+    pmb.helpers.run.user(args, ["mkdir", "-p", tmpdir + "/packages"])
+    pmb.helpers.run.user(args, ["chmod", "777", tmpdir + "/packages"])
+
+    # Copy over the pmbootstrap config, disable timestamp based rebuilds
+    pmb.helpers.run.user(args, ["cp", args.config, tmpdir +
+                                "/_pmbootstrap.cfg"])
+    pmbootstrap(args, tmpdir, ["config", "timestamp_based_rebuild", "false"])
+
+
+def verify_pkgrels(args, tmpdir, pkgrel_testlib, pkgrel_testapp):
+    """
+    Verify the pkgrels of the two test APKBUILDs "testlib" and "testapp".
+    """
+    args.cache["apkbuild"] = {}
+    mapping = {"testlib": pkgrel_testlib, "testapp": pkgrel_testapp}
+    for pkgname, pkgrel in mapping.items():
+        # APKBUILD path
+        path = tmpdir + "/_aports/main/" + pkgname + "/APKBUILD"
+
+        # Parse and verify
+        apkbuild = pmb.parse.apkbuild(args, path)
+        assert pkgrel == int(apkbuild["pkgrel"])
+
+
+def test_pkgrel_bump_high_level(args, tmpdir):
+    # Tempdir setup
+    tmpdir = str(tmpdir)
+    setup_work(args, tmpdir)
+
+    # Let pkgrel_bump exit normally
+    pmbootstrap(args, tmpdir, ["build", "testlib"])
+    pmbootstrap(args, tmpdir, ["build", "testapp"])
+    pmbootstrap(args, tmpdir, ["pkgrel_bump", "--dry", "--auto"])
+    verify_pkgrels(args, tmpdir, 0, 0)
+
+    # Increase soname (testlib soname changes with the pkgrel)
+    pmbootstrap(args, tmpdir, ["pkgrel_bump", "testlib"])
+    verify_pkgrels(args, tmpdir, 1, 0)
+    pmbootstrap(args, tmpdir, ["build", "testlib"])
+    pmbootstrap(args, tmpdir, ["pkgrel_bump", "--dry", "--auto"])
+    verify_pkgrels(args, tmpdir, 1, 0)
+
+    # Delete package with previous soname (--auto-dry exits with >0 now)
+    pmb.helpers.run.root(args, ["rm", tmpdir + "/packages/" +
+                                args.arch_native + "/testlib-1.0-r0.apk"])
+    pmbootstrap(args, tmpdir, ["index"])
+    pmbootstrap(args, tmpdir, ["pkgrel_bump", "--dry", "--auto"], False)
+    verify_pkgrels(args, tmpdir, 1, 0)
+
+    # Bump the pkgrel of testapp and build it
+    pmbootstrap(args, tmpdir, ["pkgrel_bump", "--auto"])
+    verify_pkgrels(args, tmpdir, 1, 1)
+    pmbootstrap(args, tmpdir, ["build", "testapp"])
+
+    # After rebuilding, pkgrel_bump --auto-dry exits with 0
+    pmbootstrap(args, tmpdir, ["pkgrel_bump", "--dry", "--auto"])
+    verify_pkgrels(args, tmpdir, 1, 1)
+
+    # Test running with specific package names
+    pmbootstrap(args, tmpdir, ["pkgrel_bump", "invalid_package_name"], False)
+    pmbootstrap(args, tmpdir, ["pkgrel_bump", "--dry", "testlib"], False)
+    verify_pkgrels(args, tmpdir, 1, 1)
+
+    # Clean up
+    pmbootstrap(args, tmpdir, ["shutdown"])
+    pmb.helpers.run.root(args, ["rm", "-rf", tmpdir])

test/test_soname_bump.py

@@ -0,0 +1,58 @@
+"""
+Copyright 2018 Oliver Smith
+
+This file is part of pmbootstrap.
+
+pmbootstrap 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 3 of the License, or
+(at your option) any later version.
+
+pmbootstrap 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 pmbootstrap.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+"""
+This file uses pmb.helper.pkgrel_bump to check if the aports need a pkgrel bump
+for any package, caused by a soname bump. Example: A new libressl/openssl
+version was released, which increased the soname version, and now all packages
+that link against it, need to be rebuilt.
+"""
+
+import os
+import pytest
+import sys
+
+# Import from parent directory
+pmb_src = os.path.realpath(os.path.join(os.path.dirname(__file__) + "/.."))
+sys.path.append(pmb_src)
+import pmb.helpers.pkgrel_bump
+import pmb.helpers.logging
+
+
+@pytest.fixture
+def args(request):
+    import pmb.parse
+    sys.argv = ["pmbootstrap.py", "chroot"]
+    args = pmb.parse.arguments()
+    args.log = args.work + "/log_testsuite.txt"
+    pmb.helpers.logging.init(args)
+    request.addfinalizer(args.logfd.close)
+    return args
+
+
+def test_soname_bump(args):
+    if pmb.helpers.pkgrel_bump.auto(args, True):
+        raise RuntimeError("One or more packages need to be rebuilt, because"
+                           " a library they link against had an incompatible"
+                           " upgrade (soname bump). Run 'pmbootstrap"
+                           " pkgrel_bump --auto' to automatically increase the"
+                           " pkgrel in order to trigger a rebuild. If this"
+                           " test case failed during a pull request, the issue"
+                           " needs to be fixed on the 'master' branch first,"
+                           " then rebase your PR on 'master' afterwards.")

test/testdata/pkgrel_bump/aports/testapp/APKBUILD

@@ -0,0 +1,29 @@
+pkgname=testapp
+pkgver=1.0
+pkgrel=0
+pkgdesc="program using the testlib (for testing soname bumps)"
+url="https://postmarketos.org"
+arch="all"
+license="MIT"
+depends="testlib"
+makedepends=""
+subpackages=""
+source="testapp.c"
+options=""
+
+build() {
+	cd "$srcdir"
+	$CC testapp.c -o testapp -L/usr/lib/ -ltestlib
+}
+
+check() {
+	cd "$srcdir"
+	printf 'hello, world from testlib!\n' > expected
+	./testapp > real
+	diff -q expected real
+}
+
+package() {
+	install -Dm755 "$srcdir/testapp" "$pkgdir/usr/bin/testapp"
+}
+sha512sums="73b167575dc0082a1277b0430f095509885c7aaf55e59bad148825a9879f91fe41c6479bb7f34c0cdd15284b0aadd904a5ba2c1ea85fb8bfb061e1cbf4322d76  testapp.c"

test/testdata/pkgrel_bump/aports/testapp/testapp.c

@@ -0,0 +1,7 @@
+#include <stdio.h>
+#include <testlib.h>
+
+int main(int argc, char **argv) {
+    testlib_hello();
+    return 0;
+}

test/testdata/pkgrel_bump/aports/testlib/APKBUILD

@@ -0,0 +1,38 @@
+pkgname=testlib
+pkgver=1.0
+pkgrel=0
+pkgdesc="testing soname bumps (soname changes with pkgrel!)"
+url="https://postmarketos.org"
+arch="all"
+license="MIT"
+depends=""
+makedepends=""
+subpackages=""
+source="testlib.c testlib.h"
+options="!check"
+
+build() {
+	cd "$srcdir"
+	local major="$pkgrel"
+	local minor="0"
+	local soname="libtestlib.so.$major"
+	local realname="libtestlib.so.$minor.$major"
+
+	$CC -fPIC -c -g -Wall testlib.c -o libtestlib.o
+	$CC -shared -Wl,-soname,$soname -o $realname libtestlib.o
+	ln -sf $realname $soname
+	ln -sf $soname "libtestlib.so"
+}
+
+package() {
+	cd "$srcdir"
+	install -Dm755 testlib.h "$pkgdir/usr/include/testlib.h"
+
+	mkdir -p "$pkgdir/usr/lib/"
+	local i
+	for i in *.so*; do
+		cp -a "$i" "$pkgdir/usr/lib/$i"
+	done
+}
+sha512sums="15c671462a2f043e798b2998e8706f3ac119648c3d3ae946a0115c1f1aec567537f44e7e778bc77d3af4cd05a2d684677dabd56bb35799fca5939c6c087b4e27  testlib.c
+16be61567995052e20f9436c6834c2ca2afcfb04fea15c5d02eb576ecfdc9ef4fed8d977468b2564bbe934d098d111837d96cc323dae3f4dd033aa1d061063ee  testlib.h"

test/testdata/pkgrel_bump/aports/testlib/testlib.c

@@ -0,0 +1,5 @@
+#include <stdio.h>
+
+void testlib_hello() {
+	printf("hello, world from testlib!\n");
+}

test/testdata/pkgrel_bump/aports/testlib/testlib.h

@@ -0,0 +1,3 @@
+#pragma once
+
+void testlib_hello();