Add tests for current provider.get call behavior

Author: seanmil

spec/acceptance/get_calls_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'tempfile'
+
+RSpec.describe 'minimizing provider get calls' do
+  let(:common_args) { '--verbose --trace --strict=error --modulepath spec/fixtures' }
+
+  describe 'using `puppet resource` with a basic type' do
+    it 'calls get 1 time' do
+      stdout_str, status = Open3.capture2e("puppet resource #{common_args} test_get_calls_basic")
+      expect(stdout_str).to match %r{Notice: test_get_calls_basic: Provider get called 1 times}
+      expect(stdout_str).not_to match %r{Notice: test_get_calls_basic: Provider get called 2 times}
+      expect(status).to eq 0
+    end
+  end
+
+  describe 'using `puppet apply` with a basic type' do
+    it 'calls get 2 times' do
+      stdout_str, _status = Open3.capture2e("puppet apply #{common_args} -e \"test_get_calls_basic { foo: } test_get_calls_basic { bar: }\"")
+      expect(stdout_str).to match %r{Notice: test_get_calls_basic: Provider get called 1 times}
+      expect(stdout_str).to match %r{Notice: test_get_calls_basic: Provider get called 2 times}
+      expect(stdout_str).not_to match %r{Notice: test_get_calls_basic: Provider get called 3 times}
+      expect(stdout_str).not_to match %r{Creating}
+    end
+
+    it 'calls get 3 times with resource purging' do
+      stdout_str, _status = Open3.capture2e("puppet apply #{common_args} -e \"test_get_calls_basic { foo: } test_get_calls_basic { bar: } resources { test_get_calls_basic: purge => true }\"")
+      expect(stdout_str).to match %r{Notice: test_get_calls_basic: Provider get called 1 times}
+      expect(stdout_str).to match %r{Notice: test_get_calls_basic: Provider get called 2 times}
+      expect(stdout_str).to match %r{Notice: test_get_calls_basic: Provider get called 3 times}
+      expect(stdout_str).not_to match %r{Notice: test_get_calls_basic: Provider get called 4 times}
+      expect(stdout_str).not_to match %r{Creating}
+    end
+  end
+
+  describe 'using `puppet resource` with a simple_get_filter type' do
+    it 'calls get 1 time' do
+      stdout_str, status = Open3.capture2e("puppet resource #{common_args} test_get_calls_sgf")
+      expect(stdout_str).to match %r{Notice: test_get_calls_sgf: Provider get called 1 times}
+      expect(stdout_str).not_to match %r{Notice: test_get_calls_sgf: Provider get called 2 times}
+      expect(status.exitstatus).to be_zero
+    end
+  end
+
+  describe 'using `puppet apply` with a type using simple_get_filter' do
+    it 'calls get 2 times' do
+      stdout_str, _status = Open3.capture2e("puppet apply #{common_args} -e \"test_get_calls_sgf { foo: } test_get_calls_sgf { bar: }\"")
+      expect(stdout_str).to match %r{Notice: test_get_calls_sgf: Provider get called 1 times}
+      expect(stdout_str).to match %r{Notice: test_get_calls_sgf: Provider get called 2 times}
+      expect(stdout_str).not_to match %r{Notice: test_get_calls_sgf: Provider get called 3 times}
+      expect(stdout_str).not_to match %r{Creating}
+    end
+
+    it 'calls get 3 times when resource purging' do
+      stdout_str, _status = Open3.capture2e("puppet apply #{common_args} -e \"test_get_calls_sgf { foo: } test_get_calls_sgf { bar: } resources { test_get_calls_sgf: purge => true }\"")
+      expect(stdout_str).to match %r{Notice: test_get_calls_sgf: Provider get called 1 times}
+      expect(stdout_str).to match %r{Notice: test_get_calls_sgf: Provider get called 2 times}
+      expect(stdout_str).to match %r{Notice: test_get_calls_sgf: Provider get called 3 times}
+      expect(stdout_str).not_to match %r{Notice: test_get_calls_sgf: Provider get called 4 times}
+      expect(stdout_str).not_to match %r{Creating}
+    end
+  end
+end

spec/fixtures/test_module/lib/puppet/provider/test_get_calls_basic/test_get_calls_basic.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'puppet/resource_api/simple_provider'
+
+# Implementation for the test_get_calls_basic type using the Resource API.
+class Puppet::Provider::TestGetCallsBasic::TestGetCallsBasic < Puppet::ResourceApi::SimpleProvider
+  def get(context)
+    @count ||= 0
+    @count += 1
+    context.notice("Provider get called #{@count} times")
+    [
+      {
+        name: 'foo',
+        ensure: 'present',
+        prop: 'fooprop',
+      },
+      {
+        name: 'bar',
+        ensure: 'present',
+        prop: 'barprop',
+      },
+    ]
+  end
+
+  def create(context, name, should)
+    context.notice("Creating '#{name}' with #{should.inspect}")
+  end
+
+  def update(context, name, should)
+    context.notice("Updating '#{name}' with #{should.inspect}")
+  end
+
+  def delete(context, name)
+    context.notice("Deleting '#{name}'")
+  end
+end

spec/fixtures/test_module/lib/puppet/provider/test_get_calls_sgf/test_get_calls_sgf.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'puppet/resource_api/simple_provider'
+
+# Implementation for the test_get_calls_sgf type using the Resource API.
+class Puppet::Provider::TestGetCallsSgf::TestGetCallsSgf < Puppet::ResourceApi::SimpleProvider
+  def get(context, names = nil)
+    @count ||= 0
+    @count += 1
+    context.notice("Provider get called #{@count} times with names=#{names}")
+    data = [
+      {
+        name: 'foo',
+        ensure: 'present',
+      },
+      {
+        name: 'bar',
+        ensure: 'present',
+      },
+    ]
+    if names.nil?
+      data
+    else
+      data.select { |r| names.include?(r[:name]) }
+    end
+  end
+
+  def create(context, name, should)
+    context.notice("Creating '#{name}' with #{should.inspect}")
+  end
+
+  def update(context, name, should)
+    context.notice("Updating '#{name}' with #{should.inspect}")
+  end
+
+  def delete(context, name)
+    context.notice("Deleting '#{name}'")
+  end
+end

spec/fixtures/test_module/lib/puppet/type/test_get_calls_basic.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'puppet/resource_api'
+
+Puppet::ResourceApi.register_type(
+  name: 'test_get_calls_basic',
+  docs: <<-EOS,
+@summary a test_get_calls_basic type
+@example
+test_get_calls_basic { 'foo':
+  ensure => 'present',
+}
+
+This type provides Puppet with the capabilities to manage ...
+
+If your type uses autorequires, please document as shown below, else delete
+these lines.
+**Autorequires**:
+* `Package[foo]`
+EOS
+  features: [],
+  attributes: {
+    ensure: {
+      type: 'Enum[present, absent]',
+      desc: 'Whether this resource should be present or absent on the target system.',
+      default: 'present',
+    },
+    name: {
+      type: 'String',
+      desc: 'The name of the resource you want to manage.',
+      behaviour: :namevar,
+    },
+    prop: {
+      type: 'Optional[String]',
+      desc: 'A property to manage.',
+    },
+  },
+)

spec/fixtures/test_module/lib/puppet/type/test_get_calls_sgf.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'puppet/resource_api'
+
+Puppet::ResourceApi.register_type(
+  name: 'test_get_calls_sgf',
+  docs: <<-EOS,
+@summary a test_get_calls_sgf type
+@example
+test_get_calls_sgf { 'foo':
+  ensure => 'present',
+}
+
+This type provides Puppet with the capabilities to manage ...
+
+If your type uses autorequires, please document as shown below, else delete
+these lines.
+**Autorequires**:
+* `Package[foo]`
+EOS
+  features: ['simple_get_filter'],
+  attributes: {
+    ensure: {
+      type: 'Enum[present, absent]',
+      desc: 'Whether this resource should be present or absent on the target system.',
+      default: 'present',
+    },
+    name: {
+      type: 'String',
+      desc: 'The name of the resource you want to manage.',
+      behaviour: :namevar,
+    },
+    prop: {
+      type: 'Optional[String]',
+      desc: 'A property to manage.',
+    },
+  },
+)