poise-languages 1.0.0

data/lib/poise_languages/system/resource.rb

@@ -0,0 +1,202 @@
+#
+# 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 System
+    # A `poise_language_system` resource to manage installing a language from
+    # system packages. This is an internal implementation detail of
+    # poise-languages.
+    #
+    # @api private
+    # @since 1.0
+    # @provides poise_languages_system
+    # @action install
+    # @action upgrade
+    # @action uninstall
+    class Resource < Chef::Resource
+      include Poise
+      provides(:poise_languages_system)
+      actions(:install, :upgrade, :uninstall)
+
+      # @!attribute package_name
+      #   Name of the main package for the language.
+      #   @return [String]
+      attribute(:package_name, kind_of: String, name_attribute: true)
+      # @!attribute dev_package
+      #   Name of the development headers package, or false to disable
+      #   installing headers. By default computed from {package_name}.
+      #   @return [String, false]
+      attribute(:dev_package, kind_of: [String, FalseClass], default: lazy { default_dev_package })
+      # @!attribute dev_package_overrides
+      #   A hash of override names for dev packages that don't match the normal
+      #   naming scheme.
+      #   @return [Hash<String, String>]
+      attribute(:dev_package_overrides, kind_of: Hash, default: lazy { {} })
+      # @!attribute package_version
+      #   Version of the package(s) to install. This is distinct from {version},
+      #   and is the specific version package version, not the language version.
+      #   By default this is unset meaning the latest version will be used.
+      #   @return [String, nil]
+      attribute(:package_version, kind_of: [String, NilClass])
+      # @!attribute parent
+      #   Resource for the language runtime. Used only for messages.
+      #   @return [Chef::Resource]
+      attribute(:parent, kind_of: Chef::Resource, required: true)
+      # @!attributes version
+      #   Language version prefix. This prefix determines which version of the
+      #   language to install, following prefix matching rules.
+      #   @return [String]
+      attribute(:version, kind_of: String, default: '')
+
+      # Compute the default package name for the development headers.
+      #
+      # @return [String]
+      def default_dev_package
+        # Check for an override.
+        return dev_package_overrides[package_name] if dev_package_overrides.include?(package_name)
+        suffix = node.value_for_platform_family(debian: '-dev', rhel: '-devel', fedora: '-devel')
+        # Platforms like Arch and Gentoo don't need this anyway. I've got no
+        # clue how Amazon Linux does this.
+        if suffix
+          package_name + suffix
+        else
+          nil
+        end
+      end
+    end
+
+    # The default provider for `poise_languages_system`.
+    #
+    # @api private
+    # @since 1.0
+    # @see Resource
+    # @provides poise_languages_system
+    class Provider < Chef::Provider
+      include Poise
+      provides(:poise_languages_system)
+
+      # The `install` action for the `poise_languages_system` resource.
+      #
+      # @return [void]
+      def action_install
+        run_package_action(:install)
+      end
+
+      # The `upgrade` action for the `poise_languages_system` resource.
+      #
+      # @return [void]
+      def action_upgrade
+        run_package_action(:upgrade)
+      end
+
+      # The `uninstall` action for the `poise_languages_system` resource.
+      #
+      # @return [void]
+      def action_uninstall
+        action = node.platform_family?('debian') ? :purge : :remove
+        package_resources(action).each do |resource|
+          resource.run_action(action)
+          new_resource.updated_by_last_action(true) if resource.updated_by_last_action?
+        end
+      end
+
+      private
+
+      # Create package resource objects for all needed packages. These are created
+      # directly and not added to the resource collection.
+      #
+      # @return [Array<Chef::Resource::Package>]
+      def package_resources(action)
+        packages = {new_resource.package_name => new_resource.package_version}
+        # If we are supposed to install the dev package, grab it using the same
+        # version as the main package.
+        if new_resource.dev_package
+          packages[new_resource.dev_package] = new_resource.package_version
+        end
+
+        Chef::Log.debug("[#{new_resource.parent}] Building package resource using #{packages.inspect}.")
+        @package_resource ||= if node.platform_family?('rhel', 'fedora', 'amazon')
+          # @todo Can't use multi-package mode with yum pending https://github.com/chef/chef/issues/3476.
+          packages.map do |name, version|
+            Chef::Resource::Package.new(name, run_context).tap do |r|
+              r.version(version)
+              r.action(action)
+              r.declared_type = :package
+            end
+          end
+        else
+          [Chef::Resource::Package.new(packages.keys, run_context).tap do |r|
+            r.version(packages.values)
+            r.action(action)
+            r.declared_type = :package
+          end]
+        end
+      end
+
+      # Run the requested action for all package resources. This exists because
+      # we inject our version check in to the provider directly and I want to
+      # only run the provider action once for performance. It is otherwise
+      # mostly a stripped down version of Chef::Resource#run_action.
+      #
+      # @param action [Symbol] Action to run on all package resources.
+      # @return [void]
+      def run_package_action(action)
+        package_resources(action).each do |resource|
+          # Reset it so we have a clean baseline.
+          resource.updated_by_last_action(false)
+          # Grab the provider.
+          provider = resource.provider_for_action(action)
+          provider.action = action
+          # Check the candidate version if needed
+          patch_load_current_resource!(provider, new_resource.version)
+          # Run our action.
+          Chef::Log.debug("[#{new_resource.parent}] Running #{provider} with #{action}")
+          provider.run_action(action)
+          # Check updated flag.
+          new_resource.updated_by_last_action(true) if resource.updated_by_last_action?
+        end
+      end
+
+      # Hack a provider object to run our verification code.
+      #
+      # @param provider [Chef::Provider] Provider object to patch.
+      # @param version [String] Language version prefix to check for.
+      # @return [void]
+      def patch_load_current_resource!(provider, version)
+        # Create a closure module and inject it.
+        provider.extend Module.new {
+          # Patch load_current_resource to run our verification logic after
+          # the normal code.
+          define_method(:load_current_resource) do
+            super().tap do |_|
+              each_package do |package_name, new_version, current_version, candidate_version|
+                unless candidate_version.start_with?(version)
+                  raise PoiseLanguages::Error.new("Package #{package_name} would install #{candidate_version}, which does not match #{version.empty? ? version.inspect : version}. Please set the package_name or package_version provider options.")
+                end
+              end
+            end
+          end
+        }
+      end
+
+    end
+  end
+end

data/lib/poise_languages/utils.rb

@@ -0,0 +1,49 @@
+#
+# 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 'shellwords'
+
+require 'poise_languages/utils/which'
+
+
+module PoiseLanguages
+  module Utils
+    include Which
+    extend self
+
+    # Convert the executable in a string or array command to an absolute path.
+    #
+    # @param cmd [String, Array<String>] Command to fix up.
+    # @param path [String, nil] Replacement $PATH for executable lookup.
+    # @return [String, Array<String>]
+    def absolute_command(cmd, path: nil)
+      was_array = cmd.is_a?(Array)
+      cmd = if was_array
+        cmd.dup
+      else
+        Shellwords.split(cmd)
+      end
+      # Don't try to touch anything if the first value looks like a flag.
+      if cmd.first && !cmd.first.start_with?('-')
+        # If which returns false, just leave it I guess.
+        cmd[0] = which(cmd.first, path: path) || cmd.first
+      end
+      cmd = Shellwords.join(cmd) unless was_array
+      cmd
+    end
+
+  end
+end

data/lib/poise_languages/utils/which.rb

@@ -0,0 +1,49 @@
+#
+# 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 Utils
+    # Replacement module for Chef::Mixin::Which with a slight improvement.
+    #
+    # @since 1.0.0
+    # @see Which#which
+    module Which
+      extend self
+
+      # A replacement for Chef::Mixin::Which#which that allows using something
+      # other than an environment variable if needed.
+      #
+      # @param cmd [String] Executable to search for.
+      # @param extra_path [Array<String>] Extra directories to always search.
+      # @param path [String, nil] Replacement $PATH value.
+      # @return [String, false]
+      def which(cmd, extra_path: %w{/bin /usr/bin /sbin /usr/sbin}, path: nil)
+        # Allow passing something other than the real env var.
+        path ||= ENV['PATH']
+        # Based on Chef::Mixin::Which#which
+        # Copyright 2010-2015, Chef Softare, Inc.
+        paths = path.split(File::PATH_SEPARATOR) + extra_path
+        paths.each do |candidate_path|
+          filename = ::File.join(candidate_path, cmd)
+          return filename if ::File.executable?(filename)
+        end
+        false
+      end
+
+    end
+  end
+end

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

data/poise-languages.gemspec

@@ -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.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'poise_languages/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'poise-languages'
+  spec.version = PoiseLanguages::VERSION
+  spec.authors = ['Noah Kantrowitz']
+  spec.email = %w{noah@coderanger.net}
+  spec.description = "A Chef cookbook to help writing language cooobkoks."
+  spec.summary = spec.description
+  spec.homepage = 'https://github.com/poise/poise-languages'
+  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.3'
+
+  spec.add_development_dependency 'poise-boiler', '~> 1.0'
+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'

data/test/gemfiles/master.gemfile

@@ -0,0 +1,22 @@
+#
+# 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', github: 'chef/chef'
+gem 'halite', github: 'poise/halite'
+gem 'poise', github: 'poise/poise'
+gem 'poise-boiler', github: 'poise/poise-boiler'

data/test/spec/command/mixin_spec.rb

@@ -0,0 +1,328 @@
+#
+# 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 'spec_helper'
+
+describe PoiseLanguages::Command::Mixin do
+  resource(:mylang_runtime) do
+    include Poise(container: true)
+    attribute(:mylang_binary, default: '/binary')
+    attribute(:mylang_environment, default: {'MYLANG_PATH' => '/thing'})
+  end
+  provider(:mylang_runtime)
+  let(:runtime) { chef_run.mylang_runtime('parent') }
+
+  describe PoiseLanguages::Command::Mixin::Resource do
+    resource(:poise_test) do
+      klass = described_class
+      include Module.new {
+        include klass
+        language_command_mixin(:mylang)
+      }
+      def which(name)
+        "/which/#{name}"
+      end
+    end
+    provider(:poise_test)
+
+    describe '#parent_$name' do
+      context 'with a parent' do
+        recipe do
+          mylang_runtime 'parent'
+          poise_test 'test'
+        end
+        it { is_expected.to run_poise_test('test').with(parent_mylang: chef_run.mylang_runtime('parent')) }
+      end # /context with a parent
+
+      context 'with no parent' do
+        recipe do
+          poise_test 'test'
+        end
+        it { is_expected.to run_poise_test('test').with(parent_mylang: nil) }
+      end # /context with no parent
+
+      context 'with two containers' do
+        recipe do
+          mylang_runtime 'parent'
+          poise_test 'test'
+          mylang_runtime 'other'
+        end
+
+        it { is_expected.to run_poise_test('test').with(parent_mylang: chef_run.mylang_runtime('parent')) }
+      end # /context with two containers
+    end # /describe #parent_$name
+
+    describe '#timeout' do
+      recipe do
+        poise_test 'test' do
+          # Be explicit because Kernel#timeout is part of the timeout.rb lib.
+          self.timeout(123)
+        end
+      end
+
+      context 'with timeout enabled' do
+        it { is_expected.to run_poise_test('test').with(timeout: 123) }
+      end # /context with timeout enabled
+
+      context 'with timeout disabled' do
+        resource(:poise_test) do
+          klass = described_class
+          include Module.new {
+            include klass
+            language_command_mixin(:poise, timeout: false)
+          }
+        end
+        it { expect { subject }.to raise_error NoMethodError }
+      end # /context with timeout disabled
+    end # /describe #timeout
+
+    describe '#$name' do
+      context 'with an implicit parent' do
+        recipe do
+          mylang_runtime 'parent'
+          poise_test 'test'
+        end
+
+        it { is_expected.to run_poise_test('test').with(parent_mylang: runtime, mylang: '/binary') }
+      end # /context with an implicit parent
+
+      context 'with a parent resource' do
+        recipe do
+          r = mylang_runtime 'parent'
+          poise_test 'test' do
+            mylang r
+          end
+        end
+
+        it { is_expected.to run_poise_test('test').with(parent_mylang: runtime, mylang: '/binary') }
+      end # /context with a parent resource
+
+      context 'with a parent resource name' do
+        recipe do
+          mylang_runtime 'parent'
+          poise_test 'test' do
+            mylang 'parent'
+          end
+        end
+
+        it { is_expected.to run_poise_test('test').with(parent_mylang: runtime, mylang: '/binary') }
+      end # /context with a parent resource name
+
+      context 'with a parent resource name that looks like a path' do
+        let(:runtime) { chef_run.mylang_runtime('/usr/bin/other') }
+        recipe do
+          mylang_runtime '/usr/bin/other' do
+            mylang_binary name
+          end
+          poise_test 'test' do
+            mylang '/usr/bin/other'
+          end
+        end
+
+        it { is_expected.to run_poise_test('test').with(parent_mylang: runtime, mylang: '/usr/bin/other') }
+      end # /context with a parent resource name that looks like a path
+
+      context 'with a path' do
+        recipe do
+          poise_test 'test' do
+            mylang '/usr/bin/other'
+          end
+        end
+
+        it { is_expected.to run_poise_test('test').with(parent_mylang: nil, mylang: '/usr/bin/other') }
+      end # /context with a path
+
+      context 'with a path and an implicit parent' do
+        recipe do
+          mylang_runtime 'parent'
+          poise_test 'test' do
+            mylang '/usr/bin/other'
+          end
+        end
+
+        it { is_expected.to run_poise_test('test').with(parent_mylang: runtime, mylang: '/usr/bin/other') }
+      end # /context with a path and an implicit parent
+
+      context 'with an invalid parent' do
+        recipe do
+          poise_test 'test' do
+            mylang 'test'
+          end
+        end
+
+        it { expect { subject }.to raise_error Chef::Exceptions::ResourceNotFound }
+      end # /context with an invalid parent
+
+      context 'with no parent' do
+        recipe do
+          poise_test 'test'
+        end
+
+        it { is_expected.to run_poise_test('test').with(parent_mylang: nil, mylang: '/which/mylang') }
+      end # /context with no parent
+    end # /describe #$name
+
+    describe '#$name_from_parent' do
+      context 'with a resource parent' do
+        recipe do
+          mylang_runtime 'parent'
+          r = poise_test 'first' do
+            mylang 'parent'
+          end
+          mylang_runtime 'other'
+          poise_test 'test' do
+            mylang_from_parent r
+          end
+        end
+
+        it { is_expected.to run_poise_test('test').with(parent_mylang: runtime, mylang: '/binary') }
+      end # /context with a resource parent
+
+      context 'with a path parent' do
+        recipe do
+          r = poise_test 'first' do
+            mylang '/other'
+          end
+          poise_test 'test' do
+            mylang_from_parent r
+          end
+        end
+
+        it { is_expected.to run_poise_test('test').with(parent_mylang: nil, mylang: '/other') }
+      end # /context with a path parent
+    end # /describe #$name_from_parent
+
+    context 'as a method' do
+      resource(:poise_test) do
+        include Module.new {
+          include PoiseLanguages::Command::Mixin::Resource(:mylang)
+        }
+      end
+      recipe do
+        mylang_runtime 'parent'
+        poise_test 'test'
+      end
+
+      it { is_expected.to run_poise_test('test').with(parent_mylang: runtime, mylang: '/binary') }
+    end # /context as a method
+  end # /describe PoiseLanguages::Command::Mixin::Resource
+
+  describe PoiseLanguages::Command::Mixin::Provider do
+    resource(:poise_test) do
+      include PoiseLanguages::Command::Mixin::Resource(:mylang)
+      include Poise::Helpers::LWRPPolyfill
+      attribute(:command)
+      attribute(:expect)
+      attribute(:options, default: [])
+      def which(name)
+        "/which/#{name}"
+      end
+    end
+
+    describe '#$name_shell_out' do
+      provider(:poise_test) do
+        klass = described_class
+        include Module.new {
+          include klass
+          language_command_mixin(:mylang)
+        }
+        def action_run
+          expect(self).to receive(:shell_out).with(*new_resource.expect)
+          mylang_shell_out(new_resource.command, *new_resource.options)
+        end
+      end
+
+      context 'with a parent' do
+        recipe do
+          mylang_runtime 'parent'
+          poise_test 'test' do
+            command 'foo'
+            expect ['/binary foo', {environment: {'MYLANG_PATH' => '/thing'}, timeout: 900}]
+          end
+        end
+        it { run_chef }
+      end # /context with a parent
+
+      context 'without a parent' do
+        recipe do
+          poise_test 'test' do
+            command 'foo'
+            expect ['/which/mylang foo', {timeout: 900}]
+          end
+        end
+        it { run_chef }
+      end # /context without a parent
+
+      context 'with a timeout' do
+        recipe do
+          mylang_runtime 'parent'
+          poise_test 'test' do
+            timeout 300
+            command 'foo'
+            expect ['/binary foo', {environment: {'MYLANG_PATH' => '/thing'}, timeout: 300}]
+          end
+        end
+        it { run_chef }
+      end # /context with a timeout
+
+      context 'with environment options' do
+        recipe do
+          mylang_runtime 'parent'
+          poise_test 'test' do
+            command 'foo'
+            options [{environment: {'OTHER' => 'foo'}}]
+            expect ['/binary foo', {environment: {'MYLANG_PATH' => '/thing', 'OTHER' => 'foo'}, timeout: 900}]
+          end
+        end
+        it { run_chef }
+      end # /context with environment options
+
+      context 'with an array command' do
+        recipe do
+          poise_test 'test' do
+            command ['foo']
+            expect [['/which/mylang', 'foo'], {timeout: 900}]
+          end
+        end
+        it { run_chef }
+      end # /context with an array command
+    end # /describe #$name_shell_out
+
+    describe '#$name_shell_out!' do
+      provider(:poise_test) do
+        klass = described_class
+        include Module.new {
+          include klass
+          language_command_mixin(:mylang)
+        }
+        def action_run
+          fake_output = double()
+          expect(fake_output).to receive(:error!)
+          expect(self).to receive(:mylang_shell_out).with(*new_resource.expect).and_return(fake_output)
+          mylang_shell_out!(new_resource.command, *new_resource.options)
+        end
+      end
+      recipe do
+        poise_test 'test' do
+          command 'foo'
+          expect ['foo']
+        end
+      end
+
+      it { run_chef }
+    end # /describe #$name_shell_out!
+  end # /describe PoiseLanguages::Command::Mixin::Provider
+end