omnibus 4.0.0 → 4.1.0

data/lib/omnibus/sugarable.rb

@@ -32,12 +32,18 @@ module Omnibus
   module Sugarable
     def self.included(base)
       base.send(:include, Chef::Sugar::DSL)
+      base.send(:include, Omnibus::Sugar)
 
       if base < Cleanroom
         # Make all the "sugars" available in the cleanroom (DSL)
         Chef::Sugar::DSL.instance_methods.each do |instance_method|
           base.send(:expose, instance_method)
         end
+
+        # Make all the common "sugars" available in the cleanroom (DSL)
+         Omnibus::Sugar.instance_methods.each do |instance_method|
+          base.send(:expose, instance_method)
+        end
       end
     end
 
@@ -49,4 +55,16 @@ module Omnibus
       Ohai
     end
   end
+
+  # This module is a wrapper for common Chef::Sugar-like functions that
+  # are common to multiple DSLs (like project and software). The extensions
+  # below will be injected into CleanRoom, and hence visible to the DSLs.
+  module Sugar
+
+    # Returns whether the Windows build target is 32-bit (x86).
+    # If this returns false, the target is x64. Itanium is not supported.
+    def windows_arch_i386?
+      Config.windows_arch.to_sym == :x86
+    end
+  end
 end

data/lib/omnibus/templating.rb

@@ -53,7 +53,14 @@ module Omnibus
       end
 
       template = ERB.new(File.read(source), nil, '-')
-      struct   = Struct.new(*variables.keys).new(*variables.values)
+
+      struct =
+        if variables.empty?
+          Struct.new("Empty")
+        else
+          Struct.new(*variables.keys).new(*variables.values)
+        end
+
       result   = template.result(struct.instance_eval { binding })
 
       File.open(destination, 'w', mode) do |file|

data/lib/omnibus/version.rb

@@ -15,5 +15,5 @@
 #
 
 module Omnibus
-  VERSION = '4.0.0'
+  VERSION = '4.1.0'
 end

data/omnibus.gemspec

@@ -21,19 +21,22 @@ Gem::Specification.new do |gem|
   gem.test_files = gem.files.grep(/^(test|spec|features)\//)
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'chef-sugar',      '~> 2.2'
-  gem.add_dependency 'cleanroom',       '~> 1.0'
-  gem.add_dependency 'mixlib-shellout', '~> 1.4'
-  gem.add_dependency 'ohai',            '~> 7.2'
-  gem.add_dependency 'uber-s3'
-  gem.add_dependency 'thor',            '~> 0.18'
+  gem.add_dependency 'chef-sugar',       '~> 3.0'
+  gem.add_dependency 'cleanroom',        '~> 1.0'
+  gem.add_dependency 'mixlib-shellout',  '~> 2.0'
+  gem.add_dependency 'mixlib-versioning'
+  gem.add_dependency 'ohai',             '~> 8.0'
+  gem.add_dependency 'ruby-progressbar', '~> 1.7'
+  gem.add_dependency 'aws-sdk',          '~> 2'
+  gem.add_dependency 'thor',             '~> 0.18'
 
   gem.add_development_dependency 'bundler'
   gem.add_development_dependency 'artifactory', '~> 2.0'
   gem.add_development_dependency 'aruba',       '~> 0.5'
-  gem.add_development_dependency 'fauxhai',     '~> 2.1'
+  gem.add_development_dependency 'fauxhai',     '~> 2.3'
   gem.add_development_dependency 'rspec',       '~> 3.0'
   gem.add_development_dependency 'rspec-its'
+  gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'appbundler'
 end

data/resources/bff/gen.template.erb

@@ -15,7 +15,7 @@ Fileset
   Include license files in this package: N
   Requisites:
   ROOT Part: Y
-  USRFiles 
+  USRFiles
 <% files.each do |file| -%>
     <%= file %>
 <% end -%>

data/resources/msi/bundle.wxs.erb

@@ -0,0 +1,17 @@
+<?xml version='1.0' encoding="utf-8"?>
+<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi" xmlns:util="http://schemas.microsoft.com/wix/UtilExtension" xmlns:bal="http://schemas.microsoft.com/wix/BalExtension">
+  <!-- This is how we include wxi files -->
+  <?include "parameters.wxi" ?>
+
+  <Bundle Version="$(var.VersionNumber)" Manufacturer="!(loc.ManufacturerName)" UpgradeCode="$(var.UpgradeCode)">
+    <BootstrapperApplicationRef Id="WixStandardBootstrapperApplication.RtfLicense" >
+      <bal:WixStandardBootstrapperApplication LicenseFile="Resources\assets\LICENSE.rtf"/>
+    </BootstrapperApplicationRef>
+
+    <Chain>
+      <ExePackage SourceFile="$(var.OmnibusCacheDir)\vcredist_x64.exe" InstallCommand="/Q"
+        DownloadUrl="http://download.microsoft.com/download/d/2/4/d242c3fb-da5a-4542-ad66-f9661d0a8d19/vcredist_x64.exe" />
+      <MsiPackage SourceFile="<%= msi %>" EnableFeatureSelection="no" />
+    </Chain>
+  </Bundle>
+</Wix>

data/resources/msi/localization-en-us.wxl.erb

@@ -2,7 +2,7 @@
 <WixLocalization Culture="en-us" xmlns="http://schemas.microsoft.com/wix/2006/localization">
   <String Id="LANG">1033</String>
   <String Id="ProductName"><%= friendly_name %></String>
-  <String Id="ManufacturerName"><%= maintainer %></String>
+  <String Id="ManufacturerName"><%= maintainer.encode(:xml => :attr) %></String>
   <String Id="WelcomeDlgTitle">{\WixUI_Font_Bigger}Welcome to the [ProductName] Setup Wizard</String>
 
   <String Id="LicenseAgreementDlgTitle">{\WixUI_Font_Title_White}End-User License Agreement</String>

data/resources/rpm/spec.erb

@@ -17,7 +17,7 @@
 # Metadata
 Name: <%= name %>
 Version: <%= version %>
-Release: <%= iteration %>
+Release: <%= iteration %><%= dist_tag %>
 Summary:  <%= description.split("\n").first.empty? ? "_" : description.split("\n").first %>
 BuildArch: <%= architecture %>
 AutoReqProv: no

data/spec/functional/builder_spec.rb

@@ -7,10 +7,18 @@ module Omnibus
     #
     # Fakes the embedded bin path to whatever exists in bundler. This is useful
     # for testing methods like +ruby+ and +rake+ without the need to compile
-    # a real Ruby just for functional tests.
+    # a real Ruby just for functional tests. This strategy does not work on
+    # Windows because a) windows doesn't have symlinks and b) the windows
+    # omnibus installation has a post installation step that fixes up
+    # shebang paths to point to embedded ruby and drops bat files with
+    # the correct path. If we need to invoke bundler/appbundler etc. in a
+    # manner similar to one that omnibus provides, we would need to emulate
+    # the fixup steps here as well, which is a pain the ass.
     #
+    # So just don't run those tests on windows.
     def fake_embedded_bin(name)
       create_directory(embedded_bin_dir)
+      name = 'ruby.exe' if windows? && name == 'ruby'
       create_link(Bundler.which(name), File.join(embedded_bin_dir, name))
     end
 
@@ -32,7 +40,7 @@ module Omnibus
       end
     end
 
-    describe '#patch' do
+    describe '#patch', :not_supported_on_windows do
       it 'applies the patch' do
         configure = File.join(project_dir, 'configure')
         File.open(configure, 'w') do |f|
@@ -79,7 +87,7 @@ module Omnibus
       end
     end
 
-    describe '#gem' do
+    describe '#gem', :not_supported_on_windows do
       it 'executes the command as the embedded gem' do
         gemspec = File.join(tmp_path, 'example.gemspec')
         File.open(gemspec, 'w') do |f|
@@ -106,7 +114,7 @@ module Omnibus
       end
     end
 
-    describe '#bundler' do
+    describe '#bundler', :not_supported_on_windows do
       it 'executes the command as the embedded bundler' do
         gemspec = File.join(tmp_path, 'example.gemspec')
         File.open(gemspec, 'w') do |f|
@@ -145,7 +153,7 @@ module Omnibus
       end
     end
 
-    describe '#appbundle' do
+    describe '#appbundle', :not_supported_on_windows do
       it 'executes the command as the embedded appbundler' do
 
         source_dir       = "#{Omnibus::Config.source_dir}/example"
@@ -210,7 +218,7 @@ module Omnibus
       end
     end
 
-    describe '#rake' do
+    describe '#rake', :not_supported_on_windows do
       it 'executes the command as the embedded rake' do
         rakefile = File.join(tmp_path, 'Rakefile')
         File.open(rakefile, 'w') do |f|
@@ -445,7 +453,7 @@ module Omnibus
       end
     end
 
-    describe '#link' do
+    describe '#link', :not_supported_on_windows do
       it 'links the file' do
         path_a = File.join(tmp_path, 'file1')
         path_b = File.join(tmp_path, 'file2')

data/spec/functional/fetchers/git_fetcher_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'omnibus/manifest_entry'
 
 module Omnibus
   describe GitFetcher do
@@ -11,7 +12,15 @@ module Omnibus
       { git: remote }
     end
 
-    subject { described_class.new(software) }
+    let(:manifest_entry) do
+      double(ManifestEntry,
+        name: 'software',
+        locked_version: '45ded6d3b1a35d66ed866b2c3eb418426e6382b0',
+        described_version: version,
+        locked_source: source)
+    end
+
+    subject { described_class.new(manifest_entry, project_dir, build_dir) }
 
     describe '#fetch_required?' do
       context 'when the repo is not cloned' do
@@ -82,19 +91,38 @@ module Omnibus
 
     describe '#fetch'  do
       let(:revision) { shellout!('git rev-parse HEAD', cwd: project_dir).stdout.strip }
+      let(:version)  { 'v1.2.4' }
+      let(:remote)   { remote_git_repo('zlib', annotated_tags: [version]) }
+      let(:manifest_entry) do
+        double(ManifestEntry,
+               name: 'software',
+               locked_version: 'efde208366abd0f91419d8a54b45e3f6e0540105',
+               described_version: version,
+               locked_source: source)
+      end
+
+      subject { described_class.new(manifest_entry, project_dir, build_dir) }
+
 
       it 'clones the repository' do
         subject.fetch
         expect("#{project_dir}/.git").to be_a_directory
       end
 
+      it 'fetches the locked_version from the manifest' do
+        subject.fetch
+        expect(revision).to eq(manifest_entry.locked_version)
+      end
+    end
+
+
+    describe '#resolve_version' do
       context 'when the version is a tag' do
         let(:version)  { 'v1.2.3' }
         let(:remote)   { remote_git_repo('zlib', tags: [version]) }
 
         it 'parses the tag' do
-          subject.fetch
-          expect(revision).to eq('53c72c4abcc961b153996f5b5f402ce715e47146')
+          expect(GitFetcher.resolve_version(version, source)).to eq('53c72c4abcc961b153996f5b5f402ce715e47146')
         end
       end
 
@@ -103,8 +131,7 @@ module Omnibus
         let(:remote)   { remote_git_repo('zlib', annotated_tags: [version]) }
 
         it 'it defererences and parses the annotated tag' do
-          subject.fetch
-          expect(revision).to eq('efde208366abd0f91419d8a54b45e3f6e0540105')
+          expect(GitFetcher.resolve_version(version, source)).to eq('efde208366abd0f91419d8a54b45e3f6e0540105')
         end
       end
 
@@ -113,8 +140,7 @@ module Omnibus
         let(:remote)  { remote_git_repo('zlib', branches: [version]) }
 
         it 'parses the branch' do
-          subject.fetch
-          expect(revision).to eq('171a1aec35ac0a050f8dccd9c9ef4609b1d8d8ea')
+          expect(GitFetcher.resolve_version(version, source)).to eq('171a1aec35ac0a050f8dccd9c9ef4609b1d8d8ea')
         end
       end
 
@@ -123,8 +149,7 @@ module Omnibus
         let(:remote)  { remote_git_repo('zlib') }
 
         it 'parses the full SHA-1' do
-          subject.fetch
-          expect(revision).to eq('45ded6d3b1a35d66ed866b2c3eb418426e6382b0')
+          expect(GitFetcher.resolve_version(version, source)).to eq('45ded6d3b1a35d66ed866b2c3eb418426e6382b0')
         end
       end
 
@@ -133,8 +158,7 @@ module Omnibus
         let(:remote)  { remote_git_repo('zlib') }
 
         it 'parses the abbreviated SHA-1' do
-          subject.fetch
-          expect(revision).to eq('45ded6d3b1a35d66ed866b2c3eb418426e6382b0')
+          expect(GitFetcher.resolve_version(version, source)).to eq('45ded6d')
         end
       end
 
@@ -143,7 +167,7 @@ module Omnibus
         let(:remote)  { remote_git_repo('zlib') }
 
         it 'raise an exception' do
-          expect { subject.fetch }.to raise_error(UnresolvableGitReference)
+          expect { GitFetcher.resolve_version(version, source) }.to raise_error(UnresolvableGitReference)
         end
       end
     end
@@ -154,6 +178,14 @@ module Omnibus
       it 'includes the revision' do
         expect(subject.version_for_cache).to eq("revision:#{revision}")
       end
+
+      it 'does not returned cached revision after fetching' do
+        before_fetch = subject.version_for_cache
+        subject.fetch
+        after_fetch = revision
+        expect(subject.version_for_cache).to eq("revision:#{after_fetch}")
+        expect(subject.version_for_cache).not_to eq("revision:#{before_fetch}")
+      end
     end
   end
 end

data/spec/functional/fetchers/net_fetcher_spec.rb

@@ -2,18 +2,32 @@ require 'spec_helper'
 
 module Omnibus
   describe NetFetcher do
-    include_examples 'a software'
+    include_examples 'a software', 'zlib'
+
+    let(:source_url) { 'http://downloads.sourceforge.net/project/libpng/zlib/1.2.8/zlib-1.2.8.tar.gz' }
+    let(:source_md5) { '44d667c142d7cda120332623eab69f40' }
+    let(:source_sha1) { 'a4d316c404ff54ca545ea71a27af7dbc29817088' }
+    let(:source_sha256) { '36658cb768a54c1d4dec43c3116c27ed893e88b02ecfcb44f2166f9c0b7f2a0d' }
+    let(:source_sha512) { 'ece209d4c7ec0cb58ede791444dc754e0d10811cbbdebe3df61c0fd9f9f9867c1c3ccd5f1827f847c005e24eef34fb5bf87b5d3f894d75da04f1797538290e4a' }
 
-    let(:source_url) { 'http://www.bzip.org/1.0.6/bzip2-1.0.6.tar.gz' }
-    let(:source_md5) { '00b516f4704d4a7cb50a1d97e6e8e15b' }
     let(:source) do
       { url: source_url, md5: source_md5 }
     end
 
     let(:downloaded_file) { subject.send(:downloaded_file) }
-    let(:extracted) { File.join(source_dir, 'bzip2-1.0.6') }
+    let(:extracted) { File.join(source_dir, 'zlib-1.2.8') }
+
+    let(:fetch!) { capture_stdout { subject.fetch } }
 
-    subject { described_class.new(software) }
+    let(:manifest_entry) do
+      double(ManifestEntry,
+             name: 'software',
+             locked_version: '1.2.8',
+             described_version: '1.2.8',
+             locked_source: source)
+    end
+
+    subject { described_class.new(manifest_entry, project_dir, build_dir) }
 
     describe '#fetch_required?' do
       context 'when the file is not downloaded' do
@@ -23,7 +37,7 @@ module Omnibus
       end
 
       context 'when the file is downloaded' do
-        before { subject.fetch }
+        before { fetch! }
 
         context 'when the checksum is different' do
           it 'return true' do
@@ -41,13 +55,45 @@ module Omnibus
     end
 
     describe '#version_guid' do
-      it 'includes the source md5' do
-        expect(subject.version_guid).to eq("md5:#{source_md5}")
+      context 'source with md5' do
+        it 'includes the md5 digest' do
+          expect(subject.version_guid).to eq("md5:#{source_md5}")
+        end
+      end
+
+      context 'source with sha1' do
+        let(:source) do
+          { url: source_url, sha1: source_sha1 }
+        end
+
+        it 'includes the sha1 digest' do
+          expect(subject.version_guid).to eq("sha1:#{source_sha1}")
+        end
+      end
+
+      context 'source with sha256' do
+        let(:source) do
+          { url: source_url, sha256: source_sha256 }
+        end
+
+        it 'includes the sha256 digest' do
+          expect(subject.version_guid).to eq("sha256:#{source_sha256}")
+        end
+      end
+
+      context 'source with sha512' do
+        let(:source) do
+          { url: source_url, sha512: source_sha512 }
+        end
+
+        it 'includes the sha512 digest' do
+          expect(subject.version_guid).to eq("sha512:#{source_sha512}")
+        end
       end
     end
 
     describe '#clean' do
-      before { subject.fetch }
+      before { fetch! }
 
       context 'when the project directory exists' do
         before do
@@ -76,21 +122,94 @@ module Omnibus
     end
 
     describe '#fetch' do
-      it 'downloads the file' do
-        subject.fetch
-        expect(downloaded_file).to be_a_file
+      context 'source with md5' do
+        it 'downloads the file' do
+          fetch!
+          expect(downloaded_file).to be_a_file
+        end
+
+        context 'when the checksum is invalid' do
+          let(:source_md5) { 'bad01234checksum' }
+
+          it 'raises an exception' do
+            expect { fetch! }.to raise_error(ChecksumMismatch)
+          end
+        end
+      end
+
+      context 'source with sha1' do
+        let(:source) do
+          { url: source_url, sha1: source_sha1 }
+        end
+
+        it 'downloads the file' do
+          fetch!
+          expect(downloaded_file).to be_a_file
+        end
+
+        context 'when the checksum is invalid' do
+          let(:source_sha1) { 'bad01234checksum' }
+
+          it 'raises an exception' do
+            expect { fetch! }.to raise_error(ChecksumMismatch)
+          end
+        end
       end
 
-      context 'when the checksum is invalid' do
-        let(:source_md5) { 'bad01234checksum' }
+      context 'source with sha256' do
+        let(:source) do
+          { url: source_url, sha256: source_sha256 }
+        end
+
+        it 'downloads the file' do
+          fetch!
+          expect(downloaded_file).to be_a_file
+        end
+
+        context 'when the checksum is invalid' do
+          let(:source_sha256) { 'bad01234checksum' }
+
+          it 'raises an exception' do
+            expect { fetch! }.to raise_error(ChecksumMismatch)
+          end
+        end
+      end
+
+      context 'source with sha512' do
+        let(:source) do
+          { url: source_url, sha512: source_sha512 }
+        end
+
+        it 'downloads the file' do
+          fetch!
+          expect(downloaded_file).to be_a_file
+        end
+
+        context 'when the checksum is invalid' do
+          let(:source_sha512) { 'bad01234checksum' }
+
+          it 'raises an exception' do
+            expect { fetch! }.to raise_error(ChecksumMismatch)
+          end
+        end
+      end
 
-        it 'raises an exception' do
-          expect { subject.fetch }.to raise_error(ChecksumMismatch)
+      it 'when the download times out' do
+        # Mock the Timeout::Error for this particular test only
+        WebMock.disable_net_connect!
+        stub_request(:get, "http://downloads.sourceforge.net/project/libpng/zlib/1.2.8/zlib-1.2.8.tar.gz").to_timeout
+        output = capture_logging do
+          expect { subject.send(:download) }.to raise_error(Timeout::Error)
         end
+
+        expect(output).to include('Retrying failed download')
+        expect(output).to include('Download failed')
+        retry_count = output.scan('Retrying failed download').count
+        expect(retry_count).to eq(Omnibus::Config.fetcher_retries)
       end
 
       it 'extracts the file' do
-        subject.fetch
+        fetch!
         expect(extracted).to be_a_directory
       end
 
@@ -99,7 +218,7 @@ module Omnibus
         let(:source_md5) { '369efc3a19b9118cdf51c7e87a34f266' }
 
         it 'downloads the file' do
-          subject.fetch
+          fetch!
           expect(downloaded_file).to be_a_file
         end
       end
@@ -112,8 +231,40 @@ module Omnibus
         create_file("#{project_dir}/.file_c")
       end
 
-      it 'includes the download_url and checksum' do
-        expect(subject.version_for_cache).to eq("download_url:#{source_url}|md5:#{source_md5}")
+      context 'source with md5' do
+        it 'includes the download_url and checksum' do
+          expect(subject.version_for_cache).to eq("download_url:#{source_url}|md5:#{source_md5}")
+        end
+      end
+
+      context 'source with sha1' do
+        let(:source) do
+          { url: source_url, sha1: source_sha1 }
+        end
+
+        it 'includes the download_url and checksum' do
+          expect(subject.version_for_cache).to eq("download_url:#{source_url}|sha1:#{source_sha1}")
+        end
+      end
+
+      context 'source with sha256' do
+        let(:source) do
+          { url: source_url, sha256: source_sha256 }
+        end
+
+        it 'includes the download_url and checksum' do
+          expect(subject.version_for_cache).to eq("download_url:#{source_url}|sha256:#{source_sha256}")
+        end
+      end
+
+      context 'source with sha512' do
+        let(:source) do
+          { url: source_url, sha512: source_sha512 }
+        end
+
+        it 'includes the download_url and checksum' do
+          expect(subject.version_for_cache).to eq("download_url:#{source_url}|sha512:#{source_sha512}")
+        end
       end
     end
   end