puppet 7.27.0-x64-mingw32 → 7.29.0-x64-mingw32

data/spec/unit/transaction/resource_harness_spec.rb

@@ -1,625 +0,0 @@
-require 'spec_helper'
-
-require 'puppet/transaction/resource_harness'
-
-describe Puppet::Transaction::ResourceHarness do
-  include PuppetSpec::Files
-
-  before do
-    @mode_750 = Puppet::Util::Platform.windows? ? '644' : '750'
-    @mode_755 = Puppet::Util::Platform.windows? ? '644' : '755'
-    path = make_absolute("/my/file")
-
-    @transaction = Puppet::Transaction.new(Puppet::Resource::Catalog.new, nil, nil)
-    @resource = Puppet::Type.type(:file).new :path => path
-    @harness = Puppet::Transaction::ResourceHarness.new(@transaction)
-    @current_state = Puppet::Resource.new(:file, path)
-    allow(@resource).to receive(:retrieve).and_return(@current_state)
-  end
-
-  it "should accept a transaction at initialization" do
-    harness = Puppet::Transaction::ResourceHarness.new(@transaction)
-    expect(harness.transaction).to equal(@transaction)
-  end
-
-  it "should delegate to the transaction for its relationship graph" do
-    expect(@transaction).to receive(:relationship_graph).and_return("relgraph")
-    expect(Puppet::Transaction::ResourceHarness.new(@transaction).relationship_graph).to eq("relgraph")
-  end
-
-  describe "when evaluating a resource" do
-    it "produces a resource state that describes what happened with the resource" do
-      status = @harness.evaluate(@resource)
-
-      expect(status.resource).to eq(@resource.ref)
-      expect(status).not_to be_failed
-      expect(status.events).to be_empty
-    end
-
-    it "retrieves the current state of the resource" do
-      expect(@resource).to receive(:retrieve).and_return(@current_state)
-
-      @harness.evaluate(@resource)
-    end
-
-    it "produces a failure status for the resource when an error occurs" do
-      the_message = "retrieve failed in testing"
-      expect(@resource).to receive(:retrieve).and_raise(ArgumentError.new(the_message))
-
-      status = @harness.evaluate(@resource)
-
-      expect(status).to be_failed
-      expect(events_to_hash(status.events).collect do |event|
-        { :@status => event[:@status], :@message => event[:@message] }
-      end).to eq([{ :@status => "failure", :@message => the_message }])
-    end
-
-    it "records the time it took to evaluate the resource" do
-      before = Time.now
-      status = @harness.evaluate(@resource)
-      after = Time.now
-
-      expect(status.evaluation_time).to be <= after - before
-    end
-  end
-
-  def events_to_hash(events)
-    events.map do |event|
-      hash = {}
-      event.instance_variables.each do |varname|
-        hash[varname.to_sym] = event.instance_variable_get(varname)
-      end
-      hash
-    end
-  end
-
-  def make_stub_provider
-    stubProvider = Class.new(Puppet::Type)
-    stubProvider.instance_eval do
-      initvars
-
-      newparam(:name) do
-        desc "The name var"
-        isnamevar
-      end
-
-      newproperty(:foo) do
-        desc "A property that can be changed successfully"
-        def sync
-        end
-
-        def retrieve
-          :absent
-        end
-
-        def insync?(reference_value)
-          false
-        end
-      end
-
-      newproperty(:bar) do
-        desc "A property that raises an exception when you try to change it"
-        def sync
-          raise ZeroDivisionError.new('bar')
-        end
-
-        def retrieve
-          :absent
-        end
-
-        def insync?(reference_value)
-          false
-        end
-      end
-
-      newproperty(:baz) do
-        desc "A property that raises an Exception (not StandardError) when you try to change it"
-        def sync
-          raise Exception.new('baz')
-        end
-
-        def retrieve
-          :absent
-        end
-
-        def insync?(reference_value)
-          false
-        end
-      end
-
-      newproperty(:brillig) do
-        desc "A property that raises a StandardError exception when you test if it's insync?"
-        def sync
-        end
-
-        def retrieve
-          :absent
-        end
-
-        def insync?(reference_value)
-          raise ZeroDivisionError.new('brillig')
-        end
-      end
-
-      newproperty(:slithy) do
-        desc "A property that raises an Exception when you test if it's insync?"
-        def sync
-        end
-
-        def retrieve
-          :absent
-        end
-
-        def insync?(reference_value)
-          raise Exception.new('slithy')
-        end
-      end
-    end
-    stubProvider
-  end
-
-
-  context "interaction of ensure with other properties" do
-    def an_ensurable_resource_reacting_as(behaviors)
-      stub_type = Class.new(Puppet::Type)
-      stub_type.class_eval do
-        initvars
-        ensurable do
-          def sync
-            (@resource.behaviors[:on_ensure] || proc {}).call
-          end
-
-          def insync?(value)
-            @resource.behaviors[:ensure_insync?]
-          end
-
-          def should_to_s(value)
-            (@resource.behaviors[:on_should_to_s] || proc { "'#{value}'" }).call
-          end
-        end
-
-        newparam(:name) do
-          desc "The name var"
-          isnamevar
-        end
-
-        newproperty(:prop) do
-          newvalue("new") do
-            #noop
-          end
-
-          def retrieve
-            "old"
-          end
-        end
-
-        attr_reader :behaviors
-
-        def initialize(options)
-          @behaviors = options.delete(:behaviors)
-          super
-        end
-
-        def exists?
-          @behaviors[:present?]
-        end
-
-        def present?(resource)
-          @behaviors[:present?]
-        end
-
-        def self.name
-          "Testing"
-        end
-      end
-      stub_type.new(:behaviors => behaviors,
-                    :ensure => :present,
-                    :name => "testing",
-                    :prop => "new")
-    end
-
-    it "ensure errors means that the rest doesn't happen" do
-      resource = an_ensurable_resource_reacting_as(:ensure_insync? => false, :on_ensure => proc { raise StandardError }, :present? => true)
-
-      status = @harness.evaluate(resource)
-
-      expect(status.events.length).to eq(1)
-      expect(status.events[0].property).to eq('ensure')
-      expect(status.events[0].name.to_s).to eq('Testing_created')
-      expect(status.events[0].status).to eq('failure')
-    end
-
-    it "ensure fails completely means that the rest doesn't happen" do
-      resource = an_ensurable_resource_reacting_as(:ensure_insync? => false, :on_ensure => proc { raise Exception }, :present? => false)
-
-      expect do
-        @harness.evaluate(resource)
-      end.to raise_error(Exception)
-
-      expect(@logs.first.message).to eq("change from 'absent' to 'present' failed: Exception")
-      expect(@logs.first.level).to eq(:err)
-    end
-
-    it "ensure succeeds means that the rest doesn't happen" do
-      resource = an_ensurable_resource_reacting_as(:ensure_insync? => false, :on_ensure => proc { }, :present? => true)
-
-      status = @harness.evaluate(resource)
-
-      expect(status.events.length).to eq(1)
-      expect(status.events[0].property).to eq('ensure')
-      expect(status.events[0].name.to_s).to eq('Testing_created')
-      expect(status.events[0].status).to eq('success')
-    end
-
-    it "ensure is in sync means that the rest *does* happen" do
-      resource = an_ensurable_resource_reacting_as(:ensure_insync? => true, :present? => true)
-
-      status = @harness.evaluate(resource)
-
-      expect(status.events.length).to eq(1)
-      expect(status.events[0].property).to eq('prop')
-      expect(status.events[0].name.to_s).to eq('prop_changed')
-      expect(status.events[0].status).to eq('success')
-    end
-
-    it "ensure is in sync but resource not present, means that the rest doesn't happen" do
-      resource = an_ensurable_resource_reacting_as(:ensure_insync? => true, :present? => false)
-
-      status = @harness.evaluate(resource)
-
-      expect(status.events).to be_empty
-    end
-
-    it "ensure errors in message still get a log entry" do
-      resource = an_ensurable_resource_reacting_as(:ensure_insync? => false, :on_ensure => proc { raise StandardError }, :on_should_to_s => proc { raise StandardError }, :present? => true)
-
-      status = @harness.evaluate(resource)
-
-      expect(status.events.length).to eq(2)
-      testing_errors = status.events.find_all { |x| x.name.to_s == "Testing_created" }
-      resource_errors = status.events.find_all { |x| x.name.to_s == "resource_error" }
-      expect(testing_errors.length).to eq(1)
-      expect(resource_errors.length).to eq(1)
-      expect(testing_errors[0].message).not_to be_nil
-      expect(resource_errors[0].message).not_to eq("Puppet::Util::Log requires a message")
-    end
-  end
-
-  describe "when a caught error occurs" do
-    before :each do
-      stub_provider = make_stub_provider
-      resource = stub_provider.new :name => 'name', :foo => 1, :bar => 2
-      expect(resource).not_to receive(:err)
-      @status = @harness.evaluate(resource)
-    end
-
-    it "should record previous successful events" do
-      expect(@status.events[0].property).to eq('foo')
-      expect(@status.events[0].status).to eq('success')
-    end
-
-    it "should record a failure event" do
-      expect(@status.events[1].property).to eq('bar')
-      expect(@status.events[1].status).to eq('failure')
-    end
-  end
-
-  describe "when an Exception occurs during sync" do
-    before :each do
-      stub_provider = make_stub_provider
-      @resource = stub_provider.new :name => 'name', :baz => 1
-      expect(@resource).not_to receive(:err)
-    end
-
-    it "should log and pass the exception through" do
-      expect { @harness.evaluate(@resource) }.to raise_error(Exception, /baz/)
-      expect(@logs.first.message).to eq("change from 'absent' to 1 failed: baz")
-      expect(@logs.first.level).to eq(:err)
-    end
-  end
-
-  describe "when a StandardError exception occurs during insync?" do
-    before :each do
-      stub_provider = make_stub_provider
-      @resource = stub_provider.new :name => 'name', :brillig => 1
-      expect(@resource).not_to receive(:err)
-    end
-
-    it "should record a failure event" do
-      @status = @harness.evaluate(@resource)
-      expect(@status.events[0].name.to_s).to eq('brillig_changed')
-      expect(@status.events[0].property).to eq('brillig')
-      expect(@status.events[0].status).to eq('failure')
-    end
-  end
-
-  describe "when an Exception occurs during insync?" do
-    before :each do
-      stub_provider = make_stub_provider
-      @resource = stub_provider.new :name => 'name', :slithy => 1
-      expect(@resource).not_to receive(:err)
-    end
-
-    it "should log and pass the exception through" do
-      expect { @harness.evaluate(@resource) }.to raise_error(Exception, /slithy/)
-      expect(@logs.first.message).to eq("change from 'absent' to 1 failed: slithy")
-      expect(@logs.first.level).to eq(:err)
-    end
-  end
-
-  describe "when auditing" do
-    it "should not call insync? on parameters that are merely audited" do
-      stub_provider = make_stub_provider
-      resource = stub_provider.new :name => 'name', :audit => ['foo']
-      expect(resource.property(:foo)).not_to receive(:insync?)
-      status = @harness.evaluate(resource)
-
-      expect(status.events).to be_empty
-    end
-
-    it "should be able to audit a file's group" do # see bug #5710
-      test_file = tmpfile('foo')
-      File.open(test_file, 'w').close
-      resource = Puppet::Type.type(:file).new :path => test_file, :audit => ['group'], :backup => false
-      expect(resource).not_to receive(:err) # make sure no exceptions get swallowed
-
-      status = @harness.evaluate(resource)
-
-      status.events.each do |event|
-        expect(event.status).to != 'failure'
-      end
-    end
-
-    it "should not ignore microseconds when auditing a file's mtime" do
-      test_file = tmpfile('foo')
-      File.open(test_file, 'w').close
-      resource = Puppet::Type.type(:file).new :path => test_file, :audit => ['mtime'], :backup => false
-
-      # construct a property hash with nanosecond resolution as would be
-      # found on an ext4 file system
-      time_with_nsec_resolution = Time.at(1000, 123456.999)
-      current_from_filesystem    = {:mtime => time_with_nsec_resolution}
-
-      # construct a property hash with a 1 microsecond difference from above
-      time_with_usec_resolution = Time.at(1000, 123457.000)
-      historical_from_state_yaml = {:mtime => time_with_usec_resolution}
-
-      # set up the sequence of stubs; yeah, this is pretty
-      # brittle, so this might need to be adjusted if the
-      # resource_harness logic changes
-      expect(resource).to receive(:retrieve).and_return(current_from_filesystem)
-      allow(Puppet::Util::Storage).to receive(:cache).with(resource).
-        and_return(historical_from_state_yaml, current_from_filesystem, current_from_filesystem)
-
-      # there should be an audit change recorded, since the two
-      # timestamps differ by at least 1 microsecond
-      status = @harness.evaluate(resource)
-      expect(status.events).not_to be_empty
-      status.events.each do |event|
-        expect(event.message).to match(/audit change: previously recorded/)
-      end
-    end
-
-    it "should ignore nanoseconds when auditing a file's mtime" do
-      test_file = tmpfile('foo')
-      File.open(test_file, 'w').close
-      resource = Puppet::Type.type(:file).new :path => test_file, :audit => ['mtime'], :backup => false
-
-      # construct a property hash with nanosecond resolution as would be
-      # found on an ext4 file system
-      time_with_nsec_resolution = Time.at(1000, 123456.789)
-      current_from_filesystem    = {:mtime => time_with_nsec_resolution}
-
-      # construct a property hash with the same timestamp as above,
-      # truncated to microseconds, as would be read back from state.yaml
-      time_with_usec_resolution = Time.at(1000, 123456.000)
-      historical_from_state_yaml = {:mtime => time_with_usec_resolution}
-
-      # set up the sequence of stubs; yeah, this is pretty
-      # brittle, so this might need to be adjusted if the
-      # resource_harness logic changes
-      expect(resource).to receive(:retrieve).and_return(current_from_filesystem)
-      allow(Puppet::Util::Storage).to receive(:cache).with(resource).
-        and_return(historical_from_state_yaml, current_from_filesystem, current_from_filesystem)
-
-      # there should be no audit change recorded, despite the
-      # slight difference in the two timestamps
-      status = @harness.evaluate(resource)
-      status.events.each do |event|
-        expect(event.message).not_to match(/audit change: previously recorded/)
-      end
-    end
-  end
-
-  describe "handling sensitive properties" do
-    describe 'when syncing' do
-      let(:test_file) do
-        tmpfile('foo').tap do |path|
-          File.open(path, 'w') { |fh| fh.write("goodbye world") }
-        end
-      end
-
-      let(:resource) do
-        Puppet::Type.type(:file).new(:path => test_file, :backup => false, :content => "hello world").tap do |r|
-          r.parameter(:content).sensitive = true
-        end
-      end
-
-      it "redacts event messages for sensitive properties" do
-        status = @harness.evaluate(resource)
-        sync_event = status.events[0]
-        expect(sync_event.message).to eq 'changed [redacted] to [redacted]'
-      end
-
-      it "redacts event contents for sensitive properties" do
-        status = @harness.evaluate(resource)
-        sync_event = status.events[0]
-        expect(sync_event.previous_value).to eq '[redacted]'
-        expect(sync_event.desired_value).to eq '[redacted]'
-      end
-
-      it "redacts event messages for sensitive properties when simulating noop changes" do
-        resource[:noop] = true
-        status = @harness.evaluate(resource)
-        sync_event = status.events[0]
-        expect(sync_event.message).to eq 'current_value [redacted], should be [redacted] (noop)'
-      end
-
-      describe 'auditing' do
-        before do
-          resource[:audit] = ['content']
-        end
-
-        it "redacts notices when a parameter is newly audited" do
-          expect(resource.property(:content)).to receive(:notice).with("audit change: newly-recorded value [redacted]")
-          @harness.evaluate(resource)
-        end
-
-        it "redacts event messages for sensitive properties" do
-          allow(Puppet::Util::Storage).to receive(:cache).with(resource).and_return({:content => "historical world"})
-          status = @harness.evaluate(resource)
-          sync_event = status.events[0]
-          expect(sync_event.message).to eq 'changed [redacted] to [redacted] (previously recorded value was [redacted])'
-        end
-
-        it "redacts audit event messages for sensitive properties when simulating noop changes" do
-          allow(Puppet::Util::Storage).to receive(:cache).with(resource).and_return({:content => "historical world"})
-          resource[:noop] = true
-          status = @harness.evaluate(resource)
-          sync_event = status.events[0]
-          expect(sync_event.message).to eq 'current_value [redacted], should be [redacted] (noop) (previously recorded value was [redacted])'
-        end
-
-        it "redacts event contents for sensitive properties" do
-          allow(Puppet::Util::Storage).to receive(:cache).with(resource).and_return({:content => "historical world"})
-          status = @harness.evaluate(resource)
-          sync_event = status.events[0]
-          expect(sync_event.historical_value).to eq '[redacted]'
-        end
-      end
-    end
-
-    describe 'handling errors' do
-      it "redacts event messages generated when syncing a param raises a StandardError" do
-        stub_provider = make_stub_provider
-        resource = stub_provider.new :name => 'name', :bar => 1
-        resource.parameter(:bar).sensitive = true
-        status = @harness.evaluate(resource)
-
-        error_event = status.events[0]
-        expect(error_event.message).to eq "change from [redacted] to [redacted] failed: bar"
-      end
-
-      it "redacts event messages generated when syncing a param raises an Exception" do
-        stub_provider = make_stub_provider
-        resource = stub_provider.new :name => 'name', :baz => 1
-        resource.parameter(:baz).sensitive = true
-
-        expect { @harness.evaluate(resource) }.to raise_error(Exception, 'baz')
-
-        expect(@logs.first.message).to eq "change from [redacted] to [redacted] failed: baz"
-      end
-    end
-  end
-
-  describe "when finding the schedule" do
-    before do
-      @catalog = Puppet::Resource::Catalog.new
-      @resource.catalog = @catalog
-    end
-
-    it "should warn and return nil if the resource has no catalog" do
-      @resource.catalog = nil
-      expect(@resource).to receive(:warning)
-
-      expect(@harness.schedule(@resource)).to be_nil
-    end
-
-    it "should return nil if the resource specifies no schedule" do
-      expect(@harness.schedule(@resource)).to be_nil
-    end
-
-    it "should fail if the named schedule cannot be found" do
-      @resource[:schedule] = "whatever"
-      expect(@resource).to receive(:fail)
-      @harness.schedule(@resource)
-    end
-
-    it "should return the named schedule if it exists" do
-      sched = Puppet::Type.type(:schedule).new(:name => "sched")
-      @catalog.add_resource(sched)
-      @resource[:schedule] = "sched"
-      expect(@harness.schedule(@resource).to_s).to eq(sched.to_s)
-    end
-  end
-
-  describe "when determining if a resource is scheduled" do
-    before do
-      @catalog = Puppet::Resource::Catalog.new
-      @resource.catalog = @catalog
-    end
-
-    it "should return true if 'ignoreschedules' is set" do
-      Puppet[:ignoreschedules] = true
-      @resource[:schedule] = "meh"
-      expect(@harness).to be_scheduled(@resource)
-    end
-
-    it "should return true if the resource has no schedule set" do
-      expect(@harness).to be_scheduled(@resource)
-    end
-
-    it "should return the result of matching the schedule with the cached 'checked' time if a schedule is set" do
-      t = Time.now
-      expect(@harness).to receive(:cached).with(@resource, :checked).and_return(t)
-
-      sched = Puppet::Type.type(:schedule).new(:name => "sched")
-      @catalog.add_resource(sched)
-      @resource[:schedule] = "sched"
-
-      expect(sched).to receive(:match?).with(t.to_i).and_return("feh")
-
-      expect(@harness.scheduled?(@resource)).to eq("feh")
-    end
-  end
-
-  it "should be able to cache data in the Storage module" do
-    data = {}
-    expect(Puppet::Util::Storage).to receive(:cache).with(@resource).and_return(data)
-    @harness.cache(@resource, :foo, "something")
-
-    expect(data[:foo]).to eq("something")
-  end
-
-  it "should be able to retrieve data from the cache" do
-    data = {:foo => "other"}
-    expect(Puppet::Util::Storage).to receive(:cache).with(@resource).and_return(data)
-    expect(@harness.cached(@resource, :foo)).to eq("other")
-  end
-
-  describe "successful event message" do
-    let(:test_file) do
-      tmpfile('foo').tap do |path|
-        File.open(path, 'w') { |fh| fh.write("old contents") }
-      end
-    end
-
-    let(:resource) do
-      Puppet::Type.type(:file).new(:path => test_file, :backup => false, :content => "hello world")
-    end
-
-    it "contains (corrective) when corrective change" do
-      allow_any_instance_of(Puppet::Transaction::Event).to receive(:corrective_change).and_return(true)
-      status = @harness.evaluate(resource)
-      sync_event = status.events[0]
-      expect(sync_event.message).to match(/content changed '{sha256}[0-9a-f]+' to '{sha256}[0-9a-f]+' \(corrective\)/)
-    end
-
-    it "contains no modifier when intentional change" do
-      allow_any_instance_of(Puppet::Transaction::Event).to receive(:corrective_change).and_return(false)
-      status = @harness.evaluate(resource)
-      sync_event = status.events[0]
-      expect(sync_event.message).to match(/content changed '{sha256}[0-9a-f]+' to '{sha256}[0-9a-f]+'$/)
-    end
-  end
-end