[ci] Be more informative if install-package-dependencies fails
Also, use a temporary directory to avoid polluting the checkout and
move the logic to a shell script (no real change from the yaml file,
but this script has got big enough that it doesn't feel like it should
be inlined any more).
Splitting out into a shell script means a bit of extra work, because
we have to pass Azure Pipeline variables through to the script. Use
proper command line arguments, rather than environment variables, to
make it a bit more obvious what's going on.
Signed-off-by: Rupert Swarbrick <rswarbrick@lowrisc.org>
diff --git a/ci/install-package-dependencies.sh b/ci/install-package-dependencies.sh
new file mode 100755
index 0000000..0e772d5
--- /dev/null
+++ b/ci/install-package-dependencies.sh
@@ -0,0 +1,136 @@
+#!/bin/bash
+# Copyright lowRISC contributors.
+# Licensed under the Apache License, Version 2.0, see LICENSE for details.
+# SPDX-License-Identifier: Apache-2.0
+
+set -e
+
+usage()
+{
+ echo "Usage: install-package-dependencies.sh --verilator-version V"
+ echo " --openocd-version V"
+ echo " --verible-version V"
+ exit 1
+}
+
+error()
+{
+ echo >&2 "$@"
+ exit 1
+}
+
+long="verilator-version:,openocd-version:,verible-version:"
+ARGS="$(getopt -o "" -l "$long" -- "$@")" || usage
+
+VERILATOR_VERSION=
+OPENOCD_VERSION=
+VERIBLE_VERSION=
+
+eval set -- "$ARGS"
+while :
+do
+ case "$1" in
+ --verilator-version) VERILATOR_VERSION="$2"; shift 2 ;;
+ --openocd-version) OPENOCD_VERSION="$2"; shift 2 ;;
+ --verible-version) VERIBLE_VERSION="$2"; shift 2 ;;
+ --) shift; break ;;
+ *) error "getopt / case statement mismatch"
+ esac
+done
+
+# Check that we've seen all the expected versions
+test -n "$VERILATOR_VERSION" || error "Missing --verilator-version"
+test -n "$OPENOCD_VERSION" || error "Missing --openocd-version"
+test -n "$VERIBLE_VERSION" || error "Missing --verible-version"
+
+# Check that there aren't any positional arguments
+test $# = 0 || error "Unexpected positional arguments"
+
+CI_DIR="$(dirname "$(readlink -e "$BASH_SOURCE")")"
+REPO_TOP="$(readlink -e "$CI_DIR/..")"
+
+cd "$REPO_TOP"
+
+# Use apt-fast if available for faster installation.
+if command -v apt-fast >/dev/null; then
+ APT_CMD=apt-fast
+else
+ APT_CMD=apt-get
+fi
+
+TMPDIR="$(mktemp -d)" || {
+ error "Failed to create temporary directory"
+}
+trap 'rm -rf "$TMPDIR"' EXIT
+
+
+# Install verilator from experimental OBS repository
+# apt-requirements.txt doesn't cover this dependency as we don't support
+# using the repository below for anything but our CI (yet).
+lsb_sr="$(lsb_release -sr)"
+OBS_URL="https://download.opensuse.org/repositories"
+OBS_PATH="/home:/phiwag:/edatools/xUbuntu_${lsb_sr}"
+REPO_URL="${OBS_URL}${OBS_PATH}"
+
+EDATOOLS_REPO_KEY="${REPO_URL}/Release.key"
+EDATOOLS_REPO="deb ${REPO_URL}/ /"
+
+curl -f -sL -o "$TMPDIR/obs.asc" "$EDATOOLS_REPO_KEY" || {
+ error "Failed to download repository key from ${REPO_URL}"
+}
+echo "$EDATOOLS_REPO" > "$TMPDIR/obs.list"
+
+sudo mv "$TMPDIR/obs.asc" /etc/apt/trusted.gpg.d/obs.asc
+sudo mv "$TMPDIR/obs.list" /etc/apt/sources.list.d/edatools.list
+
+# Ensure apt package index is up-to-date.
+sudo $APT_CMD update || {
+ error "Failed to run apt update"
+}
+
+ci_reqs="$TMPDIR/apt-requirements-ci.txt"
+cp apt-requirements.txt "$ci_reqs"
+echo "verilator-${VERILATOR_VERSION}" >> "$ci_reqs"
+echo "openocd-${OPENOCD_VERSION}" >> "$ci_reqs"
+echo rsync >> "$ci_reqs"
+
+# NOTE: We use sed to remove all comments from apt-requirements-ci.txt,
+# since apt-get/apt-fast doesn't actually provide such a feature.
+sed -i -e '/^$/d' -e '/^#/d' -e 's/#.*//' "$ci_reqs"
+
+echo "Amended apt-requirements:"
+cat "$ci_reqs"
+
+xargs sudo $APT_CMD install -y <"$ci_reqs"
+
+# Python requirements are installed to the local user directory so prepend
+# appropriate bin directory to the PATH
+export PATH=$HOME/.local/bin:$PATH
+
+# Explicitly updating pip and setuptools is required to have these tools
+# properly parse Python-version metadata, which some packages uses to
+# specify that an older version of a package must be used for a certain
+# Python version. If that information is not read, pip installs the latest
+# version, which then fails to run.
+python3 -m pip install --user -U pip setuptools
+
+pip3 install --user -r python-requirements.txt
+
+# Install Verible
+lsb_sc="$(lsb_release -sc)"
+VERIBLE_BASE_URL="https://github.com/google/verible/releases/download"
+VERIBLE_TARBALL="verible-${VERIBLE_VERSION}-Ubuntu-${lsb_sr}-${lsb_sc}-x86_64.tar.gz"
+VERIBLE_URL="${VERIBLE_BASE_URL}/${VERIBLE_VERSION}/${VERIBLE_TARBALL}"
+
+verible_tar="$TMPDIR/verible.tar.gz"
+
+curl -f -Ls -o "$verible_tar" "${VERIBLE_URL}" || {
+ error "Failed to download verible from ${VERIBLE_URL}"
+}
+
+sudo mkdir -p /tools/verible
+sudo chmod 777 /tools/verible
+tar -C /tools/verible -xf "$verible_tar" --strip-components=1
+
+# Propagate PATH changes to all subsequent steps of the job
+echo "##vso[task.setvariable variable=PATH]/tools/verible/bin:$PATH"
diff --git a/ci/install-package-dependencies.yml b/ci/install-package-dependencies.yml
index cc41ff6..64faae0 100644
--- a/ci/install-package-dependencies.yml
+++ b/ci/install-package-dependencies.yml
@@ -23,58 +23,9 @@
steps:
- bash: |
set -e
-
- # Use apt-fast if available for faster installation.
- if command -v apt-fast >/dev/null; then
- APT_CMD=apt-fast
- else
- APT_CMD=apt-get
- fi
-
- cd "${{ parameters.REPO_TOP }}"
-
- # Install verilator from experimental OBS repository
- # apt-requirements.txt doesn't cover this dependency as we don't support
- # using the repository below for anything but our CI (yet).
- EDATOOLS_REPO_KEY="https://download.opensuse.org/repositories/home:phiwag:edatools/xUbuntu_$(lsb_release -sr)/Release.key"
- EDATOOLS_REPO="deb http://download.opensuse.org/repositories/home:/phiwag:/edatools/xUbuntu_$(lsb_release -sr)/ /"
- curl -sL "$EDATOOLS_REPO_KEY" | sudo apt-key add -
- sudo sh -c "echo \"$EDATOOLS_REPO\" > /etc/apt/sources.list.d/edatools.list"
-
- cp apt-requirements.txt apt-requirements-ci.txt
- echo "verilator-$(VERILATOR_VERSION)" >> apt-requirements-ci.txt
- echo "openocd-$(OPENOCD_VERSION)" >> apt-requirements-ci.txt
- echo rsync >> apt-requirements-ci.txt
- cat apt-requirements-ci.txt
-
- # Ensure apt package index is up-to-date.
- sudo $APT_CMD update
-
- # NOTE: We use sed to remove all comments from apt-requirements-ci.txt,
- # since apt-get/apt-fast doesn't actually provide such a feature.
- sed 's/#.*//' apt-requirements-ci.txt \
- | xargs sudo $APT_CMD install -y
-
- # Python requirements are installed to the local user directory so prepend
- # appropriate bin directory to the PATH
- export PATH=$HOME/.local/bin:$PATH
-
- # Explicitly updating pip and setuptools is required to have these tools
- # properly parse Python-version metadata, which some packages uses to
- # specify that an older version of a package must be used for a certain
- # Python version. If that information is not read, pip installs the latest
- # version, which then fails to run.
- python3 -m pip install --user -U pip setuptools
-
- pip3 install --user -r python-requirements.txt
-
- # Install Verible
- mkdir -p build/verible
- cd build/verible
- curl -Ls -o verible.tar.gz "https://github.com/google/verible/releases/download/$(VERIBLE_VERSION)/verible-$(VERIBLE_VERSION)-Ubuntu-$(lsb_release -sr)-$(lsb_release -sc)-x86_64.tar.gz"
- sudo mkdir -p /tools/verible && sudo chmod 777 /tools/verible
- tar -C /tools/verible -xf verible.tar.gz --strip-components=1
-
- # Propagate PATH changes to all subsequent steps of the job
- echo "##vso[task.setvariable variable=PATH]/tools/verible/bin:$PATH"
+ cd ${{ parameters.REPO_TOP }}
+ ci/install-package-dependencies.sh \
+ --verilator-version $(VERILATOR_VERSION) \
+ --openocd-version $(OPENOCD_VERSION) \
+ --verible-version $(VERIBLE_VERSION)
displayName: 'Install package dependencies'
