cross-project-tests/debuginfo-tests/dexter/dex/builder/Builder.py

   1 # DExTer : Debugging Experience Tester
   2 # ~~~~~~   ~         ~~         ~   ~~
   3 #
   4 # Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   5 # See https://llvm.org/LICENSE.txt for license information.
   6 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   7 """Deals with the processing execution of shell or batch build scripts."""
   8
   9 import os
  10 import subprocess
  11 import unittest
  12
  13 from dex.dextIR import BuilderIR
  14 from dex.utils import Timer
  15 from dex.utils.Exceptions import BuildScriptException
  16
  17
  18 def _quotify(text):
  19     if '"' in text or " " not in text:
  20         return text
  21     return '"{}"'.format(text)
  22
  23
  24 def _get_script_environment(
  25     source_files, compiler_options, linker_options, executable_file
  26 ):
  27
  28     source_files = [_quotify(f) for f in source_files]
  29     object_files = [_quotify("{}.o".format(os.path.basename(f))) for f in source_files]
  30     source_indexes = ["{:02d}".format(i + 1) for i in range(len(source_files))]
  31
  32     env_variables = {}
  33     env_variables["SOURCE_INDEXES"] = " ".join(source_indexes)
  34     env_variables["SOURCE_FILES"] = " ".join(source_files)
  35     env_variables["OBJECT_FILES"] = " ".join(object_files)
  36     env_variables["LINKER_OPTIONS"] = linker_options
  37
  38     for i, _ in enumerate(source_files):
  39         index = source_indexes[i]
  40         env_variables["SOURCE_FILE_{}".format(index)] = source_files[i]
  41         env_variables["OBJECT_FILE_{}".format(index)] = object_files[i]
  42         env_variables["COMPILER_OPTIONS_{}".format(index)] = compiler_options[i]
  43
  44     env_variables["EXECUTABLE_FILE"] = executable_file
  45
  46     return env_variables
  47
  48
  49 def run_external_build_script(
  50     context,
  51     script_path,
  52     source_files,
  53     compiler_options,
  54     linker_options,
  55     executable_file,
  56 ):
  57     """Build an executable using a builder script.
  58
  59     The executable is saved to `context.working_directory.path`.
  60
  61     Returns:
  62         ( stdout (str), stderr (str), builder (BuilderIR) )
  63     """
  64
  65     builderIR = BuilderIR(
  66         name=context.options.builder,
  67         cflags=compiler_options,
  68         ldflags=linker_options,
  69     )
  70     assert len(source_files) == len(compiler_options), (source_files, compiler_options)
  71
  72     script_environ = _get_script_environment(
  73         source_files, compiler_options, linker_options, executable_file
  74     )
  75     env = dict(os.environ)
  76     env.update(script_environ)
  77     try:
  78         with Timer("running build script"):
  79             process = subprocess.Popen(
  80                 [script_path],
  81                 cwd=context.working_directory.path,
  82                 env=env,
  83                 stdout=subprocess.PIPE,
  84                 stderr=subprocess.PIPE,
  85             )
  86             out, err = process.communicate()
  87             returncode = process.returncode
  88         out = out.decode("utf-8")
  89         err = err.decode("utf-8")
  90         if returncode != 0:
  91             raise BuildScriptException(
  92                 "{}: failed with returncode {}.\nstdout:\n{}\n\nstderr:\n{}\n".format(
  93                     script_path, returncode, out, err
  94                 ),
  95                 script_error=err,
  96             )
  97         return out, err, builderIR
  98     except OSError as e:
  99         raise BuildScriptException("{}: {}".format(e.strerror, script_path))
 100
 101
 102 class TestBuilder(unittest.TestCase):
 103     def test_get_script_environment(self):
 104         source_files = ["a.a", "b.b"]
 105         compiler_options = ["-option1 value1", "-option2 value2"]
 106         linker_options = "-optionX valueX"
 107         executable_file = "exe.exe"
 108         env = _get_script_environment(
 109             source_files, compiler_options, linker_options, executable_file
 110         )
 111
 112         assert env["SOURCE_FILES"] == "a.a b.b"
 113         assert env["OBJECT_FILES"] == "a.a.o b.b.o"
 114
 115         assert env["SOURCE_INDEXES"] == "01 02"
 116         assert env["LINKER_OPTIONS"] == "-optionX valueX"
 117
 118         assert env["SOURCE_FILE_01"] == "a.a"
 119         assert env["SOURCE_FILE_02"] == "b.b"
 120
 121         assert env["OBJECT_FILE_01"] == "a.a.o"
 122         assert env["OBJECT_FILE_02"] == "b.b.o"
 123
 124         assert env["EXECUTABLE_FILE"] == "exe.exe"
 125
 126         assert env["COMPILER_OPTIONS_01"] == "-option1 value1"
 127         assert env["COMPILER_OPTIONS_02"] == "-option2 value2"