From e8e842b9b1d3dccece36f8e361a00148c2c9233e Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 6 Mar 2022 19:31:44 +0100 Subject: [PATCH 1/3] Apply last example_ynh --- check_process | 9 ++------- conf/app.src | 4 +++- conf/nginx.conf | 1 + scripts/backup | 5 +++++ scripts/change_url | 5 +++++ scripts/install | 24 ++++++++++++++++-------- scripts/remove | 23 +++++++++++------------ scripts/restore | 20 +++++++++++++------- scripts/upgrade | 35 +++++++++++++---------------------- 9 files changed, 69 insertions(+), 57 deletions(-) diff --git a/check_process b/check_process index ae000ec..5dd363f 100644 --- a/check_process +++ b/check_process @@ -1,7 +1,6 @@ ;; Test complet ; Manifest domain="domain.tld" - path="/path" is_public=1 ; Checks pkg_linter=1 @@ -11,15 +10,11 @@ setup_private=1 setup_public=1 upgrade=1 - #upgrade=1 from_commit=CommitHash + # 1.4.0~ynh1 + upgrade=1 from_commit=0bf292928822959bac04db9d89af216ffc288576 backup_restore=1 multi_instance=0 change_url=1 ;;; Options Email= Notification=none -;;; Upgrade options - ; commit=CommitHash - name=Name and date of the commit. - manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666& - diff --git a/conf/app.src b/conf/app.src index 41c9e20..b4d917b 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,5 +1,7 @@ SOURCE_URL=https://github.com/timeoff-management/timeoff-management-application/archive/refs/tags/1.4.0.tar.gz SOURCE_SUM=2831826b689cf1f4bc7e7ae03ac42c4c846a56a8c3e1368f3a1326f46977cdcc SOURCE_SUM_PRG=sha256sum -ARCH_FORMAT=tar.gz +SOURCE_FORMAT=tar.gz SOURCE_IN_SUBDIR=true +SOURCE_FILENAME= +SOURCE_EXTRACT=true diff --git a/conf/nginx.conf b/conf/nginx.conf index a927d57..faa0512 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,3 +1,4 @@ +#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { proxy_pass http://127.0.0.1:__PORT__/; diff --git a/scripts/backup b/scripts/backup index 0739247..65e96c1 100644 --- a/scripts/backup +++ b/scripts/backup @@ -6,6 +6,7 @@ # IMPORT GENERIC HELPERS #================================================= +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers @@ -13,6 +14,10 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= +ynh_clean_setup () { + true +} +# Exit if an error occurs during the execution of the script ynh_abort_if_errors #================================================= diff --git a/scripts/change_url b/scripts/change_url index 55cf986..fabcd40 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -28,6 +28,7 @@ ynh_script_progression --message="Loading installation settings..." # Needed for helper "ynh_add_nginx_config" final_path=$(ynh_app_setting_get --app=$app --key=final_path) + port=$(ynh_app_setting_get --app=$app --key=port) #================================================= @@ -38,6 +39,7 @@ ynh_script_progression --message="Backing up the app before changing its URL (ma # Backup the current version of the app ynh_backup_before_upgrade ynh_clean_setup () { + ynh_clean_check_starting # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" @@ -104,6 +106,8 @@ fi #================================================= # SPECIFIC MODIFICATIONS #================================================= +# MODIFY CONFIGURATION +#================================================= ynh_script_progression --message="Modifying a config file..." domain="$new_domain" @@ -116,6 +120,7 @@ ynh_add_config --template="../conf/app.json" --destination="$final_path/config/a #================================================= ynh_script_progression --message="Starting a systemd service..." +# Start a systemd service ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" #================================================= diff --git a/scripts/install b/scripts/install index 5a26881..3b04635 100644 --- a/scripts/install +++ b/scripts/install @@ -1,7 +1,7 @@ #!/bin/bash #================================================= -# GENERIC STARTING +# GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= @@ -10,10 +10,14 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE FAILURE OF THE SCRIPT +# MANAGE SCRIPT FAILURE #================================================= -ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. +ynh_clean_setup () { + ynh_clean_check_starting +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors #================================================= # RETRIEVE ARGUMENTS FROM THE MANIFEST @@ -26,7 +30,7 @@ is_public=$YNH_APP_ARG_IS_PUBLIC app=$YNH_APP_INSTANCE_NAME #================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS +# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= ynh_script_progression --message="Validating installation parameters..." @@ -80,7 +84,7 @@ ynh_script_progression --message="Setting up source files..." ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source --dest_dir=$final_path +ynh_setup_source --dest_dir="$final_path" chmod 750 "$final_path" chmod -R o-rwx "$final_path" @@ -94,6 +98,8 @@ ynh_script_progression --message="Configuring NGINX web server..." # Create a dedicated NGINX config ynh_add_nginx_config +#================================================= +# SPECIFIC SETUP #================================================= # INSTALL #================================================= @@ -105,9 +111,9 @@ pushd $final_path popd #================================================= -# CONFIGURE +# ADD A CONFIGURATION #================================================= -ynh_script_progression --message="Modifying a config file..." +ynh_script_progression --message="Adding a configuration file..." ynh_add_config --template="../conf/app.json" --destination="$final_path/config/app.json" ynh_add_config --template="../conf/db.json" --destination="$final_path/config/db.json" @@ -136,7 +142,7 @@ yunohost service add $app --description="Manage employee absences" --log="/var/l ynh_script_progression --message="Starting a systemd service..." # Start a systemd service -ynh_systemd_action --service_name=$app --action=start --log_path="systemd" +ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" #================================================= # SETUP SSOWAT @@ -146,6 +152,8 @@ ynh_script_progression --message="Configuring permissions..." # Make app public if necessary if [ $is_public -eq 1 ] then + # Everyone can access the app. + # The "main" permission is automatically created before the install script. ynh_permission_update --permission="main" --add="visitors" fi diff --git a/scripts/remove b/scripts/remove index c81f4af..d548d23 100755 --- a/scripts/remove +++ b/scripts/remove @@ -29,7 +29,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) # Remove the service from the list of services known by YunoHost (added from `yunohost service add`) if ynh_exec_warn_less yunohost service status $app >/dev/null then - ynh_script_progression --message="Removing $app service..." + ynh_script_progression --message="Removing $app service integration..." yunohost service remove $app fi @@ -41,20 +41,10 @@ ynh_script_progression --message="Stopping and removing the systemd service..." # Remove the dedicated systemd config ynh_remove_systemd_config -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." - -# Remove metapackage and its dependencies -ynh_remove_app_dependencies - -ynh_remove_nodejs - #================================================= # REMOVE APP MAIN DIR #================================================= -ynh_script_progression --message="Removing $app main directory..." +ynh_script_progression --message="Removing app main directory..." # Remove the app directory securely ynh_secure_remove --file="$final_path" @@ -67,6 +57,15 @@ ynh_script_progression --message="Removing NGINX web server configuration..." # Remove the dedicated NGINX config ynh_remove_nginx_config +#================================================= +# REMOVE DEPENDENCIES +#================================================= +ynh_script_progression --message="Removing dependencies..." + +# Remove metapackage and its dependencies +ynh_remove_app_dependencies +ynh_remove_nodejs + #================================================= # GENERIC FINALIZATION #================================================= diff --git a/scripts/restore b/scripts/restore index a6c72dd..c2aadc9 100644 --- a/scripts/restore +++ b/scripts/restore @@ -6,6 +6,7 @@ # IMPORT GENERIC HELPERS #================================================= +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers @@ -13,13 +14,16 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= +ynh_clean_setup () { + ynh_clean_check_starting +} # Exit if an error occurs during the execution of the script ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading settings..." +ynh_script_progression --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME @@ -32,29 +36,30 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= ynh_script_progression --message="Validating restoration parameters..." -test ! -d $final_path || ynh_die --message="There is already a directory: $final_path " +test ! -d $final_path \ + || ynh_die --message="There is already a directory: $final_path " #================================================= # STANDARD RESTORATION STEPS #================================================= # RESTORE THE NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Restoring the NGINX configuration..." +ynh_script_progression --message="Restoring the NGINX web server configuration..." ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= -# CREATE DEDICATED USER +# RECREATE THE DEDICATED USER #================================================= ynh_script_progression --message="Recreating the dedicated system user..." -# Create a dedicated user (if not existing) +# Create the dedicated user (if not existing) ynh_system_user_create --username=$app --home_dir="$final_path" #================================================= # RESTORE THE APP MAIN DIR #================================================= -ynh_script_progression --message="Restoring $app main directory..." +ynh_script_progression --message="Restoring the app main directory..." ynh_restore_file --origin_path="$final_path" @@ -69,6 +74,7 @@ chown -R $app:www-data "$final_path" #================================================= ynh_script_progression --message="Reinstalling dependencies..." +# Define and install dependencies ynh_install_app_dependencies $pkg_dependencies # Install Nodejs @@ -94,7 +100,7 @@ yunohost service add $app --description="Manage employee absences" --log="/var/l #================================================= ynh_script_progression --message="Starting a systemd service..." -ynh_systemd_action --service_name=$app --action=start --log_path=systemd +ynh_systemd_action --service_name=$app --action="start" --log_path=systemd #================================================= # GENERIC FINALIZATION diff --git a/scripts/upgrade b/scripts/upgrade index 9b81c58..fc3629f 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -36,12 +36,21 @@ ynh_script_progression --message="Backing up the app before upgrading (may take ynh_backup_before_upgrade ynh_clean_setup () { ynh_clean_check_starting - # restore it if the upgrade fails + # Restore it if the upgrade fails ynh_restore_upgradebackup } # Exit if an error occurs during the execution of the script ynh_abort_if_errors +#================================================= +# STANDARD UPGRADE STEPS +#================================================= +# STOP SYSTEMD SERVICE +#================================================= +ynh_script_progression --message="Stopping a systemd service..." + +ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" + #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= @@ -60,15 +69,6 @@ if ynh_legacy_permissions_exists; then ynh_app_setting_delete --app=$app --key=is_public fi -#================================================= -# STANDARD UPGRADE STEPS -#================================================= -# STOP SYSTEMD SERVICE -#================================================= -ynh_script_progression --message="Stopping a systemd service..." - -ynh_systemd_action --service_name=$app --action=stop --log_path="systemd" - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= @@ -103,16 +103,7 @@ ynh_install_app_dependencies $pkg_dependencies ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version #================================================= -# CONFIGURE -#================================================= -# ynh_script_progression --message="Modifying a config file..." - -# ynh_add_config --template="../conf/app.json" --destination="$final_path/config/app.json" -# ynh_add_config --template="../conf/db.json" --destination="$final_path/config/db.json" - -# chmod 600 "$final_path/config/db.json" -# chown $app:$app "$final_path/config/db.json" - +# SPECIFIC UPGRADE #================================================= # UPGRADE NPM MODULES #================================================= @@ -138,7 +129,7 @@ ynh_add_systemd_config #================================================= # GENERIC FINALIZATION #================================================= -# SECURE FILES AND DIRECTORIES +# INTEGRATE SERVICE IN YUNOHOST #================================================= ynh_script_progression --message="Integrating service in YunoHost..." @@ -149,7 +140,7 @@ yunohost service add $app --description="Manage employee absences" --log="/var/l #================================================= ynh_script_progression --message="Starting a systemd service..." -ynh_systemd_action --service_name=$app --action=start --log_path="systemd" +ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" #================================================= # RELOAD NGINX From 17cbca8319ab7d540f2adf9586f0d168a730e7f5 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Mon, 7 Mar 2022 21:16:01 +0100 Subject: [PATCH 2/3] Fix upgrade --- scripts/install | 1 + scripts/upgrade | 7 ++++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/scripts/install b/scripts/install index 3b04635..61ad5ec 100644 --- a/scripts/install +++ b/scripts/install @@ -108,6 +108,7 @@ ynh_script_progression --message="Installing TimeOff..." pushd $final_path ynh_use_nodejs ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install 2>/dev/null + ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm cache clean 2>/dev/null popd #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index fc3629f..094c020 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -78,7 +78,7 @@ then ynh_script_progression --message="Upgrading source files..." # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path" --keep="$final_path/db.production.sqlite $final_path/config/app.json $final_path/config/db.json" + ynh_setup_source --dest_dir="$final_path" --keep="db.production.sqlite config/app.json config/db.json" fi chmod 750 "$final_path" @@ -112,9 +112,10 @@ if [ "$upgrade_type" == "UPGRADE_APP" ] then ynh_script_progression --message="Upgrading TimeOff..." pushd $final_path - #ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm cache clean 2>/dev/null + ynh_use_nodejs ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install 2>/dev/null - ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm run-script db-update + ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm cache clean 2>/dev/null + ynh_exec_as $app env $ynh_node_load_PATH NODE_ENV=production $ynh_npm run-script db-update popd fi From ddf075796c6f869ac47d5e3c5f6e8d3d85a732d7 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Tue, 8 Mar 2022 20:27:03 +0100 Subject: [PATCH 3/3] fix cache clean --- scripts/install | 4 ++-- scripts/upgrade | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/install b/scripts/install index 61ad5ec..b8f437d 100644 --- a/scripts/install +++ b/scripts/install @@ -107,8 +107,8 @@ ynh_script_progression --message="Installing TimeOff..." pushd $final_path ynh_use_nodejs - ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install 2>/dev/null - ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm cache clean 2>/dev/null + ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install 2>/dev/null + #ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm cache clean 2>/dev/null popd #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 094c020..705d747 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -114,7 +114,7 @@ then pushd $final_path ynh_use_nodejs ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install 2>/dev/null - ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm cache clean 2>/dev/null + #ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm cache clean 2>/dev/null ynh_exec_as $app env $ynh_node_load_PATH NODE_ENV=production $ynh_npm run-script db-update popd fi