shell/make_shell_tarball.sh

#!/bin/bash
#
# 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 makes a tarball of the Python-based shell that can be unzipped and
# run out-of-the-box with no configuration. The final tarball is left in
# ${IMPALA_HOME}/shell/build.

set -euo pipefail
. $IMPALA_HOME/bin/report_build_error.sh
setup_report_build_error

if [ "x${IMPALA_HOME}" == "x" ]; then
  echo "\$IMPALA_HOME must be set"
  exit 1
fi

if [ $# -eq 0 ]; then
  echo "Must specify at least one python interpreter"
  exit 1
fi

# Detect whether IMPALA_HOME is a git repository. This is used below to allow extra
# checks when building ext-py.
pushd ${IMPALA_HOME}
IS_GIT_CHECKOUT=false
if git ls-files --error-unmatch > /dev/null 2>&1 ; then
  IS_GIT_CHECKOUT=true
  echo "IMPALA_HOME is a git repository"
else
  echo "IMPALA_HOME is not a git repository"
fi;
popd

IMPALA_VERSION_INFO_FILE=${IMPALA_HOME}/bin/version.info

if [ ! -f ${IMPALA_VERSION_INFO_FILE} ]; then
  echo "No version.info file found. Generating new version info"
  ${IMPALA_HOME}/bin/save-version.sh
else
  echo "Using existing version.info file."
fi

VERSION=$(grep "VERSION: " ${IMPALA_VERSION_INFO_FILE} | awk '{print $2}')
GIT_HASH=$(grep "GIT_HASH: " ${IMPALA_VERSION_INFO_FILE} | awk '{print $2}')
BUILD_DATE=$(grep "BUILD_TIME: " ${IMPALA_VERSION_INFO_FILE} | cut -f 2- -d ' ')
cat ${IMPALA_VERSION_INFO_FILE}

SHELL_HOME=${IMPALA_HOME}/shell
BUILD_DIR=${SHELL_HOME}/build
TARBALL_ROOT=${BUILD_DIR}/impala-shell-${VERSION}

THRIFT_GEN_PY_DIR="${SHELL_HOME}/gen-py"

echo "Deleting all files in ${TARBALL_ROOT}/{gen-py,lib,ext-py*,legacy}"
rm -rf ${TARBALL_ROOT}/lib/* 2>&1 > /dev/null
rm -rf ${TARBALL_ROOT}/gen-py/* 2>&1 > /dev/null
rm -rf ${TARBALL_ROOT}/ext-py* 2>&1 > /dev/null
rm -rf ${TARBALL_ROOT}/legacy/* 2>&1 > /dev/null
mkdir -p ${TARBALL_ROOT}/lib
mkdir -p ${TARBALL_ROOT}/legacy

rm -f ${THRIFT_GEN_PY_DIR}/impala_build_version.py
cat > ${THRIFT_GEN_PY_DIR}/impala_build_version.py <<EOF
# -*- coding: utf-8 -*-
#
# 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.

def get_version():
  return "${VERSION}"

def get_git_hash():
  return "${GIT_HASH}"

def get_build_date():
  return "${BUILD_DATE}"
EOF

# Building all external dependencies
#
# This builds each package to a wheel, then pip installs that wheel into the external
# dependencies directory for that Python version. The result directories are similar
# to the lib/python${version}/site-packages directory for a virtualenv with impala-shell
# installed.
#
# These use the same pip caches as the virtualenvs to avoid extra downloads. This
# script is a prerequisite for the pypi packaging, so there is no concurrency issue.
echo "Building all external dependencies"
for PYTHON_EXE in $*; do
  PYTHON_NAME=$(basename ${PYTHON_EXE})
  PYTHON_VERSION=$(${PYTHON_EXE} -c 'import sys; \
    print("{}.{}".format(sys.version_info.major, sys.version_info.minor))')
  # pip install the wheel into the external dependencies directory
  PIP_CACHE="~/.cache/impala_pip/${PYTHON_NAME}"
  # overwrite any earlier install of the same version. System Pythons are appended to
  # the list, and will always override extra definitions of the same version.
  rm -rf ${TARBALL_ROOT}/ext-py${PYTHON_VERSION}
  # Use the venv to get the wheel package needed for bdist_wheel below.
  source ${IMPALA_HOME}/shell/build/${PYTHON_NAME}_venv/bin/activate
  for MODULE in ${SHELL_HOME}/ext-py/*; do
    # Sometimes there are leftover module directories from version changes. If IMPALA_HOME
    # is a git repository, then we can check if the module directory is tracked by git.
    # If it is not tracked, skip building it. The downside of this check is that when
    # adding a new directory, it won't build until added in git. This check does not apply
    # when IMPALA_HOME is not a git repository (e.g. if building from a release tarball).
    if ${IS_GIT_CHECKOUT} &&
      ! git ls-files --error-unmatch ${MODULE} > /dev/null 2>&1 ; then
      echo "WARNING: ${MODULE} is not tracked by the git repository, skipping..."
      continue;
    fi
    pushd ${MODULE} > /dev/null 2>&1
    echo "Cleaning up old build artifacts."
    rm -rf dist 2>&1 > /dev/null
    rm -rf build 2>&1 > /dev/null
    echo "Building ${MODULE} with ${PYTHON_EXE}"
    if [[ "$MODULE" == *"/bitarray"* ]]; then
      # Need to use setuptools to build wheel for bitarray module
      python -c "import setuptools; exec(open('setup.py').read())" -q bdist_wheel
    else
      python setup.py -q bdist_wheel clean
    fi
    pip install --no-deps --cache "${PIP_CACHE}" \
      --target ${TARBALL_ROOT}/ext-py${PYTHON_VERSION} dist/*.whl
  done
  popd 2>&1 > /dev/null
done

# Copy all the shell files into the build dir

cp -r ${THRIFT_GEN_PY_DIR} ${TARBALL_ROOT}
cp ${SHELL_HOME}/option_parser.py ${TARBALL_ROOT}/lib
cp ${SHELL_HOME}/impala_shell_config_defaults.py ${TARBALL_ROOT}/lib
cp ${SHELL_HOME}/impala_client.py ${TARBALL_ROOT}/lib
cp ${SHELL_HOME}/TSSLSocketWithWildcardSAN.py ${TARBALL_ROOT}/lib
cp ${SHELL_HOME}/ImpalaHttpClient.py ${TARBALL_ROOT}/lib
cp ${SHELL_HOME}/shell_exceptions.py ${TARBALL_ROOT}/lib
cp ${SHELL_HOME}/shell_output.py ${TARBALL_ROOT}/lib
cp ${SHELL_HOME}/cookie_util.py ${TARBALL_ROOT}/lib
cp ${SHELL_HOME}/kerberos_util.py ${TARBALL_ROOT}/lib
cp ${SHELL_HOME}/value_converter.py ${TARBALL_ROOT}/lib
cp ${SHELL_HOME}/impala-shell ${TARBALL_ROOT}
cp ${SHELL_HOME}/impala_shell.py ${TARBALL_ROOT}
cp ${SHELL_HOME}/compatibility.py ${TARBALL_ROOT}
cp ${SHELL_HOME}/thrift_printer.py ${TARBALL_ROOT}

cp ${SHELL_HOME}/legacy/pkg_resources.py ${TARBALL_ROOT}/legacy

pushd ${BUILD_DIR} > /dev/null
echo "Making tarball in ${BUILD_DIR}"
tar czf ${BUILD_DIR}/impala-shell-${VERSION}.tar.gz --exclude="*.pyc" \
    ./impala-shell-${VERSION}/ || popd 2>&1 > /dev/null