foodcritic 10.4.1 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6be21ce54a9247d8ab5fb96fa65056e1b4031a32
-  data.tar.gz: 2de7963ef01d1170af9ca58bf88ba381d057391f
+  metadata.gz: c5c06e37056b5db3985f94fea5101961eeec4164
+  data.tar.gz: 610fe94a45ecd4412e77ac18abcd66129fe3d75d
 SHA512:
-  metadata.gz: 194e8fb9cdc2e0372cddedd2290c14608a1395c9f7669fc256d4570ed20494ea0d2236b5ce9469a4f0811410a09308c6332e1773c8317366d0840d97156a5601
-  data.tar.gz: bf129cbbab3b85414d432e64ee7c04edcf413158494cf076ab3323c89442df3290221973844e2d4c9eaf7af0f2212e885d58a389b89d523c2d8cbe9103727205
+  metadata.gz: 6471cb860d9e922e4ee238b9b88647cb68c7c161123d7ad223dfec4733b3c741683db9173889a19f524f8269ae223483a3aec21eaaef020ac3681942f890efe4
+  data.tar.gz: 31ba9be090cafd5935d660ed91456da49a8efbff002f3301ec5e81466b2c9295a7a07a4982b1b58334adb05da5ed3419de54faaba99ebdd3303173ecdcb6978f

data/CHANGELOG.md

@@ -1,6 +1,31 @@
 # Foodcritic Changelog:
 
-## [10.4.0](https://github.com/acrmp/foodcritic/tree/v10.4.1) (2017-04-17)
+## [11.0.0](https://github.com/acrmp/foodcritic/tree/v11.0.0) (2017-04-24)
+
+[Full Changelog](https://github.com/acrmp/foodcritic/compare/v10.4.1...v11.0.0)
+
+**Implemented enhancements:**
+
+- Added `FC079` to detect the usage of the easy_install_package resource which is deprecated in Chef 13\. Tags: deprecated, chef13.
+- Added `FC080` to detect user resources that include the supports property, which is deprecated in Chef 13\. Tags: deprecated, chef13.
+- Added `FC081` to detect a cookbook that depends on the partial_search cookbook as partial search functionality is built into Chef 12 and later. Tags: chef12.
+- Added `FC082` to detect the usage of node.set and node.set_unless which will be removed in Chef 14\. Tags: deprecated, chef14.
+- Added `FC083` to detect execute resources that include the path property, which is deprecated in Chef 12\. Tags: deprecated, chef13.
+- Added `FC084` to detect usage of the deprecated Chef::REST class. Tags: deprecated, chef13.
+- Added `FC085` to detect usage of new_resource.updated_by_last_action to converge resources. Tags: deprecated, chef13.
+- Updated and refactored API methods `declared_dependencies`, `supported_platforms`, and `word_list_values`
+- Deprecated API methods `checks_for_chef_solo` and `chef_solo_search_supported?` have been removed.
+- Added a new API method `json_file_to_hash` for loading json files as a hash.
+- Added a new rake command to run the regression test on just a single cookbook
+
+**Fixed bugs:**
+
+- Multiple rules have been rewritten to use Foodcritic APIs instead of using XPATH queries directly. This avoids false positives created by overly simplistic queries.
+- Fixed FC069 to skip if the license metadata is any formatting of 'All Rights Reserved'.
+- Added the `license` and `supermarket` tag to FC078.
+- Updated the `field` and `field_value` API methods to correctly recognize additional formats of data in the metdata.
+
+## [10.4.1](https://github.com/acrmp/foodcritic/tree/v10.4.1) (2017-04-17)
 
 [Full Changelog](https://github.com/acrmp/foodcritic/compare/v10.4.0...v10.4.1)
 

data/Rakefile

@@ -10,7 +10,7 @@ RSpec::Core::RakeTask.new(:spec, :tag) do |t, args|
     a << "--format #{ENV['CI'] ? 'documentation' : 'Fuubar'}"
     a << "--backtrace" if ENV["DEBUG"]
     a << "--seed #{ENV['SEED']}" if ENV["SEED"]
-    a << "--tag ~regression" unless ENV["CI"] || args[:tag] == "regression"
+    a << "--tag ~regression" unless ENV["CI"] || args[:tag].to_s =~ /regression/
     a << "--tag #{args[:tag]}" if args[:tag]
   end.join(" ")
 end
@@ -65,3 +65,9 @@ task :regen_regression do
     end
   end
 end
+
+desc "Run one regression test (or all of them)"
+task :regression, [:cookbook] do |t, args|
+  tag = args[:cookbook] ? "regression_#{args[:cookbook]}" : "regression"
+  Rake::Task["spec"].invoke(tag)
+end

data/features/step_definitions/cookbook_steps.rb

@@ -409,61 +409,6 @@ Given 'a cookbook recipe that has a confusingly named local variable "default"'
   }
 end
 
-Given /^a cookbook recipe that includes a local recipe(.*)$/ do |diff_name|
-  cookbook = diff_name.empty? ? "example" : "foo"
-  write_recipe %Q{
-    include_recipe '#{cookbook}::server'
-  }
-  write_metadata %Q{
-    name '#{cookbook}'
-  }
-end
-
-Given /^a cookbook recipe that includes a recipe name from an( embedded)? expression(.*)$/ do |embedded, expr|
-  if embedded
-    write_recipe %Q{
-      include_recipe "#{expr.strip}"
-    }
-  else
-    write_recipe %q{
-      include_recipe node['foo']['bar']
-    }
-  end
-
-  write_metadata %q{
-    depends "foo"
-  }
-end
-
-Given /^a cookbook recipe that includes a(n un| )?declared recipe dependency(?: {0,1})(unscoped)?( with parentheses)?$/ do |undeclared, unscoped, parens|
-  recipe_with_dependency(:is_declared => undeclared.strip.empty?,
-                         :is_scoped => unscoped.nil?, :parentheses => parens)
-end
-
-Given "a cookbook recipe that includes both declared and undeclared recipe dependencies" do
-  write_recipe %q{
-    include_recipe "foo::default"
-    include_recipe "bar::default"
-    file "/tmp/something" do
-      action :delete
-    end
-    include_recipe "baz::default"
-  }
-  write_metadata %q{
-    ['foo', 'bar'].each{|cbk| depends cbk}
-  }
-end
-
-Given "a cookbook that uses the include_recipe shorthand syntax" do
-  write_recipe %q{
-    include_recipe "::some_recipe"
-  }
-end
-
-Given /^a cookbook recipe that includes several declared recipe dependencies - (brace|block)$/ do |brace_or_block|
-  cookbook_declares_dependencies(brace_or_block.to_sym)
-end
-
 Given /a cookbook recipe that (install|upgrade)s (a gem|multiple gems)(.*)$/ do |action, arity, approach|
   if arity == "a gem"
     if approach.empty?
@@ -942,12 +887,6 @@ Given /^a cookbook that does not contain a definition and has (no|a) definitions
   }
 end
 
-Given "a cookbook that does not have defined metadata" do
-  write_recipe %q{
-    include_recipe "foo::default"
-  }
-end
-
 Given /^a cookbook that has ([^ ]+) problems$/ do |problems|
   cookbook_that_matches_rules(
     problems.split(",").map do |problem|
@@ -1132,14 +1071,6 @@ Given /^a directory that contains a role file ([^ ]+) in (json|ruby) that define
   role(:role_name => %Q{"#{role_name}"}, :file_name => file_name, :format => format.to_sym)
 end
 
-Given "a directory that contains a ruby role that declares the role name more than once" do
-  role(:role_name => ['"webserver"', '"apache"'], :file_name => "webserver.rb")
-end
-
-Given "a directory that contains a ruby role with an expression as its name" do
-  role(:role_name => '"#{foo}#{bar}"', :file_name => "webserver.rb")
-end
-
 Given /^a directory that contains an environment file (.*) in ruby that defines environment name (.*)$/ do |file_name, env_name|
   environment(:environment_name => %Q{"#{env_name}"}, :file_name => "production.rb")
 end
@@ -1411,10 +1342,6 @@ Given "the gems have been vendored" do
   vendor_gems
 end
 
-Given "the last role name declared does not match the containing filename" do
-
-end
-
 Given /^the inferred template contains the expression (.*)$/ do |expr|
   write_file "cookbooks/example/templates/default/config.conf.erb", %Q{
     <%= #{expr} %>
@@ -1489,10 +1416,6 @@ Given "a recipe that tries to mask a systemd service" do
   }
 end
 
-Given /^a ruby environment file that defines an environment with name (.*)$/ do |env_name|
-  environment(:environment_name => %Q{"#{env_name}"}, :file_name => "production.rb")
-end
-
 Given /^a ruby environment that triggers FC050 with comment (.*)$/ do |comment|
   write_file "environments/production.rb", %Q{
     name "Production (eu-west-1)" #{comment}
@@ -1500,10 +1423,6 @@ Given /^a ruby environment that triggers FC050 with comment (.*)$/ do |comment|
   }.strip
 end
 
-Given /^a ruby role file that defines a role with name (.*)$/ do |role_name|
-  role(:role_name => [%Q{"#{role_name}"}], :file_name => "webserver.rb")
-end
-
 Given /^a ruby role that triggers FC049 with comment (.*)$/ do |comment|
   write_file "roles/webserver.rb", %Q{
     name "apache" #{comment}
@@ -1634,15 +1553,6 @@ When "I check the role directory" do
   run_lint ["--no-progress", "-R", "roles"]
 end
 
-When /^I check the role directory as a (default|cookbook|role) path$/ do |path_type|
-  options = case path_type
-    when "default" then ["--no-progress", "roles"]
-    when "cookbook" then ["--no-progress", "-B", "roles"]
-    when "role" then ["--no-progress", "-R", "roles"]
-  end
-  run_lint(options)
-end
-
 When "I check the webserver role only" do
   run_lint ["--no-progress", "-R", "roles/webserver.rb"]
 end
@@ -1945,12 +1855,6 @@ Then /^the template partials loop indefinitely warning 051 should (not )?be disp
                           :expect_warning => ! not_shown)
 end
 
-Then "the undeclared dependency warning 007 should be displayed only for the undeclared dependencies" do
-  expect_warning("FC007", :file => "recipes/default.rb", :line => 1, :expect_warning => false)
-  expect_warning("FC007", :file => "recipes/default.rb", :line => 2, :expect_warning => false)
-  expect_warning("FC007", :file => "recipes/default.rb", :line => 6, :expect_warning => true)
-end
-
 Then /^the unused template variables warning 034 should (not )?be displayed against the (?:inferred )?template(.*)?$/ do |not_shown, ext|
   file = if ext.empty?
            "templates/default/config.conf.erb"

data/lib/foodcritic/api.rb

@@ -1,5 +1,6 @@
 require "nokogiri"
 require "rufus-lru"
+require "json"
 
 module FoodCritic
   # Helper methods that form part of the Rules DSL.
@@ -44,56 +45,6 @@ module FoodCritic
       end
     end
 
-    # Does the specified recipe check for Chef Solo?
-    #
-    # @deprecated chef-solo functionality in Chef has been replaced with local-mode
-    #  so this helper is no longer necessary and will be removed in Foodcritic 11.0
-    def checks_for_chef_solo?(ast)
-      $stderr.puts "the checks_for_chef_solo? helper is deprecated and will be removed from the next release of Foodcritic"
-      raise_unless_xpath!(ast)
-      # TODO: This expression is too loose, but also will fail to match other
-      # types of conditionals.
-      (!ast.xpath(%q{//*[self::if or self::ifop or self::unless]/
-        *[self::aref or child::aref or self::call]
-        [count(descendant::const[@value = 'Chef' or @value = 'Config']) = 2
-          and
-            (   count(descendant::ident[@value='solo']) > 0
-            or  count(descendant::tstring_content[@value='solo']) > 0
-            )
-          ]}).empty?) ||
-        ast.xpath('//if_mod[return][aref/descendant::ident/@value="solo"]/aref/
-          const_path_ref/descendant::const').map do |c|
-          c["value"]
-        end == %w{Chef Config}
-    end
-
-    # Is the chef-solo-search library available?
-    #
-    # @see https://github.com/edelight/chef-solo-search
-    # @deprecated chef-solo functionality in Chef has been replaced with local-mode
-    #  so this helper is no longer necessary and will be removed in Foodcritic 11.0
-    def chef_solo_search_supported?(recipe_path)
-      $stderr.puts "the chef_solo_search_supported? helper is deprecated and will be removed from the next release of Foodcritic"
-      return false if recipe_path.nil? || !File.exist?(recipe_path)
-
-      # Look for the chef-solo-search library.
-      #
-      # TODO: This will not work if the cookbook that contains the library
-      # is not under the same `cookbook_path` as the cookbook being checked.
-      cbk_tree_path = Pathname.new(File.join(recipe_path, "../../.."))
-      search_libs = Dir[File.join(cbk_tree_path.realpath,
-                                  "*/libraries/search.rb")]
-
-      # True if any of the candidate library files match the signature:
-      #
-      #     class Chef
-      #       def search
-      search_libs.any? do |lib|
-        !read_ast(lib).xpath(%q{//class[count(descendant::const[@value='Chef']
-          ) = 1]/descendant::def/ident[@value='search']}).empty?
-      end
-    end
-
     # The absolute path of a cookbook from the specified file.
     #
     # @author Tim Smith - tsmith@chef.io
@@ -113,7 +64,11 @@ module FoodCritic
       file
     end
 
-    # Support function to retrieve a metadata field
+    # Retrieves a value of a metadata field.
+    #
+    # @author Miguel Fonseca
+    # @since 7.0.0
+    # @return [String] the value of the metadata field
     def metadata_field(file, field)
       until (file.split(File::SEPARATOR) & standard_cookbook_subdirs).empty?
         file = File.absolute_path(File.dirname(file.to_s))
@@ -133,6 +88,9 @@ module FoodCritic
     end
 
     # The name of the cookbook containing the specified file.
+    #
+    # @param file [String] file within a cookbook
+    # @return [String] name of the cookbook
     def cookbook_name(file)
       raise ArgumentError, "File cannot be nil or empty" if file.to_s.empty?
 
@@ -149,14 +107,20 @@ module FoodCritic
       end
     end
 
-    # The maintainer of the cookbook containing the specified file.
+    # Return metadata maintainer property given any file in the cookbook
+    #
+    # @param file [String] file within a cookbook
+    # @return [String] the maintainer of the cookbook
     def cookbook_maintainer(file)
       raise ArgumentError, "File cannot be nil or empty" if file.to_s.empty?
 
       metadata_field(file, "maintainer")
     end
 
-    # The maintainer email of the cookbook containing the specified file.
+    # Return metadata maintainer_email property given any file in the cookbook
+    #
+    # @param file [String] file within a cookbook
+    # @return [String] email of the maintainer of the cookbook
     def cookbook_maintainer_email(file)
       raise ArgumentError, "File cannot be nil or empty" if file.to_s.empty?
 
@@ -167,33 +131,38 @@ module FoodCritic
     def declared_dependencies(ast)
       raise_unless_xpath!(ast)
 
+      deps = []
       # String literals.
       #
       #     depends 'foo'
-      deps = ast.xpath(%q{//command[ident/@value='depends']/
-        descendant::args_add/descendant::tstring_content[1]})
+      deps += field(ast, "depends").xpath("descendant::args_add/descendant::tstring_content[1]")
 
       # Quoted word arrays are also common.
       #
       #     %w{foo bar baz}.each do |cbk|
       #       depends cbk
       #     end
-      deps = deps.to_a +
-        word_list_values(ast, "//command[ident/@value='depends']")
-      deps.uniq.map { |dep| dep["value"].strip }
+      deps += word_list_values(field(ast, "depends"))
+      deps.uniq!
+      deps.map! { |dep| dep["value"].strip }
+      deps
     end
 
-    # The key / value pair in an environment or role ruby file
+    # Look for a method call with a given name.
+    #
+    # @param ast [Nokogiri::XML::Node] Document to search under
+    # @param field_name [String] Method name to search for
+    # @return [Nokogiri::XML::NodeSet]
     def field(ast, field_name)
       if field_name.nil? || field_name.to_s.empty?
         raise ArgumentError, "Field name cannot be nil or empty"
       end
-      ast.xpath("//command[ident/@value='#{field_name}']")
+      ast.xpath("(.//command[ident/@value='#{field_name}']|.//fcall[ident/@value='#{field_name}']/..)")
     end
 
     # The value for a specific key in an environment or role ruby file
     def field_value(ast, field_name)
-      field(ast, field_name).xpath('args_add_block/descendant::tstring_content
+      field(ast, field_name).xpath('.//args_add_block//tstring_content
         [count(ancestor::args_add) = 1][count(ancestor::string_add) = 1]
         /@value').map { |a| a.to_s }.last
     end
@@ -376,25 +345,33 @@ module FoodCritic
     end
 
     # The list of standard cookbook sub-directories.
+    #
+    # @since 1.0.0
+    # @return [array] array of all default sub-directories in a cookbook
     def standard_cookbook_subdirs
       %w{attributes definitions files libraries providers recipes resources
          templates}
     end
 
-    # Platforms declared as supported in cookbook metadata
+    # Platforms declared as supported in cookbook metadata. Returns an array
+    # of hashes containing the name and version constraints for each platform.
+    #
+    # @param ast [Nokogiri::XML::Node] Document to search from.
+    # @return [Array<Hash>]
     def supported_platforms(ast)
-      platforms = ast.xpath('//command[ident/@value="supports"]/
-        descendant::*[self::string_literal or self::symbol_literal]
-        [position() = 1]
-        [self::symbol_literal or count(descendant::string_add) = 1]/
-        descendant::*[self::tstring_content | self::ident]')
-      platforms = platforms.to_a +
-        word_list_values(ast, "//command[ident/@value='supports']")
+      # Find the supports() method call.
+      platforms_ast = field(ast, "supports")
+      # Look for the first argument (the node next to the top args_new) and
+      # filter out anything with a string_embexpr since that can't be parsed
+      # statically. Then grab the static value for both strings and symbols, and
+      # finally combine it with the word list (%w{}) analyzer.
+      platforms = platforms_ast.xpath("(.//args_new)[1]/../*[not(.//string_embexpr)]").xpath(".//tstring_content|.//symbol/ident") | word_list_values(platforms_ast)
       platforms.map do |platform|
-        versions = platform.xpath('ancestor::args_add[position() > 1]/
-	  string_literal/descendant::tstring_content/@value').map { |v| v.to_s }
-        { platform: platform["value"].lstrip, versions: versions }
-      end.sort { |a, b| a[:platform] <=> b[:platform] }
+        # For each platform value, look for all arguments after the first, then
+        # extract the string literal value.
+        versions = platform.xpath("ancestor::args_add[not(args_new)]/*[position()=2]//tstring_content/@value")
+        { platform: platform["value"].lstrip, versions: versions.map(&:to_s) }
+      end.sort_by { |p| p[:platform] }
     end
 
     # Template filename
@@ -436,6 +413,23 @@ module FoodCritic
       end
     end
 
+    # Give a filename path it returns the hash of the JSON contents
+    #
+    # @author Tim Smith - tsmith@chef.io
+    # @since 11.0
+    # @param filename [String] path to a file in JSON format
+    # @return [Hash] hash of JSON content
+    def json_file_to_hash(filename)
+      raise "File #{filename} not found" unless File.exist?(filename)
+
+      file = File.read(filename)
+      begin
+        JSON.parse(file)
+      rescue RuntimeError
+        raise "File #{filename} does not appear to contain valid JSON"
+      end
+    end
+
     private
 
     def block_attributes(resource)
@@ -642,14 +636,18 @@ module FoodCritic
       end.sort
     end
 
-    def word_list_values(ast, xpath)
-      var_ref = ast.xpath("#{xpath}/descendant::var_ref/ident")
+    def word_list_values(ast, xpath = nil)
+      # Find the node for the field argument variable. (e.g. given `foo d`, find `d`)
+      var_ref = ast.xpath("#{xpath ? xpath + '/' : ''}descendant::var_ref/ident")
       if var_ref.empty?
-        []
+        # The field is either a static value, or took no arguments, or something
+        # more complex than we care to evaluate.
+        Nokogiri::XML::NodeSet.new(ast.document)
       else
-        ast.xpath(%Q{descendant::block_var/params/
-          ident#{var_ref.first['value']}/ancestor::method_add_block/call/
-          descendant::tstring_content})
+        # Look back out the tree for a method_add_block which contains a block
+        # variable matching the field argument variable, and then drill down to
+        # all the literal content nodes.
+        ast.xpath(%Q{ancestor::method_add_block[//block_var//ident/@value='#{var_ref.first['value']}']/call//tstring_content})
       end
     end
   end