Skip to content

Commit

Permalink
Added option to choose version to install (#77)
Browse files Browse the repository at this point in the history 
* addVersionOption

* addVersionOption

* update chooseversion

* Updated install

* deleted check in list

* Re-add comment about "show-progress"

* Changed from spaces to tabs; slight wording changes

* Changed tabs back to spaces

---------

Co-authored-by: Yaron Koren <[email protected]>
  • Loading branch information
@chl178 @yaronkoren
chl178 and yaronkoren authored Feb 5, 2024
1 parent d871918 commit c626b3e
Showing 1 changed file with 166 additions and 52 deletions.
218 changes: 166 additions & 52 deletions install.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,56 +5,170 @@
# This script downloads and installs the Canasta command-line interface (CLI), which is
# an executable called "canasta".

# First it checks for the prerequisites of Git, Docker and Docker Compose, displaying a
# warning to the user if they are not correctly installed; exiting the installer.

# Check if Git is installed; exit if not.
git --version 2>&1 >/dev/null
GIT_IS_AVAILABLE=$?
if [ $GIT_IS_AVAILABLE -ne 0 ];
then echo "Git was not found, please install it before continuing.";
exit;
else
echo "Checking for presence of Git... found."
fi

loc=$(which docker)
if [ -z $loc ]
then
echo "Docker is not installed; please follow the guide at https://docs.docker.com/engine/install/ to install it."
elif [ -x $loc ]
then
echo "Checking for presence of Docker... found."
else
echo "Docker appears to be installed at $loc but is not executable; please check permissions."
fi

# Canasta only supports Compose V2
# Since July 2023 Compose V1 stopped receiving updates. It is also no longer available in new releases of Docker Desktop.
if ! docker compose version >/dev/null 2>&1; then
echo "Docker Compose V2 is not installed"
echo "Please follow the guide at https://docs.docker.com/compose/install/ to install it."
echo "It is recommended to use the official Docker repositories."
echo "Alternatively, set the Compose executable path in canasta CLI using \"canasta -d PATH\" but note that Compose V1 is NOT supported."
PROGNAME=$(basename "$0")
VERSION="latest"

usage() {
cat << EOF >&2
Usage: $PROGNAME [-v <ver>|--version <ver>] [-l|--list]
-v <ver>, --version <ver> : install specific version
-l, --list : list all available versions
* : usage
EOF
exit 1
else
echo "Checking for presence of Docker Compose V2... found."
fi

echo "Downloading Canasta CLI latest release..."
canastaURL="https://github.com/CanastaWiki/Canasta-CLI/releases/latest/download/canasta"
# The show-progress param was added to wget in version 1.16 (October 2014).
wgetOptions=$(wget --help)
if [[ $wgetOptions == *"show-progress"* ]]
then
wget -q --show-progress $canastaURL
else
wget -q $canastaURL
fi

echo "Download was successful; now installing Canasta CLI."
chmod u=rwx,g=xr,o=x canasta
sudo mv canasta /usr/local/bin/canasta

echo "Please make sure you have a working kubectl if you wish to use Kubernetes as an orchestrator."
echo -e "\nUsage: sudo canasta [COMMAND] [ARGUMENTS...]"
}

list_versions() {
echo "Fetching available versions..."
releases=$(wget -qO- "https://api.github.com/repos/CanastaWiki/Canasta-CLI/releases")
versions=$(echo "$releases" | grep -Po '"tag_name": "\K.*?(?=")')

echo "Available versions:"
echo "$versions"
exit 0
}

parse_arguments() {
while [[ $# -gt 0 ]]; do
case "$1" in
-v|--version)
if [[ -z "$2" || $2 == -* ]]; then
echo "No version number provided after '-v' flag."
VERSION=""
shift
else
VERSION="$2"
shift 2
fi
;;
-l|--list)
list_versions
;;
*)
usage
;;
esac
done
}

validate_version() {
local version_to_validate="$1"
if [[ $version_to_validate =~ ^(([0-9]{1,3}[\.]){2}[0-9]{1,3}).* ]]; then
return 0
else
echo "Invalid version number!"
return 1
fi
}
choose_version() {
echo "-----"
echo "Checking the version..."
if [[ -z ${VERSION-} ]] || ! validate_version "$VERSION"; then
while true; do
echo "Enter a valid version number (e.g. 1.2.0):"
read -rp "Version (ENTER for the latest version): " -e VERSION
if [[ $VERSION =~ ^(([0-9]{1,3}[\.]){2}[0-9]{1,3}).* ]]; then
echo "Installing version $VERSION."
break
elif [[ -z $VERSION ]]; then
VERSION="latest"
echo "No version was specified; installing the latest version."
break
else
echo "Invalid version number. Please try again."
fi
done
else
echo "Version $VERSION has already been specified; proceeding with installation."
fi
}
check_dependencies() {
local dependencies=("wget" "git" "docker")
local not_found=()
echo "Checking dependencies..."
for dep in "${dependencies[@]}"; do
if ! command -v "$dep" >/dev/null 2>&1; then
not_found+=("$dep")
fi
done
# Ensure that Docker Compose V2 (i.e., "docker compose") is installed;
# Docker Compose V1 (i.e., "docker-compose") is deprecated as of July 2023.
if ! docker compose version >/dev/null 2>&1; then
not_found+=("Docker Compose V2 (see https://docs.docker.com/compose/install/)")
fi
if [ "${#not_found[@]}" -ne 0 ]; then
echo "The following dependencies are missing:"
for missing in "${not_found[@]}"; do
echo "- $missing"
done
echo "Please install the missing dependencies before continuing."
exit 1
else
echo "All the required dependencies are found."
fi
}
check_wget_show_progress() {
# The show-progress param was added to wget in version 1.16 (October 2014).
wgetOptions=$(wget --help)
if [[ $wgetOptions == *"show-progress"* ]]; then
WGET_SHOW_PROGRESS="--show-progress"
else
WGET_SHOW_PROGRESS=""
fi
}
download_and_install() {
local canasta_url=""
check_wget_show_progress
if [ "$VERSION" == "latest" ]; then
canasta_url="https://github.com/CanastaWiki/Canasta-CLI/releases/latest/download/canasta"
else
canasta_url="https://github.com/CanastaWiki/Canasta-CLI/releases/download/v${VERSION}/canasta"
fi
echo "Downloading Canasta CLI version $VERSION..."
if ! wget -q $WGET_SHOW_PROGRESS "$canasta_url" -O canasta; then
echo "Download failed. The version you specified might not exist."
echo "Please use '-l' or '--list' flag to see the available versions or try again."
rm -f canasta # Delete the 0-byte canasta file
exit 1
fi
echo "Download was successful; now installing Canasta CLI."
chmod u=rwx,g=xr,o=x canasta
sudo mv canasta /usr/local/bin/canasta
if [ $? -ne 0 ]; then
echo "Installation failed. Please try again."
while true; do
read -rp "Do you want to keep the downloaded file? (y/n): " yn
case $yn in
[Yy]* ) break;;
[Nn]* ) rm -f canasta; echo "Downloaded file deleted."; break;;
* ) echo "Please answer yes or no.";;
esac
done
exit 1
fi
echo "Canasta CLI was successfully installed."
}
main() {
check_dependencies
parse_arguments "$@"
choose_version
download_and_install
echo "Please make sure you have a working kubectl if you wish to use Kubernetes as an orchestrator."
echo -e "\nUsage: sudo canasta [COMMAND] [ARGUMENTS...]"
}
main "$@"

0 comments on commit c626b3e

Please sign in to comment.