puppetlabs-onceover 5.0.3 → 5.0.4

data/spec/puppetlabs-onceover/deploy_spec.rb

@@ -0,0 +1,246 @@
+require 'spec_helper'
+require 'puppetlabs-onceover/controlrepo'
+require 'puppetlabs-onceover/vendored_modules'
+require 'puppetlabs-onceover/deploy'
+require 'tmpdir'
+require 'fileutils'
+
+describe PuppetlabsOnceover::Deploy do
+  subject(:deploy) { described_class.new }
+
+  # Every test gets its own scratch tempdir standing in for
+  # repo.tempdir/.onceover, cleaned up afterwards so nothing leaks into the
+  # real repo tree.
+  let(:tempdir) { Dir.mktmpdir('deploy-spec-tempdir') }
+
+  after do
+    FileUtils.rm_rf(tempdir)
+  end
+
+  def build_repo(fixture, tempdir_override: tempdir)
+    repo = PuppetlabsOnceover::Controlrepo.new(path: "spec/fixtures/controlrepos/#{fixture}")
+    repo.tempdir = tempdir_override
+    repo
+  end
+
+  describe '#deploy_local' do
+    context 'when the controlrepo has no Puppetfile' do
+      it 'defaults to skipping r10k entirely and still copies the tree' do
+        repo = build_repo('minimal')
+
+        expect(deploy).not_to receive(:system)
+
+        result = deploy.deploy_local(repo, {})
+
+        expect(result).to eq(tempdir)
+        production_dir = "#{tempdir}/#{repo.environmentpath}/production"
+        expect(File.exist?("#{production_dir}/environment.conf")).to be true
+        expect(File.exist?("#{production_dir}/.onceover_manifest.json")).to be true
+      end
+    end
+
+    context 'when skip_r10k is explicitly requested' do
+      it 'copies the tree (including the untouched Puppetfile) but never shells out' do
+        repo = build_repo('basic')
+
+        expect(deploy).not_to receive(:system)
+
+        deploy.deploy_local(repo, { skip_r10k: true })
+
+        production_dir = "#{tempdir}/#{repo.environmentpath}/production"
+        original_puppetfile = File.read('spec/fixtures/controlrepos/basic/Puppetfile')
+        expect(File.read("#{production_dir}/Puppetfile")).to eq(original_puppetfile)
+      end
+    end
+
+    context 'symlinks, directories, and plain files in the controlrepo' do
+      it 'recreates symlinks, directories, and files in the copied tree' do
+        repo = build_repo('deploy_test')
+
+        deploy.deploy_local(repo, { skip_r10k: true })
+
+        production_dir = "#{tempdir}/#{repo.environmentpath}/production"
+        expect(File.symlink?("#{production_dir}/a_symlink")).to be true
+        expect(File.directory?("#{production_dir}/a_dir")).to be true
+        expect(File.read("#{production_dir}/a_dir/nested_file.txt")).to eq("nested\n")
+        expect(File.read("#{production_dir}/regular_file.txt")).to eq("hello\n")
+      end
+    end
+
+    context 'when a modules directory exists in the current working directory' do
+      it 'logs a warning' do
+        repo = build_repo('deploy_test')
+
+        allow(File).to receive(:directory?).and_call_original
+        allow(File).to receive(:directory?).with('modules').and_return(true)
+
+        expect(logger).to receive(:warn).with(/modules directory/)
+
+        deploy.deploy_local(repo, { skip_r10k: true })
+      end
+    end
+
+    context 'when a previous run left an onceover manifest behind' do
+      it 'removes the files listed in the old manifest before copying the new tree' do
+        repo = build_repo('deploy_test')
+        production_dir = "#{tempdir}/#{repo.environmentpath}/production"
+        FileUtils.mkdir_p(production_dir)
+        stale_file = File.join(production_dir, 'stale_leftover.txt')
+        File.write(stale_file, 'leftover')
+        File.write(
+          File.join(production_dir, '.onceover_manifest.json'),
+          ['stale_leftover.txt'].to_json
+        )
+
+        deploy.deploy_local(repo, { skip_r10k: true })
+
+        expect(File.exist?(stale_file)).to be false
+      end
+    end
+
+    context 'when the Puppetfile references :control_branch' do
+      it 'substitutes the current git branch in for :control_branch' do
+        repo = build_repo('control_branch')
+
+        allow(deploy).to receive(:system) do |_cmd|
+          Kernel.system('true')
+          true
+        end
+
+        deploy.deploy_local(repo, { skip_r10k: false })
+
+        production_dir = "#{tempdir}/#{repo.environmentpath}/production"
+        puppetfile_contents = File.read("#{production_dir}/Puppetfile")
+        expect(puppetfile_contents).not_to include(':control_branch')
+        current_branch = `git rev-parse --abbrev-ref HEAD`.chomp
+        expect(puppetfile_contents).to include("'#{current_branch}'")
+      end
+    end
+
+    context 'when auto_vendored is requested' do
+      it 'asks VendoredModules for missing modules and appends them to the Puppetfile' do
+        repo = build_repo('basic')
+
+        vendored_modules_double = instance_double(
+          'PuppetlabsOnceover::VendoredModules',
+          missing_vendored: [{ 'puppetlabs-mymodule' => { git: 'https://example.com/mymodule.git', ref: 'main' } }]
+        )
+        allow(vendored_modules_double).to receive(:puppetfile_missing_vendored)
+        allow(PuppetlabsOnceover::VendoredModules).to receive(:new).and_return(vendored_modules_double)
+
+        allow(deploy).to receive(:system) do |_cmd|
+          Kernel.system('true')
+          true
+        end
+
+        deploy.deploy_local(repo, { skip_r10k: false, auto_vendored: true })
+
+        production_dir = "#{tempdir}/#{repo.environmentpath}/production"
+        puppetfile_contents = File.read("#{production_dir}/Puppetfile")
+        expect(puppetfile_contents).to include('puppetlabs-mymodule')
+        expect(puppetfile_contents).to include('PuppetlabsOnceover Managed Vendored Modules')
+      end
+
+      it 'leaves the Puppetfile untouched when there are no missing vendored modules' do
+        repo = build_repo('basic')
+
+        vendored_modules_double = instance_double(
+          'PuppetlabsOnceover::VendoredModules',
+          missing_vendored: []
+        )
+        allow(vendored_modules_double).to receive(:puppetfile_missing_vendored)
+        allow(PuppetlabsOnceover::VendoredModules).to receive(:new).and_return(vendored_modules_double)
+
+        allow(deploy).to receive(:system) do |_cmd|
+          Kernel.system('true')
+          true
+        end
+
+        deploy.deploy_local(repo, { skip_r10k: false, auto_vendored: true })
+
+        production_dir = "#{tempdir}/#{repo.environmentpath}/production"
+        puppetfile_contents = File.read("#{production_dir}/Puppetfile")
+        expect(puppetfile_contents).not_to include('PuppetlabsOnceover Managed Vendored Modules')
+      end
+    end
+
+    context 'when r10k succeeds' do
+      it 'runs r10k puppetfile install and returns the tempdir, honoring force/config/trace/debug opts' do
+        repo = build_repo('basic')
+        allow(repo).to receive(:r10k_config_file).and_return('/tmp/some-r10k.yaml')
+        logger.level = :debug
+
+        seen_cmd = nil
+        allow(deploy).to receive(:system) do |cmd|
+          seen_cmd = cmd
+          Kernel.system('true')
+          true
+        end
+
+        result = deploy.deploy_local(repo, { skip_r10k: false, force: true, trace: true })
+
+        expect(result).to eq(tempdir)
+        expect(seen_cmd).to include('r10k puppetfile install --color')
+        expect(seen_cmd).to include('--force')
+        expect(seen_cmd).to include('--config /tmp/some-r10k.yaml')
+        expect(seen_cmd).to include('--trace')
+        expect(seen_cmd).to include('--verbose debug')
+
+        logger.level = :info
+      end
+
+      it 'passes plain --verbose (not --verbose debug) when the logger is above debug level' do
+        repo = build_repo('basic')
+        logger.level = :info
+
+        seen_cmd = nil
+        allow(deploy).to receive(:system) do |cmd|
+          seen_cmd = cmd
+          Kernel.system('true')
+          true
+        end
+
+        deploy.deploy_local(repo, { skip_r10k: false })
+
+        expect(seen_cmd).to match(/--verbose(?! debug)/)
+      end
+    end
+
+    context 'when r10k fails' do
+      it 'raises an error' do
+        repo = build_repo('basic')
+
+        allow(deploy).to receive(:system) do |_cmd|
+          Kernel.system('false')
+          false
+        end
+
+        expect { deploy.deploy_local(repo, { skip_r10k: false }) }.to raise_error(
+          'r10k could not install all required modules'
+        )
+      end
+    end
+
+    context 'when repo.tempdir is nil' do
+      it 'creates a fresh tempdir via Dir.mktmpdir' do
+        repo = build_repo('minimal', tempdir_override: nil)
+
+        result = deploy.deploy_local(repo, {})
+
+        expect(result).not_to be_nil
+        expect(File.directory?(result)).to be true
+        FileUtils.rm_rf(result)
+      end
+    end
+
+    # NOTE: the `else raise "#{repo.tempdir} is not a directory"` branch
+    # (deploy.rb, just after `if File.directory?(repo.tempdir)`) is left
+    # uncovered. Reaching it legitimately requires repo.tempdir to vanish
+    # between the copy step a few lines above and this check, and stubbing
+    # File.directory?(repo.tempdir) to force it false also fools FileUtils'
+    # own internal use of File.directory? earlier in the method (it calls
+    # mkdir_p on a path it now believes doesn't exist, which raises
+    # Errno::EEXIST instead of reaching the intended branch). Not worth
+    # fighting with a source change out of scope for this test pass.
+  end
+end

data/spec/puppetlabs-onceover/group_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+require 'puppetlabs-onceover/group'
+require 'puppetlabs-onceover/class'
+require 'puppetlabs-onceover/node'
+require 'puppetlabs-onceover/testconfig'
+require 'puppetlabs-onceover/controlrepo'
+
+describe "PuppetlabsOnceover::Group" do
+  before(:each) do
+    PuppetlabsOnceover::Class.class_variable_set(:@@all, [])
+    PuppetlabsOnceover::Node.class_variable_set(:@@all, [])
+    PuppetlabsOnceover::Group.class_variable_set(:@@all, [])
+    PuppetlabsOnceover::Test.class_variable_set(:@@all, [])
+    logger.level = :fatal
+    PuppetlabsOnceover::Controlrepo.new(path: 'spec/fixtures/controlrepos/factsets')
+  end
+
+  describe "#initialize" do
+    it "accepts a ready-made list of Class objects as-is" do
+      a = PuppetlabsOnceover::Class.new('role::a')
+      b = PuppetlabsOnceover::Class.new('role::b')
+      group = PuppetlabsOnceover::Group.new('my_classes', [a, b])
+      expect(group.name).to eq('my_classes')
+      expect(group.members).to eq([a, b])
+    end
+
+    it "accepts a ready-made list of Node objects as-is" do
+      a = PuppetlabsOnceover::Node.new('node_a')
+      b = PuppetlabsOnceover::Node.new('node_b')
+      group = PuppetlabsOnceover::Group.new('my_nodes', [a, b])
+      expect(group.members).to eq([a, b])
+    end
+
+    it "defaults to an empty member list when members is nil" do
+      group = PuppetlabsOnceover::Group.new('empty_group', nil)
+      expect(group.members).to eq([])
+    end
+
+    it "resolves a hash into a subtractive include/exclude list via TestConfig.subtractive_to_list" do
+      a = PuppetlabsOnceover::Node.new('node_a')
+      b = PuppetlabsOnceover::Node.new('node_b')
+      PuppetlabsOnceover::Group.new('all_nodes', [a, b])
+      PuppetlabsOnceover::Group.new('excluded', [b])
+
+      group = PuppetlabsOnceover::Group.new('subtractive', { 'include' => 'all_nodes', 'exclude' => 'excluded' })
+      expect(group.members).to eq([a])
+    end
+
+    it "resolves a list of names/groups into member objects, flattening nested groups" do
+      a = PuppetlabsOnceover::Node.new('node_a')
+      b = PuppetlabsOnceover::Node.new('node_b')
+      PuppetlabsOnceover::Group.new('inner', [a])
+
+      group = PuppetlabsOnceover::Group.new('outer', %w[inner node_b])
+      expect(group.members).to eq([a, b])
+    end
+
+    it "raises when a resolved member list mixes classes and nodes" do
+      PuppetlabsOnceover::Class.new('role::a')
+      PuppetlabsOnceover::Node.new('node_a')
+
+      expect do
+        PuppetlabsOnceover::Group.new('mixed', ['role::a', 'node_a'])
+      end.to raise_error(RuntimeError, /must contain either all nodes or all classes/)
+    end
+
+    it "adds itself to .all" do
+      group = PuppetlabsOnceover::Group.new('g', nil)
+      expect(PuppetlabsOnceover::Group.all).to eq([group])
+    end
+  end
+
+  describe ".find" do
+    it "finds a group by name" do
+      group = PuppetlabsOnceover::Group.new('g', nil)
+      expect(PuppetlabsOnceover::Group.find('g')).to eq(group)
+    end
+
+    it "returns nil when no group matches" do
+      expect(PuppetlabsOnceover::Group.find('nope')).to be_nil
+    end
+  end
+
+  describe ".all" do
+    it "returns every group created so far" do
+      a = PuppetlabsOnceover::Group.new('a', nil)
+      b = PuppetlabsOnceover::Group.new('b', nil)
+      expect(PuppetlabsOnceover::Group.all).to eq([a, b])
+    end
+  end
+
+  describe ".valid_members?" do
+    it "is true for an all-Class list" do
+      a = PuppetlabsOnceover::Class.new('role::a')
+      expect(PuppetlabsOnceover::Group.valid_members?([a])).to eq(true)
+    end
+
+    it "is true for an all-Node list" do
+      a = PuppetlabsOnceover::Node.new('node_a')
+      expect(PuppetlabsOnceover::Group.valid_members?([a])).to eq(true)
+    end
+
+    it "is false for a mixed list" do
+      a = PuppetlabsOnceover::Class.new('role::a')
+      b = PuppetlabsOnceover::Node.new('node_a')
+      expect(PuppetlabsOnceover::Group.valid_members?([a, b])).to eq(false)
+    end
+
+    it "is false for an empty list (all? on empty is true for the Class check, so this actually documents current behavior)" do
+      expect(PuppetlabsOnceover::Group.valid_members?([])).to eq(true)
+    end
+
+    it "rescues any StandardError raised while checking and returns false" do
+      exploding = Object.new
+      def exploding.is_a?(*)
+        raise StandardError, 'boom'
+      end
+      expect(PuppetlabsOnceover::Group.valid_members?([exploding])).to eq(false)
+    end
+  end
+end

data/spec/puppetlabs-onceover/logger_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'puppetlabs-onceover/logger'
+
+describe PuppetlabsOnceover::Logger do
+  let(:includer) do
+    Class.new do
+      include PuppetlabsOnceover::Logger
+    end.new
+  end
+
+  before(:each) do
+    $logger = nil
+  end
+
+  after(:each) do
+    $logger = nil
+  end
+
+  it 'lazily builds a Logging logger with a stdout appender on first call' do
+    logger = includer.logger
+    expect(logger).to eq(Logging.logger['Colors'])
+    expect(Logging::LNAMES[logger.level]).to eq('INFO')
+  end
+
+  it 'memoizes the logger across calls' do
+    first = includer.logger
+    second = includer.logger
+    expect(first).to equal(second)
+  end
+end

data/spec/puppetlabs-onceover/node_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+require 'puppetlabs-onceover/node'
+require 'puppetlabs-onceover/controlrepo'
+
+describe "PuppetlabsOnceover::Node" do
+  before(:each) do
+    PuppetlabsOnceover::Node.class_variable_set(:@@all, [])
+    logger.level = :fatal
+  end
+
+  describe "#initialize" do
+    context "when the controlrepo's factsets can be found" do
+      before(:each) do
+        PuppetlabsOnceover::Controlrepo.new(path: 'spec/fixtures/controlrepos/factsets')
+      end
+
+      it "sets the name and a nil beaker_node" do
+        node = PuppetlabsOnceover::Node.new('centos7_notrusted')
+        expect(node.name).to eq('centos7_notrusted')
+        expect(node.beaker_node).to be_nil
+      end
+
+      it "loads the fact_set from the matching factset file" do
+        node = PuppetlabsOnceover::Node.new('centos7_notrusted')
+        expect(node.fact_set).to be_a(Hash)
+        expect(node.fact_set['operatingsystem']).to eq('CentOS')
+      end
+
+      it "strips the 'environment' key out of the fact_set via clean_facts" do
+        node = PuppetlabsOnceover::Node.new('centos_with_env')
+        expect(node.fact_set).not_to have_key('environment')
+      end
+
+      it "finds a top-level 'trusted' hash for trusted_set" do
+        node = PuppetlabsOnceover::Node.new('centos7_trusted_extensions_top')
+        expect(node.trusted_set).to eq({ 'pp_datacenter' => 'PDX' })
+      end
+
+      it "falls back to a nested trusted.extensions hash for trusted_set when no top-level trusted hash exists" do
+        node = PuppetlabsOnceover::Node.new('centos7_trusted_extensions_nested')
+        expect(node.trusted_set).to be_a(Hash)
+      end
+
+      it "falls back to an empty hash for trusted_set when neither is present" do
+        node = PuppetlabsOnceover::Node.new('centos7_notrusted')
+        expect(node.trusted_set).to eq({})
+      end
+
+      it "falls back to a nested trusted.external hash for trusted_external_set when no top-level trusted_external hash exists" do
+        node = PuppetlabsOnceover::Node.new('centos7_trusted_external_nested')
+        expect(node.trusted_external_set).to be_a(Hash)
+      end
+
+      it "falls back to an empty hash for trusted_external_set when neither is present" do
+        node = PuppetlabsOnceover::Node.new('centos7_notrusted')
+        expect(node.trusted_external_set).to eq({})
+      end
+
+      it "adds itself to .all" do
+        node = PuppetlabsOnceover::Node.new('centos7_notrusted')
+        expect(PuppetlabsOnceover::Node.all).to eq([node])
+      end
+    end
+
+    context "when no factset matches the given name" do
+      before(:each) do
+        PuppetlabsOnceover::Controlrepo.new(path: 'spec/fixtures/controlrepos/factsets')
+      end
+
+      # facts_file_index comes back nil, so PuppetlabsOnceover::Controlrepo.facts[nil]
+      # raises TypeError -- this is the rescue branch that defaults everything to {}
+      it "rescues the TypeError and defaults fact_set/trusted_set/trusted_external_set to {}" do
+        node = PuppetlabsOnceover::Node.new('no_such_factset_anywhere')
+        expect(node.fact_set).to eq({})
+        expect(node.trusted_set).to eq({})
+        expect(node.trusted_external_set).to eq({})
+      end
+    end
+  end
+
+  describe ".find" do
+    before(:each) do
+      PuppetlabsOnceover::Controlrepo.new(path: 'spec/fixtures/controlrepos/factsets')
+    end
+
+    it "finds a node by name" do
+      node = PuppetlabsOnceover::Node.new('centos7_notrusted')
+      expect(PuppetlabsOnceover::Node.find('centos7_notrusted')).to eq(node)
+    end
+
+    it "returns the same node object when passed a Node instance" do
+      node = PuppetlabsOnceover::Node.new('centos7_notrusted')
+      expect(PuppetlabsOnceover::Node.find(node)).to eq(node)
+    end
+
+    it "returns nil (and warns) when nothing matches" do
+      expect(PuppetlabsOnceover::Node.find('nonexistent')).to be_nil
+    end
+  end
+
+  describe ".all" do
+    before(:each) do
+      PuppetlabsOnceover::Controlrepo.new(path: 'spec/fixtures/controlrepos/factsets')
+    end
+
+    it "returns every node created so far" do
+      a = PuppetlabsOnceover::Node.new('centos7_notrusted')
+      b = PuppetlabsOnceover::Node.new('centos_with_env')
+      expect(PuppetlabsOnceover::Node.all).to eq([a, b])
+    end
+  end
+
+  describe ".clean_facts" do
+    it "deletes the 'environment' key and returns the factset" do
+      factset = { 'environment' => 'production', 'foo' => 'bar' }
+      expect(PuppetlabsOnceover::Node.clean_facts(factset)).to eq({ 'foo' => 'bar' })
+    end
+
+    it "is a no-op when there is no 'environment' key" do
+      factset = { 'foo' => 'bar' }
+      expect(PuppetlabsOnceover::Node.clean_facts(factset)).to eq({ 'foo' => 'bar' })
+    end
+  end
+end