[COOK-3560] Allow the user to configure runit's timeout (-w) and verbose (-v) settings

zuazo · Sean OMeara · commit e231e8d188c5 · 2013-11-04T22:09:36.000-05:00
Signed-off-by: Sean OMeara &lt;someara@opscode.com&gt;
diff --git a/README.md b/README.md
@@ -99,6 +99,9 @@ Many of these parameters are only used in the `:enable` action.
 - **service_name** - *Name attribute*. The name of the service. This
    will be used in the directory of the managed service in the
    `sv_dir` and `service_dir`.
+- **sv_timeout** - Override the default `sv` timeout of 7 seconds.
+- **sv_verbose** - Whether to enable `sv` verbose mode. Default is
+   `false`.
 - **sv_templates** - If true, the `:enable` action will create the
     service directory with the appropriate templates. Default is
     `true`. Set this to `false` if the service has a package that
diff --git a/libraries/provider_runit_service.rb b/libraries/provider_runit_service.rb
@@ -172,34 +172,34 @@ def enable_service
         end
 
         def disable_service
-          shell_out("#{new_resource.sv_bin} down #{service_dir_name}")
+          shell_out("#{new_resource.sv_bin} #{sv_args}down #{service_dir_name}")
           Chef::Log.debug("#{new_resource} down")
           FileUtils.rm(service_dir_name)
           Chef::Log.debug("#{new_resource} service symlink removed")
         end
 
         def start_service
-          shell_out!("#{new_resource.sv_bin} start #{service_dir_name}")
+          shell_out!("#{new_resource.sv_bin} #{sv_args}start #{service_dir_name}")
         end
 
         def stop_service
-          shell_out!("#{new_resource.sv_bin} stop #{service_dir_name}")
+          shell_out!("#{new_resource.sv_bin} #{sv_args}stop #{service_dir_name}")
         end
 
         def restart_service
-          shell_out!("#{new_resource.sv_bin} restart #{service_dir_name}")
+          shell_out!("#{new_resource.sv_bin} #{sv_args}restart #{service_dir_name}")
         end
 
         def restart_log_service
-          shell_out!("#{new_resource.sv_bin} restart #{service_dir_name}/log")
+          shell_out!("#{new_resource.sv_bin} #{sv_args}restart #{service_dir_name}/log")
         end
 
         def reload_service
-          shell_out!("#{new_resource.sv_bin} force-reload #{service_dir_name}")
+          shell_out!("#{new_resource.sv_bin} #{sv_args}force-reload #{service_dir_name}")
         end
 
         def reload_log_service
-          shell_out!("#{new_resource.sv_bin} force-reload #{service_dir_name}/log")
+          shell_out!("#{new_resource.sv_bin} #{sv_args}force-reload #{service_dir_name}/log")
         end
 
         #
@@ -241,19 +241,19 @@ def action_usr2
         def runit_send_signal(signal, friendly_name=nil)
           friendly_name ||= signal
           converge_by("send #{friendly_name} to #{new_resource}") do
-            shell_out!("#{new_resource.sv_bin} #{signal} #{service_dir_name}")
+            shell_out!("#{new_resource.sv_bin} #{sv_args}#{signal} #{service_dir_name}")
             Chef::Log.info("#{new_resource} sent #{friendly_name}")
             new_resource.updated_by_last_action(true)
           end
         end
 
         def running?
-          cmd = shell_out("#{new_resource.sv_bin} status #{new_resource.service_name}")
+          cmd = shell_out("#{new_resource.sv_bin} #{sv_args}status #{new_resource.service_name}")
           (cmd.stdout =~ /^run:/ && cmd.exitstatus == 0)
         end
 
         def log_running?
-          cmd = shell_out("#{new_resource.sv_bin} status #{new_resource.service_name}/log")
+          cmd = shell_out("#{new_resource.sv_bin} #{sv_args}status #{new_resource.service_name}/log")
           (cmd.stdout =~ /^run:/ && cmd.exitstatus == 0)
         end
 
@@ -269,6 +269,13 @@ def sv_dir_name
           ::File.join(new_resource.sv_dir, new_resource.service_name)
         end
 
+        def sv_args
+          sv_args = ''
+          sv_args += "-w '#{new_resource.sv_timeout}' " unless new_resource.sv_timeout.nil?
+          sv_args += '-v ' if new_resource.sv_verbose
+          sv_args
+        end
+
         def service_dir_name
           ::File.join(new_resource.service_dir, new_resource.service_name)
         end
diff --git a/libraries/resource_runit_service.rb b/libraries/resource_runit_service.rb
@@ -61,6 +61,8 @@ def initialize(name, run_context=nil)
         @control_template_names = {}
         @status_command = "#{@sv_bin} status #{@service_dir}"
         @sv_templates = true
+        @sv_timeout = nil
+        @sv_verbose = false
         @log_size = nil
         @log_num = nil
         @log_min = nil
@@ -99,6 +101,14 @@ def sv_dir(arg=nil)
         set_or_return(:sv_dir, arg, :kind_of => [String, FalseClass])
       end
 
+      def sv_timeout(arg=nil)
+        set_or_return(:sv_timeout, arg, :kind_of => [Fixnum])
+      end
+
+      def sv_verbose(arg=nil)
+        set_or_return(:sv_verbose, arg, :kind_of => [TrueClass, FalseClass])
+      end
+
       def service_dir(arg=nil)
         set_or_return(:service_dir, arg, :kind_of => [String])
       end
diff --git a/test/cookbooks/runit_test/files/default/tests/minitest/service_test.rb b/test/cookbooks/runit_test/files/default/tests/minitest/service_test.rb
@@ -54,6 +54,14 @@
     file('/etc/service/finisher/finish').must_exist
   end
 
+  it 'creates a service using sv_timeout' do
+    service('timer').must_be_running
+  end
+
+  it 'creates a service using sv_verbose' do
+    service('chatterbox').must_be_running
+  end
+
   it 'creates a service that uses env files' do
     regexp = %r{\$PATH:/opt/chef/embedded/bin}
     service('env-files').must_be_running
diff --git a/test/cookbooks/runit_test/recipes/service.rb b/test/cookbooks/runit_test/recipes/service.rb
@@ -86,6 +86,17 @@
 # Create a runsvdir service for a normal user
 runit_service "runsvdir-floyd"
 
+# Create a service with different timeout
+runit_service "timer" do
+  sv_timeout 4
+  check true
+end
+
+# Create a service with verbose enabled
+runit_service "chatterbox" do
+  sv_verbose true
+end
+
 # # Create a service running by a normal user in its runsvdir
 runit_service "floyds-app" do
   sv_dir "/home/floyd/sv"
diff --git a/test/cookbooks/runit_test/templates/default/sv-chatterbox-log-run.erb b/test/cookbooks/runit_test/templates/default/sv-chatterbox-log-run.erb
@@ -0,0 +1,2 @@
+#!/bin/sh
+exec svlogd -tt ./main
diff --git a/test/cookbooks/runit_test/templates/default/sv-chatterbox-run.erb b/test/cookbooks/runit_test/templates/default/sv-chatterbox-run.erb
@@ -0,0 +1,4 @@
+#!/bin/sh
+exec 2>&1
+sleep 2
+exec nc -l 6714
diff --git a/test/cookbooks/runit_test/templates/default/sv-timer-check.erb b/test/cookbooks/runit_test/templates/default/sv-timer-check.erb
@@ -0,0 +1,3 @@
+#!/bin/sh
+
+lsof -itcp:6713
diff --git a/test/cookbooks/runit_test/templates/default/sv-timer-log-run.erb b/test/cookbooks/runit_test/templates/default/sv-timer-log-run.erb
@@ -0,0 +1,2 @@
+#!/bin/sh
+exec svlogd -tt ./main
diff --git a/test/cookbooks/runit_test/templates/default/sv-timer-run.erb b/test/cookbooks/runit_test/templates/default/sv-timer-run.erb
@@ -0,0 +1,4 @@
+#!/bin/sh
+exec 2>&1
+sleep 2
+exec nc -l 6713
diff --git a/test/spec/libraries/provider_runit_service_spec.rb b/test/spec/libraries/provider_runit_service_spec.rb
@@ -323,6 +323,112 @@
         provider.run_action(:enable)
       end
 
+      describe 'when sv_timeout is set' do
+        before do
+          new_resource.sv_timeout(60)
+        end
+
+        %w{start up once cont}.each do |action|
+          it "pass a timeout argument on #{action} action to the sv binary" do
+            provider.current_resource.running(false)
+            provider.should_receive(:shell_out!).with("#{sv_bin} -w '60' #{action} #{service_dir_name}")
+            provider.run_action(action.to_sym)
+          end
+        end
+
+        {
+          :usr1 => 1,
+          :usr2 => 2,
+          :reload => 'force-reload',
+        }.each do |action, arg|
+          it "pass a timeout argument on #{action} action to the sv binary" do
+            provider.current_resource.running(true)
+            provider.should_receive(:shell_out!).with("#{sv_bin} -w '60' #{arg} #{service_dir_name}")
+            provider.run_action(action.to_sym)
+          end
+        end
+
+        %w{stop down restart hup int term kill quit}.each do |action|
+          it "pass a timeout argument on #{action} action to the sv binary" do
+            provider.current_resource.running(true)
+            provider.should_receive(:shell_out!).with("#{sv_bin} -w '60' #{action} #{service_dir_name}")
+            provider.run_action(action.to_sym)
+          end
+        end
+
+      end
+
+      describe 'when sv_verbose is true' do
+        before do
+          new_resource.sv_verbose(true)
+        end
+
+            %w{start up once cont}.each do |action|
+          it "pass a verbose argument on #{action} action to the sv binary" do
+            provider.current_resource.running(false)
+            provider.should_receive(:shell_out!).with("#{sv_bin} -v #{action} #{service_dir_name}")
+            provider.run_action(action.to_sym)
+          end
+        end
+
+        {
+          :usr1 => 1,
+          :usr2 => 2,
+          :reload => 'force-reload',
+        }.each do |action, arg|
+          it "pass a verbose argument on #{action} action to the sv binary" do
+            provider.current_resource.running(true)
+            provider.should_receive(:shell_out!).with("#{sv_bin} -v #{arg} #{service_dir_name}")
+            provider.run_action(action.to_sym)
+          end
+        end
+
+        %w{stop down restart hup int term kill quit}.each do |action|
+          it "pass a verbose argument on #{action} action to the sv binary" do
+            provider.current_resource.running(true)
+            provider.should_receive(:shell_out!).with("#{sv_bin} -v #{action} #{service_dir_name}")
+            provider.run_action(action.to_sym)
+          end
+        end
+
+      end
+
+      describe 'when both sv_timeout and sv_verbose are set' do
+        before do
+          new_resource.sv_timeout(60)
+          new_resource.sv_verbose(true)
+        end
+
+            %w{start up once cont}.each do |action|
+          it "pass both timeout and verbose arguments on #{action} action to the sv binary" do
+            provider.current_resource.running(false)
+            provider.should_receive(:shell_out!).with("#{sv_bin} -w '60' -v #{action} #{service_dir_name}")
+            provider.run_action(action.to_sym)
+          end
+        end
+
+        {
+          :usr1 => 1,
+          :usr2 => 2,
+          :reload => 'force-reload',
+        }.each do |action, arg|
+          it "pass both timeout and verbose arguments on #{action} action to the sv binary" do
+            provider.current_resource.running(true)
+            provider.should_receive(:shell_out!).with("#{sv_bin} -w '60' -v #{arg} #{service_dir_name}")
+            provider.run_action(action.to_sym)
+          end
+        end
+
+        %w{stop down restart hup int term kill quit}.each do |action|
+          it "pass both timeout and verbose arguments argument on #{action} action to the sv binary" do
+            provider.current_resource.running(true)
+            provider.should_receive(:shell_out!).with("#{sv_bin} -w '60' -v #{action} #{service_dir_name}")
+            provider.run_action(action.to_sym)
+          end
+        end
+
+      end
+
       it 'creates a symlink from the sv dir to the service' do
         provider.send(:service_link).path.should eq(service_dir_name)
         provider.send(:service_link).to.should eq(sv_dir_name)
diff --git a/test/spec/libraries/resource_runit_service_spec.rb b/test/spec/libraries/resource_runit_service_spec.rb
@@ -36,6 +36,8 @@
   its(:sv_dir) { should eq('/etc/sv') }
   its(:sv_bin) { should eq("/usr/bin/sv") }
   its(:lsb_init_dir) { should eq("/etc/init.d") }
+  its(:sv_timeout) { should eq(nil) }
+  its(:sv_verbose) { should eq(false) }
 
   describe "setting supported default values from node attributes" do
     let(:sv_bin) { "/fake/bin/sv_bin" }
@@ -260,6 +262,16 @@
     resource.sv_templates.should be_false
   end
 
+  it 'has a sv_timeout parameter to control sv_bin timeout' do
+    resource.sv_timeout(30)
+    resource.sv_timeout.should eq(30)
+  end
+
+  it 'has a sv_verbose parameter to control sv_bin verbose mode' do
+    resource.sv_verbose(true)
+    resource.sv_verbose.should eq(true)
+  end
+
   it "has a log_size parameter to control the maximum log size" do
     resource.log_size(1000000)
     resource.log_size.should eq(1000000)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+#!/bin/sh`
	`2`	`+exec svlogd -tt ./main`