require 'spec_helper'

describe Puppet::Type.type(:package).provider(:yum) do
  include PuppetSpec::Fixtures

  let(:resource_name) { 'myresource' }
  let(:resource) do
    Puppet::Type.type(:package).new(
      :name     => resource_name,
      :ensure   => :installed,
      :provider => 'yum'
    )
  end

  let(:provider) { Puppet::Type.type(:package).provider(:yum).new(resource) }

  it_behaves_like 'RHEL package provider', described_class, 'yum'

  it "should have lower specificity" do
    allow(Facter).to receive(:value).with(:osfamily).and_return(:redhat)
    allow(Facter).to receive(:value).with(:operatingsystem).and_return(:fedora)
    allow(Facter).to receive(:value).with(:operatingsystemmajrelease).and_return("22")
    expect(described_class.specificity).to be < 200
  end

  describe "should have logical defaults" do
    [2, 2018].each do |ver|
      it "should be the default provider on Amazon Linux #{ver}" do
        allow(Facter).to receive(:value).with(:operatingsystem).and_return('amazon')
        allow(Facter).to receive(:value).with(:osfamily).and_return('redhat')
        allow(Facter).to receive(:value).with(:operatingsystemmajrelease).and_return(ver)
        expect(described_class).to be_default
      end
    end

    Array(4..7).each do |ver|
      it "should be default for redhat #{ver}" do
        allow(Facter).to receive(:value).with(:operatingsystem).and_return('redhat')
        allow(Facter).to receive(:value).with(:osfamily).and_return('redhat')
        allow(Facter).to receive(:value).with(:operatingsystemmajrelease).and_return(ver.to_s)
        expect(described_class).to be_default
      end
    end

    it "should not be default for redhat 8" do
      allow(Facter).to receive(:value).with(:operatingsystem).and_return('redhat')
      allow(Facter).to receive(:value).with(:osfamily).and_return('redhat')
      allow(Facter).to receive(:value).with(:operatingsystemmajrelease).and_return('8')
      expect(described_class).not_to be_default
    end

    it "should not be default for Ubuntu 16.04" do
      allow(Facter).to receive(:value).with(:operatingsystem).and_return('ubuntu')
      allow(Facter).to receive(:value).with(:osfamily).and_return('ubuntu')
      allow(Facter).to receive(:value).with(:operatingsystemmajrelease).and_return('16.04')
      expect(described_class).not_to be_default
    end
  end

  describe "when supplied the source param" do
    let(:name) { 'baz' }

    let(:resource) do
      Puppet::Type.type(:package).new(
        :name => name,
        :provider => 'yum',
      )
    end

    let(:provider) do
      provider = described_class.new
      provider.resource = resource
      provider
    end

    before { allow(described_class).to receive(:command).with(:cmd).and_return("/usr/bin/yum") }

  describe 'provider features' do
    it { is_expected.to be_versionable }
    it { is_expected.to be_install_options }
    it { is_expected.to be_virtual_packages }
    it { is_expected.to be_install_only }
  end

    context "when installing" do
      it "should use the supplied source as the explicit path to a package to install" do
        resource[:ensure] = :present
        resource[:source] = "/foo/bar/baz-1.1.0.rpm"
        expect(provider).to receive(:execute) do |arr|
          expect(arr[-2..-1]).to eq([:install, "/foo/bar/baz-1.1.0.rpm"])
        end
        provider.install
      end
    end

    context "when ensuring a specific version" do
      it "should use the suppplied source as the explicit path to the package to update" do
        # The first query response informs yum provider that package 1.1.0 is
        # already installed, and the second that it's been upgraded
        expect(provider).to receive(:query).twice.and_return({:ensure => "1.1.0"}, {:ensure => "1.2.0"})
        resource[:ensure] = "1.2.0"
        resource[:source] = "http://foo.repo.com/baz-1.2.0.rpm"
        expect(provider).to receive(:execute) do |arr|
          expect(arr[-2..-1]).to eq(['update', "http://foo.repo.com/baz-1.2.0.rpm"])
        end
        provider.install
      end
    end

    describe 'with install_options' do
      it 'can parse disable-repo with array of strings' do
          resource[:install_options] = ['--disable-repo=dev*', '--disable-repo=prod*']
          expect(provider).to receive(:execute) do | arr|
            expect(arr[-3]).to eq(["--disable-repo=dev*", "--disable-repo=prod*"])
          end
          provider.install
      end

      it 'can parse disable-repo with array of hashes' do
        resource[:install_options] = [{'--disable-repo' => 'dev*'}, {'--disable-repo' => 'prod*'}]
        expect(provider).to receive(:execute) do | arr|
          expect(arr[-3]).to eq(["--disable-repo=dev*", "--disable-repo=prod*"])
        end
        provider.install
      end

      it 'can parse enable-repo with array of strings' do
          resource[:install_options] = ['--enable-repo=dev*', '--enable-repo=prod*']
          expect(provider).to receive(:execute) do | arr|
            expect(arr[-3]).to eq(["--enable-repo=dev*", "--enable-repo=prod*"])
          end
          provider.install
      end

      it 'can parse enable-repo with array of hashes' do
        resource[:install_options] = [{'--enable-repo' => 'dev*'}, {'--disable-repo' => 'prod*'}]
        expect(provider).to receive(:execute) do | arr|
          expect(arr[-3]).to eq(["--enable-repo=dev*", "--disable-repo=prod*"])
        end
        provider.install
      end

      it 'can parse enable-repo with single hash' do
        resource[:install_options] = [{'--enable-repo' => 'dev*','--disable-repo' => 'prod*'}]
        expect(provider).to receive(:execute) do | arr|
          expect(arr[-3]).to eq(["--disable-repo=prod*", "--enable-repo=dev*"])
        end
        provider.install
      end

      it 'can parse enable-repo with empty array' do
        resource[:install_options] = []
        expect(provider).to receive(:execute) do | arr|
          expect(arr[-3]).to eq([])
        end
        provider.install
      end
    end
  end

  context "latest" do
    let(:name) { 'baz' }

    let(:resource) do
      Puppet::Type.type(:package).new(
        :name => name,
        :provider => 'yum',
      )
    end

    let(:provider) do
      provider = described_class.new
      provider.resource = resource
      provider
    end

    before {
      allow(described_class).to receive(:command).with(:cmd).and_return("/usr/bin/yum")
      Puppet[:log_level] = 'debug'
    }

    it "should print a debug message with the current version if newer package is not available" do
      expect(provider).to receive(:query).and_return({:ensure => "1.2.3"})
      expect(described_class).to receive(:latest_package_version).and_return(nil)
      resource[:ensure] = :present

      provider.latest
      expect(@logs).to include(an_object_having_attributes(level: :debug, message: "Yum didn't find updates, current version (1.2.3) is the latest"))
    end
  end

  context "parsing the output of check-update" do
    context "with no multiline entries" do
      let(:check_update) { File.read(my_fixture("yum-check-update-simple.txt")) }
      let(:output) { described_class.parse_updates(check_update) }

      it 'creates an entry for each package keyed on the package name' do
        expect(output['curl']).to eq([{:name => 'curl', :epoch => '0', :version => '7.32.0', :release => '10.fc20', :arch => 'i686'}, {:name => 'curl', :epoch => '0', :version => '7.32.0', :release => '10.fc20', :arch => 'x86_64'}])
        expect(output['gawk']).to eq([{:name => 'gawk', :epoch => '0', :version => '4.1.0', :release => '3.fc20', :arch => 'i686'}])
        expect(output['dhclient']).to eq([{:name => 'dhclient', :epoch => '12', :version => '4.1.1', :release => '38.P1.fc20', :arch => 'i686'}])
        expect(output['selinux-policy']).to eq([{:name => 'selinux-policy', :epoch => '0', :version => '3.12.1', :release => '163.fc20', :arch => 'noarch'}])
      end

      it 'creates an entry for each package keyed on the package name and package architecture' do
        expect(output['curl.i686']).to eq([{:name => 'curl', :epoch => '0', :version => '7.32.0', :release => '10.fc20', :arch => 'i686'}])
        expect(output['curl.x86_64']).to eq([{:name => 'curl', :epoch => '0', :version => '7.32.0', :release => '10.fc20', :arch => 'x86_64'}])
        expect(output['gawk.i686']).to eq([{:name => 'gawk', :epoch => '0', :version => '4.1.0', :release => '3.fc20', :arch => 'i686'}])
        expect(output['dhclient.i686']).to eq([{:name => 'dhclient', :epoch => '12', :version => '4.1.1', :release => '38.P1.fc20', :arch => 'i686'}])
        expect(output['selinux-policy.noarch']).to eq([{:name => 'selinux-policy', :epoch => '0', :version => '3.12.1', :release => '163.fc20', :arch => 'noarch'}])
        expect(output['java-1.8.0-openjdk.x86_64']).to eq([{:name => 'java-1.8.0-openjdk', :epoch => '1', :version => '1.8.0.131', :release => '2.b11.el7_3', :arch => 'x86_64'}])
      end
    end

    context "with multiline entries" do
      let(:check_update) { File.read(my_fixture("yum-check-update-multiline.txt")) }
      let(:output) { described_class.parse_updates(check_update) }

      it "parses multi-line values as a single package tuple" do
        expect(output['libpcap']).to eq([{:name => 'libpcap', :epoch => '14', :version => '1.4.0', :release => '1.20130826git2dbcaa1.el6', :arch => 'x86_64'}])
      end
    end

    context "with obsoleted packages" do
      let(:check_update) { File.read(my_fixture("yum-check-update-obsoletes.txt")) }
      let(:output) { described_class.parse_updates(check_update) }

      it "ignores all entries including and after 'Obsoleting Packages'" do
        expect(output).not_to include("Obsoleting")
        expect(output).not_to include("NetworkManager-bluetooth.x86_64")
        expect(output).not_to include("1:1.0.0-14.git20150121.b4ea599c.el7")
      end
    end

    context "with security notifications" do
      let(:check_update) { File.read(my_fixture("yum-check-update-security.txt")) }
      let(:output) { described_class.parse_updates(check_update) }

      it "ignores all entries including and after 'Security'" do
        expect(output).not_to include("Security")
      end

      it "includes updates before 'Security'" do
        expect(output).to include("yum-plugin-fastestmirror.noarch")
      end
    end

    context "with broken update notices" do
      let(:check_update) { File.read(my_fixture("yum-check-update-broken-notices.txt")) }
      let(:output) { described_class.parse_updates(check_update) }

      it "ignores all entries including and after 'Update'" do
        expect(output).not_to include("Update")
      end

      it "includes updates before 'Update'" do
        expect(output).to include("yum-plugin-fastestmirror.noarch")
      end
    end

    context "with improper package names in output" do
      it "raises an exception parsing package name" do
        expect {
          described_class.update_to_hash('badpackagename', '1')
        }.to raise_exception(Exception, /Failed to parse/)
      end
    end

    context "with trailing plugin output" do
      let(:check_update) { File.read(my_fixture("yum-check-update-plugin-output.txt")) }
      let(:output) { described_class.parse_updates(check_update) }

      it "parses correctly formatted entries" do
        expect(output['bash']).to eq([{:name => 'bash', :epoch => '0', :version => '4.2.46', :release => '12.el7', :arch => 'x86_64'}])
      end

      it "ignores all mentions of plugin output" do
        expect(output).not_to include("Random plugin")
      end
    end

    context "with subscription manager enabled " do
      let(:check_update) { File.read(my_fixture("yum-check-update-subscription-manager.txt")) }
      let(:output) { described_class.parse_updates(check_update) }

      it "parses correctly formatted entries" do
        expect(output['curl.x86_64']).to eq([{:name => 'curl', :epoch => '0', :version => '7.32.0', :release => '10.fc20', :arch => 'x86_64'}])
      end
    end
  end

  describe 'insync?' do
    context 'when version is not a valid RPM version' do
      let(:is) { '>===a:123' }

      before do
        resource[:ensure] = is
      end

      it 'logs a debug message' do
        expect(Puppet).to receive(:debug).with("Cannot parse #{is} as a RPM version range")
        provider.insync?(is)
      end
    end

    context 'with valid semantic versions' do
      let(:is) { '1:1.2.3.4-5.el4' }

      it 'returns true if the current version matches the given semantic version' do
        resource[:ensure] = is
        expect(provider).to be_insync(is)
      end

      it 'returns false if the current version does not match the given semantic version' do
        resource[:ensure] = '999r'
        expect(provider).not_to be_insync(is)
      end

      it 'no debug logs if the current version matches the given semantic version' do
        resource[:ensure] = is
        expect(Puppet).not_to receive(:debug)
        provider.insync?(is)
      end

      it 'returns true if current version matches the greater or equal semantic version in ensure' do
        resource[:ensure] = '<=1:1.2.3.4-5.el4'
        expect(provider).to be_insync(is)
      end

      it 'returns true if current version matches the lesser semantic version in ensure' do
        resource[:ensure] = '>1:1.0.0'
        expect(provider).to be_insync(is)
      end

      it 'returns true if current version matches two semantic conditions' do
        resource[:ensure] = '>1:1.1.3.4-5.el4 <1:1.3.3.6-5.el4'
        expect(provider).to be_insync(is)
      end

      it 'returns false if current version does not match matches two semantic conditions' do
        resource[:ensure] = '<1:1.1.3.4-5.el4 <1:1.3.3.6-5.el4'
        expect(provider).not_to be_insync(is)
      end
    end
  end

  describe 'install' do
    before do
      resource[:ensure] = ensure_value
      allow(Facter).to receive(:value).with(:operatingsystemmajrelease).and_return('7')
      allow(described_class).to receive(:command).with(:cmd).and_return('/usr/bin/yum')
      allow(provider).to receive(:query).twice.and_return(nil, ensure: '18.3.2')
      allow(provider).to receive(:insync?).with('18.3.2').and_return(true)
    end

    context 'with version range' do
      before do
        allow(provider).to receive(:available_versions).and_return(available_versions)
      end

      context 'without epoch' do
        let(:ensure_value) { '>18.1 <19' }
        let(:available_versions) { ['17.5.2', '18.0', 'a:23', '18.3', '18.3.2', '19.0', '3:18.4'] }

        it 'selects best_version' do
          expect(provider).to receive(:execute).with(
            ['/usr/bin/yum', '-d', '0', '-e', '0', '-y', :install, 'myresource-18.3.2']
          )
          provider.install
        end

        context 'when comparing with available packages that do not have epoch' do
          let(:ensure_value) { '>18' }
          let(:available_versions) { ['18.3.3', '3:18.3.2'] }

          it 'treats no epoch as zero' do
            expect(provider).to receive(:execute).with(
              ['/usr/bin/yum', '-d', '0', '-e', '0', '-y', :install, 'myresource-18.3.2']
              )
            provider.install
          end
        end
      end

      context 'with epoch' do
        let(:ensure_value) { '>18.1 <3:19' }
        let(:available_versions) { ['3:17.5.2', '3:18.0', 'a:23', '18.3.3', '3:18.3.2', '3:19.0', '19.1'] }

        it 'selects best_version and removes epoch' do
          expect(provider).to receive(:execute).with(
            ['/usr/bin/yum', '-d', '0', '-e', '0', '-y', :install, 'myresource-18.3.2']
          )
          provider.install
        end
      end

      context 'when no suitable version in range' do
        let(:ensure_value) { '>18.1 <19' }
        let(:available_versions) { ['3:17.5.2', '3:18.0', 'a:23' '18.3', '3:18.3.2', '3:19.0', '19.1'] }

        it 'uses requested version' do
          expect(provider).to receive(:execute).with(
            ['/usr/bin/yum', '-d', '0', '-e', '0', '-y', :install, "myresource->18.1 <19"]
          )
          provider.install
        end

        it 'logs a debug message' do
          allow(provider).to receive(:execute).with(
            ['/usr/bin/yum', '-d', '0', '-e', '0', '-y', :install, "myresource->18.1 <19"]
          )

          expect(Puppet).to receive(:debug).with(
            "No available version for package myresource is included in range >18.1 <19"
          )
          provider.install
        end
      end
    end

    context 'with fix version' do
      let(:ensure_value) { '1:18.12' }

      it 'passes the version to yum command' do
        expect(provider).to receive(:execute).with(
            ['/usr/bin/yum', '-d', '0', '-e', '0', '-y', :install, "myresource-1:18.12"]
          )
          provider.install
      end
    end

    context 'when upgrading' do
      let(:ensure_value) { '>18.1 <19' }
      let(:available_versions) { ['17.5.2', '18.0', 'a:23' '18.3', '18.3.2', '19.0', '3:18.4'] }

      before do
        allow(provider).to receive(:available_versions).and_return(available_versions)
        allow(provider).to receive(:query).twice
          .and_return({ ensure: '17.0' }, { ensure: '18.3.2' })
      end

      it 'adds update flag to install command' do
        expect(provider).to receive(:execute).with(
          ['/usr/bin/yum', '-d', '0', '-e', '0', '-y', 'update', 'myresource-18.3.2']
        )
        provider.install
      end
    end

    context 'when dowgrading' do
      let(:ensure_value) { '>18.1 <19' }
      let(:available_versions) { ['17.5.2', '18.0', 'a:23' '18.3', '18.3.2', '19.0', '3:18.4'] }

      before do
        allow(provider).to receive(:available_versions).and_return(available_versions)
        allow(provider).to receive(:query).twice
          .and_return({ ensure: '19.0' }, { ensure: '18.3.2' })
      end

      it 'adds downgrade flag to install command' do
        expect(provider).to receive(:execute).with(
          ['/usr/bin/yum', '-d', '0', '-e', '0', '-y', :downgrade, 'myresource-18.3.2']
        )
        provider.install
      end
    end

    context 'on failure' do
      let(:ensure_value) { '20' }

      context 'when execute command fails' do
        before do
          allow(provider).to receive(:execute).with(
            ['/usr/bin/yum', '-d', '0', '-e', '0', '-y', :install, "myresource-20"]
          ).and_return('No package myresource-20 available.')
        end

        it 'raises Puppet::Error' do
          expect { provider.install }.to \
            raise_error(Puppet::Error, 'Could not find package myresource-20')
        end
      end

      context 'when package is not found' do
        before do
          allow(provider).to receive(:query)
          allow(provider).to receive(:execute).with(
            ['/usr/bin/yum', '-d', '0', '-e', '0', '-y', :install, "myresource-20"]
          )
        end

        it 'raises Puppet::Error' do
          expect { provider.install }.to \
            raise_error(Puppet::Error, 'Could not find package myresource')
        end
      end

      context 'when package is not installed' do
        before do
          allow(provider).to receive(:execute).with(
            ['/usr/bin/yum', '-d', '0', '-e', '0', '-y', :install, "myresource-20"]
          )
          allow(provider).to receive(:insync?).and_return(false)
        end

        it 'raises Puppet::Error' do
          expect { provider.install }.to \
            raise_error(Puppet::Error, 'Failed to update to version 20, got version 18.3.2 instead')
        end
      end
    end
  end
end
