ohai 15.3.1 → 15.6.3

data/spec/unit/provides_map_spec.rb

@@ -1,208 +0,0 @@
-#
-# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright (c) 2013-2016 Chef Software, Inc.
-# License:: Apache License, Version 2.0
-#
-# 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 expressed or
-# implied.
-# See the License for the specific language governing permissions and
-# limitations under the License
-#
-
-require "spec_helper"
-
-describe Ohai::ProvidesMap do
-
-  let(:ohai_system) { Ohai::System.new }
-  let(:provides_map) { Ohai::ProvidesMap.new }
-  let(:plugin_1) { Ohai::DSL::Plugin.new(ohai_system.data, ohai_system.logger) }
-  let(:plugin_2) { Ohai::DSL::Plugin.new(ohai_system.data, ohai_system.logger) }
-  let(:plugin_3) { Ohai::DSL::Plugin.new(ohai_system.data, ohai_system.logger) }
-  let(:plugin_4) { Ohai::DSL::Plugin.new(ohai_system.data, ohai_system.logger) }
-
-  describe "when looking up providing plugins for a single attribute" do
-    describe "when the attribute does not exist" do
-      it "raises Ohai::Exceptions::AttributeNotFound error" do
-        expect { provides_map.find_providers_for(["single"]) }.to raise_error(Ohai::Exceptions::AttributeNotFound, "No such attribute: 'single'")
-      end
-    end
-
-    describe "when the attribute does not have a provider" do
-      it "raises Ohai::Exceptions::ProviderNotFound error" do
-        provides_map.set_providers_for(plugin_1, ["first/second"])
-        expect { provides_map.find_providers_for(["first"]) }.to raise_error(Ohai::Exceptions::ProviderNotFound, "Cannot find plugin providing attribute: 'first'")
-      end
-    end
-
-    describe "when only one plugin provides the attribute" do
-      before do
-        provides_map.set_providers_for(plugin_1, ["single"])
-      end
-
-      it "returns the provider" do
-        expect(provides_map.find_providers_for(["single"])).to eq([plugin_1])
-      end
-    end
-
-    describe "when multiple plugins provide the attribute" do
-      before do
-        provides_map.set_providers_for(plugin_1, ["single"])
-        provides_map.set_providers_for(plugin_2, ["single"])
-      end
-
-      it "returns all providers" do
-        expect(provides_map.find_providers_for(["single"])).to eq([plugin_1, plugin_2])
-      end
-    end
-  end
-
-  describe "when looking up providing plugins for multiple attributes" do
-    describe "when a different plugin provides each attribute" do
-
-      before do
-        provides_map.set_providers_for(plugin_1, ["one"])
-        provides_map.set_providers_for(plugin_2, ["two"])
-      end
-
-      it "returns each provider" do
-        expect(provides_map.find_providers_for(%w{one two})).to eq([plugin_1, plugin_2])
-      end
-    end
-
-    describe "when one plugin provides both requested attributes" do
-
-      before do
-        provides_map.set_providers_for(plugin_1, ["one"])
-        provides_map.set_providers_for(plugin_1, ["one_again"])
-      end
-
-      it "returns unique providers" do
-        expect(provides_map.find_providers_for(%w{one one_again})).to eq([plugin_1])
-      end
-    end
-  end
-
-  describe "when looking up providers for multi-level attributes" do
-    describe "when the full attribute exists in the map" do
-      before do
-        provides_map.set_providers_for(plugin_1, ["top/middle/bottom"])
-      end
-
-      it "collects the provider" do
-        expect(provides_map.find_providers_for(["top/middle/bottom"])).to eq([plugin_1])
-      end
-    end
-  end
-
-  describe "when setting multi-level attributes" do
-    describe "when the attribute contains //" do
-      it "raises an Ohai::Exceptions::AttributeSyntaxError" do
-        expect { provides_map.set_providers_for(plugin_1, ["this/plugin//is/bad"]) }.to raise_error(Ohai::Exceptions::AttributeSyntaxError, "Attribute contains duplicate '/' characters: this/plugin//is/bad")
-      end
-    end
-
-    describe "when the attribute has a trailing slash" do
-      it "raises an Ohai::Exceptions::AttributeSyntaxError" do
-        expect { provides_map.set_providers_for(plugin_1, ["this/plugin/is/bad/"]) }.to raise_error(Ohai::Exceptions::AttributeSyntaxError, "Attribute contains a trailing '/': this/plugin/is/bad/")
-      end
-    end
-  end
-
-  describe "when looking for providers of attributes specified in CLI" do
-    before do
-      provides_map.set_providers_for(plugin_1, ["cat/whiskers"])
-      provides_map.set_providers_for(plugin_2, ["cat/paws", "cat/paws/toes"])
-      provides_map.set_providers_for(plugin_3, ["cat/mouth/teeth"])
-    end
-
-    it "finds providers for subattributes if any exists when the attribute doesn't have a provider" do
-      providers = provides_map.deep_find_providers_for(["cat"])
-      expect(providers).to have(3).plugins
-      expect(providers).to include(plugin_1)
-      expect(providers).to include(plugin_2)
-      expect(providers).to include(plugin_3)
-    end
-
-    it "finds providers for the first parent attribute when the attribute or any subattributes doesn't have a provider" do
-      providers = provides_map.deep_find_providers_for(["cat/paws/front"])
-      expect(providers).to eq([plugin_2])
-    end
-  end
-
-  describe "when looking for the closest providers" do
-    describe "and the full attribute is provided" do
-      before do
-        provides_map.set_providers_for(plugin_1, ["do/not/eat/metal"])
-      end
-
-      it "returns the provider of the full attribute" do
-        expect(provides_map.find_closest_providers_for(["do/not/eat/metal"])).to eql([plugin_1])
-      end
-    end
-
-    describe "and the full attribute is not provided" do
-      before do
-        provides_map.set_providers_for(plugin_1, ["do/not/eat"])
-      end
-
-      it "does not raise error if a parent attribute is provided" do
-        expect { provides_map.find_closest_providers_for(["do/not/eat/plastic"]) }.not_to raise_error
-      end
-
-      it "returns the providers of the closest parent attribute" do
-        provides_map.set_providers_for(plugin_2, ["do/not"]) # set a less-specific parent
-        expect(provides_map.find_closest_providers_for(["do/not/eat/glass"])).to eql([plugin_1])
-      end
-
-      it "raises error if the least-specific parent is not an attribute" do
-        expect { provides_map.find_closest_providers_for(["please/eat/your/vegetables"]) }.to raise_error(Ohai::Exceptions::AttributeNotFound, "No such attribute: 'please/eat/your/vegetables'")
-      end
-
-      it "raises error if no parent attribute has a provider" do
-        expect { provides_map.find_closest_providers_for(["do/not"]) }.to raise_error(Ohai::Exceptions::ProviderNotFound, "Cannot find plugin providing attribute: 'do/not'")
-      end
-    end
-  end
-
-  describe "when listing all plugins" do
-    before do
-      provides_map.set_providers_for(plugin_1, ["one"])
-      provides_map.set_providers_for(plugin_2, ["two"])
-      provides_map.set_providers_for(plugin_3, ["stub/three"])
-      provides_map.set_providers_for(plugin_4, ["foo/bar/four", "also/this/four"])
-    end
-
-    it "finds all the plugins providing attributes" do
-      all_plugins = provides_map.all_plugins
-      expect(all_plugins).to have(4).plugins
-      expect(all_plugins).to include(plugin_1)
-      expect(all_plugins).to include(plugin_2)
-      expect(all_plugins).to include(plugin_3)
-      expect(all_plugins).to include(plugin_4)
-    end
-
-    describe "with an attribute filter" do
-      it "finds plugins with a single level of attribute" do
-        expect(provides_map.all_plugins("one")).to eq([plugin_1])
-      end
-
-      it "finds plugins with an exact match for multiple levels of attribute" do
-        expect(provides_map.all_plugins("stub/three")).to eq([plugin_3])
-      end
-
-      it "finds plugins that provide subattributes of the requested path" do
-        expect(provides_map.all_plugins("stub")).to eq([plugin_3])
-        expect(provides_map.all_plugins("foo/bar")).to eq([plugin_4])
-      end
-    end
-  end
-
-end

data/spec/unit/runner_spec.rb

@@ -1,422 +0,0 @@
-#
-# Author:: Claire McQuin (<claire@chef.io>)
-# Copyright:: Copyright (c) 2013-2019, Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# 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 expressed or
-# implied.
-# See the License for the specific language governing permissions and
-# limitations under the License
-#
-
-require "spec_helper"
-
-describe Ohai::Runner, "run_plugin" do
-  let(:safe_run) { true }
-
-  before do
-    @ohai = Ohai::System.new
-    @runner = Ohai::Runner.new(@ohai, safe_run)
-  end
-
-  describe "when running an invalid plugin" do
-    it "raises error" do
-      expect { @runner.run_plugin(double("Ohai::NotPlugin")) }.to raise_error(Ohai::Exceptions::InvalidPlugin)
-    end
-  end
-
-  describe "when running a plugin" do
-    let(:plugin) { double("Ohai::DSL::Plugin", is_a?: true, version: version, name: :Test, has_run?: has_run, dependencies: [ ]) }
-    let(:version) { :version7 }
-    let(:has_run) { false }
-
-    describe "version 7" do
-      it "calls run_v7_plugin" do
-        expect(@runner).to receive(:run_v7_plugin)
-        @runner.run_plugin(plugin)
-      end
-
-      describe "if the plugin has run before" do
-        let(:has_run) { true }
-
-        it "does not run the plugin" do
-          expect(plugin).not_to receive(:safe_run)
-          @runner.run_plugin(plugin)
-        end
-      end
-    end
-
-    describe "invalid version" do
-      let(:version) { :versionBla }
-
-      it "raises error" do
-        expect { @runner.run_plugin(plugin) }.to raise_error(Ohai::Exceptions::InvalidPlugin)
-      end
-    end
-  end
-
-  describe "when running a plugin with no dependencies, Ohai::Runner" do
-    let(:plugin) do
-      klass = Ohai.plugin(:Test) do
-        provides("thing")
-        collect_data do
-          thing(Mash.new)
-        end
-      end
-      klass.new(@ohai.data, @ohai.logger)
-    end
-
-    it "runs the plugin" do
-      @runner.run_plugin(plugin)
-      expect(plugin.has_run?).to be true
-    end
-
-    it "adds plugin data to Ohai::System.data" do
-      @runner.run_plugin(plugin)
-      expect(@ohai.data).to have_key(:thing)
-      expect(@ohai.data[:thing]).to eql({})
-    end
-  end
-
-  describe "when running a plugin with one dependency" do
-    describe "when the dependency does not exist" do
-      before do
-        klass = Ohai.plugin(:Test) do
-          provides("thing")
-          depends("other_thing")
-          collect_data do
-            thing(other_thing)
-          end
-        end
-        @plugin = klass.new(@ohai.data, @ohai.logger)
-      end
-
-      it "raises Ohai::Excpetions::AttributeNotFound" do
-        expect { @runner.run_plugin(@plugin) }.to raise_error(Ohai::Exceptions::AttributeNotFound)
-      end
-
-      it "does not run the plugin" do
-        expect { @runner.run_plugin(@plugin) }.to raise_error(Ohai::Exceptions::AttributeNotFound)
-        expect(@plugin.has_run?).to be false
-      end
-    end
-
-    describe "when the dependency has a single provider" do
-      before do
-        klass1 = Ohai.plugin(:Thing) do
-          provides("thing")
-          collect_data do
-            thing("thang")
-          end
-        end
-        klass2 = Ohai.plugin(:Other) do
-          provides("other")
-          depends("thing")
-          collect_data do
-            other(thing)
-          end
-        end
-
-        @plugins = []
-        [klass1, klass2].each do |klass|
-          @plugins << klass.new(@ohai.data, @ohai.logger)
-        end
-        @plugin1, @plugin2 = @plugins
-
-        @ohai.provides_map.set_providers_for(@plugin1, ["thing"])
-      end
-
-      it "runs the plugins" do
-        @runner.run_plugin(@plugin2)
-        @plugins.each do |plugin|
-          expect(plugin.has_run?).to be true
-        end
-      end
-    end
-
-    describe "when the dependency has multiple providers" do
-      before do
-        klass1 = Ohai.plugin(:Thing) do
-          provides("thing")
-          collect_data do
-            thing(Mash.new)
-          end
-        end
-        klass2 = Ohai.plugin(:Other) do
-          provides("other")
-          depends("thing")
-          collect_data do
-            other(thing)
-          end
-        end
-
-        @plugins = []
-        [klass1, klass1, klass2].each do |klass|
-          @plugins << klass.new(@ohai.data, @ohai.logger)
-        end
-        @plugin1, @plugin2, @plugin3 = @plugins
-
-        @ohai.provides_map.set_providers_for(@plugin1, ["thing"])
-        @ohai.provides_map.set_providers_for(@plugin2, ["thing"])
-      end
-
-      it "runs the plugins" do
-        @runner.run_plugin(@plugin3)
-        @plugins.each do |plugin|
-          expect(plugin.has_run?).to be true
-        end
-      end
-    end
-  end
-
-  describe "when running a plugin with many dependencies" do
-    before do
-      @ohai = Ohai::System.new
-      @runner = Ohai::Runner.new(@ohai, true)
-
-      klass1 = Ohai.plugin(:One) do
-        provides("one")
-        collect_data do
-          one(1)
-        end
-      end
-      klass2 = Ohai.plugin(:Two) do
-        provides("two")
-        collect_data do
-          two(2)
-        end
-      end
-      klass3 = Ohai.plugin(:Three) do
-        provides("three")
-        depends("one", "two")
-        collect_data do
-          three(3)
-        end
-      end
-
-      @plugins = []
-      [klass1, klass2, klass3].each do |klass|
-        @plugins << klass.new(@ohai.data, @ohai.logger)
-      end
-      @plugin1, @plugin2, @plugin3 = @plugins
-      @ohai.provides_map.set_providers_for(@plugin1, %w{one two})
-      @ohai.provides_map.set_providers_for(@plugin2, %w{one two})
-    end
-
-    it "runs the plugins" do
-      @runner.run_plugin(@plugin3)
-      @plugins.each do |plugin|
-        expect(plugin.has_run?).to be true
-      end
-    end
-  end
-
-  describe "when a cycle is detected" do
-    let(:runner) { Ohai::Runner.new(@ohai, true) }
-
-    context "when there are no edges in the cycle (A->A)" do
-      let(:plugin_class) do
-        Ohai.plugin(:Thing) do
-          provides("thing")
-          depends("thing")
-          collect_data do
-            thing(other)
-          end
-        end
-      end
-      let(:plugin) { plugin_class.new(@ohai.data, @ohai.logger) }
-
-      it "ignores the cycle" do
-        @ohai.provides_map.set_providers_for(plugin, ["thing"])
-        runner.run_plugin(plugin) # should not raise
-      end
-
-    end
-
-    context "when there is one edge in the cycle (A->B and B->A)" do
-      before do
-        klass1 = Ohai.plugin(:Thing) do # rubocop disable Lint/UselessAssignment
-          provides("thing")
-          depends("other")
-          collect_data do
-            thing(other)
-          end
-        end
-        klass2 = Ohai.plugin(:Other) do
-          provides("other")
-          depends("thing")
-          collect_data do
-            other(thing)
-          end
-        end
-
-        @plugins = []
-        [klass1, klass2].each_with_index do |klass, idx|
-          @plugins << klass.new(@ohai.data, @ohai.logger)
-        end
-
-        @plugin1, @plugin2 = @plugins
-      end
-
-      it "raises Ohai::Exceptions::DependencyCycle" do
-        allow(runner).to receive(:fetch_plugins).with(["thing"]).and_return([@plugin1])
-        allow(runner).to receive(:fetch_plugins).with(["other"]).and_return([@plugin2])
-        expected_error_string = "Dependency cycle detected. Please refer to the following plugins: Thing, Other"
-        expect { runner.run_plugin(@plugin1) }.to raise_error(Ohai::Exceptions::DependencyCycle, expected_error_string)
-      end
-    end
-  end
-
-  describe "when A depends on B and C, and B depends on C" do
-    before do
-      @ohai = Ohai::System.new
-      @runner = Ohai::Runner.new(@ohai, true)
-
-      klass_a = Ohai.plugin(:A) do
-        provides("A")
-        depends("B", "C")
-        collect_data {}
-      end
-      klass_b = Ohai.plugin(:B) do
-        provides("B")
-        depends("C")
-        collect_data {}
-      end
-      klass_c = Ohai.plugin(:C) do
-        provides("C")
-        collect_data {}
-      end
-
-      @plugins = []
-      [klass_a, klass_b, klass_c].each do |klass|
-        @plugins << klass.new(@ohai.data, @ohai.logger)
-      end
-      @plugin_a, @plugin_b, @plugin_c = @plugins
-    end
-
-    it "does not detect a cycle when B is the first provider returned" do
-      @ohai.provides_map.set_providers_for(@plugin_a, ["A"])
-      @ohai.provides_map.set_providers_for(@plugin_b, ["B"])
-      @ohai.provides_map.set_providers_for(@plugin_c, ["C"])
-
-      expect(Ohai::Log).not_to receive(:error).with(/DependencyCycleError/)
-      @runner.run_plugin(@plugin_a)
-
-      @plugins.each do |plugin|
-        expect(plugin.has_run?).to be true
-      end
-    end
-
-    it "does not detect a cycle when C is the first provider returned" do
-      @ohai.provides_map.set_providers_for(@plugin_a, ["A"])
-      @ohai.provides_map.set_providers_for(@plugin_c, ["C"])
-      @ohai.provides_map.set_providers_for(@plugin_b, ["B"])
-
-      expect(Ohai::Log).not_to receive(:error).with(/DependencyCycleError/)
-      @runner.run_plugin(@plugin_a)
-
-      @plugins.each do |plugin|
-        expect(plugin.has_run?).to be true
-      end
-    end
-  end
-end
-
-describe Ohai::Runner, "fetch_plugins" do
-  before do
-    @provides_map = Ohai::ProvidesMap.new
-    @data = Mash.new
-    @ohai = double("Ohai::System", data: @data, provides_map: @provides_map, logger: Ohai::Log.with_child)
-    @runner = Ohai::Runner.new(@ohai, true)
-  end
-
-  it "collects the provider" do
-    plugin = Ohai::DSL::Plugin.new(@ohai.data, @ohai.logger)
-    @ohai.provides_map.set_providers_for(plugin, ["top/middle/bottom"])
-
-    dependency_providers = @runner.fetch_plugins(["top/middle/bottom"])
-    expect(dependency_providers).to eql([plugin])
-  end
-
-  describe "when the attribute is not provided by any plugin" do
-    describe "and some parent attribute has providers" do
-      it "returns the providers for the parent" do
-        plugin = Ohai::DSL::Plugin.new(@ohai.data, @ohai.logger)
-        @provides_map.set_providers_for(plugin, ["test/attribute"])
-        expect(@runner.fetch_plugins(["test/attribute/too_far"])).to eql([plugin])
-      end
-    end
-
-    describe "and no parent attribute has providers" do
-      it "raises Ohai::Exceptions::AttributeNotFound exception" do
-        # provides map is empty
-        expect { @runner.fetch_plugins(["false/attribute"]) }.to raise_error(Ohai::Exceptions::AttributeNotFound, "No such attribute: 'false/attribute'")
-      end
-    end
-  end
-
-  it "returns unique providers" do
-    plugin = Ohai::DSL::Plugin.new(@ohai.data, @ohai.logger)
-    @provides_map.set_providers_for(plugin, ["test", "test/too_far/way_too_far"])
-    expect(@runner.fetch_plugins(["test", "test/too_far/way_too_far"])).to eql([plugin])
-  end
-end
-
-describe Ohai::Runner, "#get_cycle" do
-  before do
-    @ohai = Ohai::System.new
-    @runner = Ohai::Runner.new(@ohai, true)
-
-    klass1 = Ohai.plugin(:One) do
-      provides("one")
-      depends("two")
-      collect_data do
-        one(two)
-      end
-    end
-    klass2 = Ohai.plugin(:Two) do
-      provides("two")
-      depends("one")
-      collect_data do
-        two(one)
-      end
-    end
-    klass3 = Ohai.plugin(:Three) do
-      provides("three")
-      depends("two")
-      collect_data do
-        three(two)
-      end
-    end
-
-    plugins = []
-    [klass1, klass2, klass3].each_with_index do |klass, idx|
-      plugins << klass.new(@ohai.data, @ohai.logger)
-    end
-    @plugin1, @plugin2, @plugin3 = plugins
-  end
-
-  it "returns the sources for the plugins in the cycle, when given an exact cycle" do
-    cycle = [@plugin1, @plugin2]
-    cycle_start = @plugin1
-
-    cycle_names = @runner.get_cycle(cycle, cycle_start)
-    expect(cycle_names).to eql([@plugin1.name, @plugin2.name])
-  end
-
-  it "returns the sources for only the plugins in the cycle, when there are plugins before the cycle begins" do
-    cycle = [@plugin3, @plugin1, @plugin2]
-    cycle_start = @plugin1
-
-    cycle_names = @runner.get_cycle(cycle, cycle_start)
-    expect(cycle_names).to eql([@plugin1.name, @plugin2.name])
-  end
-end