ognibuild/ognibuild/buildsystem.py
2021-03-17 12:24:43 +00:00

833 lines
28 KiB
Python

#!/usr/bin/python
# Copyright (C) 2019-2020 Jelmer Vernooij <jelmer@jelmer.uk>
# encoding: utf-8
#
# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
import logging
import os
import re
from typing import Optional
import warnings
from . import shebang_binary, UnidentifiedError
from .outputs import (
BinaryOutput,
PythonPackageOutput,
)
from .requirements import (
BinaryRequirement,
PythonPackageRequirement,
PerlModuleRequirement,
NodePackageRequirement,
CargoCrateRequirement,
)
from .fix_build import run_with_build_fixers
class NoBuildToolsFound(Exception):
"""No supported build tools were found."""
class InstallTarget(object):
# Whether to prefer user-specific installation
user: Optional[bool]
# TODO(jelmer): Add information about target directory, layout, etc.
class BuildSystem(object):
"""A particular buildsystem."""
name: str
def __str__(self):
return self.name
def dist(self, session, resolver, fixers, quiet=False):
raise NotImplementedError(self.dist)
def test(self, session, resolver, fixers):
raise NotImplementedError(self.test)
def build(self, session, resolver, fixers):
raise NotImplementedError(self.build)
def clean(self, session, resolver, fixers):
raise NotImplementedError(self.clean)
def install(self, session, resolver, fixers, install_target):
raise NotImplementedError(self.install)
def get_declared_dependencies(self):
raise NotImplementedError(self.get_declared_dependencies)
def get_declared_outputs(self):
raise NotImplementedError(self.get_declared_outputs)
class Pear(BuildSystem):
name = "pear"
def __init__(self, path):
self.path = path
def setup(self, resolver):
resolver.install([BinaryRequirement("pear")])
def dist(self, session, resolver, fixers, quiet=False):
self.setup(resolver)
run_with_build_fixers(session, ["pear", "package"], fixers)
def test(self, session, resolver, fixers):
self.setup(resolver)
run_with_build_fixers(session, ["pear", "run-tests"], fixers)
def build(self, session, resolver, fixers):
self.setup(resolver)
run_with_build_fixers(session, ["pear", "build", self.path], fixers)
def clean(self, session, resolver, fixers):
self.setup(resolver)
# TODO
def install(self, session, resolver, fixers, install_target):
self.setup(resolver)
run_with_build_fixers(session, ["pear", "install", self.path], fixers)
# run_setup, but setting __name__
# Imported from Python's distutils.core, Copyright (C) PSF
def run_setup(script_name, script_args=None, stop_after="run"):
from distutils import core
import sys
if stop_after not in ("init", "config", "commandline", "run"):
raise ValueError("invalid value for 'stop_after': %r" % (stop_after,))
core._setup_stop_after = stop_after
save_argv = sys.argv.copy()
g = {"__file__": script_name, "__name__": "__main__"}
try:
old_cwd = os.getcwd()
os.chdir(os.path.dirname(script_name))
try:
sys.argv[0] = script_name
if script_args is not None:
sys.argv[1:] = script_args
with open(script_name, "rb") as f:
exec(f.read(), g)
finally:
os.chdir(old_cwd)
sys.argv = save_argv
core._setup_stop_after = None
except SystemExit:
# Hmm, should we do something if exiting with a non-zero code
# (ie. error)?
pass
if core._setup_distribution is None:
raise RuntimeError(
(
"'distutils.core.setup()' was never called -- "
"perhaps '%s' is not a Distutils setup script?"
)
% script_name
)
return core._setup_distribution
class SetupPy(BuildSystem):
name = "setup.py"
def __init__(self, path):
self.path = path
# TODO(jelmer): Perhaps run this in session, so we can install
# missing dependencies?
try:
self.result = run_setup(os.path.abspath(path), stop_after="init")
except RuntimeError as e:
logging.warning("Unable to load setup.py metadata: %s", e)
self.result = None
def __repr__(self):
return "%s(%r)" % (type(self).__name__, self.path)
def setup(self, resolver):
with open(self.path, "r") as f:
setup_py_contents = f.read()
try:
with open("setup.cfg", "r") as f:
setup_cfg_contents = f.read()
except FileNotFoundError:
setup_cfg_contents = ""
if "setuptools" in setup_py_contents:
logging.debug("Reference to setuptools found, installing.")
resolver.install([PythonPackageRequirement("setuptools")])
if (
"setuptools_scm" in setup_py_contents
or "setuptools_scm" in setup_cfg_contents
):
logging.debug("Reference to setuptools-scm found, installing.")
resolver.install(
[
PythonPackageRequirement("setuptools_scm"),
BinaryRequirement("git"),
BinaryRequirement("hg"),
]
)
# TODO(jelmer): Install setup_requires
def test(self, session, resolver, fixers):
self.setup(resolver)
self._run_setup(session, resolver, ["test"], fixers)
def build(self, session, resolver, fixers):
self.setup(resolver)
self._run_setup(session, resolver, ["build"], fixers)
def dist(self, session, resolver, fixers, quiet=False):
self.setup(resolver)
preargs = []
if quiet:
preargs.append("--quiet")
self._run_setup(session, resolver, preargs + ["sdist"], fixers)
def clean(self, session, resolver, fixers):
self.setup(resolver)
self._run_setup(session, resolver, ["clean"], fixers)
def install(self, session, resolver, fixers, install_target):
self.setup(resolver)
extra_args = []
if install_target.user:
extra_args.append("--user")
self._run_setup(session, resolver, ["install"] + extra_args, fixers)
def _run_setup(self, session, resolver, args, fixers):
interpreter = shebang_binary(self.path)
if interpreter is not None:
resolver.install([BinaryRequirement(interpreter)])
run_with_build_fixers(session, ["./setup.py"] + args, fixers)
else:
# Just assume it's Python 3
resolver.install([BinaryRequirement("python3")])
run_with_build_fixers(session, ["python3", "./setup.py"] + args, fixers)
def get_declared_dependencies(self):
if self.result is None:
raise NotImplementedError
for require in self.result.get_requires():
yield "core", PythonPackageRequirement.from_requirement_str(require)
# Not present for distutils-only packages
if getattr(self.result, "install_requires", []):
for require in self.result.install_requires:
yield "core", PythonPackageRequirement.from_requirement_str(require)
# Not present for distutils-only packages
if getattr(self.result, "tests_require", []):
for require in self.result.tests_require:
yield "test", PythonPackageRequirement.from_requirement_str(require)
def get_declared_outputs(self):
if self.result is None:
raise NotImplementedError
for script in self.result.scripts or []:
yield BinaryOutput(os.path.basename(script))
entry_points = getattr(self.result, "entry_points", None) or {}
for script in entry_points.get("console_scripts", []):
yield BinaryOutput(script.split("=")[0])
for package in self.result.packages or []:
yield PythonPackageOutput(package, python_version="cpython3")
class Gradle(BuildSystem):
name = "gradle"
def __init__(self, path, executable="gradle"):
self.path = path
self.executable = executable
def __repr__(self):
return "%s(%r)" % (type(self).__name__, self.path)
@classmethod
def exists(cls, path):
return (
os.path.exists(os.path.join(path, "build.gradle")) or
os.path.exists(os.path.join(path, "build.gradle.kts")))
@classmethod
def from_path(cls, path):
if os.path.exists(os.path.join(path, "gradlew")):
return cls(path, "./gradlew")
return cls(path)
def setup(self, resolver):
if not self.executable.startswith('./'):
resolver.install([BinaryRequirement(self.executable)])
def clean(self, session, resolver, fixers):
self.setup(resolver)
run_with_build_fixers(session, [self.executable, "clean"], fixers)
def build(self, session, resolver, fixers):
self.setup(resolver)
run_with_build_fixers(session, [self.executable, "build"], fixers)
def test(self, session, resolver, fixers):
self.setup(resolver)
run_with_build_fixers(session, [self.executable, "test"], fixers)
def dist(self, session, resolver, fixers, quiet=False):
self.setup(resolver)
run_with_build_fixers(session, [self.executable, "distTar"], fixers)
def install(self, session, resolver, fixers, install_target):
raise NotImplementedError
self.setup(resolver)
# TODO(jelmer): installDist just creates files under build/install/...
run_with_build_fixers(
session, [self.executable, "installDist"], fixers)
class Meson(BuildSystem):
name = "meson"
def __init__(self, path):
self.path = path
def __repr__(self):
return "%s(%r)" % (type(self).__name__, self.path)
def _setup(self, session, fixers):
if session.exists("build"):
return
os.mkdir(os.path.join(session.location, "build"))
run_with_build_fixers(session, ["meson", "setup", "build"], fixers)
def clean(self, session, resolver, fixers):
self._setup(session, fixers)
run_with_build_fixers(session, ["ninja", "-C", "build", "clean"], fixers)
def build(self, session, resolver, fixers):
self._setup(session, fixers)
run_with_build_fixers(session, ["ninja", "-C", "build"], fixers)
def dist(self, session, resolver, fixers, quiet=False):
self._setup(session, fixers)
run_with_build_fixers(session, ["ninja", "-C", "build", "dist"], fixers)
def test(self, session, resolver, fixers):
self._setup(session, fixers)
run_with_build_fixers(session, ["ninja", "-C", "build", "test"], fixers)
def install(self, session, resolver, fixers, install_target):
self._setup(session, fixers)
run_with_build_fixers(session, ["ninja", "-C", "build", "install"], fixers)
class PyProject(BuildSystem):
name = "pyproject"
def __init__(self, path):
self.path = path
self.pyproject = self.load_toml()
def __repr__(self):
return "%s(%r)" % (type(self).__name__, self.path)
def load_toml(self):
import toml
with open(self.path, "r") as pf:
return toml.load(pf)
def dist(self, session, resolver, fixers, quiet=False):
if "poetry" in self.pyproject.get("tool", []):
logging.debug(
"Found pyproject.toml with poetry section, " "assuming poetry project."
)
run_with_build_fixers(session, ["poetry", "build", "-f", "sdist"], fixers)
return
raise AssertionError("no supported section in pyproject.toml")
class SetupCfg(BuildSystem):
name = "setup.cfg"
def __init__(self, path):
self.path = path
def setup(self, resolver):
resolver.install(
[
PythonPackageRequirement("pep517"),
]
)
def dist(self, session, resolver, fixers, quiet=False):
self.setup(resolver)
session.check_call(["python3", "-m", "pep517.build", "-s", "."])
class Npm(BuildSystem):
name = "npm"
def __init__(self, path):
import json
with open(path, "r") as f:
self.package = json.load(f)
def get_declared_dependencies(self):
if "devDependencies" in self.package:
for name, unused_version in self.package["devDependencies"].items():
# TODO(jelmer): Look at version
yield "dev", NodePackageRequirement(name)
def setup(self, resolver):
resolver.install([BinaryRequirement("npm")])
def dist(self, session, resolver, fixers, quiet=False):
self.setup(resolver)
run_with_build_fixers(session, ["npm", "pack"], fixers)
class Waf(BuildSystem):
name = "waf"
def __init__(self, path):
self.path = path
def setup(self, session, resolver, fixers):
resolver.install([BinaryRequirement("python3")])
def dist(self, session, resolver, fixers, quiet=False):
self.setup(session, resolver, fixers)
run_with_build_fixers(session, ["./waf", "dist"], fixers)
def test(self, session, resolver, fixers):
self.setup(session, resolver, fixers)
run_with_build_fixers(session, ["./waf", "test"], fixers)
class Gem(BuildSystem):
name = "gem"
def __init__(self, path):
self.path = path
def setup(self, resolver):
resolver.install([BinaryRequirement("gem2deb")])
def dist(self, session, resolver, fixers, quiet=False):
self.setup(resolver)
gemfiles = [
entry.name for entry in session.scandir(".") if entry.name.endswith(".gem")
]
if len(gemfiles) > 1:
logging.warning("More than one gemfile. Trying the first?")
run_with_build_fixers(session, ["gem2tgz", gemfiles[0]], fixers)
class DistInkt(BuildSystem):
def __init__(self, path):
self.path = path
self.name = "dist-zilla"
self.dist_inkt_class = None
with open(self.path, "rb") as f:
for line in f:
if not line.startswith(b";;"):
continue
try:
(key, value) = line[2:].split(b"=", 1)
except ValueError:
continue
if key.strip() == b"class" and value.strip().startswith(b"'Dist::Inkt"):
logging.debug(
"Found Dist::Inkt section in dist.ini, " "assuming distinkt."
)
self.name = "dist-inkt"
self.dist_inkt_class = value.decode().strip("'")
return
logging.debug("Found dist.ini, assuming dist-zilla.")
def setup(self, resolver):
resolver.install(
[
PerlModuleRequirement("Dist::Inkt"),
]
)
def dist(self, session, resolver, fixers, quiet=False):
self.setup(resolver)
if self.name == "dist-inkt":
resolver.install([PerlModuleRequirement(self.dist_inkt_class)])
run_with_build_fixers(session, ["distinkt-dist"], fixers)
else:
# Default to invoking Dist::Zilla
resolver.install([PerlModuleRequirement("Dist::Zilla")])
run_with_build_fixers(session, ["dzil", "build", "--in", ".."], fixers)
class Make(BuildSystem):
name = "make"
def __init__(self, path):
self.path = path
def __repr__(self):
return "%s(%r)" % (type(self).__name__, self.path)
def setup(self, session, resolver, fixers):
def makefile_exists():
return any(
[session.exists(p) for p in ["Makefile", "GNUmakefile", "makefile"]]
)
if session.exists("Makefile.PL") and not makefile_exists():
run_with_build_fixers(session, ["perl", "Makefile.PL"], fixers)
if not makefile_exists() and not session.exists("configure"):
if session.exists("autogen.sh"):
if shebang_binary(os.path.join(self.path, "autogen.sh")) is None:
run_with_build_fixers(session, ["/bin/sh", "./autogen.sh"], fixers)
try:
run_with_build_fixers(session, ["./autogen.sh"], fixers)
except UnidentifiedError as e:
if (
"Gnulib not yet bootstrapped; "
"run ./bootstrap instead.\n" in e.lines
):
run_with_build_fixers(session, ["./bootstrap"], fixers)
run_with_build_fixers(session, ["./autogen.sh"], fixers)
else:
raise
elif session.exists("configure.ac") or session.exists("configure.in"):
resolver.install(
[
BinaryRequirement("autoconf"),
BinaryRequirement("automake"),
BinaryRequirement("gettextize"),
BinaryRequirement("libtoolize"),
]
)
run_with_build_fixers(session, ["autoreconf", "-i"], fixers)
if not makefile_exists() and session.exists("configure"):
run_with_build_fixers(session, ["./configure"], fixers)
def build(self, session, resolver, fixers):
self.setup(session, resolver, fixers)
run_with_build_fixers(session, ["make", "all"], fixers)
def clean(self, session, resolver, fixers):
self.setup(session, resolver, fixers)
run_with_build_fixers(session, ["make", "clean"], fixers)
def test(self, session, resolver, fixers):
self.setup(session, resolver, fixers)
run_with_build_fixers(session, ["make", "check"], fixers)
def install(self, session, resolver, fixers, install_target):
self.setup(session, resolver, fixers)
run_with_build_fixers(session, ["make", "install"], fixers)
def dist(self, session, resolver, fixers, quiet=False):
self.setup(session, resolver, fixers)
try:
run_with_build_fixers(session, ["make", "dist"], fixers)
except UnidentifiedError as e:
if "make: *** No rule to make target 'dist'. Stop.\n" in e.lines:
raise NotImplementedError
elif "make[1]: *** No rule to make target 'dist'. Stop.\n" in e.lines:
raise NotImplementedError
elif (
"Reconfigure the source tree "
"(via './config' or 'perl Configure'), please.\n"
) in e.lines:
run_with_build_fixers(session, ["./config"], fixers)
run_with_build_fixers(session, ["make", "dist"], fixers)
elif (
"Please try running 'make manifest' and then run "
"'make dist' again.\n" in e.lines
):
run_with_build_fixers(session, ["make", "manifest"], fixers)
run_with_build_fixers(session, ["make", "dist"], fixers)
elif "Please run ./configure first\n" in e.lines:
run_with_build_fixers(session, ["./configure"], fixers)
run_with_build_fixers(session, ["make", "dist"], fixers)
elif any(
[
re.match(
r"(Makefile|GNUmakefile|makefile):[0-9]+: "
r"\*\*\* Missing \'Make.inc\' "
r"Run \'./configure \[options\]\' and retry. Stop.\n",
line,
)
for line in e.lines
]
):
run_with_build_fixers(session, ["./configure"], fixers)
run_with_build_fixers(session, ["make", "dist"], fixers)
elif any(
[
re.match(
r"Problem opening MANIFEST: No such file or directory "
r"at .* line [0-9]+\.",
line,
)
for line in e.lines
]
):
run_with_build_fixers(session, ["make", "manifest"], fixers)
run_with_build_fixers(session, ["make", "dist"], fixers)
else:
raise
def get_declared_dependencies(self):
# TODO(jelmer): Split out the perl-specific stuff?
if os.path.exists("META.yml"):
# See http://module-build.sourceforge.net/META-spec-v1.4.html for
# the specification of the format.
import ruamel.yaml
import ruamel.yaml.reader
with open("META.yml", "rb") as f:
try:
data = ruamel.yaml.load(f, ruamel.yaml.SafeLoader)
except ruamel.yaml.reader.ReaderError as e:
warnings.warn("Unable to parse META.yml: %s" % e)
return
for require in data.get("requires", []):
yield "build", PerlModuleRequirement(require)
else:
raise NotImplementedError
class Cargo(BuildSystem):
name = "cargo"
def __repr__(self):
return "%s(%r)" % (type(self).__name__, self.path)
def __init__(self, path):
from toml.decoder import load
self.path = path
with open(path, "r") as f:
self.cargo = load(f)
def get_declared_dependencies(self):
if "dependencies" in self.cargo:
for name, details in self.cargo["dependencies"].items():
if isinstance(details, str):
details = {"version": details}
# TODO(jelmer): Look at details['version']
yield "build", CargoCrateRequirement(
name,
features=details.get('features', []),
version=details.get("version"))
def test(self, session, resolver, fixers):
run_with_build_fixers(session, ["cargo", "test"], fixers)
def clean(self, session, resolver, fixers):
run_with_build_fixers(session, ["cargo", "clean"], fixers)
def build(self, session, resolver, fixers):
run_with_build_fixers(session, ["cargo", "build"], fixers)
class Golang(BuildSystem):
"""Go builds."""
name = "golang"
def __init__(self, path):
self.path = path
def __repr__(self):
return "%s()" % (type(self).__name__)
def test(self, session, resolver, fixers):
run_with_build_fixers(session, ["go", "test"], fixers)
def build(self, session, resolver, fixers):
run_with_build_fixers(session, ["go", "build"], fixers)
def install(self, session, resolver, fixers):
run_with_build_fixers(session, ["go", "install"], fixers)
def clean(self, session, resolver, fixers):
session.check_call(["go", "clean"])
class Maven(BuildSystem):
name = "maven"
def __init__(self, path):
self.path = path
class Cabal(BuildSystem):
name = "cabal"
def __init__(self, path):
self.path = path
def __repr__(self):
return "%s(%r)" % (type(self).__name__, self.path)
def _run(self, session, args, fixers):
try:
run_with_build_fixers(session, ["runhaskell", "Setup.hs"] + args, fixers)
except UnidentifiedError as e:
if "Run the 'configure' command first.\n" in e.lines:
run_with_build_fixers(
session, ["runhaskell", "Setup.hs", "configure"], fixers
)
run_with_build_fixers(
session, ["runhaskell", "Setup.hs"] + args, fixers
)
else:
raise
def test(self, session, resolver, fixers):
self._run(session, ["test"], fixers)
def dist(self, session, resolver, fixers, quiet=False):
self._run(session, ["sdist"], fixers)
def detect_buildsystems(path, trust_package=False): # noqa: C901
"""Detect build systems."""
if os.path.exists(os.path.join(path, "package.xml")):
logging.debug("Found package.xml, assuming pear package.")
yield Pear(os.path.join(path, "package.xml"))
if os.path.exists(os.path.join(path, "setup.py")):
logging.debug("Found setup.py, assuming python project.")
yield SetupPy(os.path.join(path, "setup.py"))
elif os.path.exists(os.path.join(path, "pyproject.toml")):
logging.debug("Found pyproject.toml, assuming python project.")
yield PyProject(os.path.join(path, "pyproject.toml"))
elif os.path.exists(os.path.join(path, "setup.cfg")):
logging.debug("Found setup.cfg, assuming python project.")
yield SetupCfg(os.path.join(path, "setup.cfg"))
if os.path.exists(os.path.join(path, "package.json")):
logging.debug("Found package.json, assuming node package.")
yield Npm(os.path.join(path, "package.json"))
if os.path.exists(os.path.join(path, "waf")):
logging.debug("Found waf, assuming waf package.")
yield Waf(os.path.join(path, "waf"))
if os.path.exists(os.path.join(path, "Cargo.toml")):
logging.debug("Found Cargo.toml, assuming rust cargo package.")
yield Cargo(os.path.join(path, "Cargo.toml"))
if Gradle.exists(path):
logging.debug("Found build.gradle, assuming gradle package.")
yield Gradle.from_path(path)
if os.path.exists(os.path.join(path, "meson.build")):
logging.debug("Found meson.build, assuming meson package.")
yield Meson(os.path.join(path, "meson.build"))
if os.path.exists(os.path.join(path, "Setup.hs")):
logging.debug("Found Setup.hs, assuming haskell package.")
yield Cabal(os.path.join(path, "Setup.hs"))
if os.path.exists(os.path.join(path, "pom.xml")):
logging.debug("Found pom.xml, assuming maven package.")
yield Maven(os.path.join(path, "pom.xml"))
if os.path.exists(os.path.join(path, "dist.ini")) and not os.path.exists(
os.path.join(path, "Makefile.PL")
):
yield DistInkt(os.path.join(path, "dist.ini"))
gemfiles = [entry.path for entry in os.scandir(path) if entry.name.endswith(".gem")]
if gemfiles:
yield Gem(gemfiles[0])
if any(
[
os.path.exists(os.path.join(path, p))
for p in [
"Makefile",
"GNUmakefile",
"makefile",
"Makefile.PL",
"CMakeLists.txt",
"autogen.sh",
"configure.ac",
"configure.in",
]
]
):
yield Make(path)
seen_golang = False
if os.path.exists(os.path.join(path, ".travis.yml")):
import ruamel.yaml.reader
with open(os.path.join(path, ".travis.yml"), "rb") as f:
try:
data = ruamel.yaml.load(f, ruamel.yaml.SafeLoader)
except ruamel.yaml.reader.ReaderError as e:
warnings.warn("Unable to parse .travis.yml: %s" % (e,))
else:
language = data.get("language")
if language == "go":
yield Golang(path)
seen_golang = True
if not seen_golang:
for entry in os.scandir(path):
if entry.name.endswith(".go"):
yield Golang(path)
break
def get_buildsystem(path, trust_package=False):
for buildsystem in detect_buildsystems(path, trust_package=trust_package):
return buildsystem
raise NoBuildToolsFound()