poise-service 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e4487545f34995b8df8d3ff8ec3972163020bf8
-  data.tar.gz: 829b479bd922af7b93f95346d95b96af74200129
+  metadata.gz: bfe7845772574fbc6fe57ffb8acaa41fe59e7c9f
+  data.tar.gz: 03e35f8aabba36c7ebbb775672b3491e2b65d55a
 SHA512:
-  metadata.gz: cd0ee4d31ce879997b6af819fae90cdfda026098b163da17b536b552a145858c78640595cbd5532b08b2b41e1098a4a13d1fffac85e6c521195e96ca7d11ca17
-  data.tar.gz: 85169c58d825b707b8f558b00d990b6e296dc406297306c1376eaac5beed1ca423628cd8edce1e8f4f50d25b069a04f8402d95c800855bcb8f14d644ac9ed1e3
+  metadata.gz: d4adb8f04f30a3c8a00c4cbf87413c69ece21f64bc23ea468c8a149f6aea6547261ed04aa59b09c2091d9b2895d0ab6478dac656f68cccd83e80fb87e69bb8cd
+  data.tar.gz: 189e48201d52da6f2ad5c4e77d9580ad6a981258fc5392b93a3ea557b1b570e0f36249d8b37b574bf15756532de8a645dc085c47dff0d9332940773f5497d1c9

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Poise-Service Changelog
 
+## v1.1.0
+
+* Added `inittab` provider to manage services using old-fashioned `/etc/inittab`.
+
 ## v1.0.4
 
 * Set GID correctly in all service providers.

data/Gemfile

@@ -28,6 +28,3 @@ end
 dev_gem 'halite'
 dev_gem 'poise'
 dev_gem 'poise-boiler'
-
-# Pending https://github.com/acrmp/foodcritic/pull/312 in a release.
-gem 'foodcritic', github: 'acrmp/foodcritic'

data/README.md

@@ -319,6 +319,31 @@ end
 * `never_reload` – Never try to reload the service.
 * `auto_reload` – Run `systemctl daemon-reload` after changes to the unit file. *(default: true)*
 
+### `inittab`
+
+The `inittab` provider supports managing services via `/etc/inittab` using
+[SystemV Init](http://www.nongnu.org/sysvinit/). This can provide basic
+process supervision even on very old *nix machines.
+
+```ruby
+poise_service 'myapp' do
+  provider :inittab
+  command 'myapp --serve'
+end
+```
+
+**NOTE:** Inittab does not allow stopping services, and they are started as soon
+as they are enabled.
+
+#### Options
+
+* `never_restart` – Never try to restart the service.
+* `never_reload` – Never try to reload the service.
+* `pid_file` – Path to PID file that the service command will create.
+* `service_id` – Unique 1-4 character tag for the service. Defaults to an
+  auto-generated hash based on the service name. If these collide, bad things
+  happen. Don't do that.
+
 ## ServiceMixin
 
 For the common case of a resource (LWRP or plain Ruby) that roughly maps to

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

@@ -0,0 +1,15 @@
+#!/bin/sh
+exec /opt/chef/embedded/bin/ruby <<EOH
+require 'etc'
+IO.write("<%= @pid_file %>", Process.pid)
+Dir.chdir("<%= @directory %>")
+ent = Etc.getpwnam("<%= @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
+(ENV["HOME"] = Dir.home("<%= @user %>")) rescue nil
+<%= @environment.map {|key, value| "ENV[\"#{key}\"] = \"#{value}\"" }.join("; ") %>
+exec(*<%= Shellwords.split(@command).inspect %>)
+EOH

data/lib/poise_service/service_providers.rb

@@ -17,6 +17,7 @@
 require 'chef/platform/provider_priority_map'
 
 require 'poise_service/service_providers/dummy'
+require 'poise_service/service_providers/inittab'
 require 'poise_service/service_providers/systemd'
 require 'poise_service/service_providers/sysvinit'
 require 'poise_service/service_providers/upstart'

data/lib/poise_service/service_providers/inittab.rb

@@ -0,0 +1,150 @@
+#
+# 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 'chef/util/file_edit'
+
+require 'poise_service/service_providers/base'
+
+
+module PoiseService
+  module ServiceProviders
+    class Inittab < Base
+      provides(:inittab)
+
+      def self.provides_auto?(node, resource)
+        ::File.exist?('/etc/inittab')
+      end
+
+      def pid
+        IO.read(pid_file).to_i if ::File.exist?(pid_file)
+      end
+
+      # Don't try to stop when disabling because we can't.
+      def action_disable
+        disable_service
+        notifying_block do
+          destroy_service
+        end
+      end
+
+      def action_start
+        Chef::Log.debug("[#{new_resource}] Inittab services are always started.")
+      end
+
+      def action_stop
+        raise NotImplementedError.new("[#{new_resource}] Inittab services cannot be stopped")
+      end
+
+      def action_restart
+        return if options['never_restart']
+        # Just kill it and let init restart it.
+        Process.kill(new_resource.stop_signal, pid) if pid
+      end
+
+      def action_reload
+        return if options['never_reload']
+        Process.kill(new_resource.reload_signal, pid) if pid
+      end
+
+      private
+
+      def service_resource
+        # Intentionally not implemented.
+        raise NotImplementedError
+      end
+
+      def enable_service
+      end
+
+      def disable_service
+      end
+
+      def create_service
+        # Sigh scoping.
+        pid_file_ = pid_file
+        # Inittab only allows 127 characters for the command, so cram stuff in
+        # a file. Writing to a file is gross, but so is using inittab so ¯\_(ツ)_/¯.
+        service_template("/sbin/poise_service_#{new_resource.service_name}", 'inittab.sh.erb') do
+          mode '755'
+          variables.update(
+            pid_file: pid_file_,
+          )
+        end
+        # Add to inittab.
+        edit_inittab do |content|
+          inittab_line = "#{service_id}:2345:respawn:/sbin/poise_service_#{new_resource.service_name}"
+          if content =~ /^# #{Regexp.escape(service_tag)}$/
+            # Existing line, update in place.
+            content.gsub!(/^(# #{Regexp.escape(service_tag)}\n)(.*)$/, "\\1#{inittab_line}")
+          else
+            # Add to the end.
+            content << "# #{service_tag}\n#{inittab_line}\n"
+          end
+        end
+      end
+
+      def destroy_service
+        # Remove from inittab.
+        edit_inittab do |content|
+          content.gsub!(/^# #{Regexp.escape(service_tag)}\n.*?\n$/, '')
+        end
+
+        file "/sbin/poise_service_#{new_resource.service_name}" do
+          action :delete
+        end
+
+        file pid_file do
+          action :delete
+        end
+      end
+
+      # The shortened ID because sysvinit only allows 4 characters.
+      def service_id
+        # This is a terrible hash, but it should be good enough.
+        options['service_id'] || begin
+          sum = new_resource.service_name.sum(20).to_s(36)
+          if sum.length < 4
+            'p' + sum
+          else
+            sum
+          end
+        end
+      end
+
+      # Tag to put in a comment in inittab for tracking.
+      def service_tag
+        "poise_service(#{new_resource.service_name})"
+      end
+
+      def pid_file
+        options['pid_file'] || "/var/run/#{new_resource.service_name}.pid"
+      end
+
+      def edit_inittab(&block)
+        inittab = IO.read('/etc/inittab')
+        original_inittab = inittab.dup
+        block.call(inittab)
+        if inittab != original_inittab
+          file '/etc/inittab' do
+            content inittab
+          end
+
+          execute 'telinit q'
+        end
+      end
+    end
+  end
+end

data/lib/poise_service/version.rb

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

data/test/cookbooks/poise-service_test/recipes/default.rb

@@ -24,6 +24,7 @@ end
 if node['platform_family'] == 'rhel' && node['platform_version'].start_with?('7')
   file '/no_sysvinit'
   file '/no_upstart'
+  file '/no_inittab'
 
   poise_service_test 'systemd' do
     service_provider :systemd
@@ -39,7 +40,14 @@ else
 
   if node['platform_family'] == 'rhel' && node['platform_version'].start_with?('5')
     file '/no_upstart'
+
+    poise_service_test 'inittab' do
+      service_provider :inittab
+      base_port 10000
+    end
   else
+    file '/no_inittab'
+
     poise_service_test 'upstart' do
       service_provider :upstart
       base_port 7000

data/test/integration/default/serverspec/default_spec.rb

@@ -43,3 +43,7 @@ end
 describe 'dummy provider' do
   it_should_behave_like 'a poise_service_test', 'dummy', 9000, false
 end
+
+describe 'inittab provider', unless: File.exist?('/no_inittab') do
+  it_should_behave_like 'a poise_service_test', 'inittab', 10000, false
+end

data/test/spec/service_providers/inittab_spec.rb

@@ -0,0 +1,288 @@
+#
+# 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 'spec_helper'
+
+describe PoiseService::ServiceProviders::Inittab do
+  service_provider('inittab')
+  step_into(:poise_service)
+  let(:inittab) { '' }
+  before do
+    allow(IO).to receive(:read).and_call_original
+    allow(IO).to receive(:read).with('/etc/inittab').and_return(inittab)
+  end
+
+  context 'with action :enable' do
+    recipe do
+      poise_service 'test' do
+        command 'myapp --serve'
+      end
+    end
+
+    it { is_expected.to render_file('/sbin/poise_service_test').with_content(<<-EOS) }
+#!/bin/sh
+exec /opt/chef/embedded/bin/ruby <<EOH
+require 'etc'
+IO.write("/var/run/test.pid", Process.pid)
+Dir.chdir("/")
+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
+EOS
+
+    context 'with an empty inittab' do
+      it { is_expected.to render_file('/etc/inittab').with_content(eq(<<-EOH)) }
+# poise_service(test)
+pcg:2345:respawn:/sbin/poise_service_test
+EOH
+    end # /context with an empty inittab
+
+    context 'with a normal inittab' do
+      let(:inittab) { <<-EOH }
+# Run gettys in standard runlevels
+co:2345:respawn:/sbin/agetty xvc0 9600 vt100-nav
+#1:2345:respawn:/sbin/mingetty tty1
+#2:2345:respawn:/sbin/mingetty tty2
+#3:2345:respawn:/sbin/mingetty tty3
+#4:2345:respawn:/sbin/mingetty tty4
+#5:2345:respawn:/sbin/mingetty tty5
+#6:2345:respawn:/sbin/mingetty tty6
+
+# Run xdm in runlevel 5
+x:5:respawn:/etc/X11/prefdm -nodaemon
+EOH
+
+      it { is_expected.to render_file('/etc/inittab').with_content(eq(<<-EOH)) }
+# Run gettys in standard runlevels
+co:2345:respawn:/sbin/agetty xvc0 9600 vt100-nav
+#1:2345:respawn:/sbin/mingetty tty1
+#2:2345:respawn:/sbin/mingetty tty2
+#3:2345:respawn:/sbin/mingetty tty3
+#4:2345:respawn:/sbin/mingetty tty4
+#5:2345:respawn:/sbin/mingetty tty5
+#6:2345:respawn:/sbin/mingetty tty6
+
+# Run xdm in runlevel 5
+x:5:respawn:/etc/X11/prefdm -nodaemon
+# poise_service(test)
+pcg:2345:respawn:/sbin/poise_service_test
+EOH
+    end # /context with a normal inittab
+
+    context 'with an existing line' do
+      let(:inittab) { <<-EOH }
+# Run gettys in standard runlevels
+co:2345:respawn:/sbin/agetty xvc0 9600 vt100-nav
+#1:2345:respawn:/sbin/mingetty tty1
+#2:2345:respawn:/sbin/mingetty tty2
+#3:2345:respawn:/sbin/mingetty tty3
+#4:2345:respawn:/sbin/mingetty tty4
+#5:2345:respawn:/sbin/mingetty tty5
+#6:2345:respawn:/sbin/mingetty tty6
+
+# Run xdm in runlevel 5
+x:5:respawn:/etc/X11/prefdm -nodaemon
+# poise_service(test)
+pcg:2345:respawn:/sbin/poise_service_test2
+EOH
+
+      it { is_expected.to render_file('/etc/inittab').with_content(eq(<<-EOH)) }
+# Run gettys in standard runlevels
+co:2345:respawn:/sbin/agetty xvc0 9600 vt100-nav
+#1:2345:respawn:/sbin/mingetty tty1
+#2:2345:respawn:/sbin/mingetty tty2
+#3:2345:respawn:/sbin/mingetty tty3
+#4:2345:respawn:/sbin/mingetty tty4
+#5:2345:respawn:/sbin/mingetty tty5
+#6:2345:respawn:/sbin/mingetty tty6
+
+# Run xdm in runlevel 5
+x:5:respawn:/etc/X11/prefdm -nodaemon
+# poise_service(test)
+pcg:2345:respawn:/sbin/poise_service_test
+EOH
+    end # /context with an existing line
+
+    context 'with an existing line that matches' do
+      let(:inittab) { <<-EOH }
+# Run gettys in standard runlevels
+co:2345:respawn:/sbin/agetty xvc0 9600 vt100-nav
+#1:2345:respawn:/sbin/mingetty tty1
+#2:2345:respawn:/sbin/mingetty tty2
+#3:2345:respawn:/sbin/mingetty tty3
+#4:2345:respawn:/sbin/mingetty tty4
+#5:2345:respawn:/sbin/mingetty tty5
+#6:2345:respawn:/sbin/mingetty tty6
+
+# Run xdm in runlevel 5
+x:5:respawn:/etc/X11/prefdm -nodaemon
+# poise_service(test)
+pcg:2345:respawn:/sbin/poise_service_test
+EOH
+
+      it { is_expected.to_not render_file('/etc/inittab') }
+    end # /context with an existing line that matches
+
+    context 'with a long service_id' do
+      recipe do
+        poise_service 'a'*1000 do
+          command 'myapp --serve'
+        end
+      end
+      it { is_expected.to render_file('/etc/inittab').with_content(eq(<<-EOH)) }
+# poise_service(#{'a'*1000})
+22ug:2345:respawn:/sbin/poise_service_#{'a'*1000}
+EOH
+    end # /context with a long service_id
+  end # /context with action :enable
+
+  context 'with action :disable' do
+    recipe do
+      poise_service 'test' do
+        action :disable
+      end
+    end
+
+    it { is_expected.to delete_file('/sbin/poise_service_test') }
+    it { is_expected.to delete_file('/var/run/test.pid') }
+
+    context 'with an empty inittab' do
+      it { is_expected.to_not render_file('/etc/inittab') }
+    end # /context with an empty inittab
+
+    context 'with a normal inittab' do
+      let(:inittab) { <<-EOH }
+# Run gettys in standard runlevels
+co:2345:respawn:/sbin/agetty xvc0 9600 vt100-nav
+#1:2345:respawn:/sbin/mingetty tty1
+#2:2345:respawn:/sbin/mingetty tty2
+#3:2345:respawn:/sbin/mingetty tty3
+#4:2345:respawn:/sbin/mingetty tty4
+#5:2345:respawn:/sbin/mingetty tty5
+#6:2345:respawn:/sbin/mingetty tty6
+
+# Run xdm in runlevel 5
+x:5:respawn:/etc/X11/prefdm -nodaemon=
+EOH
+
+      it { is_expected.to_not render_file('/etc/inittab') }
+    end # /context with a normal inittab
+
+    context 'with an existing line' do
+      let(:inittab) { <<-EOH }
+# Run gettys in standard runlevels
+co:2345:respawn:/sbin/agetty xvc0 9600 vt100-nav
+#1:2345:respawn:/sbin/mingetty tty1
+#2:2345:respawn:/sbin/mingetty tty2
+#3:2345:respawn:/sbin/mingetty tty3
+#4:2345:respawn:/sbin/mingetty tty4
+#5:2345:respawn:/sbin/mingetty tty5
+#6:2345:respawn:/sbin/mingetty tty6
+
+# Run xdm in runlevel 5
+x:5:respawn:/etc/X11/prefdm -nodaemon
+# poise_service(test)
+pcg:2345:respawn:/sbin/poise_service_test2
+EOH
+
+      it { is_expected.to render_file('/etc/inittab').with_content(eq(<<-EOH)) }
+# Run gettys in standard runlevels
+co:2345:respawn:/sbin/agetty xvc0 9600 vt100-nav
+#1:2345:respawn:/sbin/mingetty tty1
+#2:2345:respawn:/sbin/mingetty tty2
+#3:2345:respawn:/sbin/mingetty tty3
+#4:2345:respawn:/sbin/mingetty tty4
+#5:2345:respawn:/sbin/mingetty tty5
+#6:2345:respawn:/sbin/mingetty tty6
+
+# Run xdm in runlevel 5
+x:5:respawn:/etc/X11/prefdm -nodaemon
+EOH
+    end # /context with an existing line
+  end # /context with action :disable
+
+  context 'with action :stop' do
+    recipe do
+      poise_service 'test' do
+        action :stop
+      end
+    end
+
+    it { expect { subject }.to raise_error NotImplementedError }
+  end # /context with action :stop
+
+  context 'with action :restart' do
+    recipe do
+      poise_service 'test' do
+        action :restart
+      end
+    end
+    before do
+      allow(File).to receive(:exist?).and_call_original
+      allow(File).to receive(:exist?).with('/var/run/test.pid').and_return(true)
+      allow(IO).to receive(:read).and_call_original
+      allow(IO).to receive(:read).with('/var/run/test.pid').and_return('100')
+    end
+
+    it do
+      expect(Process).to receive(:kill).with('TERM', 100)
+      run_chef
+    end
+  end # /context with action :restart
+
+  context 'with action :reload' do
+    recipe do
+      poise_service 'test' do
+        action :reload
+      end
+    end
+    before do
+      allow(File).to receive(:exist?).and_call_original
+      allow(File).to receive(:exist?).with('/var/run/test.pid').and_return(true)
+      allow(IO).to receive(:read).and_call_original
+      allow(IO).to receive(:read).with('/var/run/test.pid').and_return('100')
+    end
+
+    it do
+      expect(Process).to receive(:kill).with('HUP', 100)
+      run_chef
+    end
+  end # /context with action :reload
+
+  describe '#pid' do
+    subject { described_class.new(nil, nil) }
+    before do
+      allow(File).to receive(:exist?).and_call_original
+      allow(File).to receive(:exist?).with('/pid').and_return(true)
+      allow(IO).to receive(:read).and_call_original
+      allow(IO).to receive(:read).with('/pid').and_return('100')
+      expect(subject).to receive(:pid_file).and_return('/pid').at_least(:once)
+    end
+    its(:pid) { is_expected.to eq 100 }
+  end # /describe #pid
+
+  describe '#service_resource' do
+    subject { described_class.new(nil, nil).send(:service_resource) }
+    it { expect { subject }.to raise_error NotImplementedError }
+  end # /describe #service_resource
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poise-service
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Noah Kantrowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-29 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: halite
@@ -86,6 +86,7 @@ files:
 - Rakefile
 - chef/attributes/default.rb
 - chef/templates/default/dummy.json.erb
+- chef/templates/default/inittab.sh.erb
 - chef/templates/default/systemd.service.erb
 - chef/templates/default/sysvinit.sh.erb
 - chef/templates/default/upstart.conf.erb
@@ -100,6 +101,7 @@ files:
 - lib/poise_service/service_providers.rb
 - lib/poise_service/service_providers/base.rb
 - lib/poise_service/service_providers/dummy.rb
+- lib/poise_service/service_providers/inittab.rb
 - lib/poise_service/service_providers/systemd.rb
 - lib/poise_service/service_providers/sysvinit.rb
 - lib/poise_service/service_providers/upstart.rb
@@ -121,6 +123,7 @@ files:
 - test/spec/service_mixin_spec.rb
 - test/spec/service_providers/base_spec.rb
 - test/spec/service_providers/dummy_spec.rb
+- test/spec/service_providers/inittab_spec.rb
 - test/spec/service_providers/systemd_spec.rb
 - test/spec/service_providers/sysvinit_spec.rb
 - test/spec/service_providers/upstart_spec.rb
@@ -166,6 +169,7 @@ test_files:
 - test/spec/service_mixin_spec.rb
 - test/spec/service_providers/base_spec.rb
 - test/spec/service_providers/dummy_spec.rb
+- test/spec/service_providers/inittab_spec.rb
 - test/spec/service_providers/systemd_spec.rb
 - test/spec/service_providers/sysvinit_spec.rb
 - test/spec/service_providers/upstart_spec.rb