Merge pull request #10 from YunoHost-Apps/testing

.github/ISSUE_TEMPLATE.md

@@ -8,7 +8,7 @@ about: When creating a bug report, please use the following template to provide
 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 dato itself. Refer to [its documentation](https://docs.couchdb.org/en/stable/index.html) or [repository](https://github.com/apache/couchdb/issues/) for help.*
+   - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.*
    - *When in doubt, post here and we will figure it out together.*
 3. *Delete the italic comments as you write over them below, and remove this guide.*
 --- 
@@ -31,7 +31,7 @@ about: When creating a bug report, please use the following template to provide
 
 - *If you performed a command from the CLI, the command itself is enough. For example:*
     ```sh
-    sudo yunohost app install couchdb
+    sudo yunohost app install the_app
     ```
 - *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:*

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+## Problem
+
+- *Description of why you made this PR*
+
+## Solution
+
+- *And how do you fix that problem*
+
+## PR Status
+
+- [ ] Code finished and ready to be reviewed/tested
+- [ ] The fix/enhancement were manually tested (if applicable)
+
+## Automatic tests
+
+Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization)

check_process

@@ -3,9 +3,9 @@
 
 ;; Test complet
 	; Manifest
-		domain="domain.tld"	(DOMAIN)
+		domain="domain.tld"
-		path="/path"	(PATH)
+		path="/path"
-		is_public=1	(PUBLIC|public=1|private=0)
+		is_public=1
 		password="pass"
 	; Checks
 		pkg_linter=1

conf/couch_ynh.ini

@@ -2,3 +2,6 @@
 [chttpd]
 ; prevent non admin users to be able to access the list of all databases
 admin_only_all_dbs = true
+
+; Defines the port number to listen:
+port = __PORT__

manifest.json

@@ -1,69 +1,53 @@
 {
-  "name": "Couchdb",
+    "name": "Couchdb",
-  "id": "couchdb",
+    "id": "couchdb",
-  "packaging_format": 1,
+    "packaging_format": 1,
-  "description": {
+    "description": {
-    "en": "An open-source document-oriented NoSQL database.",
+        "en": "An open-source document-oriented NoSQL database.",
-    "fr": "Système de gestion de base de données orienté documents."
+        "fr": "Système de gestion de base de données orienté documents."
-  },
+    },
-  "version": "3.1.1~ynh1",
+    "version": "3.1.1~ynh1",
-  "url": "https://couchdb.apache.org/",
+    "url": "https://couchdb.apache.org/",
-  "license": "Apache-2.0",
+    "license": "Apache-2.0",
-  "maintainer": {
+    "maintainer": {
-    "name": "Squeak",
+        "name": "Squeak",
-    "email": "squeak@eauchat.org",
+        "email": "squeak@eauchat.org",
-    "url": "https://squeak.eauchat.org"
+        "url": "https://squeak.eauchat.org"
-  },
+    },
-  "requirements": {
+    "requirements": {
-    "yunohost": ">= 4.1.3"
+        "yunohost": ">= 4.2.4"
-  },
+    },
-  "multi_instance": false,
+    "multi_instance": false,
-  "services": [
+    "services": [
-    "nginx"
+        "nginx"
-  ],
+    ],
-  "arguments": {
+    "arguments": {
-    "install" : [
+        "install" : [
-      {
+            {
-        "name": "domain",
+                "name": "domain",
-        "type": "domain",
+                "type": "domain",
-        "ask": {
+                "example": "example.com"
-          "en": "Choose a domain name for couchdb",
+            },
-          "fr": "Choisissez un nom de domaine pour couchdb"
+            {
-        },
+                "name": "path",
-        "example": "example.com"
+                "type": "path",
-      },
+                "example": "/couch",
-      {
+                "default": "/couch"
-        "name": "path",
+            },
-        "type": "path",
+            {
-        "ask": {
+                "name": "is_public",
-          "en": "Choose a path for couchdb",
+                "type": "boolean",
-          "fr": "Choisissez un chemin pour couchdb"
+                "help": {
-        },
+                    "en": "If enabled, couchdb will be accessible without yunohost account on your server, but couchdb contains it's own user authentication system.",
-        "example": "/couch",
+                    "fr": "Si cette case est cochée, couchdb sera accessible aux personnes n’ayant pas de compte yunohost sur votre serveur, mais couchdb a son propre système d'autentification des utilisateurs."
-        "default": "/couch"
+                },
-      },
+                "default": true
-      {
+            },
-        "name": "is_public",
+            {
-        "type": "boolean",
+                "name": "password",
-        "ask": {
+                "type": "password",
-          "en": "Is it a public application?",
+                "example": "Choose a password"
-          "fr": "Est-ce une application publique ?"
+            }
-        },
+        ]
-        "help": {
+    }
-          "en": "If enabled, couchdb will be accessible without yunohost account on your server, but couchdb contains it's own user authentication system.",
-          "fr": "Si cette case est cochée, couchdb sera accessible aux personnes n’ayant pas de compte yunohost sur votre serveur, mais couchdb a son propre système d'autentification des utilisateurs."
-        },
-        "default": true
-      },
-      {
-        "name": "password",
-        "type": "password",
-        "ask": {
-          "en": "Set the administrator password (between 8 and 30 characters)",
-          "fr": "Définissez le mot de passe administrateur (entre 8 et 30 caractères)"
-        },
-        "example": "Choose a password"
-      }
-    ]
-  }
 }

pull_request_template.md

@@ -1,16 +0,0 @@
-## 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
----
-* An automatic package_check will be launch at https://ci-apps-dev.yunohost.org/, when you add a specific comment to your Pull Request: "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!"*

scripts/backup

@@ -15,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
@@ -36,11 +35,6 @@ 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
 #=================================================

scripts/change_url

@@ -31,7 +31,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 port=$(ynh_app_setting_get --app=$app --key=port)
 
 #=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP
 #=================================================
 ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=15
 
@@ -65,8 +65,6 @@ fi
 
 #=================================================
 # STANDARD MODIFICATIONS
-#=================================================
-
 #=================================================
 # MODIFY URL IN NGINX CONF
 #=================================================

scripts/install

@@ -14,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
@@ -24,13 +23,13 @@ ynh_abort_if_errors
 # RETRIEVE ARGUMENTS FROM THE MANIFEST
 #=================================================
 
-app=$YNH_APP_INSTANCE_NAME
-
 domain=$YNH_APP_ARG_DOMAIN
 path_url=$YNH_APP_ARG_PATH
 is_public=$YNH_APP_ARG_IS_PUBLIC
 password=$YNH_APP_ARG_PASSWORD
 
+app=$YNH_APP_INSTANCE_NAME
+
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
@@ -60,9 +59,7 @@ ynh_app_setting_set --app=$app --key=password --value=$password
 ynh_script_progression --message="Finding an available port..." --weight=2
 
 # Find an available port
-port="5984"
+port=$(ynh_find_port --port=5984)
-# NOTE: ideally, it would be nice to make sure that port 5984 is not taken, but if doing so, something should be done on couchdb install to customize the port it uses
-# port=$(ynh_find_port --port=5984)
 ynh_app_setting_set --app=$app --key=port --value=$port
 
 #=================================================
@@ -111,6 +108,10 @@ ynh_script_progression --message="Customizing couchdb config..." --weight=2
 # customize a bit the couch config
 ynh_add_config --template="../conf/couch_ynh.ini" --destination="$final_path/etc/local.d/couch_ynh.ini"
 
+chmod 750 "$final_path"
+chmod -R o-rwx "$final_path"
+chown -R $app:$app "$final_path"
+
 #=================================================
 # SETUP LOGROTATE
 #=================================================

scripts/restore

@@ -15,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
@@ -100,6 +99,10 @@ apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 8756C4F765C9AC3CB6B85D6
 ynh_install_extra_app_dependencies --repo="https://apache.bintray.com/couchdb-deb buster main" --package="couchdb"
 # ynh_install_extra_app_dependencies --repo="https://apache.bintray.com/couchdb-deb buster main" --package="couchdb" --key="https://apache.bintray.com/couchdb-deb/dists/buster/Release.gpg"
 
+chmod 750 "$final_path"
+chmod -R o-rwx "$final_path"
+chown -R $app:$app "$final_path"
+
 #=================================================
 # INTEGRATE SERVICE IN YUNOHOST
 #=================================================
@@ -110,6 +113,7 @@ yunohost service add $app --description="Open-source document-oriented NoSQL dat
 #=================================================
 # RESTORE THE LOGROTATE CONFIGURATION
 #=================================================
+ynh_script_progression --message="Restoring the logrotate configuration..."
 
 ynh_restore_file --origin_path="/etc/logrotate.d/$app"
 

scripts/upgrade

@@ -20,44 +20,15 @@ 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)
 port=$(ynh_app_setting_get --app=$app --key=port)
+password=$(ynh_app_setting_get --app=$app --key=password)
 
 #=================================================
 # 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
-#=================================================
-ynh_script_progression --message="Ensuring downward compatibility..." --weight=4
-
-### If nobody installed your app before 4.1,
-### then you may safely remove these lines
-
-# Cleaning legacy permissions
-if ynh_legacy_permissions_exists; then
-	ynh_legacy_permissions_delete_all
-
-	ynh_app_setting_delete --app=$app --key=is_public
-fi
-
-if ! ynh_permission_exists --permission="admin"; then
-	# Create the required permissions
-	ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin
-fi
-
-# Create a permission if needed
-if ! ynh_permission_exists --permission="api"; then
-	ynh_permission_create --permission="api" --url "/api" --allowed="visitors" --show_tile="false" --protected="true"
-fi
-
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
@@ -74,6 +45,20 @@ ynh_abort_if_errors
 
 #=================================================
 # STANDARD UPGRADE STEPS
+#=================================================
+# ENSURE DOWNWARD COMPATIBILITY
+#=================================================
+ynh_script_progression --message="Ensuring downward compatibility..." --weight=4
+
+# Cleaning legacy permissions
+if ynh_legacy_permissions_exists; then
+	ynh_legacy_permissions_delete_all
+
+	ynh_app_setting_delete --app=$app --key=is_public
+fi
+
+ynh_permission_url --permission="main" --url="/_utils/index.html" --add_url="/" --auth_header=false
+
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
@@ -87,7 +72,41 @@ ynh_add_nginx_config
 #=================================================
 ynh_script_progression --message="Upgrading dependencies..." --weight=15
 
-ynh_install_app_dependencies $pkg_dependencies couchdb
+ynh_install_app_dependencies $pkg_dependencies
+
+#=================================================
+# SPECIFIC UPGRADE
+#=================================================
+# UPGRADING COUCHDB
+#=================================================
+ynh_script_progression --message="Upgrading couchdb..." --weight=60
+
+COUCHDB_PASSWORD=$password
+echo "couchdb couchdb/mode select standalone
+couchdb couchdb/mode seen true
+couchdb couchdb/bindaddress string 127.0.0.1
+couchdb couchdb/bindaddress seen true
+couchdb couchdb/adminpass password ${COUCHDB_PASSWORD}
+couchdb couchdb/adminpass seen true
+couchdb couchdb/adminpass_again password ${COUCHDB_PASSWORD}
+couchdb couchdb/adminpass_again seen true" | debconf-set-selections
+DEBIAN_FRONTEND=noninteractive # apt-get install -y --force-yes couchdb
+
+apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 8756C4F765C9AC3CB6B85D62379CE192D401AB61
+
+ynh_install_extra_app_dependencies --repo="https://apache.bintray.com/couchdb-deb buster main" --package="couchdb"
+# ynh_install_extra_app_dependencies --repo="https://apache.bintray.com/couchdb-deb buster main" --package="couchdb" --key="https://apache.bintray.com/couchdb-deb/dists/buster/Release.gpg"
+
+#=================================================
+# UPDATE A CONFIG FILE
+#=================================================
+ynh_script_progression --message="Updating a configuration file..."
+
+ynh_add_config --template="../conf/couch_ynh.ini" --destination="$final_path/etc/local.d/couch_ynh.ini"
+
+chmod 750 "$final_path"
+chmod -R o-rwx "$final_path"
+chown -R $app:$app "$final_path"
 
 #=================================================
 # GENERIC FINALIZATION