poise-python 1.0.0

data/lib/poise_python/resources/python_virtualenv.rb

@@ -0,0 +1,164 @@
+#
+# 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'
+
+# Break a require loop by letting autoload work its magic.
+require 'poise_python'
+
+
+module PoisePython
+  module Resources
+    # (see PythonVirtualenv::Resource)
+    # @since 1.0.0
+    module PythonVirtualenv
+      # A `python_virtualenv` resource to manage Python virtual environments.
+      #
+      # @provides python_virtualenv
+      # @action create
+      # @action delete
+      # @example
+      #   python_virtualenv '/opt/myapp'
+      class Resource < PoisePython::Resources::PythonRuntime::Resource
+        include PoisePython::PythonCommandMixin
+        provides(:python_virtualenv)
+        # Add create and delete actions as more semantically relevant aliases.
+        default_action(:create)
+        actions(:create, :delete)
+
+        # @!attribute path
+        #   Path to create the environment at.
+        #   @return [String]
+        attribute(:path, kind_of: String, name_attribute: true)
+        # @!attribute group
+        #   System group to create the virtualenv.
+        #   @return [String, Integer, nil]
+        attribute(:group, kind_of: [String, Integer, NilClass])
+        # @!attribute system_site_packages
+        #   Enable or disable visibilty of system packages in the environment.
+        #   @return [Boolean]
+        attribute(:system_site_packages, equal_to: [true, false], default: false)
+        # @!attribute user
+        #   System user to create the virtualenv.
+        #   @return [String, Integer, nil]
+        attribute(:user, kind_of: [String, Integer, NilClass])
+
+        # Lock the default provider.
+        #
+        # @api private
+        def initialize(*args)
+          super
+          # Sidestep all the normal provider lookup stuffs. This is kind of
+          # gross but it will do for now. The hard part is that the base classes
+          # for the resource and provider are using Poise::Inversion, which we
+          # don't want to use for python_virtualenv.
+          @provider = Provider
+        end
+
+        # Upstream attribute we don't support. Sets are an error and gets always
+        # return nil.
+        #
+        # @api private
+        # @param arg [Object] Ignored
+        # @return [nil]
+        def version(arg=nil)
+          raise NoMethodError if arg
+        end
+
+        # (see #version)
+        def virtualenv_version(arg=nil)
+          raise NoMethodError if arg
+        end
+      end
+
+      # The default provider for `python_virtualenv`.
+      #
+      # @see Resource
+      # @provides python_virtualenv
+      class Provider < PoisePython::PythonProviders::Base
+        include PoisePython::PythonCommandMixin
+        provides(:python_virtualenv)
+
+        # Alias our actions. Slightly annoying that they will show in
+        # tracebacks with the original names, but oh well.
+        alias_method :action_create, :action_install
+        alias_method :action_delete, :action_uninstall
+
+        def python_binary
+          ::File.join(new_resource.path, 'bin', 'python')
+        end
+
+        def python_environment
+          if new_resource.parent_python
+            new_resource.parent_python.python_environment
+          else
+            {}
+          end
+        end
+
+        private
+
+        def install_python
+          return if ::File.exist?(new_resource.path)
+
+          cmd = python_shell_out(%w{-m venv -h})
+          if cmd.error?
+            converge_by("Creating virtualenv at #{new_resource.path}") do
+              create_virtualenv(%w{virtualenv})
+            end
+          else
+            converge_by("Creating venv at #{new_resource.path}") do
+              create_virtualenv(%w{venv --without-pip})
+            end
+          end
+        end
+
+        def uninstall_python
+          directory new_resource.path do
+            action :delete
+            recursive true
+          end
+        end
+
+        # Don't install virtualenv inside virtualenv.
+        #
+        # @api private
+        # @return [void]
+        def install_virtualenv
+          # This space left intentionally blank.
+        end
+
+        # Create a virtualenv using virtualenv or venv.
+        #
+        # @param driver [Array<String>] Command snippet to actually make it.
+        # @return [void]
+        def create_virtualenv(driver)
+          cmd = %w{-m} + driver
+          cmd << '--system-site-packages' if new_resource.system_site_packages
+          cmd << new_resource.path
+          python_shell_out!(cmd, environment: {
+            # Use the environment variables to cope with older virtualenv not
+            # supporting --no-wheel. The env var will be ignored if unsupported.
+            'VIRTUALENV_NO_PIP' => '1',
+            'VIRTUALENV_NO_SETUPTOOLS' => '1',
+            'VIRTUALENV_NO_WHEEL' => '1',
+          }, group: new_resource.group, user: new_resource.user)
+        end
+
+      end
+    end
+  end
+end

data/lib/poise_python/utils.rb

@@ -0,0 +1,63 @@
+#
+# 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/error'
+
+
+module PoisePython
+  # Helper methods for Python-related things.
+  #
+  # @since 1.0.0
+  module Utils
+    autoload :PythonEncoder, 'poise_python/utils/python_encoder'
+    extend self
+
+    # Convert an object to a Python literal.
+    #
+    # @param obj [Object] Ovject to convert.
+    # @return [String]
+    def to_python(obj)
+      PythonEncoder.new(obj).encode
+    end
+
+    # Convert path to a Python dotted module name.
+    #
+    # @param path [String] Path to the file. If base is not given, this must be
+    #   a relative path.
+    # @param base [String] Optional base path to treat the file as relative to.
+    # @return [String]
+    def path_to_module(path, base=nil)
+      if base
+        path = ::File.expand_path(path, base)
+        raise PoisePython::Error.new("Path #{path} is not inside base path #{base}") unless path.start_with?(base)
+        path = path[base.length+1..-1]
+      end
+      path = path[0..-4] if path.end_with?('.py')
+      path.gsub(/#{::File::SEPARATOR}/, '.')
+    end
+
+    # Convert a Python dotted module name to a path.
+    #
+    # @param mod [String] Dotted module name.
+    # @param base [String] Optional base path to treat the file as relative to.
+    # @return [String]
+    def module_to_path(mod, base=nil)
+      path = mod.gsub(/\./, ::File::SEPARATOR) + '.py'
+      path = ::File.join(base, path) if base
+      path
+    end
+  end
+end

data/lib/poise_python/utils/python_encoder.rb

@@ -0,0 +1,73 @@
+#
+# 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 'json'
+
+
+module PoisePython
+  module Utils
+    # Convert Ruby data structures to a Python literal. Overall similar to JSON
+    # but just different enough that I need to write this. Thanks Obama.
+    #
+    # @since 1.0.0
+    # @api private
+    class PythonEncoder
+      def initialize(root, depth_limit: 100)
+        @root = root
+        @depth_limit = depth_limit
+      end
+
+      def encode
+        encode_obj(@root, 0)
+      end
+
+      private
+
+      def encode_obj(obj, depth)
+        raise ArgumentError.new("Depth limit exceeded") if depth > @depth_limit
+        case obj
+        when Hash
+          encode_hash(obj, depth)
+        when Array
+          encode_array(obj, depth)
+        when true
+          'True'
+        when false
+          'False'
+        when nil
+          'None'
+        else
+          obj.to_json
+        end
+      end
+
+      def encode_hash(obj, depth)
+        middle = obj.map do |key, value|
+          "#{encode_obj(key, depth+1)}:#{encode_obj(value, depth+1)}"
+        end
+        "{#{middle.join(',')}}"
+      end
+
+      def encode_array(obj, depth)
+        middle = obj.map do |value|
+          encode_obj(value, depth+1)
+        end
+        "[#{middle.join(',')}]"
+      end
+
+    end
+  end
+end

data/lib/poise_python/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 PoisePython
+  VERSION = '1.0.0'
+end

data/poise-python.gemspec

@@ -0,0 +1,41 @@
+#
+# 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_python/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'poise-python'
+  spec.version = PoisePython::VERSION
+  spec.authors = ['Noah Kantrowitz']
+  spec.email = %w{noah@coderanger.net}
+  spec.description = "A Chef cookbook for managing Python installations."
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/poise/python'
+  spec.license = 'Apache 2.0'
+
+  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.0'
+  spec.add_dependency 'poise-languages', '~> 1.0.dev'
+
+  spec.add_development_dependency 'poise-boiler', '~> 1.0'
+end

data/test/cookbooks/poise-python_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 'poise-python_test'
+depends 'poise-python'

data/test/cookbooks/poise-python_test/recipes/default.rb

@@ -0,0 +1,40 @@
+#
+# 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/python_runtime_test'
+
+# Install lsb-release because Debian 6 doesn't by default and serverspec requires it
+package 'lsb-release' if platform?('debian') && node['platform_version'].start_with?('6')
+
+python_runtime_test '2'
+
+python_runtime_test '3'
+
+python_runtime_test 'pypy'
+
+python_runtime_test 'system' do
+  version ''
+  runtime_provider :system
+end
+
+if platform_family?('rhel')
+  python_runtime_test 'scl' do
+    version ''
+    runtime_provider :scl
+  end
+else
+  file '/no_scl'
+end

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'