foodcritic 10.0.0 → 10.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47f475c9716a5e803b5bd2053fdc626e9188fe8c
-  data.tar.gz: bbe14738574ad807ac48599579a97d600a5dbc5b
+  metadata.gz: d13edaa29dc5980c6783c28bdfa72c6ae5624ecd
+  data.tar.gz: 95e285806cc9168efa32ab6e1511e291bff66e3e
 SHA512:
-  metadata.gz: 14843dbd1a39130a6cdaeebf63f377e4d6bbd99d57d4043e6e839819198ce0c45980901744631cd26df0bdf5c8465015c229505f600d8f41ac7f11798c50bd85
-  data.tar.gz: 956f88ef2ba32f4d59c8c2ae2944ef7c2eb83e6c86c37744984e5be4de77fb3a558aeed84d596640294d32d6ec821b87b6001caa2e60d0243f0299512beb8f62
+  metadata.gz: b1d7d8da69d8092724ccc970aa9a236175af58bb2c76a77582e6792ae3732efc924b98496faefecc3f02be8ce8315f61a412f2b71e80916c066956a1e7f5b5e9
+  data.tar.gz: 22c4676382a67e8c685af190bd473f22cdb161397e84479f4fa76666e4f89fff60d64fc88d121e808d3bbf9a32aea9fa754a79f9232abe08553afc42bd9b8112

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Foodcritic Changelog:
 
-## [10.0.0](https://github.com/acrmp/foodcritic/tree/v10.0.0) (2017-03-14)
+## [10.1.0](https://github.com/acrmp/foodcritic/tree/10.1.0) (2017-03-29)
+
+[Full Changelog](https://github.com/acrmp/foodcritic/compare/v10.0.0...v10.1.0)
+
+**Implemented enhancements:**
+
+- Remove FC023 which is no longer considered best practice [#523](https://github.com/acrmp/foodcritic/pull/523) ([tas50](https://github.com/tas50))
+- Add basic testing of the metadata_field api [#522](https://github.com/acrmp/foodcritic/pull/522) ([tas50](https://github.com/tas50))
+- Add a more robust cookbook_base_path helper to the API [#520](https://github.com/acrmp/foodcritic/pull/520) ([tas50](https://github.com/tas50))
+- Update various tags to better align the rules with the tag categories [#517](https://github.com/acrmp/foodcritic/pull/517) ([tas50](https://github.com/tas50))
+
+## [v10.0.0](https://github.com/acrmp/foodcritic/tree/v10.0.0) (2017-03-14)
 
 [Full Changelog](https://github.com/acrmp/foodcritic/compare/v9.0.0...v10.0.0)
 

data/Gemfile

@@ -6,12 +6,12 @@ group :test do
   gem "aruba", "~> 0.5"
   gem "cucumber", ">= 2"
   gem "minitest", "~> 5.3"
+  gem "minitest-reporters"
   gem "simplecov", "~> 0.8"
+  gem "chefstyle", "~> 0.5"
 end
 
 group :development do
-  gem "chef", "~> 12.1"
-  gem "chefstyle", "~> 0.4"
   gem "ronn", "~> 0.7"
 end
 

data/features/031_check_for_metadata_existence.feature

@@ -4,12 +4,12 @@ Feature: Check for metadata existence
   As a developer
   I want to verify that the metadata file exist
 
-  Scenario: Cookbook without metadata file
+  Scenario: Cookbook without metadata.rb file
     Given a cookbook that does not have defined metadata
     When I check the cookbook
     Then the non existing metadata warning 031 should be displayed against the metadata file
 
-  Scenario: Cookbook with metadata file
+  Scenario: Cookbook with metadata.rb file
     Given a cookbook that has the default boilerplate metadata generated by knife
     When I check the cookbook
     Then the non existing metadata warning 031 should not be displayed against the metadata file

data/features/choose_rules_to_apply.feature

@@ -10,19 +10,19 @@ Feature: Choose rules to apply
     Then the warnings shown should be <warnings_shown>
 
   Examples:
-    | cookbook_matches  | tag_arguments                | warnings_shown    |
-    | FC002,FC004,FC005 |                              | FC002,FC004,FC005 |
-    | FC002             | -t FC002                     | FC002             |
-    | FC002,FC004,FC005 | --tags FC002                 | FC002             |
-    | FC002,FC004,FC005 | --tags fc002                 |                   |
-    | FC002,FC004,FC005 | --tags FC006                 |                   |
-    | FC002,FC004,FC005 | --tags ~FC002                | FC004,FC005       |
-    |                   | --tags FC002                 |                   |
-    | FC002,FC004,FC005 | --tags @FC002                |                   |
-    | FC002,FC004,FC005 | --tags style                 | FC002,FC004       |
-    | FC002,FC004,FC005 | --tags FC002 --tags FC004    |                   |
-    | FC002,FC004,FC005 | --tags style --tags services | FC004             |
-    | FC002,FC004,FC005 | --tags style,services        | FC002,FC004       |
+    | cookbook_matches  | tag_arguments                      | warnings_shown    |
+    | FC002,FC004,FC005 |                                    | FC002,FC004,FC005 |
+    | FC002             | -t FC002                           | FC002             |
+    | FC002,FC004,FC005 | --tags FC002                       | FC002             |
+    | FC002,FC004,FC005 | --tags fc002                       |                   |
+    | FC002,FC004,FC005 | --tags FC006                       |                   |
+    | FC002,FC004,FC005 | --tags ~FC002                      | FC004,FC005       |
+    |                   | --tags FC002                       |                   |
+    | FC002,FC004,FC005 | --tags @FC002                      |                   |
+    | FC002,FC004,FC005 | --tags style                       | FC002             |
+    | FC002,FC004,FC005 | --tags FC002 --tags FC004          |                   |
+    | FC002,FC004,FC005 | --tags portability --tags services | FC004             |
+    | FC002,FC004,FC005 | --tags style,services,portability  | FC002,FC004       |
 
   Scenario Outline: Specified tags in cookbook .foodcritic file
     Given a cookbook that matches rules <cookbook_matches>
@@ -31,17 +31,17 @@ Feature: Choose rules to apply
     Then the warnings shown should be <warnings_shown>
 
   Examples:
-    | cookbook_matches  | tag_file       | tag_arguments  | warnings_shown    |
-    | FC002,FC004       |                |                | FC002,FC004       |
-    | FC002             | FC002          |                | FC002             |
-    | FC002             | ~FC002         | --tags FC002   | FC002             |
-    | FC002             | fc002          |                |                   |
-    | FC002,FC004       | FC005          |                |                   |
-    | FC002,FC004       | FC005          | -t FC002       | FC002             |
-    | FC002,FC004       | ~FC002         |                | FC004             |
-    | FC002,FC004       | ~FC002         | -t FC002       | FC002             |
-    |                   | FC002          |                |                   |
-    | FC002,FC004       | @FC002         |                |                   |
-    | FC002,FC004       | style          |                | FC002,FC004       |
-    | FC002,FC004       | FC002          |                |                   |
-    | FC002,FC004       | style,services |                | FC002,FC004       |
+    | cookbook_matches  | tag_file          | tag_arguments  | warnings_shown    |
+    | FC002,FC004       |                   |                | FC002,FC004       |
+    | FC002             | FC002             |                | FC002             |
+    | FC002             | ~FC002            | --tags FC002   | FC002             |
+    | FC002             | fc002             |                |                   |
+    | FC002,FC004       | FC005             |                |                   |
+    | FC002,FC004       | FC005             | -t FC002       | FC002             |
+    | FC002,FC004       | ~FC002            |                | FC004             |
+    | FC002,FC004       | ~FC002            | -t FC002       | FC002             |
+    |                   | FC002             |                |                   |
+    | FC002,FC004       | @FC002            |                |                   |
+    | FC002,FC004       | style             |                | FC002             |
+    | FC002,FC004       | FC002             |                |                   |
+    | FC002,FC004       | style,portability |                | FC002,FC004       |

data/features/continuous_integration_support.feature

@@ -18,8 +18,8 @@ Feature: Continuous Integration Support
   Examples:
     | cookbook_matches  | tag_arguments       | warnings_shown    | build_status |
     | FC002,FC004       |                     | FC002,FC004       | failed       |
-    | FC002,FC004       | -t style            | FC002,FC004       | failed       |
-    | FC002,FC004       | -t style -f ~any    | FC002,FC004       | successful   |
+    | FC002,FC004       | -t style            | FC002             | failed       |
+    | FC002,FC004       | -t style -f ~any    | FC002             | successful   |
     | FC002,FC004       | -f FC005            | FC002,FC004       | successful   |
     | FC002,FC004       | -f FC004            | FC002,FC004       | failed       |
     | FC002,FC004       | --epic-fail FC002   | FC002,FC004       | failed       |

data/features/support/command_helpers.rb

@@ -35,7 +35,7 @@ module FoodCritic
       "FC019" => "Access node attributes in a consistent manner",
       "FC021" => "Resource condition in provider may not behave as expected",
       "FC022" => "Resource condition within loop may not behave as expected",
-      "FC023" => "Prefer conditional attributes",
+      # FC023 was yanked and is considered reserved, do not reuse it
       "FC024" => "Consider adding platform equivalents",
       "FC025" => "Prefer chef_gem to compile-time gem install",
       "FC026" => "Conditional execution block attribute contains only string",
@@ -43,7 +43,7 @@ module FoodCritic
       "FC028" => "Incorrect #platform? usage",
       "FC029" => "No leading cookbook name in recipe metadata",
       "FC030" => "Cookbook contains debugger breakpoints",
-      "FC031" => "Cookbook without metadata file",
+      "FC031" => "Cookbook without metadata.rb file",
       "FC032" => "Invalid notification timing",
       "FC033" => "Missing template",
       "FC034" => "Unused template variables",

data/lib/foodcritic/api.rb

@@ -33,7 +33,11 @@ module FoodCritic
     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)
+      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.
@@ -51,10 +55,13 @@ module FoodCritic
         end == %w{Chef Config}
     end
 
-    # Is the
-    # [chef-solo-search library](https://github.com/edelight/chef-solo-search)
-    # available?
+    # 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)
+      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.
@@ -75,6 +82,25 @@ module FoodCritic
       end
     end
 
+    # The absolute path of a cookbook from the specified file.
+    #
+    # @author Tim Smith - tsmith@chef.io
+    # @since 11.0
+    # @param file [String, Pathname] relative or absolute path to a file in the cookbook
+    # @return [String] the absolute path to the base of the cookbook
+    def cookbook_base_path(file)
+      file = File.expand_path(file) # make sure we get an absolute path
+      file = File.dirname(file) unless File.directory?(file) # get the dir only
+
+      # get list of items in the dir and intersect with metadata array.
+      # until we get an interfact (we have a metadata) walk up the dir structure
+      until (Dir.entries(file) & %w{metadata.rb metadata.json}).any?
+        file = File.dirname(file)
+      end
+
+      file
+    end
+
     # Support function to retrieve a metadata field
     def metadata_field(file, field)
       until (file.split(File::SEPARATOR) & standard_cookbook_subdirs).empty?

data/lib/foodcritic/linter.rb

@@ -157,7 +157,7 @@ module FoodCritic
     end
 
     def load_rules!(options)
-      rule_files = [File.join(File.dirname(__FILE__), "rules.rb")]
+      rule_files = Dir.glob(File.join(File.dirname(__FILE__), "rules", "*"))
       rule_files << options[:include_rules]
       rule_files << rule_files_in_gems if options[:search_gems]
       @rules = RuleDsl.load(rule_files.flatten.compact, chef_version)

data/lib/foodcritic/rules/fc001.rb

@@ -0,0 +1,7 @@
+rule "FC001",
+     "Use strings in preference to symbols to access node attributes" do
+  tags %w{style attributes}
+  recipe do |ast|
+    attribute_access(ast, type: :symbol)
+  end
+end

data/lib/foodcritic/rules/fc002.rb

@@ -0,0 +1,8 @@
+rule "FC002", "Avoid string interpolation where not required" do
+  tags %w{style strings}
+  recipe do |ast|
+    ast.xpath(%q{//*[self::string_literal | self::assoc_new]/string_add[
+      count(descendant::string_embexpr) = 1 and
+      count(string_add) = 0]})
+  end
+end

data/lib/foodcritic/rules/fc004.rb

@@ -0,0 +1,12 @@
+rule "FC004", "Use a service resource to start and stop services" do
+  tags %w{portability services}
+  recipe do |ast|
+    find_resources(ast, type: "execute").find_all do |cmd|
+      cmd_str = (resource_attribute(cmd, "command") || resource_name(cmd)).to_s
+      (cmd_str.include?("/etc/init.d") || ["service ", "/sbin/service ",
+       "start ", "stop ", "invoke-rc.d "].any? do |service_cmd|
+         cmd_str.start_with?(service_cmd)
+       end) && %w{start stop restart reload}.any? { |a| cmd_str.include?(a) }
+    end
+  end
+end

data/lib/foodcritic/rules/fc005.rb

@@ -0,0 +1,29 @@
+rule "FC005", "Avoid repetition of resource declarations" do
+  tags %w{style}
+  recipe do |ast|
+    resources = find_resources(ast).map do |res|
+      resource_attributes(res).merge({ type: resource_type(res),
+                                       ast: res })
+    end.chunk do |res|
+      res[:type] +
+        res[:ast].xpath("ancestor::*[self::if | self::unless | self::elsif |
+          self::else | self::when | self::method_add_block/call][position() = 1]/
+          descendant::pos[position() = 1]").to_s +
+        res[:ast].xpath("ancestor::method_add_block/command[
+          ident/@value='action']/args_add_block/descendant::ident/@value").to_s
+    end.reject { |res| res[1].size < 3 }
+    resources.map do |cont_res|
+      first_resource = cont_res[1][0][:ast]
+      # we have contiguous resources of the same type, but do they share the
+      # same attributes?
+      sorted_atts = cont_res[1].map do |atts|
+        atts.delete_if { |k| k == :ast }.to_a.sort do |x, y|
+          x.first.to_s <=> y.first.to_s
+        end
+      end
+      first_resource if sorted_atts.all? do |att|
+        (att - sorted_atts.inject { |atts, a| atts & a }).length == 1
+      end
+    end.compact
+  end
+end

data/lib/foodcritic/rules/fc006.rb

@@ -0,0 +1,11 @@
+rule "FC006", "Mode should be quoted or fully specified when "\
+     "setting file permissions" do
+  tags %w{correctness files}
+  recipe do |ast|
+    ast.xpath(%q{//ident[@value='mode']/parent::command/
+      descendant::int[string-length(@value) < 5
+      and not(starts-with(@value, "0")
+      and string-length(@value) = 4)][count(ancestor::aref) = 0]/
+      ancestor::method_add_block})
+  end
+end

data/lib/foodcritic/rules/fc007.rb

@@ -0,0 +1,19 @@
+rule "FC007", "Ensure recipe dependencies are reflected in cookbook metadata" do
+  tags %w{correctness metadata}
+  recipe do |ast, filename|
+    metadata_path = Pathname.new(
+      File.join(File.dirname(filename), "..", "metadata.rb")).cleanpath
+    next unless File.exist? metadata_path
+    actual_included = included_recipes(ast, with_partial_names: false)
+    undeclared = actual_included.keys.map do |recipe|
+      recipe.split("::").first
+    end - [cookbook_name(filename)] -
+      declared_dependencies(read_ast(metadata_path))
+    actual_included.map do |recipe, include_stmts|
+      if undeclared.include?(recipe) ||
+          undeclared.any? { |u| recipe.start_with?("#{u}::") }
+        include_stmts
+      end
+    end.flatten.compact
+  end
+end

data/lib/foodcritic/rules/fc008.rb

@@ -0,0 +1,12 @@
+rule "FC008", "Generated cookbook metadata needs updating" do
+  tags %w{metadata supermarket}
+  metadata do |ast, filename|
+    {
+      "maintainer" => "YOUR_COMPANY_NAME",
+      "maintainer_email" => "YOUR_EMAIL",
+    }.map do |field, value|
+      ast.xpath(%Q{//command[ident/@value='#{field}']/
+                   descendant::tstring_content[@value='#{value}']})
+    end
+  end
+end

data/lib/foodcritic/rules/fc009.rb

@@ -0,0 +1,18 @@
+rule "FC009", "Resource attribute not recognised" do
+  tags %w{correctness}
+  recipe do |ast|
+    matches = []
+    resource_attributes_by_type(ast).each do |type, resources|
+      resources.each do |resource|
+        resource.keys.map(&:to_sym).reject do |att|
+          resource_attribute?(type.to_sym, att)
+        end.each do |invalid_att|
+          matches << find_resources(ast, type: type).find do |res|
+            resource_attributes(res).include?(invalid_att.to_s)
+          end
+        end
+      end
+    end
+    matches
+  end
+end

data/lib/foodcritic/rules/fc010.rb

@@ -0,0 +1,7 @@
+rule "FC010", "Invalid search syntax" do
+  tags %w{correctness search}
+  recipe do |ast|
+    # This only works for literal search strings
+    literal_searches(ast).reject { |search| valid_query?(search["value"]) }
+  end
+end

data/lib/foodcritic/rules/fc011.rb

@@ -0,0 +1,8 @@
+rule "FC011", "Missing README in markdown format" do
+  tags %w{readme supermarket}
+  cookbook do |filename|
+    unless File.exist?(File.join(filename, "README.md"))
+      [file_match(File.join(filename, "README.md"))]
+    end
+  end
+end

data/lib/foodcritic/rules/fc012.rb

@@ -0,0 +1,8 @@
+rule "FC012", "Use Markdown for README rather than RDoc" do
+  tags %w{supermarket readme}
+  cookbook do |filename|
+    if File.exist?(File.join(filename, "README.rdoc"))
+      [file_match(File.join(filename, "README.rdoc"))]
+    end
+  end
+end

data/lib/foodcritic/rules/fc013.rb

@@ -0,0 +1,10 @@
+rule "FC013", "Use file_cache_path rather than hard-coding tmp paths" do
+  tags %w{files portability}
+  recipe do |ast|
+    find_resources(ast, type: "remote_file").find_all do |download|
+      path = (resource_attribute(download, "path") ||
+        resource_name(download)).to_s
+      path.start_with?("/tmp/")
+    end
+  end
+end

data/lib/foodcritic/rules/fc014.rb

@@ -0,0 +1,10 @@
+rule "FC014", "Consider extracting long ruby_block to library" do
+  tags %w{style libraries}
+  recipe do |ast|
+    find_resources(ast, type: "ruby_block").find_all do |rb|
+      lines = rb.xpath("descendant::fcall[ident/@value='block']/../../
+        descendant::*[@line]/@line").map { |n| n.value.to_i }.sort
+      (!lines.empty?) && (lines.last - lines.first) > 15
+    end
+  end
+end

data/lib/foodcritic/rules/fc015.rb

@@ -0,0 +1,8 @@
+rule "FC015", "Consider converting definition to a Custom Resource" do
+  tags %w{style definitions}
+  cookbook do |dir|
+    Dir[File.join(dir, "definitions", "*.rb")].reject do |entry|
+      [".", ".."].include? entry
+    end.map { |entry| file_match(entry) }
+  end
+end

data/lib/foodcritic/rules/fc016.rb

@@ -0,0 +1,10 @@
+rule "FC016", "LWRP does not declare a default action" do
+  tags %w{correctness lwrp}
+  resource do |ast, filename|
+    unless ["//ident/@value='default_action'",
+     "//def/bodystmt/descendant::assign/
+      var_field/ivar/@value='@action'"].any? { |expr| ast.xpath(expr) }
+      [file_match(filename)]
+    end
+  end
+end

data/lib/foodcritic/rules/fc017.rb

@@ -0,0 +1,29 @@
+rule "FC017", "LWRP does not notify when updated" do
+  tags %w{correctness lwrp}
+  provider do |ast, filename|
+
+    use_inline_resources = !ast.xpath('//*[self::vcall or self::var_ref]/ident
+      [@value="use_inline_resources"]').empty?
+
+    unless use_inline_resources
+      actions = ast.xpath('//method_add_block/command[ident/@value="action"]/
+        args_add_block/descendant::symbol/ident')
+
+      actions.reject do |action|
+        blk = action.xpath('ancestor::command[1]/
+          following-sibling::*[self::do_block or self::brace_block]')
+        empty = !blk.xpath("stmts_add/void_stmt").empty?
+        converge_by = !blk.xpath('descendant::*[self::command or self::fcall]
+          /ident[@value="converge_by"]').empty?
+
+        updated_by_last_action = !blk.xpath('descendant::*[self::call or
+          self::command_call]/*[self::vcall or self::var_ref/ident/
+          @value="new_resource"]/../ident[@value="updated_by_last_action"]
+        ').empty?
+
+        empty || converge_by || updated_by_last_action
+      end
+    end
+
+  end
+end