omnibus 3.2.2 → 4.0.0.beta.1

data/spec/unit/packagers/pkg_spec.rb

@@ -0,0 +1,219 @@
+require 'spec_helper'
+
+module Omnibus
+  describe Packager::PKG 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
+      subject.identifier('com.getchef.project')
+
+      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 :identifier' do
+        expect(subject).to have_exposed_method(:identifier)
+      end
+
+      it 'exposes :signing_identity' do
+        expect(subject).to have_exposed_method(:signing_identity)
+      end
+    end
+
+    describe '#id' do
+      it 'is :pkg' do
+        expect(subject.id).to eq(:pkg)
+      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.pkg')
+      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 '#build_component_pkg' do
+      it 'executes the pkgbuild command' do
+        expect(subject).to receive(:shellout!).with <<-EOH.gsub(/^ {10}/, '')
+          pkgbuild \\
+            --identifier "com.getchef.project" \\
+            --version "1.2.3" \\
+            --scripts "#{project_root}/package-scripts/project" \\
+            --root "/opt/project" \\
+            --install-location "/opt/project" \\
+            "project-core.pkg"
+        EOH
+
+        subject.build_component_pkg
+      end
+    end
+
+    describe '#write_distribution_file' do
+      it 'generates the file' do
+        subject.write_distribution_file
+        expect("#{staging_dir}/Distribution").to be_a_file
+      end
+
+      it 'has the correct content' do
+        subject.write_distribution_file
+        contents = File.read("#{staging_dir}/Distribution")
+
+        expect(contents).to include('<pkg-ref id="com.getchef.project"/>')
+        expect(contents).to include('<line choice="com.getchef.project"/>')
+        expect(contents).to include('project-core.pkg')
+      end
+    end
+
+    describe '#build_product_pkg' do
+      context 'when pkg signing is disabled' do
+        it 'generates the distribution and runs productbuild' do
+          expect(subject).to receive(:shellout!).with <<-EOH.gsub(/^ {12}/, '')
+            productbuild \\
+              --distribution "#{staging_dir}/Distribution" \\
+              --resources "#{staging_dir}/Resources" \\
+              "#{package_dir}/project-1.2.3-2.pkg"
+          EOH
+
+          subject.build_product_pkg
+        end
+      end
+
+      context 'when pkg signing is enabled' do
+        before do
+          subject.signing_identity('My Special Identity')
+        end
+
+        it 'includes the signing parameters in the product build command' do
+          expect(subject).to receive(:shellout!).with  <<-EOH.gsub(/^ {12}/, '')
+            productbuild \\
+              --distribution "#{staging_dir}/Distribution" \\
+              --resources "#{staging_dir}/Resources" \\
+              --sign "My Special Identity" \\
+              "#{package_dir}/project-1.2.3-2.pkg"
+            EOH
+          subject.build_product_pkg
+        end
+      end
+
+      context "when the identifier isn't specified by the project" do
+        before do
+          subject.identifier(nil)
+          project.name('$Project#')
+        end
+
+        it 'uses com.example.PROJECT_NAME as the identifier' do
+          expect(subject.safe_identifier).to eq('test.chefsoftware.pkg.project')
+        end
+      end
+    end
+
+    describe '#component_pkg' do
+      it 'returns the project name with -core.pkg' do
+        expect(subject.component_pkg).to eq('project-core.pkg')
+      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("$Project123.for-realz_2") }
+
+        it 'returns the value while logging a message' do
+          output = capture_logging do
+            expect(subject.safe_project_name).to eq('project123forrealz2')
+          end
+
+          expect(output).to include("The `name' compontent of Mac package names can only include")
+        end
+      end
+    end
+
+    describe '#safe_identifier' do
+      context 'when Project#identifier is given' do
+        before { subject.identifier('com.apple.project') }
+
+        it 'is used' do
+          expect(subject.safe_identifier).to eq('com.apple.project')
+        end
+      end
+
+      context 'when no value in project is given' do
+        before { subject.identifier(nil) }
+
+        it 'is interpreted' do
+          expect(subject.safe_identifier).to eq('test.chefsoftware.pkg.project')
+        end
+      end
+
+      context 'when interpolated values are "unsafe"' do
+        before do
+          project.name("$Project123.for-realz_2")
+          project.maintainer("This is SPARTA!")
+          subject.identifier(nil)
+        end
+
+        it 'uses the "safe" values' do
+          expect(subject.safe_identifier).to eq('test.thisissparta.pkg.project123forrealz2')
+        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 Mac package names can only include")
+        end
+      end
+    end
+  end
+end

data/spec/unit/packagers/rpm_spec.rb

@@ -0,0 +1,328 @@
+require 'spec_helper'
+
+module Omnibus
+  describe Packager::RPM 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}/BUILD")
+      create_directory("#{staging_dir}/RPMS")
+      create_directory("#{staging_dir}/SRPMS")
+      create_directory("#{staging_dir}/SOURCES")
+      create_directory("#{staging_dir}/SPECS")
+    end
+
+    describe '#signing_passphrase' do
+      it 'is a DSL method' do
+        expect(subject).to have_exposed_method(:signing_passphrase)
+      end
+
+      it 'has a no default value' do
+        expect(subject.signing_passphrase).to be(nil)
+      end
+    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 '#category' do
+      it 'is a DSL method' do
+        expect(subject).to have_exposed_method(:category)
+      end
+
+      it 'has a default value' do
+        expect(subject.category).to eq('default')
+      end
+
+      it 'must be a string' do
+        expect { subject.category(Object.new) }.to raise_error(InvalidValue)
+      end
+    end
+
+    describe '#id' do
+      it 'is :rpm' do
+        expect(subject.id).to eq(:rpm)
+      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.rpm')
+      end
+    end
+
+    describe '#build_dir' do
+      it 'is nested inside the staging_dir' do
+        expect(subject.build_dir).to eq("#{staging_dir}/BUILD")
+      end
+    end
+
+    describe '#write_rpm_spec' do
+      before do
+        allow(subject).to receive(:safe_architecture).and_return('x86_64')
+      end
+
+      let(:spec_file) { "#{staging_dir}/SPECS/project-1.2.3-2.x86_64.rpm.spec" }
+
+      it 'generates the file' do
+        subject.write_rpm_spec
+        expect(spec_file).to be_a_file
+      end
+
+      it 'has the correct content' do
+        subject.write_rpm_spec
+        contents = File.read(spec_file)
+
+        expect(contents).to include("Name: project")
+        expect(contents).to include("Version: 1.2.3")
+        expect(contents).to include("Release: 2")
+        expect(contents).to include("Summary:  The full stack of project")
+        expect(contents).to include("BuildArch: x86_64")
+        expect(contents).to include("AutoReqProv: no")
+        expect(contents).to include("BuildRoot: %buildroot")
+        expect(contents).to include("Prefix: /")
+        expect(contents).to include("Group: default")
+        expect(contents).to include("License: unknown")
+        expect(contents).to include("Vendor: Omnibus <omnibus@getchef.com>")
+        expect(contents).to include("URL: https://example.com")
+        expect(contents).to include("Packager: Chef Software")
+      end
+
+      context 'when scripts are given' do
+        before do
+          Packager::RPM::SCRIPTS.each do |name|
+            create_file("#{project_root}/package-scripts/project/#{name}") do
+              "Contents of #{name}"
+            end
+          end
+        end
+
+        it 'writes the scripts into the spec' do
+          subject.write_rpm_spec
+          contents = File.read(spec_file)
+
+          expect(contents).to include("%pre")
+          expect(contents).to include("Contents of pre")
+          expect(contents).to include("%post")
+          expect(contents).to include("Contents of post")
+          expect(contents).to include("%preun")
+          expect(contents).to include("Contents of preun")
+          expect(contents).to include("%postun")
+          expect(contents).to include("Contents of postun")
+          expect(contents).to include("%verifyscript")
+          expect(contents).to include("Contents of verifyscript")
+          expect(contents).to include("%pretans")
+          expect(contents).to include("Contents of pretans")
+          expect(contents).to include("%posttrans")
+          expect(contents).to include("Contents of posttrans")
+        end
+      end
+
+      context 'when files and directories are present' do
+        before do
+          create_file("#{staging_dir}/BUILD/.file1")
+          create_file("#{staging_dir}/BUILD/file2")
+          create_directory("#{staging_dir}/BUILD/.dir1")
+          create_directory("#{staging_dir}/BUILD/dir2")
+        end
+
+        it 'writes them into the spec' do
+          subject.write_rpm_spec
+          contents = File.read(spec_file)
+
+          expect(contents).to include("/.dir1")
+          expect(contents).to include("/.file1")
+          expect(contents).to include("/dir2")
+          expect(contents).to include("/file2")
+        end
+      end
+    end
+
+    describe '#create_rpm_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_rpm_file }
+        expect(output).to include('Creating .rpm file')
+      end
+
+      it 'uses the correct command' do
+        expect(subject).to receive(:shellout!)
+          .with(/rpmbuild -bb --buildroot/)
+        subject.create_rpm_file
+      end
+
+      context 'when RPM signing is enabled' do
+        before do
+          subject.signing_passphrase('foobar')
+          allow(Dir).to receive(:mktmpdir).and_return(tmp_path)
+        end
+
+        it 'signs the rpm' do
+          expect(subject).to receive(:shellout!)
+            .with(/sign\-rpm/, kind_of(Hash))
+          subject.create_rpm_file
+        end
+      end
+    end
+
+    describe '#spec_file' do
+      before do
+        allow(subject).to receive(:package_name).and_return('package_name')
+      end
+
+      it 'includes the package_name' do
+        expect(subject.spec_file).to eq("#{staging_dir}/SPECS/package_name.spec")
+      end
+    end
+
+    describe '#rpm_safe' do
+      it 'adds quotes when required' do
+        expect(subject.rpm_safe('file path')).to eq('"file path"')
+      end
+
+      it 'escapes [' do
+        expect(subject.rpm_safe('[foo')).to eq('[\\[]foo')
+      end
+
+      it 'escapes *' do
+        expect(subject.rpm_safe('*foo')).to eq('[*]foo')
+      end
+
+      it 'escapes ?' do
+        expect(subject.rpm_safe('?foo')).to eq('[?]foo')
+      end
+
+      it 'escapes %' do
+        expect(subject.rpm_safe('%foo')).to eq('[%]foo')
+      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 RPM 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 RPM package names can only include")
+        end
+      end
+    end
+
+    describe '#safe_architecture' do
+      before do
+        stub_ohai(platform: 'ubuntu', version: '12.04') do |data|
+          data['kernel']['machine'] = 'i386'
+        end
+      end
+
+      it 'returns the value from Ohai' do
+        expect(subject.safe_architecture).to eq('i386')
+      end
+    end
+  end
+end