poise-languages 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a83f0d87752ae0d05c9559e572dcc877b4ff6383
-  data.tar.gz: 4d97ce1203bdbe9f54d070d2942be3ebdae14ad7
+  metadata.gz: f4a05fa47de317277eae76e90f0e2f8fd4f03d72
+  data.tar.gz: e3c4ef2901a9c2ccb9f0467334389060533448e2
 SHA512:
-  metadata.gz: 364248c8d0541ec0f3fe00db0f9c260129214cf467008b5f77b19988a4c06d60a0aafef8698c7d190383ebb000b3a58f03b76f05ad01cdc2ef46d8d4d67df32c
-  data.tar.gz: 54c6bf4cfbce36e651b265f32c818f78ef1c5df358a2402fb26eb060a30df2820a9c467202836d005fd3ffe5fef9e4e5bd2bcded9df550f9cce5d32d17ddd8fe
+  metadata.gz: dce25fe02f0b2c9c66764c19d1278d95262b0a2ae7aa2ff865a223baa21f6acc97df83ef22cd1e438e378ca9043f2bfca19d522c24e63be5818cae7394142557
+  data.tar.gz: b0ec72f8eda800c9a0a0423920c5bd704697af0c4561431d3e30e14e471b495b9b240e6e2aa288b5f1fc38c19203d27a9e859ff9577ee8d16a97032f3e2d1cc5

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v1.2.0
+
+* Support for installing development headers with SCL providers.
+* Add `PoiseLanguages::Utils.shelljoin` for encoding command arrays with some
+  bash metadata characters allowed.
+* [#1](https://github.com/poise/poise-languages/pull/1) – Fix typo in gemspec.
+
 ## v1.1.0
 
 * Add helpers for installing from static archives.

data/lib/poise_languages/scl/mixin.rb

@@ -24,9 +24,12 @@ module PoiseLanguages
 
       def install_scl_package
         pkg = scl_package
-        poise_languages_scl pkg[:name] do
+        poise_languages_scl options[:package_name] || pkg[:name] do
+          action :upgrade if options[:package_upgrade]
+          dev_package options[:dev_package] == true ? pkg[:devel_name] : options[:dev_package]
           parent new_resource
           url pkg[:url]
+          version options[:package_version]
         end
       end
 
@@ -83,6 +86,23 @@ module PoiseLanguages
           !!find_scl_package(node, version)
         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
+
         def find_scl_package(node, version)
           pkg = scl_packages.find {|p| p[:version].start_with?(version) }
           return unless pkg
@@ -97,8 +117,8 @@ module PoiseLanguages
           @scl_packages ||= []
         end
 
-        def scl_package(version, name, urls)
-          scl_packages << {version: version, name: name, urls: urls}
+        def scl_package(version, name, devel_name=nil, urls)
+          scl_packages << {version: version, name: name, devel_name: devel_name, urls: urls}
         end
 
         def included(klass)

data/lib/poise_languages/scl/resource.rb

@@ -33,16 +33,18 @@ module PoiseLanguages
     class Resource < Chef::Resource
       include Poise
       provides(:poise_languages_scl)
-      actions(:install, :uninstall)
+      actions(:install, :upgrade, :uninstall)
 
       # @!attribute package_name
       #   Name of the SCL package for the language.
       #   @return [String]
       attribute(:package_name, kind_of: String, name_attribute: true)
+      attribute(:dev_package, kind_of: [String, NilClass])
       # @!attribute url
       #   URL to the SCL repository package for the language.
       #   @return [String]
       attribute(:url, kind_of: String, required: true)
+      attribute(:version, kind_of: [String, NilClass])
       # @!attribute parent
       #   Resource for the language runtime. Used only for messages.
       #   @return [Chef::Resource]
@@ -66,7 +68,22 @@ module PoiseLanguages
         notifying_block do
           install_scl_utils
           install_scl_repo_package
-          install_scl_package
+          flush_yum_cache
+          install_scl_package(:install)
+          install_scl_devel_package(:install) if new_resource.dev_package
+        end
+      end
+
+      # The `upgrade` action for the `poise_languages_scl` resource.
+      #
+      # @return [void]
+      def action_upgrade
+        notifying_block do
+          install_scl_utils
+          install_scl_repo_package
+          flush_yum_cache
+          install_scl_package(:upgrade)
+          install_scl_devel_package(:upgrade) if new_resource.dev_package
         end
       end
 
@@ -77,7 +94,9 @@ module PoiseLanguages
         notifying_block do
           uninstall_scl_utils
           uninstall_scl_repo_package
+          uninstall_scl_devel_package if new_resource.dev_package
           uninstall_scl_package
+          flush_yum_cache
         end
       end
 
@@ -95,9 +114,25 @@ module PoiseLanguages
         end
       end
 
-      def install_scl_package
+      def flush_yum_cache
+        ruby_block 'flush_yum_cache' do
+          block do
+            # Equivalent to flush_cache after: true
+            Chef::Provider::Package::Yum::YumCache.instance.reload
+          end
+        end
+      end
+
+      def install_scl_package(action)
         yum_package new_resource.package_name do
-          flush_cache before: true
+          action action
+          version new_resource.version
+        end
+      end
+
+      def install_scl_devel_package(action)
+        yum_package new_resource.dev_package do
+          action action
         end
       end
 
@@ -114,9 +149,11 @@ module PoiseLanguages
       end
 
       def uninstall_scl_package
-        install_scl_package.tap do |r|
-          r.action(:remove)
-        end
+        install_scl_package(:remove)
+      end
+
+      def uninstall_scl_devel_package
+        install_scl_devel_package(:remove)
       end
 
     end

data/lib/poise_languages/utils.rb

@@ -24,6 +24,25 @@ module PoiseLanguages
     include Which
     extend self
 
+    # Default whitelist for {#shelljoin}.
+    SHELLJOIN_WHITELIST = [/^2?[><]/]
+
+    # An improved version of Shellwords.shelljoin that doesn't escape a few
+    # things.
+    #
+    # @param cmd [Array<String>] Command array to join.
+    # @param whitelist [Array<Regexp>] Array of patterns to whitelist.
+    # @return [String]
+    def shelljoin(cmd, whitelist: SHELLJOIN_WHITELIST)
+      cmd.map do |str|
+        if whitelist.any? {|pat| str =~ pat }
+          str
+        else
+          Shellwords.shellescape(str)
+        end
+      end.join(' ')
+    end
+
     # Convert the executable in a string or array command to an absolute path.
     #
     # @param cmd [String, Array<String>] Command to fix up.
@@ -41,7 +60,7 @@ module PoiseLanguages
         # 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 = shelljoin(cmd) unless was_array
       cmd
     end
 

data/lib/poise_languages/version.rb

@@ -16,5 +16,5 @@
 
 
 module PoiseLanguages
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/poise-languages.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   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.description = "A Chef cookbook to help writing language cookbooks."
   spec.summary = spec.description
   spec.homepage = 'https://github.com/poise/poise-languages'
   spec.license = 'Apache 2.0'

data/test/spec/scl/mixin_spec.rb

@@ -29,6 +29,9 @@ describe PoiseLanguages::Scl::Mixin do
       def scl_package
         {name: 'python34', url: 'http://something.rpm'}
       end
+      def options
+        {dev_package: true}
+      end
       def action_run
         install_scl_package
       end
@@ -47,6 +50,9 @@ describe PoiseLanguages::Scl::Mixin do
       def scl_package
         {name: 'python34', url: 'http://something.rpm'}
       end
+      def options
+        {dev_package: true}
+      end
       def action_run
         uninstall_scl_package
       end
@@ -181,6 +187,17 @@ EOH
     end # /context with an scl_source line
   end # /describe #parse_enable_file
 
+  describe '.default_inversion_options' do
+    provider(:poise_test) do
+      include Poise(inversion: :poise_test)
+      include described_class
+    end
+    let(:node) { double('node') }
+    let(:new_resource) { double('resource') }
+    subject { provider(:poise_test).default_inversion_options(node, new_resource) }
+    it { is_expected.to eq({dev_package: true, package_name: nil, package_version: nil, package_upgrade: false}) }
+  end # /describe .default_inversion_options
+
   describe '.provides_auto?' do
     let(:node) { double('node', :"[]" => {'machine' => 'x86_64'}) }
     let(:new_resource) { double('resource') }
@@ -196,13 +213,13 @@ EOH
     let(:version) { '' }
     provider(:poise_test) do
       include described_class
-      scl_package('3.4.2', 'rh-python34', {
+      scl_package('3.4.2', 'rh-python34', 'rh-python34-python-devel', {
         ['redhat', 'centos'] => {
           '~> 7.0' => 'https://www.softwarecollections.org/en/scls/rhscl/rh-python34/epel-7-x86_64/download/rhscl-rh-python34-epel-7-x86_64.noarch.rpm',
           '~> 6.0' => 'https://www.softwarecollections.org/en/scls/rhscl/rh-python34/epel-6-x86_64/download/rhscl-rh-python34-epel-6-x86_64.noarch.rpm',
         },
       })
-      scl_package('3.3.2', 'python33', {
+      scl_package('3.3.2', 'python33', 'python33-python-devel', {
         ['redhat', 'centos'] => {
           '~> 7.0' => 'https://www.softwarecollections.org/en/scls/rhscl/python33/epel-7-x86_64/download/rhscl-python33-epel-7-x86_64.noarch.rpm',
           '~> 6.0' => 'https://www.softwarecollections.org/en/scls/rhscl/python33/epel-6-x86_64/download/rhscl-python33-epel-6-x86_64.noarch.rpm',
@@ -221,6 +238,7 @@ EOH
         is_expected.to include({
           version: '3.4.2',
           name: 'rh-python34',
+          devel_name: 'rh-python34-python-devel',
           url: 'https://www.softwarecollections.org/en/scls/rhscl/rh-python34/epel-7-x86_64/download/rhscl-rh-python34-epel-7-x86_64.noarch.rpm',
         })
       end
@@ -233,6 +251,7 @@ EOH
         is_expected.to include({
           version: '3.3.2',
           name: 'python33',
+          devel_name: 'python33-python-devel',
           url: 'https://www.softwarecollections.org/en/scls/rhscl/python33/epel-6-x86_64/download/rhscl-python33-epel-6-x86_64.noarch.rpm',
         })
       end
@@ -242,5 +261,26 @@ EOH
       let(:chefspec_options) { {platform: 'ubuntu', version: '12.04'} }
       it { is_expected.to be_nil }
     end # /context on Ubuntu
+
+    context 'with no devel package' do
+      provider(:poise_test) do
+        include described_class
+        scl_package('3.4.2', 'rh-python34', {
+          ['redhat', 'centos'] => {
+            '~> 7.0' => 'https://www.softwarecollections.org/en/scls/rhscl/rh-python34/epel-7-x86_64/download/rhscl-rh-python34-epel-7-x86_64.noarch.rpm',
+            '~> 6.0' => 'https://www.softwarecollections.org/en/scls/rhscl/rh-python34/epel-6-x86_64/download/rhscl-rh-python34-epel-6-x86_64.noarch.rpm',
+          },
+        })
+      end
+      let(:chefspec_options) { {platform: 'centos', version: '7.0'} }
+      it do
+        is_expected.to include({
+          version: '3.4.2',
+          name: 'rh-python34',
+          devel_name: nil,
+          url: 'https://www.softwarecollections.org/en/scls/rhscl/rh-python34/epel-7-x86_64/download/rhscl-rh-python34-epel-7-x86_64.noarch.rpm',
+        })
+      end
+    end # /context with no devel package
   end # /describe .find_scl_package
 end

data/test/spec/scl/resource_spec.rb

@@ -18,12 +18,20 @@ require 'spec_helper'
 
 describe PoiseLanguages::Scl::Resource do
   step_into(:poise_languages_scl)
+  step_into(:ruby_block)
   let(:chefspec_options) { {platform: 'centos', version: '7.0'} }
+  let(:yum_cache) { double('yum_cache', reload: nil) }
+  before do
+    allow(Chef::Provider::Package::Yum::YumCache).to receive(:instance).and_return(yum_cache)
+  end
 
   context 'action :install' do
     recipe do
-      r = ruby_block 'parent'
+      r = ruby_block 'parent' do
+        block { }
+      end
       poise_languages_scl 'mylang' do
+        dev_package 'mylang-devel'
         parent r
         url 'http://mylang.rpm'
       end
@@ -31,14 +39,39 @@ describe PoiseLanguages::Scl::Resource do
 
     it { is_expected.to upgrade_package('scl-utils') }
     it { is_expected.to install_rpm_package('rhscl-mylang').with(source: 'http://mylang.rpm') }
-    it { is_expected.to install_yum_package('mylang').with(flush_cache: {before: true}) }
+    it { is_expected.to install_yum_package('mylang') }
+    it { is_expected.to install_yum_package('mylang-devel') }
+    it { expect(yum_cache).to receive(:reload); run_chef }
   end # /context action :install
 
+  context 'action :upgrade' do
+    recipe do
+      r = ruby_block 'parent' do
+        block { }
+      end
+      poise_languages_scl 'mylang' do
+        action :upgrade
+        dev_package 'mylang-devel'
+        parent r
+        url 'http://mylang.rpm'
+      end
+    end
+
+    it { is_expected.to upgrade_package('scl-utils') }
+    it { is_expected.to install_rpm_package('rhscl-mylang').with(source: 'http://mylang.rpm') }
+    it { is_expected.to upgrade_yum_package('mylang') }
+    it { is_expected.to upgrade_yum_package('mylang-devel') }
+    it { expect(yum_cache).to receive(:reload); run_chef }
+  end # /context action :upgrade
+
   context 'action :uninstall' do
     recipe do
-      r = ruby_block 'parent'
+      r = ruby_block 'parent' do
+        block { }
+      end
       poise_languages_scl 'mylang' do
         action :uninstall
+        dev_package 'mylang-devel'
         parent r
         url 'http://mylang.rpm'
       end
@@ -47,5 +80,7 @@ describe PoiseLanguages::Scl::Resource do
     it { is_expected.to remove_package('scl-utils') }
     it { is_expected.to remove_rpm_package('rhscl-mylang') }
     it { is_expected.to remove_yum_package('mylang') }
+    it { is_expected.to remove_yum_package('mylang-devel') }
+    it { expect(yum_cache).to receive(:reload); run_chef }
   end # /context action :uninstall
 end

data/test/spec/utils_spec.rb

@@ -17,6 +17,45 @@
 require 'spec_helper'
 
 describe PoiseLanguages::Utils do
+  describe '#shelljoin' do
+    let(:cmd) { [] }
+    subject { described_class.shelljoin(cmd) }
+
+    context 'with an empty array' do
+      it { is_expected.to eq '' }
+    end # /context with an empty array
+
+    context 'with simple arguments' do
+      let(:cmd) { %w{a b c} }
+      it { is_expected.to eq 'a b c' }
+    end # /context with simple arguments
+
+    context 'with complex arguments' do
+      let(:cmd) { ['a', 'b c', '--d=e'] }
+      it { is_expected.to eq 'a b\\ c --d\\=e' }
+    end # /context with complex arguments
+
+    context 'with input redirect' do
+      let(:cmd) { %w{a b < c} }
+      it { is_expected.to eq 'a b < c' }
+    end # /context with input redirect
+
+    context 'with input redirect and no space' do
+      let(:cmd) { %w{a b <c} }
+      it { is_expected.to eq 'a b <c' }
+    end # /context with input redirect
+
+    context 'with output redirect' do
+      let(:cmd) { %w{a b > c} }
+      it { is_expected.to eq 'a b > c' }
+    end # /context with output redirect
+
+    context 'with error redirect' do
+      let(:cmd) { %w{a b 2> c} }
+      it { is_expected.to eq 'a b 2> c' }
+    end # /context with error redirect
+  end # /describe #shelljoin
+
   describe '#absolute_command' do
     let(:path) { double('path') }
     let(:cmd) { }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poise-languages
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Noah Kantrowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-28 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: halite
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: A Chef cookbook to help writing language cooobkoks.
+description: A Chef cookbook to help writing language cookbooks.
 email:
 - noah@coderanger.net
 executables: []
@@ -118,7 +118,7 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: A Chef cookbook to help writing language cooobkoks.
+summary: A Chef cookbook to help writing language cookbooks.
 test_files:
 - test/docker/docker.ca
 - test/docker/docker.pem