omnibus 4.0.0 → 4.1.0

data/spec/unit/build_version_spec.rb

@@ -9,6 +9,7 @@ module Omnibus
     subject(:build_version) { described_class.new }
 
     before do
+      Config.append_timestamp(true)
       allow_any_instance_of(described_class).to receive(:shellout)
         .and_return(double('ouput', stdout: git_describe, exitstatus: 0))
     end
@@ -88,6 +89,16 @@ module Omnibus
         its(:commits_since_tag) { should == 0 }
         its(:prerelease_version?) { should be_truthy }
       end
+
+      # v-prefixed tag
+      context "v1.2.3-beta2" do
+        let(:git_describe) { "v1.2.3-beta2" }
+        its(:version_tag) { should == "1.2.3" }
+        its(:prerelease_tag) { should == "beta2" }
+        its(:git_sha_tag) { should be(nil) }
+        its(:commits_since_tag) { should eq(0) }
+        its(:prerelease_version?) { should be(true) }
+      end
     end
 
     describe 'semver output' do
@@ -129,7 +140,6 @@ module Omnibus
 
       describe 'appending a timestamp' do
         let(:git_describe) { '11.0.0-alpha-3-207-g694b062' }
-
         context 'by default' do
           it 'appends a timestamp' do
             expect(build_version.semver).to match(/11.0.0-alpha.3\+#{today_string}[0-9]+.git.207.694b062/)
@@ -137,8 +147,6 @@ module Omnibus
         end
 
         context 'when Config.append_timestamp is true' do
-          before { Config.append_timestamp(true) }
-
           it 'appends a timestamp' do
             expect(build_version.semver).to match(/11.0.0-alpha.3\+#{today_string}[0-9]+.git.207.694b062/)
           end
@@ -146,7 +154,6 @@ module Omnibus
 
         context 'when Config.append_timestamp is false' do
           before { Config.append_timestamp(false) }
-
           it 'does not append a timestamp' do
             expect(build_version.semver).to match(/11.0.0-alpha.3\+git.207.694b062/)
           end

data/spec/unit/builder_spec.rb

@@ -180,5 +180,38 @@ module Omnibus
         subject.make(timeout: 3600)
       end
     end
+
+    describe "#shasum" do
+      let(:build_step) do
+        Proc.new {
+          block do
+            command("true")
+          end
+        }
+      end
+
+      let(:tmp_dir) { Dir.mktmpdir }
+      after { FileUtils.rmdir(tmp_dir) }
+
+      let(:software) do
+        double(Software,
+               name: 'chefdk',
+               install_dir: tmp_dir,
+               project_dir: tmp_dir,
+               overridden?: false)
+      end
+
+      let(:before_build_shasum) do
+        b = described_class.new(software)
+        b.evaluate(&build_step)
+        b.shasum
+      end
+
+      it "returns the same value when called before or after the build" do
+        subject.evaluate(&build_step)
+        subject.build
+        expect(subject.shasum).to eq(before_build_shasum)
+      end
+    end
   end
 end

data/spec/unit/changelog_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+module Omnibus
+  describe ChangeLog do
+    describe "#new" do
+      it "sets the start_ref to the latest tag if none is set" do
+        repo = double(GitRepository, :latest_tag => "1.0")
+        expect(ChangeLog.new(nil, "2.0", repo).start_ref).to eq("1.0")
+      end
+
+      it "sets the end_ref to HEAD if none is set" do
+        expect(ChangeLog.new.end_ref).to eq("HEAD")
+      end
+    end
+
+    describe "#changelog_entries" do
+      it "returns any git log lines with the ChangeLog: tag, removing the tag" do
+        repo = double(GitRepository, :commit_messages => ["ChangeLog-Entry: foobar\n",
+                                                          "ChangeLog-Entry: wombat\n"])
+        changelog = ChangeLog.new("0.0.1", "0.0.2", repo)
+        expect(changelog.changelog_entries).to eq(["foobar\n", "wombat\n"])
+      end
+
+      it "returns an empty array if there were no changelog entries" do
+        repo = double(GitRepository, :commit_messages => [])
+        changelog = ChangeLog.new("0.0.1", "0.0.2", repo)
+        expect(changelog.changelog_entries).to eq([])
+      end
+
+      it "does not return git messages without a ChangeLog: tag" do
+        repo = double(GitRepository, :commit_messages => ["foobar\n", "wombat\n"])
+        changelog = ChangeLog.new("0.0.1", "0.0.2", repo)
+        expect(changelog.changelog_entries).to eq([])
+      end
+
+      it "does not return blank lines" do
+        repo = double(GitRepository, :commit_messages => ["\n", "\n"])
+        changelog = ChangeLog.new("0.0.1", "0.0.2", repo)
+        expect(changelog.changelog_entries).to eq([])
+      end
+
+      it "can handle multi-line ChangeLog entries" do
+        repo = double(GitRepository, :commit_messages => ["ChangeLog-Entry: foobar\n", "foobaz\n"])
+        changelog = ChangeLog.new("0.0.1", "0.0.2", repo)
+        expect(changelog.changelog_entries).to eq(["foobar\nfoobaz\n"])
+      end
+
+      it "end a ChangeLog entry at the first blank line" do
+        repo = double(GitRepository, :commit_messages => ["ChangeLog-Entry: foobar\n", "\n", "foobaz\n"])
+        changelog = ChangeLog.new("0.0.1", "0.0.2", repo)
+        expect(changelog.changelog_entries).to eq(["foobar\n"])
+      end
+    end
+  end
+end

data/spec/unit/cleanroom_spec.rb

@@ -43,7 +43,7 @@ module Omnibus
         EOH
       end
 
-      let(:filepath) { '/file/path' }
+      let(:filepath) { File.join(tmp_path, '/file/path') }
 
       before do
         allow(IO).to receive(:read).and_call_original

data/spec/unit/compressors/dmg_spec.rb

@@ -15,9 +15,9 @@ module Omnibus
 
     subject { described_class.new(project) }
 
-    let(:project_root) { "#{tmp_path}/project/root" }
-    let(:package_dir)  { "#{tmp_path}/package/dir" }
-    let(:staging_dir)  { "#{tmp_path}/staging/dir" }
+    let(:project_root) { File.join(tmp_path, 'project/root') }
+    let(:package_dir)  { File.join(tmp_path, 'package/dir') }
+    let(:staging_dir)  { File.join(tmp_path, 'staging/dir') }
 
     before do
       allow(project).to receive(:packager)

data/spec/unit/compressors/tgz_spec.rb

@@ -15,9 +15,9 @@ module Omnibus
 
     subject { described_class.new(project) }
 
-    let(:project_root) { "#{tmp_path}/project/root" }
-    let(:package_dir)  { "#{tmp_path}/package/dir" }
-    let(:staging_dir)  { "#{tmp_path}/staging/dir" }
+    let(:project_root) { File.join(tmp_path, 'project/root') }
+    let(:package_dir)  { File.join(tmp_path, 'package/dir') }
+    let(:staging_dir)  { File.join(tmp_path, 'staging/dir') }
 
     before do
       create_directory(project_root)

data/spec/unit/config_spec.rb

@@ -9,6 +9,7 @@ module Omnibus
     end
 
     before do
+      Config.reset!
       # Don't expand paths on the build system. Otherwise, you will end up with
       # paths like +\\Users\\you\\Development\\omnibus-ruby\\C:/omnibus-ruby+
       # when testing on "other" operating systems
@@ -37,11 +38,12 @@ module Omnibus
     include_examples 'a configurable', :project_root, Dir.pwd
     include_examples 'a configurable', :local_software_dirs, []
     include_examples 'a configurable', :software_gems, ['omnibus-software']
-    include_examples 'a configurable', :solaris_compiler, nil
+    include_examples 'a configurable', :solaris_linker_mapfile, 'files/mapfiles/solaris'
     include_examples 'a configurable', :append_timestamp, true
     include_examples 'a configurable', :build_retries, 0
     include_examples 'a configurable', :use_git_caching, true
     include_examples 'a configurable', :fetcher_read_timeout, 60
+    include_examples 'a configurable', :fetcher_retries, 5
 
     describe '#workers' do
       context 'when the Ohai data is not present' do

data/spec/unit/fetcher_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'omnibus/manifest_entry'
+
+module Omnibus
+  describe Fetcher do
+    let(:source_path) { '/local/path' }
+    let(:project_dir) { '/project/dir' }
+    let(:build_dir) { '/build/dir' }
+
+    let(:manifest_entry) do
+      double(Software,
+        name: 'software',
+        locked_version: '31aedfs',
+        described_version: 'mrfancypants',
+        locked_source: { path: source_path })
+    end
+
+    subject { described_class.new(manifest_entry, project_dir, build_dir) }
+
+
+    describe "#initialize" do
+      it "sets the resovled_version to the locked_version" do
+        expect(subject.resolved_version).to eq("31aedfs")
+      end
+
+      it "sets the source to the locked_source" do
+        expect(subject.source).to eq({ path: source_path})
+      end
+
+      it 'sets the described_version to the described version' do
+        expect(subject.described_version).to eq('mrfancypants')
+      end
+    end
+  end
+end

data/spec/unit/fetchers/git_fetcher_spec.rb

@@ -4,18 +4,20 @@ module Omnibus
   describe GitFetcher do
     let(:source_path) { '/local/path' }
     let(:project_dir) { '/project/dir' }
+    let(:build_dir) { '/build/dir' }
 
-    let(:software) do
-      double(Software,
+    let(:manifest_entry) do
+      double(ManifestEntry,
         name: 'software',
-        source: { path: source_path },
-        project_dir: project_dir,
-      )
+        locked_version: '123abcd1234',
+        described_version: 'some-git-ref',
+        locked_source: { path: source_path })
     end
 
-    subject { described_class.new(software) }
+    subject { described_class.new(manifest_entry, project_dir, build_dir) }
 
     describe '#fetch_required?' do
+
       context 'when the repository is not cloned' do
         before { allow(subject).to receive(:cloned?).and_return(false) }
 
@@ -26,7 +28,7 @@ module Omnibus
 
       context 'when the repository is cloned' do
         before { allow(subject).to receive(:cloned?).and_return(true) }
-
+        before { allow(subject).to receive(:resolved_version).and_return('12341235')}
         context 'when the revision is difference' do
           before { allow(subject).to receive(:same_revision?).and_return(false) }
 
@@ -65,7 +67,7 @@ module Omnibus
           allow(subject).to receive(:cloned?).and_return(true)
         end
 
-        it 'gleans the directory' do
+        it 'cleans the directory' do
           expect(subject).to receive(:git).with('clean -fdx')
           subject.clean
         end
@@ -94,9 +96,6 @@ module Omnibus
     describe '#fetch' do
       before do
         allow(subject).to receive(:create_required_directories)
-        allow(subject).to receive(:git_fetch)
-        allow(subject).to receive(:git_clone)
-        allow(subject).to receive(:git_checkout)
       end
 
       context 'when the repository is cloned' do
@@ -105,7 +104,7 @@ module Omnibus
         context 'when the revision is different' do
           before { allow(subject).to receive(:same_revision?).and_return(false) }
 
-          it 'fetches and resets' do
+          it 'fetches and resets to the resolved_version' do
             expect(subject).to receive(:git_fetch)
             subject.fetch
           end
@@ -122,9 +121,24 @@ module Omnibus
       end
 
       context 'when the repository is not cloned' do
-        before { allow(subject).to receive(:cloned?).and_return(false) }
+        before do
+          allow(subject).to receive(:cloned?).and_return(false)
+          allow(subject).to receive(:dir_empty?).and_return(true)
+          allow(subject).to receive(:git_clone)
+          allow(subject).to receive(:git_checkout)
+        end
+
+        context 'but a directory does exist' do
+          before { expect(subject).to receive(:dir_empty?).with(project_dir).and_return(false)}
+
+          it 'forcefully removes and recreateds the directory' do
+            expect(FileUtils).to receive(:rm_rf).with(project_dir).and_return(project_dir)
+            expect(Dir).to receive(:mkdir).with(project_dir).and_return(0)
+            subject.fetch
+          end
+        end
 
-        it 'clones the repository' do
+        it 'clones the repository and checks out the correct revision' do
           expect(subject).to receive(:git_clone).once
           subject.fetch
         end

data/spec/unit/fetchers/net_fetcher_spec.rb

@@ -3,16 +3,17 @@ require 'spec_helper'
 module Omnibus
   describe NetFetcher do
     let(:project_dir) { '/tmp/project' }
+    let(:build_dir) { '/tmp/build' }
+    let(:source) do
+      { url: 'https://get.example.com/file.tar.gz', md5: 'abcd1234' }
+    end
 
-    let(:software) do
-      double(Software,
-        downloaded_file: 'file.tar.gz',
-        name: 'file',
-        source: { url: 'https://get.example.com/file.tar.gz', md5: 'abcd1234' },
-        checksum: 'abc123',
-        source_uri: 'http://example.com/file.tar.gz',
-        project_dir: project_dir,
-      )
+    let(:manifest_entry) do
+      double(Omnibus::ManifestEntry,
+             name: 'file',
+             locked_version: "1.2.3",
+             described_version: '1.2.3',
+             locked_source: source)
     end
 
     let(:cache_dir) { '/cache' }
@@ -21,7 +22,7 @@ module Omnibus
       Config.cache_dir(cache_dir)
     end
 
-    subject { described_class.new(software) }
+    subject { described_class.new(manifest_entry, project_dir, build_dir) }
 
     describe '#fetch_required?' do
       context 'when file is not downloaded' do
@@ -60,8 +61,40 @@ module Omnibus
     end
 
     describe '#version_guid' do
-      it 'returns the shasum' do
-        expect(subject.version_guid).to eq('md5:abcd1234')
+      context 'source with md5' do
+        it 'returns the shasum' do
+          expect(subject.version_guid).to eq('md5:abcd1234')
+        end
+      end
+
+      context 'source with sha1' do
+        let(:source) do
+          { url: 'https://get.example.com/file.tar.gz', sha1: 'abcd1234' }
+        end
+
+        it 'returns the shasum' do
+          expect(subject.version_guid).to eq('sha1:abcd1234')
+        end
+      end
+
+      context 'source with sha256' do
+        let(:source) do
+          { url: 'https://get.example.com/file.tar.gz', sha256: 'abcd1234' }
+        end
+
+        it 'returns the shasum' do
+          expect(subject.version_guid).to eq('sha256:abcd1234')
+        end
+      end
+
+      context 'source with sha512' do
+        let(:source) do
+          { url: 'https://get.example.com/file.tar.gz', sha512: 'abcd1234' }
+        end
+
+        it 'returns the shasum' do
+          expect(subject.version_guid).to eq('sha512:abcd1234')
+        end
       end
     end
 
@@ -104,24 +137,127 @@ module Omnibus
     end
 
     describe '#version_for_cache' do
+      context 'source with md5' do
+        it 'returns the download URL and md5' do
+          expect(subject.version_for_cache).to eq('download_url:https://get.example.com/file.tar.gz|md5:abcd1234')
+        end
+      end
+
+      context 'source with sha1' do
+        let(:source) do
+          { url: 'https://get.example.com/file.tar.gz', sha1: 'abcd1234' }
+        end
+
+        it 'returns the download URL and sha1' do
+          expect(subject.version_for_cache).to eq('download_url:https://get.example.com/file.tar.gz|sha1:abcd1234')
+        end
+      end
+
+      context 'source with sha256' do
+        let(:source) do
+          { url: 'https://get.example.com/file.tar.gz', sha256: 'abcd1234' }
+        end
+
+        it 'returns the download URL and sha256' do
+          expect(subject.version_for_cache).to eq('download_url:https://get.example.com/file.tar.gz|sha256:abcd1234')
+        end
+      end
+
+      context 'source with sha512' do
+        let(:source) do
+          { url: 'https://get.example.com/file.tar.gz', sha512: 'abcd1234' }
+        end
+
+        it 'returns the download URL and sha1' do
+          expect(subject.version_for_cache).to eq('download_url:https://get.example.com/file.tar.gz|sha512:abcd1234')
+        end
+      end
+    end
+
+    describe "downloading the file" do
+
+      let(:expected_open_opts) do
+        {
+          "Accept-Encoding" => "identity",
+          :read_timeout => 60,
+          :content_length_proc => an_instance_of(Proc),
+          :progress_proc => an_instance_of(Proc)
+        }
+      end
+
+      let(:tempfile_path) { "/tmp/intermediate_path/tempfile_path.random_garbage.tmp" }
+
+      let(:fetched_file) { instance_double("File", path: tempfile_path) }
+
+      let(:destination_path) { "/cache/file.tar.gz" }
+
+      let(:progress_bar_output) { StringIO.new }
+
+      let(:reported_content_length) { 100 }
+
+      let(:cumulative_downloaded_length) { 100 }
+
+      def capturing_stdout
+        old_stdout, $stdout = $stdout, progress_bar_output
+        yield
+      ensure
+        $stdout = old_stdout
+      end
+
+
       before do
-        allow(software).to receive(:source).and_return({
-          url: 'https://url',
-          md5: 'abcd1234',
-        })
+        expect(subject).to receive(:open).with(source[:url], expected_open_opts) do |_url, open_uri_opts|
+          open_uri_opts[:content_length_proc].call(reported_content_length)
+          open_uri_opts[:progress_proc].call(cumulative_downloaded_length)
+
+          fetched_file
+        end
+        expect(FileUtils).to receive(:cp).with(tempfile_path, destination_path)
+        expect(fetched_file).to receive(:close)
       end
 
-      it 'returns the download URL and md5' do
-        expect(subject.version_for_cache).to eq('download_url:https://url|md5:abcd1234')
+      it "downloads the thing" do
+        capturing_stdout do
+          expect { subject.send(:download) }.to_not raise_error
+        end
+      end
+
+      # In Ci we somewhat frequently see:
+      #   ProgressBar::InvalidProgressError: You can't set the item's current value to be greater than the total.
+      #
+      # My hunch is that this is caused by some floating point shenanigans
+      # where we sum a bunch of floating point numbers and they add up to some
+      # small fraction greater than the actual total. Since we're gonna verify
+      # the checksum of what we downloaded later, we don't want to hear about
+      # this error.
+      context "when cumulative downloaded amount exceeds reported content length" do
+
+        let(:reported_content_length) { 100 }
+
+        let(:cumulative_downloaded_length) { 100.1 }
+
+        it "downloads the thing" do
+          capturing_stdout do
+            expect { subject.send(:download) }.to_not raise_error
+          end
+        end
+
       end
+
     end
 
     shared_examples 'an extractor' do |extension, command|
       context "when the file is a .#{extension}" do
-        before do
-          software.source[:url] = "https://example.com/file.#{extension}"
+        let(:manifest_entry) do
+          double(Omnibus::ManifestEntry,
+                 name: 'file',
+                 locked_version: "1.2.3",
+                 described_version: '1.2.3',
+                 locked_source: { url: "https://get.example.com/file.#{extension}", md5: 'abcd1234' })
         end
 
+        subject { described_class.new(manifest_entry, project_dir, build_dir) }
+
         it 'is the right command' do
           expect(subject.send(:extract_command)).to eq(command)
         end
@@ -134,29 +270,47 @@ module Omnibus
       end
 
       context 'when the downloaded file is a folder' do
+        let(:manifest_entry) do
+          double(Omnibus::ManifestEntry,
+                 name: 'file',
+                 locked_version: "1.2.3",
+                 described_version: '1.2.3',
+                 locked_source: { url: "https://get.example.com/folder", md5: 'abcd1234' })
+        end
+
+        subject { described_class.new(manifest_entry, project_dir, build_dir) }
+
         before do
           allow(FileUtils).to receive(:cp_r)
           allow(File).to receive(:directory?).and_return(true)
-          allow(subject).to receive(:extract_command)
-          software.source[:url] = 'https://example.com/folder'
         end
 
         it 'copies the entire directory to project_dir' do
+          allow(subject).to receive(:extract_command)
           expect(FileUtils).to receive(:cp_r).with("#{cache_dir}/folder", project_dir)
           subject.extract
         end
       end
 
       context 'when the downloaded file is a regular file' do
+        let(:manifest_entry) do
+          double(Omnibus::ManifestEntry,
+                 name: 'file',
+                 locked_version: "1.2.3",
+                 described_version: '1.2.3',
+                 locked_source: { url: "https://get.example.com/file", md5: 'abcd1234' })
+        end
+
+        subject { described_class.new(manifest_entry, project_dir, build_dir) }
+
         before do
           allow(FileUtils).to receive(:mkdir_p)
           allow(FileUtils).to receive(:cp)
           allow(File).to receive(:directory?).and_return(false)
-          allow(subject).to receive(:extract_command)
-          software.source[:url] = 'https://example.com/file'
         end
 
         it 'copies the file into the project_dir' do
+          allow(subject).to receive(:extract_command)
           expect(FileUtils).to receive(:cp).with("#{cache_dir}/file", "#{project_dir}/")
           subject.extract
         end