omnibus 3.2.0.rc.1 → 3.2.0.rc.2

data/lib/omnibus/util.rb

@@ -48,6 +48,12 @@ module Omnibus
       options = args.last.kind_of?(Hash) ? args.pop : {}
       options = SHELLOUT_OPTIONS.merge(options)
 
+      # Since Mixlib::ShellOut supports :environment and :env, we want to
+      # standardize here
+      if options[:env]
+        options[:environment] = options.fetch(:environment, {}).merge(options[:env])
+      end
+
       # Log any environment options given
       unless options[:environment].empty?
         Omnibus.logger.info { 'Environment:' }
@@ -60,6 +66,7 @@ module Omnibus
       Omnibus.logger.info { "$ #{args.join(' ')}" }
 
       cmd = Mixlib::ShellOut.new(*args, options)
+      cmd.environment['HOME'] = '/tmp' unless ENV['HOME']
       cmd.run_command
       cmd
     end
@@ -92,13 +99,16 @@ module Omnibus
       value && value.to_s =~ /^(false|f|no|n|0)$/i
     end
 
+    #
+    # Convert the given path to be appropiate for shelling out on Windows.
+    #
     # @param [Array<String>] pieces
     #   the pieces of the path to join and fix
     # @return [String]
     #   the path with applied changes
     #
     def windows_safe_path(*pieces)
-      path = File.expand_path(File.join(*pieces))
+      path = File.join(*pieces)
 
       if File::ALT_SEPARATOR
         path.gsub(File::SEPARATOR, File::ALT_SEPARATOR)

data/lib/omnibus/version.rb

@@ -15,5 +15,5 @@
 #
 
 module Omnibus
-  VERSION = '3.2.0.rc.1'
+  VERSION = '3.2.0.rc.2'
 end

data/omnibus.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |gem|
   gem.test_files = gem.files.grep(/^(test|spec|features)\//)
   gem.require_paths = ['lib']
 
+  gem.add_dependency 'bundler'
   gem.add_dependency 'chef-sugar',      '~> 1.2'
   gem.add_dependency 'mixlib-shellout', '~> 1.4'
   gem.add_dependency 'ohai',            '~> 7.2.0.rc'
@@ -31,9 +32,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'artifactory', '~> 1.2'
   gem.add_development_dependency 'aruba',       '~> 0.5'
   gem.add_development_dependency 'fauxhai',     '~> 2.1'
-  gem.add_development_dependency 'rspec',       '~> 2.14'
+  gem.add_development_dependency 'rspec',       '~> 3.0'
   gem.add_development_dependency 'rspec-its'
   gem.add_development_dependency 'rake'
-
-  gem.add_development_dependency 'bundler'
 end

data/spec/data/complicated/config/software/libyaml-windows.rb

@@ -35,7 +35,7 @@ source :url => "http://packages.openknapsack.org/libyaml/libyaml-0.1.6-x86-windo
 build do
   temp_directory = File.join(cache_dir, "libyaml-cache")
   # First extract the tar file out of lzma archive.
-  command "7z.exe x #{project_file} -o#{temp_directory} -r -y"
+  command "7z.exe x #{downloaded_file} -o#{temp_directory} -r -y"
   # Now extract the files out of tar archive.
   command "7z.exe x #{File.join(temp_directory, "libyaml-0.1.6-x86-windows.tar")} -o#{temp_directory} -r -y"
   # Now copy over libyaml-0-2.dll to the build dir

data/spec/functional/builder_spec.rb

@@ -0,0 +1,305 @@
+require 'spec_helper'
+
+module Omnibus
+  describe Builder do
+    let(:software) do
+      double(Software,
+        name: 'chefdk',
+        install_dir: File.join(tmp_path, 'chefdk'),
+        project_dir: File.join(tmp_path, 'chefdk', 'cache'),
+        overridden?: false,
+      )
+    end
+
+    #
+    # 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.
+    #
+    def fake_embedded_bin(name)
+      bin = File.join(software.install_dir, 'embedded', 'bin')
+
+      FileUtils.mkdir_p(bin)
+      FileUtils.ln_s(Bundler.which(name), File.join(bin, name))
+    end
+
+    subject { described_class.new(software) }
+
+    before do
+      Config.project_root(tmp_path)
+      Config.build_retries(0)
+      Config.use_git_caching(false)
+      Config.software_gems(nil)
+
+      # Make the directories
+      FileUtils.mkdir_p(software.install_dir)
+      FileUtils.mkdir_p(software.project_dir)
+      FileUtils.mkdir_p(File.join(tmp_path, 'config', 'software'))
+      FileUtils.mkdir_p(File.join(tmp_path, 'config', 'patches'))
+      FileUtils.mkdir_p(File.join(tmp_path, 'config', 'templates'))
+    end
+
+    describe '#command' do
+      it 'executes the command' do
+        path = File.join(software.install_dir, 'file.txt')
+        subject.command("echo 'Hello World!'")
+
+        output = capture_logging { subject.build }
+        expect(output).to include('Hello World')
+      end
+    end
+
+    describe '#patch' do
+      it 'applies the patch' do
+        configure = File.join(tmp_path, 'chefdk', 'cache', 'configure')
+        FileUtils.mkdir_p(File.dirname(configure))
+        File.open(configure, 'w') do |f|
+          f.write <<-EOH.gsub(/^ {12}/, '')
+            THING="-e foo"
+            ZIP="zap"
+          EOH
+        end
+
+        patch = File.join(tmp_path, 'config', 'patches', 'chefdk', 'apply.patch')
+        FileUtils.mkdir_p(File.dirname(patch))
+        File.open(patch, 'w') do |f|
+          f.write <<-EOH.gsub(/^ {12}/, '')
+            --- a/configure
+            +++ b/configure
+            @@ -1,2 +1,3 @@
+             THING="-e foo"
+            +FOO="bar"
+             ZIP="zap"
+          EOH
+        end
+
+        subject.patch(source: 'apply.patch')
+        subject.build
+      end
+    end
+
+    describe '#ruby' do
+      it 'executes the command as the embdedded ruby' do
+        ruby = File.join(tmp_path, 'chefdk', 'scripts', 'setup.rb')
+        FileUtils.mkdir_p(File.dirname(ruby))
+        File.open(ruby, 'w') do |f|
+          f.write <<-EOH.gsub(/^ {12}/, '')
+            File.write("#{software.install_dir}/test.txt", 'This is content!')
+          EOH
+        end
+
+        fake_embedded_bin('ruby')
+
+        subject.ruby(ruby)
+        subject.build
+
+        path = "#{software.install_dir}/test.txt"
+        expect(File.exist?(path)).to be_truthy
+        expect(File.read(path)).to eq('This is content!')
+      end
+    end
+
+    describe '#gem' do
+      it 'executes the command as the embedded gem' do
+        gemspec = File.join(tmp_path, 'example.gemspec')
+        File.open(gemspec, 'w') do |f|
+          f.write <<-EOH.gsub(/^ {12}/, '')
+            Gem::Specification.new do |gem|
+              gem.name           = 'example'
+              gem.version        = '1.0.0'
+              gem.author         = 'Chef Software, Inc.'
+              gem.email          = 'info@getchef.com'
+              gem.description    = 'Installs a thing'
+              gem.summary        = gem.description
+            end
+          EOH
+        end
+
+        fake_embedded_bin('gem')
+
+        subject.gem("build #{gemspec}")
+        subject.gem("install #{tmp_path}/chefdk/cache/example-1.0.0.gem")
+        output = capture_logging { subject.build }
+
+        expect(output).to include('gem build')
+        expect(output).to include('gem install')
+      end
+    end
+
+    describe '#bundler' do
+      it 'executes the command as the embedded bundler' do
+        gemspec = File.join(tmp_path, 'example.gemspec')
+        File.open(gemspec, 'w') do |f|
+          f.write <<-EOH.gsub(/^ {12}/, '')
+            Gem::Specification.new do |gem|
+              gem.name           = 'example'
+              gem.version        = '1.0.0'
+              gem.author         = 'Chef Software, Inc.'
+              gem.email          = 'info@getchef.com'
+              gem.description    = 'Installs a thing'
+              gem.summary        = gem.description
+            end
+          EOH
+        end
+
+        gemfile = File.join(tmp_path, 'Gemfile')
+        File.open(gemfile, 'w') do |f|
+          f.write <<-EOH.gsub(/^ {12}/, '')
+            gemspec
+          EOH
+        end
+
+        fake_embedded_bin('bundle')
+
+        subject.bundle('install')
+        output = capture_logging { subject.build }
+
+        expect(output).to include('bundle install')
+      end
+    end
+
+    describe '#rake' do
+      it 'executes the command as the embedded rake' do
+        rakefile = File.join(tmp_path, 'Rakefile')
+        File.open(rakefile, 'w') do |f|
+          f.write <<-EOH.gsub(/^ {12}/, '')
+            task(:foo) {  }
+          EOH
+        end
+
+        fake_embedded_bin('rake')
+
+        subject.rake('-T')
+        subject.rake('foo')
+        output = capture_logging { subject.build }
+
+        expect(output).to include('rake -T')
+        expect(output).to include('rake foo')
+      end
+    end
+
+    describe '#block' do
+      it 'executes the command as a block' do
+        subject.block('A complex operation') do
+          FileUtils.touch("#{project_dir}/bacon")
+        end
+        output = capture_logging { subject.build }
+
+        expect(output).to include('A complex operation')
+        expect(File.exist?("#{software.project_dir}/bacon")).to be_truthy
+      end
+    end
+
+    describe '#erb' do
+      it 'renders the erb' do
+        erb = File.join(tmp_path, 'config', 'templates', 'chefdk', 'example.erb')
+        FileUtils.mkdir_p(File.dirname(erb))
+        File.open(erb, 'w') do |f|
+          f.write <<-EOH.gsub(/^ {12}/, '')
+            <%= a %>
+            <%= b %>
+          EOH
+        end
+
+        destination = File.join(tmp_path, 'rendered')
+
+        subject.erb(
+          source: 'example.erb',
+          dest:   destination,
+          vars:   { a: 'foo', b: 'bar' },
+        )
+        subject.build
+
+        expect(File.exist?(destination)).to be_truthy
+        expect(File.read(destination)).to eq("foo\nbar\n")
+      end
+    end
+
+    describe '#mkdir' do
+      it 'creates the directory' do
+        path = File.join(tmp_path, 'scratch')
+        FileUtils.rm_rf(path)
+
+        subject.mkdir(path)
+        subject.build
+
+        expect(File.directory?(path)).to be_truthy
+      end
+    end
+
+    describe '#touch' do
+      it 'creates the file' do
+        path = File.join(tmp_path, 'file')
+        FileUtils.rm_rf(path)
+
+        subject.touch(path)
+        subject.build
+
+        expect(File.file?(path)).to be_truthy
+      end
+    end
+
+    describe '#delete' do
+      it 'deletes the directory' do
+        path = File.join(tmp_path, 'scratch')
+        FileUtils.mkdir_p(path)
+
+        subject.delete(path)
+        subject.build
+
+        expect(File.exist?(path)).to be_falsey
+      end
+
+      it 'deletes the file' do
+        path = File.join(tmp_path, 'file')
+        FileUtils.touch(path)
+
+        subject.delete(path)
+        subject.build
+
+        expect(File.exist?(path)).to be_falsey
+      end
+    end
+
+    describe '#copy' do
+      it 'copies the file' do
+        path_a = File.join(tmp_path, 'file1')
+        path_b = File.join(tmp_path, 'file2')
+        FileUtils.touch(path_a)
+
+        subject.copy(path_a, path_b)
+        subject.build
+
+        expect(File.file?(path_b)).to be_truthy
+        expect(File.read(path_b)).to eq(File.read(path_a))
+      end
+    end
+
+    describe '#move' do
+      it 'moves the file' do
+        path_a = File.join(tmp_path, 'file1')
+        path_b = File.join(tmp_path, 'file2')
+        FileUtils.touch(path_a)
+
+        subject.move(path_a, path_b)
+        subject.build
+
+        expect(File.file?(path_b)).to be_truthy
+        expect(File.file?(path_a)).to be_falsey
+      end
+    end
+
+    describe '#link' do
+      it 'links the file' do
+        path_a = File.join(tmp_path, 'file1')
+        path_b = File.join(tmp_path, 'file2')
+        FileUtils.touch(path_a)
+
+        subject.link(path_a, path_b)
+        subject.build
+
+        expect(File.symlink?(path_b)).to be_truthy
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -40,11 +40,11 @@ module Omnibus
     #
     def stub_env(key, value)
       unless @__env_already_stubbed__
-        ENV.stub(:[]).and_call_original
+        allow(ENV).to receive(:[]).and_call_original
         @__env_already_stubbed__ = true
       end
 
-      ENV.stub(:[]).with(key).and_return(value.to_s)
+      allow(ENV).to receive(:[]).with(key).and_return(value.to_s)
     end
 
     #
@@ -56,7 +56,7 @@ module Omnibus
       require 'ohai' unless defined?(Mash)
 
       ohai = Mash.from_hash(Fauxhai.mock(options, &block).data)
-      Ohai.stub(:ohai).and_return(ohai)
+      allow(Ohai).to receive(:ohai).and_return(ohai)
     end
 
     #
@@ -103,7 +103,6 @@ RSpec.configure do |config|
   config.include Omnibus::RSpec
   config.filter_run focus: true
   config.run_all_when_everything_filtered = true
-  config.treat_symbols_as_metadata_keys_with_true_values = true
 
   config.filter_run_excluding windows_only: true unless windows?
   config.filter_run_excluding mac_only: true unless mac?
@@ -141,11 +140,13 @@ end
 # Shard example group for asserting a DSL method
 #
 # @example
-#   it_behaves_like 'a cleanroom setter', :name, 'chef'
+#   it_behaves_like 'a cleanroom setter', :name, <<-EOH
+#     name 'foo'
+#   EOH
 #
-RSpec.shared_examples 'a cleanroom setter' do |id, value|
+RSpec.shared_examples 'a cleanroom setter' do |id, string|
   it "for `#{id}'" do
-    expect { subject.evaluate("#{id}(#{value.inspect})") }
+    expect { subject.evaluate(string) }
       .to_not raise_error
   end
 end

data/spec/unit/build_version_dsl_spec.rb

@@ -17,120 +17,122 @@
 
 require 'spec_helper'
 
-describe Omnibus::BuildVersionDSL do
-  let(:subject_with_version) { Omnibus::BuildVersionDSL.new(version_string) }
-  let(:subject_with_description) { Omnibus::BuildVersionDSL.new(&description) }
+module Omnibus
+  describe BuildVersionDSL do
+    let(:subject_with_version) { described_class.new(version_string) }
+    let(:subject_with_description) { described_class.new(&description) }
 
-  let(:version_string) { "1.0.0" }
-  let(:description) { nil }
+    let(:version_string) { "1.0.0" }
+    let(:description) { nil }
 
-  let(:zoo_version) { double("BuildVersion", semver: "5.5.5", custom: "7.7.7") }
-  let(:zoo_software) { double("software", name: 'zoo', project_dir: '/etc/zoo', version: "6.6.6") }
+    let(:zoo_version) { double("BuildVersion", semver: "5.5.5", custom: "7.7.7") }
+    let(:zoo_software) { double("software", name: 'zoo', project_dir: '/etc/zoo', version: "6.6.6") }
 
-  describe "when given nil" do
-    it "should fail" do
-      expect { subject.build_version }.to raise_error
+    describe "when given nil" do
+      it "fails" do
+        expect { subject.build_version }.to raise_error
+      end
     end
-  end
 
-  describe "when given a string" do
-    it "should set the version to the string" do
-      expect(subject_with_version.build_version).to eq("1.0.0")
+    describe "when given a string" do
+      it "sets the version to the string" do
+        expect(subject_with_version.build_version).to eq("1.0.0")
+      end
     end
-  end
 
-  describe "when given a :git source" do
-    describe "when given a software as source" do
-      let(:description) do
-        proc do
-          source(:git, from_dependency: 'zoo')
+    describe "when given a :git source" do
+      describe "when given a software as source" do
+        let(:description) do
+          proc do
+            source(:git, from_dependency: 'zoo')
+          end
         end
-      end
 
-      describe "before resolving version" do
-        it "should mention the version is not ready yet" do
-          expect(subject_with_description.explain).to match(/will be determined/)
+        describe "before resolving version" do
+          it "mentions the version is not ready yet" do
+            expect(subject_with_description.explain).to match(/will be determined/)
+          end
+
+          it "includes the dependency name in the message" do
+            expect(subject_with_description.explain).to match(/zoo/)
+          end
         end
 
-        it "should include the dependency name in the message" do
-          expect(subject_with_description.explain).to match(/zoo/)
+        describe "after resolving version" do
+          before do
+            expect(BuildVersion).to receive(:new).with("/etc/zoo").and_return(zoo_version)
+            subject_with_description.resolve(zoo_software)
+          end
+
+          it "creates the version with path from source with semver" do
+            expect(subject_with_description.explain).to eq("Build Version: 5.5.5")
+          end
         end
       end
 
-      describe "after resolving version" do
-        before do
-          Omnibus::BuildVersion.should_receive(:new).with("/etc/zoo").and_return(zoo_version)
-          subject_with_description.resolve(zoo_software)
+      describe "when not given a software as source" do
+        let(:description) do
+          proc { source(:git) }
         end
 
-        it "should create the version with path from source with semver" do
-          expect(subject_with_description.explain).to eq("Build Version: 5.5.5")
+        it "creates the version with default path as semver" do
+          expect(BuildVersion).to receive(:new).with(no_args).and_return(zoo_version)
+          expect(subject_with_description.build_version).to eq("5.5.5")
         end
       end
-    end
 
-    describe "when not given a software as source" do
-      let(:description) do
-        proc { source(:git) }
-      end
+      describe "when given an output format" do
+        let(:description) do
+          proc do
+            source(:git)
+            output_format(:custom)
+          end
+        end
 
-      it "should create the version with default path as semver" do
-        Omnibus::BuildVersion.should_receive(:new).with(no_args).and_return(zoo_version)
-        expect(subject_with_description.build_version).to eq("5.5.5")
+        it "outputs the version with given function" do
+          expect(BuildVersion).to receive(:new).with(no_args).and_return(zoo_version)
+          expect(subject_with_description.build_version).to eq("7.7.7")
+        end
       end
     end
 
-    describe "when given an output format" do
-      let(:description) do
-        proc do
-          source(:git)
-          output_format(:custom)
+    describe "when given a :version source" do
+      describe "when given a software as source" do
+        let(:description) do
+          proc do
+            source(:version, from_dependency: 'zoo')
+          end
         end
-      end
 
-      it "should output the version with given function" do
-        Omnibus::BuildVersion.should_receive(:new).with(no_args).and_return(zoo_version)
-        expect(subject_with_description.build_version).to eq("7.7.7")
+        it "creates the version with version from source" do
+          subject_with_description.resolve(zoo_software)
+          expect(subject_with_description.build_version).to eq("6.6.6")
+        end
       end
-    end
-  end
 
-  describe "when given a :version source" do
-    describe "when given a software as source" do
-      let(:description) do
-        proc do
-          source(:version, from_dependency: 'zoo')
+      describe "when not given a software as source" do
+        let(:description) do
+          proc do
+            source(:version)
+          end
         end
-      end
 
-      it "should create the version with version from source" do
-        subject_with_description.resolve(zoo_software)
-        expect(subject_with_description.build_version).to eq("6.6.6")
+        it "fails" do
+          expect { subject_with_description.build_version }.to raise_error
+        end
       end
     end
 
-    describe "when not given a software as source" do
+    describe "when given an unknown source" do
       let(:description) do
         proc do
-          source(:version)
+          source(:park)
         end
       end
 
-      it "should fail" do
+      it "fails" do
         expect { subject_with_description.build_version }.to raise_error
       end
     end
   end
-
-  describe "when given an unknown source" do
-    let(:description) do
-      proc do
-        source(:park)
-      end
-    end
-
-    it "should fail" do
-      expect { subject_with_description.build_version }.to raise_error
-    end
-  end
 end