packaging 0.88.77

data/spec/lib/packaging/util/os_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Pkg::Util::OS do
+  def as_host_os(platform, &block)
+    old = RbConfig::CONFIG['host_os']
+    RbConfig::CONFIG['host_os'] = platform
+    begin
+      yield
+    ensure
+      RbConfig::CONFIG['host_os'] = old
+    end
+  end
+
+  it "detects windows when host_os contains mingw" do
+    as_host_os('mingw32') do
+      expect(Pkg::Util::OS).to be_windows
+    end
+  end
+
+  it "detects windows when host_os contains mswin60" do
+    as_host_os('mswin60') do
+      expect(Pkg::Util::OS).to be_windows
+    end
+  end
+
+  it "does not detect windows when host_os contains darwin" do
+    as_host_os('darwin12.5.0') do
+      expect(Pkg::Util::OS).to_not be_windows
+    end
+  end
+end

data/spec/lib/packaging/util/rake_utils_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe "Pkg::Util::RakeUtils" do
+  let(:foo_defined?) { Rake::Task.task_defined?(:foo) }
+  let(:bar_defined?) { Rake::Task.task_defined?(:bar) }
+  let(:define_foo)   { body = proc{}; Rake::Task.define_task(:foo, &body) }
+  let(:define_bar)   { body = proc{}; Rake::Task.define_task(:bar, &body) }
+
+  before(:each) do
+    if foo_defined?
+      Rake::Task[:foo].clear_prerequisites
+    end
+  end
+
+  describe "#task_defined?" do
+    context "given a Rake::Task task name" do
+      it "should return true if the task exists" do
+        Rake::Task.stub(:task_defined?).with(:foo) {true}
+        expect(Pkg::Util::RakeUtils.task_defined?(:foo)).to be_true
+      end
+      it "should return false if the task does not exist" do
+        Rake::Task.stub(:task_defined?).with(:foo) {false}
+        expect(Pkg::Util::RakeUtils.task_defined?(:foo)).to be_false
+      end
+    end
+  end
+
+  describe "#get_task" do
+    it "should return a task object for a named task" do
+      foo = nil
+      if !foo_defined?
+        foo = define_foo
+      else
+        foo = Rake::Task[:foo]
+      end
+      task = Pkg::Util::RakeUtils.get_task(:foo)
+      expect(task).to be_a(Rake::Task)
+      expect(task).to be(foo)
+    end
+  end
+
+  describe "#add_dependency" do
+    it "should add a dependency to a given rake task" do
+      foo = nil
+      bar = nil
+      if !foo_defined?
+        foo = define_foo
+      else
+        foo = Rake::Task[:foo]
+      end
+      if !bar_defined?
+        bar = define_bar
+      else
+        bar = Rake::Task[:bar]
+      end
+      Pkg::Util::RakeUtils.add_dependency(foo, bar)
+      expect(Rake::Task["foo"].prerequisites).to include(bar)
+    end
+  end
+
+  describe "#evaluate_pre_tasks" do
+    context "Given a data file with :pre_tasks defined" do
+      it "should, for each k=>v pair, add v as a dependency to k" do
+        Pkg::Config.config_from_yaml(File.join(FIXTURES, 'util', 'pre_tasks.yaml'))
+        expect(Pkg::Util::RakeUtils).to receive(:add_dependency)
+        Pkg::Util::RakeUtils.evaluate_pre_tasks
+      end
+    end
+  end
+end

data/spec/lib/packaging/util/ship_spec.rb

@@ -0,0 +1,199 @@
+require 'spec_helper'
+
+describe '#Pkg::Util::Ship' do
+  describe '#collect_packages' do
+    msi_packages = %w[
+      pkg/windows/puppet6/puppet-agent-6.19.0-x64.msi
+      pkg/windows/puppet6/puppet-agent-6.19.0-x86.msi
+      pkg/windowsfips/puppet6/puppet-agent-6.19.0-x64.msi
+      pkg/windows/puppet6/puppet-agent-x86.msi
+      pkg/windowsfips/puppet6/puppet-agent-x64.msi
+    ]
+    solaris_packages = %w[
+      pkg/solaris/10/puppet6/puppet-agent-6.9.0-1.sparc.pkg.gz
+      pkg/solaris/10/puppet6/puppet-agent-6.9.0-1.sparc.pkg.gz.asc
+    ]
+
+    it 'returns an array of packages found on the filesystem' do
+      allow(Dir).to receive(:glob).with('pkg/**/*.sparc*').and_return(solaris_packages)
+      expect(Pkg::Util::Ship.collect_packages(['pkg/**/*.sparc*'])).to eq(solaris_packages)
+    end
+
+    context 'excluding packages' do
+      before :each do
+        allow(Dir).to receive(:glob).with('pkg/**/*.msi').and_return(msi_packages)
+      end
+      it 'correctly excludes any packages that match a passed excludes argument' do
+        expect(Pkg::Util::Ship.collect_packages(['pkg/**/*.msi'], ['puppet-agent-x(86|64).msi']))
+          .not_to include('pkg/windows/puppet6/puppet-agent-x86.msi')
+        expect(Pkg::Util::Ship.collect_packages(['pkg/**/*.msi'], ['puppet-agent-x(86|64).msi']))
+          .not_to include('pkg/windows/puppet6/puppet-agent-x64.msi')
+      end
+      it 'correctly includes packages that do not match a passed excluded argument' do
+        expect(Pkg::Util::Ship.collect_packages(['pkg/**/*.msi'],
+                                                ['bogus-puppet-agent-x(86|64).msi']))
+          .to match_array(msi_packages)
+      end
+    end
+
+    it 'returns an empty array when it cannot find any packages' do
+      allow(Dir).to receive(:glob).with('pkg/**/*.html').and_return([])
+      expect(Pkg::Util::Ship.collect_packages(['pkg/**/*.html'])).to be_empty
+    end
+  end
+
+  # Sample data for #reorganize_packages and #ship_pkgs specs
+  retrieved_packages = %w[
+    pkg/deb/bionic/puppet6/puppet-agent_6.19.0-1bionic_amd64.deb
+    pkg/el/7/puppet6/aarch64/puppet-agent-6.19.0-1.el7.aarch64.rpm
+    pkg/el/7/puppet6/ppc64le/puppet-agent-6.19.0-1.el7.ppc64le.rpm
+    pkg/el/7/puppet6/x86_64/puppet-agent-6.19.0-1.el7.x86_64.rpm
+    pkg/sles/12/puppet6/ppc64le/puppet-agent-6.19.0-1.sles12.ppc64le.rpm
+    pkg/sles/12/puppet6/x86_64/puppet-agent-6.19.0-1.sles12.x86_64.rpm
+    pkg/sles/15/puppet6/x86_64/puppet-agent-6.19.0-1.sles15.x86_64.rpm
+    pkg/apple/10.14/puppet6/x86_64/puppet-agent-6.19.0-1.osx10.14.dmg
+    pkg/apple/10.15/puppet6/x86_64/puppet-agent-6.19.0-1.osx10.15.dmg
+    pkg/fedora/32/puppet6/x86_64/puppet-agent-6.19.0-1.fc32.x86_64.rpm
+    pkg/windows/puppet-agent-6.19.0-x64.msi
+    pkg/windows/puppet-agent-6.19.0-x86.msi
+    pkg/windowsfips/puppet-agent-6.19.0-x64.msi
+    pkg/windows/puppet6/puppet-agent-x86.msi
+    pkg/windowsfips/puppet6/puppet-agent-x64.msi
+  ]
+
+  # After reorganization, the packages should look like this.
+  # Beware apple->mac transforms.
+  expected_reorganized_packages = %w[
+    pkg/bionic/puppet6/puppet-agent_6.19.0-1bionic_amd64.deb
+    pkg/puppet6/el/7/aarch64/puppet-agent-6.19.0-1.el7.aarch64.rpm
+    pkg/puppet6/el/7/ppc64le/puppet-agent-6.19.0-1.el7.ppc64le.rpm
+    pkg/puppet6/el/7/x86_64/puppet-agent-6.19.0-1.el7.x86_64.rpm
+    pkg/puppet6/sles/12/ppc64le/puppet-agent-6.19.0-1.sles12.ppc64le.rpm
+    pkg/puppet6/sles/12/x86_64/puppet-agent-6.19.0-1.sles12.x86_64.rpm
+    pkg/puppet6/sles/15/x86_64/puppet-agent-6.19.0-1.sles15.x86_64.rpm
+    pkg/mac/puppet6/10.14/x86_64/puppet-agent-6.19.0-1.osx10.14.dmg
+    pkg/mac/puppet6/10.15/x86_64/puppet-agent-6.19.0-1.osx10.15.dmg
+    pkg/puppet6/fedora/32/x86_64/puppet-agent-6.19.0-1.fc32.x86_64.rpm
+    pkg/windows/puppet6/puppet-agent-6.19.0-x64.msi
+    pkg/windows/puppet6/puppet-agent-6.19.0-x86.msi
+    pkg/windowsfips/puppet6/puppet-agent-6.19.0-x64.msi
+    pkg/windows/puppet6/puppet-agent-x86.msi
+    pkg/windowsfips/puppet6/puppet-agent-x64.msi
+  ]
+
+  describe '#reorganize_packages' do
+    # This is a sampling of packages found on builds.delivery.puppetlabs.net in
+    # '/opt/jenkins-builds/puppet-agent/<version>/artifacts'
+    # pl:jenkins:retrieve replaces 'artifacts' with 'pkg', so we pick up the
+    # action from that point by pretending that we've scanned the directory and
+    # made this list:
+
+    scratch_directory = Dir.mktmpdir
+
+    before :each do
+      allow(Pkg::Config).to receive(:repo_name).and_return('puppet6')
+      expect(FileUtils).to receive(:cp).at_least(:once).and_return(true)
+    end
+
+    original_packages = retrieved_packages
+
+    it 'leaves the old packages in place' do
+      reorganized_packages = Pkg::Util::Ship
+                               .reorganize_packages(retrieved_packages, scratch_directory)
+
+      expect(retrieved_packages).to eq(original_packages)
+    end
+
+    it 'returns a list of properly reorganized packages' do
+      reorganized_packages = Pkg::Util::Ship
+                               .reorganize_packages(retrieved_packages, scratch_directory)
+      expect(reorganized_packages).to eq(expected_reorganized_packages)
+    end
+  end
+
+  describe '#ship_pkgs' do
+    test_staging_server = 'foo.delivery.puppetlabs.net'
+    test_remote_path = '/opt/repository/yum'
+
+    it 'ships the packages to the staging server' do
+      allow(Pkg::Util::Ship)
+        .to receive(:collect_packages)
+              .and_return(retrieved_packages)
+      allow(Pkg::Util::Ship)
+        .to receive(:reorganize_packages)
+              .and_return(expected_reorganized_packages)
+      allow(Pkg::Util).to receive(:ask_yes_or_no).and_return(true)
+      # All of these expects must be called in the same block in order for the
+      # tests to work without actually shipping anything
+      expect(Pkg::Util::Net)
+        .to receive(:remote_execute)
+              .with(test_staging_server, /#{test_remote_path}/)
+              .exactly(retrieved_packages.count).times
+      expect(Pkg::Util::Net)
+        .to receive(:rsync_to)
+              .with(anything, test_staging_server, /#{test_remote_path}/, anything)
+              .exactly(retrieved_packages.count).times
+      expect(Pkg::Util::Net)
+        .to receive(:remote_set_ownership)
+              .with(test_staging_server, 'root', 'release', anything)
+              .exactly(retrieved_packages.count).times
+      expect(Pkg::Util::Net)
+        .to receive(:remote_set_permissions)
+              .with(test_staging_server, '775', anything)
+              .exactly(retrieved_packages.count).times
+      expect(Pkg::Util::Net)
+        .to receive(:remote_set_permissions)
+              .with(test_staging_server, '0664', anything)
+              .exactly(retrieved_packages.count).times
+      expect(Pkg::Util::Net)
+        .to receive(:remote_set_immutable)
+              .with(test_staging_server, anything)
+              .exactly(retrieved_packages.count).times
+      expect(Pkg::Util::Ship.ship_pkgs(['pkg/**/*.rpm'], test_staging_server, test_remote_path))
+        .to eq(true)
+    end
+
+    it 'ships packages containing the string `pkg` to the right place' do
+      retrieved_package =   'pkg/el/7/puppet6/x86_64/puppet-agent-6.19.0-1.el7.x86_64.rpm'
+      reorganized_package = 'pkg/puppet6/el/7/x86_64/puppet-agent-6.19.0-1.el7.x86_64.rpm'
+      package_basename = File.basename(reorganized_package)
+      repository_base_path = '/opt/repository/yum/puppet6/el/7/x86_64'
+
+      allow(Pkg::Util::Ship).to receive(:collect_packages).and_return([retrieved_package])
+      allow(Pkg::Util::Ship).to receive(:reorganize_packages).and_return([reorganized_package])
+      allow(Pkg::Util).to receive(:ask_yes_or_no).and_return(true)
+      allow(Dir).to receive(:mktmpdir).and_return('/tmp/test')
+
+      # All of these expects must be called in the same block in order for the
+      # tests to work without actually shipping anything
+      expect(Pkg::Util::Net)
+        .to receive(:remote_execute)
+              .with(test_staging_server, /#{test_remote_path}/)
+      expect(Pkg::Util::Net)
+        .to receive(:rsync_to)
+              .with(anything, test_staging_server, /#{test_remote_path}/, anything)
+      expect(Pkg::Util::Net)
+        .to receive(:remote_set_ownership)
+              .with(test_staging_server, 'root', 'release',
+                    [repository_base_path, "#{repository_base_path}/#{package_basename}"])
+      expect(Pkg::Util::Net)
+        .to receive(:remote_set_permissions)
+              .with(test_staging_server, '775', anything)
+      expect(Pkg::Util::Net)
+        .to receive(:remote_set_permissions)
+              .with(test_staging_server, '0664', anything)
+      expect(Pkg::Util::Net)
+        .to receive(:remote_set_immutable)
+              .with(test_staging_server, anything)
+      expect(Pkg::Util::Ship.ship_pkgs(['pkg/**/*.rpm'], test_staging_server,
+                                       test_remote_path, excludes: ['puppet-agent']))
+        .to eq(true)
+    end
+
+    it 'returns false if there are no packages to ship' do
+      expect(Pkg::Util::Ship.ship_pkgs(['pkg/**/*.msi'],
+                                       test_staging_server, test_remote_path))
+        .to eq(false)
+    end
+  end
+end

data/spec/lib/packaging/util/version_spec.rb

@@ -0,0 +1,123 @@
+# -*- ruby -*-
+require 'spec_helper'
+
+# Spec tests for Pkg::Util::Version
+#
+# rubocop:disable Metrics/BlockLength
+describe 'Pkg::Util::Version' do
+  context '#versionbump' do
+    let(:version_file) { 'thing.txt' }
+    let(:version) { '1.2.3' }
+    let(:orig_contents) { "abcd\nVERSION = @DEVELOPMENT_VERSION@\n" }
+    let(:updated_contents) { "abcd\nVERSION = #{version}\n" }
+
+    it 'should update the version file contents accordingly' do
+      Pkg::Config.config_from_hash(project: 'foo', version_file: version_file)
+      allow(IO).to receive(:read).with(version_file) { orig_contents }
+      allow(Pkg::Config).to receive(:version) { version }
+      version_file_to_write = double('file')
+      expect(File).to receive(:open).with(version_file, 'w').and_yield(version_file_to_write)
+      expect(version_file_to_write).to receive(:write).with(updated_contents)
+      Pkg::Util::Version.versionbump
+    end
+  end
+
+  describe '#base_pkg_version' do
+    version_hash = {
+      '5.6' => ['5.6', '1'],
+      '1.0.0' => ['1.0.0', '1'],
+      '2017.6.5.3' => ['2017.6.5.3', '1'],
+      '4.99.0-22' => ['4.99.0.22', '0.1'],
+      '1.0.0-658-gabc1234' => ['1.0.0.658.gabc1234', '0.1'],
+      '5.0.0.master.SNAPSHOT.2017.05.16T1357' => ['5.0.0.master', '0.1SNAPSHOT.2017.05.16T1357'],
+      '5.9.7-rc4' => ['5.9.7', '0.1rc4'],
+      '5.9.7-rc4-65-gabc1234' => ['5.9.7.65.gabc1234', '0.1rc4'],
+      '5.9.7-rc4-65-gabc1234-dirty' => ['5.9.7.65.gabc1234', '0.1rc4dirty'],
+      '4.99.0-dirty' => ['4.99.0', '0.1dirty'],
+      '4.99.0-56-gabc1234-dirty' => ['4.99.0.56.gabc1234', '0.1dirty']
+    }
+    version_hash.each do |pre, post|
+      before do
+        allow(Pkg::Config).to receive(:version) { pre }
+        allow(Pkg::Config).to receive(:release) { '1' }
+        allow(Pkg::Config).to receive(:vanagon_project) { false }
+      end
+
+      it "transforms #{pre} to #{post}" do
+        expect(Pkg::Util::Version.base_pkg_version(pre)).to eq post
+      end
+    end
+  end
+
+  describe '#final?' do
+    final_versions = [
+      '1.0.0',
+      '2017.6.5.3',
+      '0.6.8',
+      '2068.532.6',
+      '96.5'
+    ]
+
+    non_final_versions = [
+      '4.99.0-22',
+      '1.0.0-658-gabc1234',
+      '5.0.0.master.SNAPSHOT.2017.05.16T1357',
+      '5.9.7-rc4',
+      '4.99.0-56-dirty'
+    ]
+
+    final_versions.each do |version|
+      it "returns true when given #{version}" do
+        allow(Pkg::Config).to receive(:version) { nil }
+        expect(Pkg::Util::Version.final?(version)).to be true
+      end
+    end
+
+    non_final_versions.each do |version|
+      it "returns false when given #{version}" do
+        allow(Pkg::Config).to receive(:version) { nil }
+        expect(Pkg::Util::Version.final?(version)).to be false
+      end
+    end
+
+    it 'correctly reads a final version from Pkg::Config.version' do
+      allow(Pkg::Config).to receive(:version) { '1.0.0' }
+      expect(Pkg::Util::Version.final?).to be true
+    end
+
+    it 'correctly reads a non-final version from Pkg::Config.version' do
+      allow(Pkg::Config).to receive(:version) { '4.99.0-56-dirty' }
+      expect(Pkg::Util::Version.final?).to be false
+    end
+
+    it 'classifies dirty versions as final when allow_dirty_tree is set' do
+      allow(Pkg::Config).to receive(:allow_dirty_tree).and_return true
+      allow(Pkg::Config).to receive(:version) { '1.0.0-dirty' }
+      expect(Pkg::Util::Version.final?).to be true
+    end
+
+    it 'classifies dirty nonfinal versions as not final even when allow_dirty_tree is set' do
+      allow(Pkg::Config).to receive(:allow_dirty_tree).and_return true
+      allow(Pkg::Config).to receive(:version) { '1.0.0-22-dirty' }
+      expect(Pkg::Util::Version.final?).to be false
+    end
+  end
+
+  context "#dash_version" do
+    versions = {
+      '5.3.0' => '5.3.0',
+      '5.3.0-18-gfbddc8f' => '5.3.0-18',
+      '5.3.0-18-gfbddc8f-dirty' => '5.3.0-18-dirty',
+      '0.7.0-rc1' => '0.7.0-rc1',
+      '0.7.0-rc1-63-g51ccc51' => '0.7.0-rc1-63',
+      '0.7.0-rc1-63-g51ccc51-dirty'=> '0.7.0-rc1-63-dirty',
+    }
+    versions.each do |describe, reformatted|
+      it "correctly returns #{reformatted} when #{describe} is the git describe version" do
+        allow(Pkg::Util::Git).to receive(:ref_type).and_return 'sha'
+        allow(Pkg::Util::Git).to receive(:describe).and_return describe
+        expect(Pkg::Util::Version.dash_version).to eq reformatted
+      end
+    end
+  end
+end

data/spec/lib/packaging_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+#   We load packaging.rb once, in spec_helper, to avoid reloading the library
+#   and issuing warnings about already defined constants.
+describe "Pkg" do
+  it "should require the utilities module, Pkg::Util" do
+    Pkg::Util.should_not be_nil
+  end
+
+  it  "should require the configuration module, Pkg::Config" do
+    Pkg::Config.should_not be_nil
+  end
+
+  it  "should require the tar library, Pkg::Tar" do
+    Pkg::Tar.should_not be_nil
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'rspec'
+require 'pathname'
+require 'rake'
+
+SPECDIR = Pathname(__FILE__).dirname
+PROJECT_ROOT = File.expand_path(File.join(Pathname(__FILE__).dirname, ".."))
+FIXTURES = File.join(SPECDIR, 'fixtures')
+
+require File.join(SPECDIR, '..', 'lib', 'packaging.rb')
+
+def load_task(name)
+  return false if (@loaded ||= {})[name]
+  load File.join(SPECDIR, '..', 'tasks', name)
+  @loaded[name] = true
+end
+
+def reset_env(keys)
+  keys.each do |key|
+    ENV[key] = nil
+  end
+end