Merge pull request #13 from YunoHost-Apps/testing

Testing

README.md

@@ -19,12 +19,11 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
 A beautiful web dashboard for GNU/Linux which display CPU, RAM, memory, network and other usage.
 
 
-**Shipped version:** 2.0~ynh3
+**Shipped version:** 2.0~ynh4
 
 **Demo:** https://afaqurk.github.io/linux-dash/
 ## Documentation and resources
 
-* Official app website: <https://github.com/afaqurk/linux-dash>
 * Official admin documentation: <https://github.com/afaqurk/linux-dash/wiki>
 * Upstream app code repository: <https://github.com/afaqurk/linux-dash>
 * YunoHost Store: <https://apps.yunohost.org/app/linuxdash>

README_fr.md

@@ -19,12 +19,11 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
 A beautiful web dashboard for GNU/Linux which display CPU, RAM, memory, network and other usage.
 
 
-**Version incluse :** 2.0~ynh3
+**Version incluse :** 2.0~ynh4
 
 **Démo :** https://afaqurk.github.io/linux-dash/
 ## Documentations et ressources
 
-* Site officiel de l’app : <https://github.com/afaqurk/linux-dash>
 * Documentation officielle de l’admin : <https://github.com/afaqurk/linux-dash/wiki>
 * Dépôt de code officiel de l’app : <https://github.com/afaqurk/linux-dash>
 * YunoHost Store: <https://apps.yunohost.org/app/linuxdash>

check_process

@@ -1,22 +0,0 @@
-;; Test complet
-	; Manifest
-		domain="domain.tld"
-		path="/path"
-		admin="john"
-	; Checks
-		pkg_linter=1
-		setup_sub_dir=1
-		setup_root=1
-		setup_nourl=0
-		setup_private=0
-		setup_public=0
-		upgrade=1
-		# 2.0~ynh2
-		upgrade=1	from_commit=1319c98657f9b743cd345185aafc51c7a7da342f
-		backup_restore=1
-		multi_instance=1
-		port_already_use=0
-		change_url=1
-;;; Options
-Email=
-Notification=none

conf/app.src

@@ -1,7 +0,0 @@
-SOURCE_URL=https://codeload.github.com/afaqurk/linux-dash/tar.gz/186a802ea76e8bfcab7e8e7ebc533b74f80306fc
-SOURCE_SUM=506ae346f69b2002d4e3494d6aaa92104dbc8e50c8740acb2c49bc592a5939ce
-SOURCE_SUM_PRG=sha256sum
-SOURCE_FORMAT=tar.gz
-SOURCE_IN_SUBDIR=true
-SOURCE_FILENAME=
-SOURCE_EXTRACT=true

conf/nginx.conf

@@ -1,7 +1,7 @@
 #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
 location __PATH__/ {
 
-  proxy_pass             http://localhost:__PORT__/;
+  proxy_pass        http://127.0.0.1:__PORT__/;
   proxy_redirect    off;
   proxy_hide_header Content-Type;
 

conf/supervisor.service

@@ -1,5 +1,5 @@
 [program:__APP__]
-directory=__FINALPATH__/app/server/
+directory=__INSTALL_DIR__/app/server/
 command=__YNH_NODE__ index.js --port __PORT__
 autostart=true
 autorestart=true

manifest.json

@@ -1,54 +0,0 @@
-{
-    "name": "Linux-Dash",
-    "id": "linuxdash",
-    "packaging_format": 1,
-    "description": {
-        "en": "A drop-in, low-overhead monitoring web dashboard for GNU/linux machine.",
-        "fr": "Tableau de bord léger pour le monitoring d’un serveur GNU/linux."
-    },
-    "version": "2.0~ynh3",
-    "url": "https://github.com/afaqurk/linux-dash",
-    "upstream": {
-        "license": "MIT",
-        "website": "https://github.com/afaqurk/linux-dash",
-        "demo": "https://afaqurk.github.io/linux-dash/",
-        "admindoc": "https://github.com/afaqurk/linux-dash/wiki",
-        "code": "https://github.com/afaqurk/linux-dash"
-    },
-    "license": "MIT",
-    "maintainer": {
-        "name": "Moul",
-        "email": "moul@moul.re",
-        "url": "https://moul.re"
-    },
-    "requirements": {
-        "yunohost": ">= 4.3.0"
-    },
-    "multi_instance": true,
-    "services": [
-        "nginx"
-    ],
-    "arguments": {
-        "install": [
-            {
-                "name": "domain",
-                "type": "domain"
-            },
-            {
-                "name": "path",
-                "type": "path",
-                "example": "/dash",
-                "default": "/dash"
-            },
-            {
-                "name": "admin",
-                "type": "user",
-                "ask": {
-                    "en": "Choose the YunoHost user which have access to Linux-Dash",
-                    "fr": "Choisissez l’utilisateur YunoHost qui a accès à Linux-Dash"
-                },
-                "example": "john"
-            }
-        ]
-    }
-}

manifest.toml

@@ -0,0 +1,56 @@
+packaging_format = 2
+
+id = "linuxdash"
+name = "Linux-Dash"
+description.en = "Monitoring web dashboard for GNU/linux machine"
+description.fr = "Tableau de bord léger pour le monitoring d’un serveur GNU/linux"
+
+version = "2.0~ynh4"
+
+maintainers = ["Moul"]
+
+[upstream]
+license = "MIT"
+demo = "https://afaqurk.github.io/linux-dash/"
+admindoc = "https://github.com/afaqurk/linux-dash/wiki"
+code = "https://github.com/afaqurk/linux-dash"
+
+[integration]
+yunohost = ">= 11.1.20"
+architectures = "all"
+multi_instance = true
+ldap = false
+sso = false
+disk = "50M"
+ram.build = "50M"
+ram.runtime = "50M"
+
+[install]
+    [install.domain]
+    type = "domain"
+
+    [install.path]
+    type = "path"
+    default = "/dash"
+
+    [install.admin]
+    type = "user"
+
+[resources]
+        [resources.sources.main]
+        url = "https://github.com/tariqbuilds/linux-dash/archive/186a802ea76e8bfcab7e8e7ebc533b74f80306fc.tar.gz"
+        sha256 = "506ae346f69b2002d4e3494d6aaa92104dbc8e50c8740acb2c49bc592a5939ce"
+        autoupdate.upstream = "https://github.com/tariqbuilds/linux-dash"
+        autoupdate.strategy = "latest_github_commit"
+
+    [resources.ports]
+
+    [resources.system_user]
+
+    [resources.install_dir]
+
+    [resources.permissions]
+    main.url = "/"
+
+    [resources.apt]
+    packages = "supervisor"

scripts/_common.sh

@@ -4,9 +4,7 @@
 # COMMON VARIABLES
 #=================================================
 
-# dependencies used by the app
+nodejs_version=18
-pkg_dependencies="supervisor"
-nodejs_version=12
 
 #=================================================
 # PERSONAL HELPERS
@@ -19,3 +17,171 @@ nodejs_version=12
 #=================================================
 # FUTURE OFFICIAL HELPERS
 #=================================================
+
+
+# Create a dedicated supervisor config
+#
+# usage: ynh_add_supervisor_config [--service=service] [--template=template]
+# | arg: -s, --service=     - Service name (optionnal, `$app` by default)
+# | arg: -t, --template=    - Name of template file (optionnal, this is 'supervisor' by default, meaning ./conf/supervisor.service will be used as template)
+#
+# This will use the template `../conf/<templatename>.service`.
+#
+# See the documentation of `ynh_add_config` for a description of the template
+# format and how placeholders are replaced with actual variables.
+#
+# Requires YunoHost version 2.7.11 or higher.
+ynh_add_supervisor_config () {
+    # Declare an array to define the options of this helper.
+    local legacy_args=stv
+    local -A args_array=( [s]=service= [t]=template= [v]=others_var=)
+    local service
+    local template
+    local others_var
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    local service="${service:-$app}"
+    local template="${template:-supervisor.service}"
+    others_var="${others_var:-}"
+
+    [[ -z "$others_var" ]] || ynh_print_warn --message="Packagers: using  others var is unecessary since Yunohost 4.2"
+
+    ynh_add_config --template="$YNH_APP_BASEDIR/conf/$template" --destination="/etc/supervisor/conf.d/$service.conf"
+
+    supervisorctl reread
+    supervisorctl update
+}
+
+# Remove the dedicated supervisor config
+#
+# usage: ynh_remove_supervisor_config [--service=service]
+# | arg: -s, --service=     - Service name (optionnal, $app by default)
+#
+# Requires YunoHost version 2.7.2 or higher.
+ynh_remove_supervisor_config () {
+    # Declare an array to define the options of this helper.
+    local legacy_args=s
+    local -A args_array=( [s]=service= )
+    local service
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    local service="${service:-$app}"
+
+    local finalsupervisorconf="/etc/supervisor/conf.d/$service.conf"
+    if [ -e "$finalsupervisorconf" ]
+    then
+        ynh_supervisor_action --service_name=$service --action=stop
+        ynh_secure_remove --file="$finalsupervisorconf"
+        supervisorctl reread
+        supervisorctl update
+    fi
+}
+
+# Start (or other actions) a service,  print a log in case of failure and optionnaly wait until the service is completely started
+#
+# usage: ynh_supervisor_action [--service_name=service_name] [--action=action] [ [--line_match="line to match"] [--log_path=log_path] [--timeout=300] [--length=20] ]
+# | arg: -n, --service_name= - Name of the service to start. Default : `$app`
+# | arg: -a, --action=       - Action to perform with supervisorctl. Default: start
+# | arg: -l, --line_match=   - Line to match - The line to find in the log to attest the service have finished to boot. If not defined it don't wait until the service is completely started.
+# | arg: -p, --log_path=     - Log file - Path to the log file. Default : `/var/log/$app/$app.log`
+# | arg: -t, --timeout=      - Timeout - The maximum time to wait before ending the watching. Default : 300 seconds.
+# | arg: -e, --length=       - Length of the error log : Default : 20
+#
+# Requires YunoHost version 3.5.0 or higher.
+ynh_supervisor_action() {
+    # Declare an array to define the options of this helper.
+    local legacy_args=nalpte
+    declare -Ar args_array=( [n]=service_name= [a]=action= [l]=line_match= [p]=log_path= [t]=timeout= [e]=length= )
+    local service_name
+    local action
+    local line_match
+    local length
+    local log_path
+    local timeout
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    service_name="${service_name:-$app}"
+    action=${action:-start}
+    line_match=${line_match:-}
+    length=${length:-20}
+    log_path="${log_path:-/var/log/$service_name/$service_name.log}"
+    timeout=${timeout:-300}
+
+    # Start to read the log
+    if [[ -n "$line_match" ]]
+    then
+        local templog="$(mktemp)"
+        # Following the starting of the app in its log
+        if [ "$log_path" == "systemd" ]
+        then
+            # Read the supervisor journal
+            journalctl --unit=supervisor --follow --since=-0 --quiet > "$templog" &
+            # Get the PID of the journalctl command
+            local pid_tail=$!
+        else
+            # Read the specified log file
+            tail --follow=name --retry --lines=0 "$log_path" > "$templog" 2>&1 &
+            # Get the PID of the tail command
+            local pid_tail=$!
+        fi
+    fi
+
+    # Use reload-or-restart instead of reload. So it wouldn't fail if the service isn't running.
+    if [ "$action" == "reload" ]; then
+        action="update"
+    fi
+
+    # If the service fails to perform the action
+    if ! supervisorctl $action $service_name
+    then
+        # Show syslog for this service
+        ynh_exec_err journalctl --quiet --no-hostname --no-pager --lines=$length --unit=$service_name
+        # If a log is specified for this service, show also the content of this log
+        if [ -e "$log_path" ]
+        then
+            ynh_exec_err tail --lines=$length "$log_path"
+        fi
+        ynh_clean_check_starting
+        return 1
+    fi
+
+    # Start the timeout and try to find line_match
+    if [[ -n "${line_match:-}" ]]
+    then
+        set +x
+        local i=0
+        for i in $(seq 1 $timeout)
+        do
+            # Read the log until the sentence is found, that means the app finished to start. Or run until the timeout
+            if grep --extended-regexp --quiet "$line_match" "$templog"
+            then
+                ynh_print_info --message="The service $service_name has correctly executed the action ${action}."
+                break
+            fi
+            if [ $i -eq 3 ]; then
+                echo -n "Please wait, the service $service_name is ${action}ing" >&2
+            fi
+            if [ $i -ge 3 ]; then
+                echo -n "." >&2
+            fi
+            sleep 1
+        done
+        set -x
+        if [ $i -ge 3 ]; then
+            echo "" >&2
+        fi
+        if [ $i -eq $timeout ]
+        then
+            ynh_print_warn --message="The service $service_name didn't fully executed the action ${action} before the timeout."
+            ynh_print_warn --message="Please find here an extract of the end of the log of the service $service_name:"
+            ynh_exec_warn journalctl --quiet --no-hostname --no-pager --lines=$length --unit=$service_name
+            if [ -e "$log_path" ]
+            then
+                ynh_print_warn --message="\-\-\-"
+                ynh_exec_warn tail --lines=$length "$log_path"
+            fi
+        fi
+        ynh_clean_check_starting
+    fi
+}
+

scripts/backup

@@ -10,23 +10,6 @@
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers
 
-#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
-
-#=================================================
-# LOAD SETTINGS
-#=================================================
-ynh_print_info --message="Loading installation settings..."
-
-app=$YNH_APP_INSTANCE_NAME
-
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-domain=$(ynh_app_setting_get --app=$app --key=domain)
-
 #=================================================
 # DECLARE DATA AND CONF FILES TO BACKUP
 #=================================================
@@ -36,7 +19,7 @@ ynh_print_info --message="Declaring files to be backed up..."
 # BACKUP THE APP MAIN DIR
 #=================================================
 
-ynh_backup --src_path="$final_path"
+ynh_backup --src_path="$install_dir"
 
 #=================================================
 # BACKUP THE NGINX CONFIGURATION

scripts/change_url

@@ -9,102 +9,30 @@
 source _common.sh
 source /usr/share/yunohost/helpers
 
-#=================================================
-# RETRIEVE ARGUMENTS
-#=================================================
-
-old_domain=$YNH_APP_OLD_DOMAIN
-old_path=$YNH_APP_OLD_PATH
-
-new_domain=$YNH_APP_NEW_DOMAIN
-new_path=$YNH_APP_NEW_PATH
-
-app=$YNH_APP_INSTANCE_NAME
-
-#=================================================
-# LOAD SETTINGS
-#=================================================
-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)
-
-# Add settings here as needed by your application
-port=$(ynh_app_setting_get --app=$app --key=port)
-
-#=================================================
-# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP
-#=================================================
-ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..."
-
-# 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"
-
-	# Restore it if the upgrade fails
-	ynh_restore_upgradebackup
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
-
-#=================================================
-# CHECK WHICH PARTS SHOULD BE CHANGED
-#=================================================
-
-change_domain=0
-if [ "$old_domain" != "$new_domain" ]
-then
-	change_domain=1
-fi
-
-change_path=0
-if [ "$old_path" != "$new_path" ]
-then
-	change_path=1
-fi
-
 #=================================================
 # STANDARD MODIFICATIONS
+#=================================================
+# STOP SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Stopping a systemd service..." --weight=1
+
+ynh_supervisor_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log"
+
 #=================================================
 # MODIFY URL IN NGINX CONF
 #=================================================
-ynh_script_progression --message="Updating NGINX web server configuration..."
+ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1
 
-nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
+ynh_change_url_nginx_config
-
-# Change the path in the NGINX config file
-if [ $change_path -eq 1 ]
-then
-	# Make a backup of the original NGINX config file if modified
-	ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
-	# Set global variables for NGINX helper
-	domain="$old_domain"
-	path_url="$new_path"
-	# Create a dedicated NGINX config
-	ynh_add_nginx_config
-fi
-
-# Change the domain for NGINX
-if [ $change_domain -eq 1 ]
-then
-	# Delete file checksum for the old conf file location
-	ynh_delete_file_checksum --file="$nginx_conf_path"
-	mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
-	# Store file checksum for the new config file location
-	ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
-fi
 
 #=================================================
 # GENERIC FINALISATION
 #=================================================
-# RELOAD NGINX
+# START SYSTEMD SERVICE
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..."
+ynh_script_progression --message="Starting a systemd service..." --weight=1
 
-ynh_systemd_action --service_name=nginx --action=reload
+ynh_supervisor_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
 
 #=================================================
 # END OF SCRIPT

scripts/install

@@ -7,88 +7,25 @@
 #=================================================
 
 source _common.sh
-source ynh_supervisor
 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
-
-#=================================================
-# RETRIEVE ARGUMENTS FROM THE MANIFEST
-#=================================================
-
-domain=$YNH_APP_ARG_DOMAIN
-path_url=$YNH_APP_ARG_PATH
-admin=$YNH_APP_ARG_ADMIN
-
-app=$YNH_APP_INSTANCE_NAME
-
-#=================================================
-# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
-#=================================================
-ynh_script_progression --message="Validating installation parameters..."
-
-final_path=/var/www/$app
-test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
-
-# Register (book) web path
-ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
-
-#=================================================
-# STORE SETTINGS FROM MANIFEST
-#=================================================
-ynh_script_progression --message="Storing installation settings..."
-
-ynh_app_setting_set --app=$app --key=domain --value=$domain
-ynh_app_setting_set --app=$app --key=path --value=$path_url
-ynh_app_setting_set --app=$app --key=admin --value=$admin
-
-#=================================================
-# STANDARD MODIFICATIONS
-#=================================================
-# FIND AND OPEN A PORT
-#=================================================
-ynh_script_progression --message="Finding an available port..."
-
-# Find an available port
-port=$(ynh_find_port --port=8095)
-ynh_app_setting_set --app=$app --key=port --value=$port
-
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
 ynh_script_progression --message="Installing dependencies..."
 
-ynh_install_app_dependencies $pkg_dependencies
 ynh_install_nodejs --nodejs_version=$nodejs_version
 
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Configuring system user..."
-
-# Create a system user
-ynh_system_user_create --username=$app --home_dir="$final_path"
-
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
 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="$install_dir"
 
-chmod 750 "$final_path"
+chmod -R o-rwx "$install_dir"
-chmod -R o-rwx "$final_path"
+chown -R $app:www-data "$install_dir"
-chown -R $app:www-data "$final_path"
 
 #=================================================
 # NGINX CONFIGURATION
@@ -105,16 +42,17 @@ ynh_add_nginx_config
 #=================================================
 ynh_script_progression --message="Remobing Google..."
 
-sed --in-place "/googlecode\|googleapis/d" "$final_path/index.html"
+sed --in-place "/googlecode\|googleapis/d" "$install_dir/index.html"
 
 #=================================================
 # BUILD APP
 #=================================================
 ynh_script_progression --message="Building app..."
 
-pushd "$final_path"
+pushd "$install_dir"
 	ynh_use_nodejs
-	ynh_npm install --production
+	#ynh_exec_warn_less ynh_npm install --production
+	ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --production
 popd
 
 #=================================================
@@ -132,7 +70,7 @@ ynh_add_supervisor_config
 #=================================================
 ynh_script_progression --message="Integrating service in YunoHost..."
 
-yunohost service add $app --log="/var/log/$app/$app.log"
+yunohost service add $app --description="Monitoring web dashboard" --log="/var/log/$app/$app.log"
 
 #=================================================
 # START SYSTEMD SERVICE
@@ -142,21 +80,6 @@ ynh_script_progression --message="Starting a systemd service..."
 # Start a systemd service
 ynh_supervisor_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
 
-#=================================================
-# SETUP SSOWAT
-#=================================================
-ynh_script_progression --message="Configuring permissions..."
-
-# Only the admin can access the admin panel of the app (if the app has an admin panel)
-ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin
-
-#=================================================
-# RELOAD NGINX
-#=================================================
-ynh_script_progression --message="Reloading NGINX web server..."
-
-ynh_systemd_action --service_name=nginx --action=reload
-
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/remove

@@ -7,20 +7,8 @@
 #=================================================
 
 source _common.sh
-source ynh_supervisor
 source /usr/share/yunohost/helpers
 
-#=================================================
-# LOAD SETTINGS
-#=================================================
-ynh_script_progression --message="Loading installation settings..."
-
-app=$YNH_APP_INSTANCE_NAME
-
-domain=$(ynh_app_setting_get --app=$app --key=domain)
-port=$(ynh_app_setting_get --app=$app --key=port)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-
 #=================================================
 # STANDARD REMOVE
 #=================================================
@@ -42,14 +30,6 @@ ynh_script_progression --message="Stopping and removing the systemd service..."
 # Remove the dedicated systemd config
 ynh_remove_supervisor_config
 
-#=================================================
-# REMOVE APP MAIN DIR
-#=================================================
-ynh_script_progression --message="Removing app main directory..."
-
-# Remove the app directory securely
-ynh_secure_remove --file="$final_path"
-
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
@@ -65,17 +45,6 @@ ynh_script_progression --message="Removing dependencies..."
 
 # Remove metapackage and its dependencies
 ynh_remove_nodejs
-ynh_remove_app_dependencies
-
-#=================================================
-# GENERIC FINALIZATION
-#=================================================
-# REMOVE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Removing the dedicated system user..."
-
-# Delete a system user
-ynh_system_user_delete --username=$app
 
 #=================================================
 # END OF SCRIPT

scripts/restore

@@ -8,65 +8,17 @@
 
 # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
 source ../settings/scripts/_common.sh
-source ../settings/scripts/ynh_supervisor
 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 installation settings..."
-
-app=$YNH_APP_INSTANCE_NAME
-
-domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get --app=$app --key=path)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-
-#=================================================
-# CHECK IF THE APP CAN BE RESTORED
-#=================================================
-ynh_script_progression --message="Validating restoration parameters..."
-
-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 web server configuration..."
-
-ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
-
-#=================================================
-# RECREATE THE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Recreating the dedicated system user..."
-
-# 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 the app main directory..."
 
-ynh_restore_file --origin_path="$final_path"
+ynh_restore_file --origin_path="$install_dir"
 
-chmod 750 "$final_path"
+chmod -R o-rwx "$install_dir"
-chmod -R o-rwx "$final_path"
+chown -R $app:www-data "$install_dir"
-chown -R $app:www-data "$final_path"
 
 #=================================================
 # SPECIFIC RESTORATION
@@ -76,9 +28,15 @@ chown -R $app:www-data "$final_path"
 ynh_script_progression --message="Reinstalling dependencies..."
 
 # Define and install dependencies
-ynh_install_app_dependencies $pkg_dependencies
 ynh_install_nodejs --nodejs_version=$nodejs_version
 
+#=================================================
+# RESTORE 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"
+
 #=================================================
 # RESTORE SYSTEMD
 #=================================================
@@ -93,14 +51,14 @@ supervisorctl update
 #=================================================
 ynh_script_progression --message="Integrating service in YunoHost..."
 
-yunohost service add $app --log="/var/log/$app/$app.log"
+yunohost service add $app --description="Monitoring web dashboard" --log="/var/log/$app/$app.log"
 
 #=================================================
 # START SYSTEMD SERVICE
 #=================================================
 ynh_script_progression --message="Starting a systemd service..."
 
-ynh_supervisor_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+ynh_supervisor_action --service_name=$app --action="start" --log_path="systemd"
 
 #=================================================
 # GENERIC FINALIZATION

scripts/upgrade

@@ -7,44 +7,14 @@
 #=================================================
 
 source _common.sh
-source ynh_supervisor
 source /usr/share/yunohost/helpers
 
-#=================================================
-# LOAD SETTINGS
-#=================================================
-ynh_script_progression --message="Loading installation settings..."
-
-app=$YNH_APP_INSTANCE_NAME
-
-domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get --app=$app --key=path)
-admin=$(ynh_app_setting_get --app=$app --key=admin)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-port=$(ynh_app_setting_get --app=$app --key=port)
-
 #=================================================
 # CHECK VERSION
 #=================================================
-ynh_script_progression --message="Checking version..."
 
 upgrade_type=$(ynh_check_app_version_changed)
 
-#=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
-#=================================================
-ynh_script_progression --message="Backing up the app before upgrading (may take a while)..."
-
-# Backup the current version of the app
-ynh_backup_before_upgrade
-ynh_clean_setup () {
-	ynh_clean_check_starting
-	# 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
 #=================================================
@@ -52,19 +22,7 @@ ynh_abort_if_errors
 #=================================================
 ynh_script_progression --message="Stopping a systemd service..."
 
-ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log"
+ynh_supervisor_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log"
-
-#=================================================
-# ENSURE DOWNWARD COMPATIBILITY
-#=================================================
-ynh_script_progression --message="Ensuring downward compatibility..."
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..."
-
-# Create a dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir="$final_path"
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@@ -75,12 +33,11 @@ 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"
+	ynh_setup_source --dest_dir="$install_dir"
 fi
 
-chmod 750 "$final_path"
+chmod -R o-rwx "$install_dir"
-chmod -R o-rwx "$final_path"
+chown -R $app:www-data "$install_dir"
-chown -R $app:www-data "$final_path"
 
 #=================================================
 # NGINX CONFIGURATION
@@ -95,7 +52,6 @@ ynh_add_nginx_config
 #=================================================
 ynh_script_progression --message="Upgrading dependencies..."
 
-ynh_install_app_dependencies $pkg_dependencies
 ynh_install_nodejs --nodejs_version=$nodejs_version
 
 #=================================================
@@ -104,16 +60,16 @@ ynh_install_nodejs --nodejs_version=$nodejs_version
 # REMOVE GOOGLE !!!
 #=================================================
 
-sed --in-place "/googlecode\|googleapis/d" "$final_path/index.html"
+sed --in-place "/googlecode\|googleapis/d" "$install_dir/index.html"
 
 #=================================================
 # BUILD APP
 #=================================================
 ynh_script_progression --message="Building app..."
 
-pushd "$final_path"
+pushd "$install_dir"
 	ynh_use_nodejs
-	ynh_npm install --production
+	ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --production
 popd
 
 #=================================================
@@ -131,7 +87,7 @@ ynh_add_supervisor_config
 #=================================================
 ynh_script_progression --message="Integrating service in YunoHost..."
 
-yunohost service add $app --log="/var/log/$app/$app.log"
+yunohost service add $app --description="Monitoring web dashboard" --log="/var/log/$app/$app.log"
 
 #=================================================
 # START SYSTEMD SERVICE
@@ -140,13 +96,6 @@ ynh_script_progression --message="Starting a systemd service..."
 
 ynh_supervisor_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
 
-#=================================================
-# RELOAD NGINX
-#=================================================
-ynh_script_progression --message="Reloading NGINX web server..."
-
-ynh_systemd_action --service_name=nginx --action=reload
-
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/ynh_supervisor

@@ -1,167 +0,0 @@
-#!/bin/bash
-
-# Create a dedicated supervisor config
-#
-# usage: ynh_add_supervisor_config [--service=service] [--template=template]
-# | arg: -s, --service=     - Service name (optionnal, `$app` by default)
-# | arg: -t, --template=    - Name of template file (optionnal, this is 'supervisor' by default, meaning ./conf/supervisor.service will be used as template)
-#
-# This will use the template `../conf/<templatename>.service`.
-#
-# See the documentation of `ynh_add_config` for a description of the template
-# format and how placeholders are replaced with actual variables.
-#
-# Requires YunoHost version 2.7.11 or higher.
-ynh_add_supervisor_config () {
-    # Declare an array to define the options of this helper.
-    local legacy_args=stv
-    local -A args_array=( [s]=service= [t]=template= [v]=others_var=)
-    local service
-    local template
-    local others_var
-    # Manage arguments with getopts
-    ynh_handle_getopts_args "$@"
-    local service="${service:-$app}"
-    local template="${template:-supervisor.service}"
-    others_var="${others_var:-}"
-
-    [[ -z "$others_var" ]] || ynh_print_warn --message="Packagers: using --others_var is unecessary since Yunohost 4.2"
-
-    ynh_add_config --template="$YNH_APP_BASEDIR/conf/$template" --destination="/etc/supervisor/conf.d/$service.conf"
-
-    supervisorctl reread
-    supervisorctl update
-}
-
-# Remove the dedicated supervisor config
-#
-# usage: ynh_remove_supervisor_config [--service=service]
-# | arg: -s, --service=     - Service name (optionnal, $app by default)
-#
-# Requires YunoHost version 2.7.2 or higher.
-ynh_remove_supervisor_config () {
-    # Declare an array to define the options of this helper.
-    local legacy_args=s
-    local -A args_array=( [s]=service= )
-    local service
-    # Manage arguments with getopts
-    ynh_handle_getopts_args "$@"
-    local service="${service:-$app}"
-
-    local finalsupervisorconf="/etc/supervisor/conf.d/$service.conf"
-    if [ -e "$finalsupervisorconf" ]
-    then
-        ynh_supervisor_action --service_name=$service --action=stop
-        ynh_secure_remove --file="$finalsupervisorconf"
-        supervisorctl reread
-        supervisorctl update
-    fi
-}
-
-# Start (or other actions) a service,  print a log in case of failure and optionnaly wait until the service is completely started
-#
-# usage: ynh_supervisor_action [--service_name=service_name] [--action=action] [ [--line_match="line to match"] [--log_path=log_path] [--timeout=300] [--length=20] ]
-# | arg: -n, --service_name= - Name of the service to start. Default : `$app`
-# | arg: -a, --action=       - Action to perform with supervisorctl. Default: start
-# | arg: -l, --line_match=   - Line to match - The line to find in the log to attest the service have finished to boot. If not defined it don't wait until the service is completely started.
-# | arg: -p, --log_path=     - Log file - Path to the log file. Default : `/var/log/$app/$app.log`
-# | arg: -t, --timeout=      - Timeout - The maximum time to wait before ending the watching. Default : 300 seconds.
-# | arg: -e, --length=       - Length of the error log : Default : 20
-#
-# Requires YunoHost version 3.5.0 or higher.
-ynh_supervisor_action() {
-    # Declare an array to define the options of this helper.
-    local legacy_args=nalpte
-    declare -Ar args_array=( [n]=service_name= [a]=action= [l]=line_match= [p]=log_path= [t]=timeout= [e]=length= )
-    local service_name
-    local action
-    local line_match
-    local length
-    local log_path
-    local timeout
-    # Manage arguments with getopts
-    ynh_handle_getopts_args "$@"
-    service_name="${service_name:-$app}"
-    action=${action:-start}
-    line_match=${line_match:-}
-    length=${length:-20}
-    log_path="${log_path:-/var/log/$service_name/$service_name.log}"
-    timeout=${timeout:-300}
-
-    # Start to read the log
-    if [[ -n "$line_match" ]]
-    then
-        local templog="$(mktemp)"
-        # Following the starting of the app in its log
-        if [ "$log_path" == "systemd" ]
-        then
-            # Read the supervisor journal
-            journalctl --unit=supervisor --follow --since=-0 --quiet > "$templog" &
-            # Get the PID of the journalctl command
-            local pid_tail=$!
-        else
-            # Read the specified log file
-            tail --follow=name --retry --lines=0 "$log_path" > "$templog" 2>&1 &
-            # Get the PID of the tail command
-            local pid_tail=$!
-        fi
-    fi
-
-    # Use reload-or-restart instead of reload. So it wouldn't fail if the service isn't running.
-    if [ "$action" == "reload" ]; then
-        action="update"
-    fi
-
-    # If the service fails to perform the action
-    if ! supervisorctl $action $service_name
-    then
-        # Show syslog for this service
-        ynh_exec_err journalctl --quiet --no-hostname --no-pager --lines=$length --unit=$service_name
-        # If a log is specified for this service, show also the content of this log
-        if [ -e "$log_path" ]
-        then
-            ynh_exec_err tail --lines=$length "$log_path"
-        fi
-        ynh_clean_check_starting
-        return 1
-    fi
-
-    # Start the timeout and try to find line_match
-    if [[ -n "${line_match:-}" ]]
-    then
-        set +x
-        local i=0
-        for i in $(seq 1 $timeout)
-        do
-            # Read the log until the sentence is found, that means the app finished to start. Or run until the timeout
-            if grep --extended-regexp --quiet "$line_match" "$templog"
-            then
-                ynh_print_info --message="The service $service_name has correctly executed the action ${action}."
-                break
-            fi
-            if [ $i -eq 3 ]; then
-                echo -n "Please wait, the service $service_name is ${action}ing" >&2
-            fi
-            if [ $i -ge 3 ]; then
-                echo -n "." >&2
-            fi
-            sleep 1
-        done
-        set -x
-        if [ $i -ge 3 ]; then
-            echo "" >&2
-        fi
-        if [ $i -eq $timeout ]
-        then
-            ynh_print_warn --message="The service $service_name didn't fully executed the action ${action} before the timeout."
-            ynh_print_warn --message="Please find here an extract of the end of the log of the service $service_name:"
-            ynh_exec_warn journalctl --quiet --no-hostname --no-pager --lines=$length --unit=$service_name
-            if [ -e "$log_path" ]
-            then
-                ynh_print_warn --message="\-\-\-"
-                ynh_exec_warn tail --lines=$length "$log_path"
-            fi
-        fi
-        ynh_clean_check_starting
-    fi
-}

tests.toml

@@ -0,0 +1,9 @@
+test_format = 1.0
+
+[default]
+
+    # -------------------------------
+    # Commits to test upgrade from
+    # -------------------------------
+
+    test_upgrade_from.1319c98657f9b743cd345185aafc51c7a7da342f.name = "Upgrade from 2.0~ynh2"