poise-application-python 4.0.0

data/Rakefile

@@ -0,0 +1,17 @@
+#
+# 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_boiler/rakefile'

data/SUPPORTERS.md

@@ -0,0 +1,81 @@
+# Supporters
+
+This cookbook wouldn't have been possible without the generous support of my
+Kickstarter backers. Thanks so much to every one of you!
+
+* @kcunning
+* Alberto Lorenzo Pulido
+* Alex Gaynor
+* Alexander Myasnikov
+* Brooke Schreier Ganz
+* Bryan McLellan
+* Charles Johnson
+* Chef Software, Inc.
+* Chris Adams
+* Christopher Petrilli
+* David Thornton
+* Derek Murawsky
+* Fast Robot, LLC
+* Fatty McAwesome Pants (Kate Heddleston)
+* Greg Albrecht
+* JD Harrington
+* Jake Plimack
+* Jason Cook
+* Jeff Byrnes
+* Jeff Forcier
+* Jeff Lindsay
+* Jennifer Davis
+* John Fitch
+* Jon Stacks
+* Joshua SS Miller
+* Julian Dunn
+* Julien Phalip
+* Kennon Kwok
+* Kevin Duane
+* Krzysztof Wilczynski
+* Linda Goldstein
+* Manny Toledo
+* Marco A Morales
+* Marcus Morris
+* Mark Luntzel
+* Martin B. Smith
+* Mathieu Sauve-Frankel
+* Matt Good
+* Matt Juszczak
+* Matt Ray
+* Matt Stratton
+* Michael Burns
+* Miguel Landaeta
+* Mike Schueler
+* Nathan L Smith
+* Nathen Harvey
+* Paul Welch
+* Peter Kropf
+* Phil Mocek
+* Practice Fusion Inc
+* Ranjib
+* Richard Jones
+* Robert J. Berger
+* Robin Levin
+* Roland Moriz
+* Ruben Orduz
+* Russell Keith-Magee
+* Ryan Hass
+* Sam Clements
+* Sean OMeara
+* Seva Feldman
+* Soo Choi
+* Steven Danna
+* Symonds & Son
+* Todd Michael Bushnell
+* Tracy Osborn
+* Troy Ready
+* Tyler Ball
+* Vicky Tuite
+* Ying Li
+* Yvo van Doorn
+* Zac Stevens
+* lvh
+* oolongtea
+* smeuser
+* tmonk42

data/chef/templates/celeryconfig.py.erb

@@ -0,0 +1,5 @@
+# Generated by Chef for <%= @new_resource.to_s %>
+
+<%- @new_resource.options.each do |key, value| -%>
+<%= key.upcase %> = <%= PoisePython::Utils.to_python(value) %>
+<%- end -%>

data/chef/templates/settings.py.erb

@@ -0,0 +1,13 @@
+# Generated by Chef for <%= @new_resource.to_s %>
+
+<%- unless @allowed_hosts.empty? -%>
+ALLOWED_HOSTS = <%= PoisePython::Utils.to_python(@allowed_hosts) %>
+
+<%- end -%>
+DEBUG = <%= PoisePython::Utils.to_python(@debug) %>
+
+DATABASES = <%= PoisePython::Utils.to_python(@databases) %>
+<%- if @secret_key -%>
+
+SECRET_KEY = <%= PoisePython::Utils.to_python(@secret_key) %>
+<%- end -%>

data/lib/poise_application_python.rb

@@ -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.
+#
+
+
+module PoiseApplicationPython
+  autoload :AppMixin, 'poise_application_python/app_mixin'
+  autoload :Error, 'poise_application_python/error'
+  autoload :Resources, 'poise_application_python/resources'
+  autoload :VERSION, 'poise_application_python/version'
+end

data/lib/poise_application_python/app_mixin.rb

@@ -0,0 +1,67 @@
+#
+# 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/backports'
+require 'poise/utils'
+require 'poise_application/app_mixin'
+require 'poise_python/python_command_mixin'
+
+
+module PoiseApplicationPython
+  # A helper mixin for Python application resources and providers.
+  #
+  # @since 4.0.0
+  module AppMixin
+    include Poise::Utils::ResourceProviderMixin
+
+    # A helper mixin for Python application resources.
+    module Resource
+      include PoiseApplication::AppMixin::Resource
+      include PoisePython::PythonCommandMixin::Resource
+
+      # @!attribute parent_python
+      #   Override the #parent_python from PythonCommandMixin to grok the
+      #   application level parent as a default value.
+      #   @return [PoisePython::Resources::PythonRuntime::Resource, nil]
+      parent_attribute(:python, type: :python_runtime, optional: true, default: lazy { app_state_python.equal?(self) ? nil : app_state_python })
+
+      # @attribute app_state_python
+      #   The application-level Python parent.
+      #   @return [PoisePython::Resources::PythonRuntime::Resource, nil]
+      def app_state_python(python=Poise::NOT_PASSED)
+        unless python == Poise::NOT_PASSED
+          app_state[:python] = python
+        end
+        app_state[:python]
+      end
+
+      # A merged hash of environment variables for both the application state
+      # and parent python.
+      #
+      # @return [Hash<String, String>]
+      def app_state_environment_python
+        env = app_state_environment
+        env = env.merge(parent_python.python_environment) if parent_python
+        env
+      end
+    end
+
+    # A helper mixin for Python application providers.
+    module Provider
+      include PoiseApplication::AppMixin::Provider
+    end
+  end
+end

data/lib/poise_application_python/cheftie.rb

@@ -0,0 +1,17 @@
+#
+# 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_application_python/resources'

data/lib/poise_application_python/error.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.
+#
+
+require 'poise_application/error'
+
+module PoiseApplicationPython
+  # Base exception class for poise-application-python errors.
+  #
+  # @since 4.0.0
+  class Error < PoiseApplication::Error
+  end
+end

data/lib/poise_application_python/resources.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_application_python/resources/celery_beat'
+require 'poise_application_python/resources/celery_config'
+require 'poise_application_python/resources/celery_worker'
+require 'poise_application_python/resources/django'
+require 'poise_application_python/resources/gunicorn'
+require 'poise_application_python/resources/pip_requirements'
+require 'poise_application_python/resources/python'
+require 'poise_application_python/resources/python_execute'
+require 'poise_application_python/resources/python_package'
+require 'poise_application_python/resources/virtualenv'

data/lib/poise_application_python/resources/celery_beat.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_application_python/resources/celery_worker'
+
+
+module PoiseApplicationPython
+  module Resources
+    # (see CeleryBeat::Resource)
+    # @since 4.0.0
+    module CeleryBeat
+      class Resource < PoiseApplicationPython::Resources::CeleryWorker::Resource
+        provides(:application_celery_beat)
+      end
+
+      class Provider < PoiseApplicationPython::Resources::CeleryWorker::Provider
+        provides(:application_celery_beat)
+
+        private
+
+        # (see PoiseApplication::ServiceMixin#service_options)
+        def service_options(resource)
+          super
+          resource.command("#{new_resource.python} -m celery --app=#{new_resource.app_module} beat")
+        end
+
+      end
+    end
+  end
+end

data/lib/poise_application_python/resources/celery_config.rb

@@ -0,0 +1,109 @@
+#
+# 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 'uri'
+
+require 'chef/provider'
+require 'chef/resource'
+require 'poise'
+require 'poise_application'
+require 'poise_python'
+
+require 'poise_application_python/app_mixin'
+require 'poise_application_python/error'
+
+
+module PoiseApplicationPython
+  module Resources
+    # (see CeleryConfig::Resource)
+    # @since 4.0.0
+    module CeleryConfig
+      # An `application_celery_config` resource to configure Celery workers.
+      #
+      # @since 4.0.0
+      # @provides application_celery_config
+      # @action deploy
+      # @example
+      #   application '/srv/myapp' do
+      #     git '...'
+      #     pip_requirements
+      #     celery_config do
+      #       options do
+      #         broker_url '...'
+      #       end
+      #     end
+      #     celeryd
+      #   end
+      class Resource < Chef::Resource
+        include PoiseApplicationPython::AppMixin
+        provides(:application_celery_config)
+        actions(:deploy)
+
+        attribute('', template: true, default_source: 'celeryconfig.py.erb')
+        # @!attribute group
+        #   Owner for the Django application, defaults to application group.
+        #   @return [String]
+        attribute(:group, kind_of: String, default: lazy { parent && parent.group })
+        # @!attribute owner
+        #   Owner for the Django application, defaults to application owner.
+        #   @return [String]
+        attribute(:owner, kind_of: String, default: lazy { parent && parent.owner })
+        attribute(:path, kind_of: String, default: lazy { default_path })
+
+        private
+
+        def default_path
+          if ::File.directory?(name)
+            ::File.join(name, 'celeryconfig.py')
+          else
+            name
+          end
+        end
+      end
+
+      # Provider for `application_celery_config`.
+      #
+      # @since 4.0.0
+      # @see Resource
+      # @provides application_celery_config
+      class Provider < Chef::Provider
+        include PoiseApplicationPython::AppMixin
+        provides(:application_celery_config)
+
+        # `deploy` action for `application_celery_config`. Writes config file.
+        #
+        # @return [void]
+        def action_deploy
+          notifying_block do
+            write_config
+          end
+        end
+
+        private
+
+        def write_config
+          file new_resource.path do
+            content new_resource.content
+            mode '640'
+            owner new_resource.owner
+            group new_resource.group
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/poise_application_python/resources/celery_worker.rb

@@ -0,0 +1,77 @@
+#
+# 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/provider'
+require 'chef/resource'
+
+require 'poise_application_python/service_mixin'
+
+
+module PoiseApplicationPython
+  module Resources
+    # (see CeleryWorker::Resource)
+    # @since 4.0.0
+    module CeleryWorker
+      class Resource < Chef::Resource
+        include PoiseApplicationPython::ServiceMixin
+        provides(:application_celery_worker)
+
+        attribute(:app_module, kind_of: [String, NilClass], default: lazy { default_app_module })
+
+        private
+
+        # Compute the default application module to pass to gunicorn. This
+        # checks the app state and then looks for commonly used filenames.
+        # Raises an exception if no default can be found.
+        #
+        # @return [String]
+        def default_app_module
+          # If set in app_state, use that.
+          return app_state[:python_celery_module] if app_state[:python_celery_module]
+          # If a Django settings module is set, use everything by the last
+          # dotted component of it. to_s handles nil since that won't match.
+          return $1 if app_state_environment[:DJANGO_SETTINGS_MODULE].to_s =~ /^(.+?)\.[^.]+$/
+          files = Dir.exist?(path) ? Dir.entries(path) : []
+          # Try to find a known filename.
+          candidate_file = %w{tasks.py task.py celery.py main.py app.py application.py}.find {|file| files.include?(file) }
+          # Try the first Python file. Do I really want this?
+          candidate_file ||= files.find {|file| file.end_with?('.py') }
+          if candidate_file
+            ::File.basename(candidate_file, '.py')
+          else
+            nil
+          end
+        end
+
+      end
+
+      class Provider < Chef::Provider
+        include PoiseApplicationPython::ServiceMixin
+        provides(:application_celery_worker)
+
+        private
+
+        # (see PoiseApplication::ServiceMixin#service_options)
+        def service_options(resource)
+          super
+          raise PoiseApplicationPython::Error.new("Unable to determine app module for #{new_resource}") unless new_resource.app_module
+          resource.command("#{new_resource.python} -m celery --app=#{new_resource.app_module} worker")
+        end
+
+      end
+    end
+  end
+end