Flexibilize release asset selection #2

AZMCode · 2020-05-25T17:58:23Z

The plugin can now adjust to naming convention flexibility in stedolan/jq's release names.
Fixes #1

The plugin can now select between various files available in a release in a smarter way. Fixes #1

AZMCode · 2020-05-25T18:03:32Z

Tested that it worked in Ubuntu 64-bits.
The amount of errors printed when you try to download a nonexistent release might be a bit too much, and so might need a bit of work.

Edit: This happens because each function used in the process logs its own error. There might be better ways to handle this, but no obvious ones I can see without sacrificing useful error output, given bash's lack of error handling capability.

AZMCode

Commented and explained the changes done in the commit.

AZMCode · 2020-06-02T18:00:29Z

bin/install

@@ -8,6 +8,7 @@ set -o nounset
 set -o pipefail

 readonly BINARY_NAME="jq"
+readonly RELEASES_URL="https://api.github.com/repos/stedolan/jq/releases"


Added constant for RELEASES_URL in the same way the list-all script does

AZMCode · 2020-06-02T18:01:08Z

bin/install

@@ -18,23 +19,109 @@ error_exit() {
  exit "${2:-1}"
 }

-platform() {
+get_platform() {


Renamed the platform() function to get_platform(), in line with other functions added in the PR

AZMCode · 2020-06-02T18:02:01Z

bin/install

  local -r os=$(
    case "$(uname | tr '[:upper:]' '[:lower:]')" in
      darwin) echo "osx" ;;
      *) echo "linux" ;;
    esac
  )

-  echo "${os}-amd64"
+  echo "${os}"


Since this function is no longer responsible of directly choosing the release asset to be installed, it now only returns the platform name, either osx or linux

AZMCode · 2020-06-02T18:03:01Z

bin/install

 }
+get_arch(){


The get_arch() function returns the architecture of the system, returning '32' for x86 and compatibles, as well as '64' for x86_64

error_exits if the release if uname -m does not return one of x86_64, i386, or i686

AZMCode · 2020-06-02T18:06:26Z

bin/install

+  return
+}
+
+get_assets_url() {


The function get_assets_url(install_version) returns the Github API endpoint that itself returns all available assets for a given release. This is done by querying the releases URL, extracting an array of all 'assets_url' and 'tag_name' properties within the json returned, putting them in two arrays, and correlating the two arrays.

Hacky solution, but it seems to work, given the absence of jq in the runtime system at the time of execution.

error_exits on a release not found.

Have not tested what happens when the input is an empty string.

AZMCode · 2020-06-02T18:15:32Z

bin/install

+  done
+  error_exit 'Given version did not match any releases. Try list-all to see available options'
+}
+find_all_asset_names() {


find_all_asset_names(install_version) calls get_assets_url($install_version) to get the endpoint for the release of the given version, then extracts the values of all 'name' properties within the JSON, and returns them in an array.

Due to the way arrays work in bash scripting, unexpected behaviors might happen is a release asset contains a space in its name.

AZMCode · 2020-06-02T18:23:21Z

bin/install

+  echo ${asset_names[@]}
+  return
+}
+filter_assets() {


filter_assets(inArr,platform,arch) takes an array of release asset names, and returns all that match the given platform and architecture as an array.

The platform argument takes any value returned by get_platform(), and the arch argument takes any value returned by get_arch(). Other values have not been tested.

Values which do not match the following perl-style regexes are excluded:

$platform.*((86(?!_64))|32) for an arch value of 32

$platform.*(64) for an arch value of 64

AZMCode · 2020-06-02T18:29:09Z

bin/install

+  done
+  echo "${outArr[@]}"
+}
+find_file_name() {


The function find_file_name(install_version) returns a fitting release asset for the given install_version, calling find_all_asset_names($install_version) to get all available assets in the given version, then filtering them with filter_assets.

If no fitting assets are returned from the previouslt called functions, it will error_exit, listing the platform and architecture.

If a single fitting asset is encountered, it returns the asset name silently.

If more than one fitting asset is encountered, it logs to stderr to let the user know that multiple useable assets were found, and returns the first one found.

AZMCode · 2020-06-02T18:32:57Z

bin/install

 install() {
  local -r install_type="$1"
  local -r install_version="$2"
  local -r install_path="$3"
  local -r install_path_bin="${install_path}/bin"
-  local -r download_url="${DOWNLOAD_BASE_URL}/${install_version}/${BINARY_NAME}-$(platform)"
+  declare file_name="$(find_file_name "$install_version")"


Here the install(install_type,install_version,install_path) function is modified to, before defining the local download_url variable, call find_file_name($install_version) to find out if there exists a fitting asset.

If no asset is found, install now error_exits.

If an asset is found, the file_name variable now contains the needed string, which is then used to complete download_url, and the function proceeds as normal.

AZMCode · 2020-06-02T18:33:41Z

bin/install

Accidental newline. What is the standard in this project on newlines at the end of files?

AZMCode · 2020-08-10T12:05:51Z

Why would it fail on macOS?
Can someone with a mac help me debug?

Program now takes version input and output without jq prepended. In progress of achieving OSX compatibility

Signed-off-by: AZMCode <adrianozambrana@protonmail.com>

…KEN. Don't get any ideas, the pass is already revoked XD Signed-off-by: AZMCode <adrianozambrana@protonmail.com>

Added github token usage on respective curl calls, and removed eval from list-all

Smarter release asset selection

827ab50

The plugin can now select between various files available in a release in a smarter way. Fixes #1

AZMCode commented Jun 2, 2020

View reviewed changes

AZMCode changed the title ~~Smarter release asset selection~~ Flexibilize release asset selection Jun 2, 2020

AZMCode marked this pull request as draft August 10, 2020 12:06

AZMCode force-pushed the patch-1 branch from 273bf2f to 1716fc5 Compare August 11, 2020 19:52

AZMCode added 2 commits August 11, 2020 20:58

This is a combination of 32 commits.

313ffc1

Program now takes version input and output without jq prepended. In progress of achieving OSX compatibility

Some more tweaks and debugging

6c24ffe

Signed-off-by: AZMCode <adrianozambrana@protonmail.com>

AZMCode force-pushed the patch-1 branch from 8b747ef to 6c24ffe Compare August 12, 2020 01:00

AZMCode added 2 commits August 11, 2020 21:03

Tweaked a couple more things

6ec2568

Signed-off-by: AZMCode <adrianozambrana@protonmail.com>

PAT is no longer on the codebase, instead grabbing it from $GITHUB_TO…

3927021

…KEN. Don't get any ideas, the pass is already revoked XD Signed-off-by: AZMCode <adrianozambrana@protonmail.com>

AZMCode marked this pull request as ready for review October 5, 2020 18:38

AZMCode added 17 commits December 4, 2020 14:53

Added manual trigger to Github CI workflow

f55782f

Workaround allowing set-env until asdf-vm/actions can fix it.

04aea56

Small changes in ./bin/install

3ae9bcf

debugging

6f95175

debugging

0923f56

Added step to install curl before testing

ba4ba96

Fixed Ubuntu Command

9f8d118

Fixed noop

1682539

Turns out curl had nothing to do with it.

3b7527a

Removed curl check

42daf7c

Removed authentication as author from both scripts

69327df

Removed environment declaration

2f691d5

Removed schedule from CI

4b1cf46

Deleted extraneous log file

204e26f

Re-added github api token because of asdf-vm's guidellines

cb423bd

Fixed command

7f930e5

debugging macos

14936c0

AZMCode added 16 commits December 4, 2020 17:38

debugging

4a3f4c8

debugging

043ff4b

Bash for macos

acd574c

Using index iterable loop

3c73e15

debugging

b34db38

debugging

ff169c5

debugging

8fcb91b

debugging

a492cd9

debugging

8274f32

Separated declaration and initialization for arrays

a3abe3e

Silencing git over hex tag names

0b17e33

Fix for previous commit

b8f81fb

POSIX-compliant regex attempt

aca2bae

Corrected character class syntax

d8a013d

Couple Fixes

c0a0171

Added github token usage on respective curl calls, and removed eval from list-all

Attempt at fixing headerful curl requests

504e394

AZMCode mentioned this pull request Dec 4, 2020

Installation on osx fails #6

Closed

AZMCode closed this Dec 5, 2020

AZMCode deleted the patch-1 branch December 5, 2020 14:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Flexibilize release asset selection #2

Flexibilize release asset selection #2

AZMCode commented May 25, 2020 •

edited

Loading

AZMCode commented May 25, 2020 •

edited

Loading

AZMCode left a comment •

edited

Loading

AZMCode Jun 2, 2020 •

edited

Loading

AZMCode Jun 2, 2020

AZMCode Jun 2, 2020

AZMCode Jun 2, 2020

AZMCode Jun 2, 2020

AZMCode Jun 2, 2020

AZMCode Jun 2, 2020

AZMCode Jun 2, 2020

AZMCode Jun 2, 2020

AZMCode Jun 2, 2020

AZMCode commented Aug 10, 2020

		}
		get_arch(){

Flexibilize release asset selection #2

Flexibilize release asset selection #2

Conversation

AZMCode commented May 25, 2020 • edited Loading

AZMCode commented May 25, 2020 • edited Loading

AZMCode left a comment • edited Loading

Choose a reason for hiding this comment

AZMCode Jun 2, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AZMCode commented Aug 10, 2020

AZMCode commented May 25, 2020 •

edited

Loading

AZMCode commented May 25, 2020 •

edited

Loading

AZMCode left a comment •

edited

Loading

AZMCode Jun 2, 2020 •

edited

Loading