Merge pull request #35 from cartest/master

kamatama41 · web-flow · commit 8a86d9ef15f7 · 2017-03-09T23:21:00.000+09:00
Additional development of latest. Bash standards. Revert to upstream README.md. Add CHANGELOG.md. Develop Test Suite.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,11 @@
+## 0.4.1 (March 8, 2017)
+
+ * Update error_and_die functions to better report their source location
+ * libexec/tfenv-version-name: Respect `latest` & `latest:<regex>` syntax in .terraform-version
+ * Extension and development of test suite standards
+
+## 0.4.0 (March 6, 2017)
+
+ * Add capability to specify `latest` or `latest:<regex>` in the `use` and `install` actions.
+ * Add error_and_die functions to standardise error output
+ * Specify --tlsv1.2 to curl requests to remote repo. TLSv1.2 required; supported by but not auto-selected by older NSS.
diff --git a/README.md b/README.md
@@ -55,6 +55,9 @@ $ tfenv use latest:^0.8
 List installed versions
 ```sh
 % tfenv list
+0.9.0-beta2
+0.8.8
+0.8.4
 0.7.0
 0.7.0-rc4
 0.6.16
@@ -66,20 +69,29 @@ List installed versions
 List installable versions
 ```sh
 % tfenv list-remote
-0.7.0
-0.7.0-rc4
-0.7.0-rc3
-0.7.0-rc2
-0.7.0-rc1
-0.6.16
-0.6.15
-0.6.14
-0.6.13
+0.9.0-beta2
+0.9.0-beta1
+0.8.8
+0.8.7
+0.8.6
+0.8.5
+0.8.4
+0.8.3
+0.8.2
+0.8.1
+0.8.0
+0.8.0-rc3
+0.8.0-rc2
+0.8.0-rc1
+0.8.0-beta2
+0.8.0-beta1
+0.7.13
+0.7.12
 ...
 ```
 
 ## .terraform-version
-If you put `.terraform-version` file on your project root, tfenv detects it and use the version written in it.
+If you put `.terraform-version` file on your project root, tfenv detects it and use the version written in it. If the version is `latest` or `latest:<regex>`, the latest matching version currently installed will be selected.
 
 ```sh
 $ cat .terraform-version
@@ -96,6 +108,10 @@ $ echo 0.7.3 > .terraform-version
 $ terraform --version
 Terraform v0.7.3
 
+$ echo latest:^0.8 > .terraform-version
+
+$ terraform --version
+Terraform v0.8.8
 ```
 
 ## Upgrading
@@ -112,3 +128,4 @@ $ rm -rf /some/path/to/tfenv
 - [tfenv itself](https://github.com/kamatama41/tfenv/blob/master/LICENSE)
 - [rbenv](https://github.com/rbenv/rbenv/blob/master/LICENSE)
   - tfenv partially uses rbenv's source code
+
diff --git a/libexec/tfenv---version b/libexec/tfenv---version
@@ -10,9 +10,9 @@
 # tagged.
 
 set -e
-[ -n "$TFENV_DEBUG" ] && set -x
+[ -n "${TFENV_DEBUG}" ] && set -x
 
-version="0.4.0"
+version="0.4.1"
 git_revision=""
 
 if cd "${BASH_SOURCE%/*}" 2>/dev/null && git remote -v 2>/dev/null | grep -q tfenv; then
diff --git a/libexec/tfenv-exec b/libexec/tfenv-exec
@@ -14,10 +14,9 @@
 #   PATH="$TFENV_ROOT/versions/0.7.0/bin:$PATH" terraform plan
 
 set -e
-[ -n "$TFENV_DEBUG" ] && set -x
+[ -n "${TFENV_DEBUG}" ] && set -x
 
-TFENV_VERSION="$(tfenv-version-name)"
-export TFENV_VERSION
+export TFENV_VERSION="$(tfenv-version-name)"
 TF_BIN_PATH="${TFENV_ROOT}/versions/${TFENV_VERSION}/terraform"
 export PATH="${TF_BIN_PATH}:${PATH}"
-"$TF_BIN_PATH" "$@"
+"${TF_BIN_PATH}" "${@}"
diff --git a/libexec/tfenv-help b/libexec/tfenv-help
@@ -1,5 +1,7 @@
 #!/usr/bin/env bash
-[ -n "$TFENV_DEBUG" ] && set -x
+
+[ -n "${TFENV_DEBUG}" ] && set -x
+
 echo "Usage: tfenv <command> [<options>]
 
 Commands:
diff --git a/libexec/tfenv-install b/libexec/tfenv-install
@@ -1,37 +1,39 @@
 #!/usr/bin/env bash
 
 function error_and_die() {
-  echo -e "${1}" >&2
+  echo -e "tfenv: ${0}: ${1}" >&2
   exit 1
 }
 
-[ -n "$TFENV_DEBUG" ] && set -x
+[ -n "${TFENV_DEBUG}" ] && set -x
 
-[ $# -gt 1 ] && error_and_die "usage: tfenv install [<version>]"
+[ ${#} -gt 1 ] && error_and_die "usage: tfenv install [<version>]"
 
-declare version regex
-if [[ "${1}" =~ ^latest\:.*$ ]]; then
-  version="${1%%\:*}"
-  regex="${1##*\:}"
-else
-  version="${1}"
-fi
-
-if [ ${version} == "latest" ]; then
-  version="$(tfenv-list-remote | grep -e "${regex}" | head -n 1)"
-  [ -n "${version}" ] || error_and_die "No matching version found in remote"
-elif [ -z "$(tfenv-list-remote | grep "${version}")" ]; then
-  error_and_die "Terraform version '${version}' doesn't exist in remote, please confirm version name."
-fi
+declare version_requested version regex
 
-if [ -z "${version}" ]; then
+if [ -z "${1}" ]; then
   version_file="$(tfenv-version-file)"
   if [ "${version_file}" != "${TFENV_ROOT}/version" ];then
-    version="$(cat ${version_file} || true)"
+    version_requested="$(cat ${version_file} || true)"
   fi
+else
+  version_requested="${1}"
+fi
+
+if [[ "${version_requested}" =~ ^latest\:.*$ ]]; then
+  version="${version_requested%%\:*}"
+  regex="${version_requested##*\:}"
+elif [[ "${version_requested}" =~ ^latest$ ]]; then
+  version="${version_requested}"
+  regex=""
+else
+  version="${version_requested}"
+  regex="${version_requested}"
 fi
 
 [ -n "${version}" ] || error_and_die "Version is not specified"
+version="$(tfenv-list-remote | grep -e "${regex}" | head -n 1)"
+[ -n "${version}" ] || error_and_die "No versions matching '${1}' found in remote"
 
 dst_path="${TFENV_ROOT}/versions/${version}"
 if [ -f ${dst_path}/terraform ];then
diff --git a/libexec/tfenv-list b/libexec/tfenv-list
@@ -1,17 +1,19 @@
 #!/usr/bin/env bash
 
 function error_and_die() {
-  echo -e "${1}" >&2
+  echo -e "tfenv: ${0}: ${1}" >&2
   exit 1
 }
 
-[ -n "$TFENV_DEBUG" ] && set -x
+[ -n "${TFENV_DEBUG}" ] && set -x
 
-[ $# -ne 0 ] \
+[ ${#} -ne 0 ] \
   && error_and_die "usage: tfenv list"
 
 [ -d "${TFENV_ROOT}/versions" ] \
   || error_and_die "No versions available. Please install one with: tfenv install"
 
-set -e
+[[ -x "${TFENV_ROOT}/versions" && -r "${TFENV_ROOT}/versions" ]] \
+  || error_and_die "tfenv versions directory is inaccessible!"
+
 ls -1 "${TFENV_ROOT}/versions" | sort -t'.' -k 1nr,1 -k 2nr,2 -k 3nr,3
diff --git a/libexec/tfenv-list-remote b/libexec/tfenv-list-remote
@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 set -e
-[ -n "$TFENV_DEBUG" ] && set -x
+[ -n "${TFENV_DEBUG}" ] && set -x
 
-if [ $# -ne 0 ];then
+if [ ${#} -ne 0 ];then
   echo "usage: tfenv list-remote" 1>&2
   exit 1
 fi
diff --git a/libexec/tfenv-use b/libexec/tfenv-use
@@ -1,37 +1,45 @@
 #!/usr/bin/env bash
 
 function error_and_die() {
-  echo -e "${1}" >&2
+  echo -e "tfenv: ${0}: ${1}" >&2
   exit 1
 }
 
-[ -n "$TFENV_DEBUG" ] && set -x
+[ -n "${TFENV_DEBUG}" ] && set -x
 
-[ $# -ne 1 ] && error_and_die "usage: tfenv use <version>"
+[ ${#} -ne 1 ] && error_and_die "usage: tfenv use <version>"
 
-declare version
-if [[ "${1}" =~ ^latest\:.*$ ]]; then
-  version="${1%%\:*}"
-  regex="${1##*\:}"
+declare version_requested version regex
+
+version_requested="${1}"
+
+if [[ "${version_requested}" =~ ^latest\:.*$ ]]; then
+  version="${version_requested%%\:*}"
+  regex="${version_requested##*\:}"
+elif [[ "${version_requested}" =~ ^latest$ ]]; then
+  version="${version_requested}"
+  regex=""
 else
-  version="${1}"
+  version="${version_requested}"
+  regex="${version_requested}"
 fi
 
 [ -d "${TFENV_ROOT}/versions" ] \
   || error_and_die "No versions of terraform installed. Please install one with: tfenv install"
 
-[ "${version}" == "latest" ] \
-  && version="$(\ls "${TFENV_ROOT}/versions" \
-    | sort -t'.' -k 1nr,1 -k 2nr,2 -k 3nr,3 \
-    | grep -e "${regex}" \
-    | head -n 1
-  )"
+version="$(\ls "${TFENV_ROOT}/versions" \
+  | sort -t'.' -k 1nr,1 -k 2nr,2 -k 3nr,3 \
+  | grep -e "${regex}" \
+  | head -n 1
+)"
 
-[ -n "${version}" ] || error_and_die "Version not specified or not found"
+[ -n "${version}" ] || error_and_die "No installed versions of terraform matched '${1}'"
 
 target_path=${TFENV_ROOT}/versions/${version}
 [ -f ${target_path}/terraform ] \
-  || error_and_die "Terraform version ${version} is not installed"
+  || error_and_die "Version directory for ${version} is present, but the terraform binary is not! Manual intervention required."
+[ -x ${target_path}/terraform ] \
+  || error_and_die "Version directory for ${version} is present, but the terraform binary is not executable! Manual intervention required. "
 
 echo "${version}" > "${TFENV_ROOT}/version"
 terraform --version || error_and_die "'terraform --version' failed. Something is seriously wrong"
diff --git a/libexec/tfenv-version-file b/libexec/tfenv-version-file
@@ -2,19 +2,19 @@
 # Usage: tfenv version-file
 # Summary: Detect the file that sets the current tfenv version
 set -e
-[ -n "$TFENV_DEBUG" ] && set -x
+[ -n "${TFENV_DEBUG}" ] && set -x
 
 find_local_version_file() {
-  local root="$1"
-  while ! [[ "$root" =~ ^//[^/]*$ ]]; do
+  local root="${1}"
+  while ! [[ "${root}" =~ ^//[^/]*$ ]]; do
     if [ -e "${root}/.terraform-version" ]; then
       echo "${root}/.terraform-version"
       return 0
     fi
-    [ -n "$root" ] || break
+    [ -n "${root}" ] || break
     root="${root%/*}"
   done
   return 1
 }
 
-find_local_version_file "$TFENV_DIR" || echo "${TFENV_ROOT}/version"
+find_local_version_file "${TFENV_DIR}" || echo "${TFENV_ROOT}/version"
diff --git a/libexec/tfenv-version-name b/libexec/tfenv-version-name
@@ -1,24 +1,41 @@
 #!/usr/bin/env bash
 # Summary: Show the current Terraform version
 set -e
-[ -n "$TFENV_DEBUG" ] && set -x
+
+function error_and_die() {
+  echo -e "tfenv: ${0}: ${1}" >&2
+  exit 1
+}
+
+[ -n "${TFENV_DEBUG}" ] && set -x
+
+[ -d "${TFENV_ROOT}/versions" ] \
+  || error_and_die "No versions of terraform installed. Please install one with: tfenv install"
 
 TFENV_VERSION_FILE="$(tfenv-version-file)"
-TFENV_VERSION="$(cat "$TFENV_VERSION_FILE" || true)"
+TFENV_VERSION="$(cat "${TFENV_VERSION_FILE}" || true)"
 
-if [ -z "$TFENV_VERSION" ]; then
-  echo "tfenv: version could not be resolved (set by $TFENV_VERSION_FILE or tfenv use <version>)" >&2
-  exit 1
+if [[ "${TFENV_VERSION}" =~ ^latest.*$ ]]; then
+  [[ "${TFENV_VERSION}" =~ ^latest\:.*$ ]] && regex="${TFENV_VERSION##*\:}"
+  version="$(\ls "${TFENV_ROOT}/versions" \
+    | sort -t'.' -k 1nr,1 -k 2nr,2 -k 3nr,3 \
+    | grep -e "${regex}" \
+    | head -n 1
+  )"
+  [ -n "${version}" ] || error_and_die "No installed versions of terraform matched '${TFENV_VERSION}'"
+  TFENV_VERSION="${version}"
 fi
 
+[ -z "${TFENV_VERSION}" ] \
+  && error_and_die "Version could not be resolved (set by ${TFENV_VERSION_FILE} or tfenv use <version>)"
+
 version_exists() {
-  local version="$1"
+  local version="${1}"
   [ -d "${TFENV_ROOT}/versions/${version}" ]
 }
 
-if version_exists "$TFENV_VERSION"; then
-  echo "$TFENV_VERSION"
+if version_exists "${TFENV_VERSION}"; then
+  echo "${TFENV_VERSION}"
 else
-  echo "tfenv: version \`$TFENV_VERSION' is not installed (set by $TFENV_VERSION_FILE)" >&2
-  exit 1
+  error_and_die "version \`${TFENV_VERSION}' is not installed (set by ${TFENV_VERSION_FILE})"
 fi
diff --git a/test/helpers.sh b/test/helpers.sh
@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 check_version() {
-  v=${1}
+  v="${1}"
   [ -n "$(terraform --version | grep "Terraform v${v}")" ]
 }
 
diff --git a/test/run.sh b/test/run.sh
@@ -1,25 +1,30 @@
 #!/usr/bin/env bash
 
-if [ -n "$TFENV_DEBUG" ]; then
+if [ -n "${TFENV_DEBUG}" ]; then
   export PS4='+ [${BASH_SOURCE##*/}:${LINENO}] '
   set -x
 fi
-TFENV_ROOT=$(cd $(dirname $0)/.. && pwd)
+TFENV_ROOT=$(cd $(dirname ${0})/.. && pwd)
 export PATH="${TFENV_ROOT}/bin:${PATH}"
 
 errors=()
-if [ $# -ne 0 ];then
-  targets="$@"
+if [ ${#} -ne 0 ];then
+  targets="${@}"
 else
-  targets=`ls $(dirname $0) | grep 'test_'`
+  targets=$(\ls $(dirname ${0}) | grep 'test_')
 fi
 
 for t in ${targets}; do
-  bash $(dirname $0)/${t} || errors+=( ${t} )
+  bash $(dirname ${0})/${t} || errors+=( ${t} )
 done
 
 if [ ${#errors[@]} -ne 0 ];then
-  echo -e "\033[0;31m===== Following tests failed ====\033[0;39m" 1>&2
-  echo "${errors[@]}"
+  echo -e "\033[0;31m===== The following test suites failed =====\033[0;39m" >&2
+  for error in "${errors[@]}"; do
+    echo -e "\t${error}" >&2
+  done
   exit 1
+else
+  echo -e "\033[0;32mAll test suites passed.\033[0;39m"
 fi
+exit 0
diff --git a/test/test_install_and_use.sh b/test/test_install_and_use.sh
diff --git a/test/test_list.sh b/test/test_list.sh
diff --git a/test/test_symlink.sh b/test/test_symlink.sh
