omnibus 3.2.2 → 4.0.0.beta.1

data/spec/functional/fetchers/git_fetcher_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+module Omnibus
+  describe GitFetcher do
+    include_examples 'a software'
+
+    let(:remote)  { remote_git_repo('zlib') }
+    let(:version) { 'master' }
+
+    let(:source) do
+      { git: remote }
+    end
+
+    subject { described_class.new(software) }
+
+    describe '#fetch_required?' do
+      context 'when the repo is not cloned' do
+        it 'return true' do
+          expect(subject.fetch_required?).to be_truthy
+        end
+      end
+
+      context 'when the repo is cloned' do
+        before { subject.fetch }
+
+        context 'when the revisions are different' do
+          it 'return true' do
+            # Dirty the project_dir to differ the revisions
+            Dir.chdir(project_dir) do
+              FileUtils.touch("file-#{Time.now.to_i}")
+              git %|add .|
+              git %|commit -am "Add new file"|
+            end
+
+            expect(subject.fetch_required?).to be_truthy
+          end
+        end
+
+        context 'when the revisions are the same' do
+          it 'return false' do
+            expect(subject.fetch_required?).to be(false)
+          end
+        end
+      end
+    end
+
+    describe '#version_guid' do
+      it 'includes the current revision' do
+        expect(subject.version_guid).to match(/^git:[0-9a-f]{40}/)
+      end
+    end
+
+    describe '#clean' do
+      context 'when the project directory exists' do
+        before do
+          subject.fetch
+          create_file("#{project_dir}/file_a")
+          create_file("#{project_dir}/.file_b")
+        end
+
+        it 'cleans the git repo' do
+          subject.clean
+          expect("#{project_dir}/file_a").to_not be_a_file
+          expect("#{project_dir}/.file_b").to_not be_a_file
+        end
+
+        it 'returns true' do
+          expect(subject.clean).to be_truthy
+        end
+      end
+
+      context 'when the project directory does not exist' do
+        before do
+          remove_directory(project_dir)
+        end
+
+        it 'returns false' do
+          expect(subject.clean).to be(false)
+        end
+      end
+    end
+
+    describe '#fetch'  do
+      let(:revision) { shellout!('git rev-parse HEAD', cwd: project_dir).stdout.strip }
+
+      it 'clones the repository' do
+        subject.fetch
+        expect("#{project_dir}/.git").to be_a_directory
+      end
+
+      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')
+        end
+      end
+
+      context 'when the version is a branch' do
+        let(:version) { 'sethvargo/magic_ponies' }
+        let(:remote)  { remote_git_repo('zlib', branches: [version]) }
+
+        it 'parses the branch' do
+          subject.fetch
+          expect(revision).to eq('171a1aec35ac0a050f8dccd9c9ef4609b1d8d8ea')
+        end
+      end
+
+      context 'when the version is a ref' do
+        let(:version) { '45ded6d' }
+        let(:remote)  { remote_git_repo('zlib') }
+
+        it 'parses the ref' do
+          subject.fetch
+          expect(revision).to eq('45ded6d3b1a35d66ed866b2c3eb418426e6382b0')
+        end
+      end
+    end
+
+    describe '#version_for_cache' do
+      let(:revision) { shellout!('git rev-parse HEAD', cwd: project_dir).stdout.strip }
+
+      it 'includes the revision' do
+        expect(subject.version_for_cache).to eq("revision:#{revision}")
+      end
+    end
+  end
+end

data/spec/functional/fetchers/net_fetcher_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+module Omnibus
+  describe NetFetcher do
+    include_examples 'a software'
+
+    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') }
+
+    subject { described_class.new(software) }
+
+    describe '#fetch_required?' do
+      context 'when the file is not downloaded' do
+        it 'return true' do
+          expect(subject.fetch_required?).to be_truthy
+        end
+      end
+
+      context 'when the file is downloaded' do
+        before { subject.fetch }
+
+        context 'when the checksum is different' do
+          it 'return true' do
+            allow(subject).to receive(:checksum).and_return('abcd1234')
+            expect(subject.fetch_required?).to be_truthy
+          end
+        end
+
+        context 'when the checksum is the same' do
+          it 'return false' do
+            expect(subject.fetch_required?).to be(false)
+          end
+        end
+      end
+    end
+
+    describe '#version_guid' do
+      it 'includes the source md5' do
+        expect(subject.version_guid).to eq("md5:#{source_md5}")
+      end
+    end
+
+    describe '#clean' do
+      before { subject.fetch }
+
+      context 'when the project directory exists' do
+        before do
+          create_file("#{project_dir}/file_a")
+        end
+
+        it 'extracts the asset' do
+          subject.clean
+          expect(extracted).to_not be_a_file
+        end
+
+        it 'returns true' do
+          expect(subject.clean).to be_truthy
+        end
+      end
+
+      context 'when the project directory does not exist' do
+        before do
+          remove_directory(project_dir)
+        end
+
+        it 'returns false' do
+          expect(subject.clean).to be(false)
+        end
+      end
+    end
+
+    describe '#fetch' do
+      it 'downloads the file' do
+        subject.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 { subject.fetch }.to raise_error(ChecksumMismatch)
+        end
+      end
+
+      it 'extracts the file' do
+        subject.fetch
+        expect(extracted).to be_a_directory
+      end
+    end
+
+    describe '#version_for_cache' do
+      before do
+        create_file("#{project_dir}/file_a")
+        create_file("#{project_dir}/file_b")
+        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}")
+      end
+    end
+  end
+end

data/spec/functional/fetchers/path_fetcher_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+module Omnibus
+  describe PathFetcher do
+    include_examples 'a software'
+
+    let(:source_path) { File.join(tmp_path, 'remote', 'software') }
+
+    let(:source) do
+      { path: source_path }
+    end
+
+    before do
+      create_directory(source_path)
+    end
+
+    subject { described_class.new(software) }
+
+    describe '#fetch_required?' do
+      context 'when the directories have different files' do
+        before do
+          create_file("#{source_path}/directory/file") { 'different' }
+          create_file("#{project_dir}/directory/file") { 'same' }
+        end
+
+        it 'return true' do
+          expect(subject.fetch_required?).to be_truthy
+        end
+      end
+
+      context 'when the directories have the same files' do
+        before do
+          create_file("#{source_path}/directory/file") { 'same' }
+          create_file("#{project_dir}/directory/file") { 'same' }
+        end
+
+        it 'returns false' do
+          expect(subject.fetch_required?).to be(false)
+        end
+      end
+    end
+
+    describe '#version_guid' do
+      it 'includes the source path' do
+        expect(subject.version_guid).to eq("path:#{source_path}")
+      end
+    end
+
+    describe '#clean' do
+      context 'when the project directory exists' do
+        before do
+          create_file("#{source_path}/file_a")
+          create_file("#{source_path}/file_b")
+          create_file("#{source_path}/.file_c")
+
+          create_file("#{project_dir}/file_a")
+        end
+
+        it 'fetches new files' do
+          subject.clean
+
+          expect("#{project_dir}/file_a").to be_a_file
+          expect("#{project_dir}/file_b").to be_a_file
+          expect("#{project_dir}/.file_c").to be_a_file
+        end
+
+        it 'returns true' do
+          expect(subject.clean).to be_truthy
+        end
+      end
+
+      context 'when the project directory does not exist' do
+        before do
+          remove_directory(project_dir)
+        end
+
+        it 'returns false' do
+          expect(subject.clean).to be(false)
+        end
+      end
+    end
+
+    describe '#version_for_cache' do
+      before do
+        create_file("#{project_dir}/file_a")
+        create_file("#{project_dir}/file_b")
+        create_file("#{project_dir}/.file_c")
+      end
+
+      let(:sha) { '69553b23b84e69e095b4a231877b38022b1ffb41ae0ecbba6bb2625410c49f7e' }
+
+      it 'includes the source_path and shasum' do
+        expect(subject.version_for_cache).to eq("path:#{source_path}|shasum:#{sha}")
+      end
+    end
+  end
+end

data/spec/functional/file_syncer_spec.rb

@@ -0,0 +1,206 @@
+require 'spec_helper'
+
+module Omnibus
+  describe FileSyncer do
+    describe '#glob' do
+      before do
+        FileUtils.mkdir_p(File.join(tmp_path, 'folder'))
+        FileUtils.mkdir_p(File.join(tmp_path, '.hidden_folder'))
+
+        FileUtils.touch(File.join(tmp_path, 'folder', 'file'))
+        FileUtils.touch(File.join(tmp_path, '.hidden_file'))
+      end
+
+      let(:list) do
+        described_class
+          .glob("#{tmp_path}/**/*")
+          .map { |item| item.sub("#{tmp_path}/", '') }
+      end
+
+      it 'includes regular files' do
+        expect(list).to include('folder')
+        expect(list).to include('folder/file')
+      end
+
+      it 'ignores .' do
+        expect(list).to_not include('.')
+      end
+
+      it 'ignores ..' do
+        expect(list).to_not include('..')
+      end
+
+      it 'includes hidden files' do
+        expect(list).to include('.hidden_file')
+      end
+
+      it 'includes hidden folders' do
+        expect(list).to include('.hidden_folder')
+      end
+    end
+
+    describe '#sync' do
+      let(:source) do
+        source = File.join(tmp_path, 'source')
+        FileUtils.mkdir_p(source)
+
+        FileUtils.touch(File.join(source, 'file_a'))
+        FileUtils.touch(File.join(source, 'file_b'))
+        FileUtils.touch(File.join(source, 'file_c'))
+
+        FileUtils.mkdir_p(File.join(source, 'folder'))
+        FileUtils.touch(File.join(source, 'folder', 'file_d'))
+        FileUtils.touch(File.join(source, 'folder', 'file_e'))
+
+        FileUtils.mkdir_p(File.join(source, '.dot_folder'))
+        FileUtils.touch(File.join(source, '.dot_folder', 'file_f'))
+
+        FileUtils.touch(File.join(source, '.file_g'))
+        source
+      end
+
+      let(:destination) { File.join(tmp_path, 'destination') }
+
+      context 'when the destination is empty' do
+        it 'syncs the directories' do
+          described_class.sync(source, destination)
+
+          expect("#{destination}/file_a").to be_a_file
+          expect("#{destination}/file_b").to be_a_file
+          expect("#{destination}/file_c").to be_a_file
+          expect("#{destination}/folder/file_d").to be_a_file
+          expect("#{destination}/folder/file_e").to be_a_file
+          expect("#{destination}/.dot_folder/file_f").to be_a_file
+          expect("#{destination}/.file_g").to be_a_file
+        end
+      end
+
+      context 'when the directory exists' do
+        before { FileUtils.mkdir_p(destination) }
+
+        it 'deletes existing files and folders' do
+          FileUtils.mkdir_p("#{destination}/existing_folder")
+          FileUtils.mkdir_p("#{destination}/.existing_folder")
+          FileUtils.touch("#{destination}/existing_file")
+          FileUtils.touch("#{destination}/.existing_file")
+
+          described_class.sync(source, destination)
+
+          expect("#{destination}/file_a").to be_a_file
+          expect("#{destination}/file_b").to be_a_file
+          expect("#{destination}/file_c").to be_a_file
+          expect("#{destination}/folder/file_d").to be_a_file
+          expect("#{destination}/folder/file_e").to be_a_file
+          expect("#{destination}/.dot_folder/file_f").to be_a_file
+          expect("#{destination}/.file_g").to be_a_file
+
+          expect("#{destination}/existing_folder").to_not be_a_directory
+          expect("#{destination}/.existing_folder").to_not be_a_directory
+          expect("#{destination}/existing_file").to_not be_a_file
+          expect("#{destination}/.existing_file").to_not be_a_file
+        end
+      end
+
+      context 'with deeply nested paths and symlinks' do
+        let(:source) do
+          source = File.join(tmp_path, 'source')
+          FileUtils.mkdir_p(source)
+
+          create_directory(source, 'bin')
+               create_file(source, 'bin', 'apt')
+               create_file(source, 'bin', 'yum')
+
+          create_file(source, 'LICENSE') { 'MIT' }
+
+          create_directory(source, 'include')
+          create_directory(source, 'include', 'linux')
+               create_file(source, 'include', 'linux', 'init.ini')
+
+          create_directory(source, 'source')
+          create_directory(source, 'source', 'bin')
+               create_file(source, 'source', 'bin', 'apt')
+               create_file(source, 'source', 'bin', 'yum')
+               create_file(source, 'source', 'LICENSE') { 'Apache 2.0' }
+
+          create_directory(source, 'empty_directory')
+
+          create_directory(source, 'links')
+                 create_file(source, 'links', 'home.html')
+                 FileUtils.ln_s("./home.html", "#{source}/links/index.html")
+                 FileUtils.ln_s("./home.html", "#{source}/links/default.html")
+                 FileUtils.ln_s("../source/bin/apt", "#{source}/links/apt")
+
+          FileUtils.ln_s('/foo/bar', "#{source}/root")
+
+          source
+        end
+
+        it 'copies relative and absolute symlinks' do
+          described_class.sync(source, destination)
+
+          expect("#{destination}/bin").to be_a_directory
+          expect("#{destination}/bin/apt").to be_a_file
+          expect("#{destination}/bin/yum").to be_a_file
+
+          expect("#{destination}/LICENSE").to be_a_file
+
+          expect("#{destination}/include").to be_a_directory
+          expect("#{destination}/include/linux").to be_a_directory
+          expect("#{destination}/include/linux/init.ini").to be_a_file
+
+          expect("#{destination}/source").to be_a_directory
+          expect("#{destination}/source/bin").to be_a_directory
+          expect("#{destination}/source/bin/apt").to be_a_file
+          expect("#{destination}/source/bin/yum").to be_a_file
+          expect("#{destination}/source/LICENSE").to be_a_file
+
+          expect("#{destination}/empty_directory").to be_a_directory
+
+          expect("#{destination}/links").to be_a_directory
+          expect("#{destination}/links/home.html").to be_a_file
+          expect("#{destination}/links/index.html").to be_a_symlink_to("./home.html")
+          expect("#{destination}/links/default.html").to be_a_symlink_to("./home.html")
+          expect("#{destination}/links/apt").to be_a_symlink_to("../source/bin/apt")
+
+          expect("#{destination}/root").to be_a_symlink_to('/foo/bar')
+        end
+      end
+
+      context 'when :exclude is given' do
+        it 'does not copy files and folders that match the pattern' do
+          described_class.sync(source, destination, exclude: '.dot_folder')
+
+          expect("#{destination}/file_a").to be_a_file
+          expect("#{destination}/file_b").to be_a_file
+          expect("#{destination}/file_c").to be_a_file
+          expect("#{destination}/folder/file_d").to be_a_file
+          expect("#{destination}/folder/file_e").to be_a_file
+          expect("#{destination}/.dot_folder").to_not be_a_directory
+          expect("#{destination}/.dot_folder/file_f").to_not be_a_file
+          expect("#{destination}/.file_g").to be_a_file
+        end
+
+        it 'removes existing files and folders in destination' do
+          FileUtils.mkdir_p("#{destination}/existing_folder")
+          FileUtils.touch("#{destination}/existing_file")
+          FileUtils.mkdir_p("#{destination}/.dot_folder")
+          FileUtils.touch("#{destination}/.dot_folder/file_f")
+
+          described_class.sync(source, destination, exclude: '.dot_folder')
+
+          expect("#{destination}/file_a").to be_a_file
+          expect("#{destination}/file_b").to be_a_file
+          expect("#{destination}/file_c").to be_a_file
+          expect("#{destination}/folder/file_d").to be_a_file
+          expect("#{destination}/folder/file_e").to be_a_file
+          expect("#{destination}/.dot_folder").to_not be_a_directory
+          expect("#{destination}/.dot_folder/file_f").to_not be_a_file
+          expect("#{destination}/.file_g").to be_a_file
+
+          expect("#{destination}/existing_folder").to_not be_a_directory
+          expect("#{destination}/existing_file").to_not be_a_file
+        end
+      end
+    end
+  end
+end