Merge pull request #1 from YunoHost-Apps/example_ynh

Apply last example_ynh
2024-09-03 18:06:25 +02:00 · 2020-06-15 10:38:20 +02:00 · 2020-06-15 10:38:20 +02:00 · 8db7e76b5d
commit 8db7e76b5d
parent cce2fbc071 259888e517
11 changed files with 160 additions and 80 deletions
--- a/README.md
+++ b/README.md
@ -1,25 +1,42 @@
 # Cesium package for YunoHost

-[![Integration level](https://dash.yunohost.org/integration/cesium.svg)](https://dash.yunohost.org/appci/app/cesium) ![](https://ci-apps.yunohost.org/ci/badges/cesium.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/cesium.maintain.svg)
-[![Install Custom Webapp with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=cesium)
+[![Integration level](https://dash.yunohost.org/integration/cesium.svg)](https://dash.yunohost.org/appci/app/cesium) ![](https://ci-apps.yunohost.org/ci/badges/cesium.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/cesium.maintain.svg)  
+[![Install Cesium with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=cesium)


-> *This package allow you to install Cesium quickly and simply on a YunoHost server.
-If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+> *This package allows you to install Cesium quickly and simply on a YunoHost server.  
+If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

 ## Overview
-
 [Cesium](https://cesium.app) is an [Unhosted webapp](https://unhosted.org) client for any [Duniter](https://duniter.org) crypto-currency.
 It allows you to manage your wallet, certify your friends, and more !

 **Shipped version:** v1.6.7

+## YunoHost specific features
+
+#### Supported architectures
+
+* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/cesium%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/cesium/)
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/cesium%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/cesium/)
+
 ## Links

- [YunoHost website](https://yunohost.org)
- [Duniter website](https://duniter.org)
- [Cesium repository](https://github.com/duniter/cesium)
+ * Report a bug: https://github.com/YunoHost-Apps/cesium_ynh/issues
+ * App website: https://duniter.org
+ * Upstream app repository: https://github.com/duniter/cesium
+ * YunoHost website: https://yunohost.org/

-## License
+---

-This software is distributed under [GNU AGPL-3.0](https://raw.github.com/duniter/cesium/master/LICENSE).
+Developer info
+----------------
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/cesium_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/cesium_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade cesium -u https://github.com/YunoHost-Apps/cesium_ynh/tree/testing --debug
+```
--- a/19
+++ b/19
@ -1,5 +1,4 @@
 ;; Test complet
-	auto_remove=1
 	; Manifest
 		domain="domain.tld"	(DOMAIN)
 		path="/path"	(PATH)
@ -12,18 +11,18 @@
 		setup_private=1
 		setup_public=1
 		upgrade=1
+		# v1.6.7~ynh1
+		upgrade=1	from_commit=99330d46e45662b922de84e2e48ad1b15a63bb6e
 		backup_restore=1
 		multi_instance=0
 		port_already_use=0
 		change_url=1
 ;;; Levels
-	Level 1=auto
-	Level 2=auto
-	Level 3=auto
-	Level 4=na
+	# If the level 5 (Package linter) is forced to 1. Please add justifications here.
 	Level 5=auto
-	Level 6=auto
-	Level 7=auto
-	Level 8=0
-	Level 9=0
-	Level 10=0
+;;; Options
+Email=
+Notification=none
+;;; Upgrade options
+	; commit=99330d46e45662b922de84e2e48ad1b15a63bb6e
+		name=v1.6.7~ynh1
--- a/issue_template.md
+++ b/issue_template.md
@ -0,0 +1,46 @@
+---
+name: Bug report
+about: Create a report to help us debug, it would be nice to fill the template as much as you can to help us, help you and help us all.
+
+---
+
+**How to post a meaningful bug report**
+1. *Read this whole template first.*
+2. *Determine if you are on the right place:*
+   - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change url...), you are on the right place!*
+   - *Otherwise, the issue may be due to Cesium itself. Refer to its documentation or repository for help.*
+   - *If you have a doubt, post here, we will figure it out together.*
+3. *Delete the italic comments as you write over them below, and remove this guide.*
+--- 
+
+**Describe the bug**
+*A clear and concise description of what the bug is.*
+
+**Versions**
+- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...*
+- YunoHost version: x.x.x
+- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...*
+- Are you in a special context or did you perform some particular tweaking on your YunoHost instance ?: *no / yes*
+  - If yes, please explain:
+- Using, or trying to install package version/branch:
+- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`*
+
+**To Reproduce**
+*Steps to reproduce the behavior.*
+- *If you performed a command from the CLI, the command itself is enough. For example:*
+    ```sh
+    sudo yunohost app install cesium
+    ```
+- *If you used the webadmin, please perform the equivalent command from the CLI first.*
+- *If the error occurs in your browser, explain what you did:*
+   1. *Go to '...'*
+   2. *Click on '....'*
+   3. *Scroll down to '....'*
+   4. *See error*
+
+**Expected behavior**
+*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.*
+
+**Logs**
+*After a failed command, YunoHost makes the log available to you, but also to others, thanks to `yunohost log display [log name] --share`. The actual command, with the correct log name, is displayed at the end of the failed attempt in the CLI. Execute it and copy here the share link it outputs.*
+*If applicable and useful, add screenshots to help explain your problem.*
--- a/pull_request_template.md
+++ b/pull_request_template.md
@ -0,0 +1,18 @@
+## Problem
+- *Description of why you made this PR*
+
+## Solution
+- *And how do you fix that problem*
+
+## PR Status
+- [ ] Code finished.
+- [ ] Tested with Package_check.
+- [ ] Fix or enhancement tested.
+- [ ] Upgrade from last version tested.
+- [ ] Can be reviewed and tested.
+
+## Package_check results
+---
+*If you have access to [App Continuous Integration for packagers](https://yunohost.org/#/packaging_apps_ci) you can provide a link to the package_check results like below, replacing '-NUM-' in this link by the PR number and USERNAME by your username on the ci-apps-dev. Or you provide a screenshot or a pastebin of the results*
+
+[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/cesium_ynh%20PR-NUM-%20(USERNAME)/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/cesium_ynh%20PR-NUM-%20(USERNAME)/)  
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@ -0,0 +1,20 @@
+#!/bin/bash
+
+#=================================================
+# COMMON VARIABLES
+#=================================================
+
+# dependencies used by the app
+pkg_dependencies=""
+
+#=================================================
+# PERSONAL HELPERS
+#=================================================
+
+#=================================================
+# EXPERIMENTAL HELPERS
+#=================================================
+
+#=================================================
+# FUTURE OFFICIAL HELPERS
+#=================================================
--- a/scripts/backup
+++ b/scripts/backup
@ -6,6 +6,8 @@
 # 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,7 +15,6 @@ source /usr/share/yunohost/helpers
 #=================================================

 ynh_clean_setup () {
-  ### Remove this function if there's nothing to clean before calling the remove script.
  true
 }
 # Exit if an error occurs during the execution of the script
@ -34,22 +35,15 @@ domain=$(ynh_app_setting_get --app=$app --key=domain)
 #=================================================
 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 fill the archive with the files happens in the core after this
-### script is called. Hence ynh_backups calls takes basically 0 seconds to run.
-
 #=================================================
 # BACKUP THE APP MAIN DIR
 #=================================================
-ynh_print_info --message="backing up the files..."

 ynh_backup --src_path="$final_path"

 #=================================================
 # BACKUP THE NGINX CONFIGURATION
 #=================================================
-ynh_print_info --message="backing up nginx.conf..."

 ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"

@ -58,5 +52,3 @@ ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 #=================================================

 ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."
-
-
--- a/scripts/change_url
+++ b/scripts/change_url
@ -6,6 +6,7 @@
 # IMPORT GENERIC HELPERS
 #=================================================

+source _common.sh
 source /usr/share/yunohost/helpers

 #=================================================
@ -32,7 +33,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 #=================================================
 # CHECK WHICH PARTS SHOULD BE CHANGED
 #=================================================
-ynh_print_info --message="checking parts should be changed..."
+ynh_script_progression --message="checking parts should be changed..."

 change_domain=0
 if [ "$old_domain" != "$new_domain" ]
@ -87,4 +88,3 @@ ynh_systemd_action --service_name=nginx --action=reload
 #=================================================

 ynh_script_progression --message="Change of URL completed for $app"
-
--- a/scripts/install
+++ b/scripts/install
@ -1,10 +1,12 @@
 #!/bin/bash
+
 #=================================================
 # GENERIC START
 #=================================================
 # IMPORT GENERIC HELPERS
 #=================================================

+source _common.sh
 source /usr/share/yunohost/helpers

 #=================================================
@ -12,7 +14,6 @@ source /usr/share/yunohost/helpers
 #=================================================

 ynh_clean_setup () {
-  ### Remove this function if there's nothing to clean before calling the remove script.
  true
 }
 # Exit if an error occurs during the execution of the script
@ -22,12 +23,12 @@ ynh_abort_if_errors
 # RETRIEVE ARGUMENTS FROM THE MANIFEST
 #=================================================

-# Retrieve arguments
-app=$YNH_APP_INSTANCE_NAME
 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
 #=================================================
@ -35,11 +36,7 @@ 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"
-# Normalize the url path syntax
-path_url=$(ynh_normalize_url_path $path_url)

-# Check web path availability
-ynh_webpath_available $domain $path_url
 # Register (book) web path
 ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url

@ -48,7 +45,6 @@ ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
 #=================================================
 ynh_script_progression --message="Storing installation settings..."

-# Save app 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=is_public --value=$is_public
@ -58,21 +54,10 @@ ynh_app_setting_set --app=$app --key=is_public --value=$is_public
 #=================================================
 ynh_script_progression --message="Setting up source files..."

-# Retrieve sources and install them
 ynh_app_setting_set --app=$app --key=final_path --value=$final_path
-	# Download, check integrity, uncompress and patch the source from app.src
-
+# Download, check integrity, uncompress and patch the source from app.src
 ynh_setup_source --dest_dir="$final_path"

-#=================================================
-# Permissions files
-#=================================================
-
-chown -R www-data: $final_path
-
-# Remove the public access
-ynh_app_setting_delete --app=$app --key=skipped_uris
-
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
@ -88,13 +73,27 @@ then
  ynh_replace_string "^#sub_path_only" "" "/etc/nginx/conf.d/$domain.d/$app.conf"
 fi

+#=================================================
+# GENERIC FINALIZATION
+#=================================================
+# SECURE FILES AND DIRECTORIES
+#=================================================
+ynh_script_progression --message="Securing files and directories..."
+
+# Set permissions to app files
+chown -R www-data: $final_path
+
 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_script_progression --message="Configuring permissions..."
+ynh_script_progression --message="Configuring SSOwat..."
+
+# Remove the public access
+ynh_app_setting_delete --app=$app --key=skipped_uris

 # If app is public, add url to SSOWat conf as skipped_uris and read-only mode
-if [[ $is_public -eq 1 ]]; then
+if [ $is_public -eq 1 ]
+then
  # unprotected_uris allows SSO credentials to be passed anyway.
  ynh_permission_update --permission "main" --add "visitors"
  # activate read-only
@ -112,4 +111,4 @@ ynh_systemd_action --service_name=nginx --action=reload
 # END OF SCRIPT
 #=================================================

-ynh_script_progression --message="Installation of $app completed"
+ynh_script_progression --message="Installation of $app completed"
--- a/scripts/remove
+++ b/scripts/remove
@ -6,6 +6,7 @@
 # IMPORT GENERIC HELPERS
 #=================================================

+source _common.sh
 source /usr/share/yunohost/helpers

 #=================================================
@ -35,18 +36,8 @@ ynh_script_progression --message="Removing nginx web server configuration..."
 # Remove the dedicated nginx config
 ynh_remove_nginx_config

-#=================================================
-# RELOAD NGINX
-#=================================================
-ynh_script_progression --message="Reloading nginx web server..."
-ynh_systemd_action --service_name=nginx --action=reload
-
 #=================================================
 # END OF SCRIPT
 #=================================================

 ynh_script_progression --message="Removal of $app completed"
-
-
-
-
--- a/scripts/restore
+++ b/scripts/restore
@ -7,6 +7,7 @@
 #=================================================

 #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

 #=================================================
@ -14,7 +15,6 @@ source /usr/share/yunohost/helpers
 #=================================================

 ynh_clean_setup () {
-  #### Remove this function if there's nothing to clean before calling the remove script.
  true
 }
 # Exit if an error occurs during the execution of the script
@ -23,7 +23,7 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..."
+ynh_script_progression --message="Loading settings..."

 app=$YNH_APP_INSTANCE_NAME

@ -46,6 +46,7 @@ test ! -d $final_path \
 #=================================================
 # RESTORE THE NGINX CONFIGURATION
 #=================================================
+ynh_script_progression --message="Restoring the nginx configuration..."

 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"

@ -59,6 +60,7 @@ ynh_restore_file --origin_path="$final_path"
 #=================================================
 # RESTORE USER RIGHTS
 #=================================================
+ynh_script_progression --message="Restoring user rights..."

 # Restore permissions on app files
 chown -R www-data: $final_path
@ -76,4 +78,4 @@ ynh_systemd_action --service_name=nginx --action=reload
 # END OF SCRIPT
 #=================================================

-ynh_script_progression --message="Restoration completed for $app"
+ynh_script_progression --message="Restoration completed for $app"
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -6,34 +6,29 @@
 # IMPORT GENERIC HELPERS
 #=================================================

+source _common.sh
 source /usr/share/yunohost/helpers

 #=================================================
 # LOAD SETTINGS
 #=================================================
 ynh_script_progression --message="Loading installation settings..."
+
 app=$YNH_APP_INSTANCE_NAME

-# Retrieve app settings
+
 domain=$(ynh_app_setting_get --app=$app --key=domain)
 path_url=$(ynh_app_setting_get --app=$app --key=path)
 is_public=$(ynh_app_setting_get --app=$app --key=is_public)
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)

-
 #=================================================
 # CHECK VERSION
 #=================================================
+ynh_script_progression --message="Checking version..."

-### 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)

-
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
@ -92,12 +87,12 @@ then
  ynh_setup_source --dest_dir="$final_path"
 fi

-
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
 ynh_script_progression --message="Upgrading nginx web server configuration..."

+# Create a dedicated nginx config
 ynh_add_nginx_config

 if [ "$path_url" != "/" ]
@ -108,6 +103,7 @@ fi
 #=================================================
 # SECURE FILES AND DIRECTORIES
 #=================================================
+ynh_script_progression --message="Securing files and directories..."

 # Set permissions on app files
 chown -R www-data: $final_path
@ -115,7 +111,7 @@ chown -R www-data: $final_path
 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_script_progression --message="Configuring permissions..."
+ynh_script_progression --message="Upgrading SSOwat configuration..."

 # If app is public, add url to SSOWat conf as skipped_uris and read-only mode
 if [[ $is_public -eq 1 ]]; then
@ -136,4 +132,4 @@ ynh_systemd_action --service_name=nginx --action=reload
 # END OF SCRIPT
 #=================================================

-ynh_script_progression --message="Upgrade of $app completed"
+ynh_script_progression --message="Upgrade of $app completed"