mirror of
https://github.com/tofuutils/pre-commit-opentofu.git
synced 2025-10-15 17:38:54 +02:00
feat: Add infracost_breakdown hook (#252)
This commit is contained in:
Maksym Vlasov
GitHub
parent
cc59119c17
commit
cff42e6d6f
5 changed files with 344 additions and 6 deletions
163
infracost_breakdown.sh
Executable file
163
infracost_breakdown.sh
Executable file
|
|
@ -0,0 +1,163 @@
|
|||
#!/usr/bin/env bash
|
||||
set -eo pipefail
|
||||
|
||||
function main {
|
||||
common::initialize
|
||||
common::parse_cmdline "$@"
|
||||
infracost_breakdown_ "${HOOK_CONFIG[*]}" "${ARGS[*]}"
|
||||
}
|
||||
|
||||
function common::colorify {
|
||||
# Colors. Provided as first string to first arg of function.
|
||||
# shellcheck disable=SC2034
|
||||
local -r red="$(tput setaf 1)"
|
||||
# shellcheck disable=SC2034
|
||||
local -r green="$(tput setaf 2)"
|
||||
# shellcheck disable=SC2034
|
||||
local -r yellow="$(tput setaf 3)"
|
||||
# Color reset
|
||||
local -r RESET="$(tput sgr0)"
|
||||
|
||||
# Params start #
|
||||
local COLOR="${!1}"
|
||||
local -r TEXT=$2
|
||||
# Params end #
|
||||
|
||||
if [ "$PRE_COMMIT_COLOR" = "never" ]; then
|
||||
COLOR=$RESET
|
||||
fi
|
||||
|
||||
echo -e "${COLOR}${TEXT}${RESET}"
|
||||
}
|
||||
|
||||
function common::initialize {
|
||||
local SCRIPT_DIR
|
||||
# get directory containing this script
|
||||
SCRIPT_DIR="$(dirname "$(realpath "${BASH_SOURCE[0]}")")"
|
||||
|
||||
# source getopt function
|
||||
# shellcheck source=lib_getopt
|
||||
. "$SCRIPT_DIR/lib_getopt"
|
||||
}
|
||||
|
||||
# common global arrays.
|
||||
# Populated in `parse_cmdline` and can used in hooks functions
|
||||
declare -a ARGS=()
|
||||
declare -a HOOK_CONFIG=()
|
||||
declare -a FILES=()
|
||||
function common::parse_cmdline {
|
||||
local argv
|
||||
argv=$(getopt -o a:,h: --long args:,hook-config: -- "$@") || return
|
||||
eval "set -- $argv"
|
||||
|
||||
for argv; do
|
||||
case $argv in
|
||||
-a | --args)
|
||||
shift
|
||||
ARGS+=("$1")
|
||||
shift
|
||||
;;
|
||||
-h | --hook-config)
|
||||
shift
|
||||
HOOK_CONFIG+=("$1;")
|
||||
shift
|
||||
;;
|
||||
--)
|
||||
shift
|
||||
FILES=("$@")
|
||||
break
|
||||
;;
|
||||
esac
|
||||
done
|
||||
}
|
||||
|
||||
function infracost_breakdown_ {
|
||||
local -r hook_config="$1"
|
||||
local args
|
||||
read -r -a args <<< "$2"
|
||||
|
||||
# Get hook settings
|
||||
IFS=";" read -r -a checks <<< "$hook_config"
|
||||
|
||||
if [ "$PRE_COMMIT_COLOR" = "never" ]; then
|
||||
args+=("--no-color")
|
||||
fi
|
||||
|
||||
local RESULTS
|
||||
RESULTS="$(infracost breakdown "${args[@]}" --format json)"
|
||||
local API_VERSION
|
||||
API_VERSION="$(jq -r .version <<< "$RESULTS")"
|
||||
|
||||
if [ "$API_VERSION" != "0.2" ]; then
|
||||
common::colorify "yellow" "WARNING: Hook supports Infracost API version \"0.2\", got \"$API_VERSION\""
|
||||
common::colorify "yellow" " Some things may not work as expected"
|
||||
fi
|
||||
|
||||
local dir
|
||||
dir="$(jq '.projects[].metadata.vcsSubPath' <<< "$RESULTS")"
|
||||
echo -e "\nRunning in $dir"
|
||||
|
||||
local have_failed_checks=false
|
||||
|
||||
for check in "${checks[@]}"; do
|
||||
# $hook_config receives string like '1 > 2; 3 == 4;' etc.
|
||||
# It gets split by `;` into array, which we're parsing here ('1 > 2' ' 3 == 4')
|
||||
# Next line removes leading spaces, just for fancy output reason.
|
||||
check=$(echo "$check" | sed 's/^[[:space:]]*//')
|
||||
|
||||
operation="$(echo "$check" | grep -oE '[!<>=]+')"
|
||||
IFS="$operation" read -r -a jq_check <<< "$check"
|
||||
real_value="$(jq "${jq_check[0]}" <<< "$RESULTS")"
|
||||
compare_value="${jq_check[1]}${jq_check[2]}"
|
||||
# Check types
|
||||
jq_check_type="$(jq -r "${jq_check[0]} | type" <<< "$RESULTS")"
|
||||
compare_value_type="$(jq -r "$compare_value | type" <<< "$RESULTS")"
|
||||
# Fail if comparing different types
|
||||
if [ "$jq_check_type" != "$compare_value_type" ]; then
|
||||
common::colorify "yellow" "Warning: Comparing values with different types may give incorrect result"
|
||||
common::colorify "yellow" " Expression: $check"
|
||||
common::colorify "yellow" " Types in the expression: [$jq_check_type] $operation [$compare_value_type]"
|
||||
common::colorify "yellow" " Use 'tonumber' filter when comparing costs (e.g. '.totalMonthlyCost|tonumber')"
|
||||
have_failed_checks=true
|
||||
continue
|
||||
fi
|
||||
# Fail if string is compared not with `==` or `!=`
|
||||
if [ "$jq_check_type" == "string" ] && {
|
||||
[ "$operation" != '==' ] && [ "$operation" != '!=' ]
|
||||
}; then
|
||||
common::colorify "yellow" "Warning: Wrong comparison operator is used in expression: $check"
|
||||
common::colorify "yellow" " Use 'tonumber' filter when comparing costs (e.g. '.totalMonthlyCost|tonumber')"
|
||||
common::colorify "yellow" " Use '==' or '!=' when comparing strings (e.g. '.currency == \"USD\"')."
|
||||
have_failed_checks=true
|
||||
continue
|
||||
fi
|
||||
|
||||
# Compare values
|
||||
check_passed="$(echo "$RESULTS" | jq "$check")"
|
||||
|
||||
status="Passed"
|
||||
color="green"
|
||||
if ! $check_passed; then
|
||||
status="Failed"
|
||||
color="red"
|
||||
have_failed_checks=true
|
||||
fi
|
||||
|
||||
# Print check result
|
||||
common::colorify $color "$status: $check\t\t$real_value $operation $compare_value"
|
||||
done
|
||||
|
||||
# Fancy informational output
|
||||
currency="$(jq -r '.currency' <<< "$RESULTS")"
|
||||
|
||||
echo -e "\nSummary: $(jq -r '.summary' <<< "$RESULTS")"
|
||||
|
||||
echo -e "\nTotal Monthly Cost: $(jq -r .totalMonthlyCost <<< "$RESULTS") $currency"
|
||||
echo "Total Monthly Cost (diff): $(jq -r .projects[].diff.totalMonthlyCost <<< "$RESULTS") $currency"
|
||||
|
||||
if $have_failed_checks; then
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
[[ ${BASH_SOURCE[0]} != "$0" ]] || main "$@"
|
||||
Loading…
Add table
Add a link
Reference in a new issue