pkgr 1.2.0 → 1.3.0

data/README.md

@@ -19,9 +19,10 @@ See <https://pkgr.io/showcase> for examples of apps packaged with `pkgr` (Gitlab
 
 ## Installation
 
-Install `pkgr` on a debian based build machine:
+On a debian based build machine:
 
-    sudo apt-get install ruby1.9.1-full
+    sudo apt-get update
+    sudo apt-get install -y build-essential ruby1.9.1-full rubygems1.9.1
     sudo gem install pkgr
 
 ## Usage
@@ -117,6 +118,19 @@ Finally, it's a great way to share your open source software with your users and
 
 * Your application must be Heroku compatible, meaning you should be able to set your main app's configuration via environment variables.
 
+## Troubleshooting
+
+If you're on older versions of Debian, you may need to append `/var/lib/gems/1.9.1/bin` to your PATH to "see" the `pkgr` command:
+
+    export PATH="$PATH:/var/lib/gems/1.9.1/bin"
+
+If you get the following error `ERROR:  While executing gem ... (ArgumentError) invalid byte sequence in US-ASCII` while trying to install `pkgr`, try setting a proper locale, and then retry:
+
+    sudo locale-gen en_US.UTF-8
+    export LANG=en_US.UTF-8
+    export LC_ALL=en_US.UTF-8
+    sudo gem install pkgr
+
 ## Authors
 
 * Cyril Rohr <cyril.rohr@gmail.com> - <http://crohr.me>

data/data/build_dependencies/centos.yml

@@ -0,0 +1,13 @@
+default:
+  - curl
+  - gcc
+  - gcc-c++
+  - kernel-devel
+  - openssl-devel
+  - readline-devel
+  - libxml2-devel
+  - libxslt-devel
+  - libevent-devel
+  - postgresql-devel
+  - mysql-devel
+  - sqlite-devel

data/{lib/pkgr/data/distributions/debian/build_dependencies.yml → data/build_dependencies/debian.yml}

@@ -9,7 +9,7 @@ default:
   - libxslt1-dev
   - libreadline-dev
   - build-essential
-squeeze:
+debian-6:
   - libssl0.9.8
-wheezy:
+debian-7:
   - libssl1.0.0

data/data/build_dependencies/ubuntu.yml

@@ -0,0 +1,15 @@
+default:
+  - curl
+  - libmysqlclient-dev
+  - libpq-dev
+  - libsqlite3-0
+  - libevent-dev
+  - libssl-dev
+  - libxml2-dev
+  - libxslt1-dev
+  - libreadline-dev
+  - build-essential
+ubuntu-10.04:
+  - libssl0.9.8
+ubuntu-12.04:
+  - libssl1.0.0

data/data/buildpacks/centos-6

@@ -0,0 +1,2 @@
+https://github.com/pkgr/heroku-buildpack-ruby.git#487c79e8cc3ab038ac13fef82d1e59a9c6ac39e6,BUILDPACK_VENDOR_URL="https://s3-external-1.amazonaws.com/pkgr-buildpack-ruby/20140408175240-centos-6.4",BUILDPACK_NODE_VERSION="0.6.8",CURL_CONNECT_TIMEOUT=60,CURL_TIMEOUT=300
+https://github.com/heroku/heroku-buildpack-nodejs.git#v58

data/data/buildpacks/debian-6

@@ -0,0 +1,2 @@
+https://github.com/heroku/heroku-buildpack-ruby.git,CURL_CONNECT_TIMEOUT=60,CURL_TIMEOUT=300
+https://github.com/heroku/heroku-buildpack-nodejs.git

data/{lib/pkgr/data/distributions/debian/buildpacks/debian_wheezy → data/buildpacks/debian-7}

@@ -1,2 +1,2 @@
-https://github.com/pkgr/heroku-buildpack-ruby.git#487c79e8cc3ab038ac13fef82d1e59a9c6ac39e6,BUILDPACK_VENDOR_URL="https://s3-external-1.amazonaws.com/pkgr-buildpack-ruby/20140408175240-debian-7.4",BUILDPACK_NODE_VERSION="0.6.8"
+https://github.com/pkgr/heroku-buildpack-ruby.git#487c79e8cc3ab038ac13fef82d1e59a9c6ac39e6,BUILDPACK_VENDOR_URL="https://s3-external-1.amazonaws.com/pkgr-buildpack-ruby/20140408175240-debian-7.4",BUILDPACK_NODE_VERSION="0.6.8",CURL_CONNECT_TIMEOUT=60,CURL_TIMEOUT=300
 https://github.com/heroku/heroku-buildpack-nodejs.git#v58

data/data/buildpacks/ubuntu-10.04

@@ -0,0 +1,2 @@
+https://github.com/heroku/heroku-buildpack-ruby.git,CURL_CONNECT_TIMEOUT=60,CURL_TIMEOUT=300
+https://github.com/heroku/heroku-buildpack-nodejs.git

data/{lib/pkgr/data/distributions/debian/buildpacks/ubuntu_precise → data/buildpacks/ubuntu-12.04}

@@ -1,2 +1,2 @@
-https://github.com/pkgr/heroku-buildpack-ruby.git#487c79e8cc3ab038ac13fef82d1e59a9c6ac39e6,BUILDPACK_VENDOR_URL="https://s3-external-1.amazonaws.com/pkgr-buildpack-ruby/20140408175240-ubuntu-12.04",BUILDPACK_NODE_VERSION="0.6.8"
+https://github.com/pkgr/heroku-buildpack-ruby.git#487c79e8cc3ab038ac13fef82d1e59a9c6ac39e6,BUILDPACK_VENDOR_URL="https://s3-external-1.amazonaws.com/pkgr-buildpack-ruby/20140408175240-ubuntu-12.04",BUILDPACK_NODE_VERSION="0.6.8",CURL_CONNECT_TIMEOUT=60,CURL_TIMEOUT=300
 https://github.com/heroku/heroku-buildpack-nodejs.git#v58

data/{lib/pkgr/data/distributions/debian/runner.erb → data/cli/cli.sh.erb}

@@ -2,61 +2,100 @@
 # Generated by pkgr.
 
 set -e
+set -o pipefail
 
-EXECUTABLE=$(basename $0)
+APP_NAME=$(basename $0)
+# useful for testing
+ROOT_PATH=${ROOT_PATH:="/"}
 
-function usage {
+# Helper function that returns the real path, based on the given ROOT_PATH
+_p() {
+  echo "${ROOT_PATH%%/}${1}"
+}
+
+usage() {
   echo "Usage:"
-  echo "  $EXECUTABLE run COMMAND [options]"
-  echo "  $EXECUTABLE scale TYPE=NUM"
-  echo "  $EXECUTABLE config:get VAR"
-  echo "  $EXECUTABLE config:set VAR=VALUE"
-  exit 1
+  echo "  $APP_NAME run COMMAND [options]"
+  echo "  $APP_NAME scale TYPE=NUM"
+  echo "  $APP_NAME logs [--tail|-n NUMBER]"
+  echo "  $APP_NAME config:get VAR"
+  echo "  $APP_NAME config:set VAR=VALUE"
+}
+
+
+# Returns the type of process manager supported by the current distribution.
+runner() {
+  if [ -f $(_p /etc/debian_version) ]; then
+    case "$(cat $(_p /etc/debian_version))" in
+      wheezy*|squeeze*|jessie*)
+        echo "upstart"
+        ;;
+      *)
+        echo "sysv"
+        ;;
+    esac
+  elif [ -f $(_p /etc/redhat-release) ]; then
+    echo "upstart"
+  fi
 }
 
 if [ ! 0 -eq ${EUID} ]; then
-  echo "You must be executing with root privileges to launch commands. Either log in as root, use sudo, or add sudo privileges for running ${EXECUTABLE} with your user."
+  echo "You must be executing with root privileges to launch commands."
+  echo "Either log in as root, use sudo, or add sudo privileges for running ${APP_NAME} with your user."
   exit 1
 fi
 
-DEFAULT_FILE=/etc/default/<%= name %>
+DEFAULT_FILE=$(_p "/etc/default/${APP_NAME}")
 
 # Source all environment variables for the app. This must be done as
 # privileged user since the config variables are only readable by root.
 . ${DEFAULT_FILE}
 
-# Returns the type of process manager supported by the current distribution.
-function process_manager() {
-  version=$(cat /etc/debian_version)
-
-  case "$version" in
-    wheezy*|squeeze*)
-      init_system="upstart"
-      ;;
-    *)
-      init_system="sysv"
-      ;;
-  esac
+for file in $(_p "/etc/${APP_NAME}/conf.d")/*; do
+  if [ -f $file ]; then . $file; fi
+done
 
-  echo "${init_system}"
-}
+for file in $(_p "${APP_HOME}/.profile.d")/*.sh; do
+  # .profile.d scripts assume HOME indicates the path to the app directory
+  if [ -f $file ]; then HOME=${APP_HOME} . $file; fi
+done
 
 # You can force a specific process manager by setting the PROCESS_MANAGER
 # environment variable.
-PROCESS_MANAGER=${PROCESS_MANAGER:=$(process_manager)}
+PROCESS_MANAGER=${PROCESS_MANAGER:=$(runner)}
 
-function current_number_of_processes() {
+# Return all the environment variables accessible to the app.
+show_env() {
+  env -i ROOT_PATH=${ROOT_PATH} ${0} run env | sort
+}
+
+logs() {
+  if [ "$1" = "" ]; then
+    for file in $(_p "/var/log/${APP_NAME}")/*.log ; do
+      echo "==> ${file} <=="
+      cat "${file}"
+    done
+  else
+    tail $(_p "/var/log/${APP_NAME}")/*.log $@
+  fi
+}
+
+tail_logs() {
+  tail -f $(_p "/var/log/${APP_NAME}")/*.log
+}
+
+current_number_of_processes() {
   PROCESS_NAME="$1"
   if [ "${PROCESS_MANAGER}" = "upstart" ]; then
-    echo $(ls -rv1 /etc/init/${APP_NAME}-${PROCESS_NAME}-*.conf 2>/dev/null | head -1 | sed -r 's/.*\-([0-9]+)\.conf/\1/g')
+    echo $(ls -rv1 $(_p /etc/init/)${APP_NAME}-${PROCESS_NAME}-*.conf 2>/dev/null | head -1 | sed -r 's/.*\-([0-9]+)\.conf/\1/g')
   else
-    echo $(ls -rv1 /etc/init.d/${APP_NAME}-${PROCESS_NAME}-* 2>/dev/null | head -1 | sed -r 's/.*\-([0-9]+)/\1/g')
+    echo $(ls -rv1 $(_p /etc/init.d/)${APP_NAME}-${PROCESS_NAME}-* 2>/dev/null | head -1 | sed -r 's/.*\-([0-9]+)/\1/g')
   fi
 
   return 0
 }
 
-function update_port() {
+update_port() {
   file="$1"
   process_name="$2"
   port="$3"
@@ -71,7 +110,7 @@ function update_port() {
   fi
 }
 
-function scale_up() {
+scale_up() {
   PROCESS_NAME="${1}"
   CURRENT_SCALE=${2}
   NEW_SCALE=${3}
@@ -80,15 +119,18 @@ function scale_up() {
   echo "Scaling up..."
 
   if [ "${PROCESS_MANAGER}" = "upstart" ]; then
-    cp "${HOME}/vendor/pkgr/scaling/upstart/${APP_NAME}.conf" /etc/init/
-    cp "${HOME}/vendor/pkgr/scaling/upstart/${APP_NAME}-${PROCESS_NAME}.conf" /etc/init/
+    # copy master
+    cp $(_p "${APP_HOME}/vendor/pkgr/scaling/upstart/${APP_NAME}.conf") $(_p "/etc/init/")
+    # copy master process
+    cp $(_p "${APP_HOME}/vendor/pkgr/scaling/upstart/${APP_NAME}-${PROCESS_NAME}.conf") $(_p "/etc/init/")
+
     for i in $(seq ${SCALE_DELTA}); do
       index=$((${i} + ${CURRENT_SCALE}))
       PROCESS_ID="${APP_NAME}-${PROCESS_NAME}-${index}"
-      cp "${HOME}/vendor/pkgr/scaling/upstart/${APP_NAME}-${PROCESS_NAME}-PROCESS_NUM.conf" "/etc/init/${PROCESS_ID}.conf"
+      cp $(_p "${APP_HOME}/vendor/pkgr/scaling/upstart/${APP_NAME}-${PROCESS_NAME}-PROCESS_NUM.conf") $(_p "/etc/init/${PROCESS_ID}.conf")
       port=$((${PORT} + ${index} - 1))
 
-      update_port "/etc/init/${PROCESS_ID}.conf" "${PROCESS_NAME}" $port $index
+      update_port $(_p "/etc/init/${PROCESS_ID}.conf") "${PROCESS_NAME}" $port $index
 
       service "${PROCESS_ID}" start
     done
@@ -96,29 +138,29 @@ function scale_up() {
     service ${APP_NAME}-${PROCESS_NAME} start || true
     service ${APP_NAME} start || true
   else
-    cp "${HOME}/vendor/pkgr/scaling/sysv/${APP_NAME}" /etc/init.d/
-    chmod a+x /etc/init.d/${APP_NAME}
+    cp $(_p "${APP_HOME}/vendor/pkgr/scaling/sysv/${APP_NAME}") $(_p /etc/init.d/)
+    chmod a+x $(_p "/etc/init.d/${APP_NAME}")
     update-rc.d ${APP_NAME} defaults
-    cp "${HOME}/vendor/pkgr/scaling/sysv/${APP_NAME}-${PROCESS_NAME}" /etc/init.d/
-    chmod a+x /etc/init.d/${APP_NAME}-${PROCESS_NAME}
+    cp $(_p "${APP_HOME}/vendor/pkgr/scaling/sysv/${APP_NAME}-${PROCESS_NAME}") $(_p /etc/init.d/)
+    chmod a+x $(_p "/etc/init.d/${APP_NAME}-${PROCESS_NAME}")
     update-rc.d ${APP_NAME}-${PROCESS_NAME} defaults
     for i in $(seq ${SCALE_DELTA}); do
       index=$((${i} + ${CURRENT_SCALE}))
       PROCESS_ID="${APP_NAME}-${PROCESS_NAME}-${index}"
-      cp "${HOME}/vendor/pkgr/scaling/sysv/${APP_NAME}-${PROCESS_NAME}-PROCESS_NUM" "/etc/init.d/${PROCESS_ID}"
+      cp $(_p "${APP_HOME}/vendor/pkgr/scaling/sysv/${APP_NAME}-${PROCESS_NAME}-PROCESS_NUM") $(_p "/etc/init.d/${PROCESS_ID}")
       port=$((${PORT} + ${index} - 1))
 
-      update_port "/etc/init.d/${PROCESS_ID}" "${PROCESS_NAME}" $port $index
+      update_port $(_p "/etc/init.d/${PROCESS_ID}") "${PROCESS_NAME}" $port $index
 
-      chmod a+x /etc/init.d/${PROCESS_ID}
+      chmod a+x $(_p "/etc/init.d/${PROCESS_ID}")
       update-rc.d ${PROCESS_ID} defaults
-      /etc/init.d/${PROCESS_ID} start
+      $(_p "/etc/init.d/${PROCESS_ID}") start
     done
   fi
   echo "--> done."
 }
 
-function scale_down() {
+scale_down() {
   PROCESS_NAME="${1}"
   CURRENT_SCALE=${2}
   NEW_SCALE=${3}
@@ -131,18 +173,18 @@ function scale_down() {
 
     if [ "${PROCESS_MANAGER}" = "upstart" ]; then
       service "${PROCESS_ID}" stop
-      rm -f "/etc/init/${PROCESS_ID}.conf"
+      rm -f $(_p "/etc/init/${PROCESS_ID}.conf")
     else
-      /etc/init.d/${PROCESS_ID} stop
+      $(_p "/etc/init.d/${PROCESS_ID}") stop
       update-rc.d -f ${PROCESS_ID} remove
-      rm -f "/etc/init.d/${PROCESS_ID}"
+      rm -f $(_p "/etc/init.d/${PROCESS_ID}")
     fi
   done
   echo "--> done."
 }
 
 # Scale processes
-function scale() {
+scale() {
   PROCESS_NAME="$1"
   NEW_SCALE="$2"
 
@@ -159,10 +201,6 @@ function scale() {
   fi
 }
 
-# Return all the environment variables accessible to the app.
-function show_env() {
-  env -i ${0} run env | sort
-}
 
 while : ; do
   case "$1" in
@@ -171,11 +209,11 @@ while : ; do
       COMMAND="$2"
       shift 2
 
-      runnable=$(echo -n "cd ${HOME} && exec")
+      runnable=$(echo -n "exec")
 
-      if [ -f "${HOME}/vendor/pkgr/processes/${COMMAND}" ]; then
+      if [ -f $(_p "${APP_HOME}/vendor/pkgr/processes/${COMMAND}") ]; then
         # Command alias defined in Procfile
-        runnable="${runnable}$(printf " %q" "vendor/pkgr/processes/${COMMAND}" "$@")"
+        runnable="${runnable}$(printf " %q" $(_p "${APP_HOME}/vendor/pkgr/processes/${COMMAND}") "$@")"
       else
         # Everything else.
         #
@@ -188,7 +226,7 @@ while : ; do
       # Do not use su, to avoid creating a new process. Note: chroot version
       # is too old on Ubuntu Lucid, so this will fail. It works on Debian
       # Squeeze though (and later).
-      exec chroot --userspec ${APP_USER}:${APP_GROUP} / sh -c "$runnable"
+      exec chroot --userspec ${APP_USER}:${APP_GROUP} "/" sh -c "cd $(_p ${APP_HOME}) && $runnable"
 
       break ;;
 
@@ -205,6 +243,15 @@ while : ; do
       done
       break ;;
 
+    logs)
+      shift
+      if [ "$1" = "--tail" ]; then
+        tail_logs
+      else
+        logs ${@}
+      fi
+      break;;
+
     config)
       show_env
       break;;
@@ -217,11 +264,12 @@ while : ; do
       VAR=${CONFIG[0]:?"Invalid variable name"}
       VALUE=${CONFIG[1]:?"Invalid value"}
 
-      DEFAULT_CONF_FILE="/etc/${APP_NAME}/conf.d/other"
+      CONFIG_FILE=$(_p "/etc/${APP_NAME}/conf.d/other")
+      touch ${CONFIG_FILE}
 
-      sed -i -r "s/^.*${VAR}.*$//g" /etc/${APP_NAME}/conf.d/*
+      sed -i -r "s/^.*${VAR}.*$//g" $(_p "/etc/${APP_NAME}/conf.d")/*
 
-      echo "export ${VAR}=${VALUE}" >> "${DEFAULT_CONF_FILE}"
+      echo "export ${VAR}=${VALUE}" >> "${CONFIG_FILE}"
 
       break;;
 

data/data/dependencies/centos.yml

@@ -0,0 +1,9 @@
+default:
+  - openssl
+  - readline
+  - libxml2
+  - libxslt
+  - libevent
+  - postgresql-libs
+  - mysql-libs
+  - sqlite

data/{lib/pkgr/data/distributions/debian/dependencies.yml → data/dependencies/debian.yml}

@@ -7,13 +7,13 @@ default:
   - libxslt1.1
   - libreadline5
   - libreadline6
-squeeze:
+debian-6:
   - libssl0.9.8
   - libmysqlclient16
   - libevent-1.4-2
   - libevent-core-1.4-2
   - libevent-extra-1.4-2
-wheezy:
+debian-7:
   - libssl1.0.0
   - libmysqlclient18
   - libevent-2.0-5

data/data/dependencies/ubuntu.yml

@@ -0,0 +1,21 @@
+default:
+  - mysql-common
+  - libpq5
+  - libsqlite3-0
+  - openssl
+  - libxml2
+  - libxslt1.1
+  - libreadline5
+  - libreadline6
+ubuntu-10.04:
+  - libssl0.9.8
+  - libmysqlclient16
+  - libevent-1.4-2
+  - libevent-core-1.4-2
+  - libevent-extra-1.4-2
+ubuntu-12.04:
+  - libssl1.0.0
+  - libmysqlclient18
+  - libevent-2.0-5
+  - libevent-core-2.0-5
+  - libevent-extra-2.0-5

data/data/environment/default.erb

@@ -0,0 +1,9 @@
+# Generated by pkgr
+export APP_HOME="<%= home %>"
+export APP_NAME="<%= name %>"
+export APP_GROUP="<%= group %>"
+export APP_USER="<%= user %>"
+export HOME="/home/<%= user %>"
+<% if runner %>
+export PROCESS_MANAGER="<%= runner.split("-").first %>"
+<% end %>

data/{lib/pkgr/data/distributions/debian → data}/hooks/postinstall.sh

@@ -5,11 +5,11 @@ set -e
 APP_NAME="<%= name %>"
 APP_USER="<%= user %>"
 APP_GROUP="<%= group %>"
-HOME="/opt/${APP_NAME}"
-HOME_LOGS="${HOME}/log"
+APP_HOME="<%= home %>"
+HOME_LOGS="${APP_HOME}/log"
 LOGS="/var/log/${APP_NAME}"
 
-chown -R ${APP_USER}.${APP_GROUP} ${HOME}
+chown -R ${APP_USER}.${APP_GROUP} ${APP_HOME}
 
 # link app log directory to /var/log/NAME
 rm -rf ${HOME_LOGS}
@@ -24,4 +24,7 @@ export DATABASE_URL=db_adapter://db_user:db_password@db_host/db_name
 export PORT=\${PORT:=6000}
 CONF
 
-chmod -R 0600 /etc/${APP_NAME}/conf.d
+chown -R ${APP_USER}.${APP_GROUP} /etc/${APP_NAME}
+
+chmod 0750 /etc/${APP_NAME} /etc/${APP_NAME}/conf.d
+find /etc/${APP_NAME} -type f -exec chmod 0640 {} +