chefspec-chef 9.3.4

data/spec/unit/solo_runner_spec.rb

@@ -0,0 +1,171 @@
+require "spec_helper"
+
+describe ChefSpec::SoloRunner do
+  before do
+    allow_any_instance_of(ChefSpec::SoloRunner)
+      .to receive(:dry_run?)
+      .and_return(true)
+  end
+
+  describe "#initialize" do
+    let(:windows_caller_stack) do
+      [
+        "C:/cookbooks/Temp/spec/test_spec.rb:11:in `block (2 levels) in <top (required)>'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/example.rb:114:in `instance_eval'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/example.rb:114:in `block in run'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/example.rb:254:in `with_around_each_hooks'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/example.rb:111:in `run'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/example_group.rb:390:in `block in run_examples'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/example_group.rb:386:in `map'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/example_group.rb:386:in `run_examples'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/example_group.rb:371:in `run'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/command_line.rb:28:in `block (2 levels) in run'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/command_line.rb:28:in `map'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/command_line.rb:28:in `block in run'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/reporter.rb:58:in `report'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/command_line.rb:25:in `run'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/runner.rb:80:in `run'",
+        "C:/Ruby193/lib/ruby/gems/1.9.1/gems/rspec-core-2.14.8/lib/rspec/core/runner.rb:17:in `block in autorun'",
+      ]
+    end
+
+    it "defaults the log level to :warn" do
+      described_class.new
+      expect(Chef::Log.level).to eq(:warn)
+    end
+
+    it "sets the log level" do
+      described_class.new(log_level: :error)
+      expect(Chef::Log.level).to eq(:error)
+    end
+
+    it "defaults the cookbook_path to the calling spec" do
+      described_class.new
+      expect(Chef::Config.cookbook_path).to eq([File.expand_path("../../..", __dir__)])
+    end
+
+    it "defaults the cookbook_path to the calling spec when using windows paths" do
+      runner = described_class.new
+      windows_path = runner.instance_exec(windows_caller_stack) { |callstack|
+        calling_cookbook_path({}, callstack)
+      }
+      # There's got to be a better way to do this the File.expand_path returns
+      # something like /home/user/repos/chefspec/C:/cookbooks" which is less
+      # than ideal as a robust test
+      expect(windows_path).to end_with("C:/cookbooks")
+    end
+
+    it "sets the cookbook path" do
+      described_class.new(cookbook_path: "/tmp/bacon")
+      expect(Chef::Config.cookbook_path).to eq(["/tmp/bacon"])
+    end
+
+    it "sets the file cache path" do
+      described_class.new( file_cache_path: "/tmp/pantoa")
+      expect(Chef::Config.file_cache_path).to eq("/tmp/pantoa")
+    end
+
+    it "sets the Chef::Config" do
+      expect(Chef::Config.cache_type).to eq("Memory")
+      expect(Chef::Config.force_logger).to be_truthy
+      expect(Chef::Config.no_lazy_load).to be_truthy
+      expect(Chef::Config.solo).to be_truthy
+      expect(Chef::Config.use_policyfile).to be_falsey
+    end
+
+    it "yields a block to set node attributes" do
+      expect { |block| described_class.new({}, &block) }.to yield_with_args(Chef::Node)
+    end
+
+    context "default ohai attributes" do
+      let(:hash) { described_class.new.node.to_hash }
+
+      it "sets the default attributes" do
+        expect(hash["os"]).to eq("chefspec")
+        expect(hash["languages"]["ruby"]["bin_dir"]).to eq("/usr/local/bin")
+        expect(hash["os_version"]).to eq("0.6.1")
+        expect(hash["fqdn"]).to eq("chefspec.local")
+        expect(hash["domain"]).to eq("local")
+        expect(hash["ipaddress"]).to eq("127.0.0.1")
+        expect(hash["hostname"]).to eq("chefspec")
+        expect(hash["kernel"]["machine"]).to eq("i386")
+      end
+    end
+
+    context "fauxhai attributes" do
+      let(:hash) { described_class.new(platform: "ubuntu", version: "18.04").node.to_hash }
+
+      it "sets the attributes from fauxhai" do
+        expect(hash["os"]).to eq("linux")
+        expect(hash["languages"]["ruby"]["ruby_bin"]).to eq("/usr/local/bin/ruby")
+        expect(hash["os_version"]).to match(/5.4.0-.*-.*/) # avoid failing when fauxhai data changes
+        expect(hash["fqdn"]).to eq("fauxhai.local")
+        expect(hash["domain"]).to eq("local")
+        expect(hash["ipaddress"]).to eq("10.0.0.2")
+        expect(hash["hostname"]).to eq("Fauxhai")
+        expect(hash["kernel"]["machine"]).to eq("x86_64")
+      end
+    end
+
+    context "RSpec global configuration" do
+      before do
+        allow(RSpec.configuration).to receive(:cookbook_path).and_return("./path")
+        allow(RSpec.configuration).to receive(:environment_path).and_return("./env-path")
+        allow(RSpec.configuration).to receive(:file_cache_path).and_return("./file-cache-path")
+        allow(RSpec.configuration).to receive(:log_level).and_return(:fatal)
+        allow(RSpec.configuration).to receive(:path).and_return("ohai.json")
+        allow(RSpec.configuration).to receive(:platform).and_return("ubuntu")
+        allow(RSpec.configuration).to receive(:version).and_return("12.04")
+      end
+
+      it "uses the RSpec values" do
+        options = described_class.new.options
+        expect(options[:cookbook_path]).to eq("./path")
+        expect(options[:environment_path]).to eq("./env-path")
+        expect(options[:file_cache_path]).to eq("./file-cache-path")
+        expect(options[:log_level]).to eq(:fatal)
+        expect(options[:path]).to eq("ohai.json")
+        expect(options[:platform]).to eq("ubuntu")
+        expect(options[:version]).to eq("12.04")
+      end
+    end
+  end
+
+  describe "#node" do
+    it "returns the Chef::Node" do
+      expect(subject.node).to be_a(Chef::Node)
+    end
+
+    it "defines a #runner method that returns self" do
+      expect(subject.node.methods).to include(:runner)
+      expect(subject.node.runner).to be(subject)
+    end
+
+    it "allows attributes to be set on the node" do
+      subject.node.normal["bacon"] = "ham"
+      expect(subject.node.bacon).to eq("ham")
+    end
+  end
+
+  describe "#to_s" do
+    it "overrides the default string representation to something readable" do
+      expect(subject.converge("apache2::default").to_s)
+        .to eq("#<ChefSpec::SoloRunner run_list: [recipe[apache2::default]]>")
+    end
+
+    it "is ok when a convergence has not yet taken place" do
+      expect(subject.to_s).to eq("#<ChefSpec::SoloRunner run_list: []>")
+    end
+
+    it "includes the entire run_list" do
+      expect(subject.converge("apache2::default", "apache2::mod_ssl").to_s)
+        .to eq("#<ChefSpec::SoloRunner run_list: [recipe[apache2::default], recipe[apache2::mod_ssl]]>")
+    end
+
+    it "has the run_list only for the last convergence" do
+      ["mysql::client", "mysql::server"].each { |recipe| subject.converge(recipe) }
+      expect(subject.to_s)
+        .to eq("#<ChefSpec::SoloRunner run_list: [recipe[mysql::server]]>")
+    end
+  end
+end

data/spec/unit/stubs/command_registry_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe ChefSpec::Stubs::CommandRegistry do
+  before { described_class.reset! }
+
+  it "inherits from Registry" do
+    expect(described_class.superclass).to be(ChefSpec::Stubs::Registry)
+  end
+
+  describe "#stub_for" do
+    it "finds a stub by name" do
+      command = double("command", command: "test -f /var/www")
+      described_class.register(command)
+      expect(described_class.stub_for("test -f /var/www")).to eq(command)
+    end
+
+    it "finds a stub by regex" do
+      command = double("command", command: /test -f (.+)/)
+      described_class.register(command)
+      expect(described_class.stub_for("test -f /var/www")).to eq(command)
+    end
+
+    it "returns nil when no commands are matched" do
+      expect(described_class.stub_for("which a2ensite")).to eq(nil)
+    end
+  end
+end

data/spec/unit/stubs/command_stub_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+describe ChefSpec::Stubs::CommandStub do
+  describe "#initialize" do
+    it "sets the command and block" do
+      block = Proc.new {}
+      stub  = described_class.new("command", &block)
+
+      expect(stub.command).to eq("command")
+      expect(stub.block).to eq(block)
+    end
+  end
+
+  describe "#and_return" do
+    subject { described_class.new("command").and_return("value") }
+
+    it "sets the value" do
+      expect(subject.value).to eq("value")
+    end
+
+    it "returns an instance of the stub" do
+      expect(subject.and_return("value")).to be(subject)
+    end
+  end
+
+  describe "#result" do
+    context "when a value is given" do
+      subject { described_class.new("command").and_return("value") }
+
+      it "returns the value" do
+        expect(subject.result).to eq("value")
+      end
+    end
+
+    context "when a block is given" do
+      subject { described_class.new("command") { 1 == 2 } }
+
+      it "calls the block" do
+        expect(subject.result).to eq(false)
+      end
+    end
+  end
+
+  describe "#signature" do
+    context "when a value is given" do
+      subject { described_class.new("command").and_return(false) }
+
+      it "includes the value" do
+        expect(subject.signature).to eq('stub_command("command").and_return(false)')
+      end
+    end
+
+    context "when a block is given" do
+      subject { described_class.new("command") { 1 == 2 } }
+
+      it "includes a comment about the block" do
+        expect(subject.signature).to eq('stub_command("command") { # Ruby code }')
+      end
+    end
+  end
+end

data/spec/unit/stubs/data_bag_item_registry_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe ChefSpec::Stubs::DataBagItemRegistry do
+  before { described_class.reset! }
+
+  it "inherits from Registry" do
+    expect(described_class.superclass).to be(ChefSpec::Stubs::Registry)
+  end
+
+  describe "#stub_for" do
+    it "finds a stub by name" do
+      search = double("search", bag: "users", id: "svargo")
+      described_class.register(search)
+      expect(described_class.stub_for("users", "svargo")).to eq(search)
+    end
+
+    it "finds a stub by Regex" do
+      search = double("search", bag: "users", id: /sv(.+)/)
+      described_class.register(search)
+      expect(described_class.stub_for("users", "svargo")).to eq(search)
+    end
+
+    it "matches when the bag is a Symbol" do
+      search = double("search", bag: :users, id: "svargo")
+      described_class.register(search)
+      expect(described_class.stub_for("users", "svargo")).to eq(search)
+    end
+
+    it "matches when the stub is a Symbol" do
+      search = double("search", bag: "users", id: "svargo")
+      described_class.register(search)
+      expect(described_class.stub_for(:users, "svargo")).to eq(search)
+    end
+
+    it "returns nil when no searches are matched" do
+      expect(described_class.stub_for("users", "svargo")).to eq(nil)
+    end
+  end
+end

data/spec/unit/stubs/data_bag_item_stub_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe ChefSpec::Stubs::DataBagItemStub do
+  it "inherts from Stub" do
+    expect(described_class.superclass).to be(ChefSpec::Stubs::Stub)
+  end
+
+  describe "#initialize" do
+    it "sets the bag, id, and block" do
+      block = Proc.new {}
+      stub  = described_class.new("bag", "id", &block)
+
+      expect(stub.bag).to eq("bag")
+      expect(stub.id).to eq("id")
+      expect(stub.block).to eq(block)
+    end
+  end
+
+  describe "#signature" do
+    context "when a value is given" do
+      subject { described_class.new("bag", "id").and_return(false) }
+
+      it "includes the value" do
+        expect(subject.signature).to eq('stub_data_bag_item("bag", "id").and_return(false)')
+      end
+    end
+
+    context "when a block is given" do
+      subject { described_class.new("bag", "id") { 1 == 2 } }
+
+      it "includes a comment about the block" do
+        expect(subject.signature).to eq('stub_data_bag_item("bag", "id") { # Ruby code }')
+      end
+    end
+  end
+end

data/spec/unit/stubs/data_bag_registry_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe ChefSpec::Stubs::DataBagRegistry do
+  before { described_class.reset! }
+
+  it "inherits from Registry" do
+    expect(described_class.superclass).to be(ChefSpec::Stubs::Registry)
+  end
+
+  describe "#stub_for" do
+    it "finds a stub by name" do
+      search = double("search", bag: "users")
+      described_class.register(search)
+      expect(described_class.stub_for("users")).to eq(search)
+    end
+
+    it "finds a stub by Regex" do
+      search = double("search", bag: "users")
+      described_class.register(search)
+      expect(described_class.stub_for("users")).to eq(search)
+    end
+
+    it "matches when the bag is Symbol" do
+      search = double("search", bag: :users)
+      described_class.register(search)
+      expect(described_class.stub_for("users")).to eq(search)
+    end
+
+    it "matches when the stub is Symbol" do
+      search = double("search", bag: "users")
+      described_class.register(search)
+      expect(described_class.stub_for(:users)).to eq(search)
+    end
+
+    it "returns nil when no searches are matched" do
+      expect(described_class.stub_for("users")).to eq(nil)
+    end
+  end
+end

data/spec/unit/stubs/data_bag_stub_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe ChefSpec::Stubs::DataBagStub do
+  it "inherts from Stub" do
+    expect(described_class.superclass).to be(ChefSpec::Stubs::Stub)
+  end
+
+  describe "#initialize" do
+    it "sets the bag and block" do
+      block = Proc.new {}
+      stub  = described_class.new("bag", &block)
+
+      expect(stub.bag).to eq("bag")
+      expect(stub.block).to eq(block)
+    end
+  end
+
+  describe "#signature" do
+    context "when a value is given" do
+      subject { described_class.new("bag").and_return(false) }
+
+      it "includes the value" do
+        expect(subject.signature).to eq('stub_data_bag("bag").and_return(false)')
+      end
+    end
+
+    context "when a block is given" do
+      subject { described_class.new("bag") { 1 == 2 } }
+
+      it "includes a comment about the block" do
+        expect(subject.signature).to eq('stub_data_bag("bag") { # Ruby code }')
+      end
+    end
+  end
+end

data/spec/unit/stubs/registry_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe ChefSpec::Stubs::Registry do
+  before { described_class.reset! }
+
+  describe "#reset!" do
+    it "cleans the list of stubs" do
+      described_class.stubs = [1, 2, 3]
+      described_class.reset!
+
+      expect(described_class.stubs).to be_empty
+    end
+  end
+
+  describe "#register" do
+    it "adds the stub to the registry" do
+      described_class.register("bacon")
+      expect(described_class.stubs).to include("bacon")
+    end
+  end
+
+  describe "#stub_for" do
+    it "finds a stub by name" do
+      expect {
+        described_class.stub_for
+      }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/unit/stubs/search_registry_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe ChefSpec::Stubs::SearchRegistry do
+  before { described_class.reset! }
+
+  it "inherits from Registry" do
+    expect(described_class.superclass).to be(ChefSpec::Stubs::Registry)
+  end
+
+  describe "#stub_for" do
+    it "finds a stub by name" do
+      search = double("search", type: "node", query: "*:*")
+      described_class.register(search)
+      expect(described_class.stub_for("node", "*:*")).to eq(search)
+    end
+
+    it "finds a stub by Regex" do
+      search = double("search", type: "node", query: /name:(.+)/)
+      described_class.register(search)
+      expect(described_class.stub_for("node", "name:example.com")).to eq(search)
+    end
+
+    it "matches when the type is Symbol" do
+      search = double("search", type: :node, query: "*:*")
+      described_class.register(search)
+      expect(described_class.stub_for("node", "*:*")).to eq(search)
+    end
+
+    it "matches when the stub is Symbol" do
+      search = double("search", type: "node", query: "*:*")
+      described_class.register(search)
+      expect(described_class.stub_for(:node, "*:*")).to eq(search)
+    end
+
+    it "returns nil when no searches are matched" do
+      expect(described_class.stub_for("node", "name:example.com")).to eq(nil)
+    end
+  end
+end

data/spec/unit/stubs/search_stub_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe ChefSpec::Stubs::SearchStub do
+  it "inherts from Stub" do
+    expect(described_class.superclass).to be(ChefSpec::Stubs::Stub)
+  end
+
+  describe "#initialize" do
+    it "sets the type, query, and block" do
+      block = Proc.new {}
+      stub  = described_class.new("type", "query", &block)
+
+      expect(stub.type).to eq("type")
+      expect(stub.query).to eq("query")
+      expect(stub.block).to eq(block)
+    end
+  end
+
+  describe "#signature" do
+    context "when a value is given" do
+      subject { described_class.new("type", "query").and_return(false) }
+
+      it "includes the value" do
+        expect(subject.signature).to eq('stub_search("type", "query").and_return(false)')
+      end
+    end
+
+    context "when a block is given" do
+      subject { described_class.new("type", "query") { 1 == 2 } }
+
+      it "includes a comment about the block" do
+        expect(subject.signature).to eq('stub_search("type", "query") { # Ruby code }')
+      end
+    end
+  end
+end

data/spec/unit/stubs/stub_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe ChefSpec::Stubs::Stub do
+  describe "#and_return" do
+    subject { described_class.new.and_return("value") }
+
+    it "sets the value" do
+      expect(subject.value).to eq("value")
+    end
+
+    it "returns an instance of the stub" do
+      expect(subject.and_return("value")).to be(subject)
+    end
+  end
+
+  describe "#and_raise" do
+    subject { described_class.new.and_raise(ArgumentError) }
+
+    it "sets the block" do
+      expect(subject.instance_variable_get(:@block)).to be_a(Proc)
+    end
+
+    it "returns an instance of the stub" do
+      expect(subject.and_raise(ArgumentError)).to be(subject)
+    end
+  end
+
+  describe "#result" do
+    context "when a value is given" do
+      subject { described_class.new.and_return("value") }
+
+      it "returns the value" do
+        expect(subject.result).to eq("value")
+      end
+    end
+
+    context "when a block is given" do
+      subject { described_class.new }
+
+      it "calls the block" do
+        subject.instance_variable_set(:@block, Proc.new { 1 == 2 })
+        expect(subject.result).to eq(false)
+      end
+    end
+
+    context "when an exception block is given" do
+      subject { described_class.new.and_raise(ArgumentError) }
+
+      it "raises the exception" do
+        expect {
+          subject.result
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when the value is a Hash" do
+      subject { described_class.new.and_return([ { name: "a" } ]) }
+
+      it "recursively mashifies the value" do
+        expect(subject.result.first).to be_a(Mash)
+      end
+    end
+  end
+end

data/templates/coverage/human.erb

@@ -0,0 +1,22 @@
+
+<% if @total == 0 %>
+  No Chef resources found, skipping coverage calculation...
+<% else %>
+ChefSpec Coverage report generated...
+
+  Total Resources:   <%= @total %>
+  Touched Resources: <%= @touched %>
+  Touch Coverage:    <%= @coverage %>%
+
+<% if @untouched_resources.empty? %>
+You are awesome and so is your test coverage! Have a fantastic day!
+
+<% else %>
+Untouched Resources:
+
+<% @untouched_resources.each do |resource| %>
+  <%= resource.to_s.ljust(32) %>   <%= resource.source_file %>:<%= resource.source_line %>
+<% end %>
+
+<% end %>
+<% end %>

data/templates/coverage/json.erb

@@ -0,0 +1,8 @@
+{ "resources":[
+  <%= @all_resources.map { |resource| resource.to_json }.join(",\n") %>
+  ],
+  "resource_count": <%= @total %>,
+  "resources_touched": <%= @touched %>,
+  "resource_coverage":    <%= @coverage %>
+
+}

data/templates/coverage/table.erb

@@ -0,0 +1,14 @@
+<%='Touched'.to_s.ljust(8) %> <%='Resource'.to_s.ljust(48) %>   File:Line
+<% @all_resources.each do |resource| %>
+<%=resource.touched?.to_s.ljust(8) %> <%= resource.to_s.ljust(48) %>   <%= resource.source_file %>:<%= resource.source_line %>
+<% end %>
+
+<% if @total == 0 %>
+  No Chef resources found, skipping coverage calculation...
+<% else %>
+ChefSpec Coverage report generated...
+
+  Total Resources:   <%= @total %>
+  Touched Resources: <%= @touched %>
+  Touch Coverage:    <%= @coverage %>%
+<% end %>

data/templates/errors/cookbook_path_not_found.erb

@@ -0,0 +1,3 @@
+I could not find or infer a cookbook_path from your current working directory.
+Please make sure you put your specs (tests) under a directory named 'spec' or
+manually set the cookbook path in the RSpec configuration.

data/templates/errors/erb_template_parse_error.erb

@@ -0,0 +1,5 @@
+An Error occured during parsing the Erb Given.
+
+Here is the original error:
+
+    <%= @original_error %>

data/templates/errors/gem_load_error.erb

@@ -0,0 +1,7 @@
+I could not load the '<%= @name %>' gem! You must have the gem installed
+on your local system before you can use the <%= @gem %> plugin.
+You can install <%= @gem %> by running:
+
+    gem install <%= @gem %>
+
+or add <%= @name %> to your Gemfile and run the `bundle` command to install.

data/templates/errors/invalid_berkshelf_options.erb

@@ -0,0 +1,4 @@
+The currently configured value for `berkshelf_options` appears to be invalid.
+This attribute must be a Ruby hash with symbol keys. The current value is:
+
+  <%= @value %>