Skip to content

Commit

Permalink
refactor: Refactor CircleCI Slack Orb for Improved Readability and Co…
Browse files Browse the repository at this point in the history 
…nsistency (#402)

* refactor: replace `eval echo` for sanitization and default templates

* refactor: export default values for visibility and consistency

* refactor: use 2 spaces instead of 4
  • Loading branch information
@EricRibeiro
EricRibeiro authored Apr 26, 2023
1 parent d2992cd commit b1d05c0
Show file tree
Hide file tree
Showing 3 changed files with 270 additions and 264 deletions.
321 changes: 159 additions & 162 deletions src/scripts/notify.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,181 +6,180 @@ eval "$SLACK_SCRIPT_UTILS"
JQ_PATH=/usr/local/bin/jq

BuildMessageBody() {
# Send message
# If sending message, default to custom template,
# if none is supplied, check for a pre-selected template value.
# If none, error.
if [ -n "${SLACK_PARAM_CUSTOM:-}" ]; then
SanitizeVars "$SLACK_PARAM_CUSTOM"
ModifyCustomTemplate
# shellcheck disable=SC2016
CUSTOM_BODY_MODIFIED=$(echo "$CUSTOM_BODY_MODIFIED" | sed 's/\\/\\\\/g' | sed 's/"/\\"/g' | sed 's/`/\\`/g')
T2="$(eval printf '%s' \""$CUSTOM_BODY_MODIFIED"\")"
else
# shellcheck disable=SC2154
if [ -n "${SLACK_PARAM_TEMPLATE:-}" ]; then TEMPLATE="\$$SLACK_PARAM_TEMPLATE"
elif [ "$CCI_STATUS" = "pass" ]; then TEMPLATE="\$basic_success_1"
elif [ "$CCI_STATUS" = "fail" ]; then TEMPLATE="\$basic_fail_1"
else echo "A template wasn't provided nor is possible to infer it based on the job status. The job status: '$CCI_STATUS' is unexpected."; exit 1
fi

[ -z "${SLACK_PARAM_TEMPLATE:-}" ] && echo "No message template was explicitly chosen. Based on the job status '$CCI_STATUS' the template '$TEMPLATE' will be used."
template_body="$(eval printf '%s' \""$TEMPLATE\"")"
SanitizeVars "$template_body"

# shellcheck disable=SC2016
T1="$(printf '%s' "$template_body" | sed 's/\\/\\\\/g' | sed 's/"/\\"/g' | sed 's/`/\\`/g')"
T2="$(eval printf '%s' \""$T1"\")"
# Send message
# If sending message, default to custom template,
# if none is supplied, check for a pre-selected template value.
# If none, error.
if [ -n "${SLACK_PARAM_CUSTOM:-}" ]; then
SanitizeVars "$SLACK_PARAM_CUSTOM"
ModifyCustomTemplate
# Escape special characters.
custom_template="$(printf '%s' "$CUSTOM_BODY_MODIFIED" | sed 's/\\/\\\\/g' | sed 's/"/\\"/g' | sed 's/`/\\`/g')"
# Expand variables and run subshell commands in the custom template.
message_body="$(eval printf '%s' \""$custom_template"\")"
else
# shellcheck disable=SC2154
if [ -n "${SLACK_PARAM_TEMPLATE:-}" ]; then TEMPLATE="\$$SLACK_PARAM_TEMPLATE"
elif [ "$CCI_STATUS" = "pass" ]; then TEMPLATE="\$basic_success_1"
elif [ "$CCI_STATUS" = "fail" ]; then TEMPLATE="\$basic_fail_1"
else echo "A template wasn't provided nor is possible to infer it based on the job status. The job status: '$CCI_STATUS' is unexpected."; exit 1
fi

# Insert the default channel. THIS IS TEMPORARY
T2="$(printf '%s' "$T2" | jq ". + {\"channel\": \"$SLACK_DEFAULT_CHANNEL\"}")"
SLACK_MSG_BODY="$T2"
[ -z "${SLACK_PARAM_TEMPLATE:-}" ] && echo "No message template was explicitly chosen. Based on the job status '$CCI_STATUS' the template '$TEMPLATE' will be used."
# Evaluate the template name to get the template body.
included_template="$(eval printf '%s' \""$TEMPLATE\"")"
# Escape special characters in environment variables present in the template.
SanitizeVars "$included_template"
# Expand variables.
message_body="$(circleci env subst "$included_template")"
fi

# Insert the default channel. THIS IS TEMPORARY
message_body="$(printf '%s' "$message_body" | jq ". + {\"channel\": \"$SLACK_DEFAULT_CHANNEL\"}")"
SLACK_MSG_BODY="$message_body"
}

PostToSlack() {
# Post once per channel listed by the channel parameter
# The channel must be modified in SLACK_MSG_BODY

# shellcheck disable=SC2001
for i in $(eval echo \""$SLACK_PARAM_CHANNEL"\" | sed "s/,/ /g")
do
echo "Sending to Slack Channel: $i"
SLACK_MSG_BODY=$(echo "$SLACK_MSG_BODY" | jq --arg channel "$i" '.channel = $channel')
if [ "$SLACK_PARAM_DEBUG" -eq 1 ]; then
printf "%s\n" "$SLACK_MSG_BODY" > "$SLACK_MSG_BODY_LOG"
echo "The message body being sent to Slack can be found below. To view redacted values, rerun the job with SSH and access: ${SLACK_MSG_BODY_LOG}"
echo "$SLACK_MSG_BODY"
fi
SLACK_SENT_RESPONSE=$(curl -s -f -X POST -H 'Content-type: application/json' -H "Authorization: Bearer $SLACK_ACCESS_TOKEN" --data "$SLACK_MSG_BODY" https://slack.com/api/chat.postMessage)

if [ "$SLACK_PARAM_DEBUG" -eq 1 ]; then
printf "%s\n" "$SLACK_SENT_RESPONSE" > "$SLACK_SENT_RESPONSE_LOG"
echo "The response from the API call to Slack can be found below. To view redacted values, rerun the job with SSH and access: ${SLACK_SENT_RESPONSE_LOG}"
echo "$SLACK_SENT_RESPONSE"
fi

SLACK_ERROR_MSG=$(echo "$SLACK_SENT_RESPONSE" | jq '.error')
if [ ! "$SLACK_ERROR_MSG" = "null" ]; then
echo "Slack API returned an error message:"
echo "$SLACK_ERROR_MSG"
echo
echo
echo "View the Setup Guide: https://github.com/CircleCI-Public/slack-orb/wiki/Setup"
if [ "$SLACK_PARAM_IGNORE_ERRORS" = "0" ]; then
exit 1
fi
fi
done
# Post once per channel listed by the channel parameter
# The channel must be modified in SLACK_MSG_BODY

# shellcheck disable=SC2001
for i in $(eval echo \""$SLACK_PARAM_CHANNEL"\" | sed "s/,/ /g"); do
echo "Sending to Slack Channel: $i"
SLACK_MSG_BODY=$(echo "$SLACK_MSG_BODY" | jq --arg channel "$i" '.channel = $channel')
if [ "$SLACK_PARAM_DEBUG" -eq 1 ]; then
printf "%s\n" "$SLACK_MSG_BODY" >"$SLACK_MSG_BODY_LOG"
echo "The message body being sent to Slack can be found below. To view redacted values, rerun the job with SSH and access: ${SLACK_MSG_BODY_LOG}"
echo "$SLACK_MSG_BODY"
fi
SLACK_SENT_RESPONSE=$(curl -s -f -X POST -H 'Content-type: application/json' -H "Authorization: Bearer $SLACK_ACCESS_TOKEN" --data "$SLACK_MSG_BODY" https://slack.com/api/chat.postMessage)

if [ "$SLACK_PARAM_DEBUG" -eq 1 ]; then
printf "%s\n" "$SLACK_SENT_RESPONSE" >"$SLACK_SENT_RESPONSE_LOG"
echo "The response from the API call to Slack can be found below. To view redacted values, rerun the job with SSH and access: ${SLACK_SENT_RESPONSE_LOG}"
echo "$SLACK_SENT_RESPONSE"
fi

SLACK_ERROR_MSG=$(echo "$SLACK_SENT_RESPONSE" | jq '.error')
if [ ! "$SLACK_ERROR_MSG" = "null" ]; then
echo "Slack API returned an error message:"
echo "$SLACK_ERROR_MSG"
echo
echo
echo "View the Setup Guide: https://github.com/CircleCI-Public/slack-orb/wiki/Setup"
if [ "$SLACK_PARAM_IGNORE_ERRORS" = "0" ]; then
exit 1
fi
fi
done
}

ModifyCustomTemplate() {
# Inserts the required "text" field to the custom json template from block kit builder.
if [ "$(echo "$SLACK_PARAM_CUSTOM" | jq '.text')" = "null" ]; then
CUSTOM_BODY_MODIFIED=$(echo "$SLACK_PARAM_CUSTOM" | jq '. + {"text": ""}')
else
# In case the text field was set manually.
CUSTOM_BODY_MODIFIED=$(echo "$SLACK_PARAM_CUSTOM" | jq '.')
fi
# Inserts the required "text" field to the custom json template from block kit builder.
if [ "$(echo "$SLACK_PARAM_CUSTOM" | jq '.text')" = "null" ]; then
CUSTOM_BODY_MODIFIED=$(echo "$SLACK_PARAM_CUSTOM" | jq '. + {"text": ""}')
else
# In case the text field was set manually.
CUSTOM_BODY_MODIFIED=$(echo "$SLACK_PARAM_CUSTOM" | jq '.')
fi
}

InstallJq() {
echo "Checking For JQ + CURL"
if command -v curl >/dev/null 2>&1 && ! command -v jq >/dev/null 2>&1; then
uname -a | grep Darwin > /dev/null 2>&1 && JQ_VERSION=jq-osx-amd64 || JQ_VERSION=jq-linux32
curl -Ls -o "$JQ_PATH" https://github.com/stedolan/jq/releases/download/jq-1.6/"${JQ_VERSION}"
chmod +x "$JQ_PATH"
command -v jq >/dev/null 2>&1
return $?
else
command -v curl >/dev/null 2>&1 || { echo >&2 "SLACK ORB ERROR: CURL is required. Please install."; exit 1; }
command -v jq >/dev/null 2>&1 || { echo >&2 "SLACK ORB ERROR: JQ is required. Please install"; exit 1; }
return $?
fi
echo "Checking For JQ + CURL"
if command -v curl >/dev/null 2>&1 && ! command -v jq >/dev/null 2>&1; then
uname -a | grep Darwin >/dev/null 2>&1 && JQ_VERSION=jq-osx-amd64 || JQ_VERSION=jq-linux32
curl -Ls -o "$JQ_PATH" https://github.com/stedolan/jq/releases/download/jq-1.6/"${JQ_VERSION}"
chmod +x "$JQ_PATH"
command -v jq >/dev/null 2>&1
return $?
else
command -v curl >/dev/null 2>&1 || { echo >&2 "SLACK ORB ERROR: CURL is required. Please install."; exit 1; }
command -v jq >/dev/null 2>&1 || { echo >&2 "SLACK ORB ERROR: JQ is required. Please install"; exit 1; }
return $?
fi
}

FilterBy() {
if [ -z "$1" ] || [ -z "$2" ]; then
return
fi

# If any pattern supplied matches the current branch or the current tag, proceed; otherwise, exit with message.
FLAG_MATCHES_FILTER="false"
for i in $(echo "$1" | sed "s/,/ /g"); do
if echo "$2" | grep -Eq "^${i}$"; then
FLAG_MATCHES_FILTER="true"
break
fi
done
# If the invert_match parameter is set, invert the match.
if { [ "$FLAG_MATCHES_FILTER" = "false" ] && [ "$SLACK_PARAM_INVERT_MATCH" -eq 0 ]; } || \
{ [ "$FLAG_MATCHES_FILTER" = "true" ] && [ "$SLACK_PARAM_INVERT_MATCH" -eq 1 ]; }
then
# dont send message.
echo "NO SLACK ALERT"
echo
echo "Current reference \"$2\" does not match any matching parameter"
echo "Current matching pattern: $1"
exit 0
if [ -z "$1" ] || [ -z "$2" ]; then
return
fi

# If any pattern supplied matches the current branch or the current tag, proceed; otherwise, exit with message.
FLAG_MATCHES_FILTER="false"
for i in $(echo "$1" | sed "s/,/ /g"); do
if echo "$2" | grep -Eq "^${i}$"; then
FLAG_MATCHES_FILTER="true"
break
fi
done
# If the invert_match parameter is set, invert the match.
if { [ "$FLAG_MATCHES_FILTER" = "false" ] && [ "$SLACK_PARAM_INVERT_MATCH" -eq 0 ]; } ||
{ [ "$FLAG_MATCHES_FILTER" = "true" ] && [ "$SLACK_PARAM_INVERT_MATCH" -eq 1 ]; }; then
# dont send message.
echo "NO SLACK ALERT"
echo
echo "Current reference \"$2\" does not match any matching parameter"
echo "Current matching pattern: $1"
exit 0
fi
}

SetupEnvVars() {
echo "BASH_ENV file: $BASH_ENV"
if [ -f "$BASH_ENV" ]; then
echo "Exists. Sourcing into ENV"
# shellcheck disable=SC1090
. "$BASH_ENV"
else
echo "Does Not Exist. Skipping file execution"
fi
echo "BASH_ENV file: $BASH_ENV"
if [ -f "$BASH_ENV" ]; then
echo "Exists. Sourcing into ENV"
# shellcheck disable=SC1090
. "$BASH_ENV"
else
echo "Does Not Exist. Skipping file execution"
fi
}

CheckEnvVars() {
if [ -n "${SLACK_WEBHOOK:-}" ]; then
echo "It appears you have a Slack Webhook token present in this job."
echo "Please note, Webhooks are no longer used for the Slack Orb (v4 +)."
echo "Follow the setup guide available in the wiki: https://github.com/CircleCI-Public/slack-orb/wiki/Setup"
fi
if [ -z "${SLACK_ACCESS_TOKEN:-}" ]; then
echo "In order to use the Slack Orb (v4 +), an OAuth token must be present via the SLACK_ACCESS_TOKEN environment variable."
echo "Follow the setup guide available in the wiki: https://github.com/CircleCI-Public/slack-orb/wiki/Setup"
exit 1
fi
# If no channel is provided, quit with error
if [ -z "${SLACK_PARAM_CHANNEL:-}" ]; then
echo "No channel was provided. Enter value for SLACK_DEFAULT_CHANNEL env var, or channel parameter"
exit 1
fi
if [ -n "${SLACK_WEBHOOK:-}" ]; then
echo "It appears you have a Slack Webhook token present in this job."
echo "Please note, Webhooks are no longer used for the Slack Orb (v4 +)."
echo "Follow the setup guide available in the wiki: https://github.com/CircleCI-Public/slack-orb/wiki/Setup"
fi
if [ -z "${SLACK_ACCESS_TOKEN:-}" ]; then
echo "In order to use the Slack Orb (v4 +), an OAuth token must be present via the SLACK_ACCESS_TOKEN environment variable."
echo "Follow the setup guide available in the wiki: https://github.com/CircleCI-Public/slack-orb/wiki/Setup"
exit 1
fi
# If no channel is provided, quit with error
if [ -z "${SLACK_PARAM_CHANNEL:-}" ]; then
echo "No channel was provided. Enter value for SLACK_DEFAULT_CHANNEL env var, or channel parameter"
exit 1
fi
}

ShouldPost() {
if [ "$CCI_STATUS" = "$SLACK_PARAM_EVENT" ] || [ "$SLACK_PARAM_EVENT" = "always" ]; then
# In the event the Slack notification would be sent, first ensure it is allowed to trigger
# on this branch or this tag.
FilterBy "$SLACK_PARAM_BRANCHPATTERN" "${CIRCLE_BRANCH:-}"
FilterBy "$SLACK_PARAM_TAGPATTERN" "${CIRCLE_TAG:-}"

echo "Posting Status"
else
# dont send message.
echo "NO SLACK ALERT"
echo
echo "This command is set to send an alert on: $SLACK_PARAM_EVENT"
echo "Current status: ${CCI_STATUS}"
exit 0
fi
if [ "$CCI_STATUS" = "$SLACK_PARAM_EVENT" ] || [ "$SLACK_PARAM_EVENT" = "always" ]; then
# In the event the Slack notification would be sent, first ensure it is allowed to trigger
# on this branch or this tag.
FilterBy "$SLACK_PARAM_BRANCHPATTERN" "${CIRCLE_BRANCH:-}"
FilterBy "$SLACK_PARAM_TAGPATTERN" "${CIRCLE_TAG:-}"

echo "Posting Status"
else
# dont send message.
echo "NO SLACK ALERT"
echo
echo "This command is set to send an alert on: $SLACK_PARAM_EVENT"
echo "Current status: ${CCI_STATUS}"
exit 0
fi
}

SetupLogs() {
if [ "$SLACK_PARAM_DEBUG" -eq 1 ]; then
LOG_PATH="$(mktemp -d 'slack-orb-logs.XXXXXX')"
SLACK_MSG_BODY_LOG="$LOG_PATH/payload.json"
SLACK_SENT_RESPONSE_LOG="$LOG_PATH/response.json"

touch "$SLACK_MSG_BODY_LOG" "$SLACK_SENT_RESPONSE_LOG"
chmod 0600 "$SLACK_MSG_BODY_LOG" "$SLACK_SENT_RESPONSE_LOG"
fi
if [ "$SLACK_PARAM_DEBUG" -eq 1 ]; then
LOG_PATH="$(mktemp -d 'slack-orb-logs.XXXXXX')"
SLACK_MSG_BODY_LOG="$LOG_PATH/payload.json"
SLACK_SENT_RESPONSE_LOG="$LOG_PATH/response.json"

touch "$SLACK_MSG_BODY_LOG" "$SLACK_SENT_RESPONSE_LOG"
chmod 0600 "$SLACK_MSG_BODY_LOG" "$SLACK_SENT_RESPONSE_LOG"
fi
}

# $1: Template with environment variables to be sanitized.
Expand All @@ -206,7 +205,7 @@ SanitizeVars() {
# The variable must be wrapped in double quotes before the evaluation.
# Otherwise the newlines will be removed.
local value
value="$(eval printf '%s' \"\$"$var\"")"
value="$(circleci env subst \$"$var")"
[ -z "$value" ] && { printf '%s\n' "$var is empty or doesn't exist. Skipping it..."; continue; }

printf '%s\n' "Sanitizing $var..."
Expand All @@ -218,30 +217,28 @@ SanitizeVars() {
sanitized_value="$(printf '%s' "$sanitized_value" | awk 'NR > 1 { printf("\\n") } { printf("%s", $0) }')"
# Escape double quotes.
if [ "$PLATFORM" = "windows" ]; then
sanitized_value="$(printf '%s' "$sanitized_value" | awk '{gsub(/"/, "\\\""); print $0}')"
sanitized_value="$(printf '%s' "$sanitized_value" | awk '{gsub(/"/, "\\\""); print $0}')"
else
sanitized_value="$(printf '%s' "$sanitized_value" | awk '{gsub(/\"/, "\\\""); print $0}')"
sanitized_value="$(printf '%s' "$sanitized_value" | awk '{gsub(/\"/, "\\\""); print $0}')"
fi

# Write the sanitized value back to the original variable.
# shellcheck disable=SC3045 # This is working on Alpine.
printf -v "$var" "%s" "$sanitized_value"
done

return 0;
}

# Will not run if sourced from another script.
# This is done so this script may be tested.
ORB_TEST_ENV="bats-core"
if [ "${0#*"$ORB_TEST_ENV"}" = "$0" ]; then
# shellcheck source=/dev/null
. "/tmp/SLACK_JOB_STATUS"
ShouldPost
SetupEnvVars
SetupLogs
CheckEnvVars
InstallJq
BuildMessageBody
PostToSlack
# shellcheck source=/dev/null
. "/tmp/SLACK_JOB_STATUS"
ShouldPost
SetupEnvVars
SetupLogs
CheckEnvVars
InstallJq
BuildMessageBody
PostToSlack
fi
Loading

0 comments on commit b1d05c0

Please sign in to comment.