build-infer.sh

#!/usr/bin/env bash

# Convenience script to build Infer when using opam

# Copyright (c) Facebook, Inc. and its affiliates.
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.

set -e
set -o pipefail
set -u

SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
INFER_ROOT="$SCRIPT_DIR"
DEPENDENCIES_DIR="$INFER_ROOT/facebook/dependencies"
PLATFORM="$(uname)"
SANDCASTLE=${SANDCASTLE:-}
NCPU="$(getconf _NPROCESSORS_ONLN 2>/dev/null || echo 1)"
INFER_OPAM_DEFAULT_SWITCH="5.2.1+flambda"
INFER_OPAM_DEFAULT_SWITCH_OPTIONS="--package=ocaml-variants.5.2.1+options,ocaml-option-flambda"
INFER_OPAM_SWITCH=${INFER_OPAM_SWITCH:-$INFER_OPAM_DEFAULT_SWITCH}
INFER_OPAM_SWITCH_OPTIONS=${INFER_OPAM_SWITCH_OPTIONS:-$INFER_OPAM_DEFAULT_SWITCH_OPTIONS}
PLUGIN_DIR="$INFER_ROOT/facebook-clang-plugins"
PLUGIN_SETUP_SCRIPT=${PLUGIN_SETUP_SCRIPT:-setup.sh}
PLUGIN_SETUP="${PLUGIN_DIR}/clang/${PLUGIN_SETUP_SCRIPT}"

function usage() {
  echo "Usage: $0 [options] [targets] [-- options for ./configure]"
  echo
  echo " targets:"
  echo "   all      build everything except swift (default)"
  echo "   clang    build C and Objective-C analyzer"
  echo "   erlang   build Erlang analyzer"
  echo "   hack     build Hack analyzer"
  echo "   java     build Java analyzer"
  echo "   python   build Python analyzer (experimental)"
  echo "   swift    build swift analyzer (experimental)"
  echo
  echo " options:"
  echo "   -h,--help             show this message"
  echo "   --no-opam-lock        do not use the opam/infer.opam.locked file and let opam resolve dependencies"
  echo "   --only-setup-opam     initialize opam, install the opam dependencies of infer, and exit"
  echo "   --user-opam-switch    use the current opam switch to install infer (default: $INFER_OPAM_DEFAULT_SWITCH)"
  echo "   -y,--yes              automatically agree to everything"
  echo "   --                    stop parsing options and pass the remaining ones to ./configure"
  echo
  echo " examples:"
  echo "    $0                                 # build infer with default options"
  echo "    $0 -- --help                       # display the options from ./configure"
  echo "    $0 java                            # build only the Java analyzer"
  echo "    $0 -y -- --disable-clang-analyzers # build everything but clang support, agree to all questions"
}

# arguments
CONFIGURE_OPTS=()
BUILD_CLANG=${BUILD_CLANG:-no}
BUILD_ERLANG=${BUILD_ERLANG:-no}
BUILD_HACK=${BUILD_HACK:-no}
BUILD_JAVA=${BUILD_JAVA:-no}
BUILD_PYTHON=${BUILD_PYTHON:-no}
BUILD_SWIFT=${BUILD_SWIFT:-no}
INTERACTIVE=${INTERACTIVE:-yes}
JOBS=${JOBS:-$NCPU}
ONLY_SETUP_OPAM=${ONLY_SETUP_OPAM:-no}
USE_OPAM_LOCK=${USE_OPAM_LOCK:-yes}
USER_OPAM_SWITCH=no

ORIG_ARGS="$*"

function build_all() {
  BUILD_CLANG=yes
  BUILD_ERLANG=yes
  BUILD_HACK=yes
  BUILD_JAVA=yes
  BUILD_PYTHON=yes
  BUILD_SWIFT=no
}

while [[ $# -gt 0 ]]; do
  opt_key="$1"
  case $opt_key in
    all)
      build_all
      shift
      continue
      ;;
    clang)
      BUILD_CLANG=yes
      shift
      continue
      ;;
    erlang)
      BUILD_ERLANG=yes
      shift
      continue
      ;;
    hack)
      BUILD_HACK=yes
      shift
      continue
      ;;
    java)
      BUILD_JAVA=yes
      shift
      continue
      ;;
    python)
      BUILD_PYTHON=yes
      shift
      continue
      ;;
    swift)
      BUILD_SWIFT=yes
      shift
      continue
      ;;
    -h|--help)
      usage
      exit 0
     ;;
    --no-opam-lock)
      USE_OPAM_LOCK=no
      shift
      continue
     ;;
    --user-opam-switch)
      USER_OPAM_SWITCH=yes
      shift
      continue
     ;;
    --only-setup-opam)
      ONLY_SETUP_OPAM=yes
      shift
      continue
     ;;
    -y|--yes)
      INTERACTIVE=no
      shift
      continue
     ;;
    --)
      shift
      CONFIGURE_OPTS+=( "$@" )
      shift $#
      continue
     ;;
     *)
      usage
      exit 1
  esac
  shift
done

if [ "$BUILD_CLANG" == "no" ] && [ "$BUILD_ERLANG" == "no" ] && \
   [ "$BUILD_HACK" == "no" ] && [ "$BUILD_JAVA" == "no" ] && \
   [ "$BUILD_PYTHON" == "no" ] && [ "$BUILD_SWIFT" == "no" ]; then
  build_all
fi

# enable --yes option for some commands in non-interactive mode
YES=
if [ "$INTERACTIVE" == "no" ]; then
  YES=--yes
fi
# --yes by default for opam commands except if we are using the user's opam switch
if [ "$INTERACTIVE" == "no" ] || [ "$USER_OPAM_SWITCH" == "no" ]; then
    export OPAMYES=true
fi

setup_opam () {
    opam var root 1>/dev/null 2>/dev/null || opam init --reinit --bare --no-setup &&
    opam_retry opam_switch_create_if_needed "$INFER_OPAM_SWITCH" "$INFER_OPAM_SWITCH_OPTIONS" &&
    opam switch set "$INFER_OPAM_SWITCH"
}

install_opam_deps () {
    local locked=
    if [ "$USE_OPAM_LOCK" == yes ]; then
        locked=.locked
    fi
    opam pin add --no-action stdcompat "$INFER_ROOT"/dependencies/stdcompat
    opam install --deps-only "$INFER_ROOT"/opam/infer.opam$locked
}

echo "initializing opam... " >&2
. "$INFER_ROOT"/scripts/opam_utils.sh
if [ "$USER_OPAM_SWITCH" == "no" ]; then
    setup_opam
fi
eval $(SHELL=bash opam env)
echo >&2
echo "installing infer dependencies; this can take up to 30 minutes... " >&2
opam_retry install_opam_deps

if [ "$ONLY_SETUP_OPAM" == "yes" ]; then
  exit 0
fi

echo "preparing build... " >&2
./autogen.sh > /dev/null

# we want to add these before the ones passed explicitly by the user, if only because they
# correspond to options that appear earlier on the command line of this script so it's the more
# natural behaviour
CONFIGURE_PREPEND_OPTS=""
if [ "$BUILD_CLANG" == "no" ]; then
  CONFIGURE_PREPEND_OPTS+=" --disable-c-analyzers"
fi
if [ "$BUILD_ERLANG" == "no" ]; then
  CONFIGURE_PREPEND_OPTS+=" --disable-erlang-analyzers"
fi
if [ "$BUILD_HACK" == "no" ]; then
  CONFIGURE_PREPEND_OPTS+=" --disable-hack-analyzers"
fi
if [ "$BUILD_JAVA" == "no" ]; then
  CONFIGURE_PREPEND_OPTS+=" --disable-java-analyzers"
fi
if [ "$BUILD_PYTHON" == "no" ]; then
  CONFIGURE_PREPEND_OPTS+=" --disable-python-analyzers"
fi
if [ "$BUILD_SWIFT" == "yes" ]; then
  CONFIGURE_PREPEND_OPTS+=" --enable-swift-analyzers"
fi

set -x
# empty arrays trigger unbound variable errors, use horrible syntax to work around it
./configure $CONFIGURE_PREPEND_OPTS ${CONFIGURE_OPTS[@]+"${CONFIGURE_OPTS[@]}"}
set +x

# test if clang is enabled and if so are we about to build it? we cannot rely on $BUILD_CLANG
# because the user can also set --disable-clang-analyzers
if [ $(grep BUILD_C_ANALYZERS Makefile.autoconf | cut -d ' ' -f 3) = "yes" ]; then
  if ! "$PLUGIN_SETUP" --only-check-install; then
    echo ""
    echo "  Warning: you are not using a release of Infer. The C and"
    echo "  Objective-C analyses require a custom clang to be compiled"
    echo "  now. This step takes ~30-60 minutes, possibly more."
    echo ""
    echo "  To speed this along, you are encouraged to use a release of"
    echo "  Infer instead:"
    echo ""
    echo "  http://fbinfer.com/docs/getting-started"
    echo ""
    echo "  If you are only interested in analyzing Java programs, simply"
    echo "  run this script with only the \"java\" argument:"
    echo ""
    echo "  $0 java"
    echo ""

    confirm="n"
    printf "Are you sure you want to compile clang? (y/N) "
    if [ "$INTERACTIVE" == "no" ]; then
        confirm="y"
        echo "$confirm"
    else
        read confirm
    fi

    if [ "x$confirm" != "xy" ]; then
        exit 0
    fi

    # only run this script if we are definitely building clang
    facebook-clang-plugins/clang/src/prepare_clang_src.sh
  fi
fi

make -j "$JOBS" opt || (
  echo >&2
  echo '  compilation failure; you can try running' >&2
  echo >&2
  echo '    make clean' >&2
  echo "    '$0' $ORIG_ARGS" >&2
  echo >&2
  exit 1)

echo
echo "*** Success! Infer is now built in '$SCRIPT_DIR/infer/bin/'."
echo '*** Install infer on your system with `make install`.'
echo
echo '*** If you plan to hack on infer, check out CONTRIBUTING.md to setup your dev environment.'