2913: download-latest: some refactoring r=curquiza a=nfsec

# Pull Request

## What does this PR do?
- Usually the elevation of variables.

## PR checklist
Please check if your PR fulfills the following requirements:
- [X] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [X] Have you read the contributing guidelines?
- [X] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: Patryk Krawaczyński <nfsec@users.noreply.github.com>
Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>
This commit is contained in:
bors[bot] 2022-10-17 13:21:36 +00:00 committed by GitHub
commit 96acbf815d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,17 +1,26 @@
#!/bin/sh #!/bin/sh
# COLORS # GLOBALS
# Colors
RED='\033[31m' RED='\033[31m'
GREEN='\033[32m' GREEN='\033[32m'
DEFAULT='\033[0m' DEFAULT='\033[0m'
# GLOBALS # Project name
GREP_SEMVER_REGEXP='v\([0-9]*\)[.]\([0-9]*\)[.]\([0-9]*\)$' # i.e. v[number].[number].[number] PNAME='meilisearch'
# Version regexp i.e. v[number].[number].[number]
GREP_SEMVER_REGEXP='v\([0-9]*\)[.]\([0-9]*\)[.]\([0-9]*\)$'
# GitHub API address
GITHUB_API='https://api.github.com/repos/meilisearch/meilisearch/releases'
# GitHub Release address
GITHUB_REL='https://github.com/meilisearch/meilisearch/releases/download/'
# FUNCTIONS # FUNCTIONS
# semverParseInto and semverLT from https://github.com/cloudflare/semver_bash/blob/master/semver.sh # semverParseInto and semverLT from: https://github.com/cloudflare/semver_bash/blob/master/semver.sh
# usage: semverParseInto version major minor patch special # usage: semverParseInto version major minor patch special
# version: the string version # version: the string version
# major, minor, patch, special: will be assigned by the function # major, minor, patch, special: will be assigned by the function
@ -67,16 +76,22 @@ semverLT() {
return 1 return 1
} }
# Get a token from https://github.com/settings/tokens to increase rate limit (from 60 to 5000), make sure the token scope is set to 'public_repo' # Get a token from: https://github.com/settings/tokens to increase rate limit (from 60 to 5000),
# Create GITHUB_PAT environment variable once you acquired the token to start using it # make sure the token scope is set to 'public_repo'.
# Returns the tag of the latest stable release (in terms of semver and not of release date) # Create GITHUB_PAT environment variable once you acquired the token to start using it.
# Returns the tag of the latest stable release (in terms of semver and not of release date).
get_latest() { get_latest() {
temp_file='temp_file' # temp_file needed because the grep would start before the download is over # temp_file is needed because the grep would start before the download is over
temp_file=$(mktemp -q /tmp/$PNAME.XXXXXXXXX)
if [ $? -ne 0 ]; then
echo "$0: Can't create temp file, bye bye.."
exit 1
fi
if [ -z "$GITHUB_PAT" ]; then if [ -z "$GITHUB_PAT" ]; then
curl -s 'https://api.github.com/repos/meilisearch/meilisearch/releases' > "$temp_file" || return 1 curl -s $GITHUB_API > "$temp_file" || return 1
else else
curl -H "Authorization: token $GITHUB_PAT" -s 'https://api.github.com/repos/meilisearch/meilisearch/releases' > "$temp_file" || return 1 curl -H "Authorization: token $GITHUB_PAT" -s $GITHUB_API > "$temp_file" || return 1
fi fi
releases=$(cat "$temp_file" | \ releases=$(cat "$temp_file" | \
@ -89,28 +104,35 @@ get_latest() {
latest='' latest=''
current_tag='' current_tag=''
for release_info in $releases; do for release_info in $releases; do
if [ $i -eq 0 ]; then # Checking tag_name # Checking tag_name
if echo "$release_info" | grep -q "$GREP_SEMVER_REGEXP"; then # If it's not an alpha or beta release if [ $i -eq 0 ]; then
# If it's not an alpha or beta release
if echo "$release_info" | grep -q "$GREP_SEMVER_REGEXP"; then
current_tag=$release_info current_tag=$release_info
else else
current_tag='' current_tag=''
fi fi
i=1 i=1
elif [ $i -eq 1 ]; then # Checking draft boolean # Checking draft boolean
elif [ $i -eq 1 ]; then
if [ "$release_info" = 'true' ]; then if [ "$release_info" = 'true' ]; then
current_tag='' current_tag=''
fi fi
i=2 i=2
elif [ $i -eq 2 ]; then # Checking prerelease boolean # Checking prerelease boolean
elif [ $i -eq 2 ]; then
if [ "$release_info" = 'true' ]; then if [ "$release_info" = 'true' ]; then
current_tag='' current_tag=''
fi fi
i=0 i=0
if [ "$current_tag" != '' ]; then # If the current_tag is valid # If the current_tag is valid
if [ "$latest" = '' ]; then # If there is no latest yet if [ "$current_tag" != '' ]; then
# If there is no latest yes
if [ "$latest" = '' ]; then
latest="$current_tag" latest="$current_tag"
else else
semverLT $current_tag $latest # Comparing latest and the current tag # Comparing latest and the current tag
semverLT $current_tag $latest
if [ $? -eq 1 ]; then if [ $? -eq 1 ]; then
latest="$current_tag" latest="$current_tag"
fi fi
@ -123,7 +145,7 @@ get_latest() {
return 0 return 0
} }
# Gets the OS by setting the $os variable # Gets the OS by setting the $os variable.
# Returns 0 in case of success, 1 otherwise. # Returns 0 in case of success, 1 otherwise.
get_os() { get_os() {
os_name=$(uname -s) os_name=$(uname -s)
@ -143,7 +165,7 @@ get_os() {
return 0 return 0
} }
# Gets the architecture by setting the $archi variable # Gets the architecture by setting the $archi variable.
# Returns 0 in case of success, 1 otherwise. # Returns 0 in case of success, 1 otherwise.
get_archi() { get_archi() {
architecture=$(uname -m) architecture=$(uname -m)
@ -152,7 +174,8 @@ get_archi() {
archi='amd64' archi='amd64'
;; ;;
'arm64') 'arm64')
if [ $os = 'macos' ]; then # MacOS M1 # MacOS M1
if [ $os = 'macos' ]; then
archi='amd64' archi='amd64'
else else
archi='aarch64' archi='aarch64'
@ -171,9 +194,9 @@ success_usage() {
printf "$GREEN%s\n$DEFAULT" "Meilisearch $latest binary successfully downloaded as '$binary_name' file." printf "$GREEN%s\n$DEFAULT" "Meilisearch $latest binary successfully downloaded as '$binary_name' file."
echo '' echo ''
echo 'Run it:' echo 'Run it:'
echo ' $ ./meilisearch' echo " $ ./$PNAME"
echo 'Usage:' echo 'Usage:'
echo ' $ ./meilisearch --help' echo " $ ./$PNAME --help"
} }
not_available_failure_usage() { not_available_failure_usage() {
@ -189,52 +212,55 @@ fetch_release_failure_usage() {
echo 'Please let us know about this issue: https://github.com/meilisearch/meilisearch/issues/new/choose' echo 'Please let us know about this issue: https://github.com/meilisearch/meilisearch/issues/new/choose'
} }
# MAIN fill_release_variables() {
# Fill $latest variable.
# Fill $latest variable
if ! get_latest; then if ! get_latest; then
fetch_release_failure_usage # TO CHANGE # TO CHANGE.
fetch_release_failure_usage
exit 1 exit 1
fi fi
if [ "$latest" = '' ]; then if [ "$latest" = '' ]; then
fetch_release_failure_usage fetch_release_failure_usage
exit 1 exit 1
fi fi
# Fill $os variable.
# Fill $os variable
if ! get_os; then if ! get_os; then
not_available_failure_usage not_available_failure_usage
exit 1 exit 1
fi fi
# Fill $archi variable.
# Fill $archi variable
if ! get_archi; then if ! get_archi; then
not_available_failure_usage not_available_failure_usage
exit 1 exit 1
fi fi
}
download_binary() {
fill_release_variables
echo "Downloading Meilisearch binary $latest for $os, architecture $archi..." echo "Downloading Meilisearch binary $latest for $os, architecture $archi..."
case "$os" in case "$os" in
'windows') 'windows')
release_file="meilisearch-$os-$archi.exe" release_file="$PNAME-$os-$archi.exe"
binary_name='meilisearch.exe' binary_name="$PNAME.exe"
;; ;;
*) *)
release_file="meilisearch-$os-$archi" release_file="$PNAME-$os-$archi"
binary_name='meilisearch' binary_name="$PNAME"
esac esac
# Fetch the Meilisearch binary.
# Fetch the Meilisearch binary curl --fail -OL "$GITHUB_REL/$latest/$release_file"
link="https://github.com/meilisearch/meilisearch/releases/download/$latest/$release_file"
curl --fail -OL "$link"
if [ $? -ne 0 ]; then if [ $? -ne 0 ]; then
fetch_release_failure_usage fetch_release_failure_usage
exit 1 exit 1
fi fi
mv "$release_file" "$binary_name" mv "$release_file" "$binary_name"
chmod 744 "$binary_name" chmod 744 "$binary_name"
success_usage success_usage
}
# MAIN
main() {
download_binary
}
main