Merge pull request #27 from YunoHost-Apps/simpler_testing

Simpler testing
2024-09-03 20:36:27 +02:00 · 2024-06-21 10:37:10 +02:00 · 2024-06-21 10:37:10 +02:00 · 48f03e590c
commit 48f03e590c
parent 182f0bafac 27fed044cc
9 changed files with 162 additions and 268 deletions
--- a/ALL_README.md
+++ b/ALL_README.md
@ -1,6 +1,8 @@
 # All available README files by language

 - [Read the README in English](README.md)
+- [Lea el README en español](README_es.md)
+- [Irakurri README euskaraz](README_eu.md)
 - [Lire le README en français](README_fr.md)
 - [Le o README en galego](README_gl.md)
- [Leggi il “README” in italiano](README_it.md)
+- [阅读中文（简体）的 README](README_zh_Hans.md)
--- a/README.md
+++ b/README.md
@ -9,7 +9,7 @@ It shall NOT be edited by hand.

 [![Install ifconfig-io with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ifconfig-io)

-*[Read this README is other languages.](./ALL_README.md)*
+*[Read this README in other languages.](./ALL_README.md)*

 > *This package allows you to install ifconfig-io 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.*
--- a/README_es.md
+++ b/README_es.md
@ -0,0 +1,50 @@
+<!--
+Este archivo README esta generado automaticamente<https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
+No se debe editar a mano.
+-->
+
+# ifconfig-io para Yunohost
+
+[![Nivel de integración](https://dash.yunohost.org/integration/ifconfig-io.svg)](https://dash.yunohost.org/appci/app/ifconfig-io) ![Estado funcional](https://ci-apps.yunohost.org/ci/badges/ifconfig-io.status.svg) ![Estado En Mantención](https://ci-apps.yunohost.org/ci/badges/ifconfig-io.maintain.svg)
+
+[![Instalar ifconfig-io con Yunhost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ifconfig-io)
+
+*[Leer este README en otros idiomas.](./ALL_README.md)*
+
+> *Este paquete le permite instalarifconfig-io rapidamente y simplement en un servidor YunoHost.*  
+> *Si no tiene YunoHost, visita [the guide](https://yunohost.org/install) para aprender como instalarla.*
+
+## Descripción general
+
+Inspired by ifconfig.me, but designed for pure speed. A single server can do 18,000 requests per seconds while only consuming 50megs of ram.
+
+I used the gin framework as it does several things to ensure that there are no memory allocations on each request, keeping the GC happy and preventing unnessary allocations.
+
+Tested to handle 15,000 requests persecond on modest hardware with an average response time of 130ms.
+
+
+**Versión actual:** 2024.01.06~ynh1
+
+**Demo:** <https://ifconfig.io>
+## Documentaciones y recursos
+
+- Sitio web oficial: <https://ifconfig.io/>
+- Documentación usuario oficial: <https://github.com/georgyo/ifconfig.io/>
+- Documentación administrador oficial: <https://github.com/georgyo/ifconfig.io/>
+- Repositorio del código fuente oficial de la aplicación : <https://github.com/georgyo/ifconfig.io/>
+- Catálogo YunoHost: <https://apps.yunohost.org/app/ifconfig-io>
+- Reportar un error: <https://github.com/YunoHost-Apps/ifconfig-io_ynh/issues>
+
+## Información para desarrolladores
+
+Por favor enviar sus correcciones a la [`branch testing`](https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing
+
+Para probar la rama `testing`, sigue asÍ:
+
+```bash
+sudo yunohost app install https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing --debug
+o
+sudo yunohost app upgrade ifconfig-io -u https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing --debug
+```
+
+**Mas informaciones sobre el empaquetado de aplicaciones:** <https://yunohost.org/packaging_apps>
--- a/README_eu.md
+++ b/README_eu.md
@ -0,0 +1,50 @@
+<!--
+Ohart ongi: README hau automatikoki sortu da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>ri esker
+EZ editatu eskuz.
+-->
+
+# ifconfig-io YunoHost-erako
+
+[![Integrazio maila](https://dash.yunohost.org/integration/ifconfig-io.svg)](https://dash.yunohost.org/appci/app/ifconfig-io) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/ifconfig-io.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/ifconfig-io.maintain.svg)
+
+[![Instalatu ifconfig-io YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ifconfig-io)
+
+*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)*
+
+> *Pakete honek ifconfig-io YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.*  
+> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.*
+
+## Aurreikuspena
+
+Inspired by ifconfig.me, but designed for pure speed. A single server can do 18,000 requests per seconds while only consuming 50megs of ram.
+
+I used the gin framework as it does several things to ensure that there are no memory allocations on each request, keeping the GC happy and preventing unnessary allocations.
+
+Tested to handle 15,000 requests persecond on modest hardware with an average response time of 130ms.
+
+
+**Paketatutako bertsioa:** 2024.01.06~ynh1
+
+**Demoa:** <https://ifconfig.io>
+## Dokumentazioa eta baliabideak
+
+- Aplikazioaren webgune ofiziala: <https://ifconfig.io/>
+- Erabiltzaileen dokumentazio ofiziala: <https://github.com/georgyo/ifconfig.io/>
+- Administratzaileen dokumentazio ofiziala: <https://github.com/georgyo/ifconfig.io/>
+- Jatorrizko aplikazioaren kode-gordailua: <https://github.com/georgyo/ifconfig.io/>
+- YunoHost Denda: <https://apps.yunohost.org/app/ifconfig-io>
+- Eman errore baten berri: <https://github.com/YunoHost-Apps/ifconfig-io_ynh/issues>
+
+## Garatzaileentzako informazioa
+
+Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing).
+
+`testing` abarra probatzeko, ondorengoa egin:
+
+```bash
+sudo yunohost app install https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing --debug
+edo
+sudo yunohost app upgrade ifconfig-io -u https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing --debug
+```
+
+**Informazio gehiago aplikazioaren paketatzeari buruz:** <https://yunohost.org/packaging_apps>
--- a/README_zh_Hans.md
+++ b/README_zh_Hans.md
@ -0,0 +1,50 @@
+<!--
+注意：此 README 由 <https://github.com/YunoHost/apps/tree/master/tools/readme_generator> 自动生成
+请勿手动编辑。
+-->
+
+# YunoHost 上的 ifconfig-io
+
+[![集成程度](https://dash.yunohost.org/integration/ifconfig-io.svg)](https://dash.yunohost.org/appci/app/ifconfig-io) ![工作状态](https://ci-apps.yunohost.org/ci/badges/ifconfig-io.status.svg) ![维护状态](https://ci-apps.yunohost.org/ci/badges/ifconfig-io.maintain.svg)
+
+[![使用 YunoHost 安装 ifconfig-io](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ifconfig-io)
+
+*[阅读此 README 的其它语言版本。](./ALL_README.md)*
+
+> *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 ifconfig-io。*  
+> *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。*
+
+## 概况
+
+Inspired by ifconfig.me, but designed for pure speed. A single server can do 18,000 requests per seconds while only consuming 50megs of ram.
+
+I used the gin framework as it does several things to ensure that there are no memory allocations on each request, keeping the GC happy and preventing unnessary allocations.
+
+Tested to handle 15,000 requests persecond on modest hardware with an average response time of 130ms.
+
+
+**分发版本：** 2024.01.06~ynh1
+
+**演示：** <https://ifconfig.io>
+## 文档与资源
+
+- 官方应用网站： <https://ifconfig.io/>
+- 官方用户文档： <https://github.com/georgyo/ifconfig.io/>
+- 官方管理文档： <https://github.com/georgyo/ifconfig.io/>
+- 上游应用代码库： <https://github.com/georgyo/ifconfig.io/>
+- YunoHost 商店： <https://apps.yunohost.org/app/ifconfig-io>
+- 报告 bug： <https://github.com/YunoHost-Apps/ifconfig-io_ynh/issues>
+
+## 开发者信息
+
+请向 [`testing` 分支](https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing) 发送拉取请求。
+
+如要尝试 `testing` 分支，请这样操作：
+
+```bash
+sudo yunohost app install https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing --debug
+或
+sudo yunohost app upgrade ifconfig-io -u https://github.com/YunoHost-Apps/ifconfig-io_ynh/tree/testing --debug
+```
+
+**有关应用打包的更多信息：** <https://yunohost.org/packaging_apps>
--- a/manifest.toml
+++ b/manifest.toml
@ -2,7 +2,8 @@ packaging_format = 2

 id = "ifconfig-io"
 name = "ifconfig-io"
-description.en = "IP API service to get their public IP address."
+description.en = "IP API service to get their public IP address"
+description.fr = "Service API IP pour obtenir leur adresse IP publique"

 version = "2024.01.06~ynh1"

@ -17,7 +18,7 @@ userdoc = "https://github.com/georgyo/ifconfig.io/"
 code = "https://github.com/georgyo/ifconfig.io/"

 [integration]
-yunohost = ">= 11.2"
+yunohost = ">= 11.2.12"
 architectures = "all"
 multi_instance = true

--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@ -1,250 +1,3 @@
 #!/bin/bash

 GO_VERSION="1.19"
-
-ynh_go_try_bash_extension() {
-  if [ -x src/configure ]; then
-    src/configure && make -C src || {
-      ynh_print_info --message="Optional bash extension failed to build, but things will still work normally."
-    }
-  fi
-}
-
-goenv_install_dir="/opt/goenv"
-go_version_path="$goenv_install_dir/versions"
-# goenv_ROOT is the directory of goenv, it needs to be loaded as a environment variable.
-export GOENV_ROOT="$goenv_install_dir"
-
-# Load the version of Go for an app, and set variables.
-#
-# ynh_use_go has to be used in any app scripts before using Go for the first time.
-# This helper will provide alias and variables to use in your scripts.
-#
-# To use gem or Go, use the alias `ynh_gem` and `ynh_go`
-# Those alias will use the correct version installed for the app
-# For example: use `ynh_gem install` instead of `gem install`
-#
-# With `sudo` or `ynh_exec_as`, use instead the fallback variables `$ynh_gem` and `$ynh_go`
-# And propagate $PATH to sudo with $ynh_go_load_path
-# Exemple: `ynh_exec_as $app $ynh_go_load_path $ynh_gem install`
-#
-# $PATH contains the path of the requested version of Go.
-# However, $PATH is duplicated into $go_path to outlast any manipulation of $PATH
-# You can use the variable `$ynh_go_load_path` to quickly load your Go version
-#  in $PATH for an usage into a separate script.
-# Exemple: $ynh_go_load_path $install_dir/script_that_use_gem.sh`
-#
-#
-# Finally, to start a Go service with the correct version, 2 solutions
-#  Either the app is dependent of Go or gem, but does not called it directly.
-#  In such situation, you need to load PATH
-#    `Environment="__YNH_GO_LOAD_PATH__"`
-#    `ExecStart=__FINALPATH__/my_app`
-#     You will replace __YNH_GO_LOAD_PATH__ with $ynh_go_load_path
-#
-#  Or Go start the app directly, then you don't need to load the PATH variable
-#    `ExecStart=__YNH_GO__ my_app run`
-#     You will replace __YNH_GO__ with $ynh_go
-#
-#
-# one other variable is also available
-#   - $go_path: The absolute path to Go binaries for the chosen version.
-#
-# usage: ynh_use_go
-#
-# Requires YunoHost version 3.2.2 or higher.
-ynh_use_go () {
-    go_version=$(ynh_app_setting_get --app=$app --key=go_version)
-
-    # Get the absolute path of this version of Go
-    go_path="$go_version_path/$go_version/bin"
-
-    # Allow alias to be used into bash script
-    shopt -s expand_aliases
-
-    # Create an alias for the specific version of Go and a variable as fallback
-    ynh_go="$go_path/go"
-    alias ynh_go="$ynh_go"
-
-    # Load the path of this version of Go in $PATH
-    if [[ :$PATH: != *":$go_path"* ]]; then
-        PATH="$go_path:$PATH"
-    fi
-    # Create an alias to easily load the PATH
-    ynh_go_load_path="PATH=$PATH"
-
-    # Sets the local application-specific Go version
-    pushd $install_dir
-        $goenv_install_dir/bin/goenv local $go_version
-    popd
-}
-
-# Install a specific version of Go
-#
-# ynh_install_go will install the version of Go provided as argument by using goenv.
-#
-# This helper creates a /etc/profile.d/goenv.sh that configures PATH environment for goenv
-# for every LOGIN user, hence your user must have a defined shell (as opposed to /usr/sbin/nologin)
-#
-# Don't forget to execute go-dependent command in a login environment
-# (e.g. sudo --login option)
-# When not possible (e.g. in systemd service definition), please use direct path
-# to goenv shims (e.g. $goenv_ROOT/shims/bundle)
-#
-# usage: ynh_install_go --go_version=go_version
-# | arg: -v, --go_version= - Version of go to install.
-#
-# Requires YunoHost version 3.2.2 or higher.
-ynh_install_go () {
-    # Declare an array to define the options of this helper.
-    local legacy_args=v
-    local -A args_array=( [v]=go_version= )
-    local go_version
-    # Manage arguments with getopts
-    ynh_handle_getopts_args "$@"
-
-    # Load goenv path in PATH
-    local CLEAR_PATH="$goenv_install_dir/bin:$PATH"
-
-    # Remove /usr/local/bin in PATH in case of Go prior installation
-    PATH=$(echo $CLEAR_PATH | sed 's@/usr/local/bin:@@')
-
-    # Move an existing Go binary, to avoid to block goenv
-    test -x /usr/bin/go && mv /usr/bin/go /usr/bin/go_goenv
-
-    # Install or update goenv
-    goenv="$(command -v goenv $goenv_install_dir/bin/goenv | head -1)"
-    if [ -n "$goenv" ]; then
-        ynh_print_info --message="goenv already seems installed in \`$goenv'."
-        pushd "${goenv%/*/*}"
-            if git remote -v 2>/dev/null | grep "https://github.com/syndbg/goenv.git"; then
-                echo "Trying to update with git..."
-                git pull -q --tags origin master
-                cd ..
-                ynh_go_try_bash_extension
-            fi
-        popd
-    else
-        ynh_print_info --message="Installing goenv with git..."
-        mkdir -p $goenv_install_dir
-        pushd $goenv_install_dir
-            git init -q
-            git remote add -f -t master origin https://github.com/syndbg/goenv.git > /dev/null 2>&1
-            git checkout -q -b master origin/master
-            ynh_go_try_bash_extension
-            goenv=$goenv_install_dir/bin/goenv
-        popd
-    fi
-
-    goenv_latest="$(command -v "$goenv_install_dir"/plugins/*/bin/goenv-latest goenv-latest | head -1)"
-    if [ -n "$goenv_latest" ]; then
-        ynh_print_info --message="\`goenv latest' command already available in \`$goenv_latest'."
-        pushd "${goenv_latest%/*/*}"
-            if git remote -v 2>/dev/null | grep "https://github.com/momo-lab/xxenv-latest.git"; then
-                ynh_print_info --message="Trying to update xxenv-latest with git..."
-                git pull -q origin master
-            fi
-        popd
-    else
-        ynh_print_info --message="Installing xxenv-latest with git..."
-        mkdir -p "${goenv_install_dir}/plugins"
-        git clone -q https://github.com/momo-lab/xxenv-latest.git "${goenv_install_dir}/plugins/xxenv-latest"
-    fi
-
-    # Enable caching
-    mkdir -p "${goenv_install_dir}/cache"
-
-    # Create shims directory if needed
-    mkdir -p "${goenv_install_dir}/shims"
-
-    # Restore /usr/local/bin in PATH
-    PATH=$CLEAR_PATH
-
-    # And replace the old Go binary
-    test -x /usr/bin/go_goenv && mv /usr/bin/go_goenv /usr/bin/go
-
-    # Install the requested version of Go
-    local final_go_version=$(goenv latest --print $go_version)
-    ynh_print_info --message="Installation of Go-$final_go_version"
-    goenv install --skip-existing $final_go_version
-
-    # Store go_version into the config of this app
-    ynh_app_setting_set --app=$YNH_APP_INSTANCE_NAME --key=go_version --value=$final_go_version
-
-    # Cleanup Go versions
-    ynh_cleanup_go
-
-    # Set environment for Go users
-    echo  "#goenv
-export GOENV_ROOT=$goenv_install_dir
-export PATH=\"$goenv_install_dir/bin:$PATH\"
-eval \"\$(goenv init -)\"
-#goenv" > /etc/profile.d/goenv.sh
-
-    # Load the environment
-    eval "$(goenv init -)"
-}
-
-# Remove the version of Go used by the app.
-#
-# This helper will also cleanup Go versions
-#
-# usage: ynh_remove_go
-ynh_remove_go () {
-    local go_version=$(ynh_app_setting_get --app=$YNH_APP_INSTANCE_NAME --key=go_version)
-
-    # Load goenv path in PATH
-    local CLEAR_PATH="$goenv_install_dir/bin:$PATH"
-
-    # Remove /usr/local/bin in PATH in case of Go prior installation
-    PATH=$(echo $CLEAR_PATH | sed 's@/usr/local/bin:@@')
-
-    # Remove the line for this app
-    ynh_app_setting_delete --app=$YNH_APP_INSTANCE_NAME --key=go_version
-
-    # Cleanup Go versions
-    ynh_cleanup_go
-}
-
-# Remove no more needed versions of Go used by the app.
-#
-# This helper will check what Go version are no more required,
-# and uninstall them
-# If no app uses Go, goenv will be also removed.
-#
-# usage: ynh_cleanup_go
-ynh_cleanup_go () {
-
-    # List required Go versions
-    local installed_apps=$(yunohost app list --output-as json --quiet | jq -r .apps[].id)
-    local required_go_versions=""
-    for installed_app in $installed_apps
-    do
-        local installed_app_go_version=$(ynh_app_setting_get --app=$installed_app --key="go_version")
-        if [[ $installed_app_go_version ]]
-        then
-            required_go_versions="${installed_app_go_version}\n${required_go_versions}"
-        fi
-    done
-    
-    # Remove no more needed Go versions
-    local installed_go_versions=$(goenv versions --bare --skip-aliases | grep -Ev '/')
-    for installed_go_version in $installed_go_versions
-    do
-        if ! `echo ${required_go_versions} | grep "${installed_go_version}" 1>/dev/null 2>&1`
-        then
-            ynh_print_info --message="Removing of Go-$installed_go_version"
-            $goenv_install_dir/bin/goenv uninstall --force $installed_go_version
-        fi
-    done
-
-    # If none Go version is required
-    if [[ ! $required_go_versions ]]
-    then
-        # Remove goenv environment configuration
-        ynh_print_info --message="Removing of goenv"
-        ynh_secure_remove --file="$goenv_install_dir"
-        ynh_secure_remove --file="/etc/profile.d/goenv.sh"
-    fi
-}
-
--- a/scripts/backup
+++ b/scripts/backup
@ -21,21 +21,13 @@ ynh_print_info --message="Declaring files to be backed up..."
 ynh_backup --src_path="$install_dir"

 #=================================================
-# BACKUP THE NGINX CONFIGURATION
+# SYSTEM CONFIGURATION
 #=================================================

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

-#=================================================
-# BACKUP LOGROTATE
-#=================================================
-
 ynh_backup --src_path="/etc/logrotate.d/$app"

-#=================================================
-# BACKUP SYSTEMD
-#=================================================
-
 ynh_backup --src_path="/etc/systemd/system/$app.service"

 #=================================================
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -3,7 +3,7 @@
 source _common.sh
 source /usr/share/yunohost/helpers

-upgrade_type=$(ynh_check_app_version_changed)
+app_path="$install_dir/go/src/github.com/georgyo/ifconfig.io"

 #=================================================
 # UPGRADE DEPENDENCIES
@ -24,13 +24,9 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
+ynh_script_progression --message="Upgrading source files..." --weight=1

-if [ "$upgrade_type" == "UPGRADE_APP" ]
-then
-	ynh_script_progression --message="Upgrading source files..." --weight=1
-
-	ynh_setup_source --dest_dir="$install_dir"
-fi
+ynh_setup_source --dest_dir="$app_path" --full_replace=1

 chmod -R o-rwx "$install_dir"
 chown -R $app:www-data "$install_dir"
@ -45,7 +41,7 @@ export GOPATH="$install_dir/go"
 export GOCACHE="$install_dir/go/.cache"
 export GO111MODULE=on

-pushd "$install_dir"
+pushd "$app_path"
    ynh_exec_warn_less $ynh_go mod download
    ynh_exec_warn_less $ynh_go build -tags=jsoniter
 popd