-
Notifications
You must be signed in to change notification settings - Fork 0
/
setChecker.sh
executable file
·212 lines (194 loc) · 7.36 KB
/
setChecker.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
#!/usr/bin/env bash
#
# File: https://github.com/cloud-helpers/k8s-job-wrappers/tree/main/setChecker.sh
#
# Utility supporting executing tasks from within Kubernetes (k8s) pods
#
# Functions performing checks, e.g., that a specific environment variable has
# been set, or that a specific file exists and is accessible
#
# Dependencies:
# * setDistAndArch.sh (https://github.com/cloud-helpers/k8s-job-wrappers/tree/main/setDistAndArch.sh)
# * setGnuTools.sh (https://github.com/cloud-helpers/k8s-job-wrappers/tree/main/setGnuTools.sh)
# * setLogFunc.sh (https://github.com/cloud-helpers/k8s-job-wrappers/tree/main/setLogFunc.sh)
#
#
THIS_KJW_SCRIPT_URL="https://github.com/cloud-helpers/k8s-job-wrappers/tree/main/setCheckers.sh"
KJW_FUNC="default"
# Derive where KJW has been installed
# Reference: https://stackoverflow.com/a/246128/798053
KJW_CURRENT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)"
# Set up environment variables for the Linux distribution, host name
# and architecture
source ${KJW_CURRENT_DIR}/setDistAndArch.sh
retval=$?
if [ "${retval}" != 0 ]
then
echo "Call to setDistAndArch.sh failed. Returned code: ${retval}" > /dev/stderr
return ${retval}
fi
# Set up envrionment variables for command-line tools differing on MacOS
source ${KJW_CURRENT_DIR}/setGnuTools.sh
retval=$?
if [ "${retval}" != 0 ]
then
echo "Call to setGnuTools.sh failed. Returned code: ${retval}" > /dev/stderr
return ${retval}
fi
# Set up envrionment variables for logging support functions
source ${KJW_CURRENT_DIR}/setLogFunc.sh
retval=$?
if [ "${retval}" != 0 ]
then
echo "Call to setGnuTools.sh failed. Returned code: ${retval}" > /dev/stderr
return ${retval}
fi
# Check that a list of environment variables have been specified
assertEnvVar() {
declare -a envVarNameList=($@)
for idx in "${!envVarNameList[@]}"
do
local myEnvVarName="${envVarNameList[$idx]}"
local myEnvVarValue="${!myEnvVarName}"
if [ -z "${myEnvVarValue}" ]
then
if [ -z "${KJW_LOG_FILE}" -o ! -w "${KJW_LOG_FILE}" ]
then
# The log file has not been specified yet, so we log onto
# the standard error stream
echo "Error - The ${myEnvVarName} environment variable should be set, but is not." > /dev/stderr
echo " Current script: ${KJW_SCRIPT_URL}" > /dev/stderr
if [ ! -z "${KJW_K8S_DEPL_FILE}" ]
then
echo " That script is usually launched by a Kubernetes deployment (${KJW_K8S_DEPL_FILE})" > /dev/stderr
fi
else
# The log file has been specified, so we log onto it
if [ -z "${KJW_K8S_DEPL_FILE}" ]
then
logMulti "Error - The ${myEnvVarName} environment variable should be set, but is not." \
" Current script: ${KJW_SCRIPT_URL}"
else
logMulti "Error - The ${myEnvVarName} environment variable should be set, but is not." \
" Current script: ${KJW_SCRIPT_URL}" \
" That script is usually launched by a Kubernetes deployment (${KJW_K8S_DEPL_FILE})"
fi
fi
# Return the position of the first environment variable not
# specified
return $(( $idx + 1 ))
fi
done
}
# Check that a list of directories exist and are accessible
assertDirExistence() {
declare -a envVarNameList=($@)
for idx in "${!envVarNameList[@]}"
do
local myEnvVarName="${envVarNameList[$idx]}"
local myEnvVarValue="${!myEnvVarName}"
if [ ! -d "${myEnvVarValue}" ]
then
if [ -z "${KJW_LOG_FILE}" -o ! -w "${KJW_LOG_FILE}" ]
then
# The log file has not been specified yet, so we log onto
# the standard error stream
echo "Error - The ${myEnvVarValue} directory should exist and be accessible, but does not." > /dev/stderr
echo " Current script: ${KJW_SCRIPT_URL}" > /dev/stderr
if [ ! -z "${KJW_K8S_DEPL_FILE}" ]
then
echo " That script is usually launched by a Kubernetes deployment (${KJW_K8S_DEPL_FILE})" > /dev/stderr
fi
else
# The log file has been specified, so we log onto it
if [ -z "${KJW_K8S_DEPL_FILE}" ]
then
logMulti "Error - The ${myEnvVarValue} directory should exist and be accessible, but does not." \
" Current script: ${KJW_SCRIPT_URL}"
else
logMulti "Error - The ${myEnvVarValue} directory should exist and be accessible, but does not." \
" Current script: ${KJW_SCRIPT_URL}" \
" That script is usually launched by a Kubernetes deployment (${KJW_K8S_DEPL_FILE})"
fi
fi
# Return the position of the first environment variable not
# specified
return $(( $idx + 1 ))
fi
done
}
# Check that a list of files exist and are accessible
assertFileExistence() {
declare -a envVarNameList=($@)
for idx in "${!envVarNameList[@]}"
do
local myEnvVarName="${envVarNameList[$idx]}"
local myEnvVarValue="${!myEnvVarName}"
if [ ! -f "${myEnvVarValue}" ]
then
if [ -z "${KJW_LOG_FILE}" -o ! -w "${KJW_LOG_FILE}" ]
then
# The log file has not been specified yet, so we log onto
# the standard error stream
echo "Error - The ${myEnvVarValue} file should exist and be accessible, but does not." > /dev/stderr
echo " Current script: ${KJW_SCRIPT_URL}" > /dev/stderr
if [ ! -z "${KJW_K8S_DEPL_FILE}" ]
then
echo " That script is usually launched by a Kubernetes deployment (${KJW_K8S_DEPL_FILE})" > /dev/stderr
fi
else
# The log file has been specified, so we log onto it
if [ -z "${KJW_K8S_DEPL_FILE}" ]
then
logMulti "Error - The ${myEnvVarValue} directory should exist and be accessible, but does not." \
" Current script: ${KJW_SCRIPT_URL}"
else
logMulti "Error - The ${myEnvVarValue} file should exist and be accessible, but does not." \
" Current script: ${KJW_SCRIPT_URL}" \
" That script is usually launched by a Kubernetes deployment (${KJW_K8S_DEPL_FILE})"
fi
fi
# Return the position of the first environment variable not
# specified
return $(( $idx + 1 ))
fi
done
}
# Check that a list of files (whatever the type, could be directories) exist
# and are accessible
assertFileWriteable() {
declare -a envVarNameList=($@)
for idx in "${!envVarNameList[@]}"
do
local myEnvVarName="${envVarNameList[$idx]}"
local myEnvVarValue="${!myEnvVarName}"
if [ ! -w "${myEnvVarValue}" ]
then
if [ -z "${KJW_LOG_FILE}" -o ! -w "${KJW_LOG_FILE}" ]
then
# The log file has not been specified yet, so we log onto
# the standard error stream
echo "Error - The ${myEnvVarValue} file/directory should exist and be writeable, but does not." > /dev/stderr
echo " Current script: ${KJW_SCRIPT_URL}" > /dev/stderr
if [ ! -z "${KJW_K8S_DEPL_FILE}" ]
then
echo " That script is usually launched by a Kubernetes deployment (${KJW_K8S_DEPL_FILE})" > /dev/stderr
fi
else
# The log file has been specified, so we log onto it
if [ -z "${KJW_K8S_DEPL_FILE}" ]
then
logMulti "Error - The ${myEnvVarValue} directory should exist and be writeable, but does not." \
" Current script: ${KJW_SCRIPT_URL}"
else
logMulti "Error - The ${myEnvVarValue} file should exist and be writeable, but does not." \
" Current script: ${KJW_SCRIPT_URL}" \
" That script is usually launched by a Kubernetes deployment (${KJW_K8S_DEPL_FILE})"
fi
fi
# Return the position of the first environment variable not
# specified
return $(( $idx + 1 ))
fi
done
}