foodcritic 12.1.0 → 12.2.0

data/lib/foodcritic/dsl.rb

@@ -56,7 +56,7 @@ module FoodCritic
     end
 
     # The most frequently used block within a rule. A slight misnomer because
-    # `recipe` rule blocks are also evaluated against providers.
+    # `recipe` rule blocks are also evaluated against resources, providers and libraries
     rule_block :recipe
 
     rule_block :cookbook

data/lib/foodcritic/linter.rb

@@ -9,7 +9,7 @@ module FoodCritic
 
     # The default version that will be used to determine relevant rules. This
     # can be over-ridden at the command line with the `--chef-version` option.
-    DEFAULT_CHEF_VERSION = "13.5.3"
+    DEFAULT_CHEF_VERSION = "13.6.0"
     attr_reader :chef_version
 
     # Perform a lint check. This method is intended for use by the command-line

data/lib/foodcritic/rules/fc075.rb

@@ -1,9 +1,7 @@
 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)
+  recipe do |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/rules/fc082.rb

@@ -1,9 +1,7 @@
 rule "FC082", "Deprecated node.set or node.set_unless used to set node attributes" do
   tags %w{chef14 deprecated}
-  def node_sets(ast)
+  recipe do |ast|
     ast.xpath('//call[(vcall|var_ref)/ident/@value="node"]
     [ident[@value="set" or @value="set_unless"]]')
   end
-  recipe { |ast| node_sets(ast) }
-  library { |ast| node_sets(ast) }
 end

data/lib/foodcritic/rules/fc084.rb

@@ -1,9 +1,6 @@
 rule "FC084", "Deprecated Chef::REST class used" do
   tags %w{chef13 deprecated}
-  def rest(ast)
+  recipe do |ast|
     ast.xpath('//const_path_ref/const[@value="REST"]/..//const[@value="Chef"]/../../..')
   end
-  recipe { |ast| rest(ast) }
-  library { |ast| rest(ast) }
-
 end

data/lib/foodcritic/rules/fc085.rb

@@ -1,8 +1,41 @@
 rule "FC085", "Resource using new_resource.updated_by_last_action to converge resource" do
   tags %w{chef13 deprecated}
   def updated_by(ast)
-    ast.xpath('//call[(vcall|var_ref)/ident/@value="new_resource"]
-      [ident/@value="updated_by_last_action"]')
+    # we need to handle both @new_resource.updated_by_last_action(true) or new_resource.updated_by_last_action(true)
+    # Here's the ast that xpath sees in all 3 possible scenarios from those two:
+    # <call value=".">
+    #   <vcall value="vcall">
+    #     <ident value="new_resource">
+    #       <pos line="26" column="0"/>
+    #     </ident>
+    #   </vcall>
+    #   <ident value="updated_by_last_action">
+    #     <pos line="26" column="13"/>
+    #   </ident>
+    # </call>
+    #
+    # <call value=".">
+    #   <var_ref value="var_ref">
+    #     <ivar value="@new_resource">
+    #       <pos line="25" column="0"/>
+    #     </ivar>
+    #   </var_ref>
+    #   <ident value="updated_by_last_action">
+    #     <pos line="25" column="14"/>
+    #   </ident>
+    # </call>
+    #
+    # <call value=".">
+    #   <var_ref value="var_ref">
+    #     <ident value="new_resource">
+    #       <pos line="27" column="0"/>
+    #     </ident>
+    #   </vcall>
+    #   <ident value="updated_by_last_action">
+    #     <pos line="27" column="13"/>
+    #   </ident>
+    # </call>
+    ast.xpath('descendant::*[self::var_ref/ident/@value="new_resource" or self::vcall/ident/@value="new_resource" or self::var_ref/ivar/@value="@new_resource"]/../ident[@value="updated_by_last_action"]')
   end
 
   resource { |ast| updated_by(ast) }

data/lib/foodcritic/rules/fc086.rb

@@ -1,10 +1,6 @@
 rule "FC086", "Use databag helper methods to load data bag items" do
   tags %w{style}
-  def old_dbag(ast)
-    ast.xpath('//const_path_ref/const[@value="EncryptedDataBagItem" or @value="DataBagItem"]/..//const[@value="Chef"]/../../..//ident[@value!="load_secret"]/..')
+  recipe do |ast|
+    ast.xpath('//const_path_ref/const[@value="EncryptedDataBagItem" or @value="DataBagItem"]/..//const[@value="Chef"]/../../..//ident[@value="load"]/..')
   end
-
-  resource { |ast| old_dbag(ast) }
-  recipe { |ast| old_dbag(ast) }
-  library { |ast| old_dbag(ast) }
 end

data/lib/foodcritic/rules/fc087.rb

@@ -1,6 +1,5 @@
 rule "FC087", "Library uses deprecated Chef::Platform methods" do
   tags %w{chef13 deprecated}
-
   library do |ast|
     ast.xpath('//const_path_ref/const[@value="Platform"]/..//const[@value="Chef"]/../../../ident[@value="set" or @value="provider_for_resource" or @value="find_provider"]')
   end

data/lib/foodcritic/rules/fc088.rb

@@ -1,11 +1,6 @@
 rule "FC088", "Prefer Mixlib::Shellout over deprecated Chef::Mixin::Command" do
   tags %w{chef13 deprecated}
-
-  def includes_command(ast)
+  recipe do |ast|
     ast.xpath('//const_path_ref/const[@value="Command"]/..//const[@value="Mixin"]/..//const[@value="Chef"]')
   end
-
-  resource { |ast| includes_command(ast) }
-  recipe { |ast| includes_command(ast) }
-  library { |ast| includes_command(ast) }
 end

data/lib/foodcritic/rules/fc089.rb

@@ -1,11 +1,6 @@
 rule "FC089", "Prefer Mixlib::Shellout over deprecated Chef::ShellOut" do
   tags %w{chef13 deprecated}
-
-  def old_shellout(ast)
+  recipe do |ast|
     ast.xpath('//const_path_ref[var_ref/const[@value="Chef"]]/const[@value="ShellOut"]')
   end
-
-  resource { |ast| old_shellout(ast) }
-  recipe { |ast| old_shellout(ast) }
-  library { |ast| old_shellout(ast) }
 end

data/lib/foodcritic/rules/fc091.rb

@@ -1,6 +1,5 @@
 rule "FC091", "Use property not attribute in custom resources" do
   tags %w{correctness}
-
   resource do |ast|
     # Make sure we're in a custom resource not an LWRP
     if ast.xpath("//command/ident/@value='action'")

data/lib/foodcritic/rules/fc092.rb

@@ -1,6 +1,5 @@
 rule "FC092", "Custom resources should not define actions" do
   tags %w{correctness}
-
   resource do |ast|
     # Make sure we're in a custom resource not an LWRP
     if ast.xpath("//command/ident/@value='action'")

data/lib/foodcritic/rules/fc093.rb

@@ -1,6 +1,5 @@
 rule "FC093", "Generated README text needs updating" do
   tags %w{readme supermarket}
-
   cookbook do |path|
     readme = File.join(path, "README.md")
     generated_readme = "TODO: Enter the cookbook description here."

data/lib/foodcritic/rules/fc094.rb

@@ -1,6 +1,5 @@
 rule "FC094", "Cookbook uses deprecated filesystem2 ohai plugin data" do
   tags %w{deprecated chef14}
-
   recipe do |ast|
     ast.xpath('//aref[vcall/ident/@value="node"]
       /args_add_block/args_add/string_literal/string_add/tstring_content[@value="filesystem2"]')

data/lib/foodcritic/rules/fc095.rb

@@ -1,6 +1,5 @@
 rule "FC095", "Cookbook uses deprecated cloud_v2 ohai plugin data" do
   tags %w{deprecated chef14}
-
   recipe do |ast|
     ast.xpath('//aref[vcall/ident/@value="node"]
       /args_add_block/args_add/string_literal/string_add/tstring_content[@value="cloud_v2"]')

data/lib/foodcritic/rules/fc096.rb

@@ -1,6 +1,5 @@
 rule "FC096", "Cookbook uses deprecated libvirt virtualization ohai data" do
   tags %w{deprecated chef14}
-
   recipe do |ast|
     ast.xpath('//aref[aref/vcall/ident/@value="node"]
       [aref/args_add_block/args_add/string_literal/string_add/tstring_content/@value="virtualization" and

data/lib/foodcritic/rules/fc097.rb

@@ -1,11 +1,7 @@
 rule "FC097", "Deprecated Chef::Mixin::LanguageIncludeAttribute mixin used" do
   tags %w{chef14 deprecated}
-  def lang_include_attrib_mixin(ast)
+  recipe do |ast|
     # include Chef::Mixin::LanguageIncludeAttribute
     ast.xpath('//const_path_ref/const[@value="LanguageIncludeAttribute"]/..//const[@value="Mixin"]/..//const[@value="Chef"]')
   end
-  recipe { |ast| lang_include_attrib_mixin(ast) }
-  library { |ast| lang_include_attrib_mixin(ast) }
-  resource { |ast| lang_include_attrib_mixin(ast) }
-
 end

data/lib/foodcritic/rules/fc098.rb

@@ -1,11 +1,7 @@
 rule "FC098", "Deprecated Chef::Mixin::RecipeDefinitionDSLCore mixin used" do
   tags %w{chef14 deprecated}
-  def recipe_def_mixin(ast)
+  recipe do |ast|
     # include Chef::Mixin::RecipeDefinitionDSLCore
     ast.xpath('//const_path_ref/const[@value="RecipeDefinitionDSLCore"]/..//const[@value="Mixin"]/..//const[@value="Chef"]')
   end
-  recipe { |ast| recipe_def_mixin(ast) }
-  library { |ast| recipe_def_mixin(ast) }
-  resource { |ast| recipe_def_mixin(ast) }
-
 end

data/lib/foodcritic/rules/fc099.rb

@@ -1,11 +1,7 @@
 rule "FC099", "Deprecated Chef::Mixin::LanguageIncludeRecipe mixin used" do
   tags %w{chef14 deprecated}
-  def lang_include_mixin(ast)
+  recipe do |ast|
     # include Chef::Mixin::LanguageIncludeRecipe
     ast.xpath('//const_path_ref/const[@value="LanguageIncludeRecipe"]/..//const[@value="Mixin"]/..//const[@value="Chef"]')
   end
-  recipe  { |ast| lang_include_mixin(ast) }
-  library { |ast| lang_include_mixin(ast) }
-  resource { |ast| lang_include_mixin(ast) }
-
 end

data/lib/foodcritic/rules/fc100.rb

@@ -1,11 +1,7 @@
 rule "FC100", "Deprecated Chef::Mixin::Language mixin used" do
   tags %w{chef14 deprecated}
-  def lang_mixin(ast)
+  recipe do |ast|
     # include Chef::Mixin::Language
     ast.xpath('//const_path_ref/const[@value="Language"]/..//const[@value="Mixin"]/..//const[@value="Chef"]')
   end
-  recipe  { |ast| lang_mixin(ast) }
-  library { |ast| lang_mixin(ast) }
-  resource { |ast| lang_mixin(ast) }
-
 end

data/lib/foodcritic/rules/fc102.rb

@@ -1,11 +1,7 @@
 rule "FC102", "Deprecated Chef::DSL::Recipe::FullDSL class used" do
   tags %w{chef14 deprecated}
-  def full_dsl(ast)
+  recipe do |ast|
     # include Chef::DSL::Recipe::FullDSL
     ast.xpath('//const_path_ref/const[@value="FullDSL"]/..//const[@value="Recipe"]/..//const[@value="DSL"]/..//const[@value="Chef"]')
   end
-  recipe  { |ast| full_dsl(ast) }
-  library { |ast| full_dsl(ast) }
-  resource { |ast| full_dsl(ast) }
-
 end

data/lib/foodcritic/rules/fc103.rb

@@ -0,0 +1,8 @@
+rule "FC103", "Deprecated :uninstall action in chocolatey_package used" do
+  tags %w{deprecated chef14}
+  recipe do |ast|
+    find_resources(ast, type: "chocolatey_package").find_all do |choco_resource|
+      resource_attribute(choco_resource, "action") == :uninstall
+    end
+  end
+end

data/lib/foodcritic/rules/fc104.rb

@@ -0,0 +1,18 @@
+rule "FC104", "Use the :run action in ruby_block instead of :create" do
+  tags %w{correctness}
+  recipe do |ast|
+    matches = []
+    find_resources(ast).each do |resource|
+      # if it's a ruby_block check for the :create action
+      if ast.xpath('//method_add_block[command/ident[@value="ruby_block"]]')
+        matches << resource if resource_attribute(resource, "action") == :create
+      end
+
+      # no matter what check notification
+      notifications(resource).any? do |notification|
+        matches << resource if notification[:resource_type] == :ruby_block && notification[:action] == :create
+      end
+    end
+    matches
+  end
+end

data/lib/foodcritic/rules/fc105.rb

@@ -0,0 +1,6 @@
+rule "FC105", "Deprecated erl_call resource used" do
+  tags %w{chef14 deprecated}
+  recipe do |ast|
+    find_resources(ast, type: "erl_call")
+  end
+end

data/lib/foodcritic/rules/fc106.rb

@@ -0,0 +1,8 @@
+rule "FC106", "Use the plist_hash property in launchd instead of hash" do
+  tags %w{deprecation chef13}
+  recipe do |ast|
+    find_resources(ast, type: "launchd").find_all do |launchd_resource|
+      resource_attribute(launchd_resource, "hash")
+    end
+  end
+end

data/lib/foodcritic/rules/fc107.rb

@@ -0,0 +1,6 @@
+rule "FC107", "Resource uses epic_fail instead of ignore_failure" do
+  tags %w{deprecated chef14}
+  recipe do |ast|
+    find_resources(ast).xpath('(.//command|.//fcall)[ident/@value="epic_fail"]')
+  end
+end

data/lib/foodcritic/rules/fc108.rb

@@ -0,0 +1,12 @@
+rule "FC108", "Resource should not define a property named 'name'" do
+  tags %w{correctness}
+  resource do |ast|
+    # Make sure we're in a custom resource not an LWRP
+    if ast.xpath("//command/ident/@value='action'")
+      # command has a child of type ident with a value of "property". That tells us
+      # we're in a property. Quite a ways desecendant from that is another ident
+      # with value of "name"
+      ast.xpath("//command[ident/@value='property' and descendant::symbol_literal/symbol/ident/@value='name']")
+    end
+  end
+end

data/lib/foodcritic/rules/fc109.rb

@@ -0,0 +1,8 @@
+rule "FC109", "Use platform-specific package resources instead of provider property" do
+  tags %w{correctness}
+  recipe do |ast|
+    find_resources(ast, type: "package").find_all do |package_resources|
+      resource_attribute(package_resources, "provider")
+    end
+  end
+end

data/lib/foodcritic/version.rb

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

data/spec/functional/fc085_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe "FC085" do
-  context "with a cookbook with a custom resource that converges with updated_by_last_action" do
+  context "with a cookbook with a custom resource that converges with new_resource.updated_by_last_action" do
     resource_file <<-EOF
     action :create do
       template "/etc/something.conf" do
@@ -14,8 +14,8 @@ describe "FC085" do
     it { is_expected.to violate_rule }
   end
 
-  context "with a cookbook with a LWRP that converges with updated_by_last_action" do
-    resource_file <<-EOF
+  context "with a cookbook with a LWRP that converges with @new_resource.updated_by_last_action" do
+    provider_file <<-EOF
     use_inline_resources
 
     action :create do
@@ -23,6 +23,15 @@ describe "FC085" do
         notifies :restart, "service[something]"
       end
 
+      @new_resource.updated_by_last_action(true)
+    end
+    EOF
+    it { is_expected.to violate_rule }
+  end
+
+  context "with a cookbook with a LWRP that converges with new_resource.updated_by_last_action in a method" do
+    provider_file <<-EOF
+    def update_me(new_resource)
       new_resource.updated_by_last_action(true)
     end
     EOF
@@ -42,7 +51,7 @@ describe "FC085" do
   end
 
   context "with a cookbook with a LWRP that relies on resources for convergence" do
-    resource_file <<-EOF
+    provider_file <<-EOF
     use_inline_resources
 
     action :create do
@@ -55,4 +64,14 @@ describe "FC085" do
     it { is_expected.to_not violate_rule }
   end
 
+  context "with a cookbook with a LWRP that calls foo.updated_by_last_action" do
+    provider_file <<-EOF
+    use_inline_resources
+
+    action :create do
+      foo.updated_by_last_action(true)
+    EOF
+    it { is_expected.to_not violate_rule }
+  end
+
 end

data/spec/functional/fc086_spec.rb

@@ -34,8 +34,12 @@ describe "FC086" do
     it { is_expected.not_to violate_rule }
   end
 
-  context "with a recipe that uses Chef::EncryptedDataBagItem.load_secret" do
-    recipe_file "data_bag_item('bag', 'item', Chef::EncryptedDataBagItem.load_secret('secret_file'))"
+  context "with a recipe that uses other Chef::EncryptedDataBagItem methods" do
+    recipe_file <<-EOF
+     data_bag_item('bag', 'item', Chef::EncryptedDataBagItem.load_secret('secret_file'))
+     encrypted_item = Chef::EncryptedDataBagItem.encrypt_data_bag_item(original_item, Chef::EncryptedDataBagItem.load_secret)
+     bag = Chef::DataBagItem.new
+    EOF
     it { is_expected.not_to violate_rule }
   end
 end

data/spec/functional/fc103_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe "FC103" do
+  context "with a cookbook with a custom resource that uses the :uninstall resource in chocolatey_package" do
+    resource_file <<-EOF
+    chocolatey_package 'name' do
+      action :uninstall
+    end
+    EOF
+    it { is_expected.to violate_rule }
+  end
+
+  context "with a cookbook with a recipe that uses the :uninstall resource in chocolatey_package" do
+    recipe_file <<-EOF
+    chocolatey_package 'name' do
+      action :uninstall
+    end
+    EOF
+    it { is_expected.to violate_rule }
+  end
+
+  context "with a cookbook with a library that uses the :uninstall resource in chocolatey_package" do
+    library_file <<-EOF
+    chocolatey_package 'name' do
+      action :uninstall
+    end
+    EOF
+    it { is_expected.to violate_rule }
+  end
+end