poise-service 1.0.0

data/lib/poise_service/resources/poise_service_test.rb

@@ -0,0 +1,200 @@
+#
+# 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/resource'
+require 'chef/provider'
+require 'poise'
+
+
+module PoiseService
+  module Resources
+    # (see PoiseServiceTest::Resource)
+    module PoiseServiceTest
+      # A `poise_service_test` resource for integration testing service providers.
+      # This is used in Test-Kitchen tests to ensure all providers behave
+      # similarly.
+      #
+      # @since 1.0.0
+      # @provides poise_service_test
+      # @action run
+      # @example
+      #   poise_service_test 'upstart' do
+      #     service_provider :upstart
+      #     base_port 5000
+      #   end
+      class Resource < Chef::Resource
+        include Poise
+        provides(:poise_service_test)
+        actions(:run)
+
+        # @!attribute service_provider
+        #   Service provider to set for the test group.
+        #   @return [Symbol]
+        attribute(:service_provider, kind_of: Symbol)
+        # @!attribute base_port
+        #   Port number to start from for the test group.
+        #   @return [Integer]
+        attribute(:base_port, kind_of: Integer)
+      end
+
+      # Provider for `poise_service_test`.
+      #
+      # @see Resource
+      # @provides poise_service_test
+      class Provider < Chef::Provider
+        include Poise
+        provides(:poise_service_test)
+
+        SERVICE_SCRIPT = <<-EOH
+require 'webrick'
+require 'json'
+require 'etc'
+FILE_DATA = ''
+server = WEBrick::HTTPServer.new(Port: ARGV[0].to_i)
+server.mount_proc '/' do |req, res|
+  res.body = {
+    directory: Dir.getwd,
+    user: Etc.getpwuid(Process.uid).name,
+    group: Etc.getgrgid(Process.gid).name,
+    environment: ENV.to_hash,
+    file_data: FILE_DATA,
+    pid: Process.pid,
+  }.to_json
+end
+EOH
+
+        # `run` action for `poise_service_test`. Create all test services.
+        #
+        # @return [void]
+        def action_run
+          notifying_block do
+            create_script
+            create_noterm_script
+            create_user
+            create_tests
+          end
+        end
+
+        private
+
+        def create_script
+          file '/usr/bin/poise_test' do
+            owner 'root'
+            group 'root'
+            mode '755'
+            content <<-EOH
+#!/opt/chef/embedded/bin/ruby
+#{SERVICE_SCRIPT}
+def load_file
+  FILE_DATA.replace(IO.read(ARGV[1]))
+end
+if ARGV[1]
+  load_file
+  trap('HUP') do
+    load_file
+  end
+end
+server.start
+EOH
+          end
+        end
+
+        def create_noterm_script
+          file '/usr/bin/poise_test_noterm' do
+            owner 'root'
+            group 'root'
+            mode '755'
+            content <<-EOH
+#!/opt/chef/embedded/bin/ruby
+trap('HUP', 'IGNORE')
+trap('STOP', 'IGNORE')
+trap('TERM', 'IGNORE')
+#{SERVICE_SCRIPT}
+while true
+  begin
+    server.start
+  rescue Exception
+  rescue StandardError
+  end
+end
+EOH
+          end
+        end
+
+        def create_user
+          poise_service_user 'poise' do
+            home '/tmp'
+          end
+        end
+
+        def create_tests
+          poise_service "poise_test_#{new_resource.name}" do
+            provider new_resource.service_provider if new_resource.service_provider
+            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
+            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
+            action [:enable, :disable]
+            command "/usr/bin/poise_test_noterm #{new_resource.base_port + 2}"
+            stop_signal 'kill'
+          end
+
+          {'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
+              action(:disable)
+              service_name "poise_test_#{new_resource.name}_#{action}"
+            end
+
+            # Write the content to the read on service launch.
+            file "/etc/poise_test_#{new_resource.name}_#{action}" do
+              content 'first'
+            end
+
+            # 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
+              command "/usr/bin/poise_test #{new_resource.base_port + port} /etc/poise_test_#{new_resource.name}_#{action}"
+            end
+
+            # Rewrite the file to second, restart/reload to trigger an update.
+            file "/etc/poise_test_#{new_resource.name}_#{action} again" do
+              path "/etc/poise_test_#{new_resource.name}_#{action}"
+              content 'second'
+              notifies action.to_sym, "poise_service[poise_test_#{new_resource.name}_#{action}]"
+            end
+          end
+
+          ruby_block "/tmp/poise_test_#{new_resource.name}_pid" do
+            block do
+              pid = resources("poise_service[poise_test_#{new_resource.name}]").pid
+              IO.write("/tmp/poise_test_#{new_resource.name}_pid", pid.to_s)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/poise_service/resources/poise_service_user.rb

@@ -0,0 +1,136 @@
+#
+# 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/resource'
+require 'chef/provider'
+require 'poise'
+
+
+module PoiseService
+  module Resources
+    # (see PoiseServiceUser::Resource)
+    module PoiseServiceUser
+      # A `poise_service_user` resource to create service users/groups.
+      #
+      # @since 1.0.0
+      # @provides poise_service_user
+      # @action create
+      # @action remove
+      # @example
+      #   poise_service_user 'myapp' do
+      #     home '/var/tmp'
+      #     group 'nogroup'
+      #   end
+      class Resource < Chef::Resource
+        include Poise
+        provides(:poise_service_user)
+        actions(:create, :remove)
+
+        # @!attribute user
+        #   Name of the user to create. Defaults to the name of the resource.
+        #   @return [String]
+        attribute(:user, kind_of: String, name_attribute: true)
+        # @!attribute group
+        #   Name of the group to create. Defaults to the name of the resource.
+        #   Set to false to disable group creation.
+        #   @return [String, false]
+        attribute(:group, kind_of: [String, FalseClass], name_attribute: true)
+        # @!attribute uid
+        #   UID of the user to create. Optional, if not set the UID will be
+        #   allocated automatically.
+        #   @return [Integer]
+        attribute(:uid, kind_of: Integer)
+        # @!attribute gid
+        #   GID of the group to create. Optional, if not set the GID will be
+        #   allocated automatically.
+        #   @return [Integer]
+        attribute(:gid, kind_of: Integer)
+        # @!attribute home
+        #   Home directory of the user. This directory will not be created if it
+        #   does not exist. Optional.
+        #   @return [String]
+        attribute(:home, kind_of: String)
+      end
+
+      # Provider for `poise_service_user`.
+      #
+      # @see Resource
+      # @provides poise_service_user
+      class Provider < Chef::Provider
+        include Poise
+        provides(:poise_service_user)
+
+        # `create` action for `poise_service_user`. Ensure the user and group (if
+        # enabled) exist.
+        #
+        # @return [void]
+        def action_create
+          notifying_block do
+            create_group if new_resource.group
+            create_user
+          end
+        end
+
+        # `remove` action for `poise_service_user`. Ensure the user and group (if
+        # enabled) are destroyed.
+        #
+        # @return [void]
+        def action_remove
+          notifying_block do
+            remove_user
+            remove_group if new_resource.group
+          end
+        end
+
+        private
+
+        # Create the system group.
+        def create_group
+          group new_resource.group do
+            gid new_resource.gid
+            system true
+          end
+        end
+
+        # Create the system user.
+        def create_user
+          user new_resource.user do
+            comment "Service user for #{new_resource.name}"
+            gid new_resource.group if new_resource.group
+            home new_resource.home
+            shell '/bin/false'
+            system true
+            uid new_resource.uid
+          end
+        end
+
+        # Remove the system group.
+        def remove_group
+          create_group.tap do |r|
+            r.action(:remove)
+          end
+        end
+
+        # Remove the system user.
+        def remove_user
+          create_user.tap do |r|
+            r.action(:remove)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/poise_service/service_mixin.rb

@@ -0,0 +1,192 @@
+#
+# 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'
+
+require 'poise_service/resources/poise_service'
+
+
+module PoiseService
+  # Mixin for application services. This is any resource that will be part of
+  # an application deployment and involves running a persistent service.
+  #
+  # @since 1.0.0
+  # @example
+  #   module MyApp
+  #     class Resource < Chef::Resource
+  #       include Poise
+  #       provides(:my_app)
+  #       include PoiseService::ServiceMixin
+  #     end
+  #
+  #     class Provider < Chef::Provider
+  #       include Poise
+  #       provides(:my_app)
+  #       include PoiseService::ServiceMixin
+  #
+  #       def action_enable
+  #         notifying_block do
+  #           template '/etc/myapp.conf' do
+  #             # ...
+  #           end
+  #         end
+  #         super
+  #       end
+  #
+  #       def service_options(r)
+  #         r.command('myapp --serve')
+  #       end
+  #     end
+  #   end
+  module ServiceMixin
+    include Poise::Utils::ResourceProviderMixin
+
+    # Mixin for service wrapper resources.
+    #
+    # @see ServiceMixin
+    module Resource
+      include Poise::Resource
+
+      module ClassMethods
+        # @api private
+        def included(klass)
+          super
+          klass.extend(ClassMethods)
+          klass.class_exec do
+            actions(:enable, :disable, :start, :stop, :restart, :reload)
+            attribute(:service_name, kind_of: String, name_attribute: true)
+          end
+        end
+      end
+
+      extend ClassMethods
+    end
+
+    # Mixin for service wrapper providers.
+    #
+    # @see ServiceMixin
+    module Provider
+      include Poise::Provider
+
+      # Default enable action for service wrappers.
+      #
+      # @return [void]
+      def action_enable
+        notify_if_service do
+          service_resource.run_action(:enable)
+        end
+      end
+
+      # Default disable action for service wrappers.
+      #
+      # @return [void]
+      def action_disable
+        notify_if_service do
+          service_resource.run_action(:disable)
+        end
+      end
+
+      # Default start action for service wrappers.
+      #
+      # @return [void]
+      def action_start
+        notify_if_service do
+          service_resource.run_action(:start)
+        end
+      end
+
+      # Default stop action for service wrappers.
+      #
+      # @return [void]
+      def action_stop
+        notify_if_service do
+          service_resource.run_action(:stop)
+        end
+      end
+
+      # Default restart action for service wrappers.
+      #
+      # @return [void]
+      def action_restart
+        notify_if_service do
+          service_resource.run_action(:restart)
+        end
+      end
+
+      # Default reload action for service wrappers.
+      #
+      # @return [void]
+      def action_reload
+        notify_if_service do
+          service_resource.run_action(:reload)
+        end
+      end
+
+      # @todo Add reload once poise-service supports it.
+
+      private
+
+      # Set the current resource as notified if the provided block updates the
+      # service resource.
+      #
+      # @api public
+      # @param block [Proc] Block to run.
+      # @return [void]
+      # @example
+      #   notify_if_service do
+      #     service_resource.run_action(:enable)
+      #   end
+      def notify_if_service(&block)
+        service_resource.updated_by_last_action(false)
+        block.call if block
+        new_resource.updated_by_last_action(true) if service_resource.updated_by_last_action?
+      end
+
+      # Service resource for this service wrapper. This returns a
+      # poise_service resource that will not be added to the resource
+      # collection. Override {#service_options} to set service resource
+      # parameters.
+      #
+      # @api public
+      # @return [Chef::Resource]
+      # @example
+      #   service_resource.run_action(:restart)
+      def service_resource
+        @service_resource ||= PoiseService::Resources::PoiseService::Resource.new(new_resource.name, run_context).tap do |r|
+          # Set some defaults.
+          r.enclosing_provider = self
+          r.source_line = new_resource.source_line
+          r.service_name(new_resource.service_name)
+          # Call the subclass hook for more specific settings.
+          service_options(r)
+        end
+      end
+
+      # Abstract hook to set parameters on {#service_resource} when it is
+      # created. This is required to set at least `resource.command`.
+      #
+      # @api public
+      # @param resource [Chef::Resource] Resource instance to set parameters on.
+      # @return [void]
+      # @example
+      #   def service_options(resource)
+      #     resource.command('myapp --serve')
+      #   end
+      def service_options(resource)
+      end
+    end
+  end
+end