poise-service 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9083e6c7faa81f26cb75ba512932747ca7d78505
-  data.tar.gz: 1cf6379abe8c39cafb38b7d7b5812db1fa24c9d4
+  metadata.gz: 7e4487545f34995b8df8d3ff8ec3972163020bf8
+  data.tar.gz: 829b479bd922af7b93f95346d95b96af74200129
 SHA512:
-  metadata.gz: 475915c90a841a1f8ebadfbf48074440dc2b202a0902c8b50cd362bf2dd523feec27f60d010d9fdc46d6b60079343b53b4d56aa3f96243c1d4c7806c644f370e
-  data.tar.gz: 8ee09393fc20251559c2c275e7bc7cb56b12dc0d091e85ec66c7f6983f263c9a4490a9c888a1b856dfe7b56e54247846f85565d7ef0d23bd47a6afbd88ce2995
+  metadata.gz: cd0ee4d31ce879997b6af819fae90cdfda026098b163da17b536b552a145858c78640595cbd5532b08b2b41e1098a4a13d1fffac85e6c521195e96ca7d11ca17
+  data.tar.gz: 85169c58d825b707b8f558b00d990b6e296dc406297306c1376eaac5beed1ca423628cd8edce1e8f4f50d25b069a04f8402d95c800855bcb8f14d644ac9ed1e3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Poise-Service Changelog
 
+## v1.0.4
+
+* Set GID correctly in all service providers.
+* Allow overriding the path to the generated sysvinit script.
+
 ## v1.0.3
 
 * [#10](https://github.com/poise/poise-service/pull/10) Fixes for ensuring services are restarted when their command or user changes.

data/README.md

@@ -47,6 +47,8 @@ framework is used.
 * Upstart
 * systemd
 * [Runit](https://github.com/poise/poise-service-runit)
+* [Solaris](https://github.com/sh9189/poise-service-solaris)
+* [AIX](https://github.com/johnbellone/poise-service-aix)
 * *Supervisor (coming soon!)*
 
 
@@ -168,8 +170,8 @@ end
 ```
 
 Unlike resource attributes, service options can be different for each provider.
-Not all providers support the same options so make sure to the check the
-documentation for each provider to see what options the use.
+Not all providers support the same options so make sure to check the
+documentation for each provider to see what options are available.
 
 ### `poise_service_options`
 
@@ -236,8 +238,7 @@ end
 
 By default a PID file will be created in `/var/run/service_name.pid`. You can
 use the `pid_file` option detailed below to override this and rely on your
-process creating a PID file in the given path. This is highly recommended on
-RHEL-family platforms as automatic PID detection there is more finicky.
+process creating a PID file in the given path.
 
 #### Options
 
@@ -252,6 +253,7 @@ RHEL-family platforms as automatic PID detection there is more finicky.
 * `user` – Override the service user.
 * `never_restart` – Never try to restart the service.
 * `never_reload` – Never try to reload the service.
+* `script_path` – Override the path to the generated service script.
 
 ### `upstart`
 

data/chef/templates/default/sysvinit.sh.erb

@@ -38,6 +38,7 @@ _start() {
   <%# Implementing this using RedHat's bash helpers is too painful. Sorry. %>
   <%# See dummy.rb for a more commented version of this code. %>
   /opt/chef/embedded/bin/ruby <<EOH
+require 'etc'
 pid_file = <%= @pid_file.inspect %>
 File.unlink(pid_file) if File.exist?(pid_file)
 if Process.fork
@@ -48,7 +49,12 @@ else
   <%- unless @pid_file_external -%>
   IO.write(pid_file, Process.pid)
   <%- end -%>
-  Process::UID.change_privilege(<%= @user.inspect %>)
+  ent = Etc.getpwnam(<%= @user.inspect %>)
+  if Process.euid != ent.uid || Process.egid != ent.gid
+    Process.initgroups(ent.name, ent.gid)
+    Process::GID.change_privilege(ent.gid) if Process.egid != ent.gid
+    Process::UID.change_privilege(ent.uid) if Process.euid != ent.uid
+  end
   Kernel.exec(*<%= Shellwords.split(@command).inspect %>)
   exit!
 end

data/chef/templates/default/upstart.conf.erb

@@ -25,7 +25,19 @@ reload signal <%= @reload_signal %>
 <%- if @upstart_features[:setuid] -%>
 exec <%= @command %>
 <%- else -%>
-exec /opt/chef/embedded/bin/ruby -e 'Process::UID.change_privilege("<%= @user %>"); ENV["HOME"] = Dir.home("<%= @user %>") rescue nil; exec(*<%= Shellwords.split(@command).inspect %>)'
+script
+exec /opt/chef/embedded/bin/ruby <<EOH
+require 'etc'
+ent = Etc.getpwnam(<%= @user.inspect %>)
+if Process.euid != ent.uid || Process.egid != ent.gid
+  Process.initgroups(ent.name, ent.gid)
+  Process::GID.change_privilege(ent.gid) if Process.egid != ent.gid
+  Process::UID.change_privilege(ent.uid) if Process.euid != ent.uid
+end
+ENV["HOME"] = Dir.home(<%= @user.inspect %>) rescue nil
+exec(*<%= Shellwords.split(@command).inspect %>)
+EOH
+end script
 <%- end -%>
 <%- if !@upstart_features[:kill_signal] && @stop_signal != 'TERM' -%>
 pre-stop script

data/lib/poise_service/resources/poise_service.rb

@@ -155,7 +155,7 @@ module PoiseService
           end
         end
 
-        # Provides can be found under service_providers/.
+        # Providers can be found under service_providers/.
       end
     end
   end

data/lib/poise_service/resources/poise_service_test.rb

@@ -44,6 +44,10 @@ module PoiseService
         #   Service provider to set for the test group.
         #   @return [Symbol]
         attribute(:service_provider, kind_of: Symbol)
+        # @!attribute service_options
+        #   Service options to set for the test group.
+        #   @return [Hash, nil]
+        attribute(:service_options, kind_of: [Hash, nil])
         # @!attribute base_port
         #   Port number to start from for the test group.
         #   @return [Integer]
@@ -68,7 +72,9 @@ server.mount_proc '/' do |req, res|
   res.body = {
     directory: Dir.getwd,
     user: Etc.getpwuid(Process.uid).name,
+    euser: Etc.getpwuid(Process.euid).name,
     group: Etc.getgrgid(Process.gid).name,
+    egroup: Etc.getgrgid(Process.egid).name,
     environment: ENV.to_hash,
     file_data: FILE_DATA,
     pid: Process.pid,
@@ -142,19 +148,28 @@ EOH
 
         def create_tests
           poise_service "poise_test_#{new_resource.name}" do
-            provider new_resource.service_provider if new_resource.service_provider
+            if new_resource.service_provider
+              provider new_resource.service_provider
+              options new_resource.service_provider, new_resource.service_options if new_resource.service_options
+            end
             command "/usr/bin/poise_test #{new_resource.base_port}"
           end
 
           poise_service "poise_test_#{new_resource.name}_params" do
-            provider new_resource.service_provider if new_resource.service_provider
+            if new_resource.service_provider
+              provider new_resource.service_provider
+              options new_resource.service_provider, new_resource.service_options if new_resource.service_options
+            end
             command "/usr/bin/poise_test #{new_resource.base_port + 1}"
             environment POISE_ENV: new_resource.name
             user 'poise'
           end
 
           poise_service "poise_test_#{new_resource.name}_noterm" do
-            provider new_resource.service_provider if new_resource.service_provider
+            if new_resource.service_provider
+              provider new_resource.service_provider
+              options new_resource.service_provider, new_resource.service_options if new_resource.service_options
+            end
             action [:enable, :disable]
             command "/usr/bin/poise_test_noterm #{new_resource.base_port + 2}"
             stop_signal 'kill'
@@ -163,7 +178,10 @@ EOH
           {'restart' => 3, 'reload' => 4}.each do |action, port|
             # Stop it before writing the file so we always start with first.
             poise_service "poise_test_#{new_resource.name}_#{action} stop" do
-              provider new_resource.service_provider if new_resource.service_provider
+              if new_resource.service_provider
+                provider new_resource.service_provider
+                options new_resource.service_provider, new_resource.service_options if new_resource.service_options
+              end
               action(:disable)
               service_name "poise_test_#{new_resource.name}_#{action}"
             end
@@ -175,7 +193,10 @@ EOH
 
             # Launch the service, reading in first.
             poise_service "poise_test_#{new_resource.name}_#{action}" do
-              provider new_resource.service_provider if new_resource.service_provider
+              if new_resource.service_provider
+                provider new_resource.service_provider
+                options new_resource.service_provider, new_resource.service_options if new_resource.service_options
+              end
               command "/usr/bin/poise_test #{new_resource.base_port + port} /etc/poise_test_#{new_resource.name}_#{action}"
             end
 
@@ -197,13 +218,19 @@ EOH
 
           # Test changing the service definition itself.
           poise_service "poise_test_#{new_resource.name}_change" do
-            provider new_resource.service_provider if new_resource.service_provider
+            if new_resource.service_provider
+              provider new_resource.service_provider
+              options new_resource.service_provider, new_resource.service_options if new_resource.service_options
+            end
             command "/usr/bin/poise_test #{new_resource.base_port + 5}"
           end
 
           poise_service "poise_test_#{new_resource.name}_change_second" do
             service_name "poise_test_#{new_resource.name}_change"
-            provider new_resource.service_provider if new_resource.service_provider
+            if new_resource.service_provider
+              provider new_resource.service_provider
+              options new_resource.service_provider, new_resource.service_options if new_resource.service_options
+            end
             command "/usr/bin/poise_test #{new_resource.base_port + 6}"
           end
 

data/lib/poise_service/service_providers/dummy.rb

@@ -14,6 +14,7 @@
 # limitations under the License.
 #
 
+require 'etc'
 require 'shellwords'
 
 require 'poise_service/service_providers/base'
@@ -45,7 +46,8 @@ module PoiseService
         else
           # :nocov:
           Chef::Log.debug("[#{new_resource}] Forked")
-          # First child, daemonize and go to town.
+          # First child, daemonize and go to town. This handles multi-fork,
+          # setsid, and shutting down stdin/out/err.
           Process.daemon(true)
           Chef::Log.debug("[#{new_resource}] Daemonized")
           # Daemonized, set up process environment.
@@ -57,8 +59,14 @@ module PoiseService
           end
           Chef::Log.debug("[#{new_resource}] Process environment configured")
           IO.write(pid_file, Process.pid)
-          Chef::Log.debug("[#{new_resource}] PID written to #{pid_file}, dropping privs and execing")
-          Process::UID.change_privilege(new_resource.user)
+          Chef::Log.debug("[#{new_resource}] PID written to #{pid_file}")
+          ent = Etc.getpwnam(new_resource.user)
+          if Process.euid != ent.uid || Process.egid != ent.gid
+            Process.initgroups(ent.name, ent.gid)
+            Process::GID.change_privilege(ent.gid) if Process.egid != ent.gid
+            Process::UID.change_privilege(ent.uid) if Process.euid != ent.uid
+          end
+          Chef::Log.debug("[#{new_resource}] Changed privs to #{new_resource.user} (#{ent.uid}:#{ent.gid})")
           # Split the command so we don't get an extra sh -c.
           Chef::Log.debug("[#{new_resource}] Execing #{new_resource.command}")
           Kernel.exec(*Shellwords.split(new_resource.command))
@@ -71,16 +79,21 @@ module PoiseService
 
       def action_stop
         return unless pid
+        Chef::Log.debug("[#{new_resource}] Stopping with #{new_resource.stop_signal}. Current PID is #{pid.inspect}.")
         Process.kill(new_resource.stop_signal, pid)
         ::File.unlink(pid_file)
       end
 
       def action_restart
+        return if options['never_restart']
         action_stop
         action_start
       end
 
       def action_reload
+        return if options['never_reload']
+        return unless pid
+        Chef::Log.debug("[#{new_resource}] Reloading with #{new_resource.reload_signal}. Current PID is #{pid.inspect}.")
         Process.kill(new_resource.reload_signal, pid)
       end
 

data/lib/poise_service/service_providers/sysvinit.rb

@@ -36,13 +36,14 @@ module PoiseService
         super.tap do |r|
           r.provider(case node['platform_family']
           when 'debian'
-            Chef::Provider::Service::Init::Debian
+            Chef::Provider::Service::Debian
           when 'rhel'
-            Chef::Provider::Service::Init::Redhat
+            Chef::Provider::Service::Redhat
           else
             # This will explode later in the template, but better than nothing for later.
             Chef::Provider::Service::Init
           end)
+          r.init_command(script_path)
         end
       end
 
@@ -56,7 +57,7 @@ module PoiseService
         # Sigh scoping.
         pid_file_ = pid_file
         # Render the service template
-        service_template("/etc/init.d/#{new_resource.service_name}", 'sysvinit.sh.erb') do
+        service_template(script_path, 'sysvinit.sh.erb') do
           mode '755'
           variables.update(
             daemon: daemon,
@@ -69,7 +70,7 @@ module PoiseService
       end
 
       def destroy_service
-        file "/etc/init.d/#{new_resource.service_name}" do
+        file script_path do
           action :delete
         end
 
@@ -78,6 +79,10 @@ module PoiseService
         end
       end
 
+      def script_path
+        options['script_path'] || "/etc/init.d/#{new_resource.service_name}"
+      end
+
       def pid_file
         options['pid_file'] || "/var/run/#{new_resource.service_name}.pid"
       end

data/lib/poise_service/version.rb

@@ -16,5 +16,5 @@
 
 
 module PoiseService
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/test/spec/service_providers/sysvinit_spec.rb

@@ -28,10 +28,10 @@ describe PoiseService::ServiceProviders::Sysvinit do
   context 'on Ubuntu' do
     let(:chefspec_options) { { platform: 'ubuntu', version: '14.04'} }
 
-    it { is_expected.to render_file('/etc/init.d/test').with_content(<<-'EOH') }
-  start-stop-daemon --start --quiet --background \
-      --pidfile "/var/run/test.pid" --make-pidfile \
-      --chuid "root" --chdir "/" \
+    it { is_expected.to render_file('/etc/init.d/test').with_content(<<-EOH) }
+  start-stop-daemon --start --quiet --background \\
+      --pidfile "/var/run/test.pid" --make-pidfile \\
+      --chuid "root" --chdir "/" \\
       --exec "myapp" -- --serve
 EOH
 
@@ -41,10 +41,10 @@ EOH
         override_attributes['poise-service']['test']['pid_file'] = '/tmp/pid'
       end
 
-      it { is_expected.to render_file('/etc/init.d/test').with_content(<<-'EOH') }
-  start-stop-daemon --start --quiet --background \
-      --pidfile "/tmp/pid" \
-      --chuid "root" --chdir "/" \
+      it { is_expected.to render_file('/etc/init.d/test').with_content(<<-EOH) }
+  start-stop-daemon --start --quiet --background \\
+      --pidfile "/tmp/pid" \\
+      --chuid "root" --chdir "/" \\
       --exec "myapp" -- --serve
 EOH
     end # /context with an external PID file
@@ -56,7 +56,12 @@ EOH
     it { is_expected.to render_file('/etc/init.d/test').with_content(<<-EOH) }
   Dir.chdir("/")
   IO.write(pid_file, Process.pid)
-  Process::UID.change_privilege("root")
+  ent = Etc.getpwnam("root")
+  if Process.euid != ent.uid || Process.egid != ent.gid
+    Process.initgroups(ent.name, ent.gid)
+    Process::GID.change_privilege(ent.gid) if Process.egid != ent.gid
+    Process::UID.change_privilege(ent.uid) if Process.euid != ent.uid
+  end
   Kernel.exec(*["myapp", "--serve"])
 EOH
 
@@ -68,7 +73,12 @@ EOH
 
       it { is_expected.to render_file('/etc/init.d/test').with_content(<<-EOH) }
   Dir.chdir("/")
-  Process::UID.change_privilege("root")
+  ent = Etc.getpwnam("root")
+  if Process.euid != ent.uid || Process.egid != ent.gid
+    Process.initgroups(ent.name, ent.gid)
+    Process::GID.change_privilege(ent.gid) if Process.egid != ent.gid
+    Process::UID.change_privilege(ent.uid) if Process.euid != ent.uid
+  end
   Kernel.exec(*["myapp", "--serve"])
 EOH
     end # /context with an external PID file

data/test/spec/service_providers/upstart_spec.rb

@@ -32,7 +32,7 @@ describe PoiseService::ServiceProviders::Upstart do
 
     context 'with upstart 0.6.5' do
       let(:upstart_version) { '0.6.5' }
-      it { is_expected.to render_file('/etc/init/test.conf').with_content(<<-EOH) }
+      it { is_expected.to render_file('/etc/init/test.conf').with_content(<<-EOS) }
 # test generated by poise-service for poise_service[test]
 
 description "test"
@@ -45,8 +45,20 @@ respawn limit 10 5
 umask 022
 chdir /
 
-exec /opt/chef/embedded/bin/ruby -e 'Process::UID.change_privilege("root"); ENV["HOME"] = Dir.home("root") rescue nil; exec(*["myapp", "--serve"])'
+script
+exec /opt/chef/embedded/bin/ruby <<EOH
+require 'etc'
+ent = Etc.getpwnam("root")
+if Process.euid != ent.uid || Process.egid != ent.gid
+  Process.initgroups(ent.name, ent.gid)
+  Process::GID.change_privilege(ent.gid) if Process.egid != ent.gid
+  Process::UID.change_privilege(ent.uid) if Process.euid != ent.uid
+end
+ENV["HOME"] = Dir.home("root") rescue nil
+exec(*["myapp", "--serve"])
 EOH
+end script
+EOS
 
       context 'with a stop signal' do
         recipe do
@@ -56,7 +68,7 @@ EOH
           end
         end
 
-        it { is_expected.to render_file('/etc/init/test.conf').with_content(<<-EOH) }
+        it { is_expected.to render_file('/etc/init/test.conf').with_content(<<-EOS) }
 # test generated by poise-service for poise_service[test]
 
 description "test"
@@ -69,14 +81,26 @@ respawn limit 10 5
 umask 022
 chdir /
 
-exec /opt/chef/embedded/bin/ruby -e 'Process::UID.change_privilege("root"); ENV["HOME"] = Dir.home("root") rescue nil; exec(*["myapp", "--serve"])'
+script
+exec /opt/chef/embedded/bin/ruby <<EOH
+require 'etc'
+ent = Etc.getpwnam("root")
+if Process.euid != ent.uid || Process.egid != ent.gid
+  Process.initgroups(ent.name, ent.gid)
+  Process::GID.change_privilege(ent.gid) if Process.egid != ent.gid
+  Process::UID.change_privilege(ent.uid) if Process.euid != ent.uid
+end
+ENV["HOME"] = Dir.home("root") rescue nil
+exec(*["myapp", "--serve"])
+EOH
+end script
 pre-stop script
   PID=`initctl status test | sed 's/^.*process \\([0-9]*\\)$/\\1/'`
   if [ -n "$PID" ]; then
     kill -KILL "$PID"
   fi
 end script
-EOH
+EOS
       end # /context with a stop signal
     end # /context with upstart 0.6.5
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poise-service
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Noah Kantrowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-05 00:00:00.000000000 Z
+date: 2015-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: halite