github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-22 03:11:40 +00:00
Code Issues Projects Releases Wiki Activity

Updates to resolve shellcheck issues

Browse Source 
Removed hack/lib/test.sh from /hack/shellcheck_failures
Removed  and }s to satisfy shellcheck SC2004
Added double quotes to satisfy shellcheck SC2086
Converted array reference to access all elements to satisfy shellcheck SC2128
Updates to satisfy shellcheck SC2143
Updates to satisfy shellcheck SC2178 & SC2124
Updates to satisfy shellcheck SC2128
Updates to satisfy shellcheck SC2207

Remove double quotes to allow expansion. Fixed piping to grep -q

Removed quotes to allow for expansion on flags
This commit is contained in:
Joe Searcy 2019-08-24 00:50:12 -04:00
parent 9fa7889e98
commit 1b7ba643bb
2 changed files with 39 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
hack/.shellcheck_failures
View File

@ -14,4 +14,3 @@
./cluster/log-dump/log-dump.sh ./cluster/log-dump/log-dump.sh
./cluster/pre-existing/util.sh ./cluster/pre-existing/util.sh
./cluster/validate-cluster.sh ./cluster/validate-cluster.sh
./hack/lib/test.sh

66
hack/lib/test.sh
View File

@ -24,6 +24,8 @@ readonly green=$(tput setaf 2)
kube::test::clear_all() { kube::test::clear_all() {
if kube::test::if_supports_resource "rc" ; then if kube::test::if_supports_resource "rc" ; then
# shellcheck disable=SC2154
# Disabling because "kube_flags" is set in a parent script
kubectl delete "${kube_flags[@]}" rc --all --grace-period=0 --force kubectl delete "${kube_flags[@]}" rc --all --grace-period=0 --force
fi fi
if kube::test::if_supports_resource "pods" ; then if kube::test::if_supports_resource "pods" ; then
@ -43,7 +45,7 @@ kube::test::get_caller() {
# Force exact match of a returned result for a object query. Wrap this with || to support multiple # Force exact match of a returned result for a object query. Wrap this with || to support multiple
# valid return types. # valid return types.
# This runs `kubectl get` once and asserts that the result is as expected. # This runs `kubectl get` once and asserts that the result is as expected.
## $1: Object on which get should be run # $1: Object on which get should be run
# $2: The go-template to run on the result # $2: The go-template to run on the result
# $3: The expected output # $3: The expected output
# $4: Additional args to be passed to kubectl # $4: Additional args to be passed to kubectl
@ -75,8 +77,10 @@ kube::test::object_assert() {
local expected=$4 local expected=$4
local args=${5:-} local args=${5:-}
for j in $(seq 1 ${tries}); do for j in $(seq 1 "${tries}"); do
res=$(eval kubectl get "${kube_flags[@]}" ${args} ${object} -o go-template=\"${request}\") # shellcheck disable=SC2086
# Disabling because "args" needs to allow for expansion here
res=$(eval kubectl get "${kube_flags[@]}" ${args} "${object}" -o go-template=\""${request}"\")
if [[ "${res}" =~ ^$expected$ ]]; then if [[ "${res}" =~ ^$expected$ ]]; then
echo -n "${green}" echo -n "${green}"
echo "$(kube::test::get_caller 3): Successful get ${object} ${request}: ${res}" echo "$(kube::test::get_caller 3): Successful get ${object} ${request}: ${res}"
@ -84,7 +88,7 @@ kube::test::object_assert() {
return 0 return 0
fi fi
echo "Waiting for Get ${object} ${request} ${args}: expected: ${expected}, got: ${res}" echo "Waiting for Get ${object} ${request} ${args}: expected: ${expected}, got: ${res}"
sleep $((${j}-1)) sleep $((j-1))
done done
echo "${bold}${red}" echo "${bold}${red}"
@ -103,7 +107,7 @@ kube::test::get_object_jsonpath_assert() {
local request=$2 local request=$2
local expected=$3 local expected=$3
res=$(eval kubectl get "${kube_flags[@]}" ${object} -o jsonpath=\"${request}\") res=$(eval kubectl get "${kube_flags[@]}" "${object}" -o jsonpath=\""${request}"\")
if [[ "${res}" =~ ^$expected$ ]]; then if [[ "${res}" =~ ^$expected$ ]]; then
echo -n "${green}" echo -n "${green}"
@ -126,12 +130,12 @@ kube::test::get_object_jsonpath_assert() {
kube::test::describe_object_assert() { kube::test::describe_object_assert() {
local resource=$1 local resource=$1
local object=$2 local object=$2
local matches=${@:3} local matches=( "${@:3}" )
result=$(eval kubectl describe "${kube_flags[@]}" ${resource} ${object}) result=$(eval kubectl describe "${kube_flags[@]}" "${resource}" "${object}")
for match in ${matches}; do for match in "${matches[@]}"; do
if [[ ! $(echo "${result}" | grep ${match}) ]]; then if grep -q "${match}" <<< "${result}"; then
echo "${bold}${red}" echo "${bold}${red}"
echo "$(kube::test::get_caller): FAIL!" echo "$(kube::test::get_caller): FAIL!"
echo "Describe ${resource} ${object}" echo "Describe ${resource} ${object}"
@ -158,12 +162,12 @@ kube::test::describe_object_events_assert() {
local showevents=${3:-"true"} local showevents=${3:-"true"}
if [[ -z "${3:-}" ]]; then if [[ -z "${3:-}" ]]; then
result=$(eval kubectl describe "${kube_flags[@]}" ${resource} ${object}) result=$(eval kubectl describe "${kube_flags[@]}" "${resource}" "${object}")
else else
result=$(eval kubectl describe "${kube_flags[@]}" "--show-events=${showevents}" ${resource} ${object}) result=$(eval kubectl describe "${kube_flags[@]}" "--show-events=${showevents}" "${resource}" "${object}")
fi fi
if [[ -n $(echo "${result}" | grep "No events.\|Events:") ]]; then if grep -q "No events.\|Events:" <<< "${result}"; then
local has_events="true" local has_events="true"
else else
local has_events="false" local has_events="false"
@ -192,12 +196,12 @@ kube::test::describe_object_events_assert() {
kube::test::describe_resource_assert() { kube::test::describe_resource_assert() {
local resource=$1 local resource=$1
local matches=${@:2} local matches=( "${@:2}" )
result=$(eval kubectl describe "${kube_flags[@]}" ${resource}) result=$(eval kubectl describe "${kube_flags[@]}" "${resource}")
for match in ${matches}; do for match in "${matches[@]}"; do
if [[ ! $(echo "${result}" | grep ${match}) ]]; then if grep -q "${match}" <<< "${result}"; then
echo "${bold}${red}" echo "${bold}${red}"
echo "FAIL!" echo "FAIL!"
echo "Describe ${resource}" echo "Describe ${resource}"
@ -222,9 +226,9 @@ kube::test::describe_resource_events_assert() {
local resource=$1 local resource=$1
local showevents=${2:-"true"} local showevents=${2:-"true"}
result=$(eval kubectl describe "${kube_flags[@]}" "--show-events=${showevents}" ${resource}) result=$(eval kubectl describe "${kube_flags[@]}" "--show-events=${showevents}" "${resource}")
if [[ $(echo "${result}" | grep "No events.\|Events:") ]]; then if grep -q "No events.\|Events:" <<< "${result}"; then
local has_events="true" local has_events="true"
else else
local has_events="false" local has_events="false"
@ -252,7 +256,7 @@ kube::test::describe_resource_events_assert() {
# Compare sort-by resource name output with expected order specify in the last parameter # Compare sort-by resource name output with expected order specify in the last parameter
kube::test::if_sort_by_has_correct_order() { kube::test::if_sort_by_has_correct_order() {
local array=($(echo "$1" |awk '{if(NR!=1) print $1}')) IFS=" " read -r -a array <<< "$(echo "$1" |awk '{if(NR!=1) print $1}')"
local var local var
for i in "${array[@]}"; do for i in "${array[@]}"; do
var+="${i}:" var+="${i}:"
@ -332,12 +336,16 @@ kube::test::version::object_to_file() {
name=$1 name=$1
flags=${2:-""} flags=${2:-""}
file=$3 file=$3
# shellcheck disable=SC2086
# Disabling because "flags" needs to allow for expansion here
kubectl version ${flags} | grep "${name} Version:" | sed -e s/"${name} Version: version.Info{"/'/' -e s/'}'/'/' -e s/', '/','/g -e s/':'/'=/g' -e s/'"'/""/g | tr , '\n' > "${file}" kubectl version ${flags} | grep "${name} Version:" | sed -e s/"${name} Version: version.Info{"/'/' -e s/'}'/'/' -e s/', '/','/g -e s/':'/'=/g' -e s/'"'/""/g | tr , '\n' > "${file}"
} }
kube::test::version::json_object_to_file() { kube::test::version::json_object_to_file() {
flags=$1 flags=$1
file=$2 file=$2
# shellcheck disable=SC2086
# Disabling because "flags" needs to allow for expansion here
kubectl version ${flags} --output json | sed -e s/' '/''/g -e s/'\"'/''/g -e s/'}'/''/g -e s/'{'/''/g -e s/'clientVersion:'/'clientVersion:,'/ -e s/'serverVersion:'/'serverVersion:,'/ | tr , '\n' > "${file}" kubectl version ${flags} --output json | sed -e s/' '/''/g -e s/'\"'/''/g -e s/'}'/''/g -e s/'{'/''/g -e s/'clientVersion:'/'clientVersion:,'/ -e s/'serverVersion:'/'serverVersion:,'/ | tr , '\n' > "${file}"
} }
@ -345,12 +353,16 @@ kube::test::version::json_client_server_object_to_file() {
flags=$1 flags=$1
name=$2 name=$2
file=$3 file=$3
# shellcheck disable=SC2086
# Disabling because "flags" needs to allow for expansion here
kubectl version ${flags} --output json | jq -r ".${name}" | sed -e s/'\"'/''/g -e s/'}'/''/g -e s/'{'/''/g -e /^$/d -e s/','/''/g -e s/':'/'='/g > "${file}" kubectl version ${flags} --output json | jq -r ".${name}" | sed -e s/'\"'/''/g -e s/'}'/''/g -e s/'{'/''/g -e /^$/d -e s/','/''/g -e s/':'/'='/g > "${file}"
} }
kube::test::version::yaml_object_to_file() { kube::test::version::yaml_object_to_file() {
flags=$1 flags=$1
file=$2 file=$2
# shellcheck disable=SC2086
# Disabling because "flags" needs to allow for expansion here
kubectl version ${flags} --output yaml | sed -e s/' '/''/g -e s/'\"'/''/g -e /^$/d > "${file}" kubectl version ${flags} --output yaml | sed -e s/' '/''/g -e s/'\"'/''/g -e /^$/d > "${file}"
} }
@ -381,11 +393,11 @@ kube::test::version::diff_assert() {
return 1 return 1
fi fi
sort ${original} > "${original}.sorted" sort "${original}" > "${original}.sorted"
sort ${latest} > "${latest}.sorted" sort "${latest}" > "${latest}.sorted"
if [ "${comparator}" == "eq" ]; then if [ "${comparator}" == "eq" ]; then
if [ "$(diff -iwB ${original}.sorted ${latest}.sorted)" == "" ] ; then if [ "$(diff -iwB "${original}".sorted "${latest}".sorted)" == "" ] ; then
echo -n "${green}" echo -n "${green}"
echo "Successful: ${diff_msg}" echo "Successful: ${diff_msg}"
echo -n "${reset}" echo -n "${reset}"
@ -394,16 +406,16 @@ kube::test::version::diff_assert() {
echo "${bold}${red}" echo "${bold}${red}"
echo "FAIL! ${diff_msg}" echo "FAIL! ${diff_msg}"
echo " Expected: " echo " Expected: "
echo "$(cat ${original})" cat "${original}"
echo " Got: " echo " Got: "
echo "$(cat ${latest})" cat "${latest}"
echo "${reset}${red}" echo "${reset}${red}"
caller caller
echo "${reset}" echo "${reset}"
return 1 return 1
fi fi
else else
if [ ! -z "$(diff -iwB ${original}.sorted ${latest}.sorted)" ] ; then if [ -n "$(diff -iwB "${original}".sorted "${latest}".sorted)" ] ; then
echo -n "${green}" echo -n "${green}"
echo "Successful: ${diff_msg}" echo "Successful: ${diff_msg}"
echo -n "${reset}" echo -n "${reset}"
@ -412,9 +424,9 @@ kube::test::version::diff_assert() {
echo "${bold}${red}" echo "${bold}${red}"
echo "FAIL! ${diff_msg}" echo "FAIL! ${diff_msg}"
echo " Expected: " echo " Expected: "
echo "$(cat ${original})" cat "${original}"
echo " Got: " echo " Got: "
echo "$(cat ${latest})" cat "${latest}"
echo "${reset}${red}" echo "${reset}${red}"
caller caller
echo "${reset}" echo "${reset}"