build/rails-package-scripts/postinst.sh

   1 #!/bin/sh
   2 # This code runs after package variable definitions and step2.sh.
   3
   4 set -e
   5
   6 DATABASE_READY=1
   7 APPLICATION_READY=1
   8
   9 if [ -s "$HOME/.rvm/scripts/rvm" ] || [ -s "/usr/local/rvm/scripts/rvm" ]; then
  10     COMMAND_PREFIX="/usr/local/rvm/bin/rvm-exec default"
  11 else
  12     COMMAND_PREFIX=
  13 fi
  14
  15 report_not_ready() {
  16     local ready_flag="$1"; shift
  17     local config_file="$1"; shift
  18     if [ "1" != "$ready_flag" ]; then cat >&2 <<EOF
  19
  20 PLEASE NOTE:
  21
  22 The $PACKAGE_NAME package was not configured completely because
  23 $config_file needs some tweaking.
  24 Please refer to the documentation at
  25 <$DOC_URL> for more details.
  26
  27 When $(basename "$config_file") has been modified,
  28 reconfigure or reinstall this package.
  29
  30 EOF
  31     fi
  32 }
  33
  34 report_web_service_warning() {
  35     local warning="$1"; shift
  36     cat >&2 <<EOF
  37
  38 WARNING: $warning.
  39
  40 To override, set the WEB_SERVICE environment variable to the name of the service
  41 hosting the Rails server.
  42
  43 For Debian-based systems, then reconfigure this package with dpkg-reconfigure.
  44
  45 For RPM-based systems, then reinstall this package.
  46
  47 EOF
  48 }
  49
  50 run_and_report() {
  51     # Usage: run_and_report ACTION_MSG CMD
  52     # This is the usual wrapper that prints ACTION_MSG, runs CMD, then writes
  53     # a message about whether CMD succeeded or failed.  Returns the exit code
  54     # of CMD.
  55     local action_message="$1"; shift
  56     local retcode=0
  57     echo -n "$action_message..."
  58     if "$@"; then
  59         echo " done."
  60     else
  61         retcode=$?
  62         echo " failed."
  63     fi
  64     return $retcode
  65 }
  66
  67 setup_confdirs() {
  68     for confdir in "$@"; do
  69         if [ ! -d "$confdir" ]; then
  70             install -d -g "$WWW_OWNER" -m 0750 "$confdir"
  71         fi
  72     done
  73 }
  74
  75 setup_conffile() {
  76     # Usage: setup_conffile CONFFILE_PATH [SOURCE_PATH]
  77     # Both paths are relative to RELEASE_CONFIG_PATH.
  78     # This function will try to safely ensure that a symbolic link for
  79     # the configuration file points from RELEASE_CONFIG_PATH to CONFIG_PATH.
  80     # If SOURCE_PATH is given, this function will try to install that file as
  81     # the configuration file in CONFIG_PATH, and return 1 if the file in
  82     # CONFIG_PATH is unmodified from the source.
  83     local conffile_relpath="$1"; shift
  84     local conffile_source="$1"
  85     local release_conffile="$RELEASE_CONFIG_PATH/$conffile_relpath"
  86     local etc_conffile="$CONFIG_PATH/$(basename "$conffile_relpath")"
  87
  88     # Note that -h can return true and -e will return false simultaneously
  89     # when the target is a dangling symlink.  We're okay with that outcome,
  90     # so check -h first.
  91     if [ ! -h "$release_conffile" ]; then
  92         if [ ! -e "$release_conffile" ]; then
  93             ln -s "$etc_conffile" "$release_conffile"
  94         # If there's a config file in /var/www identical to the one in /etc,
  95         # overwrite it with a symlink after porting its permissions.
  96         elif cmp --quiet "$release_conffile" "$etc_conffile"; then
  97             local ownership="$(stat -c "%u:%g" "$release_conffile")"
  98             local owning_group="${ownership#*:}"
  99             if [ 0 != "$owning_group" ]; then
 100                 chgrp "$owning_group" "$CONFIG_PATH" /etc/arvados
 101             fi
 102             chown "$ownership" "$etc_conffile"
 103             chmod --reference="$release_conffile" "$etc_conffile"
 104             ln --force -s "$etc_conffile" "$release_conffile"
 105         fi
 106     fi
 107
 108     if [ -n "$conffile_source" ]; then
 109         if [ ! -e "$etc_conffile" ]; then
 110             install -g "$WWW_OWNER" -m 0640 \
 111                     "$RELEASE_CONFIG_PATH/$conffile_source" "$etc_conffile"
 112             return 1
 113         # Even if $etc_conffile already existed, it might be unmodified from
 114         # the source.  This is especially likely when a user installs, updates
 115         # database.yml, then reconfigures before they update application.yml.
 116         # Use cmp to be sure whether $etc_conffile is modified.
 117         elif cmp --quiet "$RELEASE_CONFIG_PATH/$conffile_source" "$etc_conffile"; then
 118             return 1
 119         fi
 120     fi
 121 }
 122
 123 prepare_database() {
 124   DB_MIGRATE_STATUS=`$COMMAND_PREFIX bundle exec rake db:migrate:status 2>&1 || true`
 125   if echo $DB_MIGRATE_STATUS | grep -qF 'Schema migrations table does not exist yet.'; then
 126       # The database exists, but the migrations table doesn't.
 127       run_and_report "Setting up database" $COMMAND_PREFIX bundle exec \
 128                      rake "$RAILSPKG_DATABASE_LOAD_TASK" db:seed
 129   elif echo $DB_MIGRATE_STATUS | grep -q '^database: '; then
 130       run_and_report "Running db:migrate" \
 131                      $COMMAND_PREFIX bundle exec rake db:migrate
 132   elif echo $DB_MIGRATE_STATUS | grep -q 'database .* does not exist'; then
 133       if ! run_and_report "Running db:setup" \
 134            $COMMAND_PREFIX bundle exec rake db:setup 2>/dev/null; then
 135           echo "Warning: unable to set up database." >&2
 136           DATABASE_READY=0
 137       fi
 138   else
 139     echo "Warning: Database is not ready to set up. Skipping database setup." >&2
 140     DATABASE_READY=0
 141   fi
 142 }
 143
 144 configure_version() {
 145   if [ -n "$WEB_SERVICE" ]; then
 146       SERVICE_MANAGER=$(guess_service_manager)
 147   elif WEB_SERVICE=$(list_services_systemd | grep -E '^(nginx|httpd)'); then
 148       SERVICE_MANAGER=systemd
 149   elif WEB_SERVICE=$(list_services_service \
 150                          | grep -Eo '\b(nginx|httpd)[^[:space:]]*'); then
 151       SERVICE_MANAGER=service
 152   fi
 153
 154   if [ -z "$WEB_SERVICE" ]; then
 155     report_web_service_warning "Web service (Nginx or Apache) not found"
 156   elif [ "$WEB_SERVICE" != "$(echo "$WEB_SERVICE" | head -n 1)" ]; then
 157     WEB_SERVICE=$(echo "$WEB_SERVICE" | head -n 1)
 158     report_web_service_warning \
 159         "Multiple web services found.  Choosing the first one ($WEB_SERVICE)"
 160   fi
 161
 162   if [ -e /etc/redhat-release ]; then
 163       # Recognize any service that starts with "nginx"; e.g., nginx16.
 164       if [ "$WEB_SERVICE" != "${WEB_SERVICE#nginx}" ]; then
 165         WWW_OWNER=nginx
 166       else
 167         WWW_OWNER=apache
 168       fi
 169   else
 170       # Assume we're on a Debian-based system for now.
 171       # Both Apache and Nginx run as www-data by default.
 172       WWW_OWNER=www-data
 173   fi
 174
 175   echo
 176   echo "Assumption: $WEB_SERVICE is configured to serve Rails from"
 177   echo "            $RELEASE_PATH"
 178   echo "Assumption: $WEB_SERVICE and passenger run as $WWW_OWNER"
 179   echo
 180
 181   echo -n "Creating symlinks to configuration in $CONFIG_PATH ..."
 182   setup_confdirs /etc/arvados "$CONFIG_PATH"
 183   setup_conffile environments/production.rb environments/production.rb.example \
 184       || true
 185   setup_conffile application.yml application.yml.example || APPLICATION_READY=0
 186   if [ -n "$RAILSPKG_DATABASE_LOAD_TASK" ]; then
 187       setup_conffile database.yml database.yml.example || DATABASE_READY=0
 188   fi
 189   setup_extra_conffiles
 190   echo "... done."
 191
 192   # Before we do anything else, make sure some directories and files are in place
 193   if [ ! -e $SHARED_PATH/log ]; then mkdir -p $SHARED_PATH/log; fi
 194   if [ ! -e $RELEASE_PATH/tmp ]; then mkdir -p $RELEASE_PATH/tmp; fi
 195   if [ ! -e $RELEASE_PATH/log ]; then ln -s $SHARED_PATH/log $RELEASE_PATH/log; fi
 196   if [ ! -e $SHARED_PATH/log/production.log ]; then touch $SHARED_PATH/log/production.log; fi
 197
 198   cd "$RELEASE_PATH"
 199   export RAILS_ENV=production
 200
 201   if ! $COMMAND_PREFIX bundle --version >/dev/null; then
 202       run_and_report "Installing bundle" $COMMAND_PREFIX gem install bundle
 203   fi
 204
 205   run_and_report "Running bundle install" \
 206       $COMMAND_PREFIX bundle install --path $SHARED_PATH/vendor_bundle --local --quiet
 207
 208   echo -n "Ensuring directory and file permissions ..."
 209   # Ensure correct ownership of a few files
 210   chown "$WWW_OWNER:" $RELEASE_PATH/config/environment.rb
 211   chown "$WWW_OWNER:" $RELEASE_PATH/config.ru
 212   chown "$WWW_OWNER:" $RELEASE_PATH/Gemfile.lock
 213   chown -R "$WWW_OWNER:" $RELEASE_PATH/tmp
 214   chown -R "$WWW_OWNER:" $SHARED_PATH/log
 215   case "$RAILSPKG_DATABASE_LOAD_TASK" in
 216       db:schema:load) chown "$WWW_OWNER:" $RELEASE_PATH/db/schema.rb ;;
 217       db:structure:load) chown "$WWW_OWNER:" $RELEASE_PATH/db/structure.sql ;;
 218   esac
 219   chmod 644 $SHARED_PATH/log/*
 220   chmod -R 2775 $RELEASE_PATH/tmp
 221   echo "... done."
 222
 223   if [ -n "$RAILSPKG_DATABASE_LOAD_TASK" ]; then
 224       prepare_database
 225   fi
 226
 227   if [ 11 = "$RAILSPKG_SUPPORTS_CONFIG_CHECK$APPLICATION_READY" ]; then
 228       run_and_report "Checking application.yml for completeness" \
 229           $COMMAND_PREFIX bundle exec rake config:check || APPLICATION_READY=0
 230   fi
 231
 232   # precompile assets; thankfully this does not take long
 233   if [ "$APPLICATION_READY" = "1" ]; then
 234       run_and_report "Precompiling assets" \
 235           $COMMAND_PREFIX bundle exec rake assets:precompile -q -s 2>/dev/null \
 236           || APPLICATION_READY=0
 237   else
 238       echo "Precompiling assets... skipped."
 239   fi
 240   chown -R "$WWW_OWNER:" $RELEASE_PATH/tmp
 241
 242   setup_before_nginx_restart
 243
 244   if [ -n "$SERVICE_MANAGER" ]; then
 245       service_command "$SERVICE_MANAGER" restart "$WEB_SERVICE"
 246   fi
 247 }
 248
 249 if [ "$1" = configure ]; then
 250   # This is a debian-based system
 251   configure_version
 252 elif [ "$1" = "0" ] || [ "$1" = "1" ] || [ "$1" = "2" ]; then
 253   # This is an rpm-based system
 254   configure_version
 255 fi
 256
 257 report_not_ready "$DATABASE_READY" "$CONFIG_PATH/database.yml"
 258 report_not_ready "$APPLICATION_READY" "$CONFIG_PATH/application.yml"