poise-python 1.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/chef/attributes/default.rb

@@ -0,0 +1,24 @@
+#
+# 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.
+#
+
+# Default inversion options.
+default['poise-python']['provider'] = 'auto'
+default['poise-python']['options'] = {}
+
+# Used for the default recipe.
+default['poise-python']['install_python2'] = true
+default['poise-python']['install_python3'] = false
+default['poise-python']['install_pypy'] = false

data/chef/recipes/default.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.
+#
+
+# Default runtimes, last one will be the default.
+python_runtime 'pypy' if node['poise-python']['install_pypy']
+python_runtime '3' if node['poise-python']['install_python3']
+python_runtime '2' if node['poise-python']['install_python2']

data/lib/poise_python.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.
+#
+
+
+module PoisePython
+  autoload :Error, 'poise_python/error'
+  autoload :Resources, 'poise_python/resources'
+  autoload :PythonCommandMixin, 'poise_python/python_command_mixin'
+  autoload :PythonProviders, 'poise_python/python_providers'
+  autoload :Utils, 'poise_python/utils'
+  autoload :VERSION, 'poise_python/version'
+end

data/lib/poise_python/cheftie.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.
+#
+
+require 'poise_python/resources'
+require 'poise_python/python_providers'

data/lib/poise_python/error.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.
+#
+
+require 'poise_languages'
+
+
+module PoisePython
+  class Error < PoiseLanguages::Error
+  end
+end

data/lib/poise_python/python_command_mixin.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 'poise/utils'
+require 'poise_languages'
+
+
+module PoisePython
+  # Mixin for resources and providers which run Python commands.
+  #
+  # @since 1.0.0
+  module PythonCommandMixin
+    include Poise::Utils::ResourceProviderMixin
+
+    # Mixin for resources which run Python commands.
+    module Resource
+      include PoiseLanguages::Command::Mixin::Resource(:python)
+
+      # Wrapper for setting the parent to be a virtualenv.
+      #
+      # @param name [String] Name of the virtualenv resource.
+      # @return [void]
+      def virtualenv(name)
+        parent_python("python_virtualenv[#{name}]")
+      end
+    end
+
+    module Provider
+      include PoiseLanguages::Command::Mixin::Provider(:python)
+    end
+  end
+end

data/lib/poise_python/python_providers.rb

@@ -0,0 +1,35 @@
+#
+# 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_python/python_providers/portable_pypy'
+require 'poise_python/python_providers/scl'
+require 'poise_python/python_providers/system'
+
+
+module PoisePython
+  # Inversion providers for the python_runtime resource.
+  #
+  # @since 1.0.0
+  module PythonProviders
+    autoload :Base, 'poise_python/python_providers/base'
+
+    Chef::Platform::ProviderPriorityMap.instance.priority(:python_runtime, [
+      PoisePython::PythonProviders::PortablePyPy,
+      PoisePython::PythonProviders::Scl,
+      PoisePython::PythonProviders::System,
+    ])
+  end
+end

data/lib/poise_python/python_providers/base.rb

@@ -0,0 +1,177 @@
+#
+# 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 'poise'
+
+
+module PoisePython
+  module PythonProviders
+    class Base < Chef::Provider
+      include Poise(inversion: :python_runtime)
+
+      # Set default inversion options.
+      #
+      # @api private
+      def self.default_inversion_options(node, new_resource)
+        super.merge({
+          pip_version: new_resource.pip_version,
+          setuptools_version: new_resource.setuptools_version,
+          version: new_resource.version,
+          virtualenv_version: new_resource.virtualenv_version,
+          wheel_version: new_resource.wheel_version,
+        })
+      end
+
+      # The `install` action for the `python_runtime` resource.
+      #
+      # @return [void]
+      def action_install
+        # First inner converge for the Python install.
+        notifying_block do
+          install_python
+        end
+        # Second inner converge for the support tools. This is needed because
+        # we run a python command to check if venv is available.
+        notifying_block do
+          install_pip
+          install_setuptools
+          install_wheel
+          install_virtualenv
+        end
+      end
+
+      # The `uninstall` action for the `python_runtime` resource.
+      #
+      # @abstract
+      # @return [void]
+      def action_uninstall
+        notifying_block do
+          uninstall_python
+        end
+      end
+
+      # The path to the `python` binary. This is an output property.
+      #
+      # @abstract
+      # @return [String]
+      def python_binary
+        raise NotImplementedError
+      end
+
+      # The environment variables for this Python. This is an output property.
+      #
+      # @return [Hash<String, String>]
+      def python_environment
+        {}
+      end
+
+      private
+
+      # Install the Python runtime. Must be implemented by subclass.
+      #
+      # @abstract
+      # @return [void]
+      def install_python
+        raise NotImplementedError
+      end
+
+      # Uninstall the Python runtime. Must be implemented by subclass.
+      #
+      # @abstract
+      # @return [void]
+      def uninstall_python
+        raise NotImplementedError
+      end
+
+      # Install pip in to the Python runtime.
+      #
+      # @return [void]
+      def install_pip
+        pip_version_or_url = options[:pip_version]
+        return unless pip_version_or_url
+        # If there is a : in the version, use it as a URL.
+        if pip_version_or_url.is_a?(String) && pip_version_or_url.include?(':')
+          pip_version = nil
+          pip_url = pip_version_or_url
+        else
+          pip_version = pip_version_or_url
+          pip_url = nil
+        end
+        Chef::Log.debug("[#{new_resource}] Installing pip #{pip_version || 'latest'}")
+        # Install or bootstrap pip.
+        python_runtime_pip new_resource.name do
+          parent new_resource
+          # If the version is `true`, don't pass it at all.
+          version pip_version if pip_version.is_a?(String)
+          get_pip_url pip_url if pip_url
+        end
+      end
+
+      # Install setuptools in to the Python runtime. This is very similar to the
+      # {#install_wheel} and {#install_virtualenv} methods but they are kept
+      # separate for the benefit of subclasses being able to override them
+      # individually.
+      #
+      # @return [void]
+      def install_setuptools
+        # Captured because #options conflicts with Chef::Resource::Package#options.
+        setuptools_version = options[:setuptools_version]
+        return unless setuptools_version
+        Chef::Log.debug("[#{new_resource}] Installing setuptools #{setuptools_version == true ? 'latest' : setuptools_version}")
+        # Install setuptools via pip.
+        python_package 'setuptools' do
+          parent_python new_resource
+          version setuptools_version if setuptools_version.is_a?(String)
+        end
+      end
+
+      # Install wheel in to the Python runtime.
+      #
+      # @return [void]
+      def install_wheel
+        # Captured because #options conflicts with Chef::Resource::Package#options.
+        wheel_version = options[:wheel_version]
+        return unless wheel_version
+        Chef::Log.debug("[#{new_resource}] Installing setuptools #{wheel_version == true ? 'latest' : wheel_version}")
+        # Install wheel via pip.
+        python_package 'wheel' do
+          parent_python new_resource
+          version wheel_version if wheel_version.is_a?(String)
+        end
+      end
+
+      # Install virtualenv in to the Python runtime.
+      #
+      # @return [void]
+      def install_virtualenv
+        # Captured because #options conflicts with Chef::Resource::Package#options.
+        virtualenv_version = options[:virtualenv_version]
+        return unless virtualenv_version
+        # Check if the venv module exists.
+        cmd = shell_out([python_binary, '-m', 'venv', '-h'], environment: python_environment)
+        return unless cmd.error?
+        Chef::Log.debug("[#{new_resource}] Installing virtualenv #{virtualenv_version == true ? 'latest' : virtualenv_version}")
+        # Install virtualenv via pip.
+        python_package 'virtualenv' do
+          parent_python new_resource
+          version virtualenv_version if virtualenv_version.is_a?(String)
+        end
+      end
+
+    end
+  end
+end

data/lib/poise_python/python_providers/portable_pypy.rb

@@ -0,0 +1,96 @@
+#
+# 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_python/error'
+require 'poise_python/python_providers/base'
+
+
+module PoisePython
+  module PythonProviders
+    class PortablePyPy < Base
+      provides(:portable_pypy)
+
+      PYPY_PACKAGES = {
+        'pypy' => %w{2.6 2.5.1 2.5 2.4 2.3.1 2.3 2.2.1 2.2 2.1 2.0.2},
+        'pypy3' => %w{2.4 2.3.1},
+      }
+
+      # Only use this to install pypy.
+      #
+      # @api private
+      def self.provides_auto?(node, resource)
+        super || (resource.version.start_with?('pypy') && node['kernel']['name'].downcase == 'linux')
+      end
+
+      def python_binary
+        ::File.join(pypy_folder, 'bin', 'pypy')
+      end
+
+      private
+
+      def install_python
+        path = ::File.join(Chef::Config[:file_cache_path], "#{pypy_package}.tar.bz2")
+        folder = pypy_folder
+        url = pypy_package_url
+
+        package %w{tar bzip2}
+
+        unpack = execute 'unpack pypy' do
+          action :nothing
+          command ['tar', 'xjvf', path]
+          cwd ::File.dirname(folder)
+        end
+
+        remote_file path do
+          source url
+          owner 'root'
+          group 'root'
+          mode '644'
+          notifies :run, unpack, :immediately
+        end
+      end
+
+      def uninstall_python
+        directory pypy_folder do
+          action :delete
+          recursive true
+        end
+      end
+
+      def pypy_package
+        @pypy_package ||= begin
+          match = options['version'].match(/^(pypy(?:|3))(?:-(.*))?$/)
+          package_type = match ? match[1] : 'pypy'
+          version_prefix = (match && match[2]).to_s
+          version = PYPY_PACKAGES[package_type].find {|v| v.start_with?(version_prefix) }
+          "#{package_type}-#{version}-#{node['kernel']['name'].downcase}_#{node['kernel']['machine']}-portable"
+        end
+      end
+
+      def pypy_folder
+        options['folder'] || ::File.join('', 'opt', pypy_package)
+      end
+
+      def pypy_package_url
+        options['url'] || "https://bitbucket.org/squeaky/portable-pypy/downloads/#{pypy_package}.tar.bz2"
+      end
+
+    end
+  end
+end
+