poise-service 1.0.0

data/lib/poise_service/service_providers/upstart.rb

@@ -0,0 +1,117 @@
+#
+# 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.
+#
+
+# Used in the template.
+require 'shellwords'
+
+require 'chef/mixin/shell_out'
+
+require 'poise_service/error'
+require 'poise_service/service_providers/base'
+
+
+module PoiseService
+  module ServiceProviders
+    class Upstart < Base
+      include Chef::Mixin::ShellOut
+      provides(:upstart)
+
+      def self.provides_auto?(node, resource)
+        # Don't allow upstart under docker, it won't work.
+        return false if node['virtualization'] && %w{docker lxc}.include?(node['virtualization']['system'])
+        service_resource_hints.include?(:upstart)
+      end
+
+      def action_reload
+        return if options['never_reload']
+        if !upstart_features[:reload_signal] && new_resource.reload_signal != 'HUP'
+          if options[:reload_shim]
+            Process.kill(new_resource.reload_signal, pid)
+          else
+            check_reload_signal!
+          end
+        else
+          super
+        end
+      end
+
+      def pid
+        cmd = shell_out(%w{initctl status} + [new_resource.service_name])
+        if !cmd.error? && md = cmd.stdout.match(/process (\d+)/)
+          md[1].to_i
+        else
+          nil
+        end
+      end
+
+      private
+
+      def service_resource
+        super.tap do |r|
+          r.provider(Chef::Provider::Service::Upstart)
+        end
+      end
+
+      def create_service
+        check_reload_signal!
+        # Set features so it will be a closure below.
+        features = upstart_features
+        service_template("/etc/init/#{new_resource.service_name}.conf", 'upstart.conf.erb') do
+          variables.update(
+            upstart_features: features,
+          )
+        end
+      end
+
+      def destroy_service
+        file "/etc/init/#{new_resource.service_name}.conf" do
+          action :delete
+        end
+      end
+
+      def upstart_version
+        cmd = shell_out(%w{initctl --version})
+        if !cmd.error? && md = cmd.stdout.match(/upstart ([^)]+)\)/)
+          md[1]
+        else
+          '0'
+        end
+      end
+
+      def upstart_features
+        @upstart_features ||= begin
+          upstart_ver = Gem::Version.new(upstart_version)
+          versions_added = {
+            kill_signal: '1.3',
+            reload_signal: '1.10',
+            setuid: '1.4',
+          }
+          versions_added.inject({}) do |memo, (feature, version)|
+            memo[feature] = Gem::Requirement.create(">= #{version}").satisfied_by?(upstart_ver)
+            memo
+          end
+        end
+      end
+
+      def check_reload_signal!
+        if !options['reload_shim'] && !upstart_features[:reload_signal] && new_resource.reload_signal != 'HUP'
+          raise Error.new("Upstart #{upstart_version} only supports HUP for reload, to use the shim please set the 'reload_shim' options for #{new_resource.to_s}")
+        end
+      end
+
+    end
+  end
+end

data/lib/poise_service/utils.rb

@@ -0,0 +1,45 @@
+#
+# 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 'pathname'
+
+
+module PoiseService
+  # Utility methods for PoiseService.
+  #
+  # @api public
+  # @since 1.0.0
+  module Utils
+    # Methods are also available as module-level methods as well as a mixin.
+    extend self
+
+    # Common segments to ignore
+    COMMON_SEGMENTS = %w{var www current etc}.inject({}) {|memo, seg| memo[seg] = true; memo }
+
+    # Parse the service name from a path. Look at the last component of the
+    # path, ignoring some common names.
+    #
+    # @param path [String] Path to parse.
+    # @return [String]
+    # @example
+    #   attribute(:service_name, kind_of: String, default: lazy { PoiseService::Utils.parse_service_name(path) })
+    def parse_service_name(path)
+      parts = Pathname.new(path).each_filename.to_a.reverse!
+      # Find the last segment not in common segments, fall back to the last segment.
+      parts.find {|seg| !COMMON_SEGMENTS[seg] } || parts.first
+    end
+  end
+end

data/lib/poise_service/version.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.
+#
+
+module PoiseService
+  VERSION = '1.0.0'
+end

data/poise-service.gemspec

@@ -0,0 +1,41 @@
+#
+# 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.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'poise_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'poise-service'
+  spec.version = PoiseService::VERSION
+  spec.authors = ['Noah Kantrowitz']
+  spec.email = %w{noah@coderanger.net}
+  spec.description = "A Chef cookbook for managing system services."
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/poise/poise-service'
+  spec.license = 'Apache 2.0'
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w{lib}
+
+  spec.add_dependency 'halite', '~> 1.0'
+  spec.add_dependency 'poise', '~> 2.0'
+
+  spec.add_development_dependency 'kitchen-rackspace', '~> 0.14'
+  spec.add_development_dependency 'poise-boiler', '~> 1.0'
+end

data/test/cookbooks/poise-service_test/metadata.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.
+#
+
+name 'poise-service_test'
+depends 'poise-service'

data/test/cookbooks/poise-service_test/providers/mixin.rb

@@ -0,0 +1,43 @@
+#
+# 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/service_mixin'
+
+include PoiseService::ServiceMixin
+
+def action_enable
+  notifying_block do
+    file "/usr/bin/poise_mixin_#{new_resource.service_name}" do
+      owner 'root'
+      group 'root'
+      mode '755'
+      content <<-EOH
+#!/opt/chef/embedded/bin/ruby
+require 'webrick'
+server = WEBrick::HTTPServer.new(Port: #{new_resource.port})
+server.mount_proc '/' do |req, res|
+  res.body = #{new_resource.message.inspect}
+end
+server.start
+EOH
+    end
+  end
+  super
+end
+
+def service_options(resource)
+  resource.command("/usr/bin/poise_mixin_#{new_resource.service_name}")
+end

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

@@ -0,0 +1,47 @@
+#
+# 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.
+#
+
+# Create the various services.
+poise_service_test 'default' do
+  base_port 5000
+end
+
+if node['platform_family'] == 'rhel' && node['platform_version'].start_with?('7')
+  file '/no_sysvinit'
+  file '/no_upstart'
+
+  poise_service_test 'systemd' do
+    service_provider :systemd
+    base_port 8000
+  end
+else
+  file '/no_systemd'
+
+  poise_service_test 'sysvinit' do
+    service_provider :sysvinit
+    base_port 6000
+  end
+
+  poise_service_test 'upstart' do
+    service_provider :upstart
+    base_port 7000
+  end
+end
+
+poise_service_test 'dummy' do
+  service_provider :dummy
+  base_port 9000
+end

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

@@ -0,0 +1,34 @@
+#
+# 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.
+#
+
+# Integration tests for the mixin.
+poise_service_test_mixin 'default' do
+  service_name 'poise_mixin_default'
+  message 'Hello world!'
+  port 4000
+end
+
+poise_service_test_mixin 'update' do
+  service_name 'poise_mixin_update'
+  message 'first'
+  port 4001
+end
+
+poise_service_test_mixin 'update again' do
+  service_name 'poise_mixin_update'
+  message 'second'
+  port 4001
+end

data/test/cookbooks/poise-service_test/resources/mixin.rb

@@ -0,0 +1,26 @@
+#
+# 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/service_mixin'
+
+include PoiseService::ServiceMixin
+
+attribute :message
+attribute :port
+
+def after_created
+  notifies(:restart, self)
+end

data/test/gemfiles/chef-12.gemfile

@@ -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.
+#
+
+eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
+
+gem 'chef', '~> 12.0'

data/test/gemfiles/master.gemfile

@@ -0,0 +1,22 @@
+#
+# 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.
+#
+
+eval_gemfile File.expand_path('../../../Gemfile', __FILE__)
+
+gem 'chef', github: 'chef/chef'
+gem 'halite', github: 'poise/halite'
+gem 'poise', github: 'poise/poise'
+gem 'poise-boiler', github: 'poise/poise-boiler'