foodcritic 10.2.2 → 10.3.0

data/lib/foodcritic/rules/fc070.rb

@@ -0,0 +1,63 @@
+rule "FC070", "Ensure supports metadata defines valid platforms" do
+  tags %w{metadata supermarket}
+  metadata do |ast, filename|
+    # Where did this come from? We pulled every unique platform for supermarket cookbooks
+    # and then looked at all the invalid names. Lots of typos and bad characters and then
+    # a few entirely made up platforms
+    bad_chars = [" ", "'", ",", "\"", "/", "]", "[", "{", "}", "-", "=", ">"]
+    invalid_platforms = %w{
+      aws
+      archlinux
+      amazonlinux
+      darwin
+      debuan
+      mingw32
+      mswin
+      mac_os_x_server
+      linux
+      oel
+      oraclelinux
+      rhel
+      schientific
+      scientificlinux
+      sles
+      solaris
+      true
+      ubundu
+      ubunth
+      ubunutu
+      windwos
+      xcp
+    }
+    matches = false
+
+    metadata_platforms = supported_platforms(ast).map { |x| x[:platform] }
+
+    metadata_platforms.each do |plat|
+      break if matches # we found one on the previous run so stop looking
+
+      # see if the platform is uppercase, which is invalid
+      unless plat.scan(/[A-Z]/).empty?
+        matches = true
+        break # stop looking
+      end
+
+      # search for platform strings with bad strings in them
+      # these can't possibly be valid platforms
+      bad_chars.each do |char|
+        unless plat.scan(char).empty?
+          matches = true
+          break # stop looking
+        end
+      end
+
+      # see if the platform is a commonly mistaken platform string
+      if invalid_platforms.include?(plat)
+        matches = true
+        break # stop looking
+      end
+    end
+
+    [file_match(filename)] if matches
+  end
+end

data/lib/foodcritic/rules/fc071.rb

@@ -0,0 +1,6 @@
+rule "FC071", "Missing LICENSE file" do
+  tags %w{style license}
+  cookbook do |path|
+    ensure_file_exists(path, "LICENSE")
+  end
+end

data/lib/foodcritic/rules/fc072.rb

@@ -0,0 +1,6 @@
+rule "FC072", 'Metadata should not contain "attribute" keyword' do
+  tags %w{metadata style}
+  metadata do |ast, filename|
+    [file_match(filename)] if field(ast, "attribute").any?
+  end
+end

data/lib/foodcritic/rules/fc073.rb

@@ -0,0 +1,17 @@
+rule "FC073", "Root alias file shadowing non-alias file" do
+  tags %w{correctness chef13}
+  cookbook do |path|
+    {
+      "attributes.rb" => "attributes/default.rb",
+      "recipe.rb" => "recipes/default.rb",
+    }.map do |alias_path, folder_path|
+      full_alias_path = File.join(path, alias_path)
+      full_folder_path = File.join(path, folder_path)
+      if File.exist?(full_alias_path) && File.exist?(full_folder_path)
+        file_match(full_folder_path)
+      else
+        nil
+      end
+    end.compact
+  end
+end

data/lib/foodcritic/rules/fc074.rb

@@ -0,0 +1,10 @@
+rule "FC074", "LWRP should use DSL to define resource's default action" do
+  tags %w{correctness lwrp}
+  resource do |ast, filename|
+    # See if we're in a custom resource not an LWRP. Only LWRPs need the default_action
+    if ["//def/bodystmt/descendant::assign/
+      var_field/ivar/@value='@action'"].any? { |expr| ast.xpath(expr) }
+      [file_match(filename)]
+    end
+  end
+end

data/lib/foodcritic/rules/fc075.rb

@@ -0,0 +1,9 @@
+rule "FC075", "Cookbook uses node.save to save partial node data to the chef-server mid-run" do
+  tags %w{correctness}
+  def node_saves(ast)
+    ast.xpath('//call[(vcall|var_ref)/ident/@value="node"]
+    [ident/@value="save"]')
+  end
+  recipe { |ast| node_saves(ast) }
+  library { |ast| node_saves(ast) }
+end

data/lib/foodcritic/version.rb

@@ -1,4 +1,4 @@
 module FoodCritic
   # The current version of foodcritic
-  VERSION = "10.2.2"
+  VERSION = "10.3.0"
 end

data/spec/functional/fc001_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+describe "FC001" do
+  context "with a cookbook with a single recipe that reads node attributes via symbols" do
+    recipe_file "log node[:foo]\n"
+    it { is_expected.to violate_rule("FC001") }
+  end
+
+  context "with a cookbook with a single recipe that accesses multiple node attributes via symbols" do
+    recipe_file "node[:foo] = 'bar'\nnode[:testing] = 'bar'\n"
+    it { is_expected.to violate_rule("FC001") }
+  end
+
+  context "with a cookbook with a single recipe that assigns node attributes accessed via symbols to a local variable" do
+    recipe_file "baz = node[:foo]\n"
+    it { is_expected.to violate_rule("FC001") }
+  end
+
+  context "with a cookbook with a single recipe that accesses nested node attributes via symbols" do
+    recipe_file "node[:foo][:foo2] = 'bar'\n"
+    it { is_expected.to violate_rule("FC001") }
+  end
+
+  context "with a cookbook with a single recipe that reads node attributes via strings" do
+    recipe_file "log node['foo']\n"
+    it { is_expected.to_not violate_rule("FC001") }
+  end
+
+  context "with a cookbook with a single recipe that searches based on a node attribute accessed via strings" do
+    recipe_file %Q{remote = search(:node, "name:\#{node['drbd']['remote_host']}")[0]\n}
+    it { is_expected.to_not violate_rule("FC001") }
+  end
+
+  context "with a cookbook with a single recipe that passes node attributes accessed via symbols to a template" do
+    recipe_file <<-EOH
+      template "/etc/foo" do
+        source "foo.erb"
+        variables({
+          :port => node[:foo][:port],
+          :user => node[:foo][:user]
+        })
+      end
+    EOH
+    it { is_expected.to violate_rule("FC001").in("recipes/default.rb:4") }
+    it { is_expected.to violate_rule("FC001").in("recipes/default.rb:5") }
+  end
+
+  context "with a cookbook that declares default attributes via symbols" do
+    attributes_file "default[:apache][:dir] = '/etc/apache2'\n"
+    it { is_expected.to violate_rule("FC001") }
+  end
+
+  context "with a cookbook that declares override attributes via symbols" do
+    attributes_file "override[:apache][:dir] = '/etc/apache2'\n"
+    it { is_expected.to violate_rule("FC001") }
+  end
+
+  context "with a cookbook that declares set attributes via symbols" do
+    attributes_file "set[:apache][:dir] = '/etc/apache2'\n"
+    it { is_expected.to violate_rule("FC001") }
+  end
+
+  context "with a cookbook that declares normal attributes via symbols" do
+    attributes_file "normal[:apache][:dir] = '/etc/apache2'\n"
+    it { is_expected.to violate_rule("FC001") }
+  end
+end

data/spec/functional/fc008_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe "FC008" do
+  context "with a cookbook with a metadata file containing boilerplate maintainer from knife CLI" do
+    metadata_file "maintainer 'YOUR_COMPANY_NAME'"
+    it { is_expected.to violate_rule("FC008") }
+  end
+
+  context "with a cookbook with a metadata file containing boilerplate maintainer from chef CLI" do
+    metadata_file "maintainer 'The Authors'"
+    it { is_expected.to violate_rule("FC008") }
+  end
+
+  context "with a cookbook with a metadata file containing boilerplate maintainer_email from knife CLI" do
+    metadata_file "maintainer_email 'YOUR_EMAIL'"
+    it { is_expected.to violate_rule("FC008") }
+  end
+
+  context "with a cookbook with a metadata file containing boilerplate maintainer_email from chef CLI" do
+    metadata_file "maintainer_email 'you@example.com'"
+    it { is_expected.to violate_rule("FC008") }
+  end
+
+  context "with a cookbook with a metadata file containing non-boilerplate maintainer and maintainer_email" do
+    metadata_file "maintainer 'John Smith'\nmaintainer_email 'john@smith.com'"
+    it { is_expected.not_to violate_rule("FC008") }
+  end
+
+  context "with a cookbook with a metadata file not containing maintainer or maintainer_email" do
+    metadata_file
+    it { is_expected.not_to violate_rule("FC008") }
+  end
+end

data/spec/functional/fc011_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe "FC011" do
+  context "with a cookbook with a README.md file" do
+    metadata_file "name 'mycookbook'"
+    file("README.md")
+    it { is_expected.not_to violate_rule("FC011") }
+  end
+
+  context "with a cookbook without a README.md file" do
+    metadata_file "name 'mycookbook'"
+    it { is_expected.to violate_rule("FC011") }
+  end
+
+  context "with a cookbook with a README.rdoc file" do
+    metadata_file "name 'mycookbook'"
+    file("README.rdoc")
+    it { is_expected.to violate_rule("FC011") }
+  end
+end

data/spec/functional/fc012_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe "FC012" do
+  context "with a cookbook with a README.md file" do
+    metadata_file "name 'mycookbook'"
+    file("README.md")
+    it { is_expected.not_to violate_rule("FC012") }
+  end
+
+  context "with a cookbook without a README file" do
+    metadata_file "name 'mycookbook'"
+    it { is_expected.not_to violate_rule("FC012") }
+  end
+
+  context "with a cookbook with a README.rdoc file" do
+    metadata_file "name 'mycookbook'"
+    file("README.rdoc")
+    it { is_expected.to violate_rule("FC012") }
+  end
+end

data/spec/functional/fc016_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe "FC016" do
+
+  context "with a cookbook with a LWRP that includes a default_action" do
+    resource_file <<-EOH
+      actions :create, :remove
+      default_action :create
+
+      attribute :name, String, name_attribute: true
+    EOH
+    it { is_expected.to_not violate_rule("FC016") }
+  end
+
+  context "with a cookbook with a LWRP that includes a non-DSL default_action" do
+    resource_file <<-EOH
+      actions :create, :remove,
+
+      def initialize(*args)
+        super
+        @action = :create
+      end
+
+      attribute :name, String, name_attribute: true
+    EOH
+    it { is_expected.to_not violate_rule("FC016") }
+  end
+
+  context "with a cookbook with a LWRP that does not include a default_action" do
+    resource_file <<-EOH
+      actions :create, :remove,
+
+      attribute :name, String, name_attribute: true
+    EOH
+    it { is_expected.to violate_rule("FC016") }
+  end
+
+  context "with a custom resource" do
+    resource_file <<-EOH
+      property :name, String, name_property: true
+
+      action :create do
+        cookbook_file "/etc/something"
+      end
+    EOH
+    it { is_expected.to_not violate_rule("FC016") }
+  end
+end

data/spec/functional/fc028_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe "FC028" do
+  context "with a cookbook with a single recipe that calls platform? without parentheses for a single platform" do
+    recipe_file "platform? 'ubuntu'"
+    it { is_expected.not_to violate_rule("FC028") }
+  end
+
+  context "with a cookbook with a single recipe that calls platform? without parentheses for two platforms" do
+    recipe_file "platform?('ubuntu','windows')"
+    it { is_expected.not_to violate_rule("FC028") }
+  end
+
+  context "with a cookbook with a single recipe that calls platform? with parentheses for a single platform" do
+    recipe_file "platform?('ubuntu')"
+    it { is_expected.not_to violate_rule("FC028") }
+  end
+
+  context "with a cookbook with a single recipe that calls platform? with parentheses for two platforms" do
+    recipe_file "platform?('ubuntu', 'windows')"
+    it { is_expected.not_to violate_rule("FC028") }
+  end
+
+  context "with a cookbook with a single recipe that compares a value against node.platform" do
+    recipe_file "node.platform == 'ubuntu'"
+    it { is_expected.not_to violate_rule("FC028") }
+  end
+
+  context "with a cookbook with a single recipe that uses checks a value against node.platform" do
+    recipe_file "node.platform == 'ubuntu'"
+    it { is_expected.not_to violate_rule("FC028") }
+  end
+
+  context "with a cookbook with a single recipe that calls node.platform? without a parentheses" do
+    recipe_file "node.platform? 'ubuntu'"
+    it { is_expected.to violate_rule("FC028") }
+  end
+
+  context "with a cookbook with a single recipe that calls node.platform? with a parentheses" do
+    recipe_file "node.platform?('ubuntu')"
+    it { is_expected.to violate_rule("FC028") }
+  end
+
+  context "with a cookbook with a single recipe that calls node.platform? with a parentheses for 2 platforms" do
+    recipe_file "node.platform?('ubuntu', 'windows')"
+    it { is_expected.to violate_rule("FC028") }
+  end
+end

data/spec/functional/fc029_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe "FC029" do
+  context "with a cookbook with a metadata file that doesn't contain the recipe keyword" do
+    metadata_file("name 'example'")
+    it { is_expected.not_to violate_rule("FC029") }
+  end
+
+  context "with a cookbook with a metadata file that contains contain the recipe keyword with the cookbook name only" do
+    metadata_file("name 'example'\nrecipe 'example', 'Installs Example'")
+    it { is_expected.not_to violate_rule("FC029") }
+  end
+
+  context "with a cookbook with a metadata file that contains the recipe keyword with the cookbook::recipe format name" do
+    metadata_file("name 'example'\nrecipe 'example::default', 'Installs Example'")
+    it { is_expected.not_to violate_rule("FC029") }
+  end
+
+  context "with a cookbook with a metadata file that contains the recipe keyword and lacks the cookbook name" do
+    metadata_file("name 'example'\nrecipe 'default', 'Installs Example'")
+    it { is_expected.to violate_rule("FC029") }
+  end
+
+  context "with a cookbook with a metadata file that contains the recipe keyword and stores full recipe name as a var" do
+    metadata_file("name 'example'\nvar = 'example::default'\nrecipe my_var, 'Installs Example'")
+    it { is_expected.not_to violate_rule("FC029") }
+  end
+
+  context "with a cookbook with a metadata file that contains the recipe keyword and stores part of the recipe name as a var" do
+    metadata_file('name "example"\nvar = "example"\nrecipe "#{my_var}::default", "Installs Example"')
+    it { is_expected.not_to violate_rule("FC029") }
+  end
+end

data/spec/functional/fc031_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe "FC031" do
+  context "with a cookbook with a metadata file" do
+    metadata_file
+    recipe_file
+    it { is_expected.to_not violate_rule("FC031") }
+  end
+
+  context "with a cookbook without a metadata file" do
+    recipe_file
+    it { is_expected.to violate_rule("FC031") }
+  end
+end

data/spec/functional/fc042_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe "FC042" do
+  context "with a cookbook with a single recipe that uses require_recipe" do
+    recipe_file "require_recipe 'my_recipe::default'"
+    it { is_expected.to violate_rule("FC042") }
+  end
+
+  context "with a cookbook with a single recipe that uses include_recipe" do
+    recipe_file "include_recipe 'my_recipe::default'"
+    it { is_expected.not_to violate_rule("FC042") }
+  end
+end

data/spec/functional/fc045_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe "FC045" do
+  context "with a cookbook with a metadata file that includes the name keyword" do
+    metadata_file "name 'food'"
+    it { is_expected.to_not violate_rule("FC045") }
+  end
+
+  context "with a cookbook with a metadata file that doesn't include the name keyword" do
+    metadata_file
+    it { is_expected.to violate_rule("FC045") }
+  end
+
+  context "with a cookbook without a metadata file" do
+    recipe_file
+    it { is_expected.to_not violate_rule("FC045") }
+  end
+end