halite 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bd9453c15ddb7b58021da152d53ee281e00e13e
-  data.tar.gz: 641b09025f131006f0707625a4f22a475deac522
+  metadata.gz: 1a37de991e3e0d1627ffdef876685f8eec08df61
+  data.tar.gz: 6299278206fcadb36f2b6c6b5f6b33b63a563c58
 SHA512:
-  metadata.gz: 7bdb648670ef4bc5afdb954e7c5f769c8bf643f8e58c6065c63211e90e4bfc5336cf358d68313585e53b31e0bad5c70b647c858f2f51d917cb921fbc603e7c19
-  data.tar.gz: 36c524bb699a35b9a7c3f772e56d74cf220cc8e1a41df349dfcb632f52d9a815f0fc515922999457394d54fdc71ff91cc4c3cb097876df0b898301c247899c44
+  metadata.gz: 3e584b28d05cad1e885c1050c149e0b0541b8157e8493ecdbd9b50bad174379e51f0185b56284f8d50d61ee290ea2f15e2ef5babe02bf91e004b28967ad3f8c5
+  data.tar.gz: 0fdac57fd61e32efcc2017d937c3db4c58d5ec1673f9db36e73ba6057e5a8fc1697eac98242f398a0e48e2a8c08f6a759b4f22eb2baa4450c4970f1e09801ad4

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Halite Changelog
 
+## v1.7.0
+
+* Allow specifying which platforms a cookbook supports via gem metadata:
+  `spec.metadata['platforms'] = 'ubuntu centos'`.
+* Support for automatic ChefSpec matchers in the future.
+
 ## v1.6.0
 
 * Chef 13 compatibility.

data/lib/halite/converter/metadata.rb

@@ -47,7 +47,10 @@ module Halite
             buf << ", #{dep.requirement.inspect}" if dep.requirement != '>= 0'
             buf << "\n"
           end
-          buf << "chef_version(*#{gem_data.chef_version_requirement.inspect}) if defined?(chef_version)\n"
+          buf << "chef_version #{gem_data.chef_version_requirement.map(&:inspect).join(', ')} if defined?(chef_version)\n"
+          gem_data.platforms.each do |platform|
+            buf << "supports #{platform.map(&:inspect).join(', ')}\n"
+          end
         end
       end
 

data/lib/halite/gem.rb

@@ -116,6 +116,28 @@ module Halite
       end
     end
 
+    # Platform support to be used in the Chef metadata.
+    #
+    # @return [Array<Array<String>>]
+    def platforms
+      raw_platforms = spec.metadata.fetch('platforms', '').strip
+      case raw_platforms
+      when ''
+        []
+      when 'any', 'all', '*'
+        # Based on `ls lib/fauxhai/platforms  | xargs echo`.
+        %w{aix amazon arch centos chefspec debian dragonfly4 fedora freebsd gentoo
+           ios_xr mac_os_x nexus omnios openbsd opensuse oracle raspbian redhat
+           slackware smartos solaris2 suse ubuntu windows}.map {|p| [p] }
+      when /,/
+        # Comma split mode. String looks like "name, name constraint, name constraint"
+        raw_platforms.split(/\s*,\s*/).map {|p| p.split(/\s+/, 2) }
+      else
+        # Whitepace split mode, assume no constraints.
+        raw_platforms.split(/\s+/).map {|p| [p] }
+      end
+    end
+
     # Iterate over all the files in the gem, with an optional prefix. Each
     # element in the iterable will be [full_path, relative_path], where
     # relative_path is relative to the prefix or gem path.
@@ -221,7 +243,8 @@ module Halite
       if spec.metadata['halite_chef_version']
         # Manually overridden by gem metadata, use that.
         [spec.metadata['halite_chef_version']]
-      elsif dep = spec.dependencies.find {|dep| dep.name == 'chef' && !dep.requirement.none? }
+      elsif dep = spec.dependencies.find {|inner_dep| inner_dep.name == 'chef' && !inner_dep.requirement.none? }
+        # Parse through the dependencies looking for something like `spec.add_dependency 'chef', '>= 12.1''`.
         dep.requirement.as_list
       else
         ['>= 12']

data/lib/halite/helper_base.rb

@@ -21,7 +21,6 @@ require 'thor'
 require 'thor/shell'
 
 require 'halite/error'
-require 'halite/gem'
 
 
 module Halite
@@ -124,6 +123,7 @@ module Halite
     #
     # @return [Halite::Gem]
     def cookbook
+      require 'halite/gem'
       @cookbook ||= Halite::Gem.new(gemspec)
     end
   end

data/lib/halite/spec_helper.rb

@@ -14,13 +14,15 @@
 # limitations under the License.
 #
 
+# This must come first to ensure ChefSpec can patch in for matcher loading.
+require 'chefspec'
+
 # Fix load ordering bug in Chef 12.0.1. Remove this when dropping support for 12.0.
 require 'chef/providers'
 
 require 'chef/node'
 require 'chef/provider'
 require 'chef/resource'
-require 'chefspec'
 
 
 module Halite

data/lib/halite/version.rb

@@ -17,5 +17,5 @@
 
 module Halite
   # Halite version.
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
 end

data/spec/converter/metadata_spec.rb

@@ -50,6 +50,7 @@ describe Halite::Converter::Metadata do
         cookbook_version: cookbook_version,
         issues_url: issues_url,
         chef_version_requirement: chef_version_requirement,
+        platforms: [],
       )
     end
     subject { described_class.generate(gem_data) }
@@ -58,7 +59,7 @@ describe Halite::Converter::Metadata do
       it { is_expected.to eq <<-EOH }
 name "mygem"
 version "1.0.0"
-chef_version(*[">= 12"]) if defined?(chef_version)
+chef_version ">= 12" if defined?(chef_version)
 EOH
     end # /context with simple data
 
@@ -70,7 +71,7 @@ EOH
 # header
 name "mygem"
 version "1.0.0"
-chef_version(*[">= 12"]) if defined?(chef_version)
+chef_version ">= 12" if defined?(chef_version)
 EOH
     end # /context with a license header
 
@@ -80,7 +81,7 @@ EOH
 name "mygem"
 version "1.0.0"
 depends "other"
-chef_version(*[">= 12"]) if defined?(chef_version)
+chef_version ">= 12" if defined?(chef_version)
 EOH
     end # /context with one dependency
 
@@ -91,7 +92,7 @@ name "mygem"
 version "1.0.0"
 depends "other", "~> 1.0"
 depends "another", "~> 2.0.0"
-chef_version(*[">= 12"]) if defined?(chef_version)
+chef_version ">= 12" if defined?(chef_version)
 EOH
     end # /context with two dependencies
 
@@ -104,7 +105,7 @@ EOH
 name "mygem"
 version "1.0.0"
 description "My awesome library!"
-chef_version(*[">= 12"]) if defined?(chef_version)
+chef_version ">= 12" if defined?(chef_version)
 EOH
     end # /context with a description
 
@@ -118,7 +119,7 @@ EOH
 name "mygem"
 version "1.0.0"
 long_description "My awesome readme!\\nCopyright me.\\n"
-chef_version(*[">= 12"]) if defined?(chef_version)
+chef_version ">= 12" if defined?(chef_version)
 EOH
     end # /context with a readme
 
@@ -128,10 +129,20 @@ EOH
       it { is_expected.to eq <<-EOH }
 name "mygem"
 version "1.0.0"
-chef_version(*[">= 0"]) if defined?(chef_version)
+chef_version ">= 0" if defined?(chef_version)
 EOH
     end # /context with a chef_version
 
+    context 'with a complex chef_version' do
+      let(:chef_version_requirement) { ['< 15', '>= 12.5'] }
+
+      it { is_expected.to eq <<-EOH }
+name "mygem"
+version "1.0.0"
+chef_version "< 15", ">= 12.5" if defined?(chef_version)
+EOH
+    end # /context with a complex chef_version
+
     context 'with an issues_url' do
       let(:issues_url) { 'http://issues' }
 
@@ -139,9 +150,39 @@ EOH
 name "mygem"
 version "1.0.0"
 issues_url "http://issues" if defined?(issues_url)
-chef_version(*[">= 12"]) if defined?(chef_version)
+chef_version ">= 12" if defined?(chef_version)
 EOH
     end # /context with an issues_url
+
+    context 'with platforms' do
+      before do
+        allow(gem_data).to receive(:platforms).and_return([%w{ubuntu}, %w{debian}, %w{redhat}])
+      end
+
+      it { is_expected.to eq <<-EOH }
+name "mygem"
+version "1.0.0"
+chef_version ">= 12" if defined?(chef_version)
+supports "ubuntu"
+supports "debian"
+supports "redhat"
+EOH
+    end # /context with platforms
+
+    context 'with complex platforms' do
+      before do
+        allow(gem_data).to receive(:platforms).and_return([['ubuntu', '>= 16.04'], ['debian', '>= 6', '< 9'], %w{redhat}])
+      end
+
+      it { is_expected.to eq <<-EOH }
+name "mygem"
+version "1.0.0"
+chef_version ">= 12" if defined?(chef_version)
+supports "ubuntu", ">= 16.04"
+supports "debian", ">= 6", "< 9"
+supports "redhat"
+EOH
+    end # /context with complex platforms
   end # /describe #generate
 
   describe '#write' do

data/spec/fixtures/cookbooks/test1/metadata.rb

@@ -6,4 +6,4 @@ maintainer "Noah Kantrowitz"
 maintainer_email "noah@coderanger.net"
 source_url "http://example.com/" if defined?(source_url)
 license "Apache 2.0"
-chef_version(*[">= 12"]) if defined?(chef_version)
+chef_version ">= 12" if defined?(chef_version)

data/spec/fixtures/cookbooks/test2/metadata.rb

@@ -6,4 +6,5 @@ maintainer_email "noah@coderanger.net"
 source_url "http://example.com/" if defined?(source_url)
 license "Apache 2.0"
 depends "testdep"
-chef_version(*[">= 12"]) if defined?(chef_version)
+chef_version ">= 12" if defined?(chef_version)
+supports "ubuntu"

data/spec/fixtures/cookbooks/test3/metadata.rb

@@ -6,4 +6,6 @@ maintainer_email "noah@coderanger.net"
 source_url "http://example.com/" if defined?(source_url)
 license "Apache 2.0"
 depends "test2", "~> 4.5.6"
-chef_version(*[">= 3"]) if defined?(chef_version)
+chef_version ">= 3" if defined?(chef_version)
+supports "ubuntu", ">= 16.04"
+supports "redhat"

data/spec/fixtures/cookbooks/test4/metadata.rb

@@ -6,4 +6,9 @@ maintainer_email "noah@coderanger.net"
 source_url "http://example.com/" if defined?(source_url)
 issues_url "http://issues" if defined?(issues_url)
 license "Apache 2.0"
-chef_version(*[">= 1"]) if defined?(chef_version)
+chef_version "< 99", ">= 1" if defined?(chef_version)
+supports "ubuntu"
+supports "debian"
+supports "centos"
+supports "redhat"
+supports "fedora"

data/spec/fixtures/gems/test2/test2.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary = %q||
   spec.homepage = 'http://example.com/'
   spec.license = 'Apache 2.0'
+  spec.metadata['platforms'] = 'ubuntu'
 
   spec.files = `cd #{File.expand_path('..', __FILE__)} && git ls-files`.split($/)
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/spec/fixtures/gems/test3/test3.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.license = 'Apache 2.0'
   spec.metadata['halite_entry_point'] = 'test3/dsl'
   spec.metadata['halite_chef_version'] = '>= 3'
+  spec.metadata['platforms'] = 'ubuntu >= 16.04, redhat'
 
   spec.files = `cd #{File.expand_path('..', __FILE__)} && git ls-files`.split($/)
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/spec/fixtures/gems/test4/test4.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage = 'http://example.com/'
   spec.license = 'Apache 2.0'
   spec.metadata['issues_url'] = 'http://issues'
+  spec.metadata['platforms'] = 'ubuntu debian centos redhat fedora'
 
   spec.files = `cd #{File.expand_path('..', __FILE__)} && git ls-files`.split($/)
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -20,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w{lib}
 
   spec.add_dependency 'halite'
-  spec.add_dependency 'chef', '>= 1'
+  spec.add_dependency 'chef', '>= 1', '< 99'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'test2', '~> 4.5.6'

data/spec/gem_spec.rb

@@ -35,6 +35,7 @@ describe Halite::Gem do
     its(:version) { is_expected.to eq Halite::VERSION }
     its(:spec) { is_expected.to quiet_be_a Gem::Specification }
     its(:issues_url) { is_expected.to eq 'https://github.com/poise/halite/issues' }
+    its(:platforms) { is_expected.to eq [] }
   end
 
   context 'when loading halite with a version' do
@@ -66,7 +67,8 @@ describe Halite::Gem do
     its(:cookbook_dependencies) { is_expected.to eq [] }
     its(:is_halite_cookbook?) { is_expected.to be_truthy }
     its(:issues_url) { is_expected.to be_nil }
-    its(:chef_version_requirement) { is_expected.to eq [">= 12"] }
+    its(:chef_version_requirement) { is_expected.to eq ['>= 12'] }
+    its(:platforms) { is_expected.to eq [] }
 
     describe '#each_file' do
       context 'with no prefixes' do
@@ -105,7 +107,8 @@ describe Halite::Gem do
     its(:cookbook_dependencies) { is_expected.to eq [Halite::Dependencies::Dependency.new('testdep', '>= 0', :requirements)] }
     its(:is_halite_cookbook?) { is_expected.to be_truthy }
     its(:issues_url) { is_expected.to be_nil }
-    its(:chef_version_requirement) { is_expected.to eq [">= 12"] }
+    its(:chef_version_requirement) { is_expected.to eq ['>= 12'] }
+    its(:platforms) { is_expected.to eq [%w{ubuntu}] }
 
     describe '#each_file' do
       context 'with no prefixes' do
@@ -142,6 +145,7 @@ describe Halite::Gem do
     its(:is_halite_cookbook?) { is_expected.to be_truthy }
     its(:issues_url) { is_expected.to be_nil }
     its(:chef_version_requirement) { is_expected.to eq [">= 3"] }
+    its(:platforms) { is_expected.to eq [['ubuntu', '>= 16.04'], %w{redhat}] }
   end # /context when loading test3
 
   context 'when loading test4' do
@@ -152,7 +156,8 @@ describe Halite::Gem do
     its(:version) { is_expected.to eq '2.3.1.rc.1' }
     its(:cookbook_version) { is_expected.to eq '2.3.1' }
     its(:issues_url) { is_expected.to eq 'http://issues' }
-    its(:chef_version_requirement) { is_expected.to eq [">= 1"] }
+    its(:chef_version_requirement) { is_expected.to eq ['< 99', '>= 1'] }
+    its(:platforms) { is_expected.to eq [%w{ubuntu}, %w{debian}, %w{centos}, %w{redhat}, %w{fedora}] }
   end # /context when loading test4
 
   context 'when loading a Gem::Dependency' do
@@ -237,4 +242,75 @@ describe Halite::Gem do
       it { is_expected.to eq 'mycompany-mygem' }
     end
   end # /describe #cookbook_name
+
+  describe '#platforms' do
+    let(:platforms) { '' }
+    let(:metadata) { {'platforms' => platforms} }
+    subject { described_class.new(Gem::Specification.new {|s| s.metadata.update(metadata) }).platforms }
+
+    context 'with no metadata' do
+      let(:metadata) { {} }
+      it { is_expected.to eq [] }
+    end # /context with no metadata
+
+    context 'with ""' do
+      let(:platforms) { '' }
+      it { is_expected.to eq [] }
+    end # /context with ""
+
+    context 'with " "' do
+      let(:platforms) { ' ' }
+      it { is_expected.to eq [] }
+    end # /context with " "
+
+    context 'with "name1"' do
+      let(:platforms) { 'name1' }
+      it { is_expected.to eq [%w{name1}] }
+    end # /context with "name1"
+
+    context 'with "name1 "' do
+      let(:platforms) { 'name1 ' }
+      it { is_expected.to eq [%w{name1}] }
+    end # /context with "name1 "
+
+    context 'with " name1"' do
+      let(:platforms) { ' name1' }
+      it { is_expected.to eq [%w{name1}] }
+    end # /context with " name1"
+
+    context 'with "name1 name2"' do
+      let(:platforms) { 'name1 name2' }
+      it { is_expected.to eq [%w{name1}, %w{name2}] }
+    end # /context with "name1 name2"
+
+    context 'with "name1, name2"' do
+      let(:platforms) { 'name1, name2' }
+      it { is_expected.to eq [%w{name1}, %w{name2}] }
+    end # /context with "name1, name2"
+
+    context 'with "name1 >= 1.0, name2"' do
+      let(:platforms) { 'name1 >= 1.0, name2' }
+      it { is_expected.to eq [['name1', '>= 1.0'], %w{name2}] }
+    end # /context with "name1 >= 1.0, name2"
+
+    context 'with "name1 >= 1.0, name2 <= 2.0"' do
+      let(:platforms) { 'name1 >= 1.0, name2 <= 2.0' }
+      it { is_expected.to eq [['name1', '>= 1.0'], ['name2', '<= 2.0']] }
+    end # /context with "name1 >= 1.0, name2 <= 2.0"
+
+    context 'with "any"' do
+      let(:platforms) { 'any' }
+      it { is_expected.to eq [%w{aix}, %w{amazon}, %w{arch}, %w{centos}, %w{chefspec}, %w{debian}, %w{dragonfly4}, %w{fedora}, %w{freebsd}, %w{gentoo}, %w{ios_xr}, %w{mac_os_x}, %w{nexus}, %w{omnios}, %w{openbsd}, %w{opensuse}, %w{oracle}, %w{raspbian}, %w{redhat}, %w{slackware}, %w{smartos}, %w{solaris2}, %w{suse}, %w{ubuntu}, %w{windows}] }
+    end # /context with "any"
+
+    context 'with "all"' do
+      let(:platforms) { 'all' }
+      it { is_expected.to eq [%w{aix}, %w{amazon}, %w{arch}, %w{centos}, %w{chefspec}, %w{debian}, %w{dragonfly4}, %w{fedora}, %w{freebsd}, %w{gentoo}, %w{ios_xr}, %w{mac_os_x}, %w{nexus}, %w{omnios}, %w{openbsd}, %w{opensuse}, %w{oracle}, %w{raspbian}, %w{redhat}, %w{slackware}, %w{smartos}, %w{solaris2}, %w{suse}, %w{ubuntu}, %w{windows}] }
+    end # /context with "all"
+
+    context 'with "*"' do
+      let(:platforms) { '*' }
+      it { is_expected.to eq [%w{aix}, %w{amazon}, %w{arch}, %w{centos}, %w{chefspec}, %w{debian}, %w{dragonfly4}, %w{fedora}, %w{freebsd}, %w{gentoo}, %w{ios_xr}, %w{mac_os_x}, %w{nexus}, %w{omnios}, %w{openbsd}, %w{opensuse}, %w{oracle}, %w{raspbian}, %w{redhat}, %w{slackware}, %w{smartos}, %w{solaris2}, %w{suse}, %w{ubuntu}, %w{windows}] }
+    end # /context with "*"
+  end # /describe #platforms
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: halite
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Noah Kantrowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-09 00:00:00.000000000 Z
+date: 2017-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef