Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow comments in .terraform-version file #347

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+41 −14
Open

Allow comments in .terraform-version file #347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7898b72
Add failing test of comments in .terraform-version
OJFord Jul 15, 2022
759a13a
Allow comments in .terraform-version file
OJFord Jul 15, 2022
739f459
Refactor version file parsing to own function
OJFord Aug 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/helpers.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ export -f check_dependencies;

source "$TFENV_ROOT/lib/tfenv-exec.sh";
source "$TFENV_ROOT/lib/tfenv-min-required.sh";
source "$TFENV_ROOT/lib/tfenv-parse-version-file.sh";
source "$TFENV_ROOT/lib/tfenv-version-file.sh";
source "$TFENV_ROOT/lib/tfenv-version-name.sh";

Expand Down
14 changes: 14 additions & 0 deletions lib/tfenv-parse-version-file.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/usr/bin/env bash

set -uo pipefail;

# Ensure GNU grep
check_dependencies;

function tfenv-parse-version-file() {
local version_file="$1"
log 'debug' "Parsing version from file ${version_file}"

grep --invert-match '^#' "${version_file}";
}
export -f tfenv-parse-version-file;
2 changes: 1 addition & 1 deletion lib/tfenv-version-name.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ function tfenv-version-name() {
&& log 'debug' "TFENV_VERSION_FILE retrieved from tfenv-version-file: ${TFENV_VERSION_FILE}" \
|| log 'error' 'Failed to retrieve TFENV_VERSION_FILE from tfenv-version-file';

TFENV_VERSION="$(cat "${TFENV_VERSION_FILE}" || true)" \
TFENV_VERSION="$(tfenv-parse-version-file "${TFENV_VERSION_FILE}")" \
&& log 'debug' "TFENV_VERSION specified in TFENV_VERSION_FILE: ${TFENV_VERSION}";

TFENV_VERSION_SOURCE="${TFENV_VERSION_FILE}";
Expand Down
4 changes: 2 additions & 2 deletions libexec/tfenv-resolve-version
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,12 @@ if [ -z "${arg}" -a -z "${TFENV_TERRAFORM_VERSION:-""}" ]; then

if [ "${version_file}" != "${TFENV_CONFIG_DIR}/version" ]; then
log 'debug' "Version File (${version_file}) is not the default \${TFENV_CONFIG_DIR}/version (${TFENV_CONFIG_DIR}/version)";
version_requested="$(cat "${version_file}")" \
version_requested="$(tfenv-parse-version-file "${version_file}")" \
|| log 'error' "Failed to open ${version_file}";

elif [ -f "${version_file}" ]; then
log 'debug' "Version File is the default \${TFENV_CONFIG_DIR}/version (${TFENV_CONFIG_DIR}/version)";
version_requested="$(cat "${version_file}")" \
version_requested="$(tfenv-parse-version-file "${version_file}")" \
|| log 'error' "Failed to open ${version_file}";

# Absolute fallback
Expand Down
4 changes: 2 additions & 2 deletions libexec/tfenv-uninstall
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ if [ -z "${arg:-""}" -a -z "${TFENV_TERRAFORM_VERSION:-""}" ]; then
log 'debug' "Version File: ${version_file}";
if [ "${version_file}" != "${TFENV_CONFIG_DIR}/version" ]; then
log 'debug' "Version File (${version_file}) is not the default \${TFENV_CONFIG_DIR}/version (${TFENV_CONFIG_DIR}/version)";
version_requested="$(cat "${version_file}")" \
version_requested="$(tfenv-parse-version-file "${version_file}")" \
|| log 'error' "Failed to open ${version_file}";
elif [ -f "${version_file}" ]; then
log 'debug' "Version File is the default \${TFENV_CONFIG_DIR}/version (${TFENV_CONFIG_DIR}/version)";
version_requested="$(cat "${version_file}")" \
version_requested="$(tfenv-parse-version-file "${version_file}")" \
|| log 'error' "Failed to open ${version_file}";
else
log 'debug' "Version File is the default \${TFENV_CONFIG_DIR}/version (${TFENV_CONFIG_DIR}/version) but it doesn't exist";
Expand Down
2 changes: 1 addition & 1 deletion libexec/tfenv-use
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ if [ -z "${requested_arg}" -a -z "${TFENV_TERRAFORM_VERSION:-""}" ]; then
version_source_suffix=" (set by ${loaded_version_file})";

if [ -f "${loaded_version_file}" ]; then
requested="$(cat "${loaded_version_file}" || true)";
requested="$(tfenv-parse-version-file "${loaded_version_file}")";
else
# No-one asked for anything, no default version is set either
requested='latest';
Expand Down
28 changes: 20 additions & 8 deletions test/test_install_and_use.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,14 @@ tests__kv=(
'0.14.6,v0.14.6'
);

tests_file_only__desc=(
'version with comment'
);

tests_file_only__kv=(
'1.2.3,# this is a comment\n1.2.3'
);

tests_count=${#tests__desc[@]};

declare desc kv k v test_num;
Expand All @@ -127,19 +135,23 @@ for ((test_iter=0; test_iter<${tests_count}; ++test_iter )) ; do
|| error_and_proceed "## Param Test ${test_num}/${tests_count}: ${desc} ( ${k} / ${v} ) failed";
done;

for ((test_iter=0; test_iter<${tests_count}; ++test_iter )) ; do
tests_file__desc=("${tests__desc[@]}" "${tests_file_only__desc[@]}");
tests_file__kv=("${tests__kv[@]}" "${tests_file_only__kv[@]}");
tests_file_count=${#tests_file__desc[@]};

for ((test_iter=0; test_iter<${tests_file_count}; ++test_iter )) ; do
cleanup || log 'error' 'Cleanup failed?!';
test_num=$((test_iter + 1));
desc=${tests__desc[${test_iter}]};
kv="${tests__kv[${test_iter}]}";
test_num=$((test_iter + 1));
desc="${tests_file__desc[${test_iter}]}";
kv="${tests_file__kv[${test_iter}]}";
v="${kv%,*}";
k="${kv##*,}";
log 'info' "## ./.terraform-version Test ${test_num}/${tests_count}: ${desc} ( ${k} / ${v} )";
log 'info' "## ./.terraform-version Test ${test_num}/${tests_file_count}: ${desc} ( ${k} / ${v} )";
log 'info' "Writing ${k} to ./.terraform-version";
echo "${k}" > ./.terraform-version;
echo -e "${k}" > ./.terraform-version;
test_install_and_use "${v}" \
&& log info "## ./.terraform-version Test ${test_num}/${tests_count}: ${desc} ( ${k} / ${v} ) succeeded" \
|| error_and_proceed "## ./.terraform-version Test ${test_num}/${tests_count}: ${desc} ( ${k} / ${v} ) failed";
&& log info "## ./.terraform-version Test ${test_num}/${tests_file_count}: ${desc} ( ${k} / ${v} ) succeeded" \
|| error_and_proceed "## ./.terraform-version Test ${test_num}/${tests_file_count}: ${desc} ( ${k} / ${v} ) failed";
done;

for ((test_iter=0; test_iter<${tests_count}; ++test_iter )) ; do
Expand Down
Loading