From 090ea2d61f706882f446b88f34246907abf83a1d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Thu, 18 Jan 2024 10:42:33 +0100 Subject: [PATCH] Packaging v2 --- .github/workflows/updater.sh | 122 ---------------------- .github/workflows/updater.yml | 49 --------- check_process | 26 ----- conf/app.src | 6 -- conf/nginx.conf | 16 +-- doc/DESCRIPTION.md | 3 + doc/DISCLAIMER.md | 3 - manifest.json | 65 ------------ manifest.toml | 70 +++++++++++++ scripts/_common.sh | 27 ++++- scripts/backup | 26 +---- scripts/change_url | 101 ++----------------- scripts/install | 124 +++++------------------ scripts/remove | 42 +------- scripts/restore | 67 ++----------- scripts/upgrade | 156 +++++++---------------------- sources/extra_files/app/.gitignore | 2 - sources/patches/.gitignore | 2 - tests.toml | 11 ++ 19 files changed, 198 insertions(+), 720 deletions(-) delete mode 100644 .github/workflows/updater.sh delete mode 100644 .github/workflows/updater.yml delete mode 100644 check_process delete mode 100644 conf/app.src create mode 100644 doc/DESCRIPTION.md delete mode 100644 doc/DISCLAIMER.md delete mode 100644 manifest.json create mode 100644 manifest.toml delete mode 100644 sources/extra_files/app/.gitignore delete mode 100644 sources/patches/.gitignore create mode 100644 tests.toml diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh deleted file mode 100644 index cc18f85..0000000 --- a/.github/workflows/updater.sh +++ /dev/null @@ -1,122 +0,0 @@ -#!/bin/bash - -#================================================= -# PACKAGE UPDATING HELPER -#================================================= - -# This script is meant to be run by GitHub Actions -# The YunoHost-Apps organisation offers a template Action to run this script periodically -# Since each app is different, maintainers can adapt its contents so as to perform -# automatic actions when a new upstream release is detected. - -#================================================= -# FETCHING LATEST RELEASE AND ITS ASSETS -#================================================= - -# Fetching information -current_version=$(cat manifest.json | jq -j '.version|split("~")[0]') -current_ynh_version=$(cat manifest.json | jq -j '.version|split("~ynh")[1]') -current_commit=$(cat scripts/_common.sh | awk -F= '/^COMMIT/ { print $2 }') -repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]') - -page=0 -tag_version="" -while [ -z $tag_version ] -do - let page++ - tag_version=$(curl --silent "https://api.github.com/repos/$repo/tags?per_page=100&page=$page" | jq -r '.[] | .name' | grep -v "alpha" | grep "@standardnotes/web@" | sort -V | tail -1) - -done - -version=$(curl --silent "https://raw.githubusercontent.com/$repo/$tag_version/packages/web/package.json" | jq -j '.version') -asset="https://github.com/$repo/archive/refs/tags/$tag_version.tar.gz" -commit=$(curl --silent "https://api.github.com/repos/$repo/tags?per_page=100&page=$page" | jq -r '[ .[] | select(.name=="'$tag_version'").commit.sha ] | join(" ") | @sh' | tr -d "'") - -# Later down the script, we assume the version has only digits and dots -# Sometimes the release name starts with a "v", so let's filter it out. -# You may need more tweaks here if the upstream repository has different naming conventions. -#if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then -# version=${version:1} -#fi - -# Setting up the environment variables -echo "Current version: $current_version" -echo "Current ynh version: $current_ynh_version" -echo "Current commit: $current_commit" -echo "Latest tag version from upstream: $tag_version" -echo "Latest version from upstream: $version" - -echo "VERSION=$version" >> $GITHUB_ENV -echo "YNH_VERSION=$current_ynh_version" >> $GITHUB_ENV -echo "TAG_VERSION=$tag_version" >> $GITHUB_ENV -# For the time being, let's assume the script will fail -echo "PROCEED=false" >> $GITHUB_ENV - -# Proceed only if the retrieved version is greater than the current one -if [[ ${current_commit:1:-1} == $commit ]] ; then - echo "::warning ::No new version available" - exit 0 -# Proceed only if a PR for this new version does not already exist -elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version-tag$tag_version ; then - echo "::warning ::A branch already exists for this update" - exit 0 -fi - -#================================================= -# UPDATE SOURCE FILES -#================================================= - -# Create the temporary directory -tempdir="$(mktemp -d)" - -# Download sources and calculate checksum -filename=${asset##*/} -curl --silent -4 -L $asset -o "$tempdir/$filename" -checksum=$(sha256sum "$tempdir/$filename" | head -c 64) - -# Delete temporary directory -rm -rf $tempdir - -# Get extension -if [[ $filename == *.tar.gz ]]; then - extension=tar.gz -else - extension=${filename##*.} -fi - -# Rewrite source file -cat < conf/app.src -SOURCE_URL=$asset -SOURCE_SUM=$checksum -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=$extension -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -EOT -echo "... conf/app.src updated" - -#================================================= -# SPECIFIC UPDATE STEPS -#================================================= - -# Any action on the app's source code can be done. -# The GitHub Action workflow takes care of committing all changes after this script ends. - -#================================================= -# GENERIC FINALIZATION -#================================================= - -if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then - new_version="$version~ynh$((current_ynh_version+1))" -else - new_version="$version~ynh1" -fi - -# Replace new version in manifest -echo "$(jq -s --indent 4 ".[] | .version = \"$new_version\"" manifest.json)" > manifest.json - -# No need to update the README, yunohost-bot takes care of it - -# The Action will proceed only if the PROCEED environment variable is set to true -echo "PROCEED=true" >> $GITHUB_ENV -exit 0 diff --git a/.github/workflows/updater.yml b/.github/workflows/updater.yml deleted file mode 100644 index d89ec8c..0000000 --- a/.github/workflows/updater.yml +++ /dev/null @@ -1,49 +0,0 @@ -# This workflow allows GitHub Actions to automagically update your app whenever a new upstream release is detected. -# You need to enable Actions in your repository settings, and fetch this Action from the YunoHost-Apps organization. -# This file should be enough by itself, but feel free to tune it to your needs. -# It calls updater.sh, which is where you should put the app-specific update steps. -name: Check for new upstream releases -on: - # Allow to manually trigger the workflow - workflow_dispatch: - # Run it every monday at 6:00 UTC - schedule: - - cron: '0 6 * * 1' -jobs: - updater: - runs-on: ubuntu-latest - steps: - - name: Fetch the source code - uses: actions/checkout@v3 - with: - token: ${{ secrets.GITHUB_TOKEN }} - - name: Run the updater script - id: run_updater - run: | - # Setting up Git user - git config --global user.name 'yunohost-bot' - git config --global user.email 'yunohost-bot@users.noreply.github.com' - # Run the updater script - /bin/bash .github/workflows/updater.sh - - name: Commit changes - id: commit - if: ${{ env.PROCEED == 'true' }} - run: | - git commit -am "Upgrade to version $VERSION" - - name: Create Pull Request - id: cpr - if: ${{ env.PROCEED == 'true' }} - uses: peter-evans/create-pull-request@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - commit-message: 'Update: Update to version ${{ env.VERSION }}' - committer: 'yunohost-bot ' - author: 'yunohost-bot ' - signoff: false - base: testing - branch: ci-auto-update-v${{ env.VERSION }} - delete-branch: true - title: 'Upgrade to version ${{ env.VERSION }}' - body: | - Upgrade to version ${{ env.VERSION }} - draft: false diff --git a/check_process b/check_process deleted file mode 100644 index f0f1e3c..0000000 --- a/check_process +++ /dev/null @@ -1,26 +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 - # 3.142.8~ynh1 - upgrade=1 from_commit=e9473769cf6a0ef8ab9ea0a0f640b7569ea87d3c - backup_restore=1 - multi_instance=1 - port_already_use=0 - change_url=1 -;;; Options -Email= -Notification=none -;;; Upgrade options - ; commit=e9473769cf6a0ef8ab9ea0a0f640b7569ea87d3c - name=3.142.8~ynh1 - manifest_arg=domain=DOMAIN&is_public=1 diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index 6bc77fb..0000000 --- a/conf/app.src +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://github.com/standardnotes/app/archive/refs/tags/@standardnotes/web@3.160.8.tar.gz -SOURCE_SUM=cb6dee23103d91dc03dd62a1e19cf4582898295a41be6b20acbf4772fdb322d4 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/conf/nginx.conf b/conf/nginx.conf index 6bc0218..107ecaf 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,14 +1,14 @@ #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { - # Path to source - alias __FINALPATH__/live/packages/web/dist/ ; + # Path to source + alias __INSTALL_DIR__/live/packages/web/dist/ ; - # Redirects - sub_filter ' href="/' ' href="__PATH__/'; - sub_filter ' src="/' ' src="__PATH__/'; + # Redirects + sub_filter ' href="/' ' href="__PATH__/'; + sub_filter ' src="/' ' src="__PATH__/'; - # Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; - more_clear_input_headers 'Accept-Encoding'; + # Include SSOWAT user panel. + include conf.d/yunohost_panel.conf.inc; + more_clear_input_headers 'Accept-Encoding'; } diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..a3fa6e6 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1,3 @@ +Standard Notes is a free, secure note-taking app with powerful end-to-end encryption, unparalleled privacy features, and seamless cross-platform syncing on unlimited devices. + +This is the web app of Standard Notes. It requires a server, [installable on YunoHost](https://github.com/YunoHost-Apps/snserver_ynh). diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md deleted file mode 100644 index 08a9707..0000000 --- a/doc/DISCLAIMER.md +++ /dev/null @@ -1,3 +0,0 @@ -* No single-sign on or LDAP integration -* The app requires up 1500MB of RAM to install -* The app requires around 3600MB of disk. diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 9058154..0000000 --- a/manifest.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "name": "Standard Notes", - "id": "snweb", - "packaging_format": 1, - "description": { - "en": "End-to-end encrypted note-taking app", - "fr": "Application de prise de notes chiffrées" - }, - "version": "3.160.8~ynh1", - "url": "https://github.com/standardnotes/web", - "upstream": { - "license": "AGPL-3.0-or-later", - "website": "https://standardnotes.org/", - "demo": "https://standardnotes.org/demo", - "admindoc": "https://docs.standardnotes.org/", - "userdoc": "https://standardnotes.org/help", - "code": "https://github.com/standardnotes/app" - }, - "license": "AGPL-3.0-or-later", - "maintainer": { - "name": "Fabian Wilkens", - "email": "46000361+FabianWilkens@users.noreply.github.com" - }, - "requirements": { - "yunohost": ">= 11.2" - }, - "multi_instance": true, - "services": [ - "nginx" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/notes", - "default": "/", - "help": { - "en": "You can use extensions only without a path URL." - } - }, - { - "name": "is_public", - "type": "boolean", - "help": { - "en": "A public application means that anyone can access this site." - }, - "default": false - }, - { - "name": "snserver_domain", - "type": "string", - "ask": { - "en": "Choose the default Standard Notes Syncing Server", - "de": "Wähle den Standard Notes Syncing Server" - }, - "default": "api.standardnotes.com" - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..812344f --- /dev/null +++ b/manifest.toml @@ -0,0 +1,70 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "snweb" +name = "Standard Notes" +description.en = "End-to-end encrypted note-taking app" +description.fr = "Application de prise de notes chiffrées" + +version = "3.160.8~ynh1" + +maintainers = ["Fabian Wilkens"] + +[upstream] +license = "AGPL-3.0-or-later" +website = "https://standardnotes.org/" +demo = "https://standardnotes.org/demo" +admindoc = "https://docs.standardnotes.org/" +userdoc = "https://standardnotes.org/help" +code = "https://github.com/standardnotes/app" + +[integration] +yunohost = ">= 11.2" +architectures = "all" +multi_instance = true +ldap = false +sso = false +disk = "3600M" +ram.build = "1500M" +ram.runtime = "1500M" + +[install] + [install.domain] + type = "domain" + + [install.path] + help.en = "You can use extensions only without a path URL." + type = "path" + default = "/" + + [install.init_main_permission] + help.en = "A public application means that anyone can access this site." + type = "group" + default = false + + [install.snserver_domain] + ask.en = "Choose the default Standard Notes Syncing Server" + ask.de = "Wähle den Standard Notes Syncing Server" + type = "string" + default = "api.standardnotes.com" + +[resources] + [resources.sources.main] + url = "https://github.com/standardnotes/app/archive/refs/tags/@standardnotes/web@3.160.8.tar.gz" + sha256 = "cb6dee23103d91dc03dd62a1e19cf4582898295a41be6b20acbf4772fdb322d4" + + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" + + [resources.apt] + + [resources.apt.extras.yarn] + repo = "deb https://dl.yarnpkg.com/debian/ stable main" + key = "https://dl.yarnpkg.com/debian/pubkey.gpg" + packages = "yarn" diff --git a/scripts/_common.sh b/scripts/_common.sh index 960eb53..b9d10b1 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,16 +4,37 @@ # COMMON VARIABLES #================================================= -# dependencies used by the app -pkg_dependencies="" +NODEJS_VERSION="16" -NODEJS_VERSION="16.17.0" node_max_old_space_size=2048 #================================================= # PERSONAL HELPERS #================================================= +# Remove the version of Ruby used by the app. +# +# This helper will also cleanup Ruby versions +# +# usage: ynh_remove_ruby +ynh_remove_ruby () { + local ruby_version=$(ynh_app_setting_get --app="$YNH_APP_INSTANCE_NAME" --key=ruby_version) + + # Load rbenv path in PATH + local CLEAR_PATH="$rbenv_install_dir/bin:$PATH" + + # Remove /usr/local/bin in PATH in case of Ruby prior installation + PATH="$(echo "$CLEAR_PATH" | sed 's@/usr/local/bin:@@')" + + rbenv alias "$YNH_APP_INSTANCE_NAME" --remove + + # Remove the line for this app + ynh_app_setting_delete --app="$YNH_APP_INSTANCE_NAME" --key=ruby_version + + # Cleanup Ruby versions + ynh_cleanup_ruby +} + #================================================ # EXPERIMENTAL HELPERS #================================================= diff --git a/scripts/backup b/scripts/backup index 9b468a7..52eea5b 100755 --- a/scripts/backup +++ b/scripts/backup @@ -10,26 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - true -} -# 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 #================================================= @@ -39,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 @@ -47,10 +27,6 @@ ynh_backup --src_path="$final_path" ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# SPECIFIC BACKUP -#================================================= - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/change_url b/scripts/change_url index 82517c7..fa9c8dd 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,60 +9,6 @@ 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..." --weight=1 - -# Needed for helper "ynh_add_nginx_config" -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -snserver_domain=$(ynh_app_setting_get --app=$app --key=snserver_domain) - -#================================================= -# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # 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 #================================================= @@ -70,54 +16,21 @@ fi #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1 -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf - -# 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 +ynh_change_url_nginx_config #================================================= # SPECIFIC MODIFICATIONS #================================================= ynh_script_progression --message="Modify Configuration..." --weight=1 -if [ $change_path -eq 1 ] -then - cp "$final_path/live/packages/web/dist/app.js.orginal" "$final_path/live/packages/web/dist/app.js" - # If $new_path is used modify .js file for a working app on a subpath - if [ $new_path != "/" ] - then - ynh_replace_string --match_string="/components/" --replace_string="$new_path/components/" --target_file="$final_path/live/packages/web/dist/app.js" - fi +if [ $change_path -eq 1 ]; then + cp "$install_dir/live/packages/web/dist/app.js.orginal" "$install_dir/live/packages/web/dist/app.js" + # If $new_path is used modify .js file for a working app on a subpath + if [ $new_path != "/" ]; then + ynh_replace_string --match_string="/components/" --replace_string="$new_path/components/" --target_file="$install_dir/live/packages/web/dist/app.js" + fi fi -#================================================= -# GENERIC FINALISATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/install b/scripts/install index b2c894f..93ad60b 100644 --- a/scripts/install +++ b/scripts/install @@ -10,104 +10,45 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# INITIALIZE AND STORE SETTINGS #================================================= -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 -is_public=$YNH_APP_ARG_IS_PUBLIC -snserver_domain=$YNH_APP_ARG_SNSERVER_DOMAIN if [ -z "$snserver_domain" ]; then - snserver_domain="api.standardnotes.com" + snserver_domain="api.standardnotes.com" + ynh_app_setting_set --app="$app" --key=snserver_domain --value="$snserver_domain" fi -app=$YNH_APP_INSTANCE_NAME +#================================================= +# INSTALL NODEJS +#================================================= +ynh_script_progression --message="Installing NodeJS..." --weight=30 -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=2 - -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 -ynh_app_setting_set --app=$app --key=snserver_domain --value=$snserver_domain - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -#================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing dependencies..." --weight=30 - -ynh_install_app_dependencies $pkg_dependencies -ynh_install_nodejs --nodejs_version=$NODEJS_VERSION -ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg" - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=1 - -# Create a system user -ynh_system_user_create --username=$app --home_dir=$final_path +ynh_install_nodejs --nodejs_version="$NODEJS_VERSION" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=16 -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/live" +ynh_setup_source --dest_dir="$install_dir/live" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring NGINX web server..." --weight=3 - -# Create a dedicated NGINX config -ynh_add_nginx_config - -#================================================= -# SPECIFIC SETUP -#================================================= -#================================================= -# BUILDING +# BUILDING #================================================= ynh_script_progression --message="Building... ( This may take a while... )" --weight=100 #497 -pushd "$final_path/live" +pushd "$install_dir/live" ynh_use_nodejs - ynh_exec_warn_less ynh_exec_as $app env NODE_OPTIONS="--max-old-space-size=$node_max_old_space_size" $ynh_node_load_PATH yarn install --immutable - ynh_exec_warn_less ynh_exec_as $app env NODE_OPTIONS="--max-old-space-size=$node_max_old_space_size" $ynh_node_load_PATH yarn build:web + ynh_exec_warn_less ynh_exec_as "$app" env NODE_OPTIONS="--max-old-space-size=$node_max_old_space_size" "$ynh_node_load_PATH" yarn install --immutable + ynh_exec_warn_less ynh_exec_as "$app" env NODE_OPTIONS="--max-old-space-size=$node_max_old_space_size" "$ynh_node_load_PATH" yarn build:web popd -chown -R $app:www-data "$final_path" + +chown -R "$app:www-data" "$install_dir" #================================================= # Modify Config @@ -115,14 +56,13 @@ chown -R $app:www-data "$final_path" ynh_script_progression --message="Configuring..." --weight=1 # If $path is used modify .js file for a working app on a subpath -cp "$final_path/live/packages/web/dist/app.js" "$final_path/live/packages/web/dist/app.js.orginal" -if [ $path_url != "/" ] -then - ynh_replace_string --match_string="/components/" --replace_string="$path_url/components/" --target_file="$final_path/live/packages/web/dist/app.js" +cp "$install_dir/live/packages/web/dist/app.js" "$install_dir/live/packages/web/dist/app.js.orginal" +if [ "$path" != "/" ]; then + ynh_replace_string --match_string="/components/" --replace_string="$path/components/" --target_file="$install_dir/live/packages/web/dist/app.js" fi # Modify Config -index_file="$final_path/live/packages/web/dist/index.html" +index_file="$install_dir/live/packages/web/dist/index.html" ynh_replace_string --match_string="\(defaultSyncServer = \).*" --replace_string="\1\"https://$snserver_domain\"" --target_file="$index_file" ynh_replace_string --match_string="\(defaultFilesHost = \).*" --replace_string="\1\"\"" --target_file="$index_file" ynh_replace_string --match_string="\(enabledUnfinishedFeatures = \).*" --replace_string="\1false" --target_file="$index_file" @@ -132,24 +72,12 @@ ynh_replace_string --match_string="\(plansUrl = \).*" --replace_string="\1\"\"" ynh_replace_string --match_string="\(dashboardUrl =\).*" --replace_string="\1\"\"" --target_file="$index_file" #================================================= -# SETUP SSOWAT +# SYSTEM CONFIGURATION #================================================= -ynh_script_progression --message="Configuring permissions..." --weight=2 +ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 -# Make app public if necessary -if [ $is_public -eq 1 ] -then - # Everyone can access the app. - # The "main" permission is automatically created before the install script. - ynh_permission_update --permission="main" --add="visitors" -fi - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=2 - -ynh_systemd_action --service_name=nginx --action=reload +# Create a dedicated NGINX config +ynh_add_nginx_config #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index 3a79b16..e8d77f3 100755 --- a/scripts/remove +++ b/scripts/remove @@ -7,38 +7,14 @@ #================================================= source _common.sh -source ynh_install_ruby__2 source /usr/share/yunohost/helpers #================================================= -# LOAD SETTINGS +# REMOVE NODEJS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +ynh_script_progression --message="Removing NodeJS..." --weight=4 -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 DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." --weight=4 - -# Remove metapackage and its dependencies ynh_remove_nodejs -ynh_remove_app_dependencies - -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --weight=2 - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" #================================================= # REMOVE NGINX CONFIGURATION @@ -48,20 +24,6 @@ ynh_script_progression --message="Removing NGINX web server configuration..." -- # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# SPECIFIC REMOVE -#================================================= - -#================================================= -# GENERIC FINALIZATION -#================================================= -# 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 9295585..8d7941a 100755 --- a/scripts/restore +++ b/scripts/restore @@ -11,76 +11,31 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# INSTALL NODEJS #================================================= +ynh_script_progression --message="Reinstalling NodeJS..." --weight=30 -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..." --weight=2 - -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 -#================================================= -# 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..." --weight=2 - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir=$final_path +ynh_install_nodejs --nodejs_version="$NODEJS_VERSION" #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=2 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" + +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" #================================================= -# SPECIFIC RESTORATION +# RESTORE SYSTEM CONFIGURATIONS #================================================= -# REINSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Reinstalling dependencies... ( This may take a while... )" --weight=100 #294 +ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 -# Define and install dependencies -ynh_install_app_dependencies $pkg_dependencies -ynh_install_nodejs --nodejs_version=$NODEJS_VERSION -ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg" +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# GENERIC FINALIZATION #================================================= # RELOAD NGINX #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index f7e866e..64f9a70 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -7,145 +7,62 @@ #================================================= source _common.sh -source ynh_install_ruby__2 source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=2 - -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) -snserver_domain=$(ynh_app_setting_get --app=$app --key=snserver_domain) - -#================================================= -# 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)..." --weight=69 - -# 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 - -#================================================= -# STANDARD UPGRADE STEPS -#================================================= #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public +if [ -z "${snserver_domain:-}" ]; then + snserver_domain="api.standardnotes.com" + ynh_app_setting_set --app="$app" --key=snserver_domain --value="$snserver_domain" fi -# 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 - -if [ -z "$snserver_domain" ]; then - snserver_domain="api.standardnotes.com" -fi - -if ynh_compare_current_package_version --comparison lt --version 3.66.0~ynh1 -then - # Remove old service +if ynh_compare_current_package_version --comparison lt --version 3.66.0~ynh1; then + # Remove old service ynh_script_progression --message="Removing $app service..." --weight=1 yunohost service remove "$app" + ynh_remove_systemd_config --service="$app" - # Remove the dedicated systemd config - ynh_script_progression --message="Stopping and removing the systemd service..." --weight=1 - ynh_remove_systemd_config --service="$app" - - # Remove unneeded ruby - ynh_remove_ruby - ynh_secure_remove --file="$final_path/.bundle" - ynh_secure_remove --file="$final_path/.ruby-version" + # Remove unneeded ruby + ynh_remove_ruby + ynh_secure_remove --file="$install_dir/.bundle" + ynh_secure_remove --file="$install_dir/.ruby-version" fi #================================================= -# CREATE DEDICATED USER +# INSTALL NODEJS #================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 +ynh_script_progression --message="Upgrading NodeJS..." --weight=30 -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir=$final_path +ynh_install_nodejs --nodejs_version="$NODEJS_VERSION" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= +ynh_script_progression --message="Upgrading source files..." --weight=17 -if [ "$upgrade_type" == "UPGRADE_APP" ] -then - ynh_script_progression --message="Upgrading source files..." --weight=17 - - ynh_secure_remove --file="$final_path/live" - - # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path/live" -fi +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source --dest_dir="$install_dir/live" --full_replace=1 # Set permissions to app files -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= -# NGINX CONFIGURATION +# BUILDING #================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=3 +ynh_script_progression --message="Building... ( This may take a while... )" --weight=100 #131 -# Create a dedicated NGINX config -ynh_add_nginx_config +pushd "$install_dir/live" + ynh_use_nodejs + ynh_exec_warn_less ynh_exec_as "$app" env NODE_OPTIONS="--max-old-space-size=$node_max_old_space_size" "$ynh_node_load_PATH" yarn install --immutable + ynh_exec_warn_less ynh_exec_as "$app" env NODE_OPTIONS="--max-old-space-size=$node_max_old_space_size" "$ynh_node_load_PATH" yarn build:web +popd$app:www-data -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=37 - -ynh_install_app_dependencies $pkg_dependencies -ynh_install_nodejs --nodejs_version=$NODEJS_VERSION -ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg" - -#================================================= -# SPECIFIC UPGRADE -#================================================= -#================================================= -# BUILDING -#================================================= - -if [ "$upgrade_type" == "UPGRADE_APP" ] -then - ynh_script_progression --message="Building... ( This may take a while... )" --weight=100 #131 - - pushd "$final_path/live" - ynh_use_nodejs - ynh_exec_warn_less ynh_exec_as $app env NODE_OPTIONS="--max-old-space-size=$node_max_old_space_size" $ynh_node_load_PATH yarn install --immutable - ynh_exec_warn_less ynh_exec_as $app env NODE_OPTIONS="--max-old-space-size=$node_max_old_space_size" $ynh_node_load_PATH yarn build:web - popd - chown -R $app:www-data "$final_path" -fi +chown -R "$app:www-data" "$install_dir" #================================================= # Modify Config @@ -153,14 +70,13 @@ fi ynh_script_progression --message="Configuring..." --weight=1 # If $path is used modify .js file for a working app on a subpath -cp "$final_path/live/packages/web/dist/app.js" "$final_path/live/packages/web/dist/app.js.orginal" -if [ $path_url != "/" ] -then - ynh_replace_string --match_string="/components/" --replace_string="$path_url/components/" --target_file="$final_path/live/packages/web/dist/app.js" +cp "$install_dir/live/packages/web/dist/app.js" "$install_dir/live/packages/web/dist/app.js.orginal" +if [ "$path" != "/" ]; then + ynh_replace_string --match_string="/components/" --replace_string="$path/components/" --target_file="$install_dir/live/packages/web/dist/app.js" fi # Modify Config -index_file="$final_path/live/packages/web/dist/index.html" +index_file="$install_dir/live/packages/web/dist/index.html" ynh_replace_string --match_string="\(defaultSyncServer = \).*" --replace_string="\1\"https://$snserver_domain\"" --target_file="$index_file" ynh_replace_string --match_string="\(defaultFilesHost = \).*" --replace_string="\1\"\"" --target_file="$index_file" ynh_replace_string --match_string="\(enabledUnfinishedFeatures = \).*" --replace_string="\1false" --target_file="$index_file" @@ -170,14 +86,12 @@ ynh_replace_string --match_string="\(plansUrl = \).*" --replace_string="\1\"\"" ynh_replace_string --match_string="\(dashboardUrl =\).*" --replace_string="\1\"\"" --target_file="$index_file" #================================================= -# GENERIC FINALIZATION +# REAPPLY SYSTEM CONFIGURATIONS #================================================= -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 +ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 -ynh_systemd_action --service_name=nginx --action=reload +# Create a dedicated NGINX config +ynh_add_nginx_config #================================================= # END OF SCRIPT diff --git a/sources/extra_files/app/.gitignore b/sources/extra_files/app/.gitignore deleted file mode 100644 index 783a4ae..0000000 --- a/sources/extra_files/app/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -*~ -*.sw[op] diff --git a/sources/patches/.gitignore b/sources/patches/.gitignore deleted file mode 100644 index 783a4ae..0000000 --- a/sources/patches/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -*~ -*.sw[op] diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..e5a8899 --- /dev/null +++ b/tests.toml @@ -0,0 +1,11 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json + +test_format = 1.0 + +[default] + + # ------------ + # Tests to run + # ------------ + + test_upgrade_from.e94737.name = "3.142.8~ynh1"