poise-python 1.0.0

data/lib/poise_python/resources/python_runtime.rb

@@ -0,0 +1,114 @@
+#
+# 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 'poise'
+
+
+module PoisePython
+  module Resources
+    # (see PythonRuntime::Resource)
+    # @since 1.0.0
+    module PythonRuntime
+      # A `python_runtime` resource to manage Python installations.
+      #
+      # @provides python_runtime
+      # @action install
+      # @action uninstall
+      # @example
+      #   python_runtime '2.7'
+      class Resource < Chef::Resource
+        include Poise(inversion: true, container: true)
+        provides(:python_runtime)
+        actions(:install, :uninstall)
+
+        # @!attribute version
+        #   Version of Python to install. The version is prefix-matched so `'2'`
+        #   will install the most recent Python 2.x, and so on.
+        #   @return [String]
+        #   @example Install any version
+        #     python_runtime 'any' do
+        #       version ''
+        #     end
+        #   @example Install Python 2.7
+        #     python_runtime '2.7'
+        attribute(:version, kind_of: String, name_attribute: true)
+        # @!attribute pip_version
+        #   Version of pip to install. If set to `true`, the latest available
+        #   pip will be used. If set to `false`, pip will not be installed. If
+        #   set to a URL, that will be used as the URL to get-pip.py. If a
+        #   non-URL version is given, the get-pip.py installer will be
+        #   downloaded from the internet.
+        #   @note Due to https://github.com/pypa/pip/issues/1087, the latest
+        #     version of pip will always be installed initially. It will then
+        #     downgrade to the requested version if needed.
+        #   @note Disabling the pip install may result in other resources being
+        #     non-functional.
+        #   @return [String, Boolean]
+        #   @example Install from a locally-hosted copy of get-pip.py
+        #     python_runtime '2' do
+        #       pip_version 'http://myserver/get-pip.py'
+        #     end
+        attribute(:pip_version, kind_of: [String, TrueClass, FalseClass], default: true)
+        # @!attribute setuptools_version
+        #   Version of Setuptools to install. It set to `true`, the latest
+        #   available version will be used. If set to `false`, setuptools will
+        #   not be installed.
+        #   @return [String, Boolean]
+        attribute(:setuptools_version, kind_of: [String, TrueClass, FalseClass], default: true)
+        # @!attribute virtualenv_version
+        #   Version of Virtualenv to install. It set to `true`, the latest
+        #   available version will be used. If set to `false`, virtualenv will
+        #   not be installed. Virtualenv will never be installed if the built-in
+        #   venv module is available.
+        #   @note Disabling the virtualenv install may result in other resources
+        #     being non-functional.
+        #   @return [String, Boolean]
+        attribute(:virtualenv_version, kind_of: [String, TrueClass, FalseClass], default: true)
+        # @!attribute wheel_version
+        #   Version of Wheel to install. It set to `true`, the latest
+        #   available version will be used. If set to `false`, wheel will not
+        #   be installed.
+        #   @return [String, Boolean]
+        attribute(:wheel_version, kind_of: [String, TrueClass, FalseClass], default: true)
+
+        # The path to the `python` binary for this Python installation. This is
+        # an output property.
+        #
+        # @return [String]
+        # @example
+        #   execute "#{resources('python_runtime[2.7]').python_binary} myapp.py"
+        def python_binary
+          provider_for_action(:python_binary).python_binary
+        end
+
+        # The environment variables for this Python installation. This is an
+        # output property.
+        #
+        # @return [Hash<String, String>]
+        # @example
+        #   execute '/opt/myapp.py' do
+        #     environment resources('python_runtime[2.7]').python_environment
+        #   end
+        def python_environment
+          provider_for_action(:python_environment).python_environment
+        end
+      end
+
+      # Providers can be found under lib/poise_python/python_providers/
+    end
+  end
+end

data/lib/poise_python/resources/python_runtime_pip.rb

@@ -0,0 +1,167 @@
+#
+# 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 'tempfile'
+
+require 'chef/resource'
+require 'poise'
+
+
+module PoisePython
+  module Resources
+    # (see PythonRuntimePip::Resource)
+    # @since 1.0.0
+    # @api private
+    module PythonRuntimePip
+      # URL for the default get-pip.py script.
+      DEFAULT_GET_PIP_URL = 'https://bootstrap.pypa.io/get-pip.py'
+
+      # A `python_runtime_pip` resource to install/upgrade pip itself. This is
+      # used internally by `python_runtime` and is not intended to be a public
+      # API.
+      #
+      # @provides python_runtime_pip
+      # @action install
+      # @action uninstall
+      class Resource < Chef::Resource
+        include Poise(parent: :python_runtime)
+        provides(:python_runtime_pip)
+        actions(:install, :uninstall)
+
+        # @!attribute version
+        #   Version of pip to install. Only kind of works due to
+        #   https://github.com/pypa/pip/issues/1087.
+        #   @return [String]
+        attribute(:version, kind_of: String)
+        # @!attribute get_pip_url
+        #   URL to the get-pip.py script. Defaults to pulling it from pypa.io.
+        #   @return [String]
+        attribute(:get_pip_url, kind_of: String, default: DEFAULT_GET_PIP_URL)
+      end
+
+      # The default provider for `python_runtime_pip`.
+      #
+      # @see Resource
+      # @provides python_runtime_pip
+      class Provider < Chef::Provider
+        include Poise
+        provides(:python_runtime_pip)
+
+        # @api private
+        def load_current_resource
+          super.tap do |current_resource|
+            # Try to find the current version if possible.
+            current_resource.version(pip_version)
+          end
+        end
+
+        # The `install` action for the `python_runtime_pip` resource.
+        #
+        # @return [void]
+        def action_install
+          if current_resource.version
+            install_pip
+          else
+            bootstrap_pip
+          end
+        end
+
+        # The `uninstall` action for the `python_runtime_pip` resource.
+        #
+        # @return [void]
+        def action_uninstall
+          notifying_block do
+            python_package 'pip' do
+              action :uninstall
+            end
+          end
+        end
+
+        private
+
+        # Bootstrap pip using get-pip.py.
+        #
+        # @return [void]
+        def bootstrap_pip
+          # Always updated if we have hit this point.
+          new_resource.updated_by_last_action(true)
+          # Pending https://github.com/pypa/pip/issues/1087.
+          if new_resource.version
+            Chef::Log.warn("pip does not support bootstrapping a specific version, see https://github.com/pypa/pip/issues/1087.")
+          end
+          # Use a temp file to hold the installer.
+          Tempfile.create(['get-pip', '.py']) do |temp|
+            # Download the get-pip.py.
+            get_pip = Chef::HTTP.new(new_resource.get_pip_url).get('')
+            # Write it to the temp file.
+            temp.write(get_pip)
+            # Close the file to flush it.
+            temp.close
+            # Run the install. This probably needs some handling for proxies et
+            # al. Disable setuptools and wheel as we will install those later.
+            # Use the environment vars instead of CLI arguments so I don't have
+            # to deal with bootstrap versions that don't support --no-wheel.
+            shell_out!([new_resource.parent.python_binary, temp.path], environment: new_resource.parent.python_environment.merge('PIP_NO_SETUPTOOLS' => '1', 'PIP_NO_WHEEL' => '1'))
+          end
+          new_pip_version = pip_version
+          if new_resource.version && new_pip_version != new_resource.version
+            # We probably want to downgrade, which is silly but ¯\_(ツ)_/¯.
+            # Can be removed once https://github.com/pypa/pip/issues/1087 is fixed.
+            current_resource.version(new_pip_version)
+            install_pip
+          end
+        end
+
+        # Upgrade (or downgrade) pip using itself. Should work back at least
+        # pip 1.5.
+        #
+        # @return [void]
+        def install_pip
+          if new_resource.version
+            # Already up to date, we're done here.
+            return if current_resource.version == new_resource.version
+          else
+            # We don't wany a specific version, so just make a general check.
+            return if current_resource.version
+          end
+
+          notifying_block do
+            # Use pip to upgrade (or downgrade) itself.
+            python_package 'pip' do
+              action :upgrade
+              version new_resource.version if new_resource.version
+            end
+          end
+        end
+
+        # Find the version of pip currently installed in this Python runtime.
+        # Returns nil if not installed.
+        #
+        # @return [String, nil]
+        def pip_version
+          cmd = shell_out([new_resource.parent.python_binary, '-m', 'pip.__main__', '--version'], environment: new_resource.parent.python_environment)
+          if cmd.error?
+            # Not installed, probably.
+            nil
+          else
+            cmd.stdout[/pip ([\d.a-z]+)/, 1]
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/poise_python/resources/python_runtime_test.rb

@@ -0,0 +1,185 @@
+#
+# 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'
+
+
+module PoisePython
+  module Resources
+    # (see PythonRuntimeTest::Resource)
+    # @since 1.0.0
+    # @api private
+    module PythonRuntimeTest
+      # A `python_runtime_test` resource for integration testing of this
+      # cookbook. This is an internal API and can change at any time.
+      #
+      # @provides python_runtime_test
+      # @action run
+      class Resource < Chef::Resource
+        include Poise
+        provides(:python_runtime_test)
+        actions(:run)
+
+        attribute(:version, kind_of: String, name_attribute: true)
+        attribute(:runtime_provider, kind_of: Symbol)
+        attribute(:path, kind_of: String, default: lazy { default_path })
+
+        def default_path
+          ::File.join('', 'root', "python_test_#{name}")
+        end
+      end
+
+      # The default provider for `python_runtime_test`.
+      #
+      # @see Resource
+      # @provides python_runtime_test
+      class Provider < Chef::Provider
+        include Poise
+        provides(:python_runtime_test)
+
+        # The `run` action for the `python_runtime_test` resource.
+        #
+        # @return [void]
+        def action_run
+          notifying_block do
+            # Top level directory for this test.
+            directory new_resource.path
+
+            # Install and log the version.
+            python_runtime new_resource.name do
+              provider new_resource.runtime_provider if new_resource.runtime_provider
+              version new_resource.version
+            end
+            test_version
+
+            # Test python_package.
+            python_package 'sqlparse remove before' do
+              action :remove
+              package_name 'sqlparse'
+              python new_resource.name
+            end
+            test_import('sqlparse', 'sqlparse_before')
+            python_package 'sqlparse' do
+              python new_resource.name
+              notifies :create, sentinel_file('sqlparse'), :immediately
+            end
+            test_import('sqlparse', 'sqlparse_mid')
+            python_package 'sqlparse again' do
+              package_name 'sqlparse'
+              python new_resource.name
+              notifies :create, sentinel_file('sqlparse2'), :immediately
+            end
+            python_package 'sqlparse remove after' do
+              action :remove
+              package_name 'sqlparse'
+              python new_resource.name
+            end
+            test_import('sqlparse', 'sqlparse_after')
+
+            # Use setuptools to test something that should always be installed.
+            python_package 'setuptools' do
+              python new_resource.name
+              notifies :create, sentinel_file('setuptools'), :immediately
+            end
+
+            # Multi-package install.
+            python_package ['pep8', 'pytz'] do
+              python new_resource.name
+            end
+            test_import('pep8')
+            test_import('pytz')
+
+            # Create a virtualenv.
+            python_virtualenv ::File.join(new_resource.path, 'venv') do
+              python new_resource.name
+            end
+
+            # Install a package inside a virtualenv.
+            python_package 'Pytest' do
+              virtualenv ::File.join(new_resource.path, 'venv')
+            end
+            test_import('pytest')
+            test_import('pytest', 'pytest_venv', python: nil, virtualenv: ::File.join(new_resource.path, 'venv'))
+
+            # Create and install a requirements file.
+            file ::File.join(new_resource.path, 'requirements.txt') do
+              content <<-EOH
+requests==2.7.0
+six==1.8.0
+EOH
+            end
+            pip_requirements ::File.join(new_resource.path, 'requirements.txt') do
+              python new_resource.name
+            end
+            test_import('requests')
+            test_import('six')
+          end
+        end
+
+        def sentinel_file(name)
+          file ::File.join(new_resource.path, "sentinel_#{name}") do
+            action :nothing
+          end
+        end
+
+        private
+
+        def test_version(python: new_resource.name, virtualenv: nil)
+          # Only queue up this resource once, the ivar is just for tracking.
+          @python_version_test ||= file ::File.join(new_resource.path, 'python_version.py') do
+            user 'root'
+            group 'root'
+            mode '644'
+            content <<-EOH
+import sys, platform
+open(sys.argv[1], 'w').write(platform.python_version())
+EOH
+          end
+
+          python_execute "#{@python_version_test.path} #{::File.join(new_resource.path, 'version')}" do
+            python python if python
+            virtualenv virtualenv if virtualenv
+          end
+        end
+
+        def test_import(name, path=name, python: new_resource.name, virtualenv: nil)
+          # Only queue up this resource once, the ivar is just for tracking.
+          @python_import_test ||= file ::File.join(new_resource.path, 'import_version.py') do
+            user 'root'
+            group 'root'
+            mode '644'
+            content <<-EOH
+try:
+    import sys
+    mod = __import__(sys.argv[1])
+    open(sys.argv[2], 'w').write(mod.__version__)
+except ImportError:
+    pass
+EOH
+          end
+
+          python_execute "#{@python_import_test.path} #{name} #{::File.join(new_resource.path, "import_#{path}")}" do
+            python python if python
+            virtualenv virtualenv if virtualenv
+          end
+        end
+
+      end
+    end
+  end
+end