poise 2.0.0

data/test/spec/helpers/lazy_default_spec.rb

@@ -0,0 +1,74 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+LAZY_DEFAULT_GLOBAL = [0]
+
+describe Poise::Helpers::LazyDefault do
+  resource(:poise_test) do
+    include Poise::Helpers::LWRPPolyfill
+    include described_class
+    attribute(:value, default: lazy { name + '_lazy' })
+  end
+  provider(:poise_test)
+  recipe do
+    poise_test 'test'
+  end
+
+  it { is_expected.to run_poise_test('test').with(value: 'test_lazy') }
+
+  context 'with an explicit value' do
+    recipe do
+      poise_test 'test' do
+        value 'value'
+      end
+    end
+
+    it { is_expected.to run_poise_test('test').with(value: 'value') }
+  end
+
+  context 'in a subclass' do
+    resource(:poise_sub, parent: :poise_test)
+    provider(:poise_sub)
+    recipe do
+      poise_sub 'test'
+    end
+
+    it { is_expected.to run_poise_test('test').with(value: 'test_lazy') }
+  end
+
+  context 'with an external global' do
+    resource(:poise_test) do
+      include Poise::Helpers::LWRPPolyfill
+      include described_class
+      attribute(:value, default: lazy { LAZY_DEFAULT_GLOBAL.first })
+    end
+
+    it 'does not cache the value before retrieval' do
+      LAZY_DEFAULT_GLOBAL[0] = 42
+      is_expected.to run_poise_test('test').with(value: 42)
+    end
+
+    # This is actually part of set_or_return, but make sure we didn't break semantics
+    it 'caches the value once retrieved' do
+      LAZY_DEFAULT_GLOBAL[0] = 0
+      is_expected.to run_poise_test('test').with(value: 0)
+      LAZY_DEFAULT_GLOBAL[0] = 42
+      is_expected.to run_poise_test('test').with(value: 0)
+    end
+  end
+end

data/test/spec/helpers/lwrp_polyfill_spec.rb

@@ -0,0 +1,128 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe Poise::Helpers::LWRPPolyfill do
+  describe Poise::Helpers::LWRPPolyfill::Resource do
+    describe '#attribute' do
+      resource(:poise_test) do
+        include described_class
+        attribute(:boolean, equal_to: [true, false])
+      end
+
+      provider(:poise_test)
+
+      context 'with default value' do
+        recipe do
+          poise_test 'nil'
+        end
+
+        it { is_expected.to run_poise_test('nil').with(boolean: nil) }
+      end
+
+      context 'with true value' do
+        recipe do
+          poise_test 'true' do
+            boolean true
+          end
+        end
+
+        it { is_expected.to run_poise_test('true').with(boolean: true) }
+      end
+
+      context 'with false value' do
+        recipe do
+          poise_test 'false' do
+            boolean false
+          end
+        end
+
+        it { is_expected.to run_poise_test('false').with(boolean: false) }
+      end
+
+      context 'with string value' do
+        recipe do
+          poise_test 'true' do
+            boolean 'boom'
+          end
+        end
+
+        it { expect { subject }.to raise_error Chef::Exceptions::ValidationFailed }
+      end
+    end # /describe #attribute
+
+    describe '#default_action' do
+      resource(:poise_test) do
+        include described_class
+        default_action(:one)
+        actions(:two)
+      end
+      provider(:poise_test) do
+        def action_one; end
+        def action_two; end
+      end
+      recipe do
+        poise_test 'test'
+      end
+
+      it { is_expected.to one_poise_test('test') }
+    end # /describe #default_action
+  end # /describe Poise::Helpers::LWRPPolyfill::Resource
+
+  describe Poise::Helpers::LWRPPolyfill::Provider do
+    describe 'load_current_resource override' do
+      subject { provider(:poise_test).new(nil, nil).load_current_resource }
+
+      context 'with a direct Provider subclass' do
+        provider(:poise_test, auto: false) do
+          include described_class
+        end
+
+        it { is_expected.to be_nil }
+      end
+
+      context 'with an intermediary class' do
+        provider(:poise_parent, auto: false) do
+          def load_current_resource
+            'helper'
+          end
+        end
+        provider(:poise_test, auto: false, parent: :poise_parent) do
+          include described_class
+        end
+
+        it { is_expected.to eq 'helper' }
+      end
+    end
+
+    describe 'Chef::DSL::Recipe include' do
+      resource(:poise_test)
+      provider(:poise_test) do
+        include described_class
+
+        def action_run
+          ruby_block 'test'
+        end
+      end
+      recipe do
+        poise_test 'test'
+      end
+
+      it { is_expected.to run_ruby_block('test') }
+    end
+  end # /describe Poise::Helpers::LWRPPolyfill::Provider
+end

data/test/spec/helpers/notifying_block_spec.rb

@@ -0,0 +1,87 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe Poise::Helpers::NotifyingBlock do
+  before { step_into << 'ruby_block' }
+  resource(:poise_test, unwrap_notifying_block: false) do
+    def inner_action(val=nil)
+      set_or_return(:inner_action, val, {})
+    end
+  end
+  provider(:poise_test) do
+    include Poise::Helpers::LWRPPolyfill
+    include described_class
+
+    def action_run
+      notifying_block do
+        ruby_block 'inner' do
+          action new_resource.inner_action
+          block { }
+        end
+      end
+    end
+  end
+
+  context 'with updated inner resources' do
+    recipe do
+      poise_test 'test' do
+        inner_action :run
+      end
+    end
+
+    it 'marks the outer resource as updated' do
+      expect(subject.find_resource('poise_test', 'test').updated_by_last_action?).to be_truthy
+    end
+
+    it 'does not add the inner resource to the global collection' do
+      expect(subject.find_resource('ruby_block', 'inner ')).to be_nil
+    end
+  end # /context with updated inner resources
+
+  context 'without updated inner resources' do
+    recipe do
+      poise_test 'test' do
+        inner_action :nothing
+      end
+    end
+
+    it 'does not marks the outer resource as updated' do
+      expect(subject.find_resource('poise_test', 'test').updated_by_last_action?).to be_falsey
+    end
+  end # /context without updated inner resources
+
+  context 'with an exception raised inside the block' do
+    provider(:poise_test) do
+      include Poise::Helpers::LWRPPolyfill
+      include described_class
+
+      def action_run
+        notifying_block do
+          ruby_block 'inner' do
+            block { raise 'Boom!' }
+          end
+        end
+      end
+    end
+    recipe do
+      poise_test 'test'
+    end
+
+    it { expect { subject }.to raise_error(RuntimeError) }
+  end # /context with an exception raised inside the block
+end

data/test/spec/helpers/option_collector_spec.rb

@@ -0,0 +1,82 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe Poise::Helpers::OptionCollector do
+  resource(:poise_test) do
+    include described_class
+    attribute(:options, option_collector: true)
+  end
+  provider(:poise_test)
+
+  context 'with a block' do
+    recipe do
+      poise_test 'test' do
+        options do
+          one '1'
+          two 2
+        end
+      end
+    end
+
+    it { is_expected.to run_poise_test('test').with(options: {'one' => '1', 'two' => 2}) }
+  end # /context with a block
+
+  context 'with a hash' do
+    recipe do
+      poise_test 'test' do
+        options one: '1', two: 2
+      end
+    end
+
+    it { is_expected.to run_poise_test('test').with(options: {'one' => '1', 'two' => 2}) }
+  end # /context with a hash
+
+  context 'with both a block and a hash' do
+    recipe do
+      poise_test 'test' do
+        options one: '1', two: 2 do
+          two 3
+          three 'three'
+        end
+      end
+    end
+
+    it { is_expected.to run_poise_test('test').with(options: {'one' => '1', 'two' => 3, 'three' => 'three'}) }
+  end # /context with both a block and a hash
+
+  context 'with a normal attribute too' do
+    resource(:poise_test) do
+      include Poise::Helpers::LWRPPolyfill
+      include described_class
+      attribute(:options, option_collector: true)
+      attribute(:value)
+    end
+    recipe do
+      poise_test 'test' do
+        options do
+          one '1'
+        end
+        value 2
+      end
+    end
+
+    it { is_expected.to run_poise_test('test').with(options: {'one' => '1'}, value: 2) }
+  end # /context with a normal attribute too
+
+  # TODO: Write tests for mixed symbol/string data
+end

data/test/spec/helpers/resource_name_spec.rb

@@ -0,0 +1,39 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+class ResourceNameHelper < Chef::Resource
+  include Poise::Helpers::ResourceName
+  provides(:provides_test)
+end
+
+describe Poise::Helpers::ResourceName do
+  context 'via class.name' do
+    resource(:poise_test, auto: false) do
+      include described_class
+    end
+    subject { resource(:poise_test).new(nil, nil).resource_name }
+
+    it { is_expected.to eq :poise_test }
+  end
+
+  context 'via provides' do
+    subject { ResourceNameHelper.new(nil, nil).resource_name }
+
+    it { is_expected.to eq :provides_test }
+  end
+end

data/test/spec/helpers/subcontext_block_spec.rb

@@ -0,0 +1,94 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'spec_helper'
+
+describe Poise::Helpers::SubcontextBlock do
+  resource(:poise_test)
+  recipe do
+    poise_test 'test'
+  end
+
+  # General sanity test
+  provider(:poise_test) do
+    include described_class
+    include Chef::DSL::Recipe
+
+    def action_run
+      top_level_collection = run_context.resource_collection
+      sub = subcontext_block do
+        expect(run_context.resource_collection).to_not be top_level_collection
+        expect(global_resource_collection).to be top_level_collection
+        expect(run_context.resource_collection.parent).to be top_level_collection
+
+        ruby_block 'inner'
+      end
+      expect(sub.resource_collection.find('ruby_block[inner]')).to be_truthy
+    end
+  end
+
+  it { is_expected.to_not run_ruby_block('inner') }
+
+  describe '#global_resource_collection' do
+    provider(:poise_test) do
+      include described_class
+      include Chef::DSL::Recipe
+
+      def action_run
+        top_level_collection = run_context.resource_collection
+        subcontext_block do
+          subcontext_block do
+            expect(global_resource_collection).to be top_level_collection
+          end
+        end
+      end
+    end
+
+    it { run_chef }
+  end # /describe #global_resource_collection
+
+  describe '#recursive_each' do
+    provider(:poise_test) do
+      include described_class
+      include Chef::DSL::Recipe
+
+      def action_run
+        ctx = subcontext_block do
+          ruby_block 'a'
+          ctx2 = subcontext_block do
+            ruby_block 'b'
+            ruby_block 'c'
+          end
+          expect(names(ctx2)).to eq %w{test a b c}
+          ruby_block 'd'
+        end
+        expect(names(ctx)).to eq %w{test a d}
+      end
+
+      private
+
+      def names(ctx)
+        [].tap do |names|
+          ctx.resource_collection.recursive_each do |r|
+            names << r.name
+          end
+        end
+      end
+    end
+
+    it { run_chef }
+  end # /describe #recursive_each
+end