Merge pull request #1 from YunoHost-Apps/testing

Testing

README.md

@@ -16,7 +16,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
 
 ## Overview
 
-This is a dummy description of this app features
+Group calls with WebRTC that leverage Matrix and an open-source WebRTC toolkit from LiveKit.
 
 
 **Shipped version:** 0.5.9~ynh1
@@ -25,12 +25,11 @@ This is a dummy description of this app features
 
 ## Screenshots
 
-![Screenshot of Element-Call](./doc/screenshots/example.jpg)
+![Screenshot of Element-Call](./doc/screenshots/screenshot.jpg)
 
 ## Documentation and resources
 
 * Official app website: <https://call.element.io/>
-* Official admin documentation: <https://yunohost.org/packaging_apps>
 * Upstream app code repository: <https://github.com/vector-im/element-call>
 * Report a bug: <https://github.com/YunoHost-Apps/element-call_ynh/issues>
 

README_fr.md

@@ -16,8 +16,7 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
 
 ## Vue d’ensemble
 
-Ceci est une fausse description des fonctionalités de l'app
+Appels de groupe avec WebRTC qui exploitent Matrix et une boîte à outils WebRTC open source de LiveKit.
-
 
 **Version incluse :** 0.5.9~ynh1
 
@@ -25,12 +24,11 @@ Ceci est une fausse description des fonctionalités de l'app
 
 ## Captures d’écran
 
-![Capture d’écran de Element-Call](./doc/screenshots/example.jpg)
+![Capture d’écran de Element-Call](./doc/screenshots/screenshot.jpg)
 
 ## Documentations et ressources
 
 * Site officiel de l’app : <https://call.element.io/>
-* Documentation officielle de l’admin : <https://yunohost.org/packaging_apps>
 * Dépôt de code officiel de l’app : <https://github.com/vector-im/element-call>
 * Signaler un bug : <https://github.com/YunoHost-Apps/element-call_ynh/issues>
 

conf/systemd.service

@@ -1,49 +0,0 @@
-[Unit]
-Description=Small description of the service
-After=network.target
-
-[Service]
-Type=simple
-User=__APP__
-Group=__APP__
-WorkingDirectory=__INSTALL_DIR__/
-ExecStart=__INSTALL_DIR__/script
-StandardOutput=append:/var/log/__APP__/__APP__.log
-StandardError=inherit
-
-# Sandboxing options to harden security
-# Depending on specificities of your service/app, you may need to tweak these
-# .. but this should be a good baseline
-# Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html
-NoNewPrivileges=yes
-PrivateTmp=yes
-PrivateDevices=yes
-RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_NETLINK
-RestrictNamespaces=yes
-RestrictRealtime=yes
-DevicePolicy=closed
-ProtectClock=yes
-ProtectHostname=yes
-ProtectProc=invisible
-ProtectSystem=full
-ProtectControlGroups=yes
-ProtectKernelModules=yes
-ProtectKernelTunables=yes
-LockPersonality=yes
-SystemCallArchitectures=native
-SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap @cpu-emulation @privileged
-
-# Denying access to capabilities that should not be relevant for webapps
-# Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html
-CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD
-CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE
-CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT
-CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK
-CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM
-CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG
-CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE
-CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW
-CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG
-
-[Install]
-WantedBy=multi-user.target

doc/ADMIN.md

@@ -1,3 +0,0 @@
-This is a dummy admin doc for this app
-
-The app install dir is `__INSTALL_DIR__`

doc/ADMIN_fr.md

@@ -1,3 +0,0 @@
-Ceci est une fausse doc d'admin pour cette app
-
-Le dossier d'install de l'app est `__INSTALL_DIR__`

doc/DESCRIPTION.md

@@ -1 +1 @@
-This is a dummy description of this app features
+Group calls with WebRTC that leverage Matrix and an open-source WebRTC toolkit from LiveKit.

doc/DESCRIPTION_fr.md

@@ -1 +1 @@
-Ceci est une fausse description des fonctionalités de l'app
+Appels de groupe avec WebRTC qui exploitent Matrix et une boîte à outils WebRTC open source de LiveKit.

manifest.toml

@@ -4,8 +4,8 @@ packaging_format = 2
 
 id = "element-call"
 name = "Element-Call"
-description.en = "Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)"
+description.en = "Group calls powered by Matrix"
-description.fr = "Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps)"
+description.fr = "Appels de groupe alimentés par Matrix"
 
 version = "0.5.9~ynh1"
 
@@ -15,7 +15,6 @@ maintainers = ["eric_G"]
 license = "Apache-2.0"
 website = "https://call.element.io/"
 demo = "https://call.element.io/"
-admindoc = "https://yunohost.org/packaging_apps"
 code = "https://github.com/vector-im/element-call"
 
 [integration]
@@ -39,7 +38,6 @@ ram.runtime = "50M"
     type = "group"
     default = "visitors"
 
-
 [resources]
 
     [resources.sources]
@@ -47,7 +45,6 @@ ram.runtime = "50M"
         [resources.sources.main]
         url = "https://github.com/vector-im/element-call/archive/refs/tags/v0.5.9.tar.gz"
         sha256 = "a07834e1f4bd00a71d3dc5071eaed1051a7272a742ab16b64d9f8e9e2706f829"
-
         autoupdate.strategy = "latest_github_tag"
 
     [resources.system_user]
@@ -57,8 +54,6 @@ ram.runtime = "50M"
     [resources.permissions]
     main.url = "/"
 
-    [resources.ports]
-
     [resources.apt]
     packages = ""
     extras.yarn.repo = "deb https://dl.yarnpkg.com/debian/ stable main"

scripts/backup

@@ -15,75 +15,18 @@ source /usr/share/yunohost/helpers
 #=================================================
 ynh_print_info --message="Declaring files to be backed up..."
 
-### N.B. : the following 'ynh_backup' calls are only a *declaration* of what needs
-### to be backuped and not an actual copy of any file. The actual backup that
-### creates and fills the archive with the files happens in the core after this
-### script is called. Hence ynh_backups calls take basically 0 seconds to run.
-
 #=================================================
 # BACKUP THE APP MAIN DIR
 #=================================================
 
 ynh_backup --src_path="$install_dir"
 
-#=================================================
-# BACKUP THE DATA DIR
-#=================================================
-
-# Only relevant if there is a "data_dir" resource for this app
-ynh_backup --src_path="$data_dir" --is_big
-
 #=================================================
 # BACKUP THE NGINX CONFIGURATION
 #=================================================
 
 ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
-#=================================================
-# BACKUP THE PHP-FPM CONFIGURATION
-#=================================================
-
-ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
-
-#=================================================
-# BACKUP FAIL2BAN CONFIGURATION
-#=================================================
-
-ynh_backup --src_path="/etc/fail2ban/jail.d/$app.conf"
-ynh_backup --src_path="/etc/fail2ban/filter.d/$app.conf"
-
-#=================================================
-# SPECIFIC BACKUP
-#=================================================
-# BACKUP LOGROTATE
-#=================================================
-
-ynh_backup --src_path="/etc/logrotate.d/$app"
-
-#=================================================
-# BACKUP SYSTEMD
-#=================================================
-
-ynh_backup --src_path="/etc/systemd/system/$app.service"
-
-#=================================================
-# BACKUP VARIOUS FILES
-#=================================================
-
-ynh_backup --src_path="/etc/cron.d/$app"
-
-ynh_backup --src_path="/etc/$app/"
-
-#=================================================
-# BACKUP THE MYSQL DATABASE
-#=================================================
-ynh_print_info --message="Backing up the MySQL database..."
-
-### (However, things like MySQL dumps *do* take some time to run, though the
-### copy of the generated dump to the archive still happens later)
-
-ynh_mysql_dump_db --database="$db_name" > db.sql
-
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/change_url

@@ -9,15 +9,6 @@
 source _common.sh
 source /usr/share/yunohost/helpers
 
-#=================================================
-# STANDARD MODIFICATIONS
-#=================================================
-# STOP SYSTEMD SERVICE
-#=================================================
-ynh_script_progression --message="Stopping a systemd service..." --weight=1
-
-ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log"
-
 #=================================================
 # MODIFY URL IN NGINX CONF
 #=================================================
@@ -25,21 +16,6 @@ ynh_script_progression --message="Updating NGINX web server configuration..." --
 
 ynh_change_url_nginx_config
 
-#=================================================
-# SPECIFIC MODIFICATIONS
-#=================================================
-# ...
-#=================================================
-
-#=================================================
-# GENERIC FINALISATION
-#=================================================
-# START SYSTEMD SERVICE
-#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=1
-
-ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
-
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/install

@@ -37,11 +37,6 @@ ynh_script_progression --message="Adding system configurations related to $app..
 # Create a dedicated NGINX config using the conf/nginx.conf template
 ynh_add_nginx_config
 
-# Create a dedicated systemd config
-#ynh_add_systemd_config
-
-yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log"
-
 #=================================================
 # APP INITIAL CONFIGURATION
 #=================================================
@@ -65,16 +60,6 @@ pushd $install_dir
 	ynh_exec_warn_less sudo -u $app env $ynh_node_load_PATH NODE_ENV=production yarn build
 popd
 
-#=================================================
-# GENERIC FINALIZATION
-#=================================================
-# START SYSTEMD SERVICE
-#=================================================
-#ynh_script_progression --message="Starting a systemd service..." --weight=1
-
-# Start a systemd service
-#ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
-
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/remove

@@ -16,15 +16,6 @@ source /usr/share/yunohost/helpers
 #=================================================
 ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
 
-# 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 integration..." --weight=1
-#	yunohost service remove $app
-#fi
-
-#ynh_remove_systemd_config
-
 ynh_remove_nginx_config
 
 ynh_remove_nodejs

scripts/restore

@@ -17,28 +17,8 @@ ynh_script_progression --message="Restoring the app main directory..." --weight=
 
 ynh_restore_file --origin_path="$install_dir"
 
-# $install_dir will automatically be initialized with some decent 
-# permissions by default ... however, you may need to recursively reapply
-# ownership to all files such as after the ynh_setup_source step
 chown -R $app:www-data "$install_dir"
 
-#=================================================
-# RESTORE THE DATA DIRECTORY
-#=================================================
-ynh_script_progression --message="Restoring the data directory..." --weight=1
-
-ynh_restore_file --origin_path="$data_dir" --not_mandatory
-
-# (Same as for install dir)
-chown -R $app:www-data "$data_dir"
-
-#=================================================
-# RESTORE THE MYSQL DATABASE
-#=================================================
-ynh_script_progression --message="Restoring the MySQL database..." --weight=1
-
-ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
-
 #=================================================
 # RESTORE SYSTEM CONFIGURATIONS
 #=================================================
@@ -46,28 +26,8 @@ ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./
 #=================================================
 ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1
 
-# This should be a symetric version of what happens in the install script
-
-ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
-
 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 
-ynh_restore_file --origin_path="/etc/systemd/system/$app.service"
-systemctl enable $app.service --quiet
-
-yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log"
-
-ynh_restore_file --origin_path="/etc/logrotate.d/$app"
-
-ynh_restore_file --origin_path="/etc/fail2ban/jail.d/$app.conf"
-ynh_restore_file --origin_path="/etc/fail2ban/filter.d/$app.conf"
-ynh_systemd_action --action=restart --service_name=fail2ban
-
-# Other various files...
-
-ynh_restore_file --origin_path="/etc/cron.d/$app"
-ynh_restore_file --origin_path="/etc/$app/"
-
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
@@ -75,10 +35,6 @@ ynh_restore_file --origin_path="/etc/$app/"
 #=================================================
 ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1
 
-# Typically you only have either $app or php-fpm but not both at the same time...
-ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
-ynh_systemd_action --service_name=php$phpversion-fpm --action=reload
-
 ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================

scripts/upgrade

@@ -9,52 +9,8 @@
 source _common.sh
 source /usr/share/yunohost/helpers
 
-# Settings are automatically loaded as bash variables
-# in every app script context, therefore typically these will exist:
-# - $domain
-# - $path
-# - $language
-# - $install_dir
-# - $port
-# ...
-
-# In the context of upgrade,
-# - resources are automatically provisioned / updated / deleted (depending on existing resources)
-# - a safety backup is automatically created by the core and will be restored if the upgrade fails
-
-### This helper will compare the version of the currently installed app and the version of the upstream package.
-### $upgrade_type can have 2 different values
-### - UPGRADE_APP if the upstream app version has changed
-### - UPGRADE_PACKAGE if only the YunoHost package has changed
-### ynh_check_app_version_changed will stop the upgrade if the app is up to date.
-### UPGRADE_APP should be used to upgrade the core app only if there's an upgrade to do.
 upgrade_type=$(ynh_check_app_version_changed)
 
-#=================================================
-# STANDARD UPGRADE STEPS
-#=================================================
-# ENSURE DOWNWARD COMPATIBILITY
-#=================================================
-#ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
-
-#
-# N.B. : the following setting migration snippets are provided as *EXAMPLES*
-# of what you may want to do in some cases (e.g. a setting was not defined on
-# some legacy installs and you therefore want to initiaze stuff during upgrade)
-#
-
-# If db_name doesn't exist, create it
-#if [ -z "$db_name" ]; then
-#	db_name=$(ynh_sanitize_dbid --db_name=$app)
-#	ynh_app_setting_set --app=$app --key=db_name --value=$db_name
-#fi
-
-# If install_dir doesn't exist, create it
-#if [ -z "$install_dir" ]; then
-#	install_dir=/var/www/$app
-#	ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
-#fi
-
 #=================================================
 # STOP SYSTEMD SERVICE
 #=================================================
@@ -73,12 +29,9 @@ then
 	ynh_script_progression --message="Upgrading source files..." --weight=1
 
 	# Download, check integrity, uncompress and patch the source from manifest.toml
-	ynh_setup_source --dest_dir="$install_dir"
+	ynh_setup_source --dest_dir="$install_dir" --keep="public/config.json"
 fi
 
-# $install_dir will automatically be initialized with some decent 
-# permissions by default ... however, you may need to recursively reapply
-# ownership to all files such as after the ynh_setup_source step
 chown -R $app:www-data "$install_dir"
 
 #=================================================
@@ -86,53 +39,19 @@ chown -R $app:www-data "$install_dir"
 #=================================================
 ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1
 
-# This should be a literal copypaste of what happened in the install's "System configuration" section
-
-ynh_add_fpm_config
-
 ynh_add_nginx_config
 
-ynh_add_systemd_config
-
-yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log"
-
-ynh_use_logrotate --non-append
-
-ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login"
-
 #=================================================
 # RECONFIGURE THE APP (UPDATE CONF, APPLY MIGRATIONS...)
 #=================================================
 # UPDATE A CONFIG FILE
 #=================================================
-ynh_script_progression --message="Updating a configuration file..." --weight=1
+#ynh_script_progression --message="Updating a configuration file..." --weight=1
 
-### Same as during install
+#ynh_add_config --template="config.json" --destination="$install_dir/public/config.json"
-###
-### The file will automatically be backed-up if it's found to be manually modified (because
-### ynh_add_config keeps track of the file's checksum)
 
-ynh_add_config --template="some_config_file" --destination="$install_dir/some_config_file"
+#chmod 400 "$install_dir/public/config.json"
-
+#chown $app:$app "$install_dir/public/config.json"
-# FIXME: this should be handled by the core in the future
-# You may need to use chmod 600 instead of 400,
-# for example if the app is expected to be able to modify its own config
-chmod 400 "$install_dir/some_config_file"
-chown $app:$app "$install_dir/some_config_file"
-
-### For more complex cases where you want to replace stuff using regexes,
-### you shoud rely on ynh_replace_string (which is basically a wrapper for sed)
-### When doing so, you also need to manually call ynh_store_file_checksum
-###
-### ynh_replace_string --match_string="match_string" --replace_string="replace_string" --target_file="$install_dir/some_config_file"
-### ynh_store_file_checksum --file="$install_dir/some_config_file"
-
-#=================================================
-# START SYSTEMD SERVICE
-#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=1
-
-ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
 
 #=================================================
 # END OF SCRIPT

tests.toml

@@ -0,0 +1,9 @@
+#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json
+
+test_format = 1.0
+
+[default]
+
+    # ------------
+    # Tests to run
+    # ------------

tests.toml.example

@@ -1,67 +0,0 @@
-#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json
-
-test_format = 1.0
-
-[default]
-
-    # ------------
-    # Tests to run
-    # ------------
-
-    # NB: the tests to run are automatically deduced by the CI script according to the
-    # content of the app's manifest. The declarations below allow to customize which
-    # tests are ran, possibly add special test suite to test special args, or
-    # declare which commits to test upgrade from.
-    #
-    # You can also decide (though this is discouraged!) to ban/ignore some tests,
-
-    exclude = ["install.private", "install.multi"]
-    # The test IDs to be used in only/exclude statements are:
-    # * install.root
-    # * install.subdir
-    # * install.nourl
-    # * install.multi
-    # * backup_restore
-    # * upgrade
-    # * upgrade.someCommitId
-    # * change_url
-    # NB: you should NOT need this except if you really have a good reason...
-
-    # For special usecases, sometimes you need to setup other things on the machine
-    # prior to installing the app (such as installing another app)
-    # (Remove this key entirely if not needed)
-    preinstall = """
-    sudo yunohost app install foobar
-    sudo yunohost user list
-    """
-
-    # -------------------------------
-    # Default args to use for install
-    # -------------------------------
-
-    # By default, the CI will automagically fill the 'standard' args
-    # such as domain, path, admin, is_public and password with relevant values
-    # and also install args with a "default" provided in the manifest..
-    # It should only make sense to declare custom args here for args with no default values
-
-    args.language = "fr_FR"
-    args.multisite = 0
-    # NB: you should NOT need those lines unless for custom questions with no obvious/default value
-
-    # -------------------------------
-    # Commits to test upgrade from
-    # -------------------------------
-
-    test_upgrade_from.00a1a6e7.name = "Upgrade from 5.4"
-    test_upgrade_from.00a1a6e7.args.foo = "bar"
-
-
-# This is an additional test suite
-[some_additional_testsuite]
-
-    # On additional tests suites, you can decide to run only specific tests
-
-    only = ["install.subdir"]
-
-    args.language = "en_GB"
-    args.multisite = 1