From 3b7535a79d5ff5e5d8728e88d45e3f5de1bd1da0 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Thu, 6 Aug 2020 04:37:00 +0200 Subject: [PATCH] Update ynh_mongo_db --- scripts/install | 9 +- scripts/remove | 6 +- scripts/restore | 9 +- scripts/upgrade | 9 +- scripts/ynh_mongo_db | 190 +++++++++++++++++++++++++++++-------------- 5 files changed, 135 insertions(+), 88 deletions(-) diff --git a/scripts/install b/scripts/install index 7e947e8..d237541 100755 --- a/scripts/install +++ b/scripts/install @@ -79,13 +79,7 @@ ynh_script_progression --message="Installing dependencies..." ynh_install_nodejs --nodejs_version=$nodejsversion ynh_use_nodejs -if [ "$(lsb_release --codename --short)" = "buster" ]; then - ynh_install_extra_app_dependencies --repo="deb http://repo.mongodb.org/apt/debian buster/mongodb-org/4.2 main" --package="$pkg_dependencies_buster" --key="https://www.mongodb.org/static/pgp/server-4.2.asc" - mongodb_servicename=$mongodb_buster -else - ynh_install_app_dependencies $pkg_dependencies - mongodb_servicename=$mongodb_stretch -fi +ynh_mongo_install #================================================= # CREATE A MONGODB DATABASE @@ -163,7 +157,6 @@ find "$final_path" -type d -print0 | xargs -0 chmod 750 ynh_script_progression --message="Integrating service in YunoHost..." yunohost service add $app --description "Wekan daemon" --log_type "systemd" -yunohost service add mongodb --description "MongoDB daemon" --log "/var/log/mongodb/mongodb.log" #================================================= # START SYSTEMD SERVICE diff --git a/scripts/remove b/scripts/remove index 6781b33..b1a910c 100755 --- a/scripts/remove +++ b/scripts/remove @@ -61,11 +61,7 @@ ynh_script_progression --message="Removing dependencies..." ynh_remove_app_dependencies ynh_remove_nodejs -# Only remove the mongodb service if it is not installed. -if ! ynh_package_is_installed --package="mongodb" -then - yunohost service remove mongodb -fi +ynh_mongo_remove #================================================= # REMOVE APP MAIN DIR diff --git a/scripts/restore b/scripts/restore index ee64abd..bd1eaff 100644 --- a/scripts/restore +++ b/scripts/restore @@ -89,13 +89,7 @@ ynh_script_progression --message="Reinstalling dependencies..." ynh_install_nodejs --nodejs_version=$nodejsversion ynh_use_nodejs -if [ "$(lsb_release --codename --short)" = "buster" ]; then - ynh_install_extra_app_dependencies --repo="deb http://repo.mongodb.org/apt/debian buster/mongodb-org/4.2 main" --package="$pkg_dependencies_buster" --key="https://www.mongodb.org/static/pgp/server-4.2.asc" - mongodb_servicename=$mongodb_buster -else - ynh_install_app_dependencies $pkg_dependencies - mongodb_servicename=$mongodb_stretch -fi +ynh_mongo_install #================================================= # RESTORE THE MONGODB DATABASE @@ -123,7 +117,6 @@ systemctl enable $app.service ynh_script_progression --message="Integrating service in YunoHost..." yunohost service add $app --description "Wekan daemon" --log_type "systemd" -yunohost service add mongodb --description "MongoDB daemon" --log "/var/log/mongodb/mongodb.log" #================================================= # START SYSTEMD SERVICE diff --git a/scripts/upgrade b/scripts/upgrade index 81617cc..b69cc76 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -109,7 +109,6 @@ if ynh_version_gt "1.07~ynh2" "${previous_version}" ; then ynh_remove_app_dependencies ynh_install_app_dependencies "mongodb mongodb-server" yunohost service add $app --description "Wekan daemon" --log_type "systemd" - yunohost service add mongodb --description "MongoDB daemon" --log "/var/log/mongodb/mongodb.log" fi if ynh_version_gt "2.56~ynh1" "${previous_version}" ; then @@ -181,13 +180,7 @@ ynh_remove_nodejs ynh_install_nodejs --nodejs_version=$nodejsversion ynh_use_nodejs -if [ "$(lsb_release --codename --short)" = "buster" ]; then - ynh_install_extra_app_dependencies --repo="deb http://repo.mongodb.org/apt/debian buster/mongodb-org/4.2 main" --package="$pkg_dependencies_buster" --key="https://www.mongodb.org/static/pgp/server-4.2.asc" - mongodb_servicename=$mongodb_buster -else - ynh_install_app_dependencies $pkg_dependencies - mongodb_servicename=$mongodb_stretch -fi +ynh_mongo_install #================================================= # CREATE DEDICATED USER diff --git a/scripts/ynh_mongo_db b/scripts/ynh_mongo_db index 9322c96..b00a756 100644 --- a/scripts/ynh_mongo_db +++ b/scripts/ynh_mongo_db @@ -1,11 +1,20 @@ #!/bin/bash -# Evaluate a mongo command +MONGO_SERVICENAME_STRETCH="mongodb" +MONGO_SERVICENAME_BUSTER="mongod" +MONGO_DEPENDENCIES_STRETCH="mongodb mongodb-server mongo-tools" +MONGO_DEPENDENCIES_BUSTER="mongodb-org mongodb-org-server mongodb-org-tools" +MONGO_CONFIG_STRETCH="/etc/mongodb.conf" +MONGO_CONFIG_BUSTER="/etc/mongod.conf" +MONGO_REPO_BUSTER="deb http://repo.mongodb.org/apt/debian buster/mongodb-org/4.2 main" +MONGO_KEY_BUSTER="https://www.mongodb.org/static/pgp/server-4.2.asc" + +# Execute a mongo command # -# example: ynh_mongo_exec_as --command='db.getMongo().getDBNames().indexOf("wekan")' -# example: ynh_mongo_exec_as --command="db.getMongo().getDBNames().indexOf(\"wekan\")" +# example: ynh_mongo_exec --command='db.getMongo().getDBNames().indexOf("wekan")' +# example: ynh_mongo_exec --command="db.getMongo().getDBNames().indexOf(\"wekan\")" # -# usage: ynh_mongo_exec_as [--user=user] [--password=password] [--authenticationdatabase=authenticationdatabase] [--database=database] [--host=host] [--port=port] --command="command" +# usage: ynh_mongo_exec [--user=user] [--password=password] [--authenticationdatabase=authenticationdatabase] [--database=database] [--host=host] [--port=port] --command="command" [--eval] # | arg: -u, --user= - The user name to connect as # | arg: -p, --password= - The user password # | arg: -d, --authenticationdatabase= - The authenticationdatabase to connect to @@ -13,12 +22,13 @@ # | arg: -h, --host= - The host to connect to # | arg: -P, --port= - The port to connect to # | arg: -c, --command= - The command to evaluate +# | arg: -e, --eval - Evaluate instead of execute the command. # # -ynh_mongo_exec_as() { +ynh_mongo_exec() { # Declare an array to define the options of this helper. - local legacy_args=upadhPc - local -A args_array=( [u]=user= [p]=password= [a]=authenticationdatabase= [d]=database= [h]=host= [P]=port= [c]=command= ) + local legacy_args=upadhPce + local -A args_array=( [u]=user= [p]=password= [a]=authenticationdatabase= [d]=database= [h]=host= [P]=port= [c]=command= [e]=eval ) local user local password local authenticationdatabase @@ -26,60 +36,79 @@ ynh_mongo_exec_as() { local host local port local command + local eval # Manage arguments with getopts ynh_handle_getopts_args "$@" user="${user:-}" password="${password:-}" - authenticationdatabase="${authenticationdatabase:-"admin"}" - database="${database:-"admin"}" + authenticationdatabase="${authenticationdatabase:-}" + database="${database:-}" host="${host:-}" port="${port:-}" + eval=${eval:-0} # If user is provided if [ -n "$user" ] then user="--username=$user" - password="--password=$password" - authenticationdatabase="--authenticationDatabase=$authenticationdatabase" + + # If password is provided + if [ -n "$password" ] + then + password="--password=$password" + fi + + # If authenticationdatabase is provided + if [ -n "$authenticationdatabase" ] + then + authenticationdatabase="--authenticationDatabase=$authenticationdatabase" + else + authenticationdatabase="--authenticationDatabase=admin" + fi else password="" authenticationdatabase="" fi - # Configure dabase connection - database="use $database" - # If host is provided if [ -n "$host" ] then host="--host=$host" fi - # If host is provided + # If port is provided if [ -n "$port" ] then port="--port=$port" fi - mongo --quiet $user $password $authenticationdatabase $host $port < ./dump.bson # -# usage: ynh_mongo_dump_db --database=db_name +# usage: ynh_mongo_dump_db --database=database # | arg: -d, --database= - The database name to dump # | ret: the mongodump output # @@ -127,10 +157,10 @@ ynh_mongo_dump_db() { # # [internal] # -# usage: ynh_mongo_create_user --db_user=db_user --db_pwd=db_pwd --db_name=db_name +# usage: ynh_mongo_create_user --db_user=user --db_pwd=pwd --db_name=name # | arg: -u, --db_user= - The user name to create # | arg: -p, --db_pwd= - The password to identify user by -# | arg: -n, --db_name= - Name of the database to grant privilegies +# | arg: -n, --db_name= - Name of the database to grant privilegies # # ynh_mongo_create_user() { @@ -144,15 +174,15 @@ ynh_mongo_create_user() { ynh_handle_getopts_args "$@" # Create the user and set the user as admin of the db - ynh_mongo_exec_as --database="$db_name" --command='db.createUser( { user: "'${db_user}'", pwd: "'${db_pwd}'", roles: [ { role: "readWrite", db: "'${db_name}'" } ] } );' + ynh_mongo_exec --database="$db_name" --command='db.createUser( { user: "'${db_user}'", pwd: "'${db_pwd}'", roles: [ { role: "readWrite", db: "'${db_name}'" } ] } );' # Add clustermonitoring rights - ynh_mongo_exec_as --database="$db_name" --command='db.grantRolesToUser("'${db_user}'",[{ role: "clusterMonitor", db: "admin" }]);' + ynh_mongo_exec --database="$db_name" --command='db.grantRolesToUser("'${db_user}'",[{ role: "clusterMonitor", db: "admin" }]);' } # Check if a mongo database exists # -# usage: ynh_mongo_database_exists --database=db_name +# usage: ynh_mongo_database_exists --database=database # | arg: -d, --database= - The database for which to check existence # | exit: Return 1 if the database doesn't exist, 0 otherwise # @@ -165,11 +195,11 @@ ynh_mongo_database_exists() { # Manage arguments with getopts ynh_handle_getopts_args "$@" - if [ $(ynh_mongo_exec_as --command='db.getMongo().getDBNames().indexOf("'${database}'")') -lt 0 ] + if [ $(ynh_mongo_exec --command='db.getMongo().getDBNames().indexOf("'${database}'")' --eval) -lt 0 ] then - return 0 - else return 1 + else + return 0 fi } @@ -177,7 +207,7 @@ ynh_mongo_database_exists() { # # example: ynh_mongo_restore_db --database=wekan < ./dump.bson # -# usage: ynh_mongo_restore_db --database=db_name +# usage: ynh_mongo_restore_db --database=database # | arg: -d, --database= - The database name to restore # # @@ -196,27 +226,29 @@ ynh_mongo_restore_db() { # # [internal] # -# usage: ynh_mongo_drop_user --db_user=db_user -# | arg: -u, --db_user= - The user to drop +# usage: ynh_mongo_drop_user --db_user=user --db_name=name +# | arg: -u, --db_user= - The user to drop +# | arg: -n, --db_name= - Name of the database # # ynh_mongo_drop_user() { # Declare an array to define the options of this helper. - local legacy_args=u - local -A args_array=( [u]=db_user= ) + local legacy_args=un + local -A args_array=( [u]=db_user= [n]=db_name= ) local db_user + local db_name # Manage arguments with getopts ynh_handle_getopts_args "$@" - ynh_mongo_exec_as --command='db.dropUser("'${db_user}'", {w: "majority", wtimeout: 5000})' + ynh_mongo_exec --database="$db_name" --command='db.dropUser("'$db_user'", {w: "majority", wtimeout: 5000})' } # Create a database, an user and its password. Then store the password in the app's config # -# usage: ynh_mongo_setup_db --db_user=db_user --db_name=db_name [--db_pwd=db_pwd] -# | arg: -u, --db_user= - Owner of the database -# | arg: -n, --db_name= - Name of the database -# | arg: -p, --db_pwd= - Password of the database. If not provided, a password will be generated +# usage: ynh_mongo_setup_db --db_user=user --db_name=name [--db_pwd=pwd] +# | arg: -u, --db_user= - Owner of the database +# | arg: -n, --db_name= - Name of the database +# | arg: -p, --db_pwd= - Password of the database. If not provided, a password will be generated # # After executing this helper, the password of the created database will be available in $db_pwd # It will also be stored as "mongopwd" into the app settings. @@ -228,7 +260,7 @@ ynh_mongo_setup_db() { local -A args_array=( [u]=db_user= [n]=db_name= [p]=db_pwd= ) local db_user local db_name - local db_pwd + db_pwd="" # Manage arguments with getopts ynh_handle_getopts_args "$@" @@ -239,14 +271,15 @@ ynh_mongo_setup_db() { # Create the user and grant access to the database ynh_mongo_create_user --db_user="$db_user" --db_pwd="$db_pwd" --db_name="$db_name" + # Store the password in the app's config ynh_app_setting_set --app=$app --key=db_pwd --value=$db_pwd } # Remove a database if it exists, and the associated user # -# usage: ynh_mongo_remove_db --db_user=db_user --db_name=db_name -# | arg: -u, --db_user= - Owner of the database -# | arg: -n, --db_name= - Name of the database +# usage: ynh_mongo_remove_db --db_user=user --db_name=name +# | arg: -u, --db_user= - Owner of the database +# | arg: -n, --db_name= - Name of the database # # ynh_mongo_remove_db() { @@ -258,13 +291,52 @@ ynh_mongo_remove_db() { # Manage arguments with getopts ynh_handle_getopts_args "$@" - if ynh_mongo_database_exists --database=$db_name - then # Check if the database exists - ynh_mongo_drop_db --database="$db_name" # Remove the database + if ynh_mongo_database_exists --database=$db_name; then # Check if the database exists + ynh_mongo_drop_db --database=$db_name # Remove the database else ynh_print_warn --message="Database $db_name not found" fi # Remove mongo user if it exists - ynh_mongo_drop_user --db_user=$db_user + ynh_mongo_drop_user --db_user=$db_user --db_name=$db_name +} + +# Install MongoDB and integrate MongoDB service in YunoHost +# +# usage: ynh_mongo_install +# +# +ynh_mongo_install() { + # Define Mongo Service Name + if [ "$(lsb_release --codename --short)" = "buster" ]; then + ynh_install_extra_app_dependencies --repo="$MONGO_REPO_BUSTER" --package="$MONGO_DEPENDENCIES_BUSTER" --key="$MONGO_KEY_BUSTER" + MONGODB_SERVICENAME=$MONGO_SERVICENAME_BUSTER + else + ynh_install_app_dependencies $MONGO_DEPENDENCIES_STRETCH + MONGODB_SERVICENAME=$MONGO_SERVICENAME_STRETCH + fi + mongodb_servicename=$MONGODB_SERVICENAME + + # Make sure MongoDB is started and enabled + systemctl is-enabled $MONGODB_SERVICENAME -q || systemctl enable $MONGODB_SERVICENAME --quiet + systemctl is-active $MONGODB_SERVICENAME -q || ynh_systemd_action --service_name=$MONGODB_SERVICENAME --action=restart + + # Integrate MongoDB service in YunoHost + yunohost service add $MONGODB_SERVICENAME --description "MongoDB daemon" --log "/var/log/mongodb/$MONGODB_SERVICENAME.log" +} + +# Remove MongoDB +# Only remove the MongoDB service integration in YunoHost for now +# if MongoDB package as been removed +# +# usage: ynh_mongo_remove +# +# +ynh_mongo_remove() { + # Only remove the mongodb service if it is not installed. + if ! ynh_package_is_installed --package="mongodb*" + then + yunohost service remove $MONGODB_SERVICENAME + # ynh_secure_remove --file=$MONGO_ROOT_PWD_FILE + fi }