From a82813501baf46460a30bf4b835e867ddefeb8fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Chastanet?= Date: Mon, 27 Nov 2023 22:53:25 +0100 Subject: [PATCH] migrated to bash-tools-framework 1.1.8 - get rid of build.sh --- .cspell.json | 1 + .framework-config | 23 +- .github/workflows/lint-test.yml | 11 - .pre-commit-config.yaml | 26 +- Commands.tmpl.md | 9 - bin/cli | 351 ++++------------- bin/dbImport | 327 ++++------------ bin/dbImportProfile | 341 ++++------------- bin/dbImportStream | 327 ++++------------ bin/dbQueryAllDatabases | 355 ++++------------- bin/dbScriptAllDatabases | 355 ++++------------- bin/doc | 341 ++++------------- bin/gitIsAncestorOf | 341 ++++------------- bin/gitIsBranch | 341 ++++------------- bin/gitRenameBranch | 341 ++++------------- bin/installRequirements | 359 ++++-------------- bin/mysql2puml | 331 ++++------------ bin/upgradeGithubRelease | 351 ++++------------- bin/waitForIt | 325 ++++------------ bin/waitForMysql | 341 ++++------------- build.sh | 37 -- conf/dbScripts/extractData | 190 ++------- install | 329 +++------------- .../Converters/testsData/mysql2puml.help.txt | 3 +- src/_binaries/DbImport/dbImport.bats | 1 - .../testsData/auto_default.local_fromDb_20.sh | 2 +- .../DbImport/testsData/dbImport.help.txt | 3 +- .../testsData/dbImportProfile.help.txt | 3 +- .../testsData/dbImportStream.help.txt | 3 +- .../testsData/dbQueryAllDatabases.help.txt | 3 +- .../testsData/dbScriptAllDatabases.help.txt | 3 +- src/_binaries/Docker/testsData/cli.help.txt | 3 +- .../Git/testsData/gitIsAncestorOf.help.txt | 3 +- .../Git/testsData/gitRenameBranch.help.txt | 3 +- .../testsData/upgradeGithubRelease.help.txt | 3 +- .../Utils/testsData/waitForIt.help.txt | 3 +- .../Utils/testsData/waitForMysql.help.txt | 3 +- src/_binaries/build/doc.sh | 2 +- .../build/installRequirements.options.tpl | 1 - 39 files changed, 1186 insertions(+), 4609 deletions(-) delete mode 100755 build.sh diff --git a/.cspell.json b/.cspell.json index d89c1761..e0c72000 100644 --- a/.cspell.json +++ b/.cspell.json @@ -19,6 +19,7 @@ ".jscpd.json", ".mega-linter.yml", ".shellcheckrc", + "**/*.svg", ".env", "**/*.help.txt" ], diff --git a/.framework-config b/.framework-config index 034a27e3..13906e84 100755 --- a/.framework-config +++ b/.framework-config @@ -1,22 +1,35 @@ #!/usr/bin/env bash # shellcheck disable=SC2034 -BASH_TOOLS_ROOT_DIR="${BASH_TOOLS_ROOT_DIR:-$(pwd)}" -REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" -FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")" && pwd -P)}" +BASH_TOOLS_ROOT_DIR="${BASH_TOOLS_ROOT_DIR:-$(cd "$(readlink -e "${BASH_SOURCE[0]%/*}")" && pwd -P)}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-${BASH_TOOLS_ROOT_DIR}/vendor/bash-tools-framework}" FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" +# compile parameters +# srcFile : file that needs to be compiled +# templateDir : directory from which bash-tpl templates will be searched +# binDir : fallback bin directory in case BIN_FILE has not been provided +# rootDir : directory used to compute src file relative path +# srcDirs : additional directories where to find the functions +COMPILE_PARAMETERS=( + --src-dir "${BASH_TOOLS_ROOT_DIR}/src" + --src-dir "${FRAMEWORK_SRC_DIR}" + --bin-dir "${BASH_TOOLS_ROOT_DIR}/bin" + --root-dir "${BASH_TOOLS_ROOT_DIR}" + --template-dir "${BASH_TOOLS_ROOT_DIR}/src" +) + # describe the functions that will be skipped from being imported FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|IMPORT::dir::file|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|^install$|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^conf/)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^build.sh$|^conf/|^bin/|.framework-config|^install$|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^conf/|^bin/|.framework-config|^install$|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^conf/|^bin/|^\.framework-config$|^build.sh$|\.tpl$|testsData/binaryFile$}" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^conf/|^bin/|^\.framework-config$|\.tpl$|testsData/binaryFile$}" # Source directories if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then FRAMEWORK_SRC_DIRS=( diff --git a/.github/workflows/lint-test.yml b/.github/workflows/lint-test.yml index 056bff3d..98b5b8ed 100644 --- a/.github/workflows/lint-test.yml +++ b/.github/workflows/lint-test.yml @@ -70,17 +70,6 @@ jobs: name: build bash-tools-${{matrix.vendor}}-${{matrix.bashTarVersion}} status: pending - - name: Pull/Build/Push docker image - env: - BRANCH: ${GITHUB_REF##*/} - run: | - vendor/bash-tools-framework/bin/buildPushDockerImage \ - --vendor "${{ matrix.vendor }}" \ - --bash-version "${{ matrix.bashTarVersion }}" \ - --bash-base-image "${{ matrix.bashImage }}" \ - --branch-name "${GITHUB_REF##*/}" \ - --push -vvv - - name: Check image run: | docker run --rm \ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6328db0a..8a876cd5 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -16,6 +16,10 @@ repos: hooks: - id: mixed-line-ending - id: end-of-file-fixer + exclude: | + (?x)( + .svg$ + ) - id: check-executables-have-shebangs - id: check-shebang-scripts-are-executable - id: check-xml @@ -57,7 +61,7 @@ repos: - id: prettier - repo: https://github.com/fchastanet/bash-tools-framework - rev: 1.1.5 + rev: 1.1.8 hooks: - id: fixShebangExecutionBit - id: fixShebangExecutionBitGithubActions @@ -87,6 +91,12 @@ repos: - id: plantuml - id: buildShFiles - id: buildShFilesGithubAction + - id: runUnitTests + # not manual as github will run UT with several versions of bash and arch + stages: [pre-commit] + - id: megalinterCheckVersion + - id: megalinter + - id: megalinterGithubAction - repo: local hooks: @@ -95,7 +105,7 @@ repos: name: build doc files language: script entry: bin/doc - args: [--verbose, --skip-docker-build] + args: [-vvv] pass_filenames: false require_serial: true always_run: true @@ -104,17 +114,5 @@ repos: - <<: *BUILD_DOC_FILES id: buildDocFilesGithubAction name: build doc files for Github Actions - args: [--verbose] fail_fast: false stages: [manual] - - # manual stage used to select github action with megalinter full config - - repo: https://github.com/fchastanet/bash-tools-framework - rev: 1.1.5 - hooks: - - id: runUnitTests - # not manual as github will run UT with several versions of bash and arch - stages: [pre-commit] - - id: megalinterCheckVersion - - id: megalinter - - id: megalinterGithubAction diff --git a/Commands.tmpl.md b/Commands.tmpl.md index d59164a5..d5165ebc 100644 --- a/Commands.tmpl.md +++ b/Commands.tmpl.md @@ -7,7 +7,6 @@ - [1.4. bin/doc](#14-bindoc) - [1.5. bin/findShebangFiles](#15-binfindshebangfiles) - [1.6. bin/test](#16-bintest) - - [1.7. bin/runBuildContainer](#17-binrunbuildcontainer) - [2. Converter and Generator tools](#2-converter-and-generator-tools) - [2.1. bin/generateShellDoc](#21-bingenerateshelldoc) - [2.2. bin/mysql2puml](#22-binmysql2puml) @@ -78,14 +77,6 @@ imported from bash-tools-framework @@@test_help@@@ ``` -### 1.7. bin/runBuildContainer - -imported from bash-tools-framework - -```text -@@@runBuildContainer_help@@@ -``` - ## 2. Converter and Generator tools ### 2.1. bin/generateShellDoc diff --git a/bin/cli b/bin/cli index d1c8454a..11e0c762 100755 --- a/bin/cli +++ b/bin/cli @@ -426,42 +426,38 @@ Database::checkDsnFile() { } # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description Log namespace provides 2 kind of functions @@ -732,122 +728,6 @@ Conf::list() { ) } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -885,15 +765,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -988,81 +859,13 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" - fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" -} - -# @description log message to file +# @description Display message using skip color (yellow) # @arg $1 message:String the message to display -Log::logSkipped() { - if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then - Log::logMessage "${2:-SKIPPED}" "$1" +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi + Log::logSkipped "$1" } # @description ensure command realpath is available @@ -1072,20 +875,12 @@ Linux::requireRealpathCommand() { Assert::commandExists realpath } -# @description check if an element is contained in an array -# -# @arg $1 needle:String -# @arg $@ array:String[] -# @exitcode 0 if found -# @exitcode 1 otherwise -# @example -# Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}" -Array::contains() { - local element - for element in "${@:2}"; do - [[ "${element}" = "$1" ]] && return 0 - done - return 1 +# @description log message to file +# @arg $1 message:String the message to display +Log::logSkipped() { + if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then + Log::logMessage "${2:-SKIPPED}" "$1" + fi } # FUNCTIONS @@ -1181,6 +976,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1315,54 +1111,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -1737,7 +1526,7 @@ cliCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/bin/dbImport b/bin/dbImport index 08d1c973..33acf693 100755 --- a/bin/dbImport +++ b/bin/dbImport @@ -512,28 +512,38 @@ Database::setQueryOptions() { } # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") + fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description delete files older than n days in given path @@ -571,20 +581,6 @@ Framework::createTempFile() { mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" } -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" -} - # @description Log namespace provides 2 kind of functions # - Log::display* allows to display given message with # given display level @@ -900,41 +896,6 @@ Conf::list() { ) } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - # @description check if dsn file has all the mandatory variables set # Mandatory variables are: HOSTNAME, USER, PASSWORD, PORT # @@ -986,87 +947,6 @@ Database::checkDsnFile() { ) } -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -1104,15 +984,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -1249,65 +1120,20 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" +# @description Display message using skip color (yellow) +# @arg $1 message:String the message to display +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 + Log::logSkipped "$1" } -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 +# @description ensure command realpath is available +# @exitcode 1 if realpath command not available +# @stderr diagnostics information is displayed +Linux::requireRealpathCommand() { + Assert::commandExists realpath } # @description log message to file @@ -1318,13 +1144,6 @@ Log::logSkipped() { fi } -# @description ensure command realpath is available -# @exitcode 1 if realpath command not available -# @stderr diagnostics information is displayed -Linux::requireRealpathCommand() { - Assert::commandExists realpath -} - # FUNCTIONS facade_main_dbImportsh() { @@ -1425,6 +1244,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1559,54 +1379,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -2243,7 +2056,7 @@ dbImportCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/bin/dbImportProfile b/bin/dbImportProfile index 66f5282d..0d7b4c40 100755 --- a/bin/dbImportProfile +++ b/bin/dbImportProfile @@ -394,42 +394,38 @@ Database::setQueryOptions() { } # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description Log namespace provides 2 kind of functions @@ -770,41 +766,6 @@ Conf::list() { ) } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - # @description check if dsn file has all the mandatory variables set # Mandatory variables are: HOSTNAME, USER, PASSWORD, PORT # @@ -856,87 +817,6 @@ Database::checkDsnFile() { ) } -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -962,15 +842,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -1065,23 +936,6 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - # @description concatenate 2 paths and ensure the path is correct using realpath -m # @arg $1 basePath:String # @arg $2 subPath:String @@ -1094,56 +948,13 @@ File::concatenatePath() { realpath -m "${fullPath}" 2>/dev/null } -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" +# @description Display message using skip color (yellow) +# @arg $1 message:String the message to display +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" + Log::logSkipped "$1" } # @description log message to file @@ -1154,22 +965,6 @@ Log::logSkipped() { fi } -# @description check if an element is contained in an array -# -# @arg $1 needle:String -# @arg $@ array:String[] -# @exitcode 0 if found -# @exitcode 1 otherwise -# @example -# Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}" -Array::contains() { - local element - for element in "${@:2}"; do - [[ "${element}" = "$1" ]] && return 0 - done - return 1 -} - # @description ensure command realpath is available # @exitcode 1 if realpath command not available # @stderr diagnostics information is displayed @@ -1268,6 +1063,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1402,54 +1198,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -1872,7 +1661,7 @@ dbImportProfileCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/bin/dbImportStream b/bin/dbImportStream index 045b6309..6d8fb926 100755 --- a/bin/dbImportStream +++ b/bin/dbImportStream @@ -449,28 +449,38 @@ Database::setQueryOptions() { } # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") + fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description create a temp file using default TMPDIR variable @@ -481,20 +491,6 @@ Framework::createTempFile() { mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" } -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" -} - # @description Log namespace provides 2 kind of functions # - Log::display* allows to display given message with # given display level @@ -810,41 +806,6 @@ Conf::list() { ) } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - # @description check if dsn file has all the mandatory variables set # Mandatory variables are: HOSTNAME, USER, PASSWORD, PORT # @@ -896,87 +857,6 @@ Database::checkDsnFile() { ) } -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -1014,15 +894,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -1159,65 +1030,20 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" +# @description Display message using skip color (yellow) +# @arg $1 message:String the message to display +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 + Log::logSkipped "$1" } -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 +# @description ensure command realpath is available +# @exitcode 1 if realpath command not available +# @stderr diagnostics information is displayed +Linux::requireRealpathCommand() { + Assert::commandExists realpath } # @description log message to file @@ -1228,13 +1054,6 @@ Log::logSkipped() { fi } -# @description ensure command realpath is available -# @exitcode 1 if realpath command not available -# @stderr diagnostics information is displayed -Linux::requireRealpathCommand() { - Assert::commandExists realpath -} - # FUNCTIONS facade_main_dbImportStreamsh() { @@ -1329,6 +1148,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1463,54 +1283,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -2055,7 +1868,7 @@ dbImportStreamCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/bin/dbQueryAllDatabases b/bin/dbQueryAllDatabases index 2b198934..06ffbbe0 100755 --- a/bin/dbQueryAllDatabases +++ b/bin/dbQueryAllDatabases @@ -440,42 +440,38 @@ Database::setQueryOptions() { } # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description Log namespace provides 2 kind of functions @@ -807,41 +803,6 @@ Conf::list() { ) } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - # @description check if dsn file has all the mandatory variables set # Mandatory variables are: HOSTNAME, USER, PASSWORD, PORT # @@ -932,87 +893,6 @@ Database::query() { fi } -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -1050,15 +930,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -1195,81 +1066,13 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" - fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" -} - -# @description log message to file +# @description Display message using skip color (yellow) # @arg $1 message:String the message to display -Log::logSkipped() { - if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then - Log::logMessage "${2:-SKIPPED}" "$1" +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi + Log::logSkipped "$1" } # @description ensure command realpath is available @@ -1279,28 +1082,20 @@ Linux::requireRealpathCommand() { Assert::commandExists realpath } -# @description check if an element is contained in an array -# -# @arg $1 needle:String -# @arg $@ array:String[] -# @exitcode 0 if found -# @exitcode 1 otherwise -# @example -# Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}" -Array::contains() { - local element - for element in "${@:2}"; do - [[ "${element}" = "$1" ]] && return 0 - done - return 1 +# @description log message to file +# @arg $1 message:String the message to display +Log::logSkipped() { + if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then + Log::logMessage "${2:-SKIPPED}" "$1" + fi } # FUNCTIONS # @require Compiler::Embed::requireEmbedBinDir -declare -gx embed_function_DbQueryOneDatabase="${PERSISTENT_TMPDIR:-/tmp}/bin/db083cb53bb15c706d27273bb2620268/dbQueryOneDatabase" -declare -gx encoded_binary_file_DbQueryOneDatabase="#!/usr/bin/env bash
###############################################################################
# GENERATED FACADE FROM https://github.com/fchastanet/bash-tools/tree/master/../bash-dev-env/vendor/bash-tools-framework/src/Compiler/Embed/embedFrameworkFunction.binFile.tpl
# DO NOT EDIT IT
# @generated
###############################################################################
# shellcheck disable=SC2288,SC2034
# BIN_FILE=${BIN_FILE}
# FACADE

# ensure that no user aliases could interfere with
# commands used in this script
unalias -a || true
shopt -u expand_aliases

# shellcheck disable=SC2034
((failures = 0)) || true

# Bash will remember & return the highest exit code in a chain of pipes.
# This way you can catch the error inside pipes, e.g. mysqldump | gzip
set -o pipefail
set -o errexit

# Command Substitution can inherit errexit option since bash v4.4
shopt -s inherit_errexit || true

# a log is generated when a command fails
set -o errtrace

# use nullglob so that (file*.php) will return an empty array if no file matches the wildcard
shopt -s nullglob

# ensure regexp are interpreted without accentuated characters
export LC_ALL=POSIX

export TERM=xterm-256color

# avoid interactive install
export DEBIAN_FRONTEND=noninteractive
export DEBCONF_NONINTERACTIVE_SEEN=true

# store command arguments for later usage
# shellcheck disable=SC2034
declare -a BASH_FRAMEWORK_ARGV=("$@")
# shellcheck disable=SC2034
declare -a ORIGINAL_BASH_FRAMEWORK_ARGV=("$@")

# @see https://unix.stackexchange.com/a/386856
# shellcheck disable=SC2317
interruptManagement() {
  # restore SIGINT handler
  trap - INT
  # ensure that Ctrl-C is trapped by this script and not by sub process
  # report to the parent that we have indeed been interrupted
  kill -s INT "$$"
}
trap interruptManagement INT
SCRIPT_NAME=${0##*/}
REAL_SCRIPT_FILE="$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")"
if [[ -n "${EMBED_CURRENT_DIR}" ]]; then
  CURRENT_DIR="${EMBED_CURRENT_DIR}"
else
  CURRENT_DIR="$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")" && pwd -P)"
fi

################################################
# Temp dir management
################################################

KEEP_TEMP_FILES="${KEEP_TEMP_FILES:-0}"
export KEEP_TEMP_FILES

# PERSISTENT_TMPDIR is not deleted by traps
PERSISTENT_TMPDIR="${TMPDIR:-/tmp}/bash-framework"
export PERSISTENT_TMPDIR
mkdir -p "${PERSISTENT_TMPDIR}"

# shellcheck disable=SC2034
TMPDIR="$(mktemp -d -p "${PERSISTENT_TMPDIR:-/tmp}" -t bash-framework-$$-XXXXXX)"
export TMPDIR

# temp dir cleaning
# shellcheck disable=SC2317
cleanOnExit() {
  if [[ "${KEEP_TEMP_FILES:-0}" = "1" ]]; then
    Log::displayInfo "KEEP_TEMP_FILES=1 temp files kept here '${TMPDIR}'"
  elif [[ -n "${TMPDIR+xxx}" ]]; then
    Log::displayDebug "KEEP_TEMP_FILES=0 removing temp files '${TMPDIR}'"
    rm -Rf "${TMPDIR:-/tmp/fake}" >/dev/null 2>&1
  fi
}
trap cleanOnExit EXIT HUP QUIT ABRT TERM

# VAR_MAIN_FUNCTION_VAR_NAME=dbQueryAllDatabasesFacade

# @description used to execute given query when using
# dbScriptAllDatabases
# @arg $1 dsn:String
# @arg $2 db:String
# @env query String
# @env optionSeparator String
# @require Linux::requireExecutedAsUser
Db::queryOneDatabase() {
  # query and optionSeparator are passed via export
  local dsn="$1"
  local db="$2"

  local -A dbInstance
  Database::newInstance dbInstance "${dsn}"
  Database::setQueryOptions dbInstance "${dbInstance[QUERY_OPTIONS]} --connect-timeout=5"

  # identify columns header
  echo -n "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  Database::skipColumnNames dbInstance 0

  # shellcheck disable=SC2154
  if ! Database::query dbInstance "${query}" "${db}" | sed "s/\t/${optionSeparator}/g"; then
    Log::fatal "database ${db} error" 1>&2
  fi
}

# @description Log namespace provides 2 kind of functions
# - Log::display* allows to display given message with
#   given display level
# - Log::log* allows to log given message with
#   given log level
# Log::display* functions automatically log the message too
# @see Env::requireLoad to load the display and log level from .env file

# @description log level off
export __LEVEL_OFF=0
# @description log level error
export __LEVEL_ERROR=1
# @description log level warning
export __LEVEL_WARNING=2
# @description log level info
export __LEVEL_INFO=3
# @description log level success
export __LEVEL_SUCCESS=3
# @description log level debug
export __LEVEL_DEBUG=4

# @description verbose level off
export __VERBOSE_LEVEL_OFF=0
# @description verbose level info
export __VERBOSE_LEVEL_INFO=1
# @description verbose level info
export __VERBOSE_LEVEL_DEBUG=2
# @description verbose level info
export __VERBOSE_LEVEL_TRACE=3

# @description Display message using debug color (grey)
# @arg $1 message:String the message to display
Log::displayDebug() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_DEBUG)); then
    echo -e "${__DEBUG_COLOR}DEBUG   - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logDebug "$1"
}

# @description Display message using info color (bg light blue/fg white)
# @arg $1 message:String the message to display
Log::displayInfo() {
  local type="${2:-INFO}"
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then
    echo -e "${__INFO_COLOR}${type}    - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logInfo "$1" "${type}"
}

# @description ensure COMMAND_BIN_DIR env var is set
# and PATH correctly prepared
# @noargs
# @set COMMAND_BIN_DIR string the directory where to find this command
# @set PATH string add directory where to find this command binary
Compiler::Facade::requireCommandBinDir() {
  COMMAND_BIN_DIR="${CURRENT_DIR}"
  Env::pathPrepend "${COMMAND_BIN_DIR}"
}

# @description create a new db instance
# Returns immediately if the instance is already initialized
#
# @arg $1 instanceNewInstance:&Map<String,String> (passed by reference) database instance to use
# @arg $2 dsn:String dsn profile - load the dsn.env profile deduced using rules defined in Conf::getAbsoluteFile
#
# @example
#   declare -Agx dbInstance
#   Database::newInstance dbInstance "default.local"
#
# @exitcode 1 if dns file not able to loaded
Database::newInstance() {
  local -n instanceNewInstance=$1
  local dsn="$2"
  local DSN_FILE

  if [[ -v instanceNewInstance['INITIALIZED'] && "${instanceNewInstance['INITIALIZED']:-0}" == "1" ]]; then
    return
  fi

  # final auth file generated from dns file
  instanceNewInstance['AUTH_FILE']=""
  instanceNewInstance['DSN_FILE']=""

  # check dsn file
  DSN_FILE="$(Conf::getAbsoluteFile "dsn" "${dsn}" "env")" || return 1
  Database::checkDsnFile "${DSN_FILE}" || return 1
  instanceNewInstance['DSN_FILE']="${DSN_FILE}"

  # shellcheck source=/src/Database/testsData/dsn_valid.env
  source "${instanceNewInstance['DSN_FILE']}"

  instanceNewInstance['USER']="${USER}"
  instanceNewInstance['PASSWORD']="${PASSWORD}"
  instanceNewInstance['HOSTNAME']="${HOSTNAME}"
  instanceNewInstance['PORT']="${PORT}"

  # generate authFile for easy authentication
  instanceNewInstance['AUTH_FILE']=$(mktemp -p "${TMPDIR:-/tmp}" -t "mysql.XXXXXXXXXXXX")
  (
    echo "[client]"
    echo "user = ${USER}"
    echo "password = ${PASSWORD}"
    echo "host = ${HOSTNAME}"
    echo "port = ${PORT}"
  ) >"${instanceNewInstance['AUTH_FILE']}"

  # some of those values can be overridden using the dsn file
  # SKIP_COLUMN_NAMES enabled by default
  instanceNewInstance['SKIP_COLUMN_NAMES']="${SKIP_COLUMN_NAMES:-1}"
  instanceNewInstance['SSL_OPTIONS']="${MYSQL_SSL_OPTIONS:---ssl-mode=DISABLED}"
  instanceNewInstance['QUERY_OPTIONS']="${MYSQL_QUERY_OPTIONS:---batch --raw --default-character-set=utf8}"
  instanceNewInstance['DUMP_OPTIONS']="${MYSQL_DUMP_OPTIONS:---default-character-set=utf8 --compress --hex-blob --routines --triggers --single-transaction --set-gtid-purged=OFF --column-statistics=0 ${instanceNewInstance['SSL_OPTIONS']}}"
  instanceNewInstance['DB_IMPORT_OPTIONS']="${DB_IMPORT_OPTIONS:---connect-timeout=5 --batch --raw --default-character-set=utf8}"

  instanceNewInstance['INITIALIZED']=1
}

# @description mysql query on a given db
# @warning could use QUERY_OPTIONS variable from dsn if defined
# @example
#   cat file.sql | Database::query ...
# @arg $1 instanceQuery:&Map<String,String> (passed by reference) database instance to use
# @arg $2 sqlQuery:String (optional) sql query or sql file to execute. if not provided or empty, the command can be piped
# @arg $3 dbName:String (optional) the db name
#
# @exitcode mysql command status code
Database::query() {
  local -n instanceQuery=$1
  local -a mysqlCommand=()
  local -a queryOptions

  mysqlCommand+=(mysql)
  mysqlCommand+=("--defaults-extra-file=${instanceQuery['AUTH_FILE']}")
  IFS=' ' read -r -a queryOptions <<<"${instanceQuery['QUERY_OPTIONS']}"
  mysqlCommand+=("${queryOptions[@]}")
  if [[ "${instanceQuery['SKIP_COLUMN_NAMES']}" = "1" ]]; then
    mysqlCommand+=("-s" "--skip-column-names")
  fi
  # add optional db name
  if [[ -n "${3+x}" ]]; then
    mysqlCommand+=("$3")
  fi
  # add optional sql query
  if [[ -n "${2+x}" && -n "$2" && ! -f "$2" ]]; then
    mysqlCommand+=("-e")
    mysqlCommand+=("$2")
  fi
  Log::displayDebug "$(printf "execute command: '%s'" "${mysqlCommand[*]}")"

  if [[ -f "$2" ]]; then
    "${mysqlCommand[@]}" <"$2"
  else
    "${mysqlCommand[@]}"
  fi
}

# @description set the general options to use on mysql command to query the database
# Differs than setOptions in the way that these options could change each time
#
# @arg $1 instanceSetQueryOptions:&Map<String,String> (passed by reference) database instance to use
# @arg $2 optionsList:String query options list
Database::setQueryOptions() {
  local -n instanceSetQueryOptions=$1
  # shellcheck disable=SC2034
  instanceSetQueryOptions['QUERY_OPTIONS']="$2"
}

# @description by default we skip the column names
# but sometimes we need column names to display some results
# disable this option temporarily and then restore it to true
#
# @arg $1 instanceSetQueryOptions:&Map<String,String> (passed by reference) database instance to use
# @arg $2 skipColumnNames:Boolean 0 to disable, 1 to enable (hide column names)
Database::skipColumnNames() {
  local -n instanceSkipColumnNames=$1
  # shellcheck disable=SC2034
  instanceSkipColumnNames['SKIP_COLUMN_NAMES']="$2"
}

# @description prepend directories to the PATH environment variable
# @arg $@ args:String[] list of directories to prepend
# @set PATH update PATH with the directories prepended
Env::pathPrepend() {
  local arg
  for arg in "$@"; do
    if [[ -d "${arg}" && ":${PATH}:" != *":${arg}:"* ]]; then
      PATH="$(realpath "${arg}"):${PATH}"
    fi
  done
}

# @description Display message using error color (red) and exit immediately with error status 1
# @arg $1 message:String the message to display
Log::fatal() {
  echo -e "${__ERROR_COLOR}FATAL   - ${1}${__RESET_COLOR}" >&2
  Log::logFatal "$1"
  exit 1
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logDebug() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_DEBUG)); then
    Log::logMessage "${2:-DEBUG}" "$1"
  fi
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logInfo() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then
    Log::logMessage "${2:-INFO}" "$1"
  fi
}

# @description ensure running user is not root
# @exitcode 1 if current user is root
# @stderr diagnostics information is displayed
Linux::requireExecutedAsUser() {
  if [[ "$(id -u)" = "0" ]]; then
    Log::fatal "this script should be executed as normal user"
  fi
}

# @description get absolute conf file from specified conf folder deduced using these rules
#   * from absolute file (ignores <confFolder> and <extension>)
#   * relative to where script is executed (ignores <confFolder> and <extension>)
#   * from home/.bash-tools/<confFolder>
#   * from framework conf/<confFolder>
#
# @arg $1 confFolder:String the directory name (not the path) to list
# @arg $2 conf:String file to use without extension
# @arg $3 extension:String the extension (.sh by default)
#
# @stdout absolute conf filename
# @exitcode 1 if file is not found in any location
Conf::getAbsoluteFile() {
  local confFolder="$1"
  local conf="$2"
  local extension="${3-.sh}"
  if [[ -n "${extension}" && "${extension:0:1}" != "." ]]; then
    extension=".${extension}"
  fi

  testAbs() {
    local result
    result="$(realpath -e "$1" 2>/dev/null)"
    # shellcheck disable=SC2181
    if [[ "$?" = "0" && -f "${result}" ]]; then
      echo "${result}"
      return 0
    fi
    return 1
  }

  # conf is absolute file (including extension)
  testAbs "${confFolder}${extension}" && return 0
  # conf is absolute file
  testAbs "${confFolder}" && return 0
  # conf is absolute file (including extension)
  testAbs "${conf}${extension}" && return 0
  # conf is absolute file
  testAbs "${conf}" && return 0

  # relative to where script is executed (including extension)
  if [[ -n "${CURRENT_DIR+xxx}" ]]; then
    testAbs "$(File::concatenatePath "${CURRENT_DIR}" "${confFolder}")/${conf}${extension}" && return 0
  fi
  # from home/.bash-tools/<confFolder>
  testAbs "$(File::concatenatePath "${HOME}/.bash-tools" "${confFolder}")/${conf}${extension}" && return 0

  if [[ -n "${FRAMEWORK_ROOT_DIR+xxx}" ]]; then
    # from framework conf/<confFolder> (including extension)
    testAbs "$(File::concatenatePath "${FRAMEWORK_ROOT_DIR}/conf" "${confFolder}")/${conf}${extension}" && return 0

    # from framework conf/<confFolder>
    testAbs "$(File::concatenatePath "${FRAMEWORK_ROOT_DIR}/conf" "${confFolder}")/${conf}" && return 0
  fi

  # file not found
  Log::displayError "conf file '${conf}' not found"

  return 1
}

# @description check if dsn file has all the mandatory variables set
# Mandatory variables are: HOSTNAME, USER, PASSWORD, PORT
#
# @arg $1 dsnFileName:String dsn absolute filename
# @set HOSTNAME loaded from dsn file
# @set PORT loaded from dsn file
# @set USER loaded from dsn file
# @set PASSWORD loaded from dsn file
# @exitcode 0 on valid file
# @exitcode 1 if one of the properties of the conf file is invalid or if file not found
# @stderr log output if error found in conf file
Database::checkDsnFile() {
  local dsnFileName="$1"
  if [[ ! -f "${dsnFileName}" ]]; then
    Log::displayError "dsn file ${dsnFileName} not found"
    return 1
  fi

  (
    unset HOSTNAME PORT PASSWORD USER
    # shellcheck source=/src/Database/testsData/dsn_valid.env
    source "${dsnFileName}"
    if [[ -z ${HOSTNAME+x} ]]; then
      Log::displayError "dsn file ${dsnFileName} : HOSTNAME not provided"
      return 1
    fi
    if [[ -z "${HOSTNAME}" ]]; then
      Log::displayWarning "dsn file ${dsnFileName} : HOSTNAME value not provided"
    fi
    if [[ "${HOSTNAME}" = "localhost" ]]; then
      Log::displayWarning "dsn file ${dsnFileName} : check that HOSTNAME should not be 127.0.0.1 instead of localhost"
    fi
    if [[ -z "${PORT+x}" ]]; then
      Log::displayError "dsn file ${dsnFileName} : PORT not provided"
      return 1
    fi
    if ! [[ ${PORT} =~ ^[0-9]+$ ]]; then
      Log::displayError "dsn file ${dsnFileName} : PORT invalid"
      return 1
    fi
    if [[ -z "${USER+x}" ]]; then
      Log::displayError "dsn file ${dsnFileName} : USER not provided"
      return 1
    fi
    if [[ -z "${PASSWORD+x}" ]]; then
      Log::displayError "dsn file ${dsnFileName} : PASSWORD not provided"
      return 1
    fi
  )
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logFatal() {
  Log::logMessage "${2:-FATAL}" "$1"
}

# @description Internal: common log message
# @example text
#   [date]|[levelMsg]|message
#
# @example text
#   2020-01-19 19:20:21|ERROR  |log error
#   2020-01-19 19:20:21|SKIPPED|log skipped
#
# @arg $1 levelMsg:String message's level description (eg: STATUS, ERROR, ...)
# @arg $2 msg:String the message to display
# @env BASH_FRAMEWORK_LOG_FILE String log file to use, do nothing if empty
# @env BASH_FRAMEWORK_LOG_LEVEL int log level log only if > OFF or fatal messages
# @stderr diagnostics information is displayed
# @require Env::requireLoad
# @require Log::requireLoad
Log::logMessage() {
  local levelMsg="$1"
  local msg="$2"
  local date

  if [[ -n "${BASH_FRAMEWORK_LOG_FILE}" ]] && ((BASH_FRAMEWORK_LOG_LEVEL > __LEVEL_OFF)); then
    date="$(date '+%Y-%m-%d %H:%M:%S')"
    touch "${BASH_FRAMEWORK_LOG_FILE}"
    printf "%s|%7s|%s\n" "${date}" "${levelMsg}" "${msg}" >>"${BASH_FRAMEWORK_LOG_FILE}"
  fi
}

# @description concatenate 2 paths and ensure the path is correct using realpath -m
# @arg $1 basePath:String
# @arg $2 subPath:String
# @require Linux::requireRealpathCommand
File::concatenatePath() {
  local basePath="$1"
  local subPath="$2"
  local fullPath="${basePath:+${basePath}/}${subPath}"

  realpath -m "${fullPath}" 2>/dev/null
}

# @description Display message using error color (red)
# @arg $1 message:String the message to display
Log::displayError() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_ERROR)); then
    echo -e "${__ERROR_COLOR}ERROR   - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logError "$1"
}

# @description Display message using warning color (yellow)
# @arg $1 message:String the message to display
Log::displayWarning() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_WARNING)); then
    echo -e "${__WARNING_COLOR}WARN    - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logWarning "$1"
}

# @description ensure env files are loaded
# @noargs
# @exitcode 1 if getOrderedConfFiles fails
# @exitcode 2 if one of env files fails to load
# @stderr diagnostics information is displayed
Env::requireLoad() {
  local configFilesStr
  configFilesStr="$(Env::getOrderedConfFiles)" || return 1

  local -a configFiles
  readarray -t configFiles <<<"${configFilesStr}"

  # if empty string, there will be one element
  if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then
    # should not happen, as there is always default file
    Log::displaySkipped "no env file to load"
    return 0
  fi

  Env::mergeConfFiles "${configFiles[@]}" || {
    Log::displayError "while loading config files: ${configFiles[*]}"
    return 2
  }
}

# @description activate or not Log::display* and Log::log* functions
# based on BASH_FRAMEWORK_DISPLAY_LEVEL and BASH_FRAMEWORK_LOG_LEVEL
# environment variables loaded by Env::requireLoad
# try to create log file and rotate it if necessary
# @noargs
# @set BASH_FRAMEWORK_LOG_LEVEL int to OFF level if BASH_FRAMEWORK_LOG_FILE is empty or not writable
# @env BASH_FRAMEWORK_DISPLAY_LEVEL int
# @env BASH_FRAMEWORK_LOG_LEVEL int
# @env BASH_FRAMEWORK_LOG_FILE String
# @env BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION int do log rotation if > 0
# @exitcode 0 always successful
# @stderr diagnostics information about log file is displayed
# @require Env::requireLoad
# @require UI::requireTheme
Log::requireLoad() {
  if [[ -z "${BASH_FRAMEWORK_LOG_FILE:-}" ]]; then
    BASH_FRAMEWORK_LOG_LEVEL=${__LEVEL_OFF}
    export BASH_FRAMEWORK_LOG_LEVEL
  fi

  if ((BASH_FRAMEWORK_LOG_LEVEL > __LEVEL_OFF)); then
    if [[ ! -f "${BASH_FRAMEWORK_LOG_FILE}" ]]; then
      if
        ! mkdir -p "$(dirname "${BASH_FRAMEWORK_LOG_FILE}")" 2>/dev/null ||
          ! touch --no-create "${BASH_FRAMEWORK_LOG_FILE}" 2>/dev/null
      then
        BASH_FRAMEWORK_LOG_LEVEL=${__LEVEL_OFF}
        echo -e "${__ERROR_COLOR}ERROR   - File ${BASH_FRAMEWORK_LOG_FILE} is not writable${__RESET_COLOR}" >&2
      fi
    elif [[ ! -w "${BASH_FRAMEWORK_LOG_FILE}" ]]; then
      BASH_FRAMEWORK_LOG_LEVEL=${__LEVEL_OFF}
      echo -e "${__ERROR_COLOR}ERROR   - File ${BASH_FRAMEWORK_LOG_FILE} is not writable${__RESET_COLOR}" >&2
    fi

  fi

  if ((BASH_FRAMEWORK_LOG_LEVEL > __LEVEL_OFF)); then
    # will always be created even if not in info level
    Log::logMessage "INFO" "Logging to file ${BASH_FRAMEWORK_LOG_FILE} - Log level ${BASH_FRAMEWORK_LOG_LEVEL}"
    if ((BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION > 0)); then
      Log::rotate "${BASH_FRAMEWORK_LOG_FILE}" "${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION}"
    fi
  fi
}

# @description get list of env files to load
# in order to make them available for Env::requireLoad
# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded
# @exitcode 1 if one of the env file cannot be generated
# @exitcode 2 if one of the env file is not a file or readable
# @stdout the env files asked to be loaded
# @stderr diagnostic information on failure
# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order
Env::getOrderedConfFiles() {
  local -a configFiles=()

  if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then
    # BASH_FRAMEWORK_ENV_FILES is an array
    configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}")
  fi

  local defaultEnvFile
  defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1
  configFiles+=("${defaultEnvFile}")

  local file
  for file in "${configFiles[@]}"; do
    if [[ ! -f "${file}" || ! -r "${file}" ]]; then
      Log::displayError "One of the config file is not available '${file}'"
      return 2
    fi
    echo "${file}"
  done
}

# @description merge and load conf files specified as argument
# - files are cleaned from ay comment
# - missing quotes after property = sign are added automatically
# - automatic remove of all whitespace before and after declarations
# - bash arrays are not supported
# - if a variable is declared in first file and overridden later on
#   in the same file or in subsequent files, those overloads will be
#   ignored
# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded
# @arg $@ args:String[] list of configuration files to load in order
# @set envVars String will set in environment all the variables that have been declared in the config files
# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing
# @exitcode 0 if no config files provided or load completed successfully
# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error)
# @exitcode 2 if temporary file cannot be created
# @exitcode 3 if an error occurred during config file sourcing
# @stderr diagnostics information is displayed
# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell
Env::mergeConfFiles() {
  local -a configFileList=("$@")

  if ((${#configFileList[@]} == 0)); then
    return 0
  fi

  local combinedConfigFile
  combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2

  (
    # removes any trailing whitespace from each file, if any
    # this is absolutely required when importing into ConfigMaps
    # put quotes around values
    sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" |
      # remove all comment lines
      Filters::commentLines |
      # iterates over each file and prints (default awk behavior)
      # each unique line; only takes first value and ignores duplicates
      awk -F= '!line[$1]++'
  ) >"${combinedConfigFile}" || return 1

  # have to export everything, and source it twice:
  # 1) first source is to realize variables
  # 2) second time is to realize references
  set -o allexport
  # shellcheck source=.framework-config
  source "${combinedConfigFile}" || return 3
  # shellcheck source=.framework-config
  source "${combinedConfigFile}" || return 3
  set +o allexport
}

# @description Display message using skip color (yellow)
# @arg $1 message:String the message to display
Log::displaySkipped() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then
    echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logSkipped "$1"
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logError() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_ERROR)); then
    Log::logMessage "${2:-ERROR}" "$1"
  fi
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logWarning() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_WARNING)); then
    Log::logMessage "${2:-WARNING}" "$1"
  fi
}

# @description To be called before logging in the log file
# @arg $1 file:string log file name
# @arg $2 maxLogFilesCount:int maximum number of log files
Log::rotate() {
  local file="$1"
  local maxLogFilesCount="${2:-5}"

  if [[ ! -f "${file}" ]]; then
    Log::displaySkipped "Log file ${file} doesn't exist yet"
    return 0
  fi
  for i in $(seq $((maxLogFilesCount - 1)) -1 1); do
    Log::displayInfo "Log rotation ${file}.${i} to ${file}.$((i + 1))"
    mv "${file}."{"${i}","$((i + 1))"} &>/dev/null || true
  done
  if cp "${file}" "${file}.1" &>/dev/null; then
    echo >"${file}" # reset log file
    Log::displayInfo "Log rotation ${file} to ${file}.1"
  fi
}

# @description ensure command realpath is available
# @exitcode 1 if realpath command not available
# @stderr diagnostics information is displayed
Linux::requireRealpathCommand() {
  Assert::commandExists realpath
}

# @description load color theme
# @noargs
# @env BASH_FRAMEWORK_THEME String theme to use
# @exitcode 0 always successful
UI::requireTheme() {
  UI::theme "${BASH_FRAMEWORK_THEME-default}"
}

# @description check if command specified exists or return 1
# with error and message if not
#
# @arg $1 commandName:String on which existence must be checked
# @arg $2 helpIfNotExists:String a help command to display if the command does not exist
#
# @exitcode 1 if the command specified does not exist
# @stderr diagnostic information + help if second argument is provided
Assert::commandExists() {
  local commandName="$1"
  local helpIfNotExists="$2"

  "${BASH_FRAMEWORK_COMMAND:-command}" -v "${commandName}" >/dev/null 2>/dev/null || {
    Log::displayError "${commandName} is not installed, please install it"
    if [[ -n "${helpIfNotExists}" ]]; then
      Log::displayInfo "${helpIfNotExists}"
    fi
    return 1
  }
  return 0
}

# @description default env file with all default values
# @stdout the default env filepath
Env::createDefaultEnvFile() {
  local envFile
  envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2

  (
    echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}"
    echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}"
    echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}"
    # shellcheck disable=SC2016
    echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"'
    echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}"
  ) >"${envFile}"
  echo "${envFile}"
}

# @description remove comment lines from input or files provided as arguments
# @arg $@ files:String[] (optional) the files to filter
# @env commentLinePrefix String the comment line prefix (default value: #)
# @exitcode 0 if lines filtered or not
# @exitcode 2 if grep fails for any other reasons than not found
# @stdin the file as stdin to filter (alternative to files argument)
# @stdout the filtered lines
# shellcheck disable=SC2120
Filters::commentLines() {
  grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1
}

# @description create a temp file using default TMPDIR variable
# initialized in _includes/_commonHeader.sh
# @env TMPDIR String (default value /tmp)
# @arg $1 templateName:String template name to use(optional)
Framework::createTempFile() {
  mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX"
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logSkipped() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then
    Log::logMessage "${2:-SKIPPED}" "$1"
  fi
}

# @description load colors theme constants
# @warning if tty not opened, noColor theme will be chosen
# @arg $1 theme:String the theme to use (default, noColor)
# @arg $@ args:String[]
# @set __ERROR_COLOR String indicate error status
# @set __INFO_COLOR String indicate info status
# @set __SUCCESS_COLOR String indicate success status
# @set __WARNING_COLOR String indicate warning status
# @set __SKIPPED_COLOR String indicate skipped status
# @set __DEBUG_COLOR String indicate debug status
# @set __HELP_COLOR String indicate help status
# @set __TEST_COLOR String not used
# @set __TEST_ERROR_COLOR String not used
# @set __HELP_TITLE_COLOR String used to display help title in help strings
# @set __HELP_OPTION_COLOR String used to display highlight options in help strings
#
# @set __RESET_COLOR String reset default color
#
# @set __HELP_EXAMPLE String to remove
# @set __HELP_TITLE String to remove
# @set __HELP_NORMAL String to remove
# shellcheck disable=SC2034
UI::theme() {
  local theme="${1-default}"
  if [[ ! "${theme}" =~ -force$ ]] && ! Assert::tty; then
    theme="noColor"
  fi
  case "${theme}" in
    default | default-force)
      theme="default"
      ;;
    noColor) ;;
    *)
      Log::fatal "invalid theme provided"
      ;;
  esac
  if [[ "${theme}" = "default" ]]; then
    BASH_FRAMEWORK_THEME="default"
    # check colors applicable https://misc.flogisoft.com/bash/tip_colors_and_formatting
    __ERROR_COLOR='\e[31m'         # Red
    __INFO_COLOR='\e[44m'          # white on lightBlue
    __SUCCESS_COLOR='\e[32m'       # Green
    __WARNING_COLOR='\e[33m'       # Yellow
    __SKIPPED_COLOR='\e[33m'       # Yellow
    __DEBUG_COLOR='\e[37m'         # Grey
    __HELP_COLOR='\e[7;49;33m'     # Black on Gold
    __TEST_COLOR='\e[100m'         # Light magenta
    __TEST_ERROR_COLOR='\e[41m'    # white on red
    __HELP_TITLE_COLOR="\e[1;37m"  # Bold
    __HELP_OPTION_COLOR="\e[1;34m" # Blue
    # Internal: reset color
    __RESET_COLOR='\e[0m' # Reset Color
    # shellcheck disable=SC2155,SC2034
    __HELP_EXAMPLE="$(echo -e "\e[2;97m")"
    # shellcheck disable=SC2155,SC2034
    __HELP_TITLE="$(echo -e "\e[1;37m")"
    # shellcheck disable=SC2155,SC2034
    __HELP_NORMAL="$(echo -e "\033[0m")"
  else
    BASH_FRAMEWORK_THEME="noColor"
    # check colors applicable https://misc.flogisoft.com/bash/tip_colors_and_formatting
    __ERROR_COLOR=''
    __INFO_COLOR=''
    __SUCCESS_COLOR=''
    __WARNING_COLOR=''
    __SKIPPED_COLOR=''
    __DEBUG_COLOR=''
    __HELP_COLOR=''
    __TEST_COLOR=''
    __TEST_ERROR_COLOR=''
    __HELP_TITLE_COLOR=''
    __HELP_OPTION_COLOR=''
    # Internal: reset color
    __RESET_COLOR=''
    __HELP_EXAMPLE=''
    __HELP_TITLE=''
    __HELP_NORMAL=''
  fi
}

# @description check if tty (interactive mode) is active
# @noargs
# @exitcode 1 if tty not active
# @env NON_INTERACTIVE if 1 consider as not interactive even if environment is interactive
# @env INTERACTIVE if 1 consider as interactive even if environment is not interactive
# @stderr diagnostic information + help if second argument is provided
Assert::tty() {
  if [[ "${NON_INTERACTIVE:-0}" = "1" ]]; then
    return 1
  fi
  if [[ "${INTERACTIVE:-0}" = "1" ]]; then
    return 0
  fi
  [[ -t 1 || -t 2 ]]
}

# FUNCTIONS

facade_main_embedFrameworkFunctionbinFiletpl() {
# REQUIRES
Linux::requireExecutedAsUser
Env::requireLoad
Log::requireLoad
Linux::requireRealpathCommand
UI::requireTheme
Compiler::Facade::requireCommandBinDir

# @require Compiler::Facade::requireCommandBinDir

# shellcheck disable=SC2154,SC2016
functionToCall='Db::queryOneDatabase'
"${functionToCall}" "$@"

}

facade_main_embedFrameworkFunctionbinFiletpl "$@"
" +declare -gx embed_function_DbQueryOneDatabase="${PERSISTENT_TMPDIR:-/tmp}/bin/381679fc2529dfab4ed52310d74a2fe5/dbQueryOneDatabase" +declare -gx encoded_binary_file_DbQueryOneDatabase="#!/usr/bin/env bash
###############################################################################
# GENERATED FACADE FROM https://github.com/fchastanet/bash-tools/tree/master/../../.cache/pre-commit/repoz26dv9_7/src/Compiler/Embed/embedFrameworkFunction.binFile.tpl
# DO NOT EDIT IT
# @generated
###############################################################################
# shellcheck disable=SC2288,SC2034
# BIN_FILE=${BIN_FILE}
# FACADE

# ensure that no user aliases could interfere with
# commands used in this script
unalias -a || true
shopt -u expand_aliases

# shellcheck disable=SC2034
((failures = 0)) || true

# Bash will remember & return the highest exit code in a chain of pipes.
# This way you can catch the error inside pipes, e.g. mysqldump | gzip
set -o pipefail
set -o errexit

# Command Substitution can inherit errexit option since bash v4.4
shopt -s inherit_errexit || true

# a log is generated when a command fails
set -o errtrace

# use nullglob so that (file*.php) will return an empty array if no file matches the wildcard
shopt -s nullglob

# ensure regexp are interpreted without accentuated characters
export LC_ALL=POSIX

export TERM=xterm-256color

# avoid interactive install
export DEBIAN_FRONTEND=noninteractive
export DEBCONF_NONINTERACTIVE_SEEN=true

# store command arguments for later usage
# shellcheck disable=SC2034
declare -a BASH_FRAMEWORK_ARGV=("$@")
# shellcheck disable=SC2034
declare -a ORIGINAL_BASH_FRAMEWORK_ARGV=("$@")

# @see https://unix.stackexchange.com/a/386856
# shellcheck disable=SC2317
interruptManagement() {
  # restore SIGINT handler
  trap - INT
  # ensure that Ctrl-C is trapped by this script and not by sub process
  # report to the parent that we have indeed been interrupted
  kill -s INT "$$"
}
trap interruptManagement INT
SCRIPT_NAME=${0##*/}
REAL_SCRIPT_FILE="$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")"
if [[ -n "${EMBED_CURRENT_DIR}" ]]; then
  CURRENT_DIR="${EMBED_CURRENT_DIR}"
else
  CURRENT_DIR="$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")" && pwd -P)"
fi

################################################
# Temp dir management
################################################

KEEP_TEMP_FILES="${KEEP_TEMP_FILES:-0}"
export KEEP_TEMP_FILES

# PERSISTENT_TMPDIR is not deleted by traps
PERSISTENT_TMPDIR="${TMPDIR:-/tmp}/bash-framework"
export PERSISTENT_TMPDIR
mkdir -p "${PERSISTENT_TMPDIR}"

# shellcheck disable=SC2034
TMPDIR="$(mktemp -d -p "${PERSISTENT_TMPDIR:-/tmp}" -t bash-framework-$$-XXXXXX)"
export TMPDIR

# temp dir cleaning
# shellcheck disable=SC2317
cleanOnExit() {
  if [[ "${KEEP_TEMP_FILES:-0}" = "1" ]]; then
    Log::displayInfo "KEEP_TEMP_FILES=1 temp files kept here '${TMPDIR}'"
  elif [[ -n "${TMPDIR+xxx}" ]]; then
    Log::displayDebug "KEEP_TEMP_FILES=0 removing temp files '${TMPDIR}'"
    rm -Rf "${TMPDIR:-/tmp/fake}" >/dev/null 2>&1
  fi
}
trap cleanOnExit EXIT HUP QUIT ABRT TERM

# VAR_MAIN_FUNCTION_VAR_NAME=dbQueryAllDatabasesFacade

# @description used to execute given query when using
# dbScriptAllDatabases
# @arg $1 dsn:String
# @arg $2 db:String
# @env query String
# @env optionSeparator String
# @require Linux::requireExecutedAsUser
Db::queryOneDatabase() {
  # query and optionSeparator are passed via export
  local dsn="$1"
  local db="$2"

  local -A dbInstance
  Database::newInstance dbInstance "${dsn}"
  Database::setQueryOptions dbInstance "${dbInstance[QUERY_OPTIONS]} --connect-timeout=5"

  # identify columns header
  echo -n "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  Database::skipColumnNames dbInstance 0

  # shellcheck disable=SC2154
  if ! Database::query dbInstance "${query}" "${db}" | sed "s/\t/${optionSeparator}/g"; then
    Log::fatal "database ${db} error" 1>&2
  fi
}

# @description Log namespace provides 2 kind of functions
# - Log::display* allows to display given message with
#   given display level
# - Log::log* allows to log given message with
#   given log level
# Log::display* functions automatically log the message too
# @see Env::requireLoad to load the display and log level from .env file

# @description log level off
export __LEVEL_OFF=0
# @description log level error
export __LEVEL_ERROR=1
# @description log level warning
export __LEVEL_WARNING=2
# @description log level info
export __LEVEL_INFO=3
# @description log level success
export __LEVEL_SUCCESS=3
# @description log level debug
export __LEVEL_DEBUG=4

# @description verbose level off
export __VERBOSE_LEVEL_OFF=0
# @description verbose level info
export __VERBOSE_LEVEL_INFO=1
# @description verbose level info
export __VERBOSE_LEVEL_DEBUG=2
# @description verbose level info
export __VERBOSE_LEVEL_TRACE=3

# @description Display message using debug color (grey)
# @arg $1 message:String the message to display
Log::displayDebug() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_DEBUG)); then
    echo -e "${__DEBUG_COLOR}DEBUG   - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logDebug "$1"
}

# @description Display message using info color (bg light blue/fg white)
# @arg $1 message:String the message to display
Log::displayInfo() {
  local type="${2:-INFO}"
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then
    echo -e "${__INFO_COLOR}${type}    - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logInfo "$1" "${type}"
}

# @description ensure COMMAND_BIN_DIR env var is set
# and PATH correctly prepared
# @noargs
# @set COMMAND_BIN_DIR string the directory where to find this command
# @set PATH string add directory where to find this command binary
Compiler::Facade::requireCommandBinDir() {
  COMMAND_BIN_DIR="${CURRENT_DIR}"
  Env::pathPrepend "${COMMAND_BIN_DIR}"
}

# @description create a new db instance
# Returns immediately if the instance is already initialized
#
# @arg $1 instanceNewInstance:&Map<String,String> (passed by reference) database instance to use
# @arg $2 dsn:String dsn profile - load the dsn.env profile deduced using rules defined in Conf::getAbsoluteFile
#
# @example
#   declare -Agx dbInstance
#   Database::newInstance dbInstance "default.local"
#
# @exitcode 1 if dns file not able to loaded
Database::newInstance() {
  local -n instanceNewInstance=$1
  local dsn="$2"
  local DSN_FILE

  if [[ -v instanceNewInstance['INITIALIZED'] && "${instanceNewInstance['INITIALIZED']:-0}" == "1" ]]; then
    return
  fi

  # final auth file generated from dns file
  instanceNewInstance['AUTH_FILE']=""
  instanceNewInstance['DSN_FILE']=""

  # check dsn file
  DSN_FILE="$(Conf::getAbsoluteFile "dsn" "${dsn}" "env")" || return 1
  Database::checkDsnFile "${DSN_FILE}" || return 1
  instanceNewInstance['DSN_FILE']="${DSN_FILE}"

  # shellcheck source=/src/Database/testsData/dsn_valid.env
  source "${instanceNewInstance['DSN_FILE']}"

  instanceNewInstance['USER']="${USER}"
  instanceNewInstance['PASSWORD']="${PASSWORD}"
  instanceNewInstance['HOSTNAME']="${HOSTNAME}"
  instanceNewInstance['PORT']="${PORT}"

  # generate authFile for easy authentication
  instanceNewInstance['AUTH_FILE']=$(mktemp -p "${TMPDIR:-/tmp}" -t "mysql.XXXXXXXXXXXX")
  (
    echo "[client]"
    echo "user = ${USER}"
    echo "password = ${PASSWORD}"
    echo "host = ${HOSTNAME}"
    echo "port = ${PORT}"
  ) >"${instanceNewInstance['AUTH_FILE']}"

  # some of those values can be overridden using the dsn file
  # SKIP_COLUMN_NAMES enabled by default
  instanceNewInstance['SKIP_COLUMN_NAMES']="${SKIP_COLUMN_NAMES:-1}"
  instanceNewInstance['SSL_OPTIONS']="${MYSQL_SSL_OPTIONS:---ssl-mode=DISABLED}"
  instanceNewInstance['QUERY_OPTIONS']="${MYSQL_QUERY_OPTIONS:---batch --raw --default-character-set=utf8}"
  instanceNewInstance['DUMP_OPTIONS']="${MYSQL_DUMP_OPTIONS:---default-character-set=utf8 --compress --hex-blob --routines --triggers --single-transaction --set-gtid-purged=OFF --column-statistics=0 ${instanceNewInstance['SSL_OPTIONS']}}"
  instanceNewInstance['DB_IMPORT_OPTIONS']="${DB_IMPORT_OPTIONS:---connect-timeout=5 --batch --raw --default-character-set=utf8}"

  instanceNewInstance['INITIALIZED']=1
}

# @description mysql query on a given db
# @warning could use QUERY_OPTIONS variable from dsn if defined
# @example
#   cat file.sql | Database::query ...
# @arg $1 instanceQuery:&Map<String,String> (passed by reference) database instance to use
# @arg $2 sqlQuery:String (optional) sql query or sql file to execute. if not provided or empty, the command can be piped
# @arg $3 dbName:String (optional) the db name
#
# @exitcode mysql command status code
Database::query() {
  local -n instanceQuery=$1
  local -a mysqlCommand=()
  local -a queryOptions

  mysqlCommand+=(mysql)
  mysqlCommand+=("--defaults-extra-file=${instanceQuery['AUTH_FILE']}")
  IFS=' ' read -r -a queryOptions <<<"${instanceQuery['QUERY_OPTIONS']}"
  mysqlCommand+=("${queryOptions[@]}")
  if [[ "${instanceQuery['SKIP_COLUMN_NAMES']}" = "1" ]]; then
    mysqlCommand+=("-s" "--skip-column-names")
  fi
  # add optional db name
  if [[ -n "${3+x}" ]]; then
    mysqlCommand+=("$3")
  fi
  # add optional sql query
  if [[ -n "${2+x}" && -n "$2" && ! -f "$2" ]]; then
    mysqlCommand+=("-e")
    mysqlCommand+=("$2")
  fi
  Log::displayDebug "$(printf "execute command: '%s'" "${mysqlCommand[*]}")"

  if [[ -f "$2" ]]; then
    "${mysqlCommand[@]}" <"$2"
  else
    "${mysqlCommand[@]}"
  fi
}

# @description set the general options to use on mysql command to query the database
# Differs than setOptions in the way that these options could change each time
#
# @arg $1 instanceSetQueryOptions:&Map<String,String> (passed by reference) database instance to use
# @arg $2 optionsList:String query options list
Database::setQueryOptions() {
  local -n instanceSetQueryOptions=$1
  # shellcheck disable=SC2034
  instanceSetQueryOptions['QUERY_OPTIONS']="$2"
}

# @description by default we skip the column names
# but sometimes we need column names to display some results
# disable this option temporarily and then restore it to true
#
# @arg $1 instanceSetQueryOptions:&Map<String,String> (passed by reference) database instance to use
# @arg $2 skipColumnNames:Boolean 0 to disable, 1 to enable (hide column names)
Database::skipColumnNames() {
  local -n instanceSkipColumnNames=$1
  # shellcheck disable=SC2034
  instanceSkipColumnNames['SKIP_COLUMN_NAMES']="$2"
}

# @description prepend directories to the PATH environment variable
# @arg $@ args:String[] list of directories to prepend
# @set PATH update PATH with the directories prepended
Env::pathPrepend() {
  local arg
  for arg in "$@"; do
    if [[ -d "${arg}" && ":${PATH}:" != *":${arg}:"* ]]; then
      PATH="$(realpath "${arg}"):${PATH}"
    fi
  done
}

# @description Display message using error color (red) and exit immediately with error status 1
# @arg $1 message:String the message to display
Log::fatal() {
  echo -e "${__ERROR_COLOR}FATAL   - ${1}${__RESET_COLOR}" >&2
  Log::logFatal "$1"
  exit 1
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logDebug() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_DEBUG)); then
    Log::logMessage "${2:-DEBUG}" "$1"
  fi
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logInfo() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then
    Log::logMessage "${2:-INFO}" "$1"
  fi
}

# @description ensure running user is not root
# @exitcode 1 if current user is root
# @stderr diagnostics information is displayed
Linux::requireExecutedAsUser() {
  if [[ "$(id -u)" = "0" ]]; then
    Log::fatal "this script should be executed as normal user"
  fi
}

# @description get absolute conf file from specified conf folder deduced using these rules
#   * from absolute file (ignores <confFolder> and <extension>)
#   * relative to where script is executed (ignores <confFolder> and <extension>)
#   * from home/.bash-tools/<confFolder>
#   * from framework conf/<confFolder>
#
# @arg $1 confFolder:String the directory name (not the path) to list
# @arg $2 conf:String file to use without extension
# @arg $3 extension:String the extension (.sh by default)
#
# @stdout absolute conf filename
# @exitcode 1 if file is not found in any location
Conf::getAbsoluteFile() {
  local confFolder="$1"
  local conf="$2"
  local extension="${3-.sh}"
  if [[ -n "${extension}" && "${extension:0:1}" != "." ]]; then
    extension=".${extension}"
  fi

  testAbs() {
    local result
    result="$(realpath -e "$1" 2>/dev/null)"
    # shellcheck disable=SC2181
    if [[ "$?" = "0" && -f "${result}" ]]; then
      echo "${result}"
      return 0
    fi
    return 1
  }

  # conf is absolute file (including extension)
  testAbs "${confFolder}${extension}" && return 0
  # conf is absolute file
  testAbs "${confFolder}" && return 0
  # conf is absolute file (including extension)
  testAbs "${conf}${extension}" && return 0
  # conf is absolute file
  testAbs "${conf}" && return 0

  # relative to where script is executed (including extension)
  if [[ -n "${CURRENT_DIR+xxx}" ]]; then
    testAbs "$(File::concatenatePath "${CURRENT_DIR}" "${confFolder}")/${conf}${extension}" && return 0
  fi
  # from home/.bash-tools/<confFolder>
  testAbs "$(File::concatenatePath "${HOME}/.bash-tools" "${confFolder}")/${conf}${extension}" && return 0

  if [[ -n "${FRAMEWORK_ROOT_DIR+xxx}" ]]; then
    # from framework conf/<confFolder> (including extension)
    testAbs "$(File::concatenatePath "${FRAMEWORK_ROOT_DIR}/conf" "${confFolder}")/${conf}${extension}" && return 0

    # from framework conf/<confFolder>
    testAbs "$(File::concatenatePath "${FRAMEWORK_ROOT_DIR}/conf" "${confFolder}")/${conf}" && return 0
  fi

  # file not found
  Log::displayError "conf file '${conf}' not found"

  return 1
}

# @description check if dsn file has all the mandatory variables set
# Mandatory variables are: HOSTNAME, USER, PASSWORD, PORT
#
# @arg $1 dsnFileName:String dsn absolute filename
# @set HOSTNAME loaded from dsn file
# @set PORT loaded from dsn file
# @set USER loaded from dsn file
# @set PASSWORD loaded from dsn file
# @exitcode 0 on valid file
# @exitcode 1 if one of the properties of the conf file is invalid or if file not found
# @stderr log output if error found in conf file
Database::checkDsnFile() {
  local dsnFileName="$1"
  if [[ ! -f "${dsnFileName}" ]]; then
    Log::displayError "dsn file ${dsnFileName} not found"
    return 1
  fi

  (
    unset HOSTNAME PORT PASSWORD USER
    # shellcheck source=/src/Database/testsData/dsn_valid.env
    source "${dsnFileName}"
    if [[ -z ${HOSTNAME+x} ]]; then
      Log::displayError "dsn file ${dsnFileName} : HOSTNAME not provided"
      return 1
    fi
    if [[ -z "${HOSTNAME}" ]]; then
      Log::displayWarning "dsn file ${dsnFileName} : HOSTNAME value not provided"
    fi
    if [[ "${HOSTNAME}" = "localhost" ]]; then
      Log::displayWarning "dsn file ${dsnFileName} : check that HOSTNAME should not be 127.0.0.1 instead of localhost"
    fi
    if [[ -z "${PORT+x}" ]]; then
      Log::displayError "dsn file ${dsnFileName} : PORT not provided"
      return 1
    fi
    if ! [[ ${PORT} =~ ^[0-9]+$ ]]; then
      Log::displayError "dsn file ${dsnFileName} : PORT invalid"
      return 1
    fi
    if [[ -z "${USER+x}" ]]; then
      Log::displayError "dsn file ${dsnFileName} : USER not provided"
      return 1
    fi
    if [[ -z "${PASSWORD+x}" ]]; then
      Log::displayError "dsn file ${dsnFileName} : PASSWORD not provided"
      return 1
    fi
  )
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logFatal() {
  Log::logMessage "${2:-FATAL}" "$1"
}

# @description Internal: common log message
# @example text
#   [date]|[levelMsg]|message
#
# @example text
#   2020-01-19 19:20:21|ERROR  |log error
#   2020-01-19 19:20:21|SKIPPED|log skipped
#
# @arg $1 levelMsg:String message's level description (eg: STATUS, ERROR, ...)
# @arg $2 msg:String the message to display
# @env BASH_FRAMEWORK_LOG_FILE String log file to use, do nothing if empty
# @env BASH_FRAMEWORK_LOG_LEVEL int log level log only if > OFF or fatal messages
# @stderr diagnostics information is displayed
# @require Env::requireLoad
# @require Log::requireLoad
Log::logMessage() {
  local levelMsg="$1"
  local msg="$2"
  local date

  if [[ -n "${BASH_FRAMEWORK_LOG_FILE}" ]] && ((BASH_FRAMEWORK_LOG_LEVEL > __LEVEL_OFF)); then
    date="$(date '+%Y-%m-%d %H:%M:%S')"
    touch "${BASH_FRAMEWORK_LOG_FILE}"
    printf "%s|%7s|%s\n" "${date}" "${levelMsg}" "${msg}" >>"${BASH_FRAMEWORK_LOG_FILE}"
  fi
}

# @description concatenate 2 paths and ensure the path is correct using realpath -m
# @arg $1 basePath:String
# @arg $2 subPath:String
# @require Linux::requireRealpathCommand
File::concatenatePath() {
  local basePath="$1"
  local subPath="$2"
  local fullPath="${basePath:+${basePath}/}${subPath}"

  realpath -m "${fullPath}" 2>/dev/null
}

# @description Display message using error color (red)
# @arg $1 message:String the message to display
Log::displayError() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_ERROR)); then
    echo -e "${__ERROR_COLOR}ERROR   - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logError "$1"
}

# @description Display message using warning color (yellow)
# @arg $1 message:String the message to display
Log::displayWarning() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_WARNING)); then
    echo -e "${__WARNING_COLOR}WARN    - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logWarning "$1"
}

# @description ensure env files are loaded
# @arg $@ list of default files to load at the end
# @exitcode 1 if one of env files fails to load
# @stderr diagnostics information is displayed
# shellcheck disable=SC2120
Env::requireLoad() {
  local -a defaultFiles=("$@")
  # get list of possible config files
  local -a configFiles=()
  if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then
    # BASH_FRAMEWORK_ENV_FILES is an array
    configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}")
  fi
  if [[ -f "$(pwd)/.framework-config" ]]; then
    configFiles+=("$(pwd)/.framework-config")
  fi
  if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then
    configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config")
  fi
  if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then
    # shellcheck disable=SC2034
    configFiles+=("${optionBashFrameworkConfig}")
  fi
  configFiles+=("${optionEnvFiles[@]}")
  configFiles+=("${defaultFiles[@]}")

  for file in "${configFiles[@]}"; do
    # shellcheck source=/.framework-config
    source "${file}" || {
      Log::displayError "while loading config file: ${file}"
      return 1
    }
  done
}

# @description activate or not Log::display* and Log::log* functions
# based on BASH_FRAMEWORK_DISPLAY_LEVEL and BASH_FRAMEWORK_LOG_LEVEL
# environment variables loaded by Env::requireLoad
# try to create log file and rotate it if necessary
# @noargs
# @set BASH_FRAMEWORK_LOG_LEVEL int to OFF level if BASH_FRAMEWORK_LOG_FILE is empty or not writable
# @env BASH_FRAMEWORK_DISPLAY_LEVEL int
# @env BASH_FRAMEWORK_LOG_LEVEL int
# @env BASH_FRAMEWORK_LOG_FILE String
# @env BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION int do log rotation if > 0
# @exitcode 0 always successful
# @stderr diagnostics information about log file is displayed
# @require Env::requireLoad
# @require UI::requireTheme
Log::requireLoad() {
  if [[ -z "${BASH_FRAMEWORK_LOG_FILE:-}" ]]; then
    BASH_FRAMEWORK_LOG_LEVEL=${__LEVEL_OFF}
    export BASH_FRAMEWORK_LOG_LEVEL
  fi

  if ((BASH_FRAMEWORK_LOG_LEVEL > __LEVEL_OFF)); then
    if [[ ! -f "${BASH_FRAMEWORK_LOG_FILE}" ]]; then
      if
        ! mkdir -p "$(dirname "${BASH_FRAMEWORK_LOG_FILE}")" 2>/dev/null ||
          ! touch --no-create "${BASH_FRAMEWORK_LOG_FILE}" 2>/dev/null
      then
        BASH_FRAMEWORK_LOG_LEVEL=${__LEVEL_OFF}
        echo -e "${__ERROR_COLOR}ERROR   - File ${BASH_FRAMEWORK_LOG_FILE} is not writable${__RESET_COLOR}" >&2
      fi
    elif [[ ! -w "${BASH_FRAMEWORK_LOG_FILE}" ]]; then
      BASH_FRAMEWORK_LOG_LEVEL=${__LEVEL_OFF}
      echo -e "${__ERROR_COLOR}ERROR   - File ${BASH_FRAMEWORK_LOG_FILE} is not writable${__RESET_COLOR}" >&2
    fi

  fi

  if ((BASH_FRAMEWORK_LOG_LEVEL > __LEVEL_OFF)); then
    # will always be created even if not in info level
    Log::logMessage "INFO" "Logging to file ${BASH_FRAMEWORK_LOG_FILE} - Log level ${BASH_FRAMEWORK_LOG_LEVEL}"
    if ((BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION > 0)); then
      Log::rotate "${BASH_FRAMEWORK_LOG_FILE}" "${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION}"
    fi
  fi
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logError() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_ERROR)); then
    Log::logMessage "${2:-ERROR}" "$1"
  fi
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logWarning() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_WARNING)); then
    Log::logMessage "${2:-WARNING}" "$1"
  fi
}

# @description To be called before logging in the log file
# @arg $1 file:string log file name
# @arg $2 maxLogFilesCount:int maximum number of log files
Log::rotate() {
  local file="$1"
  local maxLogFilesCount="${2:-5}"

  if [[ ! -f "${file}" ]]; then
    Log::displaySkipped "Log file ${file} doesn't exist yet"
    return 0
  fi
  for i in $(seq $((maxLogFilesCount - 1)) -1 1); do
    Log::displayInfo "Log rotation ${file}.${i} to ${file}.$((i + 1))"
    mv "${file}."{"${i}","$((i + 1))"} &>/dev/null || true
  done
  if cp "${file}" "${file}.1" &>/dev/null; then
    echo >"${file}" # reset log file
    Log::displayInfo "Log rotation ${file} to ${file}.1"
  fi
}

# @description ensure command realpath is available
# @exitcode 1 if realpath command not available
# @stderr diagnostics information is displayed
Linux::requireRealpathCommand() {
  Assert::commandExists realpath
}

# @description load color theme
# @noargs
# @env BASH_FRAMEWORK_THEME String theme to use
# @exitcode 0 always successful
UI::requireTheme() {
  UI::theme "${BASH_FRAMEWORK_THEME-default}"
}

# @description check if command specified exists or return 1
# with error and message if not
#
# @arg $1 commandName:String on which existence must be checked
# @arg $2 helpIfNotExists:String a help command to display if the command does not exist
#
# @exitcode 1 if the command specified does not exist
# @stderr diagnostic information + help if second argument is provided
Assert::commandExists() {
  local commandName="$1"
  local helpIfNotExists="$2"

  "${BASH_FRAMEWORK_COMMAND:-command}" -v "${commandName}" >/dev/null 2>/dev/null || {
    Log::displayError "${commandName} is not installed, please install it"
    if [[ -n "${helpIfNotExists}" ]]; then
      Log::displayInfo "${helpIfNotExists}"
    fi
    return 1
  }
  return 0
}

# @description Display message using skip color (yellow)
# @arg $1 message:String the message to display
Log::displaySkipped() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then
    echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logSkipped "$1"
}

# @description load colors theme constants
# @warning if tty not opened, noColor theme will be chosen
# @arg $1 theme:String the theme to use (default, noColor)
# @arg $@ args:String[]
# @set __ERROR_COLOR String indicate error status
# @set __INFO_COLOR String indicate info status
# @set __SUCCESS_COLOR String indicate success status
# @set __WARNING_COLOR String indicate warning status
# @set __SKIPPED_COLOR String indicate skipped status
# @set __DEBUG_COLOR String indicate debug status
# @set __HELP_COLOR String indicate help status
# @set __TEST_COLOR String not used
# @set __TEST_ERROR_COLOR String not used
# @set __HELP_TITLE_COLOR String used to display help title in help strings
# @set __HELP_OPTION_COLOR String used to display highlight options in help strings
#
# @set __RESET_COLOR String reset default color
#
# @set __HELP_EXAMPLE String to remove
# @set __HELP_TITLE String to remove
# @set __HELP_NORMAL String to remove
# shellcheck disable=SC2034
UI::theme() {
  local theme="${1-default}"
  if [[ ! "${theme}" =~ -force$ ]] && ! Assert::tty; then
    theme="noColor"
  fi
  case "${theme}" in
    default | default-force)
      theme="default"
      ;;
    noColor) ;;
    *)
      Log::fatal "invalid theme provided"
      ;;
  esac
  if [[ "${theme}" = "default" ]]; then
    BASH_FRAMEWORK_THEME="default"
    # check colors applicable https://misc.flogisoft.com/bash/tip_colors_and_formatting
    __ERROR_COLOR='\e[31m'         # Red
    __INFO_COLOR='\e[44m'          # white on lightBlue
    __SUCCESS_COLOR='\e[32m'       # Green
    __WARNING_COLOR='\e[33m'       # Yellow
    __SKIPPED_COLOR='\e[33m'       # Yellow
    __DEBUG_COLOR='\e[37m'         # Grey
    __HELP_COLOR='\e[7;49;33m'     # Black on Gold
    __TEST_COLOR='\e[100m'         # Light magenta
    __TEST_ERROR_COLOR='\e[41m'    # white on red
    __HELP_TITLE_COLOR="\e[1;37m"  # Bold
    __HELP_OPTION_COLOR="\e[1;34m" # Blue
    # Internal: reset color
    __RESET_COLOR='\e[0m' # Reset Color
    # shellcheck disable=SC2155,SC2034
    __HELP_EXAMPLE="$(echo -e "\e[2;97m")"
    # shellcheck disable=SC2155,SC2034
    __HELP_TITLE="$(echo -e "\e[1;37m")"
    # shellcheck disable=SC2155,SC2034
    __HELP_NORMAL="$(echo -e "\033[0m")"
  else
    BASH_FRAMEWORK_THEME="noColor"
    # check colors applicable https://misc.flogisoft.com/bash/tip_colors_and_formatting
    __ERROR_COLOR=''
    __INFO_COLOR=''
    __SUCCESS_COLOR=''
    __WARNING_COLOR=''
    __SKIPPED_COLOR=''
    __DEBUG_COLOR=''
    __HELP_COLOR=''
    __TEST_COLOR=''
    __TEST_ERROR_COLOR=''
    __HELP_TITLE_COLOR=''
    __HELP_OPTION_COLOR=''
    # Internal: reset color
    __RESET_COLOR=''
    __HELP_EXAMPLE=''
    __HELP_TITLE=''
    __HELP_NORMAL=''
  fi
}

# @description check if tty (interactive mode) is active
# @noargs
# @exitcode 1 if tty not active
# @env NON_INTERACTIVE if 1 consider as not interactive even if environment is interactive
# @env INTERACTIVE if 1 consider as interactive even if environment is not interactive
# @stderr diagnostic information + help if second argument is provided
Assert::tty() {
  if [[ "${NON_INTERACTIVE:-0}" = "1" ]]; then
    return 1
  fi
  if [[ "${INTERACTIVE:-0}" = "1" ]]; then
    return 0
  fi
  [[ -t 1 || -t 2 ]]
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logSkipped() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then
    Log::logMessage "${2:-SKIPPED}" "$1"
  fi
}

# FUNCTIONS

facade_main_embedFrameworkFunctionbinFiletpl() {
# REQUIRES
Linux::requireExecutedAsUser
Env::requireLoad
Log::requireLoad
Linux::requireRealpathCommand
UI::requireTheme
Compiler::Facade::requireCommandBinDir

# @require Compiler::Facade::requireCommandBinDir

# shellcheck disable=SC2154,SC2016
functionToCall='Db::queryOneDatabase'
"${functionToCall}" "$@"

}

facade_main_embedFrameworkFunctionbinFiletpl "$@"
" Compiler::Embed::extractFileFromBase64 \ "${embed_function_DbQueryOneDatabase}" \ @@ -1398,6 +1193,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1532,54 +1328,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -2050,7 +1839,7 @@ dbQueryAllDatabasesCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/bin/dbScriptAllDatabases b/bin/dbScriptAllDatabases index 3a6f5f7b..26915d32 100755 --- a/bin/dbScriptAllDatabases +++ b/bin/dbScriptAllDatabases @@ -440,42 +440,38 @@ Database::setQueryOptions() { } # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description Log namespace provides 2 kind of functions @@ -769,41 +765,6 @@ Conf::list() { ) } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - # @description check if dsn file has all the mandatory variables set # Mandatory variables are: HOSTNAME, USER, PASSWORD, PORT # @@ -894,87 +855,6 @@ Database::query() { fi } -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -1012,15 +892,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -1115,81 +986,13 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" - fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" -} - -# @description log message to file +# @description Display message using skip color (yellow) # @arg $1 message:String the message to display -Log::logSkipped() { - if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then - Log::logMessage "${2:-SKIPPED}" "$1" +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi + Log::logSkipped "$1" } # @description ensure command realpath is available @@ -1199,28 +1002,20 @@ Linux::requireRealpathCommand() { Assert::commandExists realpath } -# @description check if an element is contained in an array -# -# @arg $1 needle:String -# @arg $@ array:String[] -# @exitcode 0 if found -# @exitcode 1 otherwise -# @example -# Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}" -Array::contains() { - local element - for element in "${@:2}"; do - [[ "${element}" = "$1" ]] && return 0 - done - return 1 +# @description log message to file +# @arg $1 message:String the message to display +Log::logSkipped() { + if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then + Log::logMessage "${2:-SKIPPED}" "$1" + fi } # FUNCTIONS # @require Compiler::Embed::requireEmbedBinDir -declare -gx embed_function_DbQueryOneDatabase="${PERSISTENT_TMPDIR:-/tmp}/bin/db083cb53bb15c706d27273bb2620268/dbQueryOneDatabase" -declare -gx encoded_binary_file_DbQueryOneDatabase="#!/usr/bin/env bash
###############################################################################
# GENERATED FACADE FROM https://github.com/fchastanet/bash-tools/tree/master/../bash-dev-env/vendor/bash-tools-framework/src/Compiler/Embed/embedFrameworkFunction.binFile.tpl
# DO NOT EDIT IT
# @generated
###############################################################################
# shellcheck disable=SC2288,SC2034
# BIN_FILE=${BIN_FILE}
# FACADE

# ensure that no user aliases could interfere with
# commands used in this script
unalias -a || true
shopt -u expand_aliases

# shellcheck disable=SC2034
((failures = 0)) || true

# Bash will remember & return the highest exit code in a chain of pipes.
# This way you can catch the error inside pipes, e.g. mysqldump | gzip
set -o pipefail
set -o errexit

# Command Substitution can inherit errexit option since bash v4.4
shopt -s inherit_errexit || true

# a log is generated when a command fails
set -o errtrace

# use nullglob so that (file*.php) will return an empty array if no file matches the wildcard
shopt -s nullglob

# ensure regexp are interpreted without accentuated characters
export LC_ALL=POSIX

export TERM=xterm-256color

# avoid interactive install
export DEBIAN_FRONTEND=noninteractive
export DEBCONF_NONINTERACTIVE_SEEN=true

# store command arguments for later usage
# shellcheck disable=SC2034
declare -a BASH_FRAMEWORK_ARGV=("$@")
# shellcheck disable=SC2034
declare -a ORIGINAL_BASH_FRAMEWORK_ARGV=("$@")

# @see https://unix.stackexchange.com/a/386856
# shellcheck disable=SC2317
interruptManagement() {
  # restore SIGINT handler
  trap - INT
  # ensure that Ctrl-C is trapped by this script and not by sub process
  # report to the parent that we have indeed been interrupted
  kill -s INT "$$"
}
trap interruptManagement INT
SCRIPT_NAME=${0##*/}
REAL_SCRIPT_FILE="$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")"
if [[ -n "${EMBED_CURRENT_DIR}" ]]; then
  CURRENT_DIR="${EMBED_CURRENT_DIR}"
else
  CURRENT_DIR="$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")" && pwd -P)"
fi

################################################
# Temp dir management
################################################

KEEP_TEMP_FILES="${KEEP_TEMP_FILES:-0}"
export KEEP_TEMP_FILES

# PERSISTENT_TMPDIR is not deleted by traps
PERSISTENT_TMPDIR="${TMPDIR:-/tmp}/bash-framework"
export PERSISTENT_TMPDIR
mkdir -p "${PERSISTENT_TMPDIR}"

# shellcheck disable=SC2034
TMPDIR="$(mktemp -d -p "${PERSISTENT_TMPDIR:-/tmp}" -t bash-framework-$$-XXXXXX)"
export TMPDIR

# temp dir cleaning
# shellcheck disable=SC2317
cleanOnExit() {
  if [[ "${KEEP_TEMP_FILES:-0}" = "1" ]]; then
    Log::displayInfo "KEEP_TEMP_FILES=1 temp files kept here '${TMPDIR}'"
  elif [[ -n "${TMPDIR+xxx}" ]]; then
    Log::displayDebug "KEEP_TEMP_FILES=0 removing temp files '${TMPDIR}'"
    rm -Rf "${TMPDIR:-/tmp/fake}" >/dev/null 2>&1
  fi
}
trap cleanOnExit EXIT HUP QUIT ABRT TERM

# VAR_MAIN_FUNCTION_VAR_NAME=dbQueryAllDatabasesFacade

# @description used to execute given query when using
# dbScriptAllDatabases
# @arg $1 dsn:String
# @arg $2 db:String
# @env query String
# @env optionSeparator String
# @require Linux::requireExecutedAsUser
Db::queryOneDatabase() {
  # query and optionSeparator are passed via export
  local dsn="$1"
  local db="$2"

  local -A dbInstance
  Database::newInstance dbInstance "${dsn}"
  Database::setQueryOptions dbInstance "${dbInstance[QUERY_OPTIONS]} --connect-timeout=5"

  # identify columns header
  echo -n "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  Database::skipColumnNames dbInstance 0

  # shellcheck disable=SC2154
  if ! Database::query dbInstance "${query}" "${db}" | sed "s/\t/${optionSeparator}/g"; then
    Log::fatal "database ${db} error" 1>&2
  fi
}

# @description Log namespace provides 2 kind of functions
# - Log::display* allows to display given message with
#   given display level
# - Log::log* allows to log given message with
#   given log level
# Log::display* functions automatically log the message too
# @see Env::requireLoad to load the display and log level from .env file

# @description log level off
export __LEVEL_OFF=0
# @description log level error
export __LEVEL_ERROR=1
# @description log level warning
export __LEVEL_WARNING=2
# @description log level info
export __LEVEL_INFO=3
# @description log level success
export __LEVEL_SUCCESS=3
# @description log level debug
export __LEVEL_DEBUG=4

# @description verbose level off
export __VERBOSE_LEVEL_OFF=0
# @description verbose level info
export __VERBOSE_LEVEL_INFO=1
# @description verbose level info
export __VERBOSE_LEVEL_DEBUG=2
# @description verbose level info
export __VERBOSE_LEVEL_TRACE=3

# @description Display message using debug color (grey)
# @arg $1 message:String the message to display
Log::displayDebug() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_DEBUG)); then
    echo -e "${__DEBUG_COLOR}DEBUG   - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logDebug "$1"
}

# @description Display message using info color (bg light blue/fg white)
# @arg $1 message:String the message to display
Log::displayInfo() {
  local type="${2:-INFO}"
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then
    echo -e "${__INFO_COLOR}${type}    - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logInfo "$1" "${type}"
}

# @description ensure COMMAND_BIN_DIR env var is set
# and PATH correctly prepared
# @noargs
# @set COMMAND_BIN_DIR string the directory where to find this command
# @set PATH string add directory where to find this command binary
Compiler::Facade::requireCommandBinDir() {
  COMMAND_BIN_DIR="${CURRENT_DIR}"
  Env::pathPrepend "${COMMAND_BIN_DIR}"
}

# @description create a new db instance
# Returns immediately if the instance is already initialized
#
# @arg $1 instanceNewInstance:&Map<String,String> (passed by reference) database instance to use
# @arg $2 dsn:String dsn profile - load the dsn.env profile deduced using rules defined in Conf::getAbsoluteFile
#
# @example
#   declare -Agx dbInstance
#   Database::newInstance dbInstance "default.local"
#
# @exitcode 1 if dns file not able to loaded
Database::newInstance() {
  local -n instanceNewInstance=$1
  local dsn="$2"
  local DSN_FILE

  if [[ -v instanceNewInstance['INITIALIZED'] && "${instanceNewInstance['INITIALIZED']:-0}" == "1" ]]; then
    return
  fi

  # final auth file generated from dns file
  instanceNewInstance['AUTH_FILE']=""
  instanceNewInstance['DSN_FILE']=""

  # check dsn file
  DSN_FILE="$(Conf::getAbsoluteFile "dsn" "${dsn}" "env")" || return 1
  Database::checkDsnFile "${DSN_FILE}" || return 1
  instanceNewInstance['DSN_FILE']="${DSN_FILE}"

  # shellcheck source=/src/Database/testsData/dsn_valid.env
  source "${instanceNewInstance['DSN_FILE']}"

  instanceNewInstance['USER']="${USER}"
  instanceNewInstance['PASSWORD']="${PASSWORD}"
  instanceNewInstance['HOSTNAME']="${HOSTNAME}"
  instanceNewInstance['PORT']="${PORT}"

  # generate authFile for easy authentication
  instanceNewInstance['AUTH_FILE']=$(mktemp -p "${TMPDIR:-/tmp}" -t "mysql.XXXXXXXXXXXX")
  (
    echo "[client]"
    echo "user = ${USER}"
    echo "password = ${PASSWORD}"
    echo "host = ${HOSTNAME}"
    echo "port = ${PORT}"
  ) >"${instanceNewInstance['AUTH_FILE']}"

  # some of those values can be overridden using the dsn file
  # SKIP_COLUMN_NAMES enabled by default
  instanceNewInstance['SKIP_COLUMN_NAMES']="${SKIP_COLUMN_NAMES:-1}"
  instanceNewInstance['SSL_OPTIONS']="${MYSQL_SSL_OPTIONS:---ssl-mode=DISABLED}"
  instanceNewInstance['QUERY_OPTIONS']="${MYSQL_QUERY_OPTIONS:---batch --raw --default-character-set=utf8}"
  instanceNewInstance['DUMP_OPTIONS']="${MYSQL_DUMP_OPTIONS:---default-character-set=utf8 --compress --hex-blob --routines --triggers --single-transaction --set-gtid-purged=OFF --column-statistics=0 ${instanceNewInstance['SSL_OPTIONS']}}"
  instanceNewInstance['DB_IMPORT_OPTIONS']="${DB_IMPORT_OPTIONS:---connect-timeout=5 --batch --raw --default-character-set=utf8}"

  instanceNewInstance['INITIALIZED']=1
}

# @description mysql query on a given db
# @warning could use QUERY_OPTIONS variable from dsn if defined
# @example
#   cat file.sql | Database::query ...
# @arg $1 instanceQuery:&Map<String,String> (passed by reference) database instance to use
# @arg $2 sqlQuery:String (optional) sql query or sql file to execute. if not provided or empty, the command can be piped
# @arg $3 dbName:String (optional) the db name
#
# @exitcode mysql command status code
Database::query() {
  local -n instanceQuery=$1
  local -a mysqlCommand=()
  local -a queryOptions

  mysqlCommand+=(mysql)
  mysqlCommand+=("--defaults-extra-file=${instanceQuery['AUTH_FILE']}")
  IFS=' ' read -r -a queryOptions <<<"${instanceQuery['QUERY_OPTIONS']}"
  mysqlCommand+=("${queryOptions[@]}")
  if [[ "${instanceQuery['SKIP_COLUMN_NAMES']}" = "1" ]]; then
    mysqlCommand+=("-s" "--skip-column-names")
  fi
  # add optional db name
  if [[ -n "${3+x}" ]]; then
    mysqlCommand+=("$3")
  fi
  # add optional sql query
  if [[ -n "${2+x}" && -n "$2" && ! -f "$2" ]]; then
    mysqlCommand+=("-e")
    mysqlCommand+=("$2")
  fi
  Log::displayDebug "$(printf "execute command: '%s'" "${mysqlCommand[*]}")"

  if [[ -f "$2" ]]; then
    "${mysqlCommand[@]}" <"$2"
  else
    "${mysqlCommand[@]}"
  fi
}

# @description set the general options to use on mysql command to query the database
# Differs than setOptions in the way that these options could change each time
#
# @arg $1 instanceSetQueryOptions:&Map<String,String> (passed by reference) database instance to use
# @arg $2 optionsList:String query options list
Database::setQueryOptions() {
  local -n instanceSetQueryOptions=$1
  # shellcheck disable=SC2034
  instanceSetQueryOptions['QUERY_OPTIONS']="$2"
}

# @description by default we skip the column names
# but sometimes we need column names to display some results
# disable this option temporarily and then restore it to true
#
# @arg $1 instanceSetQueryOptions:&Map<String,String> (passed by reference) database instance to use
# @arg $2 skipColumnNames:Boolean 0 to disable, 1 to enable (hide column names)
Database::skipColumnNames() {
  local -n instanceSkipColumnNames=$1
  # shellcheck disable=SC2034
  instanceSkipColumnNames['SKIP_COLUMN_NAMES']="$2"
}

# @description prepend directories to the PATH environment variable
# @arg $@ args:String[] list of directories to prepend
# @set PATH update PATH with the directories prepended
Env::pathPrepend() {
  local arg
  for arg in "$@"; do
    if [[ -d "${arg}" && ":${PATH}:" != *":${arg}:"* ]]; then
      PATH="$(realpath "${arg}"):${PATH}"
    fi
  done
}

# @description Display message using error color (red) and exit immediately with error status 1
# @arg $1 message:String the message to display
Log::fatal() {
  echo -e "${__ERROR_COLOR}FATAL   - ${1}${__RESET_COLOR}" >&2
  Log::logFatal "$1"
  exit 1
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logDebug() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_DEBUG)); then
    Log::logMessage "${2:-DEBUG}" "$1"
  fi
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logInfo() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then
    Log::logMessage "${2:-INFO}" "$1"
  fi
}

# @description ensure running user is not root
# @exitcode 1 if current user is root
# @stderr diagnostics information is displayed
Linux::requireExecutedAsUser() {
  if [[ "$(id -u)" = "0" ]]; then
    Log::fatal "this script should be executed as normal user"
  fi
}

# @description get absolute conf file from specified conf folder deduced using these rules
#   * from absolute file (ignores <confFolder> and <extension>)
#   * relative to where script is executed (ignores <confFolder> and <extension>)
#   * from home/.bash-tools/<confFolder>
#   * from framework conf/<confFolder>
#
# @arg $1 confFolder:String the directory name (not the path) to list
# @arg $2 conf:String file to use without extension
# @arg $3 extension:String the extension (.sh by default)
#
# @stdout absolute conf filename
# @exitcode 1 if file is not found in any location
Conf::getAbsoluteFile() {
  local confFolder="$1"
  local conf="$2"
  local extension="${3-.sh}"
  if [[ -n "${extension}" && "${extension:0:1}" != "." ]]; then
    extension=".${extension}"
  fi

  testAbs() {
    local result
    result="$(realpath -e "$1" 2>/dev/null)"
    # shellcheck disable=SC2181
    if [[ "$?" = "0" && -f "${result}" ]]; then
      echo "${result}"
      return 0
    fi
    return 1
  }

  # conf is absolute file (including extension)
  testAbs "${confFolder}${extension}" && return 0
  # conf is absolute file
  testAbs "${confFolder}" && return 0
  # conf is absolute file (including extension)
  testAbs "${conf}${extension}" && return 0
  # conf is absolute file
  testAbs "${conf}" && return 0

  # relative to where script is executed (including extension)
  if [[ -n "${CURRENT_DIR+xxx}" ]]; then
    testAbs "$(File::concatenatePath "${CURRENT_DIR}" "${confFolder}")/${conf}${extension}" && return 0
  fi
  # from home/.bash-tools/<confFolder>
  testAbs "$(File::concatenatePath "${HOME}/.bash-tools" "${confFolder}")/${conf}${extension}" && return 0

  if [[ -n "${FRAMEWORK_ROOT_DIR+xxx}" ]]; then
    # from framework conf/<confFolder> (including extension)
    testAbs "$(File::concatenatePath "${FRAMEWORK_ROOT_DIR}/conf" "${confFolder}")/${conf}${extension}" && return 0

    # from framework conf/<confFolder>
    testAbs "$(File::concatenatePath "${FRAMEWORK_ROOT_DIR}/conf" "${confFolder}")/${conf}" && return 0
  fi

  # file not found
  Log::displayError "conf file '${conf}' not found"

  return 1
}

# @description check if dsn file has all the mandatory variables set
# Mandatory variables are: HOSTNAME, USER, PASSWORD, PORT
#
# @arg $1 dsnFileName:String dsn absolute filename
# @set HOSTNAME loaded from dsn file
# @set PORT loaded from dsn file
# @set USER loaded from dsn file
# @set PASSWORD loaded from dsn file
# @exitcode 0 on valid file
# @exitcode 1 if one of the properties of the conf file is invalid or if file not found
# @stderr log output if error found in conf file
Database::checkDsnFile() {
  local dsnFileName="$1"
  if [[ ! -f "${dsnFileName}" ]]; then
    Log::displayError "dsn file ${dsnFileName} not found"
    return 1
  fi

  (
    unset HOSTNAME PORT PASSWORD USER
    # shellcheck source=/src/Database/testsData/dsn_valid.env
    source "${dsnFileName}"
    if [[ -z ${HOSTNAME+x} ]]; then
      Log::displayError "dsn file ${dsnFileName} : HOSTNAME not provided"
      return 1
    fi
    if [[ -z "${HOSTNAME}" ]]; then
      Log::displayWarning "dsn file ${dsnFileName} : HOSTNAME value not provided"
    fi
    if [[ "${HOSTNAME}" = "localhost" ]]; then
      Log::displayWarning "dsn file ${dsnFileName} : check that HOSTNAME should not be 127.0.0.1 instead of localhost"
    fi
    if [[ -z "${PORT+x}" ]]; then
      Log::displayError "dsn file ${dsnFileName} : PORT not provided"
      return 1
    fi
    if ! [[ ${PORT} =~ ^[0-9]+$ ]]; then
      Log::displayError "dsn file ${dsnFileName} : PORT invalid"
      return 1
    fi
    if [[ -z "${USER+x}" ]]; then
      Log::displayError "dsn file ${dsnFileName} : USER not provided"
      return 1
    fi
    if [[ -z "${PASSWORD+x}" ]]; then
      Log::displayError "dsn file ${dsnFileName} : PASSWORD not provided"
      return 1
    fi
  )
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logFatal() {
  Log::logMessage "${2:-FATAL}" "$1"
}

# @description Internal: common log message
# @example text
#   [date]|[levelMsg]|message
#
# @example text
#   2020-01-19 19:20:21|ERROR  |log error
#   2020-01-19 19:20:21|SKIPPED|log skipped
#
# @arg $1 levelMsg:String message's level description (eg: STATUS, ERROR, ...)
# @arg $2 msg:String the message to display
# @env BASH_FRAMEWORK_LOG_FILE String log file to use, do nothing if empty
# @env BASH_FRAMEWORK_LOG_LEVEL int log level log only if > OFF or fatal messages
# @stderr diagnostics information is displayed
# @require Env::requireLoad
# @require Log::requireLoad
Log::logMessage() {
  local levelMsg="$1"
  local msg="$2"
  local date

  if [[ -n "${BASH_FRAMEWORK_LOG_FILE}" ]] && ((BASH_FRAMEWORK_LOG_LEVEL > __LEVEL_OFF)); then
    date="$(date '+%Y-%m-%d %H:%M:%S')"
    touch "${BASH_FRAMEWORK_LOG_FILE}"
    printf "%s|%7s|%s\n" "${date}" "${levelMsg}" "${msg}" >>"${BASH_FRAMEWORK_LOG_FILE}"
  fi
}

# @description concatenate 2 paths and ensure the path is correct using realpath -m
# @arg $1 basePath:String
# @arg $2 subPath:String
# @require Linux::requireRealpathCommand
File::concatenatePath() {
  local basePath="$1"
  local subPath="$2"
  local fullPath="${basePath:+${basePath}/}${subPath}"

  realpath -m "${fullPath}" 2>/dev/null
}

# @description Display message using error color (red)
# @arg $1 message:String the message to display
Log::displayError() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_ERROR)); then
    echo -e "${__ERROR_COLOR}ERROR   - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logError "$1"
}

# @description Display message using warning color (yellow)
# @arg $1 message:String the message to display
Log::displayWarning() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_WARNING)); then
    echo -e "${__WARNING_COLOR}WARN    - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logWarning "$1"
}

# @description ensure env files are loaded
# @noargs
# @exitcode 1 if getOrderedConfFiles fails
# @exitcode 2 if one of env files fails to load
# @stderr diagnostics information is displayed
Env::requireLoad() {
  local configFilesStr
  configFilesStr="$(Env::getOrderedConfFiles)" || return 1

  local -a configFiles
  readarray -t configFiles <<<"${configFilesStr}"

  # if empty string, there will be one element
  if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then
    # should not happen, as there is always default file
    Log::displaySkipped "no env file to load"
    return 0
  fi

  Env::mergeConfFiles "${configFiles[@]}" || {
    Log::displayError "while loading config files: ${configFiles[*]}"
    return 2
  }
}

# @description activate or not Log::display* and Log::log* functions
# based on BASH_FRAMEWORK_DISPLAY_LEVEL and BASH_FRAMEWORK_LOG_LEVEL
# environment variables loaded by Env::requireLoad
# try to create log file and rotate it if necessary
# @noargs
# @set BASH_FRAMEWORK_LOG_LEVEL int to OFF level if BASH_FRAMEWORK_LOG_FILE is empty or not writable
# @env BASH_FRAMEWORK_DISPLAY_LEVEL int
# @env BASH_FRAMEWORK_LOG_LEVEL int
# @env BASH_FRAMEWORK_LOG_FILE String
# @env BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION int do log rotation if > 0
# @exitcode 0 always successful
# @stderr diagnostics information about log file is displayed
# @require Env::requireLoad
# @require UI::requireTheme
Log::requireLoad() {
  if [[ -z "${BASH_FRAMEWORK_LOG_FILE:-}" ]]; then
    BASH_FRAMEWORK_LOG_LEVEL=${__LEVEL_OFF}
    export BASH_FRAMEWORK_LOG_LEVEL
  fi

  if ((BASH_FRAMEWORK_LOG_LEVEL > __LEVEL_OFF)); then
    if [[ ! -f "${BASH_FRAMEWORK_LOG_FILE}" ]]; then
      if
        ! mkdir -p "$(dirname "${BASH_FRAMEWORK_LOG_FILE}")" 2>/dev/null ||
          ! touch --no-create "${BASH_FRAMEWORK_LOG_FILE}" 2>/dev/null
      then
        BASH_FRAMEWORK_LOG_LEVEL=${__LEVEL_OFF}
        echo -e "${__ERROR_COLOR}ERROR   - File ${BASH_FRAMEWORK_LOG_FILE} is not writable${__RESET_COLOR}" >&2
      fi
    elif [[ ! -w "${BASH_FRAMEWORK_LOG_FILE}" ]]; then
      BASH_FRAMEWORK_LOG_LEVEL=${__LEVEL_OFF}
      echo -e "${__ERROR_COLOR}ERROR   - File ${BASH_FRAMEWORK_LOG_FILE} is not writable${__RESET_COLOR}" >&2
    fi

  fi

  if ((BASH_FRAMEWORK_LOG_LEVEL > __LEVEL_OFF)); then
    # will always be created even if not in info level
    Log::logMessage "INFO" "Logging to file ${BASH_FRAMEWORK_LOG_FILE} - Log level ${BASH_FRAMEWORK_LOG_LEVEL}"
    if ((BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION > 0)); then
      Log::rotate "${BASH_FRAMEWORK_LOG_FILE}" "${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION}"
    fi
  fi
}

# @description get list of env files to load
# in order to make them available for Env::requireLoad
# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded
# @exitcode 1 if one of the env file cannot be generated
# @exitcode 2 if one of the env file is not a file or readable
# @stdout the env files asked to be loaded
# @stderr diagnostic information on failure
# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order
Env::getOrderedConfFiles() {
  local -a configFiles=()

  if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then
    # BASH_FRAMEWORK_ENV_FILES is an array
    configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}")
  fi

  local defaultEnvFile
  defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1
  configFiles+=("${defaultEnvFile}")

  local file
  for file in "${configFiles[@]}"; do
    if [[ ! -f "${file}" || ! -r "${file}" ]]; then
      Log::displayError "One of the config file is not available '${file}'"
      return 2
    fi
    echo "${file}"
  done
}

# @description merge and load conf files specified as argument
# - files are cleaned from ay comment
# - missing quotes after property = sign are added automatically
# - automatic remove of all whitespace before and after declarations
# - bash arrays are not supported
# - if a variable is declared in first file and overridden later on
#   in the same file or in subsequent files, those overloads will be
#   ignored
# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded
# @arg $@ args:String[] list of configuration files to load in order
# @set envVars String will set in environment all the variables that have been declared in the config files
# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing
# @exitcode 0 if no config files provided or load completed successfully
# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error)
# @exitcode 2 if temporary file cannot be created
# @exitcode 3 if an error occurred during config file sourcing
# @stderr diagnostics information is displayed
# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell
Env::mergeConfFiles() {
  local -a configFileList=("$@")

  if ((${#configFileList[@]} == 0)); then
    return 0
  fi

  local combinedConfigFile
  combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2

  (
    # removes any trailing whitespace from each file, if any
    # this is absolutely required when importing into ConfigMaps
    # put quotes around values
    sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" |
      # remove all comment lines
      Filters::commentLines |
      # iterates over each file and prints (default awk behavior)
      # each unique line; only takes first value and ignores duplicates
      awk -F= '!line[$1]++'
  ) >"${combinedConfigFile}" || return 1

  # have to export everything, and source it twice:
  # 1) first source is to realize variables
  # 2) second time is to realize references
  set -o allexport
  # shellcheck source=.framework-config
  source "${combinedConfigFile}" || return 3
  # shellcheck source=.framework-config
  source "${combinedConfigFile}" || return 3
  set +o allexport
}

# @description Display message using skip color (yellow)
# @arg $1 message:String the message to display
Log::displaySkipped() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then
    echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logSkipped "$1"
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logError() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_ERROR)); then
    Log::logMessage "${2:-ERROR}" "$1"
  fi
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logWarning() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_WARNING)); then
    Log::logMessage "${2:-WARNING}" "$1"
  fi
}

# @description To be called before logging in the log file
# @arg $1 file:string log file name
# @arg $2 maxLogFilesCount:int maximum number of log files
Log::rotate() {
  local file="$1"
  local maxLogFilesCount="${2:-5}"

  if [[ ! -f "${file}" ]]; then
    Log::displaySkipped "Log file ${file} doesn't exist yet"
    return 0
  fi
  for i in $(seq $((maxLogFilesCount - 1)) -1 1); do
    Log::displayInfo "Log rotation ${file}.${i} to ${file}.$((i + 1))"
    mv "${file}."{"${i}","$((i + 1))"} &>/dev/null || true
  done
  if cp "${file}" "${file}.1" &>/dev/null; then
    echo >"${file}" # reset log file
    Log::displayInfo "Log rotation ${file} to ${file}.1"
  fi
}

# @description ensure command realpath is available
# @exitcode 1 if realpath command not available
# @stderr diagnostics information is displayed
Linux::requireRealpathCommand() {
  Assert::commandExists realpath
}

# @description load color theme
# @noargs
# @env BASH_FRAMEWORK_THEME String theme to use
# @exitcode 0 always successful
UI::requireTheme() {
  UI::theme "${BASH_FRAMEWORK_THEME-default}"
}

# @description check if command specified exists or return 1
# with error and message if not
#
# @arg $1 commandName:String on which existence must be checked
# @arg $2 helpIfNotExists:String a help command to display if the command does not exist
#
# @exitcode 1 if the command specified does not exist
# @stderr diagnostic information + help if second argument is provided
Assert::commandExists() {
  local commandName="$1"
  local helpIfNotExists="$2"

  "${BASH_FRAMEWORK_COMMAND:-command}" -v "${commandName}" >/dev/null 2>/dev/null || {
    Log::displayError "${commandName} is not installed, please install it"
    if [[ -n "${helpIfNotExists}" ]]; then
      Log::displayInfo "${helpIfNotExists}"
    fi
    return 1
  }
  return 0
}

# @description default env file with all default values
# @stdout the default env filepath
Env::createDefaultEnvFile() {
  local envFile
  envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2

  (
    echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}"
    echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}"
    echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}"
    # shellcheck disable=SC2016
    echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"'
    echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}"
  ) >"${envFile}"
  echo "${envFile}"
}

# @description remove comment lines from input or files provided as arguments
# @arg $@ files:String[] (optional) the files to filter
# @env commentLinePrefix String the comment line prefix (default value: #)
# @exitcode 0 if lines filtered or not
# @exitcode 2 if grep fails for any other reasons than not found
# @stdin the file as stdin to filter (alternative to files argument)
# @stdout the filtered lines
# shellcheck disable=SC2120
Filters::commentLines() {
  grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1
}

# @description create a temp file using default TMPDIR variable
# initialized in _includes/_commonHeader.sh
# @env TMPDIR String (default value /tmp)
# @arg $1 templateName:String template name to use(optional)
Framework::createTempFile() {
  mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX"
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logSkipped() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then
    Log::logMessage "${2:-SKIPPED}" "$1"
  fi
}

# @description load colors theme constants
# @warning if tty not opened, noColor theme will be chosen
# @arg $1 theme:String the theme to use (default, noColor)
# @arg $@ args:String[]
# @set __ERROR_COLOR String indicate error status
# @set __INFO_COLOR String indicate info status
# @set __SUCCESS_COLOR String indicate success status
# @set __WARNING_COLOR String indicate warning status
# @set __SKIPPED_COLOR String indicate skipped status
# @set __DEBUG_COLOR String indicate debug status
# @set __HELP_COLOR String indicate help status
# @set __TEST_COLOR String not used
# @set __TEST_ERROR_COLOR String not used
# @set __HELP_TITLE_COLOR String used to display help title in help strings
# @set __HELP_OPTION_COLOR String used to display highlight options in help strings
#
# @set __RESET_COLOR String reset default color
#
# @set __HELP_EXAMPLE String to remove
# @set __HELP_TITLE String to remove
# @set __HELP_NORMAL String to remove
# shellcheck disable=SC2034
UI::theme() {
  local theme="${1-default}"
  if [[ ! "${theme}" =~ -force$ ]] && ! Assert::tty; then
    theme="noColor"
  fi
  case "${theme}" in
    default | default-force)
      theme="default"
      ;;
    noColor) ;;
    *)
      Log::fatal "invalid theme provided"
      ;;
  esac
  if [[ "${theme}" = "default" ]]; then
    BASH_FRAMEWORK_THEME="default"
    # check colors applicable https://misc.flogisoft.com/bash/tip_colors_and_formatting
    __ERROR_COLOR='\e[31m'         # Red
    __INFO_COLOR='\e[44m'          # white on lightBlue
    __SUCCESS_COLOR='\e[32m'       # Green
    __WARNING_COLOR='\e[33m'       # Yellow
    __SKIPPED_COLOR='\e[33m'       # Yellow
    __DEBUG_COLOR='\e[37m'         # Grey
    __HELP_COLOR='\e[7;49;33m'     # Black on Gold
    __TEST_COLOR='\e[100m'         # Light magenta
    __TEST_ERROR_COLOR='\e[41m'    # white on red
    __HELP_TITLE_COLOR="\e[1;37m"  # Bold
    __HELP_OPTION_COLOR="\e[1;34m" # Blue
    # Internal: reset color
    __RESET_COLOR='\e[0m' # Reset Color
    # shellcheck disable=SC2155,SC2034
    __HELP_EXAMPLE="$(echo -e "\e[2;97m")"
    # shellcheck disable=SC2155,SC2034
    __HELP_TITLE="$(echo -e "\e[1;37m")"
    # shellcheck disable=SC2155,SC2034
    __HELP_NORMAL="$(echo -e "\033[0m")"
  else
    BASH_FRAMEWORK_THEME="noColor"
    # check colors applicable https://misc.flogisoft.com/bash/tip_colors_and_formatting
    __ERROR_COLOR=''
    __INFO_COLOR=''
    __SUCCESS_COLOR=''
    __WARNING_COLOR=''
    __SKIPPED_COLOR=''
    __DEBUG_COLOR=''
    __HELP_COLOR=''
    __TEST_COLOR=''
    __TEST_ERROR_COLOR=''
    __HELP_TITLE_COLOR=''
    __HELP_OPTION_COLOR=''
    # Internal: reset color
    __RESET_COLOR=''
    __HELP_EXAMPLE=''
    __HELP_TITLE=''
    __HELP_NORMAL=''
  fi
}

# @description check if tty (interactive mode) is active
# @noargs
# @exitcode 1 if tty not active
# @env NON_INTERACTIVE if 1 consider as not interactive even if environment is interactive
# @env INTERACTIVE if 1 consider as interactive even if environment is not interactive
# @stderr diagnostic information + help if second argument is provided
Assert::tty() {
  if [[ "${NON_INTERACTIVE:-0}" = "1" ]]; then
    return 1
  fi
  if [[ "${INTERACTIVE:-0}" = "1" ]]; then
    return 0
  fi
  [[ -t 1 || -t 2 ]]
}

# FUNCTIONS

facade_main_embedFrameworkFunctionbinFiletpl() {
# REQUIRES
Linux::requireExecutedAsUser
Env::requireLoad
Log::requireLoad
Linux::requireRealpathCommand
UI::requireTheme
Compiler::Facade::requireCommandBinDir

# @require Compiler::Facade::requireCommandBinDir

# shellcheck disable=SC2154,SC2016
functionToCall='Db::queryOneDatabase'
"${functionToCall}" "$@"

}

facade_main_embedFrameworkFunctionbinFiletpl "$@"
" +declare -gx embed_function_DbQueryOneDatabase="${PERSISTENT_TMPDIR:-/tmp}/bin/381679fc2529dfab4ed52310d74a2fe5/dbQueryOneDatabase" +declare -gx encoded_binary_file_DbQueryOneDatabase="#!/usr/bin/env bash
###############################################################################
# GENERATED FACADE FROM https://github.com/fchastanet/bash-tools/tree/master/../../.cache/pre-commit/repoz26dv9_7/src/Compiler/Embed/embedFrameworkFunction.binFile.tpl
# DO NOT EDIT IT
# @generated
###############################################################################
# shellcheck disable=SC2288,SC2034
# BIN_FILE=${BIN_FILE}
# FACADE

# ensure that no user aliases could interfere with
# commands used in this script
unalias -a || true
shopt -u expand_aliases

# shellcheck disable=SC2034
((failures = 0)) || true

# Bash will remember & return the highest exit code in a chain of pipes.
# This way you can catch the error inside pipes, e.g. mysqldump | gzip
set -o pipefail
set -o errexit

# Command Substitution can inherit errexit option since bash v4.4
shopt -s inherit_errexit || true

# a log is generated when a command fails
set -o errtrace

# use nullglob so that (file*.php) will return an empty array if no file matches the wildcard
shopt -s nullglob

# ensure regexp are interpreted without accentuated characters
export LC_ALL=POSIX

export TERM=xterm-256color

# avoid interactive install
export DEBIAN_FRONTEND=noninteractive
export DEBCONF_NONINTERACTIVE_SEEN=true

# store command arguments for later usage
# shellcheck disable=SC2034
declare -a BASH_FRAMEWORK_ARGV=("$@")
# shellcheck disable=SC2034
declare -a ORIGINAL_BASH_FRAMEWORK_ARGV=("$@")

# @see https://unix.stackexchange.com/a/386856
# shellcheck disable=SC2317
interruptManagement() {
  # restore SIGINT handler
  trap - INT
  # ensure that Ctrl-C is trapped by this script and not by sub process
  # report to the parent that we have indeed been interrupted
  kill -s INT "$$"
}
trap interruptManagement INT
SCRIPT_NAME=${0##*/}
REAL_SCRIPT_FILE="$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")"
if [[ -n "${EMBED_CURRENT_DIR}" ]]; then
  CURRENT_DIR="${EMBED_CURRENT_DIR}"
else
  CURRENT_DIR="$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")" && pwd -P)"
fi

################################################
# Temp dir management
################################################

KEEP_TEMP_FILES="${KEEP_TEMP_FILES:-0}"
export KEEP_TEMP_FILES

# PERSISTENT_TMPDIR is not deleted by traps
PERSISTENT_TMPDIR="${TMPDIR:-/tmp}/bash-framework"
export PERSISTENT_TMPDIR
mkdir -p "${PERSISTENT_TMPDIR}"

# shellcheck disable=SC2034
TMPDIR="$(mktemp -d -p "${PERSISTENT_TMPDIR:-/tmp}" -t bash-framework-$$-XXXXXX)"
export TMPDIR

# temp dir cleaning
# shellcheck disable=SC2317
cleanOnExit() {
  if [[ "${KEEP_TEMP_FILES:-0}" = "1" ]]; then
    Log::displayInfo "KEEP_TEMP_FILES=1 temp files kept here '${TMPDIR}'"
  elif [[ -n "${TMPDIR+xxx}" ]]; then
    Log::displayDebug "KEEP_TEMP_FILES=0 removing temp files '${TMPDIR}'"
    rm -Rf "${TMPDIR:-/tmp/fake}" >/dev/null 2>&1
  fi
}
trap cleanOnExit EXIT HUP QUIT ABRT TERM

# VAR_MAIN_FUNCTION_VAR_NAME=dbQueryAllDatabasesFacade

# @description used to execute given query when using
# dbScriptAllDatabases
# @arg $1 dsn:String
# @arg $2 db:String
# @env query String
# @env optionSeparator String
# @require Linux::requireExecutedAsUser
Db::queryOneDatabase() {
  # query and optionSeparator are passed via export
  local dsn="$1"
  local db="$2"

  local -A dbInstance
  Database::newInstance dbInstance "${dsn}"
  Database::setQueryOptions dbInstance "${dbInstance[QUERY_OPTIONS]} --connect-timeout=5"

  # identify columns header
  echo -n "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
  Database::skipColumnNames dbInstance 0

  # shellcheck disable=SC2154
  if ! Database::query dbInstance "${query}" "${db}" | sed "s/\t/${optionSeparator}/g"; then
    Log::fatal "database ${db} error" 1>&2
  fi
}

# @description Log namespace provides 2 kind of functions
# - Log::display* allows to display given message with
#   given display level
# - Log::log* allows to log given message with
#   given log level
# Log::display* functions automatically log the message too
# @see Env::requireLoad to load the display and log level from .env file

# @description log level off
export __LEVEL_OFF=0
# @description log level error
export __LEVEL_ERROR=1
# @description log level warning
export __LEVEL_WARNING=2
# @description log level info
export __LEVEL_INFO=3
# @description log level success
export __LEVEL_SUCCESS=3
# @description log level debug
export __LEVEL_DEBUG=4

# @description verbose level off
export __VERBOSE_LEVEL_OFF=0
# @description verbose level info
export __VERBOSE_LEVEL_INFO=1
# @description verbose level info
export __VERBOSE_LEVEL_DEBUG=2
# @description verbose level info
export __VERBOSE_LEVEL_TRACE=3

# @description Display message using debug color (grey)
# @arg $1 message:String the message to display
Log::displayDebug() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_DEBUG)); then
    echo -e "${__DEBUG_COLOR}DEBUG   - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logDebug "$1"
}

# @description Display message using info color (bg light blue/fg white)
# @arg $1 message:String the message to display
Log::displayInfo() {
  local type="${2:-INFO}"
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then
    echo -e "${__INFO_COLOR}${type}    - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logInfo "$1" "${type}"
}

# @description ensure COMMAND_BIN_DIR env var is set
# and PATH correctly prepared
# @noargs
# @set COMMAND_BIN_DIR string the directory where to find this command
# @set PATH string add directory where to find this command binary
Compiler::Facade::requireCommandBinDir() {
  COMMAND_BIN_DIR="${CURRENT_DIR}"
  Env::pathPrepend "${COMMAND_BIN_DIR}"
}

# @description create a new db instance
# Returns immediately if the instance is already initialized
#
# @arg $1 instanceNewInstance:&Map<String,String> (passed by reference) database instance to use
# @arg $2 dsn:String dsn profile - load the dsn.env profile deduced using rules defined in Conf::getAbsoluteFile
#
# @example
#   declare -Agx dbInstance
#   Database::newInstance dbInstance "default.local"
#
# @exitcode 1 if dns file not able to loaded
Database::newInstance() {
  local -n instanceNewInstance=$1
  local dsn="$2"
  local DSN_FILE

  if [[ -v instanceNewInstance['INITIALIZED'] && "${instanceNewInstance['INITIALIZED']:-0}" == "1" ]]; then
    return
  fi

  # final auth file generated from dns file
  instanceNewInstance['AUTH_FILE']=""
  instanceNewInstance['DSN_FILE']=""

  # check dsn file
  DSN_FILE="$(Conf::getAbsoluteFile "dsn" "${dsn}" "env")" || return 1
  Database::checkDsnFile "${DSN_FILE}" || return 1
  instanceNewInstance['DSN_FILE']="${DSN_FILE}"

  # shellcheck source=/src/Database/testsData/dsn_valid.env
  source "${instanceNewInstance['DSN_FILE']}"

  instanceNewInstance['USER']="${USER}"
  instanceNewInstance['PASSWORD']="${PASSWORD}"
  instanceNewInstance['HOSTNAME']="${HOSTNAME}"
  instanceNewInstance['PORT']="${PORT}"

  # generate authFile for easy authentication
  instanceNewInstance['AUTH_FILE']=$(mktemp -p "${TMPDIR:-/tmp}" -t "mysql.XXXXXXXXXXXX")
  (
    echo "[client]"
    echo "user = ${USER}"
    echo "password = ${PASSWORD}"
    echo "host = ${HOSTNAME}"
    echo "port = ${PORT}"
  ) >"${instanceNewInstance['AUTH_FILE']}"

  # some of those values can be overridden using the dsn file
  # SKIP_COLUMN_NAMES enabled by default
  instanceNewInstance['SKIP_COLUMN_NAMES']="${SKIP_COLUMN_NAMES:-1}"
  instanceNewInstance['SSL_OPTIONS']="${MYSQL_SSL_OPTIONS:---ssl-mode=DISABLED}"
  instanceNewInstance['QUERY_OPTIONS']="${MYSQL_QUERY_OPTIONS:---batch --raw --default-character-set=utf8}"
  instanceNewInstance['DUMP_OPTIONS']="${MYSQL_DUMP_OPTIONS:---default-character-set=utf8 --compress --hex-blob --routines --triggers --single-transaction --set-gtid-purged=OFF --column-statistics=0 ${instanceNewInstance['SSL_OPTIONS']}}"
  instanceNewInstance['DB_IMPORT_OPTIONS']="${DB_IMPORT_OPTIONS:---connect-timeout=5 --batch --raw --default-character-set=utf8}"

  instanceNewInstance['INITIALIZED']=1
}

# @description mysql query on a given db
# @warning could use QUERY_OPTIONS variable from dsn if defined
# @example
#   cat file.sql | Database::query ...
# @arg $1 instanceQuery:&Map<String,String> (passed by reference) database instance to use
# @arg $2 sqlQuery:String (optional) sql query or sql file to execute. if not provided or empty, the command can be piped
# @arg $3 dbName:String (optional) the db name
#
# @exitcode mysql command status code
Database::query() {
  local -n instanceQuery=$1
  local -a mysqlCommand=()
  local -a queryOptions

  mysqlCommand+=(mysql)
  mysqlCommand+=("--defaults-extra-file=${instanceQuery['AUTH_FILE']}")
  IFS=' ' read -r -a queryOptions <<<"${instanceQuery['QUERY_OPTIONS']}"
  mysqlCommand+=("${queryOptions[@]}")
  if [[ "${instanceQuery['SKIP_COLUMN_NAMES']}" = "1" ]]; then
    mysqlCommand+=("-s" "--skip-column-names")
  fi
  # add optional db name
  if [[ -n "${3+x}" ]]; then
    mysqlCommand+=("$3")
  fi
  # add optional sql query
  if [[ -n "${2+x}" && -n "$2" && ! -f "$2" ]]; then
    mysqlCommand+=("-e")
    mysqlCommand+=("$2")
  fi
  Log::displayDebug "$(printf "execute command: '%s'" "${mysqlCommand[*]}")"

  if [[ -f "$2" ]]; then
    "${mysqlCommand[@]}" <"$2"
  else
    "${mysqlCommand[@]}"
  fi
}

# @description set the general options to use on mysql command to query the database
# Differs than setOptions in the way that these options could change each time
#
# @arg $1 instanceSetQueryOptions:&Map<String,String> (passed by reference) database instance to use
# @arg $2 optionsList:String query options list
Database::setQueryOptions() {
  local -n instanceSetQueryOptions=$1
  # shellcheck disable=SC2034
  instanceSetQueryOptions['QUERY_OPTIONS']="$2"
}

# @description by default we skip the column names
# but sometimes we need column names to display some results
# disable this option temporarily and then restore it to true
#
# @arg $1 instanceSetQueryOptions:&Map<String,String> (passed by reference) database instance to use
# @arg $2 skipColumnNames:Boolean 0 to disable, 1 to enable (hide column names)
Database::skipColumnNames() {
  local -n instanceSkipColumnNames=$1
  # shellcheck disable=SC2034
  instanceSkipColumnNames['SKIP_COLUMN_NAMES']="$2"
}

# @description prepend directories to the PATH environment variable
# @arg $@ args:String[] list of directories to prepend
# @set PATH update PATH with the directories prepended
Env::pathPrepend() {
  local arg
  for arg in "$@"; do
    if [[ -d "${arg}" && ":${PATH}:" != *":${arg}:"* ]]; then
      PATH="$(realpath "${arg}"):${PATH}"
    fi
  done
}

# @description Display message using error color (red) and exit immediately with error status 1
# @arg $1 message:String the message to display
Log::fatal() {
  echo -e "${__ERROR_COLOR}FATAL   - ${1}${__RESET_COLOR}" >&2
  Log::logFatal "$1"
  exit 1
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logDebug() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_DEBUG)); then
    Log::logMessage "${2:-DEBUG}" "$1"
  fi
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logInfo() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then
    Log::logMessage "${2:-INFO}" "$1"
  fi
}

# @description ensure running user is not root
# @exitcode 1 if current user is root
# @stderr diagnostics information is displayed
Linux::requireExecutedAsUser() {
  if [[ "$(id -u)" = "0" ]]; then
    Log::fatal "this script should be executed as normal user"
  fi
}

# @description get absolute conf file from specified conf folder deduced using these rules
#   * from absolute file (ignores <confFolder> and <extension>)
#   * relative to where script is executed (ignores <confFolder> and <extension>)
#   * from home/.bash-tools/<confFolder>
#   * from framework conf/<confFolder>
#
# @arg $1 confFolder:String the directory name (not the path) to list
# @arg $2 conf:String file to use without extension
# @arg $3 extension:String the extension (.sh by default)
#
# @stdout absolute conf filename
# @exitcode 1 if file is not found in any location
Conf::getAbsoluteFile() {
  local confFolder="$1"
  local conf="$2"
  local extension="${3-.sh}"
  if [[ -n "${extension}" && "${extension:0:1}" != "." ]]; then
    extension=".${extension}"
  fi

  testAbs() {
    local result
    result="$(realpath -e "$1" 2>/dev/null)"
    # shellcheck disable=SC2181
    if [[ "$?" = "0" && -f "${result}" ]]; then
      echo "${result}"
      return 0
    fi
    return 1
  }

  # conf is absolute file (including extension)
  testAbs "${confFolder}${extension}" && return 0
  # conf is absolute file
  testAbs "${confFolder}" && return 0
  # conf is absolute file (including extension)
  testAbs "${conf}${extension}" && return 0
  # conf is absolute file
  testAbs "${conf}" && return 0

  # relative to where script is executed (including extension)
  if [[ -n "${CURRENT_DIR+xxx}" ]]; then
    testAbs "$(File::concatenatePath "${CURRENT_DIR}" "${confFolder}")/${conf}${extension}" && return 0
  fi
  # from home/.bash-tools/<confFolder>
  testAbs "$(File::concatenatePath "${HOME}/.bash-tools" "${confFolder}")/${conf}${extension}" && return 0

  if [[ -n "${FRAMEWORK_ROOT_DIR+xxx}" ]]; then
    # from framework conf/<confFolder> (including extension)
    testAbs "$(File::concatenatePath "${FRAMEWORK_ROOT_DIR}/conf" "${confFolder}")/${conf}${extension}" && return 0

    # from framework conf/<confFolder>
    testAbs "$(File::concatenatePath "${FRAMEWORK_ROOT_DIR}/conf" "${confFolder}")/${conf}" && return 0
  fi

  # file not found
  Log::displayError "conf file '${conf}' not found"

  return 1
}

# @description check if dsn file has all the mandatory variables set
# Mandatory variables are: HOSTNAME, USER, PASSWORD, PORT
#
# @arg $1 dsnFileName:String dsn absolute filename
# @set HOSTNAME loaded from dsn file
# @set PORT loaded from dsn file
# @set USER loaded from dsn file
# @set PASSWORD loaded from dsn file
# @exitcode 0 on valid file
# @exitcode 1 if one of the properties of the conf file is invalid or if file not found
# @stderr log output if error found in conf file
Database::checkDsnFile() {
  local dsnFileName="$1"
  if [[ ! -f "${dsnFileName}" ]]; then
    Log::displayError "dsn file ${dsnFileName} not found"
    return 1
  fi

  (
    unset HOSTNAME PORT PASSWORD USER
    # shellcheck source=/src/Database/testsData/dsn_valid.env
    source "${dsnFileName}"
    if [[ -z ${HOSTNAME+x} ]]; then
      Log::displayError "dsn file ${dsnFileName} : HOSTNAME not provided"
      return 1
    fi
    if [[ -z "${HOSTNAME}" ]]; then
      Log::displayWarning "dsn file ${dsnFileName} : HOSTNAME value not provided"
    fi
    if [[ "${HOSTNAME}" = "localhost" ]]; then
      Log::displayWarning "dsn file ${dsnFileName} : check that HOSTNAME should not be 127.0.0.1 instead of localhost"
    fi
    if [[ -z "${PORT+x}" ]]; then
      Log::displayError "dsn file ${dsnFileName} : PORT not provided"
      return 1
    fi
    if ! [[ ${PORT} =~ ^[0-9]+$ ]]; then
      Log::displayError "dsn file ${dsnFileName} : PORT invalid"
      return 1
    fi
    if [[ -z "${USER+x}" ]]; then
      Log::displayError "dsn file ${dsnFileName} : USER not provided"
      return 1
    fi
    if [[ -z "${PASSWORD+x}" ]]; then
      Log::displayError "dsn file ${dsnFileName} : PASSWORD not provided"
      return 1
    fi
  )
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logFatal() {
  Log::logMessage "${2:-FATAL}" "$1"
}

# @description Internal: common log message
# @example text
#   [date]|[levelMsg]|message
#
# @example text
#   2020-01-19 19:20:21|ERROR  |log error
#   2020-01-19 19:20:21|SKIPPED|log skipped
#
# @arg $1 levelMsg:String message's level description (eg: STATUS, ERROR, ...)
# @arg $2 msg:String the message to display
# @env BASH_FRAMEWORK_LOG_FILE String log file to use, do nothing if empty
# @env BASH_FRAMEWORK_LOG_LEVEL int log level log only if > OFF or fatal messages
# @stderr diagnostics information is displayed
# @require Env::requireLoad
# @require Log::requireLoad
Log::logMessage() {
  local levelMsg="$1"
  local msg="$2"
  local date

  if [[ -n "${BASH_FRAMEWORK_LOG_FILE}" ]] && ((BASH_FRAMEWORK_LOG_LEVEL > __LEVEL_OFF)); then
    date="$(date '+%Y-%m-%d %H:%M:%S')"
    touch "${BASH_FRAMEWORK_LOG_FILE}"
    printf "%s|%7s|%s\n" "${date}" "${levelMsg}" "${msg}" >>"${BASH_FRAMEWORK_LOG_FILE}"
  fi
}

# @description concatenate 2 paths and ensure the path is correct using realpath -m
# @arg $1 basePath:String
# @arg $2 subPath:String
# @require Linux::requireRealpathCommand
File::concatenatePath() {
  local basePath="$1"
  local subPath="$2"
  local fullPath="${basePath:+${basePath}/}${subPath}"

  realpath -m "${fullPath}" 2>/dev/null
}

# @description Display message using error color (red)
# @arg $1 message:String the message to display
Log::displayError() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_ERROR)); then
    echo -e "${__ERROR_COLOR}ERROR   - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logError "$1"
}

# @description Display message using warning color (yellow)
# @arg $1 message:String the message to display
Log::displayWarning() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_WARNING)); then
    echo -e "${__WARNING_COLOR}WARN    - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logWarning "$1"
}

# @description ensure env files are loaded
# @arg $@ list of default files to load at the end
# @exitcode 1 if one of env files fails to load
# @stderr diagnostics information is displayed
# shellcheck disable=SC2120
Env::requireLoad() {
  local -a defaultFiles=("$@")
  # get list of possible config files
  local -a configFiles=()
  if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then
    # BASH_FRAMEWORK_ENV_FILES is an array
    configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}")
  fi
  if [[ -f "$(pwd)/.framework-config" ]]; then
    configFiles+=("$(pwd)/.framework-config")
  fi
  if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then
    configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config")
  fi
  if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then
    # shellcheck disable=SC2034
    configFiles+=("${optionBashFrameworkConfig}")
  fi
  configFiles+=("${optionEnvFiles[@]}")
  configFiles+=("${defaultFiles[@]}")

  for file in "${configFiles[@]}"; do
    # shellcheck source=/.framework-config
    source "${file}" || {
      Log::displayError "while loading config file: ${file}"
      return 1
    }
  done
}

# @description activate or not Log::display* and Log::log* functions
# based on BASH_FRAMEWORK_DISPLAY_LEVEL and BASH_FRAMEWORK_LOG_LEVEL
# environment variables loaded by Env::requireLoad
# try to create log file and rotate it if necessary
# @noargs
# @set BASH_FRAMEWORK_LOG_LEVEL int to OFF level if BASH_FRAMEWORK_LOG_FILE is empty or not writable
# @env BASH_FRAMEWORK_DISPLAY_LEVEL int
# @env BASH_FRAMEWORK_LOG_LEVEL int
# @env BASH_FRAMEWORK_LOG_FILE String
# @env BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION int do log rotation if > 0
# @exitcode 0 always successful
# @stderr diagnostics information about log file is displayed
# @require Env::requireLoad
# @require UI::requireTheme
Log::requireLoad() {
  if [[ -z "${BASH_FRAMEWORK_LOG_FILE:-}" ]]; then
    BASH_FRAMEWORK_LOG_LEVEL=${__LEVEL_OFF}
    export BASH_FRAMEWORK_LOG_LEVEL
  fi

  if ((BASH_FRAMEWORK_LOG_LEVEL > __LEVEL_OFF)); then
    if [[ ! -f "${BASH_FRAMEWORK_LOG_FILE}" ]]; then
      if
        ! mkdir -p "$(dirname "${BASH_FRAMEWORK_LOG_FILE}")" 2>/dev/null ||
          ! touch --no-create "${BASH_FRAMEWORK_LOG_FILE}" 2>/dev/null
      then
        BASH_FRAMEWORK_LOG_LEVEL=${__LEVEL_OFF}
        echo -e "${__ERROR_COLOR}ERROR   - File ${BASH_FRAMEWORK_LOG_FILE} is not writable${__RESET_COLOR}" >&2
      fi
    elif [[ ! -w "${BASH_FRAMEWORK_LOG_FILE}" ]]; then
      BASH_FRAMEWORK_LOG_LEVEL=${__LEVEL_OFF}
      echo -e "${__ERROR_COLOR}ERROR   - File ${BASH_FRAMEWORK_LOG_FILE} is not writable${__RESET_COLOR}" >&2
    fi

  fi

  if ((BASH_FRAMEWORK_LOG_LEVEL > __LEVEL_OFF)); then
    # will always be created even if not in info level
    Log::logMessage "INFO" "Logging to file ${BASH_FRAMEWORK_LOG_FILE} - Log level ${BASH_FRAMEWORK_LOG_LEVEL}"
    if ((BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION > 0)); then
      Log::rotate "${BASH_FRAMEWORK_LOG_FILE}" "${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION}"
    fi
  fi
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logError() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_ERROR)); then
    Log::logMessage "${2:-ERROR}" "$1"
  fi
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logWarning() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_WARNING)); then
    Log::logMessage "${2:-WARNING}" "$1"
  fi
}

# @description To be called before logging in the log file
# @arg $1 file:string log file name
# @arg $2 maxLogFilesCount:int maximum number of log files
Log::rotate() {
  local file="$1"
  local maxLogFilesCount="${2:-5}"

  if [[ ! -f "${file}" ]]; then
    Log::displaySkipped "Log file ${file} doesn't exist yet"
    return 0
  fi
  for i in $(seq $((maxLogFilesCount - 1)) -1 1); do
    Log::displayInfo "Log rotation ${file}.${i} to ${file}.$((i + 1))"
    mv "${file}."{"${i}","$((i + 1))"} &>/dev/null || true
  done
  if cp "${file}" "${file}.1" &>/dev/null; then
    echo >"${file}" # reset log file
    Log::displayInfo "Log rotation ${file} to ${file}.1"
  fi
}

# @description ensure command realpath is available
# @exitcode 1 if realpath command not available
# @stderr diagnostics information is displayed
Linux::requireRealpathCommand() {
  Assert::commandExists realpath
}

# @description load color theme
# @noargs
# @env BASH_FRAMEWORK_THEME String theme to use
# @exitcode 0 always successful
UI::requireTheme() {
  UI::theme "${BASH_FRAMEWORK_THEME-default}"
}

# @description check if command specified exists or return 1
# with error and message if not
#
# @arg $1 commandName:String on which existence must be checked
# @arg $2 helpIfNotExists:String a help command to display if the command does not exist
#
# @exitcode 1 if the command specified does not exist
# @stderr diagnostic information + help if second argument is provided
Assert::commandExists() {
  local commandName="$1"
  local helpIfNotExists="$2"

  "${BASH_FRAMEWORK_COMMAND:-command}" -v "${commandName}" >/dev/null 2>/dev/null || {
    Log::displayError "${commandName} is not installed, please install it"
    if [[ -n "${helpIfNotExists}" ]]; then
      Log::displayInfo "${helpIfNotExists}"
    fi
    return 1
  }
  return 0
}

# @description Display message using skip color (yellow)
# @arg $1 message:String the message to display
Log::displaySkipped() {
  if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then
    echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2
  fi
  Log::logSkipped "$1"
}

# @description load colors theme constants
# @warning if tty not opened, noColor theme will be chosen
# @arg $1 theme:String the theme to use (default, noColor)
# @arg $@ args:String[]
# @set __ERROR_COLOR String indicate error status
# @set __INFO_COLOR String indicate info status
# @set __SUCCESS_COLOR String indicate success status
# @set __WARNING_COLOR String indicate warning status
# @set __SKIPPED_COLOR String indicate skipped status
# @set __DEBUG_COLOR String indicate debug status
# @set __HELP_COLOR String indicate help status
# @set __TEST_COLOR String not used
# @set __TEST_ERROR_COLOR String not used
# @set __HELP_TITLE_COLOR String used to display help title in help strings
# @set __HELP_OPTION_COLOR String used to display highlight options in help strings
#
# @set __RESET_COLOR String reset default color
#
# @set __HELP_EXAMPLE String to remove
# @set __HELP_TITLE String to remove
# @set __HELP_NORMAL String to remove
# shellcheck disable=SC2034
UI::theme() {
  local theme="${1-default}"
  if [[ ! "${theme}" =~ -force$ ]] && ! Assert::tty; then
    theme="noColor"
  fi
  case "${theme}" in
    default | default-force)
      theme="default"
      ;;
    noColor) ;;
    *)
      Log::fatal "invalid theme provided"
      ;;
  esac
  if [[ "${theme}" = "default" ]]; then
    BASH_FRAMEWORK_THEME="default"
    # check colors applicable https://misc.flogisoft.com/bash/tip_colors_and_formatting
    __ERROR_COLOR='\e[31m'         # Red
    __INFO_COLOR='\e[44m'          # white on lightBlue
    __SUCCESS_COLOR='\e[32m'       # Green
    __WARNING_COLOR='\e[33m'       # Yellow
    __SKIPPED_COLOR='\e[33m'       # Yellow
    __DEBUG_COLOR='\e[37m'         # Grey
    __HELP_COLOR='\e[7;49;33m'     # Black on Gold
    __TEST_COLOR='\e[100m'         # Light magenta
    __TEST_ERROR_COLOR='\e[41m'    # white on red
    __HELP_TITLE_COLOR="\e[1;37m"  # Bold
    __HELP_OPTION_COLOR="\e[1;34m" # Blue
    # Internal: reset color
    __RESET_COLOR='\e[0m' # Reset Color
    # shellcheck disable=SC2155,SC2034
    __HELP_EXAMPLE="$(echo -e "\e[2;97m")"
    # shellcheck disable=SC2155,SC2034
    __HELP_TITLE="$(echo -e "\e[1;37m")"
    # shellcheck disable=SC2155,SC2034
    __HELP_NORMAL="$(echo -e "\033[0m")"
  else
    BASH_FRAMEWORK_THEME="noColor"
    # check colors applicable https://misc.flogisoft.com/bash/tip_colors_and_formatting
    __ERROR_COLOR=''
    __INFO_COLOR=''
    __SUCCESS_COLOR=''
    __WARNING_COLOR=''
    __SKIPPED_COLOR=''
    __DEBUG_COLOR=''
    __HELP_COLOR=''
    __TEST_COLOR=''
    __TEST_ERROR_COLOR=''
    __HELP_TITLE_COLOR=''
    __HELP_OPTION_COLOR=''
    # Internal: reset color
    __RESET_COLOR=''
    __HELP_EXAMPLE=''
    __HELP_TITLE=''
    __HELP_NORMAL=''
  fi
}

# @description check if tty (interactive mode) is active
# @noargs
# @exitcode 1 if tty not active
# @env NON_INTERACTIVE if 1 consider as not interactive even if environment is interactive
# @env INTERACTIVE if 1 consider as interactive even if environment is not interactive
# @stderr diagnostic information + help if second argument is provided
Assert::tty() {
  if [[ "${NON_INTERACTIVE:-0}" = "1" ]]; then
    return 1
  fi
  if [[ "${INTERACTIVE:-0}" = "1" ]]; then
    return 0
  fi
  [[ -t 1 || -t 2 ]]
}

# @description log message to file
# @arg $1 message:String the message to display
Log::logSkipped() {
  if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then
    Log::logMessage "${2:-SKIPPED}" "$1"
  fi
}

# FUNCTIONS

facade_main_embedFrameworkFunctionbinFiletpl() {
# REQUIRES
Linux::requireExecutedAsUser
Env::requireLoad
Log::requireLoad
Linux::requireRealpathCommand
UI::requireTheme
Compiler::Facade::requireCommandBinDir

# @require Compiler::Facade::requireCommandBinDir

# shellcheck disable=SC2154,SC2016
functionToCall='Db::queryOneDatabase'
"${functionToCall}" "$@"

}

facade_main_embedFrameworkFunctionbinFiletpl "$@"
" Compiler::Embed::extractFileFromBase64 \ "${embed_function_DbQueryOneDatabase}" \ @@ -1319,6 +1114,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1453,54 +1249,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -2027,7 +1816,7 @@ dbScriptAllDatabasesCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/bin/doc b/bin/doc index fcf0212d..d965aed4 100755 --- a/bin/doc +++ b/bin/doc @@ -212,42 +212,38 @@ Array::wrap() { #Array::wrap ":" 40 0 "Lorem ipsum dolor sit amet," "consectetur adipiscing elit." "Curabitur ac elit id massa" "condimentum finibus." # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description Log namespace provides 2 kind of functions @@ -574,122 +570,6 @@ Assert::tty() { [[ -t 1 || -t 2 ]] } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -738,15 +618,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -849,67 +720,6 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" - fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - # @description create a temp file using default TMPDIR variable # initialized in _includes/_commonHeader.sh # @env TMPDIR String (default value /tmp) @@ -918,6 +728,15 @@ Framework::createTempFile() { mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" } +# @description Display message using skip color (yellow) +# @arg $1 message:String the message to display +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 + fi + Log::logSkipped "$1" +} + # @description log message to file # @arg $1 message:String the message to display Log::logSkipped() { @@ -926,22 +745,6 @@ Log::logSkipped() { fi } -# @description check if an element is contained in an array -# -# @arg $1 needle:String -# @arg $@ array:String[] -# @exitcode 0 if found -# @exitcode 1 otherwise -# @example -# Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}" -Array::contains() { - local element - for element in "${@:2}"; do - [[ "${element}" = "$1" ]] && return 0 - done - return 1 -} - # FUNCTIONS facade_main_docsh() { @@ -1024,6 +827,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1158,54 +962,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -1556,7 +1353,7 @@ docCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray @@ -1645,7 +1442,7 @@ docCommand parse "${BASH_FRAMEWORK_ARGV[@]}" run() { if [[ "${IN_BASH_DOCKER:-}" != "You're in docker" ]]; then DOCKER_RUN_OPTIONS=$"-e ORIGINAL_DOC_DIR=${DOC_DIR}" \ - "${COMMAND_BIN_DIR}/runBuildContainer" "/bash/bin/doc" \ + "${FRAMEWORK_BIN_DIR}/runBuildContainer" "/bash/bin/doc" \ "${RUN_CONTAINER_ARGV_FILTERED[@]}" return $? fi diff --git a/bin/gitIsAncestorOf b/bin/gitIsAncestorOf index 92bd0884..98f532ec 100755 --- a/bin/gitIsAncestorOf +++ b/bin/gitIsAncestorOf @@ -212,42 +212,38 @@ Array::wrap() { #Array::wrap ":" 40 0 "Lorem ipsum dolor sit amet," "consectetur adipiscing elit." "Curabitur ac elit id massa" "condimentum finibus." # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description Log namespace provides 2 kind of functions @@ -492,122 +488,6 @@ Assert::tty() { [[ -t 1 || -t 2 ]] } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -633,15 +513,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -736,73 +607,13 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" +# @description Display message using skip color (yellow) +# @arg $1 message:String the message to display +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" + Log::logSkipped "$1" } # @description log message to file @@ -813,22 +624,6 @@ Log::logSkipped() { fi } -# @description check if an element is contained in an array -# -# @arg $1 needle:String -# @arg $@ array:String[] -# @exitcode 0 if found -# @exitcode 1 otherwise -# @example -# Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}" -Array::contains() { - local element - for element in "${@:2}"; do - [[ "${element}" = "$1" ]] && return 0 - done - return 1 -} - # FUNCTIONS facade_main_gitIsAncestorOfsh() { @@ -912,6 +707,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1046,54 +842,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -1465,7 +1254,7 @@ gitIsAncestorOfCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/bin/gitIsBranch b/bin/gitIsBranch index db8d3d7e..13ac130f 100755 --- a/bin/gitIsBranch +++ b/bin/gitIsBranch @@ -212,42 +212,38 @@ Array::wrap() { #Array::wrap ":" 40 0 "Lorem ipsum dolor sit amet," "consectetur adipiscing elit." "Curabitur ac elit id massa" "condimentum finibus." # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description Log namespace provides 2 kind of functions @@ -492,122 +488,6 @@ Assert::tty() { [[ -t 1 || -t 2 ]] } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -633,15 +513,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -736,73 +607,13 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" +# @description Display message using skip color (yellow) +# @arg $1 message:String the message to display +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" + Log::logSkipped "$1" } # @description log message to file @@ -813,22 +624,6 @@ Log::logSkipped() { fi } -# @description check if an element is contained in an array -# -# @arg $1 needle:String -# @arg $@ array:String[] -# @exitcode 0 if found -# @exitcode 1 otherwise -# @example -# Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}" -Array::contains() { - local element - for element in "${@:2}"; do - [[ "${element}" = "$1" ]] && return 0 - done - return 1 -} - # FUNCTIONS facade_main_gitIsBranchsh() { @@ -911,6 +706,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1045,54 +841,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -1443,7 +1232,7 @@ gitIsBranchCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/bin/gitRenameBranch b/bin/gitRenameBranch index c27ed4c2..b17adeec 100755 --- a/bin/gitRenameBranch +++ b/bin/gitRenameBranch @@ -228,42 +228,38 @@ Assert::tty() { } # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description Log namespace provides 2 kind of functions @@ -514,122 +510,6 @@ Linux::requireExecutedAsUser() { fi } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -655,15 +535,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -758,73 +629,13 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" +# @description Display message using skip color (yellow) +# @arg $1 message:String the message to display +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" + Log::logSkipped "$1" } # @description log message to file @@ -835,22 +646,6 @@ Log::logSkipped() { fi } -# @description check if an element is contained in an array -# -# @arg $1 needle:String -# @arg $@ array:String[] -# @exitcode 0 if found -# @exitcode 1 otherwise -# @example -# Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}" -Array::contains() { - local element - for element in "${@:2}"; do - [[ "${element}" = "$1" ]] && return 0 - done - return 1 -} - # FUNCTIONS facade_main_gitRenameBranchsh() { @@ -940,6 +735,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1074,54 +870,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -1549,7 +1338,7 @@ gitRenameBranchCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/bin/installRequirements b/bin/installRequirements index b5b1e355..2ab13892 100755 --- a/bin/installRequirements +++ b/bin/installRequirements @@ -212,42 +212,38 @@ Array::wrap() { #Array::wrap ":" 40 0 "Lorem ipsum dolor sit amet," "consectetur adipiscing elit." "Curabitur ac elit id massa" "condimentum finibus." # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description clone the repository if not done yet, else pull it if no change in it @@ -532,122 +528,6 @@ Assert::tty() { [[ -t 1 || -t 2 ]] } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -699,15 +579,6 @@ Git::pullIfNoChanges() { ) } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -802,81 +673,13 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" - fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" -} - -# @description log message to file +# @description Display message using skip color (yellow) # @arg $1 message:String the message to display -Log::logSkipped() { - if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then - Log::logMessage "${2:-SKIPPED}" "$1" +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi + Log::logSkipped "$1" } # @description ensure command git is available @@ -886,22 +689,6 @@ Git::requireGitCommand() { Assert::commandExists git } -# @description check if an element is contained in an array -# -# @arg $1 needle:String -# @arg $@ array:String[] -# @exitcode 0 if found -# @exitcode 1 otherwise -# @example -# Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}" -Array::contains() { - local element - for element in "${@:2}"; do - [[ "${element}" = "$1" ]] && return 0 - done - return 1 -} - # @description check if command specified exists or return 1 # with error and message if not # @@ -924,6 +711,14 @@ Assert::commandExists() { return 0 } +# @description log message to file +# @arg $1 message:String the message to display +Log::logSkipped() { + if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then + Log::logMessage "${2:-SKIPPED}" "$1" + fi +} + # FUNCTIONS facade_main_installRequirementssh() { @@ -1007,6 +802,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1141,54 +937,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -1510,7 +1299,7 @@ installRequirementsCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray @@ -1556,7 +1345,7 @@ installRequirementsCommand() { INSTALLS REQUIREMENTS: - fchastanet/bash-tools-framework - and fchastanet/bash-tools-framework useful binaries: - bin/runBuildContainer, bin/test""" + bin/test""" echo echo -n -e "${__HELP_TITLE_COLOR}VERSION: ${__RESET_COLOR}" echo '1.0' @@ -1576,7 +1365,7 @@ installRequirementsCommand() { return 1 fi } -declare -a externalBinaries=([0]="bin/runBuildContainer" [1]="bin/test") +declare -a externalBinaries=([0]="bin/test") installRequirementsCommand parse "${BASH_FRAMEWORK_ARGV[@]}" diff --git a/bin/mysql2puml b/bin/mysql2puml index 4d153384..bb1517b9 100755 --- a/bin/mysql2puml +++ b/bin/mysql2puml @@ -319,28 +319,38 @@ Conf::getMergedList() { } # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") + fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description remove all empty lines @@ -367,20 +377,6 @@ Framework::createTempFile() { mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" } -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" -} - # @description Log namespace provides 2 kind of functions # - Log::display* allows to display given message with # given display level @@ -649,122 +645,6 @@ Conf::list() { ) } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -802,15 +682,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -905,73 +776,13 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" - fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description log message to file +# @description Display message using skip color (yellow) # @arg $1 message:String the message to display -Log::logSkipped() { - if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then - Log::logMessage "${2:-SKIPPED}" "$1" +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi + Log::logSkipped "$1" } # @description ensure command realpath is available @@ -1003,6 +814,14 @@ Assert::commandExists() { return 0 } +# @description log message to file +# @arg $1 message:String the message to display +Log::logSkipped() { + if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then + Log::logMessage "${2:-SKIPPED}" "$1" + fi +} + # FUNCTIONS facade_main_mysql2pumlsh() { @@ -1086,6 +905,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1220,54 +1040,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -1643,7 +1456,7 @@ mysql2pumlCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/bin/upgradeGithubRelease b/bin/upgradeGithubRelease index 530eb068..4f7e60e6 100755 --- a/bin/upgradeGithubRelease +++ b/bin/upgradeGithubRelease @@ -254,42 +254,38 @@ Assert::validPath() { } # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description intermediate callback that is used by Github::upgradeRelease @@ -665,122 +661,6 @@ Assert::tty() { [[ -t 1 || -t 2 ]] } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -849,15 +729,6 @@ Github::getLatestRelease() { rm -f "${resultFile}" } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -968,81 +839,13 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" - fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" -} - -# @description log message to file +# @description Display message using skip color (yellow) # @arg $1 message:String the message to display -Log::logSkipped() { - if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then - Log::logMessage "${2:-SKIPPED}" "$1" +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi + Log::logSkipped "$1" } # @description Retry a command several times depending on parameters @@ -1092,20 +895,12 @@ Version::githubApiExtractVersion() { jq -r ".tag_name" | Version::parse } -# @description check if an element is contained in an array -# -# @arg $1 needle:String -# @arg $@ array:String[] -# @exitcode 0 if found -# @exitcode 1 otherwise -# @example -# Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}" -Array::contains() { - local element - for element in "${@:2}"; do - [[ "${element}" = "$1" ]] && return 0 - done - return 1 +# @description log message to file +# @arg $1 message:String the message to display +Log::logSkipped() { + if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then + Log::logMessage "${2:-SKIPPED}" "$1" + fi } # @description ensure command jq is available @@ -1230,6 +1025,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1364,54 +1160,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -1882,7 +1671,7 @@ upgradeGithubReleaseCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/bin/waitForIt b/bin/waitForIt index 99da67d8..9d12da25 100755 --- a/bin/waitForIt +++ b/bin/waitForIt @@ -250,42 +250,38 @@ Assert::commandExists() { } # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description Log namespace provides 2 kind of functions @@ -521,122 +517,6 @@ Assert::tty() { [[ -t 1 || -t 2 ]] } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -662,15 +542,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -765,73 +636,13 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" +# @description Display message using skip color (yellow) +# @arg $1 message:String the message to display +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" + Log::logSkipped "$1" } # @description log message to file @@ -938,6 +749,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1072,54 +884,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -1589,7 +1394,7 @@ waitForItCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/bin/waitForMysql b/bin/waitForMysql index 4b129253..823a4d57 100755 --- a/bin/waitForMysql +++ b/bin/waitForMysql @@ -234,42 +234,38 @@ Assert::commandExists() { } # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description Log namespace provides 2 kind of functions @@ -505,122 +501,6 @@ Assert::tty() { [[ -t 1 || -t 2 ]] } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -646,15 +526,6 @@ Filters::removeAnsiCodes() { # cspell:enable } -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description log message to file # @arg $1 message:String the message to display Log::logDebug() { @@ -749,73 +620,13 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" +# @description Display message using skip color (yellow) +# @arg $1 message:String the message to display +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" + Log::logSkipped "$1" } # @description log message to file @@ -826,22 +637,6 @@ Log::logSkipped() { fi } -# @description check if an element is contained in an array -# -# @arg $1 needle:String -# @arg $@ array:String[] -# @exitcode 0 if found -# @exitcode 1 otherwise -# @example -# Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}" -Array::contains() { - local element - for element in "${@:2}"; do - [[ "${element}" = "$1" ]] && return 0 - done - return 1 -} - # FUNCTIONS facade_main_waitForMysqlsh() { @@ -931,6 +726,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1065,54 +861,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -1561,7 +1350,7 @@ waitForMysqlCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/build.sh b/build.sh deleted file mode 100755 index 58ae3ff9..00000000 --- a/build.sh +++ /dev/null @@ -1,37 +0,0 @@ -#!/usr/bin/env bash - -BASH_TOOLS_ROOT_DIR=$(cd "$(readlink -e "${BASH_SOURCE[0]%/*}")" && pwd -P) -BASH_TOOLS_SRC_DIR="${BASH_TOOLS_ROOT_DIR}/src" -FRAMEWORK_ROOT_DIR="${BASH_TOOLS_ROOT_DIR}/vendor/bash-tools-framework" -FRAMEWORK_BIN_DIR="${FRAMEWORK_ROOT_DIR}/bin" -COMMAND_BIN_DIR="${BASH_TOOLS_ROOT_DIR}/bin" - -# shellcheck source=./vendor/bash-tools-framework/src/_includes/_header.sh -source "${FRAMEWORK_ROOT_DIR}/src/_includes/_header.sh" - -# srcFile : file that needs to be compiled -# templateDir : directory from which bash-tpl templates will be searched -# binDir : fallback bin directory in case BIN_FILE has not been provided -# rootDir : directory used to compute src file relative path -# srcDirs : additional directories where to find the functions -declare -a params=( - --src-dir "${BASH_TOOLS_SRC_DIR}" - --bin-dir "${COMMAND_BIN_DIR}" - --root-dir "${BASH_TOOLS_ROOT_DIR}" - --template-dir "${BASH_TOOLS_SRC_DIR}" -) -if [[ "${ARGS_VERBOSE}" = "1" ]]; then - params+=("-vvv") -fi - -( - if (($# == 0)); then - find "${BASH_TOOLS_SRC_DIR}/_binaries" -name "*.sh" | - (grep -v -E '/testsData/' || true) - else - for file in "$@"; do - realpath "${file}" - done - fi -) | xargs -L1 -P8 -I{} \ - "${FRAMEWORK_BIN_DIR}/compile" "{}" "${params[@]}" diff --git a/conf/dbScripts/extractData b/conf/dbScripts/extractData index 77c0629e..904a4489 100755 --- a/conf/dbScripts/extractData +++ b/conf/dbScripts/extractData @@ -537,28 +537,38 @@ Log::logWarning() { } # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description activate or not Log::display* and Log::log* functions @@ -606,96 +616,6 @@ Log::requireLoad() { fi } -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - -# @description Display message using skip color (yellow) -# @arg $1 message:String the message to display -Log::displaySkipped() { - if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then - echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 - fi - Log::logSkipped "$1" -} - # @description To be called before logging in the log file # @arg $1 file:string log file name # @arg $2 maxLogFilesCount:int maximum number of log files @@ -725,49 +645,13 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" -} - -# @description log message to file +# @description Display message using skip color (yellow) # @arg $1 message:String the message to display -Log::logSkipped() { - if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then - Log::logMessage "${2:-SKIPPED}" "$1" +Log::displaySkipped() { + if ((BASH_FRAMEWORK_DISPLAY_LEVEL >= __LEVEL_INFO)); then + echo -e "${__SKIPPED_COLOR}SKIPPED - ${1}${__RESET_COLOR}" >&2 fi + Log::logSkipped "$1" } # @description load colors theme constants @@ -866,6 +750,14 @@ Assert::tty() { [[ -t 1 || -t 2 ]] } +# @description log message to file +# @arg $1 message:String the message to display +Log::logSkipped() { + if ((BASH_FRAMEWORK_LOG_LEVEL >= __LEVEL_INFO)); then + Log::logMessage "${2:-SKIPPED}" "$1" + fi +} + # FUNCTIONS facade_main_extractDatash() { diff --git a/install b/install index e4711ce5..192c3023 100755 --- a/install +++ b/install @@ -212,42 +212,38 @@ Array::wrap() { #Array::wrap ":" 40 0 "Lorem ipsum dolor sit amet," "consectetur adipiscing elit." "Curabitur ac elit id massa" "condimentum finibus." # @description ensure env files are loaded -# @noargs -# @exitcode 1 if getOrderedConfFiles fails -# @exitcode 2 if one of env files fails to load +# @arg $@ list of default files to load at the end +# @exitcode 1 if one of env files fails to load # @stderr diagnostics information is displayed +# shellcheck disable=SC2120 Env::requireLoad() { - local configFilesStr - configFilesStr="$(Env::getOrderedConfFiles)" || return 1 - - local -a configFiles - readarray -t configFiles <<<"${configFilesStr}" - - # if empty string, there will be one element - if ((${#configFiles[@]} == 0)) || [[ -z "${configFilesStr}" ]]; then - # should not happen, as there is always default file - Log::displaySkipped "no env file to load" - return 0 + local -a defaultFiles=("$@") + # get list of possible config files + local -a configFiles=() + if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then + # BASH_FRAMEWORK_ENV_FILES is an array + configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") fi + if [[ -f "$(pwd)/.framework-config" ]]; then + configFiles+=("$(pwd)/.framework-config") + fi + if [[ -f "${FRAMEWORK_ROOT_DIR}/.framework-config" ]]; then + configFiles+=("${FRAMEWORK_ROOT_DIR}/.framework-config") + fi + if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then + # shellcheck disable=SC2034 + configFiles+=("${optionBashFrameworkConfig}") + fi + configFiles+=("${optionEnvFiles[@]}") + configFiles+=("${defaultFiles[@]}") - Env::mergeConfFiles "${configFiles[@]}" || { - Log::displayError "while loading config files: ${configFiles[*]}" - return 2 - } -} - -# @description load .framework-config -# @arg $1 loadedConfigFile:&String (passed by reference) the finally loaded configuration file path -# @arg $@ srcDirs:String[] the src directories in which .framework-config file will be searched -# @stdout the config file path loaded if any -# @exitcode 0 if .framework-config file has been found in srcDirs provided -# @exitcode 1 if .framework-config file not found -# @see Conf::loadNearestFile -Framework::loadConfig() { - # shellcheck disable=SC2034 - local -n loadConfig_loadedConfigFile=$1 - shift || true - Conf::loadNearestFile ".framework-config" loadConfig_loadedConfigFile "$@" + for file in "${configFiles[@]}"; do + # shellcheck source=/.framework-config + source "${file}" || { + Log::displayError "while loading config file: ${file}" + return 1 + } + done } # @description Log namespace provides 2 kind of functions @@ -501,122 +497,6 @@ Assert::tty() { [[ -t 1 || -t 2 ]] } -# @description Load the nearest config file -# in next example will search first .framework-config file in "srcDir1" -# then if not found will go in up directories until / -# then will search in "srcDir2" -# then if not found will go in up directories until / -# source the file if found -# @example -# Conf::loadNearestFile ".framework-config" "srcDir1" "srcDir2" -# -# @arg $1 configFileName:String config file name to search -# @arg $2 loadedFile:String (passed by reference) will return the loaded config file name -# @arg $@ srcDirs:String[] source directories in which the config file will be searched -# @exitcode 0 if file found -# @exitcode 1 if file not found -Conf::loadNearestFile() { - local configFileName="$1" - local -n loadedFile="$2" - shift 2 || true - local -a srcDirs=("$@") - for srcDir in "${srcDirs[@]}"; do - configFile="$(File::upFind "${srcDir}" "${configFileName}" || true)" - if [[ -n "${configFile}" ]]; then - # shellcheck source=/.framework-config - source "${configFile}" || Log::fatal "error while loading config file '${configFile}'" - Log::displayDebug "Config file ${configFile} is loaded" - # shellcheck disable=SC2034 - loadedFile="${configFile}" - return 0 - fi - done - - Log::displayWarning "Config file '${configFileName}' not found in any source directories provided" - return 1 -} - -# @description get list of env files to load -# in order to make them available for Env::requireLoad -# @env BASH_FRAMEWORK_ENV_FILES String[] list of env files that should be loaded -# @exitcode 1 if one of the env file cannot be generated -# @exitcode 2 if one of the env file is not a file or readable -# @stdout the env files asked to be loaded -# @stderr diagnostic information on failure -# @see https://github.com/fchastanet/bash-tools-framework/blob/master/FrameworkDoc.md#config_file_order -Env::getOrderedConfFiles() { - local -a configFiles=() - - if [[ -n "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - # BASH_FRAMEWORK_ENV_FILES is an array - configFiles+=("${BASH_FRAMEWORK_ENV_FILES[@]}") - fi - - local defaultEnvFile - defaultEnvFile="$(Env::createDefaultEnvFile)" || return 1 - configFiles+=("${defaultEnvFile}") - - local file - for file in "${configFiles[@]}"; do - if [[ ! -f "${file}" || ! -r "${file}" ]]; then - Log::displayError "One of the config file is not available '${file}'" - return 2 - fi - echo "${file}" - done -} - -# @description merge and load conf files specified as argument -# - files are cleaned from ay comment -# - missing quotes after property = sign are added automatically -# - automatic remove of all whitespace before and after declarations -# - bash arrays are not supported -# - if a variable is declared in first file and overridden later on -# in the same file or in subsequent files, those overloads will be -# ignored -# @warning if an error occurs while loading one of the config file, exit code 3 but environment could be partially loaded -# @arg $@ args:String[] list of configuration files to load in order -# @set envVars String will set in environment all the variables that have been declared in the config files -# @env envVars String the env variables of the current script could be used to interpret variables during config files parsing -# @exitcode 0 if no config files provided or load completed successfully -# @exitcode 1 if error occurred during parsing the config files (file not found, grep, awk or sed error) -# @exitcode 2 if temporary file cannot be created -# @exitcode 3 if an error occurred during config file sourcing -# @stderr diagnostics information is displayed -# @see largely inspired but modified from https://opensource.com/article/21/5/processing-configuration-files-shell -Env::mergeConfFiles() { - local -a configFileList=("$@") - - if ((${#configFileList[@]} == 0)); then - return 0 - fi - - local combinedConfigFile - combinedConfigFile="$(Framework::createTempFile "mergeConfFiles")" || return 2 - - ( - # removes any trailing whitespace from each file, if any - # this is absolutely required when importing into ConfigMaps - # put quotes around values - sed -E -e $'s/\s*$// ; /^$/d ; /^#.*$/d ; s/=([^"\'].*)$/="\\1"/' "${configFileList[@]}" | - # remove all comment lines - Filters::commentLines | - # iterates over each file and prints (default awk behavior) - # each unique line; only takes first value and ignores duplicates - awk -F= '!line[$1]++' - ) >"${combinedConfigFile}" || return 1 - - # have to export everything, and source it twice: - # 1) first source is to realize variables - # 2) second time is to realize references - set -o allexport - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - # shellcheck source=.framework-config - source "${combinedConfigFile}" || return 3 - set +o allexport -} - # @description prepend directories to the PATH environment variable # @arg $@ args:String[] list of directories to prepend # @set PATH update PATH with the directories prepended @@ -744,91 +624,6 @@ UI::requireTheme() { UI::theme "${BASH_FRAMEWORK_THEME-default}" } -# @description default env file with all default values -# @stdout the default env filepath -Env::createDefaultEnvFile() { - local envFile - envFile="$(Framework::createTempFile "createDefaultEnvFileEnvFile")" || return 2 - - ( - echo "BASH_FRAMEWORK_THEME=${BASH_FRAMEWORK_THEME:-default}" - echo "BASH_FRAMEWORK_LOG_LEVEL=${BASH_FRAMEWORK_LOG_LEVEL:-0}" - echo "BASH_FRAMEWORK_DISPLAY_LEVEL=${BASH_FRAMEWORK_DISPLAY_LEVEL:-${__LEVEL_WARNING}}" - # shellcheck disable=SC2016 - echo 'BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-"${FRAMEWORK_ROOT_DIR}/logs/${SCRIPT_NAME}.log"}"' - echo "BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION=${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" - ) >"${envFile}" - echo "${envFile}" -} - -# @description search a file in parent directories -# -# @arg $1 fromPath:String path -# @arg $2 fileName:String -# @arg $3 untilInclusivePath:String (optional) find for given file until reaching this folder (default value: /) -# @arg $@ untilInclusivePaths:String[] list of untilInclusivePath -# @stdout The filename if found -# @exitcode 1 if the command failed or file not found -File::upFind() { - local fromPath="$1" - shift || true - local fileName="$1" - shift || true - local untilInclusivePath="${1:-/}" - shift || true - - if [[ -f "${fromPath}" ]]; then - fromPath="$(dirname "${fromPath}")" - fi - while true; do - if [[ -f "${fromPath}/${fileName}" ]]; then - echo "${fromPath}/${fileName}" - return 0 - fi - if Array::contains "${fromPath}" "${untilInclusivePath}" "$@" "/"; then - return 1 - fi - fromPath="$(readlink -f "${fromPath}"/..)" - done - return 1 -} - -# @description remove comment lines from input or files provided as arguments -# @arg $@ files:String[] (optional) the files to filter -# @env commentLinePrefix String the comment line prefix (default value: #) -# @exitcode 0 if lines filtered or not -# @exitcode 2 if grep fails for any other reasons than not found -# @stdin the file as stdin to filter (alternative to files argument) -# @stdout the filtered lines -# shellcheck disable=SC2120 -Filters::commentLines() { - grep -vxE "[[:blank:]]*(${commentLinePrefix:-#}.*)?" "$@" || test $? = 1 -} - -# @description create a temp file using default TMPDIR variable -# initialized in _includes/_commonHeader.sh -# @env TMPDIR String (default value /tmp) -# @arg $1 templateName:String template name to use(optional) -Framework::createTempFile() { - mktemp -p "${TMPDIR:-/tmp}" -t "${1:-}.XXXXXXXXXXXX" -} - -# @description check if an element is contained in an array -# -# @arg $1 needle:String -# @arg $@ array:String[] -# @exitcode 0 if found -# @exitcode 1 otherwise -# @example -# Array::contains "${libPath}" "${__BASH_FRAMEWORK_IMPORTED_FILES[@]}" -Array::contains() { - local element - for element in "${@:2}"; do - [[ "${element}" = "$1" ]] && return 0 - done - return 1 -} - # FUNCTIONS facade_main_installsh() { @@ -911,6 +706,7 @@ optionVersionCallback() { # shellcheck disable=SC2317 # if function is overridden optionEnvFileCallback() { local envFile="$2" + Log::displayWarning "Command ${SCRIPT_NAME} - Option --env-file is deprecated and will be removed in the future" if [[ ! -f "${envFile}" || ! -r "${envFile}" ]]; then Log::displayError "Command ${SCRIPT_NAME} - Option --env-file - File '${envFile}' doesn't exist" exit 1 @@ -1045,54 +841,47 @@ defaultFrameworkConfig="$( # copied from src/_includes/.framework-config.default # shellcheck disable=SC2034 +REAL_SCRIPT_FILE="${REAL_SCRIPT_FILE:-$(readlink -e "$(realpath "${BASH_SOURCE[0]}")")}" +FRAMEWORK_ROOT_DIR="${FRAMEWORK_ROOT_DIR:-$(cd "$(readlink -e "${REAL_SCRIPT_FILE%/*}")/../.." && pwd -P)}" +FRAMEWORK_SRC_DIR="${FRAMEWORK_SRC_DIR:-${FRAMEWORK_ROOT_DIR}/src}" +FRAMEWORK_BIN_DIR="${FRAMEWORK_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/bin}" +FRAMEWORK_VENDOR_DIR="${FRAMEWORK_VENDOR_DIR:-${FRAMEWORK_ROOT_DIR}/vendor}" +FRAMEWORK_VENDOR_BIN_DIR="${FRAMEWORK_VENDOR_BIN_DIR:-${FRAMEWORK_ROOT_DIR}/vendor/bin}" + # describe the functions that will be skipped from being imported -FRAMEWORK_FUNCTIONS_IGNORE_REGEXP='^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$' +FRAMEWORK_FUNCTIONS_IGNORE_REGEXP="${FRAMEWORK_FUNCTIONS_IGNORE_REGEXP:-^(Namespace::functions|Functions::myFunction|Namespace::requireSomething|Acquire::ForceIPv4)$}" # describe the files that do not contain function to be imported -NON_FRAMEWORK_FILES_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)" +NON_FRAMEWORK_FILES_REGEXP="${NON_FRAMEWORK_FILES_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/_binaries|^src/_includes|^src/batsHeaders.sh$|^src/_standalone)}" # describe the files that are allowed to not have an associated bats file -BATS_FILE_NOT_NEEDED_REGEXP="(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)" +BATS_FILE_NOT_NEEDED_REGEXP="${BATS_FILE_NOT_NEEDED_REGEXP:-(^bin/|.framework-config|.bats$|/testsData/|^manualTests/|/_.sh$|/ZZZ.sh$|/__all.sh$|^src/batsHeaders.sh$|^src/_includes)}" # describe the files that are allowed to not have a function matching the filename -FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="^bin/|^\.framework-config$|^build.sh$|\.tpl$|/testsData/|^manualTests/|\.bats$" +FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP="${FRAMEWORK_FILES_FUNCTION_MATCHING_IGNORE_REGEXP:-^bin/|^\.framework-config$|\.tpl$|/testsData/|^manualTests/|\.bats$}" # Source directories -FRAMEWORK_SRC_DIRS=( - "${FRAMEWORK_ROOT_DIR}/src" -) +if [[ ! -v FRAMEWORK_SRC_DIRS ]]; then + FRAMEWORK_SRC_DIRS=( + "${FRAMEWORK_ROOT_DIR}/src" + ) +fi # export here all the variables that will be used in your templates -export REPOSITORY_URL="https://github.com/fchastanet/bash-tools-framework" +export REPOSITORY_URL="${REPOSITORY_URL:-https://github.com/fchastanet/bash-tools-framework}" + +BASH_FRAMEWORK_THEME="${BASH_FRAMEWORK_THEME:-default}" +BASH_FRAMEWORK_LOG_LEVEL="${BASH_FRAMEWORK_LOG_LEVEL:-0}" +BASH_FRAMEWORK_DISPLAY_LEVEL="${BASH_FRAMEWORK_DISPLAY_LEVEL:-3}" +BASH_FRAMEWORK_LOG_FILE="${BASH_FRAMEWORK_LOG_FILE:-${FRAMEWORK_ROOT_DIR}/logs/$(basename "$0").log}" +BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION="${BASH_FRAMEWORK_LOG_FILE_MAX_ROTATION:-5}" EOF )" commandOptionParseFinished() { - if [[ -z "${BASH_FRAMEWORK_ENV_FILES[0]+1}" ]]; then - BASH_FRAMEWORK_ENV_FILES=() - fi - BASH_FRAMEWORK_ENV_FILES+=("${optionEnvFiles[@]}") - export BASH_FRAMEWORK_ENV_FILES - Env::requireLoad - Log::requireLoad + # load default template framework config + # shellcheck disable=SC2034 + defaultEnvFile="${PERSISTENT_TMPDIR}/.framework-config" + echo "${defaultFrameworkConfig}" > "${defaultEnvFile}" - # load .framework-config - if [[ -n "${optionBashFrameworkConfig}" && -f "${optionBashFrameworkConfig}" ]]; then - BASH_FRAMEWORK_CONFIG_FILE="${optionBashFrameworkConfig}" - # shellcheck source=/.framework-config - source "${optionBashFrameworkConfig}" || - Log::fatal "Command ${SCRIPT_NAME} - error while loading specific .framework-config file: ${optionBashFrameworkConfig}" - else - # shellcheck disable=SC2034 - BASH_FRAMEWORK_CONFIG_FILE="" - # shellcheck source=/.framework-config - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${FRAMEWORK_ROOT_DIR}" || { - # load default template framework config - if [[ ! -f "${PERSISTENT_TMPDIR}/.framework-config" ]]; then - echo "${defaultFrameworkConfig}" > "${PERSISTENT_TMPDIR}/.framework-config" - fi - Framework::loadConfig BASH_FRAMEWORK_CONFIG_FILE "${PERSISTENT_TMPDIR}" || { - Log::fatal "Command ${SCRIPT_NAME} - error while loading .framework-config.default file" - } - Log::displayWarning "Command ${SCRIPT_NAME} - Load default .framework-config file - ${PERSISTENT_TMPDIR}/.framework-config" - } - fi + Env::requireLoad "${defaultEnvFile}" + Log::requireLoad if [[ "${optionConfig}" = "1" ]]; then displayConfig @@ -1416,7 +1205,7 @@ installCommand() { echo -e " ${__HELP_OPTION_COLOR}--env-file ${__HELP_NORMAL} {list} (optional)" local -a helpArray # shellcheck disable=SC2054 - helpArray=(Load\ the\ specified\ env\ file) + helpArray=(Load\ the\ specified\ env\ file\ \(deprecated\,\ please\ use\ --bash-framework-config\ option\ instead\)) echo -e " $(Array::wrap " " 76 4 "${helpArray[@]}")" echo -e " ${__HELP_OPTION_COLOR}--no-color${__HELP_NORMAL} {single}" local -a helpArray diff --git a/src/_binaries/Converters/testsData/mysql2puml.help.txt b/src/_binaries/Converters/testsData/mysql2puml.help.txt index b8ee7cce..8495ecfa 100644 --- a/src/_binaries/Converters/testsData/mysql2puml.help.txt +++ b/src/_binaries/Converters/testsData/mysql2puml.help.txt @@ -27,7 +27,8 @@ -vvv {single} trace level verbose mode (alias of --display-level TRACE) --env-file  {list} (optional) - Load the specified env file + Load the specified env file (deprecated, please use --bash-framework-config + option instead) --no-color {single} Produce monochrome output. alias of --theme noColor. --theme  {single} diff --git a/src/_binaries/DbImport/dbImport.bats b/src/_binaries/DbImport/dbImport.bats index 744554d9..87539ada 100755 --- a/src/_binaries/DbImport/dbImport.bats +++ b/src/_binaries/DbImport/dbImport.bats @@ -308,7 +308,6 @@ function Database::dbImport::import_from_aws_with_tables_filter { #@test export BASH_FRAMEWORK_ENV_FILEPATH="${BATS_TEST_DIRNAME}/testsData/.env" run "${binDir}/dbImport" --verbose --from-aws fromDb.tar.gz toDb --tables dataTable,otherTable 2>&1 - assert_output --partial "Import database duration : " assert_output --partial "ignore table emptyTable" assert_output --partial "begin insert dataTable" diff --git a/src/_binaries/DbImport/testsData/auto_default.local_fromDb_20.sh b/src/_binaries/DbImport/testsData/auto_default.local_fromDb_20.sh index 2ec8a5fd..33f38ff5 100755 --- a/src/_binaries/DbImport/testsData/auto_default.local_fromDb_20.sh +++ b/src/_binaries/DbImport/testsData/auto_default.local_fromDb_20.sh @@ -4,5 +4,5 @@ cat | grep -v '^table1$' | # table size 29MB grep -v '^table2$' | # table size 10MB -# grep -v '^table3$' | # table size 4MB +# grep -v '^table3$' | # table size 4MB cat diff --git a/src/_binaries/DbImport/testsData/dbImport.help.txt b/src/_binaries/DbImport/testsData/dbImport.help.txt index 3d4cfd29..d0d27835 100644 --- a/src/_binaries/DbImport/testsData/dbImport.help.txt +++ b/src/_binaries/DbImport/testsData/dbImport.help.txt @@ -56,7 +56,8 @@ -vvv {single} trace level verbose mode (alias of --display-level TRACE) --env-file  {list} (optional) - Load the specified env file + Load the specified env file (deprecated, please use --bash-framework-config + option instead) --no-color {single} Produce monochrome output. alias of --theme noColor. --theme  {single} diff --git a/src/_binaries/DbImport/testsData/dbImportProfile.help.txt b/src/_binaries/DbImport/testsData/dbImportProfile.help.txt index fe9fcc5f..eed43c23 100644 --- a/src/_binaries/DbImport/testsData/dbImportProfile.help.txt +++ b/src/_binaries/DbImport/testsData/dbImportProfile.help.txt @@ -36,7 +36,8 @@ -vvv {single} trace level verbose mode (alias of --display-level TRACE) --env-file  {list} (optional) - Load the specified env file + Load the specified env file (deprecated, please use --bash-framework-config + option instead) --no-color {single} Produce monochrome output. alias of --theme noColor. --theme  {single} diff --git a/src/_binaries/DbImport/testsData/dbImportStream.help.txt b/src/_binaries/DbImport/testsData/dbImportStream.help.txt index 87d3059d..14739ed6 100644 --- a/src/_binaries/DbImport/testsData/dbImportStream.help.txt +++ b/src/_binaries/DbImport/testsData/dbImportStream.help.txt @@ -40,7 +40,8 @@ -vvv {single} trace level verbose mode (alias of --display-level TRACE) --env-file  {list} (optional) - Load the specified env file + Load the specified env file (deprecated, please use --bash-framework-config + option instead) --no-color {single} Produce monochrome output. alias of --theme noColor. --theme  {single} diff --git a/src/_binaries/DbQueryAllDatabases/testsData/dbQueryAllDatabases.help.txt b/src/_binaries/DbQueryAllDatabases/testsData/dbQueryAllDatabases.help.txt index 8c275026..8c57c76a 100644 --- a/src/_binaries/DbQueryAllDatabases/testsData/dbQueryAllDatabases.help.txt +++ b/src/_binaries/DbQueryAllDatabases/testsData/dbQueryAllDatabases.help.txt @@ -43,7 +43,8 @@ -vvv {single} trace level verbose mode (alias of --display-level TRACE) --env-file  {list} (optional) - Load the specified env file + Load the specified env file (deprecated, please use --bash-framework-config + option instead) --no-color {single} Produce monochrome output. alias of --theme noColor. --theme  {single} diff --git a/src/_binaries/DbScriptAllDatabases/testsData/dbScriptAllDatabases.help.txt b/src/_binaries/DbScriptAllDatabases/testsData/dbScriptAllDatabases.help.txt index 884015af..4e8b2e67 100644 --- a/src/_binaries/DbScriptAllDatabases/testsData/dbScriptAllDatabases.help.txt +++ b/src/_binaries/DbScriptAllDatabases/testsData/dbScriptAllDatabases.help.txt @@ -47,7 +47,8 @@ Allows to execute a script on each database of specified mysql server -vvv {single} trace level verbose mode (alias of --display-level TRACE) --env-file  {list} (optional) - Load the specified env file + Load the specified env file (deprecated, please use --bash-framework-config + option instead) --no-color {single} Produce monochrome output. alias of --theme noColor. --theme  {single} diff --git a/src/_binaries/Docker/testsData/cli.help.txt b/src/_binaries/Docker/testsData/cli.help.txt index f9297ec2..8fd39f97 100644 --- a/src/_binaries/Docker/testsData/cli.help.txt +++ b/src/_binaries/Docker/testsData/cli.help.txt @@ -39,7 +39,8 @@ -vvv {single} trace level verbose mode (alias of --display-level TRACE) --env-file  {list} (optional) - Load the specified env file + Load the specified env file (deprecated, please use --bash-framework-config + option instead) --no-color {single} Produce monochrome output. alias of --theme noColor. --theme  {single} diff --git a/src/_binaries/Git/testsData/gitIsAncestorOf.help.txt b/src/_binaries/Git/testsData/gitIsAncestorOf.help.txt index e4db7d17..65fbf775 100644 --- a/src/_binaries/Git/testsData/gitIsAncestorOf.help.txt +++ b/src/_binaries/Git/testsData/gitIsAncestorOf.help.txt @@ -24,7 +24,8 @@ -vvv {single} trace level verbose mode (alias of --display-level TRACE) --env-file  {list} (optional) - Load the specified env file + Load the specified env file (deprecated, please use --bash-framework-config + option instead) --no-color {single} Produce monochrome output. alias of --theme noColor. --theme  {single} diff --git a/src/_binaries/Git/testsData/gitRenameBranch.help.txt b/src/_binaries/Git/testsData/gitRenameBranch.help.txt index 2b19e695..88207f95 100644 --- a/src/_binaries/Git/testsData/gitRenameBranch.help.txt +++ b/src/_binaries/Git/testsData/gitRenameBranch.help.txt @@ -35,7 +35,8 @@ -vvv {single} trace level verbose mode (alias of --display-level TRACE) --env-file  {list} (optional) - Load the specified env file + Load the specified env file (deprecated, please use --bash-framework-config + option instead) --no-color {single} Produce monochrome output. alias of --theme noColor. --theme  {single} diff --git a/src/_binaries/Git/testsData/upgradeGithubRelease.help.txt b/src/_binaries/Git/testsData/upgradeGithubRelease.help.txt index 7cc9e555..e40168a9 100644 --- a/src/_binaries/Git/testsData/upgradeGithubRelease.help.txt +++ b/src/_binaries/Git/testsData/upgradeGithubRelease.help.txt @@ -49,7 +49,8 @@ -vvv {single} trace level verbose mode (alias of --display-level TRACE) --env-file  {list} (optional) - Load the specified env file + Load the specified env file (deprecated, please use --bash-framework-config + option instead) --no-color {single} Produce monochrome output. alias of --theme noColor. --theme  {single} diff --git a/src/_binaries/Utils/testsData/waitForIt.help.txt b/src/_binaries/Utils/testsData/waitForIt.help.txt index cc8da451..1ef282b6 100644 --- a/src/_binaries/Utils/testsData/waitForIt.help.txt +++ b/src/_binaries/Utils/testsData/waitForIt.help.txt @@ -39,7 +39,8 @@ -vvv {single} trace level verbose mode (alias of --display-level TRACE) --env-file  {list} (optional) - Load the specified env file + Load the specified env file (deprecated, please use --bash-framework-config + option instead) --no-color {single} Produce monochrome output. alias of --theme noColor. --theme  {single} diff --git a/src/_binaries/Utils/testsData/waitForMysql.help.txt b/src/_binaries/Utils/testsData/waitForMysql.help.txt index 4d739c8d..373497f3 100644 --- a/src/_binaries/Utils/testsData/waitForMysql.help.txt +++ b/src/_binaries/Utils/testsData/waitForMysql.help.txt @@ -33,7 +33,8 @@ -vvv {single} trace level verbose mode (alias of --display-level TRACE) --env-file  {list} (optional) - Load the specified env file + Load the specified env file (deprecated, please use --bash-framework-config + option instead) --no-color {single} Produce monochrome output. alias of --theme noColor. --theme  {single} diff --git a/src/_binaries/build/doc.sh b/src/_binaries/build/doc.sh index bcbc7a6a..14890978 100755 --- a/src/_binaries/build/doc.sh +++ b/src/_binaries/build/doc.sh @@ -13,7 +13,7 @@ declare -a RUN_CONTAINER_ARGV_FILTERED=() run() { if [[ "${IN_BASH_DOCKER:-}" != "You're in docker" ]]; then DOCKER_RUN_OPTIONS=$"-e ORIGINAL_DOC_DIR=${DOC_DIR}" \ - "${COMMAND_BIN_DIR}/runBuildContainer" "/bash/bin/doc" \ + "${FRAMEWORK_BIN_DIR}/runBuildContainer" "/bash/bin/doc" \ "${RUN_CONTAINER_ARGV_FILTERED[@]}" return $? fi diff --git a/src/_binaries/build/installRequirements.options.tpl b/src/_binaries/build/installRequirements.options.tpl index 02df895f..61532f84 100644 --- a/src/_binaries/build/installRequirements.options.tpl +++ b/src/_binaries/build/installRequirements.options.tpl @@ -1,6 +1,5 @@ % declare -a externalBinaries=( - bin/runBuildContainer bin/test ) declare versionNumber="1.0"