poise-application 5.0.0

data/lib/poise_application/service_mixin.rb

@@ -0,0 +1,116 @@
+#
+# 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/utils'
+require 'poise_service/service_mixin'
+require 'poise_service/utils'
+
+require 'poise_application/app_mixin'
+require 'poise_application/utils'
+
+
+module PoiseApplication
+  # Mixin for application services. This is any resource that will be part of
+  # an application deployment and involves running a persistent service.
+  #
+  # @api public
+  # @since 5.0.0
+  # @example
+  #   module MyApp
+  #     class Resource < Chef::Resource
+  #       include Poise
+  #       provides(:my_app)
+  #       include PoiseApplication::ServiceMixin
+  #     end
+  #
+  #     class Provider < Chef::Provider
+  #       include Poise
+  #       provides(:my_app)
+  #       include PoiseApplication::ServiceMixin
+  #
+  #       def action_enable
+  #         notifying_block do
+  #           template '/etc/myapp.conf' do
+  #             # ...
+  #           end
+  #         end
+  #         super
+  #       end
+  #
+  #       def service_options(r)
+  #         super
+  #         r.command('myapp --serve')
+  #       end
+  #     end
+  #   end
+  module ServiceMixin
+    include Poise::Utils::ResourceProviderMixin
+
+    # Mixin for application service resources.
+    #
+    # @see ServiceMixin
+    module Resource
+      include PoiseService::ServiceMixin::Resource
+      include PoiseApplication::AppMixin::Resource
+
+      module ClassMethods
+        # @api private
+        def included(klass)
+          super
+          klass.extend(ClassMethods)
+          klass.class_exec do
+            attribute(:path, kind_of: String, name_attribute: true)
+            # Redefines from the PoiseService version so we get a better default.
+            attribute(:service_name, kind_of: String, default: lazy { PoiseService::Utils.parse_service_name(path) })
+            attribute(:user, kind_of: [String, Integer], default: lazy { parent ? parent.owner : 'root' })
+          end
+        end
+      end
+
+      extend ClassMethods
+    end
+
+    # Mixin for application service providers.
+    #
+    # @see ServiceMixin
+    module Provider
+      include PoiseService::ServiceMixin::Provider
+      include PoiseApplication::AppMixin::Provider
+
+      private
+
+      # 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)
+      #     super
+      #     resource.command('myapp --serve')
+      #   end
+      def service_options(resource)
+        super
+        resource.directory(new_resource.path)
+        resource.user(new_resource.user)
+        resource.environment.update(new_resource.app_state_environment) if new_resource.parent
+      end
+    end
+  end
+end

data/lib/poise_application/utils.rb

@@ -0,0 +1,51 @@
+#
+# 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 'etc'
+
+
+module PoiseApplication
+  # Utility methods for PoiseApplication.
+  #
+  # @api public
+  # @since 5.0.0
+  module Utils
+    # Methods are also available as module-level methods as well as a mixin.
+    extend self
+
+    # Try to find the primary group name for a given user.
+    #
+    # @param user [String, Integer] User to check, if given as an integer this
+    #   is used as a UID, otherwise it is the username.
+    # @return [String]
+    # @example
+    #   attribute(:group, kind_of: [String, Integer], default: lazy { PoiseApplication::Utils.primary_group_for(user) })
+    def primary_group_for(user)
+       # Force a reload in case any users were created earlier in the run.
+      Etc.endpwent
+      Etc.endgrent
+      user = if user.is_a?(Integer)
+        Etc.getpwuid(user)
+      else
+        Etc.getpwnam(user.to_s)
+      end
+      Etc.getgrgid(user.gid).name
+    rescue ArgumentError
+      # One of the get* calls exploded. ¯\_(ツ)_/¯
+      user.to_s
+    end
+  end
+end

data/lib/poise_application/version.rb

@@ -0,0 +1,20 @@
+#
+# 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 PoiseApplication
+  VERSION = '5.0.0'
+end

data/poise-application.gemspec

@@ -0,0 +1,42 @@
+#
+# 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_application/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'poise-application'
+  spec.version = PoiseApplication::VERSION
+  spec.authors = ['Noah Kantrowitz']
+  spec.email = %w{noah@coderanger.net}
+  spec.description = "A Chef cookbook for deploying application code."
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/poise/application'
+  spec.license = 'Apache 2.0'
+  spec.metadata['halite_name'] = 'application'
+
+  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.4'
+  spec.add_dependency 'poise-service', '~> 1.0'
+
+  spec.add_development_dependency 'poise-boiler', '~> 1.0'
+end

data/test/cookbooks/application_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 'application_test'
+depends 'application'

data/test/cookbooks/application_test/providers/test_plugin.rb

@@ -0,0 +1,25 @@
+#
+# 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.
+#
+
+include Poise
+
+action :run do
+  notifying_block do
+    file ::File.join(new_resource.parent.path, 'plugin') do
+      content new_resource.content
+    end
+  end
+end

data/test/cookbooks/application_test/recipes/default.rb

@@ -0,0 +1,61 @@
+#
+# 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.
+#
+
+application '/home/app' do
+  test_plugin do
+    content 'test plugin'
+  end
+end
+
+# Restart behavior test.
+directory '/opt/restarter' do
+  owner 'root'
+  group 'root'
+  mode '755'
+end
+file '/opt/restarter/main.rb' do
+  content <<-EOH
+require 'webrick'
+server = WEBrick::HTTPServer.new(Port: 2000)
+trap('INT') { server.shutdown }
+server.mount_proc '/' do |req, res|
+  res.body = 'One'
+end
+server.start
+EOH
+end
+poise_service 'restarter' do
+  command '/opt/chef/embedded/bin/ruby /opt/restarter/main.rb'
+end
+
+application '/opt/restarter' do
+  file '/opt/restarter/main.rb2' do
+    path '/opt/restarter/main.rb'
+    content <<-EOH
+require 'webrick'
+server = WEBrick::HTTPServer.new(Port: 2000)
+trap('INT') { server.shutdown }
+server.mount_proc '/' do |req, res|
+  res.body = 'Two'
+end
+server.start
+EOH
+  end
+  poise_service 'restarter2' do
+    service_name 'restarter'
+    command '/opt/chef/embedded/bin/ruby /opt/restarter/main.rb'
+  end
+end

data/test/cookbooks/application_test/resources/test_plugin.rb

@@ -0,0 +1,20 @@
+#
+# 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.
+#
+
+include Poise(parent: :application)
+
+default_action :run
+attribute :content

data/test/gemfiles/chef-12.2.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.2.0'

data/test/gemfiles/chef-12.3.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.3.0'

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,23 @@
+#
+# 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'
+gem 'poise-service', github: 'poise/poise-service'