Files
impala/bin/gen-backend-test-script.py
Tim Armstrong c43c03c5ee IMPALA-3926: part 2: avoid setting LD_LIBRARY_PATH
This removes LD_LIBRARY_PATH and LD_PRELOAD from the
developer's shell and cleans it up. With the preceding
change, toolchain utilities like clang can be run without
a special LD_LIBRARY_PATH.

This fixes a bug where libjvm.so was registered as a
static instead of a shared library, which adds it to the
RUNPATH variable in the binary, which provides a default
search location that can be overriden by LD_LIBRARY_PATH.

Impala binaries don't have the rpath baked in for some
libraries, including Impala-lzo, libgcc and libstdc++.
, so we still need to set LD_LIBRARY_PATH when running
those. That is solved with wrapper scripts that sets
the environment variables only when invoking those
binaries, e.g. starting a daemon or running a backend
test. I added three scripts because there were 3 sets
of environment variables. The scripts are:
* run-binary.sh: just sets LD_LIBRARY_PATH
* run-jvm-binary.sh: sets LD_LIBRARY_PATH and CLASSPATH
* start-daemon.sh: sets LD_LIBRARY_PATH and CLASSPATH and
  kerberos-related environment variables.

The binaries, in almost all cases, work fine without
those tweaks, because libstdc++ and libgcc are picked
up along with libkuduclient.so from the toolchain (they
are in the same directory). I decided to leave good enough
alone here. run-binary.sh and friends can be used in
any remaining edge cases to run binaries.

An alternative to the 3 scripts would be to have an
uber-script that set all the variables, but I felt
that it was better to be specific about what
each binary needed. Cleaning the LD_LIBRARY_PATH
mess up has given me a distaste for scattershot
setting of environment variables. I am open to
revisiting this.

Testing:
* Ran tests on centos 7
* Manually tested that my dev env with
 LD_LIBRARY_PATH=/usr/lib/x86_64-linux-gnu continued
 to work (for now). All ubuntu 16.04 and 18.04 dev
 envs that were set up with bootstrap_development.sh
 will be in this state.

Change-Id: I61c83e6cca6debb87a12135e58ee501244bc9603
Reviewed-on: http://gerrit.cloudera.org:8080/14494
Reviewed-by: Tim Armstrong <tarmstrong@cloudera.com>
Tested-by: Impala Public Jenkins <impala-public-jenkins@cloudera.com>
2020-05-07 08:50:44 +00:00

79 lines
3.3 KiB
Python
Executable File

#!/usr/bin/env python
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# This script generates a bash script to run a certain set of backend tests. It is
# used by the build system (see be/CMakeLists.txt for usage) and is not intended to be
# run directly.
import argparse
import os
import stat
import textwrap
# The script header template requires substitutions to set the variables used by the body.
script_header_template = textwrap.dedent("""\
#!/bin/bash
GTEST_FILTER="{gtest_filter}"
TEST_EXEC_NAME="{test_exec_name}"
""")
# The script body uses shell variables for all of its key components. It requires
# no substitutions.
script_body = textwrap.dedent(r"""
${IMPALA_HOME}/bin/run-jvm-binary.sh \
${IMPALA_HOME}/be/build/latest/service/unifiedbetests \
--gtest_filter=${GTEST_FILTER} \
--gtest_output=xml:${IMPALA_BE_TEST_LOGS_DIR}/${TEST_EXEC_NAME}.xml \
-log_filename="${TEST_EXEC_NAME}" \
"$@"
RETURN_CODE=$?
# Running a gtest executable using the -gtest_filter flag produces a JUnitXML that
# contains all the tests whether they ran or not. The tests that ran are populated
# normally. The tests that didn't run have status="notrun". This is a problem for the
# unified binary, because every JUnitXML would contain every test, with a large
# portion of them marked as notrun. Various consumers of JUnitXML (such as Jenkins)
# may not understand this distinction, so it is useful to prune the notrun entries.
# The junitxml_prune_notrun.py walks through the JUnitXML file and drops the entries
# that did not run, producing a new JUnitXML file of the same name.
${IMPALA_HOME}/bin/junitxml_prune_notrun.py \
-f "${IMPALA_BE_TEST_LOGS_DIR}/${TEST_EXEC_NAME}.xml"
exit ${RETURN_CODE}
""")
def main():
parser = argparse.ArgumentParser()
parser.add_argument("--gtest_filter", required=True,
help="The location to write the generated script")
parser.add_argument("--test_script_output", required=True,
help="The test filter pattern to pass to gtest to limit the set of tests run")
args = parser.parse_args()
with open(args.test_script_output, "w") as f:
test_exec_name = os.path.basename(args.test_script_output)
script_header = script_header_template.format(gtest_filter=args.gtest_filter,
test_exec_name=test_exec_name)
f.write(script_header)
f.write(script_body)
# Make the script executable by user and group.
st = os.stat(args.test_script_output)
os.chmod(args.test_script_output, st.st_mode | stat.S_IXUSR | stat.S_IXGRP)
if __name__ == "__main__":
main()