mirror of
https://github.com/asdf-vm/asdf.git
synced 2024-11-15 09:38:16 -07:00
Unify .tool-versions and legacy file search
This commit is contained in:
Kevin Rockwood
parent
16f3fa9f03
commit
c6d814e247
162
lib/utils.sh
162
lib/utils.sh
@ -67,118 +67,82 @@ display_error() {
|
||||
echo >&2 $1
|
||||
}
|
||||
|
||||
get_version_file_path_for() {
|
||||
local tool_name=$1
|
||||
local legacy_version_file_support=$(get_asdf_config_value "legacy_version_file")
|
||||
find_version_file_for() {
|
||||
local plugin_name=$1
|
||||
|
||||
if [ ! -f "$(pwd)/.tool-versions" ] && [ "$legacy_version_file_support" = "yes" ]; then
|
||||
# Check for legacy version and return "" if it exists
|
||||
local legacy_version=$(get_tool_version_from_legacy_file $tool_name $(pwd))
|
||||
if [ "$legacy_version" != "" ]; then
|
||||
echo ""
|
||||
return 1
|
||||
fi
|
||||
fi
|
||||
|
||||
echo $(get_asdf_versions_file_path)
|
||||
}
|
||||
|
||||
get_asdf_versions_file_path() {
|
||||
local asdf_tool_versions_path=""
|
||||
local plugin_path=$(get_plugin_path "$plugin_name")
|
||||
local legacy_config=$(get_asdf_config_value "legacy_version_file")
|
||||
local legacy_list_filenames_script="${plugin_path}/bin/list-legacy-filenames"
|
||||
local search_path=$(pwd)
|
||||
|
||||
if [ "$legacy_config" = "yes" ] && [ -f $legacy_list_filenames_script ]; then
|
||||
local legacy_filenames=$(bash "$legacy_list_filenames_script")
|
||||
echo $(search_filenames ".tool-versions $legacy_filenames" "$search_path")
|
||||
else
|
||||
echo $(search_filenames ".tool-versions" "$search_path")
|
||||
fi
|
||||
}
|
||||
|
||||
search_filenames() {
|
||||
local filenames=$1
|
||||
local search_path=$2
|
||||
|
||||
while [ "$search_path" != "/" ]; do
|
||||
if [ -f "$search_path/.tool-versions" ]; then
|
||||
asdf_tool_versions_path="$search_path/.tool-versions"
|
||||
break
|
||||
fi
|
||||
for filename in $filenames; do
|
||||
if [ -f "$search_path/$filename" ]; then
|
||||
echo "$search_path/$filename"
|
||||
return 0
|
||||
fi
|
||||
done
|
||||
search_path=$(dirname "$search_path")
|
||||
done
|
||||
|
||||
echo $asdf_tool_versions_path
|
||||
}
|
||||
|
||||
parse_asdf_version_file() {
|
||||
local file_path=$1
|
||||
local plugin_name=$2
|
||||
|
||||
cat $file_path | while read -r line || [[ -n "$line" ]]; do
|
||||
local line_parts=($line)
|
||||
|
||||
if [ "${line_parts[0]}" = "$plugin_name" ]; then
|
||||
echo ${line_parts[1]}
|
||||
return 0
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
parse_legacy_version_file() {
|
||||
local file_path=$1
|
||||
local plugin_name=$2
|
||||
|
||||
local plugin_path=$(get_plugin_path "$plugin_name")
|
||||
local parse_legacy_script="${plugin_path}/bin/parse-legacy-file"
|
||||
|
||||
if [ -f $parse_legacy_script ]; then
|
||||
echo $(bash "$parse_legacy_script" "$file_path")
|
||||
else
|
||||
echo $(cat $file_path)
|
||||
fi
|
||||
}
|
||||
|
||||
parse_version_file() {
|
||||
local file_path=$1
|
||||
local plugin_name=$2
|
||||
|
||||
if [ $(basename $file_path) = ".tool-versions" ]; then
|
||||
echo $(parse_asdf_version_file "$file_path" "$plugin_name")
|
||||
else
|
||||
echo $(parse_legacy_version_file "$file_path" "$plugin_name")
|
||||
fi
|
||||
}
|
||||
|
||||
get_preset_version_for() {
|
||||
local tool_name=$1
|
||||
local asdf_versions_path=$(get_asdf_versions_file_path)
|
||||
local matching_tool_version=""
|
||||
local legacy_version_file_support=$(get_asdf_config_value "legacy_version_file")
|
||||
|
||||
# If .tool-versions is not in the working directory
|
||||
if [ "$asdf_versions_path" != "$(pwd)/.tool-versions" ] && [ "$legacy_version_file_support" = "yes" ]; then
|
||||
# Check for legacy version file
|
||||
matching_tool_version=$(get_tool_version_from_legacy_file $tool_name $(pwd))
|
||||
fi
|
||||
|
||||
# If no legacy version file, see if we can use a .tool-versions file higher in the directory tree
|
||||
if [ "$matching_tool_version" = "" ] && [ "$asdf_versions_path" != "" ]; then
|
||||
matching_tool_version=$(get_tool_version_from_file $asdf_versions_path $tool_name)
|
||||
fi
|
||||
|
||||
|
||||
# If there's no global .tool-versions file
|
||||
# then we create it and return blank
|
||||
if [ "$matching_tool_version" = "" ]; then
|
||||
local global_tool_versions_path=$HOME/.tool-versions
|
||||
if [ ! -f $global_tool_versions_path ]; then
|
||||
touch $global_tool_versions_path
|
||||
else
|
||||
matching_tool_version=$(get_tool_version_from_file $global_tool_versions_path $tool_name)
|
||||
fi
|
||||
fi
|
||||
|
||||
|
||||
echo $matching_tool_version
|
||||
}
|
||||
|
||||
|
||||
get_tool_version_from_file() {
|
||||
local asdf_versions_path=$1
|
||||
local tool_name=$2
|
||||
local get_all_versions=$3
|
||||
local matching_tool_version=""
|
||||
|
||||
local read_done=false
|
||||
until $read_done; do
|
||||
read tool_line || read_done=true
|
||||
|
||||
if $read_done ; then
|
||||
break;
|
||||
fi
|
||||
|
||||
IFS=' ' read -a tool_info <<< $tool_line
|
||||
local t_name=$(echo "${tool_info[0]}" | xargs)
|
||||
local t_version=$(echo "${tool_info[@]:1}" | xargs)
|
||||
|
||||
if [ "$t_name" = "$tool_name" ]
|
||||
then
|
||||
matching_tool_version=$t_version
|
||||
break;
|
||||
fi
|
||||
done < $asdf_versions_path
|
||||
|
||||
echo $matching_tool_version
|
||||
}
|
||||
|
||||
|
||||
get_tool_version_from_legacy_file() {
|
||||
local plugin_name=$1
|
||||
local directory=$2
|
||||
local legacy_tool_version=""
|
||||
local plugin_path=$(get_plugin_path $plugin_name)
|
||||
local legacy_version_script="${plugin_path}/bin/get-version-from-legacy-file"
|
||||
check_if_plugin_exists $plugin_name
|
||||
|
||||
if [ -f $legacy_version_script ]; then
|
||||
local legacy_tool_version=$(bash $legacy_version_script $directory)
|
||||
fi
|
||||
|
||||
# Should return the version/tag/commit/branch/path
|
||||
echo $legacy_tool_version
|
||||
local version_file_path=$(find_version_file_for "$plugin_name")
|
||||
echo $(parse_version_file "$version_file_path" "$plugin_name")
|
||||
}
|
||||
|
||||
|
||||
get_asdf_config_value_from_file() {
|
||||
local config_path=$1
|
||||
local key=$2
|
||||
|
||||
3
test/fixtures/dummy_plugin/bin/list-legacy-filenames
vendored
Normal file
3
test/fixtures/dummy_plugin/bin/list-legacy-filenames
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
echo ".dummy-version .dummyrc"
|
||||
3
test/fixtures/dummy_plugin/bin/parse-legacy-file
vendored
Normal file
3
test/fixtures/dummy_plugin/bin/parse-legacy-file
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
echo $(cat $1 | tr -d "dummy-")
|
||||
@ -8,7 +8,7 @@ setup() {
|
||||
install_dummy_version "0.1.0"
|
||||
install_dummy_version "0.2.0"
|
||||
|
||||
PROJECT_DIR=$BASE_DIR/project
|
||||
PROJECT_DIR=$HOME/project
|
||||
mkdir -p $PROJECT_DIR
|
||||
}
|
||||
|
||||
@ -45,3 +45,90 @@ teardown() {
|
||||
[ "$status" -eq 0 ]
|
||||
[ "$output" = "" ]
|
||||
}
|
||||
|
||||
@test "find_version_file_for should return .tool-versions if legacy is disabled" {
|
||||
cd $PROJECT_DIR
|
||||
touch ".tool-versions"
|
||||
touch ".dummy-version"
|
||||
|
||||
run find_version_file_for "dummy"
|
||||
[ "$status" -eq 0 ]
|
||||
[ "$output" = "$PROJECT_DIR/.tool-versions" ]
|
||||
}
|
||||
|
||||
@test "find_version_file_for should return .tool-versions ++ plugin filenames if supported" {
|
||||
cd $PROJECT_DIR
|
||||
touch "$HOME/.tool-versions"
|
||||
touch ".dummy-version"
|
||||
echo 'legacy_version_file = yes' > $HOME/.asdfrc
|
||||
|
||||
run find_version_file_for "dummy"
|
||||
[ "$status" -eq 0 ]
|
||||
[ "$output" = "$PROJECT_DIR/.dummy-version" ]
|
||||
}
|
||||
|
||||
@test "find_version_file_for should return .tool-versions if unsupported" {
|
||||
cd $PROJECT_DIR
|
||||
touch "$HOME/.tool-versions"
|
||||
touch ".dummy-version"
|
||||
echo 'legacy_version_file = yes' > $HOME/.asdfrc
|
||||
rm $ASDF_DIR/plugins/dummy/bin/list-legacy-filenames
|
||||
|
||||
run find_version_file_for "dummy"
|
||||
[ "$status" -eq 0 ]
|
||||
[ "$output" = "$HOME/.tool-versions" ]
|
||||
}
|
||||
|
||||
@test "search_filenames should return the path to the first filename found" {
|
||||
touch "$PROJECT_DIR/.dummy-version"
|
||||
touch "$PROJECT_DIR/.tool-versions"
|
||||
|
||||
run search_filenames ".tool-versions .dummy-version" $PROJECT_DIR
|
||||
[ "$status" -eq 0 ]
|
||||
[ "$output" = "$PROJECT_DIR/.tool-versions" ]
|
||||
}
|
||||
|
||||
@test "search_filenames should walk parent directories" {
|
||||
touch "$PROJECT_DIR/.dummy-version"
|
||||
touch "$HOME/.tool-versions"
|
||||
|
||||
run search_filenames ".tool-versions" $PROJECT_DIR
|
||||
[ "$status" -eq 0 ]
|
||||
[ "$output" = "$HOME/.tool-versions" ]
|
||||
}
|
||||
|
||||
@test "search_filenames should return nothing if not found" {
|
||||
run search_filenames ".does-not-exist" $PROJECT_DIR
|
||||
[ "$status" -eq 0 ]
|
||||
[ "$output" = "" ]
|
||||
}
|
||||
|
||||
@test "parse_version_file parses the version from a .tool-version file" {
|
||||
echo "dummy 0.2.0" > $HOME/.tool-versions
|
||||
run parse_version_file $HOME/.tool-versions "dummy"
|
||||
[ "$status" -eq 0 ]
|
||||
[ "$output" = "0.2.0" ]
|
||||
}
|
||||
|
||||
@test "parse_version_file calls the plugin's parse-legacy-file if implemented" {
|
||||
echo "dummy-0.2.0" > $HOME/.dummy-version
|
||||
run parse_version_file $HOME/.dummy-version "dummy"
|
||||
[ "$status" -eq 0 ]
|
||||
[ "$output" = "0.2.0" ]
|
||||
}
|
||||
|
||||
@test "parse_version_file cats the legacy file if parse-legacy-file isn't implemented" {
|
||||
echo "0.2.0" > $HOME/.dummy-version
|
||||
rm $ASDF_DIR/plugins/dummy/bin/parse-legacy-file
|
||||
run parse_version_file $HOME/.dummy-version "dummy"
|
||||
[ "$status" -eq 0 ]
|
||||
[ "$output" = "0.2.0" ]
|
||||
}
|
||||
|
||||
@test "get_preset_version_for returns the current version" {
|
||||
cd $PROJECT_DIR
|
||||
echo "dummy 0.2.0" > .tool-versions
|
||||
run get_preset_version_for "dummy"
|
||||
[ "$status" -eq 0 ]
|
||||
[ "$output" = "0.2.0" ]
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user