From 6e6bb50d5e8b3a9921067237a4ca5e1cb57d472e Mon Sep 17 00:00:00 2001 From: "Brown, Joshua" Date: Sun, 18 Feb 2024 21:53:33 -0500 Subject: [PATCH] Address codacy issues --- CHANGELOG.md | 6 +++--- compose/build_images_for_compose.sh | 2 +- compose/compose.yml | 9 +++++++++ docker/entrypoint_foxx.sh | 2 +- scripts/export_dependency_version.sh | 2 +- scripts/install_lego_and_certificates.sh | 6 +++--- scripts/install_ws.sh | 25 ++++++++++++------------ scripts/utils.sh | 2 +- web/docker/entrypoint.sh | 14 ++++++------- 9 files changed, 38 insertions(+), 30 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a633525cb..f8b11c8ad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,9 +4,9 @@ ## MINOR Feature 1. [912] - Adds initial compose file and docker files for python-client -1. [909] - Added Support for Google Analytics -2. [916] - Reworked Docker build process to be faster and produce simpler and smaller images -2. [912] - Adding working compose instance for core metadata services. +2. [909] - Added Support for Google Analytics +3. [916] - Reworked Docker build process to be faster and produce simpler and smaller images +4. [912] - Adding working compose instance for core metadata services. ## PATCH Bug fixes/Technical Debt/Documentation 1. [914] - Improve GitHub template diff --git a/compose/build_images_for_compose.sh b/compose/build_images_for_compose.sh index 1c8aa08cf..7b155465f 100755 --- a/compose/build_images_for_compose.sh +++ b/compose/build_images_for_compose.sh @@ -4,7 +4,7 @@ set -euf -o pipefail SCRIPT=$(realpath "$0") SOURCE=$(dirname "$SCRIPT") -PROJECT_ROOT=$(realpath ${SOURCE}/../) +PROJECT_ROOT=$(realpath "${SOURCE}/../") docker build \ -f "${PROJECT_ROOT}/docker/Dockerfile.dependencies" \ diff --git a/compose/compose.yml b/compose/compose.yml index 82a7993fa..cf7467e4e 100644 --- a/compose/compose.yml +++ b/compose/compose.yml @@ -2,6 +2,15 @@ version: '3.9' services: + + keycloak: + image: jboss/keycloak:latest + environment: + KEYCLOAK_USER: admin + KEYCLOAK_PASSWORD: admin + ports: + - "8888:8080" + datafed-web: depends_on: ["datafed-core"] environment: diff --git a/docker/entrypoint_foxx.sh b/docker/entrypoint_foxx.sh index 8e1f189ef..f63516839 100755 --- a/docker/entrypoint_foxx.sh +++ b/docker/entrypoint_foxx.sh @@ -8,7 +8,7 @@ fi SCRIPT=$(realpath "$0") SOURCE=$(dirname "$SCRIPT") -PROJECT_ROOT=$(realpath ${SOURCE}/../) +PROJECT_ROOT=$(realpath "${SOURCE}/../") log_path="$DATAFED_DEFAULT_LOG_PATH" if [ ! -d "${log_path}" ] diff --git a/scripts/export_dependency_version.sh b/scripts/export_dependency_version.sh index a965144af..8fd5302f4 100755 --- a/scripts/export_dependency_version.sh +++ b/scripts/export_dependency_version.sh @@ -3,7 +3,7 @@ # Assumes sourcing not running SCRIPT=$( realpath "${BASH_SOURCE[0]}" ) SCRIPT_DIR=$( dirname "${SCRIPT}" ) -PROJECT_ROOT=$(realpath ${SCRIPT_DIR}/..) +PROJECT_ROOT=$(realpath "${SCRIPT_DIR}/..") echo "SCRIPT $SCRIPT" echo "SCRIPT_DIR $SCRIPT_DIR" diff --git a/scripts/install_lego_and_certificates.sh b/scripts/install_lego_and_certificates.sh index e098e790f..6f19b0c3d 100755 --- a/scripts/install_lego_and_certificates.sh +++ b/scripts/install_lego_and_certificates.sh @@ -4,9 +4,9 @@ set -euf -o pipefail SCRIPT=$(realpath "$0") SOURCE=$(dirname "$SCRIPT") -PROJECT_ROOT=$(realpath ${SOURCE}/..) -source ${PROJECT_ROOT}/config/datafed.sh -source ${PROJECT_ROOT}/scripts/utils.sh +PROJECT_ROOT=$(realpath "${SOURCE}/..") +source "${PROJECT_ROOT}/config/datafed.sh" +source "${PROJECT_ROOT}/scripts/utils.sh" Help() { diff --git a/scripts/install_ws.sh b/scripts/install_ws.sh index 425b4104e..18b248cac 100755 --- a/scripts/install_ws.sh +++ b/scripts/install_ws.sh @@ -4,28 +4,27 @@ set -uf -o pipefail SCRIPT=$(realpath "$0") SOURCE=$(dirname "$SCRIPT") -PROJECT_ROOT=$(realpath ${SOURCE}/..) -source ${PROJECT_ROOT}/config/datafed.sh -source ${SOURCE}/dependency_versions.sh -source ${SOURCE}/dependency_install_functions.sh +PROJECT_ROOT=$(realpath "${SOURCE}/..") +source "${PROJECT_ROOT}/config/datafed.sh" +source "${SOURCE}/dependency_versions.sh" +source "${SOURCE}/dependency_install_functions.sh" #NVM_DIR=/home/cades/.nvm #[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" #export NVM_DIR="/home/cades/.nvm" #source ${NVM_DIR}/nvm.sh # Make sure paths exist -mkdir -p ${DATAFED_INSTALL_PATH}/web -mkdir -p ${DATAFED_INSTALL_PATH}/keys -mkdir -p ${DATAFED_DEFAULT_LOG_PATH} +mkdir -p "${DATAFED_INSTALL_PATH}/web" +mkdir -p "${DATAFED_INSTALL_PATH}/keys" +mkdir -p "${DATAFED_DEFAULT_LOG_PATH}" # Install web node modules -cp "$PROJECT_ROOT/web/package.json" ${DATAFED_INSTALL_PATH}/web/ - +cp "$PROJECT_ROOT/web/package.json" "${DATAFED_INSTALL_PATH}/web/" install_nvm install_node install_foxx_cli { - npm --allow-root --unsafe-perm --prefix ${DATAFED_INSTALL_PATH}/web install + npm --allow-root --unsafe-perm --prefix "${DATAFED_INSTALL_PATH}/web" install } || { echo "ERROR npm command failed!" exit 1 @@ -33,10 +32,10 @@ install_foxx_cli # Install javascript web server repo and core server were # already installed by CMake -cp "$PROJECT_ROOT/web/datafed-ws.js" ${DATAFED_INSTALL_PATH}/web +cp "$PROJECT_ROOT/web/datafed-ws.js" "${DATAFED_INSTALL_PATH}/web" # Copy configuration files -cp "$PROJECT_ROOT/config/datafed-ws.cfg" ${DATAFED_INSTALL_PATH}/web +cp "$PROJECT_ROOT/config/datafed-ws.cfg" "${DATAFED_INSTALL_PATH}/web" # Make sure that the datafed-core-pub.key exists in the web/static folder if [[ -z "${DATAFED_INSTALL_PATH}/keys/datafed-core-key.pub" ]] @@ -45,4 +44,4 @@ then exit 1 fi -cp ${DATAFED_INSTALL_PATH}/keys/datafed-core-key.pub "$DATAFED_INSTALL_PATH/web/static/" +cp "${DATAFED_INSTALL_PATH}/keys/datafed-core-key.pub" "$DATAFED_INSTALL_PATH/web/static/" diff --git a/scripts/utils.sh b/scripts/utils.sh index f88e8c488..c0ee7455a 100755 --- a/scripts/utils.sh +++ b/scripts/utils.sh @@ -4,7 +4,7 @@ SOURCE=$(dirname "$SCRIPT") if [ -z "${PROJECT_ROOT}" ] then - PROJECT_ROOT=$(realpath ${SOURCE}/..) + PROJECT_ROOT=$(realpath "${SOURCE}/..") fi echo "PROJECT ROOT $PROJECT_ROOT" diff --git a/web/docker/entrypoint.sh b/web/docker/entrypoint.sh index d5b1eb597..945c7cdc1 100755 --- a/web/docker/entrypoint.sh +++ b/web/docker/entrypoint.sh @@ -4,19 +4,19 @@ set -euf -o pipefail if [ -n "$UID" ]; then - usermod -u $UID datafed + usermod -u "$UID" datafed fi SCRIPT=$(realpath "$0") SOURCE=$(dirname "$SCRIPT") -PROJECT_ROOT=$(realpath ${SOURCE}/../..) +PROJECT_ROOT=$(realpath "${SOURCE}/../..") -${PROJECT_ROOT}/scripts/generate_datafed.sh -${PROJECT_ROOT}/scripts/generate_ws_config.sh -${PROJECT_ROOT}/scripts/install_ws.sh -. ${PROJECT_ROOT}/scripts/export_dependency_version.sh +"${PROJECT_ROOT}/scripts/generate_datafed.sh" +"${PROJECT_ROOT}/scripts/generate_ws_config.sh" +"${PROJECT_ROOT}/scripts/install_ws.sh" +. "${PROJECT_ROOT}/scripts/export_dependency_version.sh" export NVM_DIR="${DATAFED_DEPENDENCIES_INSTALL_PATH}/nvm" export NODE_VERSION="$DATAFED_NODE_VERSION" @@ -30,7 +30,7 @@ if [ ! -L "/usr/local/bin/node" ]; then ln -s "$NODE_PATH" /usr/local/bin/node fi # Send output to file as well as print to terminal -log_path=$(grep "log-path" ${BUILD_DIR}/config/datafed-ws.cfg | cut -d "=" -f 2 | tr -d ' ') +log_path=$(grep "log-path" "${BUILD_DIR}/config/datafed-ws.cfg" | cut -d "=" -f 2 | tr -d ' ') if [ ! -d "${log_path}" ] then