Make ppbt optional

Author: dwoz

relenv/build/common.py

@@ -125,8 +125,8 @@ def get_triplet(machine=None, plat=None):
     if ppbt:
         env = ppbt.environ(auto_extract=True)
         toolchain = pathlib.Path(env["TOOLCHAIN_PATH"])
-    else:
-        log.warning("ppbt package not installed")
+    #else:
+    #    log.warning("ppbt package not installed")
 else:
     toolchain = DATA_DIR / "toolchain" / get_triplet()
 
@@ -1482,6 +1482,9 @@ def find_pythonlib(libdir):
         env["RELENV_CROSS"] = dirs.prefix
         python = env["RELENV_NATIVE_PY"]
     logfp.write("\nRUN ENSURE PIP\n")
+
+    env.pop("RELENV_BUILDENV")
+
     runcmd(
         [str(python), "-m", "ensurepip"],
         env=env,

relenv/buildenv.py

@@ -55,8 +55,11 @@ def buildenv(relenv_path=None):
     if sys.platform != "linux":
         raise RelenvException("buildenv is only supported on Linux")
 
-    triplet = get_triplet()
     toolchain = get_toolchain()
+    if not toolchain:
+        raise RelenvException("buildenv is only supported on Linux")
+
+    triplet = get_triplet()
     env = {
         "RELENV_BUILDENV": "1",
         "TOOLCHAIN_PATH": f"{toolchain}",

relenv/runtime.py

@@ -602,7 +602,8 @@ def wrapper(*args, **kwargs):
                 env = ppbt.environ(auto_extract=True)
                 toolchain = pathlib.Path(env["TOOLCHAIN_PATH"])
             else:
-                debug("ppbt package not installed")
+                if os.environ.get("RELENV_BUILDENV", 0):
+                    raise RuntimeError("No toolchain installed")
                 return func(*args, **kwargs)
 
             if not toolchain.exists():

relenv/toolchain.py

@@ -20,7 +20,9 @@ def main(*args, **kwargs):
     """
     Notify users of toolchain command deprecation.
     """
-    print("The relenv toolchain command has been deprecated. Please pip install ppbt.")
+    print(
+        "The relenv toolchain command has been deprecated. Please pip install relenv[toolchain]."
+    )
 
 
 if __name__ == "__main__":

setup.cfg

@@ -17,8 +17,6 @@ packages = find:
 package_dir =
   relenv = relenv
 include_package_data = True
-install_requires =
-    ppbt; sys_platform == "linux"
 
 [options.entry_points]
 console_scripts =

tests/test_verify_build.py

@@ -108,6 +108,15 @@ def test_pip_install_salt_git(pipexec, build, build_dir, pyexec, build_version):
     if sys.platform == "darwin" and "3.13" in build_version:
         pytest.xfail("Salt does not work with 3.13 on macos yet")
 
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
+
     env = os.environ.copy()
     env["RELENV_BUILDENV"] = "yes"
     if sys.platform == "linux" and shutil.which("git"):
@@ -147,6 +156,15 @@ def test_pip_install_salt_git(pipexec, build, build_dir, pyexec, build_version):
     reason="3.11.7 and greater will not work with 3005.x",
 )
 def test_pip_install_salt(pipexec, build, tmp_path, pyexec):
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
+
     packages = [
         "salt==3005",
     ]
@@ -172,6 +190,15 @@ def test_pip_install_salt(pipexec, build, tmp_path, pyexec):
 
 @pytest.mark.skip_on_windows
 def test_symlinked_scripts(pipexec, tmp_path, build):
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
+
     name = "chardet==5.1.0"
     env = os.environ.copy()
     env["RELENV_DEBUG"] = "yes"
@@ -211,6 +238,15 @@ def test_pip_install_salt_w_static_requirements(
     if salt_branch == "3006.x" and sys.platform == "win32":
         pytest.xfail("Known failure")
 
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
+
     env = os.environ.copy()
     env["RELENV_BUILDENV"] = "yes"
     env["USE_STATIC_REQUIREMENTS"] = "1"
@@ -270,6 +306,15 @@ def test_pip_install_salt_w_package_requirements(
     if sys.platform == "darwin" and salt_branch == "3006.x":
         pytest.xfail("Known failure")
 
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
+
     env = os.environ.copy()
     env["RELENV_BUILDENV"] = "yes"
     env["USE_STATIC_REQUIREMENTS"] = "1"
@@ -365,6 +410,15 @@ def test_pip_install_pyzmq(pipexec, pyzmq_version, build_version, arch):
     if pyzmq_version == "25.1.2" and "3.13" in build_version:
         pytest.xfail(f"{pyzmq_version} does not install on 3.13")
 
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
+
     env = os.environ.copy()
 
     p = subprocess.run(
@@ -410,6 +464,14 @@ def test_pip_install_cryptography(pipexec):
     packages = [
         "cryptography",
     ]
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
     env = os.environ.copy()
     env["RELENV_BUILDENV"] = "yes"
     for name in packages:
@@ -421,6 +483,14 @@ def test_pip_install_idem(pipexec):
     packages = [
         "idem",
     ]
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
     env = os.environ.copy()
     env["RELENV_BUILDENV"] = "yes"
     for name in packages:
@@ -430,6 +500,14 @@ def test_pip_install_idem(pipexec):
 
 def test_pip_install_and_import_libcloud(pipexec, pyexec):
     name = "apache-libcloud"
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
     env = os.environ.copy()
     env["RELENV_BUILDENV"] = "yes"
     p = subprocess.run([str(pipexec), "install", name, "--no-cache-dir"], env=env)
@@ -455,6 +533,14 @@ def test_pip_install_salt_pip_dir(pipexec, build, build_version, arch):
     if sys.platform == "darwin" and "3.13" in build_version:
         pytest.xfail("Salt does not work with 3.13 on macos yet")
 
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
     env = os.environ.copy()
     env["RELENV_BUILDENV"] = "yes"
     env["RELENV_DEBUG"] = "yes"
@@ -472,6 +558,14 @@ def test_pip_install_salt_pip_dir(pipexec, build, build_version, arch):
 
 
 def test_nox_virtualenvs(pipexec, build, tmp_path):
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
     env = os.environ.copy()
     env["RELENV_BUILDENV"] = "yes"
     env["RELENV_DEBUG"] = "yes"
@@ -555,6 +649,14 @@ def test_pip_install_m2crypto_system_ssl(pipexec, pyexec):
 
 @pytest.mark.skip_unless_on_linux
 def test_pip_install_m2crypto_relenv_ssl(pipexec, pyexec, build):
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
     p = subprocess.run(
         [
             pyexec,
@@ -628,6 +730,14 @@ def validate_shebang(path):
 # XXX Mac support
 @pytest.mark.skip_unless_on_linux
 def test_moving_pip_installed_c_extentions(pipexec, build, minor_version):
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
     env = os.environ.copy()
     env["RELENV_DEBUG"] = "yes"
     env["RELENV_BUILDENV"] = "yes"
@@ -657,6 +767,15 @@ def test_moving_pip_installed_c_extentions(pipexec, build, minor_version):
 @pytest.mark.skip_unless_on_linux
 @pytest.mark.parametrize("cryptography_version", ["40.0.1", "39.0.2"])
 def test_cryptography_rpath(pipexec, build, minor_version, cryptography_version):
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
+
     def find_library(path, search):
         for root, dirs, files in os.walk(path):
             for fname in files:
@@ -723,6 +842,14 @@ def find_library(path, search):
 
 @pytest.mark.skip_unless_on_linux
 def test_install_pycurl(pipexec, build):
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
     curlver = "8.0.1"
 
     # Build curl and install it into the relenv environment
@@ -819,6 +946,14 @@ def build_dir(tmp_path):
     ],
 )
 def test_install_libgit2(pipexec, build, minor_version, build_dir, versions):
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
 
     buildscript = textwrap.dedent(
         """\
@@ -895,6 +1030,14 @@ def test_install_libgit2(pipexec, build, minor_version, build_dir, versions):
 
 @pytest.mark.skip_unless_on_linux
 def test_install_python_ldap(pipexec, build):
+    p = subprocess.run(
+        [
+            str(pipexec),
+            "install",
+            "ppbt",
+        ]
+    )
+    assert p.returncode == 0, "Failed to install ppbt"
     saslver = "2.1.28"
     ldapver = "2.5.14"