[lttng-ci.git] / scripts / babeltrace / build.sh

#!/bin/bash
#
# Copyright (C) 2015 Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
# Copyright (C) 2016-2020 Michael Jeanson <mjeanson@efficios.com>
#
# 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 3 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, see <http://www.gnu.org/licenses/>.

set -exu

# Version compare functions
vercomp () {
    set +u
    if [[ "$1" == "$2" ]]; then
        return 0
    fi
    local IFS=.
    # Ignore the shellcheck warning, we want splitting to happen based on IFS.
    # shellcheck disable=SC2206
    local i ver1=($1) ver2=($2)
    # fill empty fields in ver1 with zeros
    for ((i=${#ver1[@]}; i<${#ver2[@]}; i++)); do
        ver1[i]=0
    done
    for ((i=0; i<${#ver1[@]}; i++)); do
        if [[ -z ${ver2[i]} ]]; then
            # fill empty fields in ver2 with zeros
            ver2[i]=0
        fi
        if ((10#${ver1[i]} > 10#${ver2[i]})); then
            return 1
        fi
        if ((10#${ver1[i]} < 10#${ver2[i]})); then
            return 2
        fi
    done
    set -u
    return 0
}

# Shellcheck flags the following functions that are unused as "unreachable",
# ignore that.

# shellcheck disable=SC2317
verlte() {
    vercomp "$1" "$2"
    local res="$?"
    [ "$res" -eq "0" ] || [ "$res" -eq "2" ]
}

# shellcheck disable=SC2317
verlt() {
    vercomp "$1" "$2"; local res="$?"
    [ "$res" -eq "2" ]
}

# shellcheck disable=SC2317
vergte() {
    vercomp "$1" "$2"; local res="$?"
    [ "$res" -eq "0" ] || [ "$res" -eq "1" ]
}

# shellcheck disable=SC2317
vergt() {
    vercomp "$1" "$2"; local res="$?"
    [ "$res" -eq "1" ]
}

# shellcheck disable=SC2317
verne() {
    vercomp "$1" "$2"; local res="$?"
    [ "$res" -ne "0" ]
}

failed_configure() {
    # Assume we are in the configured build directory
    echo "#################### BEGIN config.log ####################"
    cat config.log
    echo "#################### END config.log ####################"
    exit 1
}


# Required variables
WORKSPACE=${WORKSPACE:-}

platform=${platform:-}
conf=${conf:-}
build=${build:-}
cc=${cc:-}

# Controls if the tests are run
BABELTRACE_RUN_TESTS="${BABELTRACE_RUN_TESTS:=yes}"

SRCDIR="$WORKSPACE/src/babeltrace"
TMPDIR="$WORKSPACE/tmp"
PREFIX="/build"

# Create tmp directory
rm -rf "$TMPDIR"
mkdir -p "$TMPDIR"

export TMPDIR
export CFLAGS="-g -O2"

# Set compiler variables
case "$cc" in
gcc)
    export CC=gcc
    export CXX=g++
    ;;
gcc-*)
    export CC=gcc-${cc#gcc-}
    export CXX=g++-${cc#gcc-}
    ;;
clang)
    export CC=clang
    export CXX=clang++
    ;;
clang-*)
    export CC=clang-${cc#clang-}
    export CXX=clang++-${cc#clang-}
    ;;
*)
    if [ "x$cc" != "x" ]; then
	    export CC="$cc"
    fi
    ;;
esac

if [ "x${CC:-}" != "x" ]; then
    echo "Selected compiler:"
    "$CC" -v
fi

# Set platform variables
case "$platform" in
macos*)
    export MAKE=make
    export TAR=tar
    export NPROC="getconf _NPROCESSORS_ONLN"
    export PATH="/opt/local/bin:/opt/local/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"
    export CPPFLAGS="-I/opt/local/include"
    export LDFLAGS="-L/opt/local/lib"
    export PYTHON="python3"
    export PYTHON_CONFIG="python3-config"
    ;;

freebsd*)
    export MAKE=gmake
    export TAR=tar
    export NPROC="getconf _NPROCESSORS_ONLN"
    export CPPFLAGS="-I/usr/local/include"
    export LDFLAGS="-L/usr/local/lib"
    export PYTHON="python3"
    export PYTHON_CONFIG="python3-config"

    # For bt 1.5
    export YACC="bison -y"
    ;;

*)
    export MAKE=make
    export TAR=tar
    export NPROC=nproc
    export PYTHON="python3"
    export PYTHON_CONFIG="python3-config"
    ;;
esac

# Print build env details
print_os || true
print_tooling || true

# Enter the source directory
cd "$SRCDIR"

# Run bootstrap in the source directory prior to configure
./bootstrap

# Get source version from configure script
eval "$(grep '^PACKAGE_VERSION=' ./configure)"
PACKAGE_VERSION=${PACKAGE_VERSION//\-pre*/}

# Enable dev mode by default for BT 2.0 builds
export BABELTRACE_DEBUG_MODE=1
export BABELTRACE_DEV_MODE=1
export BABELTRACE_MINIMAL_LOG_LEVEL=TRACE

# Set configure options and environment variables for each build
# configuration.
CONF_OPTS=("--prefix=$PREFIX")

# -Werror is enabled by default in stable-2.0 but won't be in 2.1
# Explicitly disable it for consistency.
if vergte "$PACKAGE_VERSION" "2.0"; then
	CONF_OPTS+=("--disable-Werror")
fi

case "$conf" in
static)
    echo "Static lib only configuration"

    CONF_OPTS+=("--enable-static" "--disable-shared")

    if vergte "$PACKAGE_VERSION" "2.0"; then
        CONF_OPTS+=("--enable-built-in-plugins")
    fi
    ;;

python-bindings)
    echo "Python bindings configuration"

    CONF_OPTS+=("--enable-python-bindings")

    if vergte "$PACKAGE_VERSION" "2.0"; then
        CONF_OPTS+=("--enable-python-bindings-doc" "--enable-python-plugins")
    fi
    ;;

prod)
    echo "Production configuration"

    # Unset the developper variables
    unset BABELTRACE_DEBUG_MODE
    unset BABELTRACE_DEV_MODE
    unset BABELTRACE_MINIMAL_LOG_LEVEL

    # Enable the python bindings
    CONF_OPTS+=("--enable-python-bindings" "--enable-python-plugins")
    ;;

doc)
    echo "Documentation configuration"

    CONF_OPTS+=("--enable-python-bindings" "--enable-python-bindings-doc" "--enable-python-plugins" "--enable-api-doc")
    ;;

min)
    echo "Minimal configuration"
    ;;

*)
    echo "Standard configuration"

    # Enable the python bindings / plugins by default with babeltrace2,
    # the test suite is mostly useless without it.
    if vergte "$PACKAGE_VERSION" "2.0"; then
        CONF_OPTS+=("--enable-python-bindings" "--enable-python-plugins")
    fi
    ;;
esac

# Build type
# oot     : out-of-tree build
# dist    : build via make dist
# oot-dist: build via make dist out-of-tree
# *       : normal tree build
#
# Make sure to move to the build directory and run configure
# before continuing.
case "$build" in
oot)
    echo "Out of tree build"

    # Create and enter a temporary build directory
    builddir=$(mktemp -d)
    cd "$builddir"

    "$SRCDIR/configure" "${CONF_OPTS[@]}" || failed_configure
    ;;

dist)
    echo "Distribution in-tree build"

    # Run configure and generate the tar file
    # in the source directory
    ./configure || failed_configure
    $MAKE dist

    # Create and enter a temporary build directory
    builddir=$(mktemp -d)
    cd "$builddir"

    # Extract the distribution tar in the build directory,
    # ignore the first directory level
    $TAR xvf "$SRCDIR"/*.tar.* --strip 1

    # Build in extracted source tree
    ./configure "${CONF_OPTS[@]}" || failed_configure
    ;;

oot-dist)
    echo "Distribution out of tree build"

    # Create and enter a temporary build directory
    builddir=$(mktemp -d)
    cd "$builddir"

    # Run configure out of tree and generate the tar file
    "$SRCDIR/configure" || failed_configure
    $MAKE dist

    dist_srcdir="$(mktemp -d)"
    cd "$dist_srcdir"

    # Extract the distribution tar in the new source directory,
    # ignore the first directory level
    $TAR xvf "$builddir"/*.tar.* --strip 1

    # Create and enter a second temporary build directory
    builddir="$(mktemp -d)"
    cd "$builddir"

    # Run configure from the extracted distribution tar,
    # out of the source tree
    "$dist_srcdir/configure" "${CONF_OPTS[@]}" || failed_configure
    ;;

*)
    echo "Standard in-tree build"
    ./configure "${CONF_OPTS[@]}" || failed_configure
    ;;
esac

# We are now inside a configured build directory

# BUILD!
$MAKE -j "$($NPROC)" V=1

# Install in the workspace
$MAKE install DESTDIR="$WORKSPACE"

# Run tests, don't fail now, we want to run the archiving steps
failed_tests=0
if [ "$BABELTRACE_RUN_TESTS" = "yes" ]; then
	$MAKE --keep-going check || failed_tests=1

	# Copy tap logs for the jenkins tap parser before cleaning the build dir
	rsync -a --exclude 'test-suite.log' --include '*/' --include '*.log' --exclude='*' tests/ "$WORKSPACE/tap"

	# The test suite prior to 1.5 did not produce TAP logs
	if verlt "$PACKAGE_VERSION" "1.5"; then
	    mkdir -p "$WORKSPACE/tap/no-log"
	    echo "1..1" > "$WORKSPACE/tap/no-log/tests.log"
	    echo "ok 1 - Test suite doesn't support logging" >> "$WORKSPACE/tap/no-log/tests.log"
	fi
fi

# Clean the build directory
$MAKE clean

# Cleanup rpath in executables and shared libraries
find "$WORKSPACE/$PREFIX/bin" -type f -perm -0500 -exec chrpath --delete {} \;
find "$WORKSPACE/$PREFIX/lib" -name "*.so" -exec chrpath --delete {} \;

# Remove libtool .la files
find "$WORKSPACE/$PREFIX/lib" -name "*.la" -exec rm -f {} \;

# Exit with failure if any of the tests failed
exit $failed_tests

# EOF
Commit	Line	Data
	1	#!/bin/bash
	2	#
	3	# Copyright (C) 2015 Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
	4	# Copyright (C) 2016-2020 Michael Jeanson <mjeanson@efficios.com>
	5	#
	6	# This program is free software: you can redistribute it and/or modify
	7	# it under the terms of the GNU General Public License as published by
	8	# the Free Software Foundation, either version 3 of the License, or
	9	# (at your option) any later version.
	10	#
	11	# This program is distributed in the hope that it will be useful,
	12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	# GNU General Public License for more details.
	15	#
	16	# You should have received a copy of the GNU General Public License
	17	# along with this program. If not, see <http://www.gnu.org/licenses/>.
	18
	19	set -exu
	20
	21	# Version compare functions
	22	vercomp () {
	23	set +u
	24	if [[ "$1" == "$2" ]]; then
	25	return 0
	26	fi
	27	local IFS=.
	28	# Ignore the shellcheck warning, we want splitting to happen based on IFS.
	29	# shellcheck disable=SC2206
	30	local i ver1=($1) ver2=($2)
	31	# fill empty fields in ver1 with zeros
	32	for ((i=${#ver1[@]}; i<${#ver2[@]}; i++)); do
	33	ver1[i]=0
	34	done
	35	for ((i=0; i<${#ver1[@]}; i++)); do
	36	if [[ -z ${ver2[i]} ]]; then
	37	# fill empty fields in ver2 with zeros
	38	ver2[i]=0
	39	fi
	40	if ((10#${ver1[i]} > 10#${ver2[i]})); then
	41	return 1
	42	fi
	43	if ((10#${ver1[i]} < 10#${ver2[i]})); then
	44	return 2
	45	fi
	46	done
	47	set -u
	48	return 0
	49	}
	50
	51	# Shellcheck flags the following functions that are unused as "unreachable",
	52	# ignore that.
	53
	54	# shellcheck disable=SC2317
	55	verlte() {
	56	vercomp "$1" "$2"
	57	local res="$?"
	58	[ "$res" -eq "0" ] \|\| [ "$res" -eq "2" ]
	59	}
	60
	61	# shellcheck disable=SC2317
	62	verlt() {
	63	vercomp "$1" "$2"; local res="$?"
	64	[ "$res" -eq "2" ]
	65	}
	66
	67	# shellcheck disable=SC2317
	68	vergte() {
	69	vercomp "$1" "$2"; local res="$?"
	70	[ "$res" -eq "0" ] \|\| [ "$res" -eq "1" ]
	71	}
	72
	73	# shellcheck disable=SC2317
	74	vergt() {
	75	vercomp "$1" "$2"; local res="$?"
	76	[ "$res" -eq "1" ]
	77	}
	78
	79	# shellcheck disable=SC2317
	80	verne() {
	81	vercomp "$1" "$2"; local res="$?"
	82	[ "$res" -ne "0" ]
	83	}
	84
	85	failed_configure() {
	86	# Assume we are in the configured build directory
	87	echo "#################### BEGIN config.log ####################"
	88	cat config.log
	89	echo "#################### END config.log ####################"
	90	exit 1
	91	}
	92
	93
	94	# Required variables
	95	WORKSPACE=${WORKSPACE:-}
	96
	97	platform=${platform:-}
	98	conf=${conf:-}
	99	build=${build:-}
	100	cc=${cc:-}
	101
	102	# Controls if the tests are run
	103	BABELTRACE_RUN_TESTS="${BABELTRACE_RUN_TESTS:=yes}"
	104
	105	SRCDIR="$WORKSPACE/src/babeltrace"
	106	TMPDIR="$WORKSPACE/tmp"
	107	PREFIX="/build"
	108
	109	# Create tmp directory
	110	rm -rf "$TMPDIR"
	111	mkdir -p "$TMPDIR"
	112
	113	export TMPDIR
	114	export CFLAGS="-g -O2"
	115
	116	# Set compiler variables
	117	case "$cc" in
	118	gcc)
	119	export CC=gcc
	120	export CXX=g++
	121	;;
	122	gcc-*)
	123	export CC=gcc-${cc#gcc-}
	124	export CXX=g++-${cc#gcc-}
	125	;;
	126	clang)
	127	export CC=clang
	128	export CXX=clang++
	129	;;
	130	clang-*)
	131	export CC=clang-${cc#clang-}
	132	export CXX=clang++-${cc#clang-}
	133	;;
	134	*)
	135	if [ "x$cc" != "x" ]; then
	136	export CC="$cc"
	137	fi
	138	;;
	139	esac
	140
	141	if [ "x${CC:-}" != "x" ]; then
	142	echo "Selected compiler:"
	143	"$CC" -v
	144	fi
	145
	146	# Set platform variables
	147	case "$platform" in
	148	macos*)
	149	export MAKE=make
	150	export TAR=tar
	151	export NPROC="getconf _NPROCESSORS_ONLN"
	152	export PATH="/opt/local/bin:/opt/local/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin"
	153	export CPPFLAGS="-I/opt/local/include"
	154	export LDFLAGS="-L/opt/local/lib"
	155	export PYTHON="python3"
	156	export PYTHON_CONFIG="python3-config"
	157	;;
	158
	159	freebsd*)
	160	export MAKE=gmake
	161	export TAR=tar
	162	export NPROC="getconf _NPROCESSORS_ONLN"
	163	export CPPFLAGS="-I/usr/local/include"
	164	export LDFLAGS="-L/usr/local/lib"
	165	export PYTHON="python3"
	166	export PYTHON_CONFIG="python3-config"
	167
	168	# For bt 1.5
	169	export YACC="bison -y"
	170	;;
	171
	172	*)
	173	export MAKE=make
	174	export TAR=tar
	175	export NPROC=nproc
	176	export PYTHON="python3"
	177	export PYTHON_CONFIG="python3-config"
	178	;;
	179	esac
	180
	181	# Print build env details
	182	print_os \|\| true
	183	print_tooling \|\| true
	184
	185	# Enter the source directory
	186	cd "$SRCDIR"
	187
	188	# Run bootstrap in the source directory prior to configure
	189	./bootstrap
	190
	191	# Get source version from configure script
	192	eval "$(grep '^PACKAGE_VERSION=' ./configure)"
	193	PACKAGE_VERSION=${PACKAGE_VERSION//\-pre*/}
	194
	195	# Enable dev mode by default for BT 2.0 builds
	196	export BABELTRACE_DEBUG_MODE=1
	197	export BABELTRACE_DEV_MODE=1
	198	export BABELTRACE_MINIMAL_LOG_LEVEL=TRACE
	199
	200	# Set configure options and environment variables for each build
	201	# configuration.
	202	CONF_OPTS=("--prefix=$PREFIX")
	203
	204	# -Werror is enabled by default in stable-2.0 but won't be in 2.1
	205	# Explicitly disable it for consistency.
	206	if vergte "$PACKAGE_VERSION" "2.0"; then
	207	CONF_OPTS+=("--disable-Werror")
	208	fi
	209
	210	case "$conf" in
	211	static)
	212	echo "Static lib only configuration"
	213
	214	CONF_OPTS+=("--enable-static" "--disable-shared")
	215
	216	if vergte "$PACKAGE_VERSION" "2.0"; then
	217	CONF_OPTS+=("--enable-built-in-plugins")
	218	fi
	219	;;
	220
	221	python-bindings)
	222	echo "Python bindings configuration"
	223
	224	CONF_OPTS+=("--enable-python-bindings")
	225
	226	if vergte "$PACKAGE_VERSION" "2.0"; then
	227	CONF_OPTS+=("--enable-python-bindings-doc" "--enable-python-plugins")
	228	fi
	229	;;
	230
	231	prod)
	232	echo "Production configuration"
	233
	234	# Unset the developper variables
	235	unset BABELTRACE_DEBUG_MODE
	236	unset BABELTRACE_DEV_MODE
	237	unset BABELTRACE_MINIMAL_LOG_LEVEL
	238
	239	# Enable the python bindings
	240	CONF_OPTS+=("--enable-python-bindings" "--enable-python-plugins")
	241	;;
	242
	243	doc)
	244	echo "Documentation configuration"
	245
	246	CONF_OPTS+=("--enable-python-bindings" "--enable-python-bindings-doc" "--enable-python-plugins" "--enable-api-doc")
	247	;;
	248
	249	min)
	250	echo "Minimal configuration"
	251	;;
	252
	253	*)
	254	echo "Standard configuration"
	255
	256	# Enable the python bindings / plugins by default with babeltrace2,
	257	# the test suite is mostly useless without it.
	258	if vergte "$PACKAGE_VERSION" "2.0"; then
	259	CONF_OPTS+=("--enable-python-bindings" "--enable-python-plugins")
	260	fi
	261	;;
	262	esac
	263
	264	# Build type
	265	# oot : out-of-tree build
	266	# dist : build via make dist
	267	# oot-dist: build via make dist out-of-tree
	268	# * : normal tree build
	269	#
	270	# Make sure to move to the build directory and run configure
	271	# before continuing.
	272	case "$build" in
	273	oot)
	274	echo "Out of tree build"
	275
	276	# Create and enter a temporary build directory
	277	builddir=$(mktemp -d)
	278	cd "$builddir"
	279
	280	"$SRCDIR/configure" "${CONF_OPTS[@]}" \|\| failed_configure
	281	;;
	282
	283	dist)
	284	echo "Distribution in-tree build"
	285
	286	# Run configure and generate the tar file
	287	# in the source directory
	288	./configure \|\| failed_configure
	289	$MAKE dist
	290
	291	# Create and enter a temporary build directory
	292	builddir=$(mktemp -d)
	293	cd "$builddir"
	294
	295	# Extract the distribution tar in the build directory,
	296	# ignore the first directory level
	297	$TAR xvf "$SRCDIR"/.tar. --strip 1
	298
	299	# Build in extracted source tree
	300	./configure "${CONF_OPTS[@]}" \|\| failed_configure
	301	;;
	302
	303	oot-dist)
	304	echo "Distribution out of tree build"
	305
	306	# Create and enter a temporary build directory
	307	builddir=$(mktemp -d)
	308	cd "$builddir"
	309
	310	# Run configure out of tree and generate the tar file
	311	"$SRCDIR/configure" \|\| failed_configure
	312	$MAKE dist
	313
	314	dist_srcdir="$(mktemp -d)"
	315	cd "$dist_srcdir"
	316
	317	# Extract the distribution tar in the new source directory,
	318	# ignore the first directory level
	319	$TAR xvf "$builddir"/.tar. --strip 1
	320
	321	# Create and enter a second temporary build directory
	322	builddir="$(mktemp -d)"
	323	cd "$builddir"
	324
	325	# Run configure from the extracted distribution tar,
	326	# out of the source tree
	327	"$dist_srcdir/configure" "${CONF_OPTS[@]}" \|\| failed_configure
	328	;;
	329
	330	*)
	331	echo "Standard in-tree build"
	332	./configure "${CONF_OPTS[@]}" \|\| failed_configure
	333	;;
	334	esac
	335
	336	# We are now inside a configured build directory
	337
	338	# BUILD!
	339	$MAKE -j "$($NPROC)" V=1
	340
	341	# Install in the workspace
	342	$MAKE install DESTDIR="$WORKSPACE"
	343
	344	# Run tests, don't fail now, we want to run the archiving steps
	345	failed_tests=0
	346	if [ "$BABELTRACE_RUN_TESTS" = "yes" ]; then
	347	$MAKE --keep-going check \|\| failed_tests=1
	348
	349	# Copy tap logs for the jenkins tap parser before cleaning the build dir
	350	rsync -a --exclude 'test-suite.log' --include '/' --include '.log' --exclude='*' tests/ "$WORKSPACE/tap"
	351
	352	# The test suite prior to 1.5 did not produce TAP logs
	353	if verlt "$PACKAGE_VERSION" "1.5"; then
	354	mkdir -p "$WORKSPACE/tap/no-log"
	355	echo "1..1" > "$WORKSPACE/tap/no-log/tests.log"
	356	echo "ok 1 - Test suite doesn't support logging" >> "$WORKSPACE/tap/no-log/tests.log"
	357	fi
	358	fi
	359
	360	# Clean the build directory
	361	$MAKE clean
	362
	363	# Cleanup rpath in executables and shared libraries
	364	find "$WORKSPACE/$PREFIX/bin" -type f -perm -0500 -exec chrpath --delete {} \;
	365	find "$WORKSPACE/$PREFIX/lib" -name "*.so" -exec chrpath --delete {} \;
	366
	367	# Remove libtool .la files
	368	find "$WORKSPACE/$PREFIX/lib" -name "*.la" -exec rm -f {} \;
	369
	370	# Exit with failure if any of the tests failed
	371	exit $failed_tests
	372
	373	# EOF