poise-languages 1.0.0

data/lib/poise_languages/error.rb

@@ -0,0 +1,21 @@
+#
+# 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 PoiseLanguages
+  class Error < ::Exception
+  end
+end

data/lib/poise_languages/scl.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.
+#
+
+
+module PoiseLanguages
+  module Scl
+    autoload :Mixin, 'poise_languages/scl/mixin'
+    autoload :Resource, 'poise_languages/scl/resource'
+    autoload :Provider, 'poise_languages/scl/resource'
+  end
+end

data/lib/poise_languages/scl/mixin.rb

@@ -0,0 +1,110 @@
+#
+# 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/scl/resource'
+
+
+module PoiseLanguages
+  module Scl
+    module Mixin
+      private
+
+      def install_scl_package
+        pkg = scl_package
+        poise_languages_scl pkg[:name] do
+          parent new_resource
+          url pkg[:url]
+        end
+      end
+
+      def uninstall_scl_package
+        install_scl_package.tap do |r|
+          r.action(:uninstall)
+        end
+      end
+
+      def scl_package
+        @scl_package ||= self.class.find_scl_package(node, options['version']).tap do |p|
+          raise PoiseLanguages::Error.new("No SCL repoistory package for #{node['platform']} #{node['platform_version']}") unless p
+        end
+      end
+
+      def scl_folder
+        ::File.join('', 'opt', 'rh', scl_package[:name])
+      end
+
+      def scl_environment
+        parse_enable_file(::File.join(scl_folder, 'enable'))
+      end
+
+      # Parse an SCL enable file to extract the environment variables set in it.
+      #
+      # @param path [String] Path to the enable file.
+      # @return [Hash<String, String>]
+      def parse_enable_file(path)
+        # Doesn't exist yet, so running Python will fail anyway. Just make sure
+        # it fails in the expected way.
+        return {} unless File.exist?(path)
+        # Yes, this is a bash parser in regex. Feel free to be mad at me.
+        IO.readlines(path).inject({}) do |memo, line|
+          if match = line.match(/^export (\w+)=(.*)$/)
+            memo[match[1]] = match[2].gsub(/\$\{(\w+)(:\+:\$\{\w+\})?\}/) do
+              if $2
+                ENV[$1] ? ":#{ENV[$1]}" : ''
+              else
+                ENV[$1].to_s
+              end
+            end
+          end
+          memo
+        end
+      end
+
+      module ClassMethods
+        def provides_auto?(node, resource)
+          version = inversion_options(node, resource)['version']
+          !!find_scl_package(node, version)
+        end
+
+        def find_scl_package(node, version)
+          pkg = scl_packages.find {|p| p[:version].start_with?(version) }
+          return unless pkg
+          pkg[:url] = node.value_for_platform(pkg[:urls])
+          return unless pkg[:url]
+          pkg
+        end
+
+        private
+
+        def scl_packages
+          @scl_packages ||= []
+        end
+
+        def scl_package(version, name, urls)
+          scl_packages << {version: version, name: name, urls: urls}
+        end
+
+        def included(klass)
+          super
+          klass.extend(ClassMethods)
+        end
+      end
+
+      extend ClassMethods
+
+    end
+  end
+end

data/lib/poise_languages/scl/resource.rb

@@ -0,0 +1,124 @@
+#
+# 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'
+
+
+module PoiseLanguages
+  module Scl
+    # A `poise_language_scl` resource to manage installing a language from
+    # SCL packages. This is an internal implementation detail of
+    # poise-languages.
+    #
+    # @api private
+    # @since 1.0
+    # @provides poise_languages_scl
+    # @action install
+    # @action uninstall
+    class Resource < Chef::Resource
+      include Poise
+      provides(:poise_languages_scl)
+      actions(:install, :uninstall)
+
+      # @!attribute package_name
+      #   Name of the SCL package for the language.
+      #   @return [String]
+      attribute(:package_name, kind_of: String, name_attribute: true)
+      # @!attribute url
+      #   URL to the SCL repository package for the language.
+      #   @return [String]
+      attribute(:url, kind_of: String, required: true)
+      # @!attribute parent
+      #   Resource for the language runtime. Used only for messages.
+      #   @return [Chef::Resource]
+      attribute(:parent, kind_of: Chef::Resource, required: true)
+    end
+
+    # The default provider for `poise_languages_scl`.
+    #
+    # @api private
+    # @since 1.0
+    # @see Resource
+    # @provides poise_languages_scl
+    class Provider < Chef::Provider
+      include Poise
+      provides(:poise_languages_scl)
+
+      # The `install` action for the `poise_languages_scl` resource.
+      #
+      # @return [void]
+      def action_install
+        notifying_block do
+          install_scl_utils
+          install_scl_repo_package
+          install_scl_package
+        end
+      end
+
+      # The `uninstall` action for the `poise_languages_scl` resource.
+      #
+      # @return [void]
+      def action_uninstall
+        notifying_block do
+          uninstall_scl_utils
+          uninstall_scl_repo_package
+          uninstall_scl_package
+        end
+      end
+
+      private
+
+      def install_scl_utils
+        package 'scl-utils' do
+          action :upgrade # This shouldn't be a problem. Famous last words.
+        end
+      end
+
+      def install_scl_repo_package
+        rpm_package 'rhscl-' + new_resource.package_name do
+          source new_resource.url
+        end
+      end
+
+      def install_scl_package
+        yum_package new_resource.package_name do
+          flush_cache before: true
+        end
+      end
+
+      def uninstall_scl_utils
+        install_scl_utils.tap do |r|
+          r.action(:remove)
+        end
+      end
+
+      def uninstall_scl_repo_package
+        install_scl_repo_package.tap do |r|
+          r.action(:remove)
+        end
+      end
+
+      def uninstall_scl_package
+        install_scl_package.tap do |r|
+          r.action(:remove)
+        end
+      end
+
+    end
+  end
+end

data/lib/poise_languages/system.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.
+#
+
+
+module PoiseLanguages
+  module System
+    autoload :Mixin, 'poise_languages/system/mixin'
+    autoload :Resource, 'poise_languages/system/resource'
+    autoload :Provider, 'poise_languages/system/resource'
+  end
+end

data/lib/poise_languages/system/mixin.rb

@@ -0,0 +1,165 @@
+#
+# 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/system/resource'
+
+
+module PoiseLanguages
+  module System
+    module Mixin
+
+      private
+
+      # Install a language using system packages.
+      #
+      # @api public
+      # @return [PoiseLanguages::System::Resource]
+      def install_system_packages
+        dev_package_overrides = system_dev_package_overrides
+        poise_languages_system options['package_name'] || system_package_name do
+          # Otherwise use the default install action.
+          action(:upgrade) if options['package_upgrade']
+          parent new_resource
+          # Don't pass true because we want the default computed behavior for that.
+          dev_package options['dev_package'] unless options['dev_package'] == true
+          dev_package_overrides dev_package_overrides
+          package_version options['package_version'] if options['package_version']
+          version options['version']
+        end
+      end
+
+      # Uninstall a language using system packages.
+      #
+      # @api public
+      # @return [PoiseLanguages::System::Resource]
+      def uninstall_system_packages
+        install_system_packages.tap do |r|
+          r.action(:uninstall)
+        end
+      end
+
+      # Compute all possible package names for a given language version. Must be
+      # implemented by mixin users. Versions are expressed as prefixes so ''
+      # matches all versions, '2' matches 2.x.
+      #
+      # @abstract
+      # @api public
+      # @param version [String] Language version prefix.
+      # @return [Array<String>]
+      def system_package_candidates(version)
+        raise NotImplementedError
+      end
+
+      # Compute the default package name for the base package for this language.
+      #
+      # @api public
+      # @return [String]
+      def system_package_name
+        # Look up all packages for this language on this platform.
+        system_packages = node.value_for_platform(self.class.packages)
+        if !system_packages && self.class.default_package
+          Chef::Log.debug("[#{new_resource}] No known packages for #{node['platform']} #{node['platform_version']}, defaulting to '#{self.class.default_package}'.")
+          system_packages = Array(self.class.default_package)
+        end
+
+        # Find the first value on system_package_candidates that is in system_packages.
+        system_package_candidates(options['version'].to_s).each do |name|
+          return name if system_packages.include?(name)
+        end
+        # No valid candidate. Sad trombone.
+        raise PoiseLanguages::Error.new("Unable to find a candidate package for version #{options['version'].to_s.inspect}. Please set package_name provider option for #{new_resource}.")
+      end
+
+      # A hash mapping package names to their override dev package name.
+      #
+      # @api public
+      # @return [Hash<String, String>]
+      def system_dev_package_overrides
+        {}
+      end
+
+      module ClassMethods
+        # Install this as a default provider for platforms we are relatively
+        # certain work.
+        #
+        # @api private
+        def provides_auto?(node, resource)
+          super || node.platform_family?('debian', 'rhel', 'amazon', 'fedora')
+        end
+
+        # Set some default inversion provider options. Package name can't get
+        # a default value here because that would complicate the handling of
+        # {system_package_candidates}.
+        #
+        # @api private
+        def default_inversion_options(node, resource)
+          super.merge({
+            # Install dev headers?
+            dev_package: true,
+            # Manual overrides for package name and/or version.
+            package_name: nil,
+            package_version: nil,
+            # Set to true to use action :upgrade on system packages.
+            package_upgrade: false,
+          })
+        end
+
+        # @overload packages()
+        #   Return a hash formatted for value_for_platform returning an Array
+        #   of package names.
+        #   @return [Hash]
+        # @overload packages(default_package, packages)
+        #   Define what system packages are available for this language on each
+        #   platform.
+        #   @param default_package [String] Default package name for platforms
+        #     not otherwise defined.
+        #   @param [Hash] Hash formatted for value_for_platform returning an
+        #     Array of package names.
+        #   @return [Hash]
+        def packages(default_package=nil, packages=nil)
+          self.default_package(default_package) if default_package
+          if packages
+            @packages = packages
+          end
+          @packages
+        end
+
+        # @overload default_package()
+        #   Return the default package name for platforms not otherwise defined.
+        #   @return [String]
+        # @overload default_package(name)
+        #   Set the default package name for platforms not defined in {packages}.
+        #   @param name [String] Package name.
+        #   @return [String]
+        def default_package(name=nil)
+          if name
+            @default_package = name
+          end
+          @default_package
+        end
+
+        # @api private
+        def included(klass)
+          super
+          klass.extend(ClassMethods)
+        end
+      end
+
+      extend ClassMethods
+
+    end
+  end
+end