omnibus 3.2.2 → 4.0.0.beta.1

data/spec/unit/packagers/deb_spec.rb

@@ -0,0 +1,324 @@
+require 'spec_helper'
+
+module Omnibus
+  describe Packager::DEB do
+    let(:project) do
+      Project.new.tap do |project|
+        project.name('project')
+        project.homepage('https://example.com')
+        project.install_dir('/opt/project')
+        project.build_version('1.2.3')
+        project.build_iteration('2')
+        project.maintainer('Chef Software')
+      end
+    end
+
+    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" }
+
+    before do
+      Config.project_root(project_root)
+      Config.package_dir(package_dir)
+
+      allow(subject).to receive(:staging_dir).and_return(staging_dir)
+      create_directory(staging_dir)
+      create_directory("#{staging_dir}/DEBIAN")
+    end
+
+    describe '#vendor' do
+      it 'is a DSL method' do
+        expect(subject).to have_exposed_method(:vendor)
+      end
+
+      it 'has a default value' do
+        expect(subject.vendor).to eq('Omnibus <omnibus@getchef.com>')
+      end
+
+      it 'must be a string' do
+        expect { subject.vendor(Object.new) }.to raise_error(InvalidValue)
+      end
+    end
+
+    describe '#license' do
+      it 'is a DSL method' do
+        expect(subject).to have_exposed_method(:license)
+      end
+
+      it 'has a default value' do
+        expect(subject.license).to eq('unknown')
+      end
+
+      it 'must be a string' do
+        expect { subject.license(Object.new) }.to raise_error(InvalidValue)
+      end
+    end
+
+    describe '#priority' do
+      it 'is a DSL method' do
+        expect(subject).to have_exposed_method(:priority)
+      end
+
+      it 'has a default value' do
+        expect(subject.priority).to eq('extra')
+      end
+
+      it 'must be a string' do
+        expect { subject.priority(Object.new) }.to raise_error(InvalidValue)
+      end
+    end
+
+    describe '#section' do
+      it 'is a DSL method' do
+        expect(subject).to have_exposed_method(:section)
+      end
+
+      it 'has a default value' do
+        expect(subject.section).to eq('misc')
+      end
+
+      it 'must be a string' do
+        expect { subject.section(Object.new) }.to raise_error(InvalidValue)
+      end
+    end
+
+    describe '#id' do
+      it 'is :deb' do
+        expect(subject.id).to eq(:deb)
+      end
+    end
+
+    describe '#package_name' do
+      before do
+        allow(subject).to receive(:safe_architecture).and_return('amd64')
+      end
+
+      it 'includes the name, version, and build iteration' do
+        expect(subject.package_name).to eq('project_1.2.3-2_amd64.deb')
+      end
+    end
+
+    describe '#debian_dir' do
+      it 'is nested inside the staging_dir' do
+        expect(subject.debian_dir).to eq("#{staging_dir}/DEBIAN")
+      end
+    end
+
+    describe '#write_control_file' do
+      it 'generates the file' do
+        subject.write_control_file
+        expect("#{staging_dir}/DEBIAN/control").to be_a_file
+      end
+
+      it 'has the correct content' do
+        subject.write_control_file
+        contents = File.read("#{staging_dir}/DEBIAN/control")
+
+        expect(contents).to include("Package: project")
+        expect(contents).to include("Version: 1.2.3")
+        expect(contents).to include("License: unknown")
+        expect(contents).to include("Vendor: Omnibus <omnibus@getchef.com>")
+        expect(contents).to include("Architecture: amd64")
+        expect(contents).to include("Maintainer: Chef Software")
+        expect(contents).to include("Installed-Size: 0")
+        expect(contents).to include("Section: misc")
+        expect(contents).to include("Priority: extra")
+        expect(contents).to include("Homepage: https://example.com")
+        expect(contents).to include("Description: The full stack of project")
+      end
+    end
+
+    describe '#write_conffiles_file' do
+      before do
+        project.config_file('/opt/project/file1')
+        project.config_file('/opt/project/file2')
+      end
+
+      context 'when there are no files' do
+        before { project.config_files.clear }
+
+        it 'does not render the file' do
+          subject.write_conffiles_file
+          expect("#{staging_dir}/DEBIAN/conffiles").to_not be_a_file
+        end
+      end
+
+      it 'generates the file' do
+        subject.write_conffiles_file
+        expect("#{staging_dir}/DEBIAN/conffiles").to be_a_file
+      end
+
+      it 'has the correct content' do
+        subject.write_conffiles_file
+        contents = File.read("#{staging_dir}/DEBIAN/conffiles")
+
+        expect(contents).to include("/opt/project/file1")
+        expect(contents).to include("/opt/project/file2")
+      end
+    end
+
+    describe '#write_scripts' do
+      before do
+        create_file("#{project_root}/package-scripts/project/preinst") { "preinst" }
+        create_file("#{project_root}/package-scripts/project/postinst") { "postinst" }
+        create_file("#{project_root}/package-scripts/project/prerm") { "prerm" }
+        create_file("#{project_root}/package-scripts/project/postrm") { "postrm" }
+      end
+
+      it 'copies the scripts into the DEBIAN dir' do
+        subject.write_scripts
+
+        expect("#{staging_dir}/DEBIAN/preinst").to be_a_file
+        expect("#{staging_dir}/DEBIAN/postinst").to be_a_file
+        expect("#{staging_dir}/DEBIAN/prerm").to be_a_file
+        expect("#{staging_dir}/DEBIAN/postrm").to be_a_file
+      end
+
+      it 'logs a message' do
+        output = capture_logging do
+          subject.write_scripts
+        end
+
+        expect(output).to include("Adding script `preinst'")
+        expect(output).to include("Adding script `postinst'")
+        expect(output).to include("Adding script `prerm'")
+        expect(output).to include("Adding script `postrm'")
+      end
+    end
+
+    describe '#write_md5_sums' do
+      before do
+        create_file("#{staging_dir}/.filea") { ".filea" }
+        create_file("#{staging_dir}/file1") { "file1" }
+        create_file("#{staging_dir}/file2") { "file2" }
+      end
+
+      it 'generates the file' do
+        subject.write_md5_sums
+        expect("#{staging_dir}/DEBIAN/md5sums").to be_a_file
+      end
+
+      it 'has the correct content' do
+        subject.write_md5_sums
+        contents = File.read("#{staging_dir}/DEBIAN/md5sums")
+
+         expect(contents).to include("9334770d184092f998009806af702c8c .filea")
+         expect(contents).to include("826e8142e6baabe8af779f5f490cf5f5 file1")
+         expect(contents).to include("1c1c96fd2cf8330db0bfa936ce82f3b9 file2")
+      end
+    end
+
+    describe '#create_deb_file' do
+      before do
+        allow(subject).to receive(:shellout!)
+        allow(Dir).to receive(:chdir) { |_, &b| b.call }
+      end
+
+      it 'logs a message' do
+        output = capture_logging { subject.create_deb_file }
+        expect(output).to include('Creating .deb file')
+      end
+
+      it 'executes the command using `fakeroot`' do
+        expect(subject).to receive(:shellout!)
+          .with(/\Afakeroot/)
+        subject.create_deb_file
+      end
+
+      it 'uses the correct command' do
+        expect(subject).to receive(:shellout!)
+          .with(/dpkg-deb -z9 -Zgzip -D --build/)
+        subject.create_deb_file
+      end
+    end
+
+    describe '#package_size' do
+      before do
+        project.install_dir(staging_dir)
+
+        create_file("#{staging_dir}/file1") { "1"*10_000 }
+        create_file("#{staging_dir}/file2") { "2"*20_000 }
+      end
+
+      it 'stats all the files in the install_dir' do
+        expect(subject.package_size).to eq(29)
+      end
+    end
+
+    describe '#safe_project_name' do
+      context 'when the project name is "safe"' do
+        it 'returns the value without logging a message' do
+          expect(subject.safe_project_name).to eq('project')
+          expect(subject).to_not receive(:log)
+        end
+      end
+
+      context 'when the project name has invalid characters' do
+        before { project.name("Pro$ject123.for-realz_2") }
+
+        it 'returns the value while logging a message' do
+          output = capture_logging do
+            expect(subject.safe_project_name).to eq('Pro-ject123.for-realz-2')
+          end
+
+          expect(output).to include("The `name' compontent of Debian package names can only include")
+        end
+      end
+    end
+
+    describe '#safe_build_iteration' do
+      it 'returns the build iternation' do
+        expect(subject.safe_build_iteration).to eq(project.build_iteration)
+      end
+    end
+
+    describe '#safe_version' do
+      context 'when the project build_version is "safe"' do
+        it 'returns the value without logging a message' do
+          expect(subject.safe_version).to eq('1.2.3')
+          expect(subject).to_not receive(:log)
+        end
+      end
+
+      context 'when the project build_version has invalid characters' do
+        before { project.build_version("1.2$alpha.##__2") }
+
+        it 'returns the value while logging a message' do
+          output = capture_logging do
+            expect(subject.safe_version).to eq('1.2-alpha.-2')
+          end
+
+          expect(output).to include("The `version' compontent of Debian package names can only include")
+        end
+      end
+    end
+
+    describe '#safe_architecture' do
+      context 'when 64-bit' do
+        before do
+          stub_ohai(platform: 'ubuntu', version: '12.04') do |data|
+            data['kernel']['machine'] = 'x86_64'
+          end
+        end
+
+        it 'returns amd64' do
+          expect(subject.safe_architecture).to eq('amd64')
+        end
+      end
+
+      context 'when not 64-bit' do
+        before do
+          stub_ohai(platform: 'ubuntu', version: '12.04') do |data|
+            data['kernel']['machine'] = 'i386'
+          end
+        end
+
+        it 'returns the value' do
+          expect(subject.safe_architecture).to eq('i386')
+        end
+      end
+    end
+  end
+end

data/spec/unit/packagers/makeself_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+module Omnibus
+  describe Packager::Makeself do
+    let(:project) do
+      Project.new.tap do |project|
+        project.name('project')
+        project.homepage('https://example.com')
+        project.install_dir('/opt/project')
+        project.build_version('1.2.3')
+        project.build_iteration('2')
+        project.maintainer('Chef Software')
+      end
+    end
+
+    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" }
+
+    before do
+      Config.project_root(project_root)
+      Config.package_dir(package_dir)
+
+      allow(subject).to receive(:staging_dir).and_return(staging_dir)
+      create_directory(staging_dir)
+    end
+
+    describe '#id' do
+      it 'is :makeself' do
+        expect(subject.id).to eq(:makeself)
+      end
+    end
+
+    describe '#package_name' do
+      before do
+        allow(subject).to receive(:safe_architecture).and_return('x86_64')
+      end
+
+      it 'includes the name, version, and build iteration' do
+        expect(subject.package_name).to eq('project-1.2.3_2.x86_64.run')
+      end
+    end
+
+    describe '#write_post_extract_file' do
+      it 'generates the file' do
+        subject.write_post_extract_file
+        expect("#{staging_dir}/post_extract.sh").to be_a_file
+        expect("#{staging_dir}/post_extract.sh").to be_an_executable
+      end
+
+      it 'has the correct content' do
+        subject.write_post_extract_file
+        contents = File.read("#{staging_dir}/post_extract.sh")
+
+        expect(contents).to include("DEST_DIR=/opt/project")
+        expect(contents).to include("CONFIG_DIR=/etc/project")
+      end
+    end
+
+    describe '#create_makeself_package' do
+      before do
+        allow(subject).to receive(:shellout!)
+        allow(Dir).to receive(:chdir) { |_, &b| b.call }
+      end
+
+      it 'logs a message' do
+        output = capture_logging { subject.create_makeself_package }
+        expect(output).to include('Creating makeself package')
+      end
+
+      it 'uses the correct command' do
+        expect(subject).to receive(:shellout!)
+          .with(/makeself\.sh/)
+        subject.create_makeself_package
+      end
+    end
+  end
+end

data/spec/unit/packagers/msi_spec.rb

@@ -0,0 +1,267 @@
+require 'spec_helper'
+
+module Omnibus
+  describe Packager::MSI do
+    let(:project) do
+      Project.new.tap do |project|
+        project.name('project')
+        project.homepage('https://example.com')
+        project.install_dir('C:/project')
+        project.build_version('1.2.3')
+        project.build_iteration('2')
+        project.maintainer('Chef Software')
+      end
+    end
+
+    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" }
+
+    before do
+      Config.project_root(project_root)
+      Config.package_dir(package_dir)
+
+      allow(subject).to receive(:staging_dir).and_return(staging_dir)
+      create_directory(staging_dir)
+    end
+
+    describe 'DSL' do
+      it 'exposes :parameters' do
+        expect(subject).to have_exposed_method(:parameters)
+      end
+    end
+
+    describe '#id' do
+      it 'is :pkg' do
+        expect(subject.id).to eq(:msi)
+      end
+    end
+
+    describe '#upgrade_code' do
+      it 'is a DSL method' do
+        expect(subject).to have_exposed_method(:upgrade_code)
+      end
+
+      it 'is required' do
+        expect {
+          subject.upgrade_code
+        }.to raise_error(MissingRequiredAttribute)
+      end
+
+      it 'requires the value to be a String' do
+        expect {
+          subject.parameters(Object.new)
+        }.to raise_error(InvalidValue)
+      end
+
+      it 'returns the given value' do
+        code = 'ABCD-1234'
+        subject.upgrade_code(code)
+        expect(subject.upgrade_code).to be(code)
+      end
+    end
+
+    describe '#parameters' do
+      it 'is a DSL method' do
+        expect(subject).to have_exposed_method(:parameters)
+      end
+
+      it 'is defaults to an empty hash' do
+        expect(subject.parameters).to be_a(Hash)
+      end
+
+      it 'requires the value to be a Hash' do
+        expect {
+          subject.parameters(Object.new)
+        }.to raise_error(InvalidValue)
+      end
+
+      it 'returns the given value' do
+        params = { 'Key' => 'value' }
+        subject.parameters(params)
+        expect(subject.parameters).to be(params)
+      end
+    end
+
+    describe '#package_name' do
+      it 'includes the name, version, and build iteration' do
+        expect(subject.package_name).to eq('project-1.2.3-2.msi')
+      end
+    end
+
+    describe '#resources_dir' do
+      it 'is nested inside the staging_dir' do
+        expect(subject.resources_dir).to eq("#{staging_dir}/Resources")
+      end
+    end
+
+    describe '#write_localization_file' do
+      it 'generates the file' do
+        subject.write_localization_file
+        expect("#{staging_dir}/localization-en-us.wxl").to be_a_file
+      end
+
+      it 'has the correct content' do
+        subject.write_localization_file
+        contents = File.read("#{staging_dir}/localization-en-us.wxl")
+
+        expect(contents).to include('<String Id="ProductName">Project</String>')
+        expect(contents).to include('<String Id="ManufacturerName">Chef Software</String>')
+        expect(contents).to include('<String Id="FeatureMainName">Project</String>')
+      end
+    end
+
+    describe '#write_parameters_file' do
+      before do
+        subject.upgrade_code('ABCD-1234')
+      end
+
+      it 'generates the file' do
+        subject.write_parameters_file
+        expect("#{staging_dir}/parameters.wxi").to be_a_file
+      end
+
+      it 'has the correct content' do
+        subject.write_parameters_file
+        contents = File.read("#{staging_dir}/parameters.wxi")
+
+        expect(contents).to include('<?define VersionNumber="1.2.3.2" ?>')
+        expect(contents).to include('<?define DisplayVersionNumber="1.2.3" ?>')
+        expect(contents).to include('<?define UpgradeCode="ABCD-1234" ?>')
+      end
+    end
+
+    describe '#write_source_file' do
+      it 'generates the file' do
+        subject.write_source_file
+        expect("#{staging_dir}/source.wxs").to be_a_file
+      end
+
+      it 'has the correct content' do
+        project.install_dir('C:/foo/bar/blip')
+        subject.write_source_file
+        contents = File.read("#{staging_dir}/source.wxs")
+
+        expect(contents).to include('<?include "parameters.wxi" ?>')
+        expect(contents).to include <<-EOH.gsub(/^ {6}/, '')
+          <Directory Id="TARGETDIR" Name="SourceDir">
+            <Directory Id="WINDOWSVOLUME">
+              <Directory Id="FOOLOCATION" Name="foo">
+                <Directory Id="FOOBARLOCATION" Name="bar">
+                  <Directory Id="PROJECTLOCATION" Name="blip">
+                  </Directory>
+                </Directory>
+              </Directory>
+            </Directory>
+          </Directory>
+        EOH
+      end
+
+      it 'has the correct wix_install_dir when the path is short' do
+        subject.write_source_file
+        contents = File.read("#{staging_dir}/source.wxs")
+
+        expect(contents).to include('<?include "parameters.wxi" ?>')
+        expect(contents).to include('<Property Id="WIXUI_INSTALLDIR" Value="WINDOWSVOLUME" />')
+      end
+    end
+
+    describe '#msi_version' do
+      context 'when the project build_version semver' do
+        it 'returns the right value' do
+          expect(subject.msi_version).to eq('1.2.3.2')
+        end
+      end
+
+      context 'when the project build_version is git' do
+        before { project.build_version('1.2.3-alpha.1+20140501194641.git.94.561b564') }
+
+        it 'returns the right value' do
+          expect(subject.msi_version).to eq('1.2.3.2')
+        end
+      end
+    end
+
+    describe '#msi_display_version' do
+      context 'when the project build_version is "safe"' do
+        it 'returns the right value' do
+          expect(subject.msi_display_version).to eq('1.2.3')
+        end
+      end
+
+      context 'when the project build_version is a git tag' do
+        before { project.build_version('1.2.3-alpha.1+20140501194641.git.94.561b564') }
+
+        it 'returns the right value' do
+          expect(subject.msi_display_version).to eq('1.2.3')
+        end
+      end
+    end
+
+    describe '#wix_candle_extensions' do
+      it 'defaults to an empty Array' do
+        expect(subject.wix_candle_extensions).to be_an(Array)
+        expect(subject.wix_candle_extensions).to be_empty
+      end
+    end
+
+    describe '#wix_light_extensions' do
+      it 'defaults to an empty Array' do
+        expect(subject.wix_light_extensions).to be_an(Array)
+        expect(subject.wix_light_extensions).to be_empty
+      end
+    end
+
+    describe '#wix_candle_extension' do
+      it 'is a DSL method' do
+        expect(subject).to have_exposed_method(:wix_candle_extension)
+      end
+
+      it 'requires the value to be an String' do
+        expect {
+          subject.wix_candle_extension(Object.new)
+        }.to raise_error(InvalidValue)
+      end
+
+      it 'returns the given value' do
+        extensions = ['a']
+        subject.wix_candle_extension(extensions[0])
+        expect(subject.wix_candle_extensions).to match_array(extensions)
+      end
+    end
+
+    describe '#wix_light_extension' do
+      it 'is a DSL method' do
+        expect(subject).to have_exposed_method(:wix_light_extension)
+      end
+
+      it 'requires the value to be an String' do
+        expect {
+          subject.wix_light_extension(Object.new)
+        }.to raise_error(InvalidValue)
+      end
+
+      it 'returns the given value' do
+        extensions = ['a']
+        subject.wix_light_extension(extensions[0])
+        expect(subject.wix_light_extensions).to match_array(extensions)
+      end
+    end
+
+    describe '#wix_extension_switches' do
+      it 'returns an empty string for an empty array' do
+        expect(subject.wix_extension_switches([])).to eq('')
+      end
+
+      it 'returns the correct value for one extension' do
+        expect(subject.wix_extension_switches(['a'])).to eq("-ext 'a'")
+      end
+
+      it 'returns the correct value for many extensions' do
+        expect(subject.wix_extension_switches(['a', 'b'])).to eq("-ext 'a' -ext 'b'")
+      end
+    end
+  end
+end