From 2baa6289316daa229d6d0c5269f296ced173f465 Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Sun, 19 Mar 2017 18:28:38 +0100 Subject: [PATCH] Reprise globale du package --- check_process | 9 +- manifest.json | 7 +- scripts/.fonctions | 564 ++++++++++++++++++++++++++++++++++----------- scripts/backup | 57 +++-- scripts/install | 193 ++++++++++------ scripts/remove | 44 ++-- scripts/restore | 103 ++++++--- scripts/upgrade | 63 ++++- 8 files changed, 751 insertions(+), 289 deletions(-) diff --git a/check_process b/check_process index 8510f1b..df25086 100644 --- a/check_process +++ b/check_process @@ -3,7 +3,7 @@ ; Manifest domain="domain.tld" (DOMAIN) path="/path" (PATH) - is_public="Yes" (PUBLIC|public=Yes|private=No) + is_public=1 (PUBLIC|public=1|private=0) ; Checks pkg_linter=1 setup_sub_dir=1 @@ -14,18 +14,15 @@ upgrade=1 backup_restore=1 multi_instance=0 - wrong_user=0 - wrong_path=1 incorrect_path=1 - corrupt_source=0 - fail_download_source=0 port_already_use=1 (8080) - final_path_already_use=0 ;;; Levels Level 1=auto Level 2=auto Level 3=auto +# Level 4: https://github.com/YunoHost-Apps/jenkins_ynh/blob/master/conf/config.xml#L11-L26 Level 4=1 +# Level 5: https://github.com/YunoHost-Apps/jenkins_ynh/issues/7 Level 5=1 Level 6=auto Level 7=auto diff --git a/manifest.json b/manifest.json index 2da4d23..d36bcfb 100644 --- a/manifest.json +++ b/manifest.json @@ -9,8 +9,9 @@ "en": "Extendable continuous integration server", "fr": "Serveur d'intégration continue extensible" }, + "version": "1.0", "url": "https://jenkins.io/index.html", - "license": "free", + "license": "MIT", "maintainer": { "name": "Julien Malik et Maniack Crudelis", "email": "maniackc_dev@crudelis.fr" @@ -42,12 +43,12 @@ }, { "name": "is_public", + "type": "boolean", "ask": { "en": "Is it a public site?", "fr": "Est-ce un site public ?" }, - "choices": ["Yes", "No"], - "default": "Yes" + "default": true } ] } diff --git a/scripts/.fonctions b/scripts/.fonctions index c18e8d3..2243dd2 100755 --- a/scripts/.fonctions +++ b/scripts/.fonctions @@ -1,103 +1,86 @@ #!/bin/bash -CHECK_VAR () { # Vérifie que la variable n'est pas vide. -# $1 = Variable à vérifier -# $2 = Texte à afficher en cas d'erreur - test -n "$1" || (echo "$2" >&2 && false) -} - -EXIT_PROPERLY () { # Provoque l'arrêt du script en cas d'erreur. Et nettoye les résidus. - exit_code=$? - if [ "$exit_code" -eq 0 ]; then - exit 0 # Quitte sans erreur si le script se termine correctement. - fi - trap '' EXIT - set +eu - echo -e "\e[91m \e[1m" # Shell in light red bold - echo -e "!!\n $app install's script has encountered an error. Installation was cancelled.\n!!" >&2 - - if type -t CLEAN_SETUP > /dev/null; then # Vérifie l'existance de la fonction avant de l'exécuter. - CLEAN_SETUP # Appel la fonction de nettoyage spécifique du script install. - fi - - # Compense le bug de ssowat qui ne supprime pas l'entrée de l'app en cas d'erreur d'installation. - sudo sed -i "\@\"$domain$path/\":@d" /etc/ssowat/conf.json - - ynh_die -} - -TRAP_ON () { # Activate signal capture - set -eu # Exit if a command fail, and if a variable is used unset. - trap EXIT_PROPERLY EXIT # Capturing exit signals on shell script -} +#================================================= +# CHECKING +#================================================= CHECK_USER () { # Vérifie la validité de l'user admin # $1 = Variable de l'user admin. - ynh_user_exists "$1" || (echo "Wrong admin" >&2 && false) -} - -CHECK_PATH () { # Vérifie la présence du / en début de path. Et son absence à la fin. - if [ "${path:0:1}" != "/" ]; then # Si le premier caractère n'est pas un / - path="/$path" # Ajoute un / en début de path - fi - if [ "${path:${#path}-1}" == "/" ] && [ ${#path} -gt 1 ]; then # Si le dernier caractère est un / et que ce n'est pas le seul caractère. - path="${path:0:${#path}-1}" # Supprime le dernier caractère - fi + ynh_user_exists "$1" || ynh_die "Wrong user" } CHECK_DOMAINPATH () { # Vérifie la disponibilité du path et du domaine. - sudo yunohost app checkurl $domain$path -a $app + sudo yunohost app checkurl $domain$path_url -a $app } CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà utilisé. final_path=/var/www/$app - if [ -e "$final_path" ] - then - echo "This path already contains a folder" >&2 - false - fi + test ! -e "$final_path" || ynh_die "This path already contains a folder" } -GENERATE_DB () { # Créer une base de données et un utilisateur dédié au nom de l'app. -# $1 = Nom de la base de donnée - db_user=$1 - db_user=${db_user//-/_} # mariadb ne supporte pas les - dans les noms de base de données. Ils sont donc remplacé par des _ - # Génère un mot de passe aléatoire. -# db_pwd=$(head -n20 /dev/urandom | tr -c -d 'A-Za-z0-9' | head -c20) - db_pwd=$(ynh_string_random) - CHECK_VAR "$db_pwd" "db_pwd empty" - # Utilise '$app' comme nom d'utilisateur et de base de donnée - # Initialise la base de donnée et stocke le mot de passe mysql. - ynh_mysql_create_db "$db_user" "$db_user" $db_pwd - ynh_app_setting_set $app mysqlpwd $db_pwd +#================================================= +# DISPLAYING +#================================================= + +NO_PRINT () { # Supprime l'affichage dans stdout pour la commande en argument. + set +x + $@ + set -x } +WARNING () { # Écrit sur le canal d'erreur pour passer en warning. + $@ >&2 +} + +SUPPRESS_WARNING () { # Force l'écriture sur la sortie standard + $@ 2>&1 +} + +QUIET () { # Redirige la sortie standard dans /dev/null + $@ > /dev/null +} + +ALL_QUIET () { # Redirige la sortie standard et d'erreur dans /dev/null + $@ > /dev/null 2>&1 +} + +#================================================= +# SETUP +#================================================= + SETUP_SOURCE () { # Télécharge la source, décompresse et copie dans $final_path -# $1 = Nom de l'archive téléchargée. - wget -nv -i ../sources/source_url -O $1 + src_url=$(cat ../conf/app.src | grep SOURCE_URL | cut -d'>' -f2) + src_checksum=$(cat ../conf/app.src | grep SOURCE_SUM | cut -d= -f2) + # Download sources from the upstream + wget -nv -O source.tar.gz $src_url # Vérifie la somme de contrôle de la source téléchargée. - md5sum -c ../sources/source_md5 --status || (echo "Corrupt source" >&2 && false) - # Décompresse la source - if [ "$(echo ${1##*.})" == "gz" ]; then - tar -x -f $1 - elif [ "$(echo ${1##*.})" == "zip" ]; then - unzip -q $1 - else - false # Format d'archive non pris en charge. - fi - # Copie les fichiers sources - sudo cp -a $(cat ../sources/source_dir)/. "$final_path" + echo "$src_checksum source.tar.gz" | md5sum -c --status || ynh_die "Corrupt source" + # Extract source into the app dir + sudo mkdir -p $final_path + sudo tar -x -f source.tar.gz -C $final_path --strip-components 1 # Copie les fichiers additionnels ou modifiés. if test -e "../sources/ajouts"; then sudo cp -a ../sources/ajouts/. "$final_path" fi } -ADD_SYS_USER () { # Créer un utilisateur système dédié à l'app - if ! ynh_system_user_exists "$app" # Test l'existence de l'utilisateur - then - sudo useradd -d /var/www/$app --system --user-group $app --shell /usr/sbin/nologin || (echo "Unable to create $app system account" >&2 && false) - fi +SETUP_SOURCE_ZIP () { # Télécharge la source, décompresse et copie dans $final_path + src_url=$(cat ../conf/app.src | grep SOURCE_URL | cut -d'>' -f2) + src_checksum=$(cat ../conf/app.src | grep SOURCE_SUM | cut -d= -f2) + # Download sources from the upstream + wget -nv -O source.zip $src_url + # Vérifie la somme de contrôle de la source téléchargée. + echo "$src_checksum source.zip" | md5sum -c --status || ynh_die "Corrupt source" + # Extract source into the app dir + sudo mkdir -p $final_path + temp_dir=$(mktemp -d) + unzip -quo source.zip -d $temp_dir # On passe par un dossier temporaire car unzip ne permet pas d'ignorer le dossier parent. + sudo cp -a $temp_dir/*/. $final_path + rm -r $temp_dir + # Copie les fichiers additionnels ou modifiés. + if test -e "../sources/ajouts"; then + sudo cp -a ../sources/ajouts/. "$final_path" + fi } POOL_FPM () { # Créer le fichier de configuration du pool php-fpm et le configure. @@ -110,9 +93,123 @@ POOL_FPM () { # Créer le fichier de configuration du pool php-fpm et le configu finalphpini=/etc/php5/fpm/conf.d/20-$app.ini sudo cp ../conf/php-fpm.ini $finalphpini sudo chown root: $finalphpini - sudo service php5-fpm reload + sudo systemctl reload php5-fpm } +YNH_CURL () { + data_post=$1 + url_access=$2 + sleep 1 + curl -kL -H "Host: $domain" --resolve $domain:443:127.0.0.1 --data "$data_post" "https://localhost$path_url$url_access" 2>&1 +} + +#================================================= +# REMOVE +#================================================= + +REMOVE_NGINX_CONF () { # Suppression de la configuration nginx + if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then # Delete nginx config + echo "Delete nginx config" + sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf" + sudo systemctl reload nginx + fi +} + +REMOVE_FPM_CONF () { # Suppression de la configuration du pool php-fpm + if [ -e "/etc/php5/fpm/pool.d/$app.conf" ]; then # Delete fpm config + echo "Delete fpm config" + sudo rm "/etc/php5/fpm/pool.d/$app.conf" + fi + if [ -e "/etc/php5/fpm/conf.d/20-$app.ini" ]; then # Delete php config + echo "Delete php config" + sudo rm "/etc/php5/fpm/conf.d/20-$app.ini" + fi + sudo systemctl reload php5-fpm +} + +SECURE_REMOVE () { # Suppression de dossier avec vérification des variables + chaine="$1" # L'argument doit être donné entre quotes simple '', pour éviter d'interpréter les variables. + no_var=0 + while (echo "$chaine" | grep -q '\$') # Boucle tant qu'il y a des $ dans la chaine + do + no_var=1 + global_var=$(echo "$chaine" | cut -d '$' -f 2) # Isole la première variable trouvée. + only_var=\$$(expr "$global_var" : '\([A-Za-z0-9_]*\)') # Isole complètement la variable en ajoutant le $ au début et en gardant uniquement le nom de la variable. Se débarrasse surtout du / et d'un éventuel chemin derrière. + real_var=$(eval "echo ${only_var}") # `eval "echo ${var}` permet d'interpréter une variable contenue dans une variable. + if test -z "$real_var" || [ "$real_var" = "/" ]; then + WARNING echo "Variable $only_var is empty, suppression of $chaine cancelled." + return 1 + fi + chaine=$(echo "$chaine" | sed "s@$only_var@$real_var@") # remplace la variable par sa valeur dans la chaine. + done + if [ "$no_var" -eq 1 ] + then + if [ -e "$chaine" ]; then + echo "Delete directory $chaine" + sudo rm -r "$chaine" + fi + return 0 + else + WARNING echo "No detected variable." + return 1 + fi +} + +#================================================= +# BACKUP +#================================================= + +BACKUP_FAIL_UPGRADE () { + WARNING echo "Upgrade failed." + app_bck=${app//_/-} # Replace all '_' by '-' + if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$backup_number; then # Vérifie l'existence de l'archive avant de supprimer l'application et de restaurer + sudo yunohost app remove $app # Supprime l'application avant de la restaurer. + sudo yunohost backup restore --ignore-hooks $app_bck-pre-upgrade$backup_number --apps $app --force # Restore the backup if upgrade failed + ynh_die "The app was restored to the way it was before the failed upgrade." + fi +} + +BACKUP_BEFORE_UPGRADE () { # Backup the current version of the app, restore it if the upgrade fails + backup_number=1 + old_backup_number=2 + app_bck=${app//_/-} # Replace all '_' by '-' + if sudo yunohost backup list | grep -q $app_bck-pre-upgrade1; then # Vérifie l'existence d'une archive déjà numéroté à 1. + backup_number=2 # Et passe le numéro de l'archive à 2 + old_backup_number=1 + fi + + sudo yunohost backup create --ignore-hooks --apps $app --name $app_bck-pre-upgrade$backup_number # Créer un backup différent de celui existant. + if [ "$?" -eq 0 ]; then # Si le backup est un succès, supprime l'archive précédente. + if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$old_backup_number; then # Vérifie l'existence de l'ancienne archive avant de la supprimer, pour éviter une erreur. + QUIET sudo yunohost backup delete $app_bck-pre-upgrade$old_backup_number + fi + else # Si le backup a échoué + ynh_die "Backup failed, the upgrade process was aborted." + fi +} + +HUMAN_SIZE () { # Transforme une taille en Ko en une taille lisible pour un humain + human=$(numfmt --to=iec --from-unit=1K $1) + echo $human +} + +CHECK_SIZE () { # Vérifie avant chaque backup que l'espace est suffisant + file_to_analyse=$1 + backup_size=$(sudo du --summarize "$file_to_analyse" | cut -f1) + free_space=$(sudo df --output=avail "/home/yunohost.backup" | sed 1d) + + if [ $free_space -le $backup_size ] + then + WARNING echo "Espace insuffisant pour sauvegarder $file_to_analyse." + WARNING echo "Espace disponible: $(HUMAN_SIZE $free_space)" + ynh_die "Espace nécessaire: $(HUMAN_SIZE $backup_size)" + fi +} + +#================================================= +# CONFIGURATION +#================================================= + STORE_MD5_CONFIG () { # Enregistre la somme de contrôle du fichier de config # $1 = Nom du fichier de conf pour le stockage dans settings.yml # $2 = Nom complet et chemin du fichier de conf. @@ -127,87 +224,278 @@ CHECK_MD5_CONFIG () { # Créé un backup du fichier de config si il a été modi fi } -FIND_PORT () { # Cherche un port libre. -# $1 = Numéro de port pour débuter la recherche. - port=$1 - while ! sudo yunohost app checkport $port ; do - port=$((port+1)) - done - CHECK_VAR "$port" "port empty" + +#================================================= +#================================================= +# FUTUR YNH HELPERS +#================================================= +# Importer ce fichier de fonction avant celui des helpers officiel +# Ainsi, les officiels prendront le pas sur ceux-ci le cas échéant +#================================================= + +# Ignore the yunohost-cli log to prevent errors with conditionals commands +# usage: ynh_no_log COMMAND +# Simply duplicate the log, execute the yunohost command and replace the log without the result of this command +# It's a very badly hack... +ynh_no_log() { + ynh_cli_log=/var/log/yunohost/yunohost-cli.log + sudo cp -a ${ynh_cli_log} ${ynh_cli_log}-move + eval $@ + exit_code=$? + sudo mv ${ynh_cli_log}-move ${ynh_cli_log} + return $? } +# Normalize the url path syntax +# Handle the slash at the beginning of path and its absence at ending +# Return a normalized url path +# +# example: url_path=$(ynh_normalize_url_path $url_path) +# ynh_normalize_url_path example -> /example +# ynh_normalize_url_path /example -> /example +# ynh_normalize_url_path /example/ -> /example +# +# usage: ynh_normalize_url_path path_to_normalize +# | arg: url_path_to_normalize - URL path to normalize before using it +ynh_normalize_url_path () { + path_url=$1 + test -n "$path_url" || ynh_die "ynh_normalize_url_path expect a URL path as first argument and received nothing." + if [ "${path_url:0:1}" != "/" ]; then # If the first character is not a / + path_url="/$path_url" # Add / at begin of path variable + fi + if [ "${path_url:${#path_url}-1}" == "/" ] && [ ${#path_url} -gt 1 ]; then # If the last character is a / and that not the only character. + path_url="${path_url:0:${#path_url}-1}" # Delete the last character + fi + echo $path_url +} -### REMOVE SCRIPT +# Create a database, an user and its password. Then store the password in the app's config +# +# User of database will be store in db_user's variable. +# Name of database will be store in db_name's variable. +# And password in db_pwd's variable. +# +# usage: ynh_mysql_generate_db user name +# | arg: user - Owner of the database +# | arg: name - Name of the database +ynh_mysql_generate_db () { + db_pwd=$(ynh_string_random) # Generate a random password + ynh_mysql_create_db "$2" "$1" "$db_pwd" # Create the database + ynh_app_setting_set $app mysqlpwd $db_pwd # Store the password in the app's config +} -REMOVE_NGINX_CONF () { # Suppression de la configuration nginx - if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then # Delete nginx config - echo "Delete nginx config" - sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf" - sudo service nginx reload +# Remove a database if it exist and the associated user +# +# usage: ynh_mysql_remove_db user name +# | arg: user - Proprietary of the database +# | arg: name - Name of the database +ynh_mysql_remove_db () { + if mysqlshow -u root -p$(sudo cat $MYSQL_ROOT_PWD_FILE) | grep -q "^| $2"; then # Check if the database exist + echo "Remove database $2" >&2 + ynh_mysql_drop_db $2 # Remove the database + ynh_mysql_drop_user $1 # Remove the associated user to database + else + echo "Database $2 not found" >&2 fi } -REMOVE_FPM_CONF () { # Suppression de la configuration du pool php-fpm - if [ -e "/etc/php5/fpm/pool.d/$app.conf" ]; then # Delete fpm config - echo "Delete fpm config" - sudo rm "/etc/php5/fpm/pool.d/$app.conf" - fi - if [ -e "/etc/php5/fpm/conf.d/20-$app.ini" ]; then # Delete php config - echo "Delete php config" - sudo rm "/etc/php5/fpm/conf.d/20-$app.ini" - fi - sudo service php5-fpm reload +# Correct the name given in argument for mariadb +# +# Avoid invalid name for your database +# +# Exemple: dbname=$(ynh_make_valid_dbid $app) +# +# usage: ynh_make_valid_dbid name +# | arg: name - name to correct +# | ret: the corrected name +ynh_make_valid_dbid () { + dbid=${1//[-.]/_} # Mariadb doesn't support - and . in the name of databases. It will be replace by _ + echo $dbid } -REMOVE_LOGROTATE_CONF () { # Suppression de la configuration de logrotate +# Manage a fail of the script +# +# Print a warning to inform that the script was failed +# Execute the ynh_clean_setup function if used in the app script +# +# usage of ynh_clean_setup function +# This function provide a way to clean some residual of installation that not managed by remove script. +# To use it, simply add in your script: +# ynh_clean_setup () { +# instructions... +# } +# This function is optionnal. +# +# Usage: ynh_exit_properly is used only by the helper ynh_check_error. +# You must not use it directly. +ynh_exit_properly () { + exit_code=$? + if [ "$exit_code" -eq 0 ]; then + exit 0 # Exit without error if the script ended correctly + fi + + trap '' EXIT # Ignore new exit signals + set +eu # Do not exit anymore if a command fail or if a variable is empty + + echo -e "!!\n $app's script has encountered an error. Its execution was cancelled.\n!!" >&2 + + if type -t ynh_clean_setup > /dev/null; then # Check if the function exist in the app script. + ynh_clean_setup # Call the function to do specific cleaning for the app. + fi + + ynh_die # Exit with error status +} + +# Exit if an error occurs during the execution of the script. +# +# Stop immediatly the execution if an error occured or if a empty variable is used. +# The execution of the script is derivate to ynh_exit_properly function before exit. +# +# Usage: ynh_abort_if_errors +ynh_abort_if_errors () { + set -eu # Exit if a command fail, and if a variable is used unset. + trap ynh_exit_properly EXIT # Capturing exit signals on shell script +} + +# Install dependencies with a equivs control file +# +# usage: ynh_install_app_dependencies dep [dep [...]] +# | arg: dep - the package name to install in dependence +ynh_install_app_dependencies () { + dependencies=$@ + manifest_path="../manifest.json" + if [ ! -e "$manifest_path" ]; then + manifest_path="../settings/manifest.json" # Into the restore script, the manifest is not at the same place + fi + version=$(sudo python3 -c "import sys, json;print(json.load(open(\"$manifest_path\"))['version'])") # Retrieve the version number in the manifest file. + dep_app=${app//_/-} # Replace all '_' by '-' + + if ynh_package_is_installed "${dep_app}-ynh-deps"; then + echo "A package named ${dep_app}-ynh-deps is already installed" >&2 + else + cat > ./${dep_app}-ynh-deps.control << EOF # Make a control file for equivs-build +Section: misc +Priority: optional +Package: ${dep_app}-ynh-deps +Version: ${version} +Depends: ${dependencies// /, } +Architecture: all +Description: Fake package for ${app} (YunoHost app) dependencies + This meta-package is only responsible of installing its dependencies. +EOF + ynh_package_install_from_equivs ./${dep_app}-ynh-deps.control \ + || ynh_die "Unable to install dependencies" # Install the fake package and its dependencies + ynh_app_setting_set $app apt_dependencies $dependencies + fi +} + +# Remove fake package and its dependencies +# +# Dependencies will removed only if no other package need them. +# +# usage: ynh_remove_app_dependencies +ynh_remove_app_dependencies () { + dep_app=${app//_/-} # Replace all '_' by '-' + ynh_package_autoremove ${dep_app}-ynh-deps # Remove the fake package and its dependencies if they not still used. +} + +# Use logrotate to manage the logfile +# +# usage: ynh_use_logrotate [logfile] +# | arg: logfile - absolute path of logfile +# +# If no argument provided, a standard directory will be use. /var/log/${app} +# You can provide a path with the directory only or with the logfile. +# /parentdir/logdir/ +# /parentdir/logdir/logfile.log +# +# It's possible to use this helper several times, each config will added to same logrotate config file. +ynh_use_logrotate () { + if [ "$#" -gt 0 ]; then + if [ "$(echo ${1##*.})" == "log" ]; then # Keep only the extension to check if it's a logfile + logfile=$1 # In this case, focus logrotate on the logfile + else + logfile=$1/.log # Else, uses the directory and all logfile into it. + fi + else + logfile="/var/log/${app}/.log" # Without argument, use a defaut directory in /var/log + fi + cat > ./${app}-logrotate << EOF # Build a config file for logrotate +$logfile { + # Rotate if the logfile exceeds 100Mo + size 100M + # Keep 12 old log maximum + rotate 12 + # Compress the logs with gzip + compress + # Compress the log at the next cycle. So keep always 2 non compressed logs + delaycompress + # Copy and truncate the log to allow to continue write on it. Instead of move the log. + copytruncate + # Do not do an error if the log is missing + missingok + # Not rotate if the log is empty + notifempty + # Keep old logs in the same dir + noolddir +} +EOF + sudo mkdir -p $(dirname "$logfile") # Create the log directory, if not exist + cat ${app}-logrotate | sudo tee -a /etc/logrotate.d/$app > /dev/null # Append this config to the others for this app. If a config file already exist +} + +# Remove the app's logrotate config. +# +# usage: ynh_remove_logrotate +ynh_remove_logrotate () { if [ -e "/etc/logrotate.d/$app" ]; then - echo "Delete logrotate config" sudo rm "/etc/logrotate.d/$app" fi } -SECURE_REMOVE () { # Suppression de dossier avec vérification des variables - chaine="$1" # L'argument doit être donné entre quotes simple '', pour éviter d'interpréter les variables. - no_var=0 - while (echo "$chaine" | grep -q '\$') # Boucle tant qu'il y a des $ dans la chaine +# Find a free port and return it +# +# example: port=$(ynh_find_port 8080) +# +# usage: ynh_find_port begin_port +# | arg: begin_port - port to start to search +ynh_find_port () { + port=$1 + test -n "$port" || ynh_die "The argument of ynh_find_port must be a valid port." + while netcat -z 127.0.0.1 $port # Check if the port is free do - no_var=1 - global_var=$(echo "$chaine" | cut -d '$' -f 2) # Isole la première variable trouvée. - only_var=\$$(expr "$global_var" : '\([A-Za-z0-9_]*\)') # Isole complètement la variable en ajoutant le $ au début et en gardant uniquement le nom de la variable. Se débarrasse surtout du / et d'un éventuel chemin derrière. - real_var=$(eval "echo ${only_var}") # `eval "echo ${var}` permet d'interpréter une variable contenue dans une variable. - if test -z "$real_var" || [ "$real_var" = "/" ]; then - echo "Variable $only_var is empty, suppression of $chaine cancelled." >&2 - return 1 - fi - chaine=$(echo "$chaine" | sed "s@$only_var@$real_var@") # remplace la variable par sa valeur dans la chaine. + port=$((port+1)) # Else, pass to next port done - if [ "$no_var" -eq 1 ] - then - if [ -e "$chaine" ]; then - echo "Delete directory $chaine" - sudo rm -r "$chaine" + echo $port +} + +# Create a system user +# +# usage: ynh_system_user_create user_name [home_dir] +# | arg: user_name - Name of the system user that will be create +# | arg: home_dir - Path of the home dir for the user. Usually the final path of the app. If this argument is omitted, the user will be created without home +ynh_system_user_create () { + if ! ynh_system_user_exists "$1" # Check if the user exists on the system + then # If the user doesn't exist + if [ $# -ge 2 ]; then # If a home dir is mentioned + user_home_dir="-d $2" + else + user_home_dir="--no-create-home" fi - return 0 - else - echo "No detected variable." >&2 - return 1 + sudo useradd $user_home_dir --system --user-group $1 --shell /usr/sbin/nologin || ynh_die "Unable to create $1 system account" fi } -REMOVE_BDD () { # Suppression de la base de donnée et de l'utilisateur associé. -# $1 = Nom de la base de donnée - # Utilise '$app' comme nom d'utilisateur et de base de donnée - db_user=$1 - if mysqlshow -u root -p$(sudo cat $MYSQL_ROOT_PWD_FILE) | grep -q "^| $db_user"; then - echo "Delete db" - ynh_mysql_drop_db $db_user - ynh_mysql_drop_user $db_user - fi -} - -REMOVE_SYS_USER () { # Supprime l'utilisateur système dédié à l'app - if ynh_system_user_exists "$app" # Test l'existence de l'utilisateur +# Delete a system user +# +# usage: ynh_system_user_delete user_name +# | arg: user_name - Name of the system user that will be create +ynh_system_user_delete () { + if ynh_system_user_exists "$1" # Check if the user exists on the system then - sudo userdel $app + echo "Remove the user $1" >&2 + sudo userdel $1 + else + echo "The user $1 was not found" >&2 fi } diff --git a/scripts/backup b/scripts/backup index 5cd229a..b8c9944 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,25 +1,54 @@ #!/bin/bash -# Récupère les infos de l'application. +#================================================= +# GENERIC STARTING +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= + +# Exit on command errors and treat unset variables as an error +set -eu + +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +if [ ! -e .fonctions ]; then + # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant + sudo cp ../settings/scripts/.fonctions ./.fonctions + sudo chmod a+rx .fonctions +fi +source .fonctions +source /usr/share/yunohost/helpers + +#================================================= +# LOAD SETTINGS +#================================================= + app=$YNH_APP_INSTANCE_NAME -# Source app helpers -source /usr/share/yunohost/helpers final_path=$(ynh_app_setting_get $app final_path) domain=$(ynh_app_setting_get $app domain) +#================================================= +# STANDARD BACKUP STEPS +#================================================= +# BACKUP OF THE MAIN DIR OF THE APP +#================================================= -# The parameter $1 is the backup directory location -# which will be compressed afterward -backup_dir=$1/apps/$app -sudo mkdir -p "$backup_dir" +CHECK_SIZE "$final_path" +ynh_backup "$final_path" "sources" -# Backup sources & data -sudo cp -a $final_path/. $backup_dir/sources +#================================================= +# BACKUP OF THE NGINX CONFIGURATION +#================================================= -# Copy Nginx and YunoHost parameters to make the script "standalone" -sudo cp -a /etc/yunohost/apps/$app/. $backup_dir/yunohost -sudo cp -a /etc/nginx/conf.d/$domain.d/$app.conf $backup_dir/nginx.conf +ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "nginx.conf" -# Copie de la configuration de démarrage de Jenkins -sudo cp -a /etc/default/$app $backup_dir/etc +#================================================= +# SPECIFIC BACKUP +#================================================= +# BACKUP OF THE JENKINS' BOOT CONFIG +#================================================= + +ynh_backup /etc/default/$app etc diff --git a/scripts/install b/scripts/install index 25f8ebe..0182d14 100644 --- a/scripts/install +++ b/scripts/install @@ -1,12 +1,23 @@ #!/bin/bash -source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -CLEAN_SETUP () { +source .fonctions +source /usr/share/yunohost/helpers + +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= + +ynh_clean_setup () { # Nettoyage des résidus d'installation non pris en charge par le script remove. if test -n "$PID_TAIL" then - kill -s 15 $PID_TAIL > /dev/null # Arrête l'exécution de tail. + SUPPRESS_WARNING kill -s 15 $PID_TAIL # Arrête l'exécution de tail. sudo rm -f "$tempfile" fi @@ -15,85 +26,112 @@ CLEAN_SETUP () { echo "" } -TRAP_ON # Active trap pour arrêter le script si une erreur est détectée. +ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. + +#================================================= +# RETRIEVE ARGUMENTS FROM THE MANIFEST +#================================================= -# Retrieve arguments domain=$YNH_APP_ARG_DOMAIN -path=$YNH_APP_ARG_PATH +path_url=$YNH_APP_ARG_PATH is_public=$YNH_APP_ARG_IS_PUBLIC app=$YNH_APP_INSTANCE_NAME -# Source app helpers -source /usr/share/yunohost/helpers +#================================================= +# CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS +#================================================= -# Vérifie que les variables ne sont pas vides. -CHECK_VAR "$app" "app name not set" - - -CHECK_PATH # Vérifie et corrige la syntaxe du path. +path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path. CHECK_DOMAINPATH # Vérifie la disponibilité du path et du domaine. # Vérifie que le dossier de destination n'est pas déjà utilisé. final_path=/var/lib/$app -if [ -e "$final_path" ] -then - echo "This path already contains a folder" >&2 - false -fi +test -e "$final_path" && ynh_die "This path already contains a folder" +#================================================= +# STORE SETTINGS FROM MANIFEST +#================================================= -FIND_PORT 8080 # Cherche un port libre. - - -# Enregistre les infos dans la config YunoHost ynh_app_setting_set $app domain $domain -ynh_app_setting_set $app path $path +ynh_app_setting_set $app path $path_url ynh_app_setting_set $app is_public $is_public -ynh_app_setting_set $app port $port ynh_app_setting_set $app final_path $final_path +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# FIND AND OPEN A PORT +#================================================= + +port=$(ynh_find_port 8080) # Cherche un port libre. +ynh_app_setting_set $app port $port + +#================================================= +# INSTALL DEPENDENCIES +#================================================= -echo "Install dependencies..." wget -q -O - https://pkg.jenkins.io/debian/jenkins.io.key | sudo apt-key add - sudo sh -c 'echo deb http://pkg.jenkins.io/debian-stable binary/ > /etc/apt/sources.list.d/jenkins.list' -sudo apt-get update -sudo apt-get install default-jre-headless -y -sudo apt-get install jenkins -y +ynh_install_app_dependencies default-jre-headless jenkins + +#================================================= +# NGINX CONFIGURATION +#================================================= + +# Copie le fichier de config nginx +sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf +# Et modifie les variables dans le fichier de configuration nginx +sudo sed -i "s@__PATH__@$path_url@g" /etc/nginx/conf.d/$domain.d/$app.conf +sudo sed -i "s@__DOMAIN__@$domain@g" /etc/nginx/conf.d/$domain.d/$app.conf +sudo sed -i "s@__PORT__@$port@g" /etc/nginx/conf.d/$domain.d/$app.conf + +#================================================= +# SPECIFIC SETUP +#================================================= +# SETUP JENKINS +#================================================= # Renseigne le port sudo sed -i "s/^HTTP_PORT=.*/HTTP_PORT=$port/g" /etc/default/jenkins # Ignore le Setup Wizard sudo sed -i "s/-Djava.awt.headless=true/& -Djenkins.install.runSetupWizard=false/g" /etc/default/jenkins -if [ "$path" != "/" ]; +if [ "$path_url" != "/" ]; then # Ajoute le path en cas d'installation en sous-dossier dans les options de démarrage de Jenkins - sudo sed -i "$ s@--httpPort=\$HTTP_PORT@& --prefix=$path@g" /etc/default/jenkins + sudo sed -i "$ s@--httpPort=\$HTTP_PORT@& --prefix=$path_url@g" /etc/default/jenkins fi -sudo service $app restart # Redémarre jenkins pour prendre en compte les modifications +#================================================= +# START JENKINS IN BACKGROUND +#================================================= + +sudo systemctl restart $app # Redémarre jenkins pour prendre en compte les modifications tempfile="$(mktemp)" tail -f -n1 /var/log/$app/$app.log > "$tempfile" & # Suit le démarrage dans le log PID_TAIL=$! # Récupère le PID de la commande tail, qui est passée en arrière plan. -# Copie le fichier de config nginx -sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf -# Et modifie les variables dans le fichier de configuration nginx -sudo sed -i "s@__PATH__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf -sudo sed -i "s@__DOMAIN__@$domain@g" /etc/nginx/conf.d/$domain.d/$app.conf -sudo sed -i "s@__PORT__@$port@g" /etc/nginx/conf.d/$domain.d/$app.conf +#================================================= +# FORCE PUBLIC ACCESS +#================================================= # Jenkins est public par défaut, au moins pour le téléchargement de jenkins-cli.jar ynh_app_setting_set $app unprotected_uris "/" -sudo service nginx reload +sudo systemctl reload nginx sudo yunohost app ssowatconf -# Ajoute le service au monitoring de Yunohost. -sudo yunohost service add $app -l /var/log/$app/$app.log +#================================================= +# ENABLE SERVICE IN ADMIN PANEL +#================================================= + +sudo yunohost service add $app --log /var/log/$app/$app.log + +#================================================= +# CHECK JENKINS STARTING +#================================================= -# Surveille le démarrage du service. config_OK=0 timeout=3600 echo "127.0.0.1 $domain #jenkins" | sudo tee -a /etc/hosts # Renseigne le domain dans le host, pour prévenir d'un dns pas encore propagé. @@ -101,74 +139,81 @@ for i in `seq 1 $timeout` do # La boucle attend le démarrage de jenkins Ou $timeout (Le démarrage sur arm est trèèèèèèèèès long...). if grep -q "Jenkins is fully up and running" "$tempfile" && [ "$config_OK" -eq 0 ]; then # Si le log annonce une première fois le démarrage de jenkins. Installe les plugins - sudo wget -nv --no-check-certificate https://$domain$path/jnlpJars/jenkins-cli.jar -O /var/lib/jenkins/jenkins-cli.jar - echo "" >&2 + sudo wget -nv --no-check-certificate https://$domain$path_url/jnlpJars/jenkins-cli.jar -O /var/lib/jenkins/jenkins-cli.jar + WARNING echo "" for i in `seq 1 $timeout` do # La boucle attend la mise à jour des dépôts de plugins. if test -e /var/lib/jenkins/updates/default.json; then break; else - echo -n "." >&2 + WARNING echo -n "." sleep 1 fi done # Installation du plugin pour l'authentification ldap et http auth - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin reverse-proxy-auth-plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin reverse-proxy-auth-plugin # Installation des plugins recommandés (Lors de l'install avec le Setup Wizard) - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin cloudbees-folder # Folders Plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin antisamy-markup-formatter # OWASP Markup Formatter Plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin pam-auth # PAM Authentication plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin mailer # Mailer Plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin ldap # LDAP Plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin matrix-auth # Matrix Authorization Strategy Plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin build-timeout # Build timeout plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin credentials-binding # Credentials Binding Plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin timestamper # Timestamper - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin ws-cleanup # Workspace Cleanup Plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin ant # Ant Plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin gradle # Gradle Plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin workflow-aggregator # Pipeline - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin pipeline-stage-view # Pipeline: Stage View Plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin git # Git plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin github-organization-folder # GitHub Organization Folder Plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin subversion # Subversion Plug-in - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin email-ext # Email Extension Plugin - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin ssh-slaves # SSH Slaves plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin cloudbees-folder # Folders Plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin antisamy-markup-formatter # OWASP Markup Formatter Plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin pam-auth # PAM Authentication plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin mailer # Mailer Plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin ldap # LDAP Plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin matrix-auth # Matrix Authorization Strategy Plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin build-timeout # Build timeout plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin credentials-binding # Credentials Binding Plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin timestamper # Timestamper + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin ws-cleanup # Workspace Cleanup Plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin ant # Ant Plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin gradle # Gradle Plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin workflow-aggregator # Pipeline + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin pipeline-stage-view # Pipeline: Stage View Plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin git # Git plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin github-organization-folder # GitHub Organization Folder Plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin subversion # Subversion Plug-in + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin email-ext # Email Extension Plugin + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin ssh-slaves # SSH Slaves plugin # Installation de plugins supplémentaires pour le confort - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin ansicolor # Prise en charge des couleurs pour la sortie console. Améliore la lisibilité de la console (par contre les couleurs ne passent pas...) - java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path install-plugin fstrigger # Monitoring sur le système de fichier local. Pour surveiller des dossiers de code et builder sur les changements. + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin ansicolor # Prise en charge des couleurs pour la sortie console. Améliore la lisibilité de la console (par contre les couleurs ne passent pas...) + java -jar /var/lib/jenkins/jenkins-cli.jar -noCertificateCheck -s https://$domain$path_url install-plugin fstrigger # Monitoring sur le système de fichier local. Pour surveiller des dossiers de code et builder sur les changements. # Configure la sécurité globale avec ldap par défaut. sudo cp ../conf/config.xml /var/lib/jenkins/ sudo chown jenkins: /var/lib/jenkins/config.xml - sudo service $app restart # Puis redémarre à nouveau le service. + sudo systemctl restart $app # Puis redémarre à nouveau le service. cat /dev/null > "$tempfile" # Purge le log de suivi du démarrage. - config_OK=1 + config_OK=1 i=1; fi if grep -q "Jenkins is fully up and running" "$tempfile" && [ "$config_OK" -eq 1 ]; then - echo "Le service $app a démarré correctement." >&2 + WARNING echo "Le service $app a démarré correctement." break # Si le log annonce une deuxième fois le démarrage de jenkins, sort de la boucle. fi - echo -n "." >&2 + WARNING echo -n "." sleep 1 done -kill -s 15 $PID_TAIL > /dev/null # Arrête l'exécution de tail. +SUPPRESS_WARNING kill -s 15 $PID_TAIL # Arrête l'exécution de tail. sudo rm "$tempfile" if [ "$i" -ge $timeout ]; then - echo -e "\nLe service $app n'a pas démarré dans le temps imparti." >&2; false + ynh_die "\nLe service $app n'a pas démarré dans le temps imparti." fi +#================================================= +# SETUP SSOWAT +#================================================= + # Si Jenkins est privé, retire l'autorisation publique. -if [ "$is_public" = "No" ]; +if [ $is_public -eq 0 ] then # Retire l'accès public ynh_app_setting_delete $app unprotected_uris ynh_app_setting_set $app skipped_uris "/github-webhook" # /path/github-webhook doit rester accessible pour les webhooks de github. fi -# Clean hosts +#================================================= +# CLEAN HOSTS FILE +#================================================= + sudo sed -i '/#jenkins/d' /etc/hosts diff --git a/scripts/remove b/scripts/remove index 00cb7d3..ccf5c44 100644 --- a/scripts/remove +++ b/scripts/remove @@ -1,36 +1,54 @@ #!/bin/bash -source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -# Récupère les infos de l'application. -app=$YNH_APP_INSTANCE_NAME - -# Source app helpers +source .fonctions source /usr/share/yunohost/helpers +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME + domain=$(ynh_app_setting_get $app domain) +#================================================= +# STANDARD REMOVE +#================================================= +# DISABLE SERVICE IN ADMIN PANEL +#================================================= -# Retire le service du monitoring de Yunohost. if sudo yunohost service status | grep -q $app # Test l'existence du service dans Yunohost then echo "Remove $app service" sudo yunohost service remove $app fi -# Supprime Jenkins -sudo apt-get purge jenkins -y +#================================================= +# REMOVE DEPENDENCIES +#================================================= + +ynh_remove_app_dependencies + sudo rm /etc/apt/sources.list.d/jenkins.list # Récupère l'id de la clé APT de jenkins apt_key=$(sudo apt-key list | grep -B1 "Kohsuke Kawaguchi" | grep pub | cut -d'/' -f2 | cut -d' ' -f1) sudo apt-key del $apt_key # Supprime la clé APT sudo apt-get update -# Régénère la configuration de SSOwat -sudo yunohost app ssowatconf +#================================================= +# REMOVE THE MAIN DIR OF THE APP +#================================================= -REMOVE_NGINX_CONF # Suppression de la configuration nginx +SECURE_REMOVE '/var/lib/$app' # Suppression du dossier de l'application, si il y a des -SECURE_REMOVE '/var/lib/$app' # Suppression du dossier de l'application, si il y a des résidus. +#================================================= +# REMOVE THE NGINX CONFIGURATION +#================================================= -echo -e "\e[0m" # Restore normal color +REMOVE_NGINX_CONF # Suppression de la configuration nginx résidus. diff --git a/scripts/restore b/scripts/restore index 5baa1e3..b2fc831 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,66 +1,111 @@ #!/bin/bash -# Récupère les infos de l'application. -app=$YNH_APP_INSTANCE_NAME +#================================================= +# GENERIC STARTING +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= -# Source app helpers +# Exit on command errors and treat unset variables as an error +set -eu + +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +if [ ! -e .fonctions ]; then + # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant + sudo cp ../settings/scripts/.fonctions ./.fonctions + sudo chmod a+rx .fonctions +fi +source .fonctions source /usr/share/yunohost/helpers +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME + domain=$(ynh_app_setting_get $app domain) -path=$(ynh_app_setting_get $app path) +path_url=$(ynh_app_setting_get $app path) final_path=$(ynh_app_setting_get $app final_path) -if [ -d $final_path ]; then - ynh_die "There is already a directory: $final_path" -fi +#================================================= +# CHECK IF THE APP CAN BE RESTORED +#================================================= -# The parameter $1 is the uncompressed restore directory location -backup_dir=$1/apps/$app +sudo yunohost app checkurl "${domain}${path_url}" -a "$app" \ + || ynh_die "Path not available: ${domain}${path_url}" +test ! -d $final_path \ + || ynh_die "There is already a directory: $final_path " + +#================================================= +# STANDARD RESTORE STEPS +#================================================= +# RESTORE OF THE NGINX CONFIGURATION +#================================================= -# Restore Nginx conf=/etc/nginx/conf.d/$domain.d/$app.conf if [ -f $conf ]; then - ynh_die "There is already a nginx conf file at this path: $conf" + ynh_die "There is already a nginx conf file at this path: $conf" fi -sudo cp -a $backup_dir/nginx.conf $conf +sudo cp -a ./nginx.conf $conf -# Restore YunoHost parameters -sudo cp -a $backup_dir/yunohost/. /etc/yunohost/apps/$app +# Reload webserver +sudo systemctl reload nginx + +#================================================= +# SPECIFIC RESTORE +#================================================= +# REINSTALL DEPENDENCIES +#================================================= -echo "Reinstall dependencies..." wget -q -O - https://pkg.jenkins.io/debian/jenkins.io.key | sudo apt-key add - sudo sh -c 'echo deb http://pkg.jenkins.io/debian-stable binary/ > /etc/apt/sources.list.d/jenkins.list' -sudo apt-get update -sudo apt-get install default-jre-headless -y -sudo apt-get install jenkins -y +ynh_install_app_dependencies default-jre-headless jenkins -# Restore sources & data -sudo cp -a "$backup_dir/sources/." $final_path +#================================================= +# RESTORE OF THE MAIN DIR OF THE APP +#================================================= -# Restauration de la configuration de démarrage de Jenkins -sudo cp -a $backup_dir/etc /etc/default/$app +sudo cp -a ./sources/. $final_path -sudo service $app restart # Redémarre jenkins pour prendre en compte les modifications +#================================================= +# RESTORE OF THE JENKINS' BOOT CONFIG +#================================================= + +sudo cp -a ./etc /etc/default/$app + +#================================================= +# START JENKINS IN BACKGROUND +#================================================= + +sudo systemctl restart $app # Redémarre jenkins pour prendre en compte les modifications tempfile="$(mktemp)" tail -f -n1 /var/log/$app/$app.log > "$tempfile" & # Suit le démarrage dans le log PID_TAIL=$! # Récupère le PID de la commande tail, qui est passée en arrière plan. -# Ajoute le service au monitoring de Yunohost. +#================================================= +# ENABLE SERVICE IN ADMIN PANEL +#================================================= + sudo yunohost service add $app --log "/var/log/$app/$app.log" -# Reload webserver -sudo service nginx reload +#================================================= +# CHECK JENKINS STARTING +#================================================= # Surveille le démarrage du service. for i in `seq 1 120` do # La boucle attend le démarrage de jenkins Ou 120 secondes. if grep -q "INFOS: Jenkins is fully up and running" "$tempfile"; then - echo "Le service $app a démarré correctement." >&2 + WARNING echo "Le service $app a démarré correctement." break # Si le log annonce le démarrage de jenkins, sort de la boucle. fi - echo -n "." >&2 + WARNING echo -n "." sleep 1 done -kill -s 15 $PID_TAIL > /dev/null # Arrête l'exécution de tail. +SUPPRESS_WARNING kill -s 15 $PID_TAIL # Arrête l'exécution de tail. sudo rm "$tempfile" diff --git a/scripts/upgrade b/scripts/upgrade index 9a5c443..02a7318 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,33 +1,72 @@ #!/bin/bash -source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source .fonctions +source /usr/share/yunohost/helpers + +#================================================= +# LOAD SETTINGS +#================================================= # Récupère les infos de l'application. app=$YNH_APP_INSTANCE_NAME -# Source app helpers -source /usr/share/yunohost/helpers - -# Retrieve arguments domain=$(ynh_app_setting_get $app domain) -path=$(ynh_app_setting_get $app path) +path_url=$(ynh_app_setting_get $app path) is_public=$(ynh_app_setting_get $app is_public) port=$(ynh_app_setting_get $app port) +#================================================= +# FIX OLD THINGS +#================================================= + +if [ "$is_public" = "Yes" ]; then + ynh_app_setting_set $app is_public 1 # Fixe is_public en booléen + is_public=1 +elif [ "$is_public" = "No" ]; then + ynh_app_setting_set $app is_public 0 + is_public=0 +fi + +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= + +BACKUP_BEFORE_UPGRADE # Backup the current version of the app +ynh_clean_setup () { + BACKUP_FAIL_UPGRADE # restore it if the upgrade fails +} +ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. + +#================================================= +# NGINX CONFIGURATION +#================================================= # Copie le fichier de config nginx sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf # Et modifie les variables dans le fichier de configuration nginx -sudo sed -i "s@__PATH__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf +sudo sed -i "s@__PATH__@$path_url@g" /etc/nginx/conf.d/$domain.d/$app.conf sudo sed -i "s@__DOMAIN__@$domain@g" /etc/nginx/conf.d/$domain.d/$app.conf sudo sed -i "s@__PORT__@$port@g" /etc/nginx/conf.d/$domain.d/$app.conf -if [ "$is_public" = "Yes" ]; +#================================================= +# SETUP SSOWAT +#================================================= + +if [ $is_public -eq 1 ] then - ynh_app_setting_set $app unprotected_uris "/" + ynh_app_setting_set $app unprotected_uris "/" else - ynh_app_setting_delete $app unprotected_uris + ynh_app_setting_delete $app unprotected_uris fi -sudo service nginx reload -sudo yunohost app ssowatconf +#================================================= +# RELOAD NGINX +#================================================= + +sudo systemctl reload nginx