openapi/test-api.sh

   1 #!/bin/bash
   2
   3 # @see https://stackoverflow.com/a/4774063
   4 SCRIPTPATH="$( cd -- "$(dirname "$0")" > /dev/null 2>&1; pwd -P )"
   5
   6 # Move to script's upper directory
   7 cd "${SCRIPTPATH}/.."
   8
   9 # --------------------------------------
  10 # Check `curl` availability
  11 # --------------------------------------
  12
  13 which curl &> /dev/null
  14
  15 if (($? != 0)); then
  16     echo "> curl not found"
  17     exit 1
  18 fi
  19
  20 # --------------------------------------
  21 # Check `php` availability
  22 # --------------------------------------
  23
  24 which php &> /dev/null
  25
  26 if (($? != 0)); then
  27     echo "> php not found"
  28     exit 1
  29 fi
  30
  31 # --------------------------------------
  32 # Get values from bash command-line parameters
  33 # --------------------------------------
  34
  35 HOST="${1:-localhost}"
  36 PORT="${2:-8000}"
  37
  38 # Colors:
  39 # @see https://stackoverflow.com/a/5947802
  40 #
  41 # NO COLOR     0
  42 # Black        0;30     Dark Gray     1;30
  43 # Red          0;31     Light Red     1;31
  44 # Green        0;32     Light Green   1;32
  45 # Brown/Orange 0;33     Yellow        1;33
  46 # Blue         0;34     Light Blue    1;34
  47 # Purple       0;35     Light Purple  1;35
  48 # Cyan         0;36     Light Cyan    1;36
  49 # Light Gray   0;37     White         1;37
  50 #
  51 #      .---------- constant part!
  52 #      vvvv vvvv-- the code from above
  53 # RED='\033[0;31m'
  54 # NC='\033[0m' # No Color
  55 # printf "I ${RED}love${NC} Stack Overflow\n"
  56
  57 # --------------------------------------
  58 # Display message
  59 #
  60 # Flags:
  61 # - 'f': Failure message
  62 # - 's': Success message
  63 # - (empty): Normal message
  64 #
  65 # @param string $1 Message
  66 # @param string $2 Flag
  67 # --------------------------------------
  68 function msg {
  69     local rd='\033[0;31m'
  70     local gr='\033[0;32m'
  71     local nc='\033[0m'
  72
  73     local message="${1}"
  74     local flag="${2}"
  75
  76     if [[ 's' == "${flag}" ]]; then
  77         echo -e "${gr}[✅ SUCCESS] ${message}${nc}"
  78     elif [[ 'f' == "${flag}" ]]; then
  79         echo -e "${rd}[❌ FAILURE] ${message}${nc}"
  80         if [[ "true" == "${STOP_ON_FAILURE}" ]]; then
  81             exit 1
  82         fi
  83     else
  84         echo ">>>>>>>>>>>> ${message}"
  85     fi
  86 }
  87
  88 # --------------------------------------
  89 # Call cURL command
  90 #
  91 # Use following global variables to return/export values:
  92 #
  93 # - CURL_EXIT_CODE
  94 # - CURL_RESPONSE_HEADER
  95 # - CURL_RESPONSE_DATA
  96 #
  97 # @param string $1 Path
  98 # @param string $2 Method
  99 # @param string $3 Data
 100 # --------------------------------------
 101 function callRestApi {
 102     CURL_EXIT_CODE=1
 103     CURL_RESPONSE_HEADER=''
 104     CURL_RESPONSE_DATA=''
 105
 106     local path="${1}"
 107     local method="${2:-GET}"
 108     local data="${3}"
 109
 110     if [[ ! -z "${data}" ]]; then
 111         data="--data ${data}"
 112     fi
 113
 114     curl "${HOST}:${PORT}${path}" \
 115         --request "${method}" \
 116         --header "Content-Type: application/json" \
 117         --header "Accept: application/json" \
 118         --dump-header curl_response_header.txt \
 119         --output curl_response_data.txt \
 120         $data &> /dev/null
 121
 122     CURL_EXIT_CODE=$?
 123
 124     if [ -f curl_response_header.txt ]; then
 125         CURL_RESPONSE_HEADER=$(cat curl_response_header.txt)
 126         rm curl_response_header.txt
 127     fi
 128
 129     if [ -f curl_response_data.txt ]; then
 130         CURL_RESPONSE_DATA=$(cat curl_response_data.txt)
 131         rm curl_response_data.txt
 132     fi
 133 }
 134
 135 # --------------------------------------
 136 # Get the value from a response header
 137 #
 138 # @param string $1 Headers list
 139 # @param string $2 Header name
 140 # --------------------------------------
 141 function getValueFromHeader {
 142     local list="${1}"
 143     local key="${2}"
 144     if [[ "code" == "${key}" ]]; then
 145         echo $(echo "${list}" | grep '^HTTP/' | cut -d' ' -f2 | xargs)
 146     else
 147         echo $(echo "${list}" | grep "^${key}:" | cut -d':' -f2 | xargs)
 148     fi
 149 }
 150
 151 # --------------------------------------
 152 # Count items in JSON list
 153 #
 154 # @param string $1 JSON
 155 # --------------------------------------
 156 function countItemsInJsonList {
 157     local json="${1}"
 158     local php=$(cat << PHP
 159 \$list = json_decode('${json}', true);
 160 echo count(\$list);
 161 PHP
 162 )
 163     echo $(php -r "${php}")
 164 }
 165
 166 # --------------------------------------
 167 # Find an item in a JSON list
 168 #
 169 # @param string $1 JSON
 170 # @param string $2 KEY
 171 # @param string $3 VALUE
 172 # --------------------------------------
 173 function searchByKeyValue {
 174     local json="${1}"
 175     local key="${2}"
 176     local value="${3}"
 177     local php=$(cat << PHP
 178 \$list = json_decode('${json}', true);
 179 \$value = null;
 180 foreach (\$list as \$item) {
 181     if ('${value}' == \$item['${key}']) {
 182         \$value = json_encode(\$item);
 183         break;
 184     }
 185 }
 186 echo \$value;
 187 PHP
 188 )
 189     echo $(php -r "${php}")
 190 }
 191
 192 # --------------------------------------
 193 # Get a value from a JSON string
 194 #
 195 # @param string $1 JSON
 196 # @param string $2 KEY
 197 # --------------------------------------
 198 function getValueFromJson {
 199     local json="${1}"
 200     local key="${2}"
 201     local php=$(cat << PHP
 202 \$list = json_decode('${json}', true);
 203 echo \$list['${key}'];
 204 PHP
 205 )
 206     echo $(php -r "${php}")
 207 }
 208
 209 # ====================================================================
 210
 211 # --------------------------------------
 212 # Helper to interact with an element
 213 #
 214 # @param string $1 HTTP Verb
 215 # @param string $2 URL Path
 216 # @param string $3 JSON
 217 # --------------------------------------
 218 function elementAction {
 219     local verb="${1}"
 220     local path="${2}"
 221     local json="${3}"
 222
 223     msg "Call REST API (${verb}) '${path}'"
 224
 225     callRestApi "${path}" "${verb}" "${json}"
 226
 227     if (( 0 != "${CURL_EXIT_CODE}" )); then
 228         msg 'Failed curl call' f
 229     else
 230         local code="$(getValueFromHeader "${CURL_RESPONSE_HEADER}" "code")"
 231
 232         if (( 200 != $code )); then
 233             msg "(${verb}) '${path}'" f
 234         fi
 235     fi
 236 }
 237
 238 # --------------------------------------
 239 # Helper to get an element (or a list)
 240 #
 241 # @param string $1 URL Path
 242 # --------------------------------------
 243 function elementGet {
 244     local path="${1}"
 245
 246     elementAction 'GET' "${path}"
 247 }
 248
 249 # --------------------------------------
 250 # Helper to create an element
 251 #
 252 # @param string $1 URL Path
 253 # @param string $2 JSON
 254 # --------------------------------------
 255 function elementCreate {
 256     local path="${1}"
 257     local json="${2}"
 258
 259     elementAction 'POST' "${path}" "${json}"
 260 }
 261
 262 # --------------------------------------
 263 # Helper to update an element
 264 #
 265 # @param string $1 URL Path
 266 # @param string $2 JSON
 267 # --------------------------------------
 268 function elementUpdate {
 269     local path="${1}"
 270     local json="${2}"
 271
 272     elementAction 'PUT' "${path}" "${json}"
 273 }
 274
 275 # --------------------------------------
 276 # Helper to delete an element
 277 #
 278 # @param string $1 URL Path
 279 # --------------------------------------
 280 function elementDelete {
 281     local path="${1}"
 282
 283     elementAction 'DELETE' "${path}"
 284 }
 285
 286 # ====================================================================
 287
 288 # --------------------------------------
 289 # Test the creation of a species
 290 #
 291 # @param string $1 Species name (to create)
 292 # --------------------------------------
 293 function testCreateSpecies () {
 294     local name="${1}"
 295     local flag=''
 296
 297     echo '========================================'
 298     msg 'Test species creation'
 299
 300     elementCreate '/especie' '{"nombre":"'$name'"}'
 301
 302     local remote_name=$(getValueFromJson "${CURL_RESPONSE_DATA}" 'nombre')
 303     flag=$([[ "${remote_name}" == "${name}" ]] && echo "s" || echo "f")
 304     msg "[new] Species name (${name}, ${remote_name})" "${flag}"
 305
 306     NEW_ID="$(getValueFromJson "${CURL_RESPONSE_DATA}" "id")"
 307 }
 308
 309 # --------------------------------------
 310 # Test the list of species
 311 #
 312 # @param string $1 Expected amount of species (in the list)
 313 # @param string $2 Expected species id (used if given)
 314 # @param string $3 Expected species name (used if given)
 315 # --------------------------------------
 316 function testListSpecies () {
 317     local amount="${1}"
 318     local id="${2}"
 319     local name="${3}"
 320
 321     echo '========================================'
 322     msg 'Test species listing'
 323
 324     elementGet '/especie'
 325
 326     local remote_amount=$(countItemsInJsonList "${CURL_RESPONSE_DATA}")
 327     flag=$( (($remote_amount == $amount)) && echo "s" || echo "f" )
 328     msg "[list] Amount of species (${amount}, ${remote_amount})" "${flag}"
 329
 330     if [[ "${id}" ]]; then
 331         local json=$(searchByKeyValue "${CURL_RESPONSE_DATA}" 'id' "${id}")
 332
 333         if [[ "${json}" ]]; then
 334             msg "[list] Species found (ID ${id})" "s"
 335
 336             if [[ "${name}" ]]; then
 337                 local remote_name=$(getValueFromJson "${json}" 'nombre')
 338                 flag=$([[ "${remote_name}" == "${name}" ]] && echo "s" || echo "f")
 339                 msg "[list] Species name (${name}, ${remote_name})" "${flag}"
 340             fi
 341         else
 342             msg "[list] Species not found (ID ${id})" "f"
 343         fi
 344     fi
 345 }
 346
 347 # --------------------------------------
 348 # Test the edition of a species
 349 #
 350 # @param string $1 Species ID (to edit)
 351 # @param string $2 New species name
 352 # --------------------------------------
 353 function testEditSpecies () {
 354     local id="${1}"
 355     local name="${2}"
 356
 357     echo '========================================'
 358     msg 'Test species edition'
 359
 360     elementUpdate "/especie/${id}" '{"nombre":"'$name'"}'
 361
 362     local remote_id=$(getValueFromJson "${CURL_RESPONSE_DATA}" 'id')
 363     flag=$([[ "${remote_id}" == "${id}" ]] && echo "s" || echo "f")
 364     msg "[edit] Species id (${id}, ${remote_id})" "${flag}"
 365
 366     local remote_name=$(getValueFromJson "${CURL_RESPONSE_DATA}" 'nombre')
 367     flag=$([[ "${remote_name}" == "${name}" ]] && echo "s" || echo "f")
 368     msg "[edit] Species name (${name}, ${remote_name})" "${flag}"
 369 }
 370
 371 # --------------------------------------
 372 # Test the deletion of a species
 373 #
 374 # @param string $1 Species ID (to edit)
 375 # @param string $2 Species name (used if given)
 376 # --------------------------------------
 377 function testDeleteSpecies () {
 378     local id="${1}"
 379     local name="${2}"
 380
 381     echo '========================================'
 382     msg 'Test species deletion'
 383
 384     elementDelete "/especie/${id}"
 385
 386     local remote_id=$(getValueFromJson "${CURL_RESPONSE_DATA}" 'id')
 387     flag=$([[ "${remote_id}" == "${id}" ]] && echo "s" || echo "f")
 388     msg "[delete] Species id (${id}, ${remote_id})" "${flag}"
 389
 390     if [[ "${name}" ]]; then
 391         local remote_name=$(getValueFromJson "${CURL_RESPONSE_DATA}" 'nombre')
 392         flag=$([[ "${remote_name}" == "${name}" ]] && echo "s" || echo "f")
 393         msg "[delete] Species name (${name}, ${remote_name})" "${flag}"
 394     fi
 395 }
 396
 397 # ====================================================================
 398
 399 # Remove and create DDBB
 400 # ----------------------
 401
 402 rm -f database.sqlite
 403 sqlite3 database.sqlite < esquema-ddbb.sql
 404
 405 # ====================================================================
 406
 407 # Species battery of tests
 408 # ------------------------
 409
 410 testListSpecies 0
 411
 412 SPECIES_DOG_NAME='perroxxxx'
 413 testCreateSpecies "${SPECIES_DOG_NAME}"
 414 SPECIES_DOG_ID="${NEW_ID}"
 415 testListSpecies 1 "${SPECIES_DOG_ID}" "${SPECIES_DOG_NAME}"
 416 SPECIES_DOG_NAME='perro'
 417 testEditSpecies "${SPECIES_DOG_ID}" "${SPECIES_DOG_NAME}"
 418 testListSpecies 1 "${SPECIES_DOG_ID}" "${SPECIES_DOG_NAME}"
 419
 420 SPECIES_CAT_NAME='gatoxxxx'
 421 testCreateSpecies "${SPECIES_CAT_NAME}"
 422 SPECIES_CAT_ID="${NEW_ID}"
 423 testListSpecies 2 "${SPECIES_CAT_ID}" "${SPECIES_CAT_NAME}"
 424 SPECIES_CAT_NAME='gato'
 425 testEditSpecies "${SPECIES_CAT_ID}" "${SPECIES_CAT_NAME}"
 426 testListSpecies 2 "${SPECIES_CAT_ID}" "${SPECIES_CAT_NAME}"
 427
 428 SPECIES_TMP_NAME='conejoxxxx'
 429 testCreateSpecies "${SPECIES_TMP_NAME}"
 430 SPECIES_TMP_ID="${NEW_ID}"
 431 testListSpecies 3 "${SPECIES_TMP_ID}" "${SPECIES_TMP_NAME}"
 432 SPECIES_TMP_NAME='conejo'
 433 testEditSpecies "${SPECIES_TMP_ID}" "${SPECIES_TMP_NAME}"
 434 testListSpecies 3 "${SPECIES_TMP_ID}" "${SPECIES_TMP_NAME}"
 435
 436 testDeleteSpecies "${SPECIES_TMP_ID}" "${SPECIES_TMP_NAME}"
 437 testListSpecies 2 "${SPECIES_DOG_ID}" "${SPECIES_DOG_NAME}"
 438 testListSpecies 2 "${SPECIES_CAT_ID}" "${SPECIES_CAT_NAME}"
 439
 440 # ====================================================================