From 488abb23d3648de8eb3e77a7e3b03b188c580c9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Fri, 3 Feb 2023 13:57:22 +0100 Subject: [PATCH] Testing (#21) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Cleaning up (#9) * Update README_fr.md * cleaning up * Fix package_checker warning * permission rework * From source * Update app.src * fix * fix * Set SVG badge * Update README_fr.md * Small fix * Small fixes * Cleaning up * Update manifest.json * Update change_url * Update manifest.json * Update upgrade * Add user * Fix * fix * Update install * Fix * [autopatch] Update issue and PR templates (#16) * Testing (#13) - Set permissions * [autopatch] Update issue and PR templates (#15) Co-authored-by: Yunohost-Bot <> * [autopatch] Update issue and PR templates Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: Yunohost-Bot <> * Update manifest.json * Update check_process * Update restore * Cleaning up * Auto-update README * Auto-update README * Update manifest.json * Auto-update README * update to 4.3 * Update manifest.json * Auto-update README * Update manifest.json * Auto-update README * Auto-update README * Update manifest.json * Update manifest.json * Auto-update README * V2 (#20) * v2 * Auto-update README * V2 * Auto-update README * Fix * Auto-update README * Auto-update README * Create description.md * Update manifest.toml * Auto-update README * Update install --------- Co-authored-by: yunohost-bot * Delete description.md * Create DESCRIPTION.md * Auto-update README --------- Co-authored-by: YunoHost Bot Co-authored-by: Yunohost-Bot <> Co-authored-by: yunohost-bot --- README.md | 4 +-- README_fr.md | 4 +-- check_process | 17 ----------- conf/nginx.conf | 2 +- doc/DESCRIPTION.md | 1 + manifest.json | 50 ------------------------------- manifest.toml | 46 ++++++++++++++++++++++++++++ scripts/backup | 18 +---------- scripts/install | 74 ++++------------------------------------------ scripts/remove | 28 ------------------ scripts/restore | 40 ++----------------------- scripts/upgrade | 74 +++------------------------------------------- tests.toml | 9 ++++++ 13 files changed, 75 insertions(+), 292 deletions(-) delete mode 100644 check_process create mode 100644 doc/DESCRIPTION.md delete mode 100644 manifest.json create mode 100644 manifest.toml create mode 100644 tests.toml diff --git a/README.md b/README.md index 57d864e..ab0cb45 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,9 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -2048 variant with Euro coins and notes +Variante de 2048 avec pièces et billets en euros. -**Shipped version:** 1.0~ynh7 +**Shipped version:** 1.0~ynh8 ## Screenshots diff --git a/README_fr.md b/README_fr.md index 9d2fb8b..078c299 100644 --- a/README_fr.md +++ b/README_fr.md @@ -15,9 +15,9 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -Variante de 2048 avec pièces et billets en euros +Variante de 2048 avec pièces et billets en euros. -**Version incluse :** 1.0~ynh7 +**Version incluse :** 1.0~ynh8 ## Captures d’écran diff --git a/check_process b/check_process deleted file mode 100644 index a402d51..0000000 --- a/check_process +++ /dev/null @@ -1,17 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - path="/path" - is_public=1 - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - backup_restore=1 - multi_instance=1 - port_already_use=0 - change_url=1 diff --git a/conf/nginx.conf b/conf/nginx.conf index 70b1b40..c91732b 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -2,7 +2,7 @@ location __PATH__/ { # Path to source - alias __FINALPATH__/ ; + alias __INSTALL_DIR__/; index index.html; diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..92292d3 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1 @@ +Variante de 2048 avec pièces et billets en euros. \ No newline at end of file diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 3a5cf44..0000000 --- a/manifest.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "name": "20 euros", - "id": "20euros", - "packaging_format": 1, - "description": { - "en": "2048 variant with Euro coins and notes", - "fr": "Variante de 2048 avec pièces et billets en euros" - }, - "version": "1.0~ynh7", - "url": "https://github.com/jatekos101/20euros", - "upstream": { - "license": "MIT", - "code": "https://github.com/jatekos101/20euros" - }, - "license": "MIT", - "maintainer": { - "name": "eric_G", - "email": "" - }, - "requirements": { - "yunohost": ">= 11.0.9" - }, - "multi_instance": true, - "services": [ - "nginx" - ], - "arguments": { - "install" : [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/20euros", - "default": "/20euros" - }, - { - "name": "is_public", - "type": "boolean", - "help": { - "en": "If enabled, 20 euros will be accessible by people who doesn’t have an account. This can be changed later via the webadmin.", - "fr": "Si cette case est cochée, 20 euros sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." - }, - "default": true - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..640781c --- /dev/null +++ b/manifest.toml @@ -0,0 +1,46 @@ +packaging_format = 2 + +id = "20euros" +name = "20 euros" +description.en = "2048 variant with Euro coins and notes" +description.fr = "Variante de 2048 avec pièces et billets en euros" + +version = "1.0~ynh8" + +maintainers = ["eric_G"] + +[upstream] +license = "MIT" +code = "https://github.com/jatekos101/20euros" + +[integration] +yunohost = ">= 11.1.2" +architectures = "all" +multi_instance = true +ldap = "not_relevant" +sso = "not_relevant" +disk = "50M" +ram.build = "50M" +ram.runtime = "50M" + +[install] + [install.domain] + type = "domain" + + [install.path] + type = "path" + default = "/20euros" + + [install.init_main_permission] + help.en = "If enabled, 20 euros will be accessible by people who doesn’t have an account. This can be changed later via the webadmin." + help.fr = "Si cette case est cochée, 20 euros sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." + type = "group" + default = "visitors" + +[resources] + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" diff --git a/scripts/backup b/scripts/backup index 80e4cd6..a6b113b 100644 --- a/scripts/backup +++ b/scripts/backup @@ -8,22 +8,6 @@ source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -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 #================================================= @@ -33,7 +17,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 diff --git a/scripts/install b/scripts/install index 1e56600..44f96c1 100755 --- a/scripts/install +++ b/scripts/install @@ -8,68 +8,21 @@ source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_abort_if_errors - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= -# Retrieve arguments - -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH -is_public=$YNH_APP_ARG_IS_PUBLIC - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=1 - -# Copy files to the right place -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..." --weight=2 - -ynh_app_setting_set --app=$app --key=domain --value=$domain -ynh_app_setting_set --app=$app --key=path --value=$path_url - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=2 - -# Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # STANDARD MODIFICATIONS #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_script_progression --message="Setting up source files..." --weight=1 +ynh_script_progression --message="Setting up source files..." --weight=2 -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" -mv $final_path/'20 Euro.html' "$final_path/index.html" +mv $install_dir/'20 Euro.html' "$install_dir/index.html" #================================================= # NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Configuring NGINX web server..." --weight=2 +ynh_script_progression --message="Configuring NGINX web server..." --weight=3 # Create a dedicated NGINX config ynh_add_nginx_config @@ -81,23 +34,8 @@ ynh_add_nginx_config #================================================= # Set permissions to app files -chown -R $app:www-data $final_path -chmod o-rwx $final_path - -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 - -# Make app public if necessary or protect it -[ $is_public -eq 0 ] || ynh_permission_update --permission="main" --add="visitors" - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +chown -R $app:www-data $install_dir +chmod o-rwx $install_dir #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index f2c5329..2952ff1 100755 --- a/scripts/remove +++ b/scripts/remove @@ -8,26 +8,6 @@ source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - -#================================================= -# STANDARD REMOVE -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --weight=3 - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" - #================================================= # REMOVE NGINX CONFIGURATION #================================================= @@ -36,14 +16,6 @@ ynh_script_progression --message="Removing NGINX web server configuration..." -- # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 - -# Delete a system user -ynh_system_user_delete --username=$app - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index 6d12b18..44176fb 100644 --- a/scripts/restore +++ b/scripts/restore @@ -8,32 +8,6 @@ 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_script_progression --message="Loading settings..." --weight=1 - -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..." --weight=1 - -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " - #================================================= # STANDARD RESTORATION STEPS #================================================= @@ -42,28 +16,20 @@ test ! -d $final_path \ 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..." --weight=1 - -# 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..." --weight=2 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" #================================================= # RESTORE USER RIGHTS #================================================= # Restore permissions on app files -chown -R $app:www-data $final_path -chmod o-rwx $final_path +chown -R $app:www-data $install_dir +chmod o-rwx $install_dir #================================================= # GENERIC FINALIZATION diff --git a/scripts/upgrade b/scripts/upgrade index 66be137..923c819 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -8,71 +8,12 @@ source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -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 VERSION #================================================= upgrade_type=$(ynh_check_app_version_changed) -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up $app before upgrading (may take a while)..." --weight=3 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 - -# If final_path doesn't exist, create it -if [ -z "$final_path" ]; then - final_path=/var/www/$app - ynh_app_setting_set --app=$app --key=final_path --value=$final_path -fi - -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 - -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 - -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= @@ -82,8 +23,8 @@ then ynh_script_progression --message="Upgrading source files..." --weight=4 # Download the source from ../sources - mkdir -p $final_path - cp -a ../sources/* $final_path + mkdir -p $install_dir + cp -a ../sources/* $install_dir fi #================================================= @@ -99,15 +40,8 @@ ynh_add_nginx_config #================================================= # Set permissions on app files -chown -R $app:www-data $final_path -chmod o-rwx $final_path - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +chown -R $app:www-data $install_dir +chmod o-rwx $install_dir #================================================= # END OF SCRIPT diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..0544ce1 --- /dev/null +++ b/tests.toml @@ -0,0 +1,9 @@ +test_format = 1.0 + +[default] + + # ------------ + # Tests to run + # ------------ + + exclude ="install.nourl"