poise-service 1.0.0

data/Rakefile

@@ -0,0 +1,17 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'poise_boiler/rakefile'

data/chef/attributes/default.rb

@@ -0,0 +1,19 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+default['poise-service']['provider'] = 'auto'
+
+default['poise-service']['options'] = {}

data/chef/templates/systemd.service.erb

@@ -0,0 +1,13 @@
+[Unit]
+Description=<%= @name %>
+
+[Service]
+Environment=<%= @environment.map {|key, val| %Q{"#{key}=#{val}"} }.join(' ') %>
+ExecStart=<%= @command %>
+ExecReload=/bin/kill -<%= @reload_signal %> $MAINPID
+KillSignal=<%= @stop_signal %>
+User=<%= @user %>
+WorkingDirectory=<%= @directory %>
+
+[Install]
+WantedBy=multi-user.target

data/chef/templates/sysvinit.sh.erb

@@ -0,0 +1,177 @@
+#!/bin/sh
+# Init script for <%= @name %> generated by poise-service
+#
+### BEGIN INIT INFO
+# Provides: <%= @name %>
+# Required-Start: $remote_fs $syslog
+# Required-Stop: $remote_fs $syslog
+# Default-Start: 2 3 4 5
+# Default-Stop: 0 1 6
+# Short-Description: Init script for <%= @name %>
+# Description: Init script for <%= @name %>
+### END INIT INFO
+
+<%- @environment.each do |key, val| -%>
+export <%= key %>="<%= val %>"
+<%- end -%>
+
+<%- if @platform_family == 'debian' -%>
+. /lib/lsb/init-functions
+
+_start() {
+  start-stop-daemon --start --quiet --background \
+      --pidfile "<%= @pid_file %>"<% unless @pid_file_external %> --make-pidfile<% end %> \
+      --chuid "<%= @user %>" --chdir "<%= @directory %>" \
+      --exec "<%= @daemon %>" -- <%= @daemon_options %>
+}
+
+_stop() {
+  start-stop-daemon --stop --quiet --pidfile "<%= @pid_file %>" --user "<%= @user %>" --signal "<%= @stop_signal %>"
+}
+
+_status() {
+  status_of_proc -p "<%= @pid_file %>" "<%= @daemon %>" "<%= @name %>"
+}
+
+_reload() {
+  start-stop-daemon --stop --quiet --pidfile "<%= @pid_file %>" --user "<%= @user %>" --signal "<%= @reload_signal %>"
+}
+
+<%- elsif @platform_family == 'rhel' -%>
+. /etc/rc.d/init.d/functions
+
+_pid () {
+  pidof -s -o $$ -o $PPID -o %PPID -x "$1" || pidof -s -o $$ -o $PPID -o %PPID -x "${1##*/}"
+}
+
+_start() {
+  ( cd "<%= @directory %>" && daemon --user "<%= @user %>" --pidfile "<%= @pid_file %>" "<%= @daemon %> <%= @daemon_options %>" >/dev/null 2>&1 ) &
+<%- unless @pid_file_external -%>
+  sleep 1 # Give it some time to start before checking for a pid
+  _pid "<%= @daemon %>" > "<%= @pid_file %>" || return 3
+<%- end -%>
+  return 0 # ¯\_(ツ)_/¯
+}
+
+_stop() {
+  if [ -r "<%= @pid_file %>" ]; then
+    kill -<%= @stop_signal%> "$(cat "<%= @pid_file %>")"
+  else
+    killproc "<%= @daemon %>" -<%= @stop_signal%> >/dev/null
+  fi
+}
+
+_status() {
+  status -p "<%= @pid_file %>" "<%= @daemon %>"
+}
+
+_reload() {
+  if [ -r "<%= @pid_file %>" ]; then
+    kill -<%= @reload_signal%> "$(cat "<%= @pid_file %>")"
+  else
+    return 1
+  fi
+}
+
+<%- # Some functions to match LSB because RHEL doesn't (╯°□°）╯︵ ┻━┻ -%>
+
+log_daemon_msg() {
+  echo -n "$1"
+}
+
+log_progress_msg() {
+  echo -n "$1"
+}
+
+log_warning_msg() {
+  echo -n "$1"
+}
+
+log_failure_msg() {
+  echo -n "$1"
+}
+
+log_end_msg() {
+  if [ "$1" = 0 ]; then
+    success
+  else
+    failure
+  fi
+}
+<%- else -%>
+<%- raise "Platform family #{@platform_family} is not supported" -%>
+<%- end -%>
+
+set -e
+
+start() {
+  if _start
+  then
+    rc=0
+    sleep 1
+    if ! kill -0 "$(cat "<%= @pid_file %>")" >/dev/null 2>&1; then
+        log_failure_msg "<%= @name %> failed to start"
+        rc=1
+    fi
+  else
+    rc=1
+  fi
+  if [ "$rc" -eq 0 ]; then
+    log_end_msg 0
+  else
+    log_end_msg 1
+    rm -f "<%= @pid_file %>"
+  fi
+}
+
+export PATH="${PATH:+$PATH:}/usr/sbin:/sbin"
+
+case "$1" in
+  start)
+    log_daemon_msg "Starting <%= @name %>"
+    if [ -s "<%= @pid_file %>" ] && kill -0 "$(cat "<%= @pid_file %>")" >/dev/null 2>&1; then
+      log_progress_msg "apparently already running"
+      log_end_msg 0
+      exit 0
+    fi
+    start
+  ;;
+
+  stop)
+    log_daemon_msg "Stopping <%= @name %>"
+    _stop
+    log_end_msg "$?"
+    rm -f "<%= @pid_file %>"
+  ;;
+
+  reload|force-reload)
+    log_daemon_msg "Reloading <%= @name %>"
+    _reload
+    log_end_msg "$?"
+  ;;
+
+  restart)
+    set +e
+    log_daemon_msg "Restarting <%= @name %>"
+    if [ -s "<%= @pid_file %>" ] && kill -0 "$(cat "<%= @pid_file %>")" >/dev/null 2>&1; then
+      _stop || true
+      sleep 1
+    else
+      log_warning_msg "<%= @name %> not running, attempting to start."
+      rm -f "<%= @pid_file %>"
+    fi
+    start
+  ;;
+
+  status)
+    set +e
+    _status
+    exit $?
+  ;;
+
+  *)
+    echo "Usage: /etc/init.d/<%= @name %> {start|stop|reload|force-reload|restart|status}"
+    exit 1
+esac
+
+exit 0

data/chef/templates/upstart.conf.erb

@@ -0,0 +1,37 @@
+# <%= @name %> generated by poise-service for <%= @new_resource.to_s %>
+
+description "<%= @name %>"
+
+start on runlevel [2345]
+stop on runlevel [!2345]
+
+respawn
+respawn limit 10 5
+umask 022
+chdir <%= @directory %>
+<%- @environment.each do |key, val| -%>
+env <%= key %>="<%= val %>"
+<%- end -%>
+<%- if @upstart_features[:setuid] -%>
+setuid <%= @user %>
+<%- end -%>
+<%- if @upstart_features[:kill_signal] -%>
+kill signal <%= @stop_signal %>
+<%- end -%>
+<%- if @upstart_features[:reload_signal] -%>
+reload signal <%= @reload_signal %>
+<%- end -%>
+
+<%- if @upstart_features[:setuid] -%>
+exec <%= @command %>
+<%- else -%>
+exec /opt/chef/embedded/bin/ruby -e 'Process.uid = "<%= @user %>"; ENV["HOME"] = Dir.home("<%= @user %>") rescue nil; exec(*<%= Shellwords.split(@command).inspect %>)'
+<%- end -%>
+<%- if !@upstart_features[:kill_signal] && @stop_signal != 'TERM' -%>
+pre-stop script
+  PID=`initctl status <%= @name %> | sed 's/^.*process \([0-9]*\)$/\1/'`
+  if [ -n "$PID" ]; then
+    kill -<%= @stop_signal %> "$PID"
+  fi
+end script
+<%- end -%>

data/lib/poise_service.rb

@@ -0,0 +1,25 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+module PoiseService
+  autoload :Error, 'poise_service/error'
+  autoload :Resources, 'poise_service/resources'
+  autoload :ServiceMixin, 'poise_service/service_mixin'
+  autoload :ServiceProviders, 'poise_service/service_providers'
+  autoload :Utils, 'poise_service/utils'
+  autoload :VERSION, 'poise_service/version'
+end

data/lib/poise_service/cheftie.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'poise_service/resources'
+require 'poise_service/service_providers'

data/lib/poise_service/error.rb

@@ -0,0 +1,20 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module PoiseService
+  class Error < ::Exception
+  end
+end

data/lib/poise_service/resources.rb

@@ -0,0 +1,28 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'poise_service/resources/poise_service'
+require 'poise_service/resources/poise_service_test'
+require 'poise_service/resources/poise_service_user'
+
+
+module PoiseService
+  # Chef resources and providers for poise-service.
+  #
+  # @since 1.0.0
+  module Resources
+  end
+end

data/lib/poise_service/resources/poise_service.rb

@@ -0,0 +1,161 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'etc'
+
+require 'chef/resource'
+require 'poise'
+
+require 'poise_service/error'
+
+
+module PoiseService
+  module Resources
+    # (see PoiseService::Resource)
+    module PoiseService
+      # `poise_service` resource. Provides a unified service interface with a
+      # dependency injection framework.
+      #
+      # @since 1.0.0
+      # @provides poise_service
+      # @action enable
+      # @action disable
+      # @action start
+      # @action stop
+      # @action restart
+      # @action reload
+      # @example
+      #   poise_service 'myapp' do
+      #     command 'myapp --serve'
+      #     user 'myuser'
+      #     directory '/home/myapp'
+      #   end
+      class Resource < Chef::Resource
+        include Poise(inversion: true)
+        provides(:poise_service)
+        actions(:enable, :disable, :start, :stop, :restart, :reload)
+
+        # @!attribute service_name
+        #   Name of the service to the underlying init system. Defaults to the name
+        #   of the resource.
+        #   @return [String]
+        attribute(:service_name, kind_of: String, name_attribute: true)
+        # @!attribute command
+        #   Command to run inside the service. This command must remain in the
+        #   foreground and not daemoinize itself.
+        #   @return [String]
+        attribute(:command, kind_of: String, required: true)
+        # @!attribute user
+        #   User to run the service as. See {UserResource} for an easy way to
+        #   create service users. Defaults to root.
+        #   @return [String]
+        attribute(:user, kind_of: String, default: 'root')
+        # @!attribute directory
+        #   Working directory for the service. Defaults to the home directory of
+        #   the configured user or / if not found.
+        #   @return [String]
+        attribute(:directory, kind_of: String, default: lazy { default_directory })
+        # @!attribute environment
+        #   Environment variables for the service.
+        #   @return [Hash]
+        attribute(:environment, kind_of: Hash, default: {})
+        # @!attribute stop_signal
+        #   Signal to use to stop the service. Some systems will fall back to
+        #   KILL if this signal fails to stop the process. Defaults to TERM.
+        #   @return [String, Symbol, Integer]
+        attribute(:stop_signal, kind_of: [String, Symbol, Integer], default: 'TERM')
+        # @!attribute reload_signal
+        #   Signal to use to reload the service. Defaults to HUP.
+        #   @return [String, Symbol, Integer]
+        attribute(:reload_signal, kind_of: [String, Symbol, Integer], default: 'HUP')
+        # @!attribute restart_on_update
+        #   If true, the service will be restarted if the service definition or
+        #   configuration changes. If 'immediately', the notification will happen
+        #   in immediate mode.
+        #   @return [Boolean, String]
+        attribute(:restart_on_update, equal_to: [true, false, 'immediately', :immediately], default: true)
+
+        # Resource DSL callback.
+        #
+        # @api private
+        def after_created
+          # Set signals to clean values.
+          stop_signal(clean_signal(stop_signal))
+          reload_signal(clean_signal(reload_signal))
+        end
+
+        # Return the PID of the main process for this service or nil if the service
+        # isn't running or the PID cannot be found.
+        #
+        # @return [Integer, nil]
+        # @example
+        #   execute "kill -WINCH #{resources('poise_test[myapp]').pid}"
+        def pid
+          # :pid isn't a real action, but this should still work.
+          provider_for_action(:pid).pid
+        end
+
+        private
+
+        # Try to find the home diretory for the configured user. This will fail if
+        # nsswitch.conf was changed during this run such as with LDAP. Defaults to
+        # the system root directory.
+        #
+        # @see #directory
+        # @return [String]
+        def default_directory
+          # For root we always want the system root path.
+          unless user == 'root'
+            # Force a reload in case any users were created earlier in the run.
+            Etc.endpwent
+            home = begin
+              Dir.home(user)
+            rescue ArgumentError
+              nil
+            end
+          end
+          # Better than nothing
+          home || case node['platform_family']
+          when 'windows'
+            ENV.fetch('SystemRoot', 'C:\\')
+          else
+            '/'
+          end
+        end
+
+        # Clean up a signal string/integer. Ints are mapped to the signal name,
+        # and strings are reformatted to upper case and without the SIG.
+        #
+        # @see #stop_signal
+        # @param signal [String, Symbol, Integer] Signal value to clean.
+        # @return [String]
+        def clean_signal(signal)
+          if signal.is_a?(Integer)
+            raise Error.new("Unknown signal #{signal}") unless (0..31).include?(signal)
+            Signal.signame(signal)
+          else
+            short_sig = signal.to_s.upcase
+            short_sig = short_sig[3..-1] if short_sig.start_with?('SIG')
+            raise Error.new("Unknown signal #{signal}") unless Signal.list.include?(short_sig)
+            short_sig
+          end
+        end
+
+        # Provides can be found under service_providers/.
+      end
+    end
+  end
+end