lib.sh

#!/usr/bin/env bash
#
# Copyright (c) 2017-2020 Intel Corporation
# Copyright (c) 2018 ARM Limited
#
# SPDX-License-Identifier: Apache-2.0
#

export KATA_KSM_THROTTLER=${KATA_KSM_THROTTLER:-no}
export KATA_QEMU_DESTDIR=${KATA_QEMU_DESTDIR:-"/usr"}
export KATA_ETC_CONFIG_PATH="/etc/kata-containers/configuration.toml"

export katacontainers_repo=${katacontainers_repo:="github.com/kata-containers/kata-containers"}
export katacontainers_repo_git="https://${katacontainers_repo}.git"
export katacontainers_repo_dir="${GOPATH}/src/${katacontainers_repo}"
export kata_default_branch="${kata_default_branch:-main}"
export CI_JOB="${CI_JOB:-}"
export CROSS_BUILD="${CROSS_BUILD:-false}"
export ARCH="${ARCH:-$(uname -m)}"

# Name of systemd service for the throttler
KATA_KSM_THROTTLER_JOB="kata-ksm-throttler"

# How long do we wait for docker to perform a task before we
# timeout with the presumption it has hung.
# Docker itself has a 10s timeout, so make our timeout longer
# than that. Measured in seconds by default (see timeout(1) for
# more formats).
export KATA_DOCKER_TIMEOUT=30

# Number of seconds to wait for a general network operation to complete.
export KATA_NET_TIMEOUT=30

source /etc/os-release || source /usr/lib/os-release

# Ensure GOPATH set
if command -v go > /dev/null; then
	export GOPATH=${GOPATH:-$(go env GOPATH)}
else
	# if go isn't installed, set default location for GOPATH
	export GOPATH="${GOPATH:-$HOME/go}"
fi

# Support Golang 1.16.x.
# By default in Golang >= 1.16 GO111MODULE is set to "on",
# some subprojects in this repo may not support "go modules",
# set GO111MODULE to "auto" to enable module-aware mode only when
# a go.mod file is present in the current directory.
export GO111MODULE="auto"

if [ "$(uname -m)" == "s390x" ] && grep -Eq "\<(fedora|suse)\>" /etc/os-release 2> /dev/null; then
	# see https://github.com/kata-containers/osbuilder/issues/217
	export CC=gcc
fi

tests_repo="${tests_repo:-github.com/kata-containers/tests}"
lib_script="${GOPATH}/src/${tests_repo}/lib/common.bash"
source "${lib_script}"

# Jenkins master URL
jenkins_url="http://jenkins.katacontainers.io"
# Path where cached artifacts are found.
cached_artifacts_path="lastSuccessfulBuild/artifact/artifacts"

# Info for running local registry
registry_port="${REGISTRY_PORT:-5000}"
registry_name="kata-registry"
container_engine="${USE_PODMAN:+podman}"
container_engine="${container_engine:-docker}"
# We cannot use Podman's and Kubernetes' CNI at the same time, but Podman uses k8s' namespace
if [ "${container_engine}" == "podman" ]; then
	stress_image="localhost/stress-kata:latest"
	stress_image_pull_policy="Never"
else
	stress_image="localhost:${registry_port}/stress-kata:latest"
	stress_image_pull_policy="Always"
fi

# Some tests will start a local registry server for container images.
# Use this function to clean up the server container after its use.
registry_server_teardown() {
	[ -n "$container_engine" ] || \
		die "Do not know what container engine to use."
	[ -n "$registry_name" ] || \
		die "Do not know the container registry name."

	local is_running="$(sudo -E ${container_engine} ps -a | \
		grep -c "${registry_name}")"
	if [ "${is_running}" -gt 0 ]; then
		info "remove local registry server: ${registry_name}"
		sudo -E "${container_engine}" rm -f \
			"${registry_name}" &>/dev/null
	fi
}

# Clone repo only if $katacontainers_repo_dir is empty
# Otherwise, we assume $katacontainers_repo is cloned and in correct branch, e.g. a PR or local change
clone_katacontainers_repo() {
	add_repo_to_git_safe_directory "${katacontainers_repo_dir}"

	if [ ! -d "${katacontainers_repo_dir}" ]; then
		mkdir -p "${katacontainers_repo_dir}"
		git clone ${katacontainers_repo_git} "${katacontainers_repo_dir}" || true
		pushd "${katacontainers_repo_dir}"
		# Checkout to default branch
		git checkout "${kata_default_branch}"
		popd
	fi
}

function build_version() {
	github_project="$1"
	make_target="$2"
	version="$3"

	[ -z "${version}" ] && die "need version to build"

	project_dir="${GOPATH}/src/${github_project}"

	if [ -d "${project_dir}" ]; then
		mkdir -p ${project_dir}
		git clone "https://${github_project}.git" ${project_dir} || true
	fi

	pushd "${project_dir}"

	if [ "$version" != "HEAD" ]; then
		info "Using ${github_project} version ${version}"
		git checkout -b "${version}" "${version}"
	fi

	info "Building ${github_project}"
	if [ ! -f Makefile ]; then
		if [ -f autogen.sh ]; then
			info "Run autogen.sh to generate Makefile"
			bash -f autogen.sh
		fi
	fi

	if [ -f Makefile ]; then
		make ${make_target}
	else
		# install locally (which is what "go get" does by default)
		go install ./...
	fi

	popd
}

function build() {
	github_project="$1"
	make_target="$2"
	version="${3:-"HEAD"}"

	build_version "${github_project}" "${make_target}" "${version}"
}

# Build the artifact tarball using kata-deploy build scripts then uncompress
# it.
#
# Parameters:
#	$1 - artifact name. For example, qemu, qemu-tdx, rootfs-image,
#	     and so on.
#
# Environment variables:
#	DESTDIR - where to uncompress the tarball, by default is '/'.
#
function build_static_artifact_and_install() {
	local artifact="${1:-}"
	local destdir="${DESTDIR:-/}"
	local make_target="${artifact}-tarball"
	local tarball="kata-static-${artifact}.tar.xz"

	clone_katacontainers_repo

	pushd "$katacontainers_repo_dir" >/dev/null
	sudo -E PATH=$PATH make "$make_target"
	sudo tar -xvJpf "build/${tarball}" -C "${destdir}"
	sudo rm -rf "build/"
	popd >/dev/null
}

function get_dep_from_yaml_db(){
	local versions_file="$1"
	local dependency="$2"

	[ ! -f "$versions_file" ] && die "cannot find $versions_file"

	"${GOPATH}/src/${tests_repo}/.ci/install_yq.sh" >&2

	result=$("${GOPATH}/bin/yq" r -X "$versions_file" "$dependency")
	[ "$result" = "null" ] && result=""
	echo "$result"
}

function get_version(){
	dependency="$1"
	versions_file="${katacontainers_repo_dir}/versions.yaml"
	if [ ! -d "${katacontainers_repo_dir}" ]; then
		mkdir -p "$(dirname ${katacontainers_repo_dir})"
		git clone --quiet ${katacontainers_repo_git} "${katacontainers_repo_dir}"
		( cd "${katacontainers_repo_dir}" && git checkout "$kata_default_branch" >&2 )
	fi
	get_dep_from_yaml_db "${versions_file}" "${dependency}"
}

function add_repo_to_git_safe_directory(){
	local repo="$1"
	if [ -z "$repo" ]; then
		local_info "BUG[add_repo_to_git_safe_directory]: No repo specified"
		return 1
	fi
	# Note: git config --global --add safe.directory will always
	# append the target to .gitconfig without checking the
	# existence of the target,
	# so it's better to check it before adding the target repo.
	local sd="$(git config --global --get safe.directory ${repo} || true)"
	if [ "${sd}" == "" ]; then
		echo "Add repo ${repo} to git's safe.directory"
		git config --global --add safe.directory "${repo}"
	else
		echo "Repo ${repo} already in git's safe.directory"
	fi
}

function get_test_version(){
	local dependency="$1"

	local db
	local cidir

	# directory of this script, not the caller
	local cidir=$(dirname "${BASH_SOURCE[0]}")

	db="${cidir}/../versions.yaml"

	get_dep_from_yaml_db "${db}" "${dependency}"
}

kill_stale_process()
{
	clean_env_ctr
	extract_kata_env
	stale_process_union=( "${stale_process_union[@]}" "${HYPERVISOR_PATH}" "${SHIM_PATH}" )
	for stale_process in "${stale_process_union[@]}"; do
		[ -z "${stale_process}" ] && continue
		local pids=$(pgrep -d ' ' -f "${stale_process}")
		if [ -n "$pids" ]; then
			sudo kill -9 ${pids} || true
		fi
	done
}

delete_stale_docker_resource()
{
	sudo systemctl stop docker.service docker.socket

	# before removing stale docker dir, you should umount related resource
	for stale_docker_mount_point in "${stale_docker_mount_point_union[@]}"; do
		local mount_point_union=$(mount | grep "${stale_docker_mount_point}" | awk '{print $3}')
		if [ -n "${mount_point_union}" ]; then
			while IFS='$\n' read mount_point; do
				[ -n "$(grep "${mount_point}" "/proc/mounts")" ] && sudo umount -R "${mount_point}"
			done <<< "${mount_point_union}"
		fi
	done
	# remove stale docker dir
	for stale_docker_dir in "${stale_docker_dir_union[@]}"; do
		if [ -d "${stale_docker_dir}" ]; then
			sudo rm -rf "${stale_docker_dir}"
		fi
	done

	sudo systemctl disable docker.service docker.socket
	sudo rm -f /etc/systemd/system/{docker.service,docker.socket}
}

delete_stale_kata_resource()
{
	for stale_kata_dir in "${stale_kata_dir_union[@]}"; do
		if [ -d "${stale_kata_dir}" ]; then
			sudo rm -rf "${stale_kata_dir}"
		fi
	done
}

delete_kata_repo_registrations()
{
	case "$ID" in
		ubuntu)
			local apt_file="/etc/apt/sources.list.d/kata-containers.list"
			if [ -f "$apt_file" ]; then
				info "Removing Kata apt file [$apt_file]"
				sudo rm -f "$apt_file"
			fi

			sudo apt-key list | grep 'home:katacontainers' > /dev/null
			if [ $? -eq 0 ]; then
				# apt-key output format changed at ubuntu 16.10
				if [ "$VERSION_ID" \< "16.10" ]; then
					kata_uuid="$(sudo apt-key list | awk '$2=="home:katacontainers" {print prev} {prev=$2}')"
					kata_uuid="${kata_uuid##*/}"
				else
					kata_uuid="$(sudo apt-key list | awk '$4=="home:katacontainers" {print prev} {prev=$0}')"
				fi

				if [ -n "$kata_uuid" ]; then
					info "Removing Kata apt key [$kata_uuid]"
					sudo apt-key del "$kata_uuid"
				else
					die "Failed to parse apt-key output for [$ID][$VERSION_ID]"
				fi
			else
				info "No katacontainers key found - not removing"
			fi
			;;

		*) info "Do not know how to clean repos from distro [$ID]";;
	esac
}

delete_crio_stale_resource() {
	# stale cri-o related binary
	sudo rm -rf /usr/local/bin/crio
	sudo sh -c 'rm -rf /usr/local/libexec/crio/*'
	sudo rm -rf /usr/local/bin/crio-runc
	# stale cri-o related configuration
	sudo rm -rf /etc/crio/crio.conf
	sudo rm -rf /usr/local/share/oci-umount/oci-umount.d/crio-umount.conf
	sudo rm -rf /etc/crictl.yaml
	# stale cri-o systemd service file
	sudo rm -rf /etc/systemd/system/crio.service
}

delete_containerd_cri_stale_resource() {
	# stop containerd service
	sudo systemctl stop containerd
	# remove stale binaries
	containerd_cri_dir=$(get_version "externals.containerd.url")
	release_bin_dir="${GOPATH}/src/${containerd_cri_dir}/bin"
	binary_dir_union=( "/usr/local/bin" "/usr/local/sbin" )
	for binary_dir in ${binary_dir_union[@]}
	do
		for stale_binary in ${release_bin_dir}/*
		do
			sudo rm -rf ${binary_dir}/$(basename ${stale_binary})
		done
	done
	# remove cluster directory
	sudo rm -rf /opt/containerd/
	# remove containerd home/run directory
	sudo rm -r /var/lib/containerd
	sudo rm -r /var/lib/containerd-test
	sudo rm -r /run/containerd
	sudo rm -r /run/containerd-test
	# remove configuration files
	sudo rm -f /etc/containerd/config.toml
	sudo rm -f /etc/crictl.yaml
	sudo rm -f /etc/systemd/system/containerd.service
}

cleanup_network_interface() {
	local FLANNEL=$(ls /sys/class/net | grep flannel)
	local CNI=$(ls /sys/class/net | grep cni)

	[ "$FLANNEL" != "" ] && sudo ip link del $FLANNEL
	[ "$CNI" != "" ] && sudo ip link del $CNI

	FLANNEL=$(ls /sys/class/net | grep flannel)
	CNI=$(ls /sys/class/net | grep cni)

	[ "$FLANNEL" != "" ] && info "$FLANNEL doesn't clean up"
	[ "$CNI" != "" ] && info "$CNI doesn't clean up"
}

gen_clean_arch() {
	# For metrics CI we are removing unnecessary steps like
	# removing packages, removing CRI-O, etc mainly because
	# they do not exist on metrics CI
	if [[ $CI_JOB != "METRICS" ]]; then
		# Set up some vars
		stale_process_union=( "docker-containerd-shim" )
		#docker supports different storage driver, such like overlay2, aufs, etc.
		docker_storage_driver=$(timeout ${KATA_DOCKER_TIMEOUT} docker info --format='{{.Driver}}')
		stale_docker_mount_point_union=( "/var/lib/docker/containers" "/var/lib/docker/${docker_storage_driver}" )
		stale_docker_dir_union=( "/var/lib/docker" )
		stale_kata_dir_union=( "/var/lib/vc" "/run/vc" "/usr/share/kata-containers" "/usr/share/defaults/kata-containers"  "/opt/kata/share/kata-containers" "/opt/kata/share/defaults/kata-containers" )

		info "kill stale process"
		kill_stale_process
		if [ -z "${USE_PODMAN}" ]; then
			info "delete stale docker resource under ${stale_docker_dir_union[@]}"
			delete_stale_docker_resource
		fi
	fi

	info "remove containers started by ctr"
	clean_env_ctr

	# reset k8s service may impact metrics test on x86_64
	[ $(uname -m) != "x86_64" -a "$(pgrep kubelet)" != "" ] && sudo sh -c 'kubeadm reset -f'
	info "Remove installed kubernetes packages and configuration"
	if [ "$ID" == ubuntu ]; then
		sudo rm -rf /etc/systemd/system/kubelet.service.d
		sudo systemctl daemon-reload
		sudo apt-get autoremove -y kubeadm kubelet kubectl
		sudo apt install -y curl make git
	fi

	# Remove existing k8s related configurations and binaries.
	sudo sh -c 'rm -rf /opt/cni/bin/*'
	sudo sh -c 'rm -rf /etc/cni /etc/kubernetes/'
	sudo sh -c 'rm -rf /var/lib/cni /var/lib/etcd /var/lib/kubelet'
	sudo sh -c 'rm -rf /run/flannel'

	if [[ $CI_JOB != "METRICS" ]]; then
		info "delete stale kata resource under ${stale_kata_dir_union[@]}"
		delete_stale_kata_resource
		info "Remove installed kata packages"
		${GOPATH}/src/${tests_repo}/cmd/kata-manager/kata-manager.sh remove-packages
		info "Remove installed cri-o related binaries and configuration"
		delete_crio_stale_resource
		info "Remove installed containerd-cri related binaries and configuration"
		delete_containerd_cri_stale_resource

		if [ "$ID" == ubuntu ]; then
			sudo apt-get autoremove -y $(dpkg -l | awk '{print $2}' | grep -E '^(containerd(.\io)?|docker(\.io|-ce(-cli)?))$')
		fi

		info "Clean up stale network interface"
		cleanup_network_interface

		info "Remove Kata package repo registrations"
		delete_kata_repo_registrations
	fi

	info "Clean GOCACHE"
	if command -v go > /dev/null; then
		GOCACHE=${GOCACHE:-$(go env GOCACHE)}
	else
		# if go isn't installed, try default dir
		GOCACHE=${GOCACHE:-$HOME/.cache/go-build}
	fi
	[ -d "$GOCACHE" ] && sudo rm -rf ${GOCACHE}/*

	info "Clean transient test data and logs which has been stored under ${KATA_TESTS_BASEDIR}"
	[ -d "${KATA_TESTS_BASEDIR}" ] && sudo rm -rf ${KATA_TESTS_BASEDIR}/*

	info "Clean rust environment"
	[ -f "${HOME}/.cargo/env" ] && source "${HOME}/.cargo/env"
	if command -v rustup > /dev/null; then
		info "uninstall rust using rustup"
		sudo -E env PATH="${HOME}/.cargo/bin":$PATH rustup self uninstall -y
	fi
	# make sure cargo and rustup home dir are removed
	info "remove cargo and rustup home dir"
	sudo rm -rf ~/.cargo ~/.rustup
}

check_git_version() {
	result="true"

        local required_version_major=$(echo "$1" | cut -d. -f1)
        local required_version_medium=$(echo "$1" | cut -d. -f2)
        local required_version_minor=$(echo "$1" | cut -d. -f3)

        local git_version=$(git version | cut -d' ' -f3)
        [ -n "${git_version}" ] || die "cannot determine git version, please ensure it is installed"

        local current_version_major=$(echo "${git_version}" | cut -d. -f1)
        local current_version_medium=$(echo "${git_version}" | cut -d. -f2)
        local current_version_minor=$(echo "${git_version}" | cut -d. -f3)

        [[ ${current_version_major} -lt ${required_version_major} ]] || \
        [[ ( ${current_version_major} -eq ${required_version_major} ) && ( ${current_version_medium} -lt ${required_version_medium} ) ]] || \
        [[ ( ${current_version_major} -eq ${required_version_major} ) && ( ${current_version_medium} -eq ${required_version_medium} ) && ( ${current_version_minor} -lt ${required_version_minor} ) ]] && \
        result="false"

	echo "${result}"
}

# Obtain a list of the files the PR changed.
# Returns the information in format "${filter}\t${file}".
get_pr_changed_file_details_full()
{
	# List of filters used to restrict the types of file changes.
	# See git-diff-tree(1) for further info.
	local filters=""

	# Added file
	filters+="A"

	# Copied file
	filters+="C"

	# Modified file
	filters+="M"

	# Renamed file
	filters+="R"

	# Unmerged (U) and Unknown (X) files. These particular filters
	# shouldn't be necessary but just in case...
	filters+="UX"

	git diff-tree \
		-r \
		--name-status \
		--diff-filter="${filters}" \
		"origin/${branch}" HEAD
}

# Obtain a list of the files the PR changed, ignoring vendor files.
# Returns the information in format "${filter}\t${file}".
get_pr_changed_file_details()
{
	get_pr_changed_file_details_full | grep -v "vendor/"
}


# Gets a list of files and/or directories to build a SHA-256 from their contents.
# Returns the SHA-256 hash if succeeded, otherwise an empty string.
sha256sum_from_files() {
	local files_in=${@:-}
	local files=""
	local shasum=""

	# Process the input files:
	#  - discard the files/directories that don't exist.
	#  - find the files if it is a directory
	for f in $files_in; do
		if [ -d "$f" ]; then
			files+=" $(find $f -type f)"
		elif [ -f "$f" ]; then
			files+=" $f"
		fi
	done
	# Return in case there is none input files.
	[ -n "$files" ] || return 0

	# Alphabetically sorting the files.
	files="$(echo $files | tr ' ' '\n' | LC_ALL=C sort -u)"
	# Concate the files and calculate a hash.
	shasum="$(cat $files | sha256sum -b)" || true
	if [ -n "$shasum" ];then
		# Return only the SHA field.
		echo $(awk '{ print $1 }' <<< $shasum)
	fi
}

# Calculate a SHA-256 from all the files used to build QEMU.
# Use this function to detect changes on build scripts which should force a
# local build of QEMU.
#
# Note: bear in mind it is not used a comprehensive list of files but only
# those that seems sufficient to detect changes. For example, this script is
# sourced by many others but it is not considered.
calc_qemu_files_sha256sum() {
	local pkg_dir="${katacontainers_repo_dir}/tools/packaging"
	local files="${pkg_dir}/qemu \
		${pkg_dir}/static-build/qemu \
		${pkg_dir}/static-build/qemu.blacklist \
		${pkg_dir}/static-build/scripts \
		${pkg_dir}/scripts"

	sha256sum_from_files $files
}

# Outputs to stdout the environment variables of the current script.
print_environment() {
	if [ -n "$(command -v env)" ]
	then
		echo environment variables for $(basename "$0"):
		env
		echo "#########################################"
	fi
}

info()
{
	local msg="$*"
	echo "INFO: ${msg}"
}

# We have a local info func, as many of our funcs return their answers via stdout,
# and we don't want to either open code a redirect all over the code nor send to
# the standard stdout (would corrupt our return strings) or stderr (some CIs would
# take that as a failure case). So, use another file descriptor, mapped back to
# stdout, that we set up previously.
local_info() {
	msg="$*"
	info "$msg" >&5
}

# Install jq package
install_jq() {
	local cmd="jq"
	local package="$cmd"

	command -v "$cmd" &>/dev/null && return 0 || true

	case "$ID" in
		centos|rhel)
			sudo yum -y install "${package}" 1>&5 2>&1
			;;
		ubuntu)
			sudo apt-get -y install "${package}" 1>&5 2>&1
			;;
		opensuse-*|sles)
			sudo zypper install -y "${package}" 1>&5 2>&1
			;;
		fedora)
			sudo dnf -y install "${package}" 1>&5 2>&1
			;;
	esac
}

# Check if the specified label is set on a PR.
#
# Returns on stdout as string:
#
#  0 - Label not found.
#  1 - Label found.
is_label_set() {
	local repo="${1:-}"
	local pr="${2:-}"
	local label="${3:-}"

	if [ -z "$repo" ]; then
		local_info "BUG: No repo specified"
		echo "0"
		return 0
	fi

	if [ -z "$pr" ]; then
		local_info "BUG: No PR specified"
		echo "0"
		return 0
	fi

	if [ -z "$label" ]; then
		local_info "BUG: No label to check specified"
		echo "0"
		return 0
	fi

	local_info "Checking labels for PR ${repo}/${pr}"

	local testing_mode=0

	# If this function was called by a shunit2 function (with the standard
	# function name prefix), we're running as part of the unit tests
	[ "${#FUNCNAME[@]}" -gt 1 ] && grep -q "^\(lib_\)\?test" <<< "${FUNCNAME[1]}" && testing_mode=1

	if [ "$testing_mode" -eq 1 ]
	then
		# Always fail
		echo "1"
		return 0
	else
		# Pull the label list for the PR
		# Ideally we'd use a github auth token here so we don't get rate limited, but to do that we would
		# have to expose the token into the CI scripts, which is then potentially a security hole.
		local json=$(curl -sL "https://api.github.com/repos/${repo}/issues/${pr}/labels")

		install_jq

		# Pull the label list out
		local labels=$(jq '.[].name' <<< $json)

		# Check if we have the forcing label set
		for x in $labels; do
			# Strip off any surrounding '"'s
			y=$(sed 's/"//g' <<< $x)

			[ "$y" == "$label" ] && echo "1" && return 0
		done

		echo "0"
		return 0
	fi
}

check_label() {
	local label="${1:-}"

	if [ -z "$label" ]; then
		local_info "BUG: No label to check specified"
		echo "0"
		return 0
	fi

	if [ -z "$ghprbGhRepository" ]; then
		local_info "No ghprbGhRepository set, skip label check"
		echo "0"
		return 0
	fi

	if [ -z "$ghprbPullId" ]; then
		local_info "No ghprbPullId set, skip label check"
		echo "0"
		return 0
	fi

	repo="$ghprbGhRepository"
	pr="$ghprbPullId"

	local result=$(is_label_set "$repo" "$pr" "$label")
	if [ "$result" -eq 1 ]; then
		local_info "label '$label' found"
		echo "1"
		return 0
	fi

	local_info "label '$label' not found"
	echo "0"
	return 0

}

# We don't want to have a main fucntion to trigger unit tests in this library,
# so prepend these tests with `lib_`, so they can be easily called elsewhere
testIsLabelSet() {
	local result=""

	result=$(is_label_set "" "" "")
	assertEquals "0" "$result"

	result=$(is_label_set "repo" "" "")
	assertEquals "0" "$result"

	result=$(is_label_set "repo" "pr" "")
	assertEquals "0" "$result"

	result=$(is_label_set "" "pr" "label")
	assertEquals "0" "$result"

	result=$(is_label_set "repo" "" "label")
	assertEquals "0" "$result"

	result=$(is_label_set "repo" "pr" "label")
	assertEquals "1" "$result"
}

testCheckLabel() {
	local result=""

	result=$(check_label "")
	assertEquals "0" "$result"

	result=$(unset ghprbGhRepository; check_label "label")
	assertEquals "0" "$result"

	result=$(unset ghprbPullId; check_label "label")
	assertEquals "0" "$result"

	result=$(unset ghprbGhRepository ghprbPullId; check_label "label")
	assertEquals "0" "$result"

	# Pretend label not found
	result=$(is_label_set() { echo "0"; return 0; }; \
	                ghprbGhRepository="repo"; \
	                ghprbPullId=123; \
	                check_label "label")
	assertEquals "0" "$result"

	# Pretend label found
	result=$(is_label_set() { echo "1"; return 0; }; \
	                ghprbGhRepository="repo"; \
	                ghprbPullId=123; \
	                check_label "label")
	assertEquals "1" "$result"
}

# Run our self tests. Tests are written using the
# github.com/kward/shunit2 library, and are encoded into functions starting
# with the string 'test'.
self_test() {
	local shunit2_path="https://github.com/kward/shunit2.git"
	local_info "Running self tests"

	local_info "Clone unit test framework from ${shunit2_path}"
	pushd "${GOPATH}/src/"
	git clone "${shunit2_path}" || true
	popd
	local_info "Run the unit tests"

	# Sourcing the `shunit2` file automatically runs the unit tests in this file.
	. "${GOPATH}/src/shunit2/shunit2"
	# shunit2 call does not return - it exits with its return code.
}

help()
{
	script_name="${0##*/}"
	cat <<EOF
Usage: ${script_name} [test]

Passing the argument 'test' to this script will cause it to only
run its self tests.
EOF

	exit 0
}

main() {
	# Some of our sub-funcs return their results on stdout, but we also want them to be
	# able to log INFO messages. But, we don't want those going to stderr, as that may
	# be seen by some CIs as an actual error. Create another file descriptor, mapped
	# back to stdout, for us to send INFO messages to...
	exec 5>&1

	if [ "$1" == "test" ]; then
		self_test
		# self_test func does not return
	fi

	[ $# -gt 0 ] && help
}

[ "$0" == "$BASH_SOURCE" ] && main "$@" || true