from-scratch 0.3.0 → 0.5.0

data/cookbooks/runit/TESTING.md

@@ -0,0 +1,26 @@
+Testing
+=======
+This cookbook has tests in the GitHub repository. To run the tests:
+
+    git clone git://github.com/hw-cookbooks/runit.git
+    cd runit
+    bundle install
+
+There are two kinds of tests, unit tests and integration tests.
+
+## Unit Tests
+
+The resource/provider code is unit tested with rspec. To run these
+tests, use rake:
+
+    bundle exec rake spec
+
+## Integration Tests
+
+Integration tests are setup to run under minitest-chef. They are
+automatically run under test kitchen.
+
+    bundle exec kitchen test
+
+This tests the default recipe ("default" configuration), and various
+uses of the `runit_service` resource ("service" configuration).

data/cookbooks/runit/attributes/default.rb

@@ -0,0 +1,62 @@
+#
+# Cookbook Name:: runit
+# Attribute File:: sv_bin
+#
+# Copyright 2008-2009, Chef Software, Inc.
+#
+# 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.
+#
+
+case node['platform_family']
+when 'debian'
+  default['runit']['sv_bin'] = '/usr/bin/sv'
+  default['runit']['chpst_bin'] = '/usr/bin/chpst'
+  default['runit']['service_dir'] = '/etc/service'
+  default['runit']['sv_dir'] = '/etc/sv'
+  default['runit']['lsb_init_dir'] = '/etc/init.d'
+  default['runit']['executable'] = '/sbin/runit'
+
+  if node['platform'] == 'debian'
+    default['runit']['start'] = 'runsvdir-start'
+    default['runit']['stop'] = ''
+    default['runit']['reload'] = ''
+  elsif node['platform'] == 'ubuntu'
+    default['runit']['start'] = 'start runsvdir'
+    default['runit']['stop'] = 'stop runsvdir'
+    default['runit']['reload'] = 'reload runsvdir'
+  end
+
+when 'rhel', 'fedora'
+  default['runit']['sv_bin'] = '/sbin/sv'
+  default['runit']['chpst_bin'] = '/sbin/chpst'
+  default['runit']['service_dir'] = '/etc/service'
+  default['runit']['sv_dir'] = '/etc/sv'
+  default['runit']['lsb_init_dir'] = '/etc/init.d'
+  default['runit']['executable'] = '/sbin/runit'
+  default['runit']['prefer_local_yum'] = node['runit']['use_package_from_yum'] || false
+  default['runit']['start'] = '/etc/init.d/runit-start start'
+  default['runit']['stop'] = '/etc/init.d/runit-start stop'
+  default['runit']['reload'] = '/etc/init.d/runit-start reload'
+
+when 'gentoo'
+  default['runit']['sv_bin'] = '/usr/bin/sv'
+  default['runit']['chpst_bin'] = '/usr/bin/chpst'
+  default['runit']['service_dir'] = '/var/service'
+  default['runit']['sv_dir'] = '/etc/sv'
+  default['runit']['lsb_init_dir'] = '/etc/init.d'
+  default['runit']['executable'] = '/sbin/runit'
+  default['runit']['start'] = '/etc/init.d/runit-start start'
+  default['runit']['stop'] = '/etc/init.d/runit-start stop'
+  default['runit']['reload'] = '/etc/init.d/runit-start reload'
+
+end

data/cookbooks/runit/files/default/runit.seed

@@ -0,0 +1 @@
+runit   runit/signalinit        boolean true

data/cookbooks/runit/files/ubuntu-6.10/runsvdir

@@ -0,0 +1,6 @@
+start on runlevel-2
+start on runlevel-3
+start on runlevel-4
+start on runlevel-5
+stop on shutdown
+respawn /usr/sbin/runsvdir-start

data/cookbooks/runit/files/ubuntu-7.04/runsvdir

@@ -0,0 +1,7 @@
+start on runlevel 2
+start on runlevel 3
+start on runlevel 4
+start on runlevel 5
+stop on shutdown
+respawn
+exec /usr/sbin/runsvdir-start

data/cookbooks/runit/files/ubuntu-7.10/runsvdir

@@ -0,0 +1,7 @@
+start on runlevel 2
+start on runlevel 3
+start on runlevel 4
+start on runlevel 5
+stop on shutdown
+respawn
+exec /usr/sbin/runsvdir-start

data/cookbooks/runit/files/ubuntu-8.04/runsvdir

@@ -0,0 +1,7 @@
+start on runlevel 2
+start on runlevel 3
+start on runlevel 4
+start on runlevel 5
+stop on shutdown
+respawn
+exec /usr/sbin/runsvdir-start

data/cookbooks/runit/libraries/helpers.rb

@@ -0,0 +1,190 @@
+#
+# Cookbook:: runit
+# Libraries:: helpers
+#
+# Author: Joshua Timberman <joshua@chef.io>
+# Author: Sean OMeara <sean@chef.io>
+# Copyright 2008-2015, Chef Software, Inc. <legal@chef.io>
+#
+# 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 RunitCookbook
+  module Helpers
+    # include Chef::Mixin::ShellOut if it is not already included in the calling class
+    def self.included(klass)
+      unless klass.ancestors.include?(Chef::Mixin::ShellOut)
+        klass.class_eval { include Chef::Mixin::ShellOut }
+      end
+    end
+
+    # Default settings for resource properties.
+    def parsed_sv_bin
+      return new_resource.sv_bin if new_resource.sv_bin
+      '/usr/bin/sv'
+    end
+
+    def parsed_sv_dir
+      return new_resource.sv_dir if new_resource.sv_dir
+      '/etc/sv'
+    end
+
+    def parsed_service_dir
+      return new_resource.service_dir if new_resource.service_dir
+      '/etc/service'
+    end
+
+    def parsed_lsb_init_dir
+      return new_resource.lsb_init_dir if new_resource.lsb_init_dir
+      '/etc/init.d'
+    end
+
+    # misc helper functions
+    def inside_docker?
+      results = `cat /proc/1/cgroup`.strip.split("\n")
+      results.any? { |val| /docker/ =~ val }
+    end
+
+    def down_file
+      "#{sv_dir_name}/down"
+    end
+
+    def env_dir
+      "#{sv_dir_name}/env"
+    end
+
+    def extra_env_files?
+      files = []
+      Dir.glob("#{sv_dir_name}/env/*").each do |f|
+        files << File.basename(f)
+      end
+      return true if files.sort != new_resource.env.keys.sort
+      false
+    end
+
+    def zap_extra_env_files
+      Dir.glob("#{sv_dir_name}/env/*").each do |f|
+        unless new_resource.env.key?(File.basename(f))
+          File.unlink(f)
+          Chef::Log.info("removing file #{f}")
+        end
+      end
+    end
+
+    def wait_for_service
+      unless inside_docker?
+        sleep 1 until ::FileTest.pipe?("#{service_dir_name}/supervise/ok")
+
+        if new_resource.log
+          sleep 1 until ::FileTest.pipe?("#{service_dir_name}/log/supervise/ok")
+        end
+      end
+    end
+
+    def runit_sv_works?
+      sv = shell_out("#{sv_bin} --help")
+      sv.exitstatus == 100 && sv.stderr =~ /usage: sv .* command service/
+    end
+
+    def runit_send_signal(signal, friendly_name = nil)
+      friendly_name ||= signal
+      converge_by("send #{friendly_name} to #{new_resource}") do
+        shell_out!("#{sv_bin} #{sv_args}#{signal} #{service_dir_name}")
+        Chef::Log.info("#{new_resource} sent #{friendly_name}")
+      end
+    end
+
+    def running?
+      cmd = shell_out("#{sv_bin} #{sv_args}status #{service_dir_name}")
+      (cmd.stdout =~ /^run:/ && cmd.exitstatus == 0)
+    end
+
+    def log_running?
+      cmd = shell_out("#{sv_bin} #{sv_args}status #{service_dir_name}/log")
+      (cmd.stdout =~ /^run:/ && cmd.exitstatus == 0)
+    end
+
+    def enabled?
+      ::File.exist?("#{service_dir_name}/run")
+    end
+
+    def log_service_name
+      "#{new_resource.service_name}/log"
+    end
+
+    def sv_dir_name
+      "#{parsed_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 sv_bin
+      parsed_sv_bin
+    end
+
+    def service_dir_name
+      "#{new_resource.service_dir}/#{new_resource.service_name}"
+    end
+
+    def log_dir_name
+      "#{new_resource.service_dir}/#{new_resource.service_name}/log"
+    end
+
+    def template_cookbook
+      new_resource.cookbook.nil? ? new_resource.cookbook_name.to_s : new_resource.cookbook
+    end
+
+    def default_logger_content
+      <<-EOS
+#!/bin/sh
+exec svlogd -tt #{new_resource.log_dir}
+      EOS
+    end
+
+    def disable_service
+      shell_out("#{new_resource.sv_bin} #{sv_args}down #{service_dir_name}")
+      FileUtils.rm(service_dir_name)
+    end
+
+    def start_service
+      shell_out!("#{new_resource.sv_bin} #{sv_args}start #{service_dir_name}")
+    end
+
+    def stop_service
+      shell_out!("#{new_resource.sv_bin} #{sv_args}stop #{service_dir_name}")
+    end
+
+    def restart_service
+      shell_out!("#{new_resource.sv_bin} #{sv_args}restart #{service_dir_name}")
+    end
+
+    def restart_log_service
+      shell_out!("#{new_resource.sv_bin} #{sv_args}restart #{service_dir_name}/log")
+    end
+
+    def reload_service
+      shell_out!("#{new_resource.sv_bin} #{sv_args}force-reload #{service_dir_name}")
+    end
+
+    def reload_log_service
+      if log_running?
+        shell_out!("#{new_resource.sv_bin} #{sv_args}force-reload #{service_dir_name}/log")
+      end
+    end
+  end
+end

data/cookbooks/runit/libraries/matchers.rb

@@ -0,0 +1,69 @@
+if defined?(ChefSpec)
+
+  ChefSpec.define_matcher(:runit_service)
+
+  def start_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :start, service)
+  end
+
+  def stop_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :stop, service)
+  end
+
+  def enable_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :enable, service)
+  end
+
+  def disable_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :disable, service)
+  end
+
+  def restart_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :restart, service)
+  end
+
+  def reload_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :reload, service)
+  end
+
+  def status_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :status, service)
+  end
+
+  def once_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :once, service)
+  end
+
+  def hup_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :hup, service)
+  end
+
+  def cont_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :cont, service)
+  end
+
+  def term_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :term, service)
+  end
+
+  def kill_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :kill, service)
+  end
+
+  def up_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :up, service)
+  end
+
+  def down_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :down, service)
+  end
+
+  def usr1_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :usr1, service)
+  end
+
+  def usr2_runit_service(service)
+    ChefSpec::Matchers::ResourceMatcher.new(:runit_service, :usr2, service)
+  end
+
+end

data/cookbooks/runit/libraries/provider_runit_service.rb

@@ -0,0 +1,326 @@
+#
+# Cookbook Name:: runit
+# Provider:: service
+#
+# Author:: Joshua Timberman <jtimberman@chef.io>
+# Author:: Sean OMeara <sean@chef.io>
+# Copyright 2011-2015, Chef Software, Inc.
+#
+# 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.
+#
+
+class Chef
+  class Provider
+    class RunitService < Chef::Provider::LWRPBase
+      unless defined?(VALID_SIGNALS)
+        # Mapping of valid signals with optional friendly name
+        VALID_SIGNALS = Mash.new(
+          :down => nil,
+          :hup => nil,
+          :int => nil,
+          :term => nil,
+          :kill => nil,
+          :quit => nil,
+          :up => nil,
+          :once => nil,
+          :cont => nil,
+          1 => :usr1,
+          2 => :usr2
+        )
+      end
+
+      use_inline_resources if defined?(use_inline_resources)
+
+      def whyrun_supported?
+        true
+      end
+
+      # Mix in helpers from libraries/helpers.rb
+      include RunitCookbook::Helpers
+
+      # actions
+      action :create do
+        # sv_templates
+        if new_resource.sv_templates
+
+          directory sv_dir_name do
+            owner new_resource.owner
+            group new_resource.group
+            mode '0755'
+            recursive true
+            action :create
+          end
+
+          template "#{sv_dir_name}/run" do
+            owner new_resource.owner
+            group new_resource.group
+            source "sv-#{new_resource.run_template_name}-run.erb"
+            cookbook template_cookbook
+            mode '0755'
+            variables(options: new_resource.options)
+            action :create
+          end
+
+          # log stuff
+          if new_resource.log
+            directory "#{sv_dir_name}/log" do
+              owner new_resource.owner
+              group new_resource.group
+              recursive true
+              action :create
+            end
+
+            directory "#{sv_dir_name}/log/main" do
+              owner new_resource.owner
+              group new_resource.group
+              mode '0755'
+              recursive true
+              action :create
+            end
+
+            directory new_resource.log_dir do
+              owner new_resource.owner
+              group new_resource.group
+              mode '00755'
+              recursive true
+              action :create
+            end
+
+            template "#{sv_dir_name}/log/config" do
+              owner new_resource.owner
+              group new_resource.group
+              mode '00644'
+              cookbook 'runit'
+              source 'log-config.erb'
+              variables(config: new_resource)
+              action :create
+            end
+
+            link "#{new_resource.log_dir}/config" do
+              to "#{sv_dir_name}/log/config"
+            end
+
+            if new_resource.default_logger
+              file "#{sv_dir_name}/log/run" do
+                content default_logger_content
+                owner new_resource.owner
+                group new_resource.group
+                mode '00755'
+                action :create
+              end
+            else
+              template "#{sv_dir_name}/log/run" do
+                owner new_resource.owner
+                group new_resource.group
+                mode '00755'
+                source "sv-#{new_resource.log_template_name}-log-run.erb"
+                cookbook template_cookbook
+                variables(options: new_resource.options)
+                action :create
+              end
+            end
+
+          end
+
+          # environment stuff
+          directory "#{sv_dir_name}/env" do
+            owner new_resource.owner
+            group new_resource.group
+            mode '00755'
+            action :create
+          end
+
+          new_resource.env.map do |var, value|
+            file "#{sv_dir_name}/env/#{var}" do
+              owner new_resource.owner
+              group new_resource.group
+              content value
+              mode 00640
+              action :create
+            end
+          end
+
+          ruby_block "zap extra env files for #{new_resource.name} service" do
+            block { zap_extra_env_files }
+            only_if { extra_env_files? }
+            not_if { new_resource.env.empty? }
+            action :run
+          end
+
+          if new_resource.check
+            template "#{sv_dir_name}/check" do
+              owner new_resource.owner
+              group new_resource.group
+              mode '00755'
+              cookbook template_cookbook
+              source "sv-#{new_resource.check_script_template_name}-check.erb"
+              variables(options: new_resource.options)
+              action :create
+            end
+          end
+
+          if new_resource.finish
+            template "#{sv_dir_name}/finish" do
+              owner new_resource.owner
+              group new_resource.group
+              mode '00755'
+              source "sv-#{new_resource.finish_script_template_name}-finish.erb"
+              cookbook template_cookbook
+              variables(options: new_resource.options) if new_resource.options.respond_to?(:has_key?)
+              action :create
+            end
+          end
+
+          directory "#{sv_dir_name}/control" do
+            owner new_resource.owner
+            group new_resource.group
+            mode '00755'
+            action :create
+          end
+
+          new_resource.control.map do |signal|
+            template "#{sv_dir_name}/control/#{signal}" do
+              owner new_resource.owner
+              group new_resource.group
+              mode '0755'
+              source "sv-#{new_resource.control_template_names[signal]}-#{signal}.erb"
+              cookbook template_cookbook
+              variables(options: new_resource.options)
+              action :create
+            end
+          end
+
+          # lsb_init
+          if node['platform'] == 'debian'
+            ruby_block "unlink #{parsed_lsb_init_dir}/#{new_resource.service_name}" do
+              block { ::File.unlink("#{parsed_lsb_init_dir}/#{new_resource.service_name}") }
+              only_if { ::File.symlink?("#{parsed_lsb_init_dir}/#{new_resource.service_name}") }
+            end
+
+            template "#{parsed_lsb_init_dir}/#{new_resource.service_name}" do
+              owner 'root'
+              group 'root'
+              mode '00755'
+              cookbook 'runit'
+              source 'init.d.erb'
+              variables(
+                name: new_resource.service_name,
+                sv_bin: new_resource.sv_bin,
+                init_dir: ::File.join(parsed_lsb_init_dir, '')
+              )
+              action :create
+            end
+          else
+            link "#{parsed_lsb_init_dir}/#{new_resource.service_name}" do
+              to sv_bin
+              action :create
+            end
+          end
+
+          # Create/Delete service down file
+          # To prevent unexpected behavior, require users to explicitly set
+          # delete_downfile to remove any down file that may already exist
+          df_action = :nothing
+          if new_resource.start_down
+            df_action = :create
+          elsif new_resource.delete_downfile
+            df_action = :delete
+          end
+
+          file down_file do
+            mode 00644
+            backup false
+            content '# File created and managed by chef!'
+            action df_action
+          end
+        end
+      end
+
+      action :disable do
+        ruby_block "disable #{new_resource.service_name}" do
+          block { disable_service }
+          only_if { enabled? }
+        end
+      end
+
+      action :enable do
+        # FIXME: remove action_create in next major version
+        action_create
+
+        directory new_resource.service_dir
+
+        link "#{service_dir_name}" do
+          to sv_dir_name
+          action :create
+        end
+
+        ruby_block "wait for #{new_resource.service_name} service socket" do
+          block do
+            wait_for_service
+          end
+          action :run
+        end
+      end
+
+      # signals
+      VALID_SIGNALS.each do |signal, signal_name|
+        action(signal_name || signal) do
+          if running?
+            Chef::Log.info "#{new_resource} signalled (#{(signal_name || signal).to_s.upcase})"
+            runit_send_signal(signal, signal_name)
+          else
+            Chef::Log.debug "#{new_resource} not running - nothing to do"
+          end
+        end
+      end
+
+      action :nothing do
+      end
+
+      action :restart do
+        restart_service
+      end
+
+      action :start do
+        if running?
+          Chef::Log.debug "#{new_resource} already running - nothing to do"
+        else
+          start_service
+          Chef::Log.info "#{new_resource} started"
+        end
+      end
+
+      action :stop do
+        if running?
+          stop_service
+          Chef::Log.info "#{new_resource} stopped"
+        else
+          Chef::Log.debug "#{new_resource} already stopped - nothing to do"
+        end
+      end
+
+      action :reload do
+        if running?
+          reload_service
+          Chef::Log.info "#{new_resource} reloaded"
+        else
+          Chef::Log.debug "#{new_resource} not running - nothing to do"
+        end
+      end
+
+      action :status do
+        running?
+      end
+    end
+  end
+end