run_mode_spec.rb

require 'spec_helper'

describe Puppet::Util::RunMode do
  before do
    @run_mode = Puppet::Util::RunMode.new('fake')
  end

  describe Puppet::Util::UnixRunMode, :unless => Puppet::Util::Platform.windows? do
    before do
      @run_mode = Puppet::Util::UnixRunMode.new('fake')
    end

    describe "#conf_dir" do
      it "has confdir /etc/puppetlabs/puppet when run as root" do
        allow(@run_mode).to receive(:find_or_first).and_return('/etc/puppetlabs/puppet')
        as_root { expect(@run_mode.conf_dir).to eq(File.expand_path('/etc/puppetlabs/puppet')) }
      end

      it "has confdir ~/.puppetlabs/etc/puppet when run as non-root" do
        as_non_root { expect(@run_mode.conf_dir).to eq(File.expand_path('~/.puppetlabs/etc/puppet')) }
      end

      context "server run mode" do
        before do
          @run_mode = Puppet::Util::UnixRunMode.new('server')
        end

        it "has confdir ~/.puppetlabs/etc/puppet when run as non-root and server run mode" do
          as_non_root { expect(@run_mode.conf_dir).to eq(File.expand_path('~/.puppetlabs/etc/puppet')) }
        end
      end
    end

    describe "#code_dir" do
      it "has codedir /etc/puppetlabs/code when run as root" do
        allow(@run_mode).to receive(:find_or_first).and_return('/etc/puppetlabs/code')
        as_root { expect(@run_mode.code_dir).to eq(File.expand_path('/etc/puppetlabs/code')) }
      end

      it "has codedir ~/.puppetlabs/etc/code when run as non-root" do
        as_non_root { expect(@run_mode.code_dir).to eq(File.expand_path('~/.puppetlabs/etc/code')) }
      end

      context "server run mode" do
        before do
          @run_mode = Puppet::Util::UnixRunMode.new('server')
        end

        it "has codedir ~/.puppetlabs/etc/code when run as non-root and server run mode" do
          as_non_root { expect(@run_mode.code_dir).to eq(File.expand_path('~/.puppetlabs/etc/code')) }
        end
      end
    end

    describe "#var_dir" do
      it "has vardir /opt/puppetlabs/puppet/cache when run as root" do
        allow(@run_mode).to receive(:find_or_first).and_return('/opt/puppetlabs/puppet/cache')
        as_root { expect(@run_mode.var_dir).to eq(File.expand_path('/opt/puppetlabs/puppet/cache')) }
      end

      it "has vardir ~/.puppetlabs/opt/puppet/cache when run as non-root" do
        as_non_root { expect(@run_mode.var_dir).to eq(File.expand_path('~/.puppetlabs/opt/puppet/cache')) }
      end
    end

    describe "#public_dir" do
      it "has publicdir /opt/puppetlabs/puppet/public when run as root" do
        allow(@run_mode).to receive(:find_or_first).and_return('/opt/puppetlabs/puppet/public')
        as_root { expect(@run_mode.public_dir).to eq(File.expand_path('/opt/puppetlabs/puppet/public')) }
      end

      it "has publicdir ~/.puppetlabs/opt/puppet/public when run as non-root" do
        as_non_root { expect(@run_mode.public_dir).to eq(File.expand_path('~/.puppetlabs/opt/puppet/public')) }
      end
    end

    describe "#log_dir" do
      describe "when run as root" do
        it "has logdir /var/log/puppetlabs/puppet" do
          allow(@run_mode).to receive(:find_or_first).and_return('/var/log/puppetlabs/puppet')
          as_root { expect(@run_mode.log_dir).to eq(File.expand_path('/var/log/puppetlabs/puppet')) }
        end
      end

      describe "when run as non-root" do
        it "has default logdir ~/.puppetlabs/var/log" do
          as_non_root { expect(@run_mode.log_dir).to eq(File.expand_path('~/.puppetlabs/var/log')) }
        end
      end
    end

    describe "#run_dir" do
      describe "when run as root" do
        it "has rundir /var/run/puppetlabs" do
          allow(@run_mode).to receive(:find_or_first).and_return('/var/run/puppetlabs')
          as_root { expect(@run_mode.run_dir).to eq(File.expand_path('/var/run/puppetlabs')) }
        end
      end

      describe "when run as non-root" do
        it "has default rundir ~/.puppetlabs/var/run" do
          as_non_root { expect(@run_mode.run_dir).to eq(File.expand_path('~/.puppetlabs/var/run')) }
        end
      end
    end

    describe "#pkg_config_path" do
      it "has pkg config path /opt/puppetlabs/puppet/lib/pkgconfig" do
        allow(@run_mode).to receive(:find_or_first).and_return('/opt/puppetlabs/puppet/lib/pkgconfig')
        expect(@run_mode.pkg_config_path).to eq('/opt/puppetlabs/puppet/lib/pkgconfig')
      end
    end

    describe "#gem_cmd" do
      it "has gem cmd /opt/puppetlabs/puppet/bin/gem" do
        allow(@run_mode).to receive(:find_or_first).and_return('/opt/puppetlabs/puppet/bin/gem')
        expect(@run_mode.gem_cmd).to eq('/opt/puppetlabs/puppet/bin/gem')
      end
    end

    describe "#common_module_dir" do
      it "has common module dir /opt/puppetlabs/puppet/modules" do
        allow(@run_mode).to receive(:find_or_first).and_return('/opt/puppetlabs/puppet/modules')
        expect(@run_mode.common_module_dir).to eq('/opt/puppetlabs/puppet/modules')
      end
    end

    describe "#vendor_module_dir" do
      it "has vendor module dir /opt/puppetlabs/puppet/vendor_modules" do
        allow(@run_mode).to receive(:find_or_first).and_return('/opt/puppetlabs/puppet/vendor_modules')
        expect(@run_mode.vendor_module_dir).to eq('/opt/puppetlabs/puppet/vendor_modules')
      end
    end
  end

  describe Puppet::Util::WindowsRunMode, :if => Puppet::Util::Platform.windows? do
    before do
      @run_mode = Puppet::Util::WindowsRunMode.new('fake')
    end

    describe "#conf_dir" do
      it "has confdir ending in Puppetlabs/puppet/etc when run as root" do
        as_root { expect(@run_mode.conf_dir).to eq(File.expand_path(File.join(ENV['ALLUSERSPROFILE'], "PuppetLabs", "puppet", "etc"))) }
      end

      it "has confdir in ~/.puppetlabs/etc/puppet when run as non-root" do
        as_non_root { expect(@run_mode.conf_dir).to eq(File.expand_path("~/.puppetlabs/etc/puppet")) }
      end
    end

    describe "#code_dir" do
      it "has codedir ending in PuppetLabs/code when run as root" do
        as_root { expect(@run_mode.code_dir).to eq(File.expand_path(File.join(ENV['ALLUSERSPROFILE'], "PuppetLabs", "code"))) }
      end

      it "has codedir in ~/.puppetlabs/etc/code when run as non-root" do
        as_non_root { expect(@run_mode.code_dir).to eq(File.expand_path("~/.puppetlabs/etc/code")) }
      end
    end

    describe "#var_dir" do
      it "has vardir ending in PuppetLabs/puppet/cache when run as root" do
        as_root { expect(@run_mode.var_dir).to eq(File.expand_path(File.join(ENV['ALLUSERSPROFILE'], "PuppetLabs", "puppet", "cache"))) }
      end

      it "has vardir in ~/.puppetlabs/opt/puppet/cache when run as non-root" do
        as_non_root { expect(@run_mode.var_dir).to eq(File.expand_path("~/.puppetlabs/opt/puppet/cache")) }
      end
    end

    describe "#public_dir" do
      it "has publicdir ending in PuppetLabs/puppet/public when run as root" do
        as_root { expect(@run_mode.public_dir).to eq(File.expand_path(File.join(ENV['ALLUSERSPROFILE'], "PuppetLabs", "puppet", "public"))) }
      end

      it "has publicdir in ~/.puppetlabs/opt/puppet/public when run as non-root" do
        as_non_root { expect(@run_mode.public_dir).to eq(File.expand_path("~/.puppetlabs/opt/puppet/public")) }
      end
    end

    describe "#log_dir" do
      describe "when run as root" do
        it "has logdir ending in PuppetLabs/puppet/var/log" do
          as_root { expect(@run_mode.log_dir).to eq(File.expand_path(File.join(ENV['ALLUSERSPROFILE'], "PuppetLabs", "puppet", "var", "log"))) }
        end
      end

      describe "when run as non-root" do
        it "has default logdir ~/.puppetlabs/var/log" do
          as_non_root { expect(@run_mode.log_dir).to eq(File.expand_path('~/.puppetlabs/var/log')) }
        end
      end
    end

    describe "#run_dir" do
      describe "when run as root" do
        it "has rundir ending in PuppetLabs/puppet/var/run" do
          as_root { expect(@run_mode.run_dir).to eq(File.expand_path(File.join(ENV['ALLUSERSPROFILE'], "PuppetLabs", "puppet", "var", "run"))) }
        end
      end

      describe "when run as non-root" do
        it "has default rundir ~/.puppetlabs/var/run" do
          as_non_root { expect(@run_mode.run_dir).to eq(File.expand_path('~/.puppetlabs/var/run')) }
        end
      end
    end

    describe '#gem_cmd' do
      before do
        allow(ENV).to receive(:fetch).and_call_original
        allow(ENV).to receive(:fetch).with('PUPPET_DIR', nil).and_return(puppetdir)
      end

      context 'when PUPPET_DIR is not set' do
        let(:puppetdir) { nil }

        before do
          allow(Gem).to receive(:default_bindir).and_return('default_gem_bin')
        end

        it 'uses Gem.default_bindir' do
          expected_path = File.join('default_gem_bin', 'gem.bat')
          expect(@run_mode.gem_cmd).to eql(expected_path)
        end
      end

      context 'when PUPPET_DIR is set' do
        let(:puppetdir) { 'puppet_dir' }

        it 'uses Gem.default_bindir' do
          expected_path = File.join('puppet_dir', 'bin', 'gem.bat')
          expect(@run_mode.gem_cmd).to eql(expected_path)
        end
      end
    end

    describe '#common_module_dir' do
      before do
        allow(ENV).to receive(:fetch).and_call_original
        allow(ENV).to receive(:fetch).with('FACTER_env_windows_installdir', nil).and_return(installdir)
      end

      context 'when installdir is not set' do
        let(:installdir) { nil }

        it 'returns nil' do
          expect(@run_mode.common_module_dir).to be(nil)
        end
      end

      context 'with installdir' do
        let(:installdir) { 'C:\Program Files\Puppet Labs\Puppet' }

        it 'returns INSTALLDIR/puppet/modules' do
          expect(@run_mode.common_module_dir).to eq('C:\Program Files\Puppet Labs\Puppet/puppet/modules')
        end
      end
    end

    describe '#vendor_module_dir' do
      before do
        allow(ENV).to receive(:fetch).and_call_original
        allow(ENV).to receive(:fetch).with('FACTER_env_windows_installdir', nil).and_return(installdir)
      end

      context 'when installdir is not set' do
        let(:installdir) { nil }

        it 'returns nil' do
          expect(@run_mode.vendor_module_dir).to be(nil)
        end
      end

      context 'with installdir' do
        let(:installdir) { 'C:\Program Files\Puppet Labs\Puppet' }

        it 'returns INSTALLDIR\puppet\vendor_modules' do
          expect(@run_mode.vendor_module_dir).to eq('C:\Program Files\Puppet Labs\Puppet\puppet\vendor_modules')
        end
      end
    end
  end

  def as_root
    allow(Puppet.features).to receive(:root?).and_return(true)
    yield
  end

  def as_non_root
    allow(Puppet.features).to receive(:root?).and_return(false)
    yield
  end
end