foodcritic 4.0.0 → 5.0.0

data/features/002_check_string_interpolation.feature

@@ -43,3 +43,8 @@ Feature: Check String Interpolation
     Given a cookbook with a single recipe for which the first hash value is an interpolated string
      When I check the cookbook
      Then the string interpolation warning 002 should be displayed
+
+  Scenario: String interpolation in heredoc
+    Given a cookbook with a single recipe that logs an interpolated string heredoc
+     When I check the cookbook
+     Then the string interpolation warning 002 should not be displayed

data/features/041_check_raw_download.feature

@@ -9,18 +9,26 @@ Feature: Check for direct usage of curl or wget
     When I check the cookbook
     Then the execute resource used to run curl or wget commands warning 041 <display> be displayed
   Examples:
-    | name                       | display    |
-    | curl 'http://example.org/' | should     |
-    | wget 'http://example.org/' | should     |
-    | which foo                  | should not |
+    | name                            | display    |
+    | curl 'http://example.org/'      | should not |
+    | wget 'http://example.org/'      | should     |
+    | which curl                      | should not |
+    | sudo wget 'http://example.org/' | should     |
+    | reboot                          | should not |
 
   Scenario Outline: Execute resource
     Given a cookbook recipe with an execute resource that runs the command <command>
     When I check the cookbook
     Then the execute resource used to run curl or wget commands warning 041 <display> be displayed
   Examples:
-    | command                                 | display     |
-    | which foo                               | should not  |
-    | curl 'http://example.org/'              | should      |
-    | wget 'http://example.org/'              | should      |
-    | mkdir foo && wget 'http://example.org/' | should      |
+    | command                                    | display     |
+    | which curl                                 | should not  |
+    | sudo wget 'http://example.org/'            | should      |
+    | curl -X POST 'http://example.org/'         | should not  |
+    | curl 'http://example.org/'                 | should not  |
+    | curl 'http://example.org/' -o foo          | should      |
+    | curl 'http://example.org/'  --output   foo | should      |
+    | curl 'http://example.org/' &>bar           | should      |
+    | curl -o baz 'http://example.org/'>   bing  | should      |
+    | wget 'http://example.org/'                 | should      |
+    | mkdir foo && wget 'http://example.org/'    | should      |

data/features/044_check_for_bare_attribute_keys.feature

@@ -41,3 +41,13 @@ Feature: Check for bare attribute keys
     Given a cookbook attributes file that sets an attribute to be the result of a library call
      When I check the cookbook
      Then the bare attribute keys warning 044 should not be displayed against the library call
+
+  Scenario: Attribute chain with new line
+    Given a cookbook attributes file that sets an attribute to have line break
+     When I check the cookbook
+     Then the bare attribute keys warning 044 should not be displayed against the local variable
+
+  Scenario: Attribute chain with new line and parameterized name
+    Given a cookbook attributes file that sets an attribute to have line break and arguments
+     When I check the cookbook
+     Then the bare attribute keys warning 044 should not be displayed against the new line

data/features/048_check_for_shellout.feature

@@ -29,6 +29,11 @@ Feature: Check for spawning without Mixlib::ShellOut
      Then the prefer mixlib shellout warning 048 should not be displayed
 
   Scenario: Group resource
-    Given a cookbook recipe that contains a group resource that uses the 'system' attribute
+    Given a cookbook recipe that contains a group resource that uses the 'system' bool attribute
      When I check the cookbook
      Then the prefer mixlib shellout warning 048 should not be displayed against the group resource
+
+  Scenario: User resource
+    Given a cookbook recipe that contains a user resource that uses the 'system' string attribute
+     When I check the cookbook
+     Then the prefer mixlib shellout warning 048 should not be displayed against the user resource

data/features/052_check_for_metadata_using_suggests_keyword.feature

@@ -0,0 +1,15 @@
+Feature: Check for metadata using suggests keyword
+
+  In order to ensure that recipe metadata is stable
+  As a developer
+  I want to identify metadata that is using unimplemented features whose definitions may change in the future
+
+  Scenario: Metadata with the suggests keyword
+    Given a cookbook with metadata that includes a suggests keyword
+     When I check the cookbook
+     Then the metadata using suggests warning 052 should be shown against the metadata file
+
+  Scenario: Metadata without the suggests keyword
+    Given a cookbook with metadata that does not include a suggests keyword
+     When I check the cookbook
+     Then the metadata using suggests warning 052 should be not shown against the metadata file

data/features/053_check_for_metadata_using_recommends_keyword.feature

@@ -0,0 +1,15 @@
+Feature: Check for metadata using recommends keyword
+
+  In order to ensure that recipe metadata is stable
+  As a developer
+  I want to identify metadata that is using unimplemented features whose definitions may change in the future
+
+  Scenario: Metadata with the recommends keyword
+    Given a cookbook with metadata that includes a recommends keyword
+     When I check the cookbook
+     Then the metadata using recommends warning 053 should be shown against the metadata file
+
+  Scenario: Metadata without the recommends keyword
+    Given a cookbook with metadata that does not include a recommends keyword
+     When I check the cookbook
+     Then the metadata using recommends warning 053 should be not shown against the metadata file

data/features/step_definitions/cookbook_steps.rb

@@ -34,6 +34,22 @@ Given 'a cookbook attributes file with a do block that takes arguments' do
   }
 end
 
+Given 'a cookbook attributes file that sets an attribute to have line break' do
+  write_attributes %q{
+    default['foo']['bar']['baz'][
+     'bing']['blonk'] = 'stupendous'
+  }
+end
+
+Given 'a cookbook attributes file that sets an attribute to have line break and arguments' do
+  write_attributes %q{
+    %w{ foo bar }.each do |baz|
+      default['foo']["bing_#{baz}"][
+        'blonk'] = baz
+    end
+  }
+end
+
 Given /^a cookbook (attributes|recipe) file with assignment (.*)$/ do |type, assignment|
   if type == 'attributes'
     write_attributes assignment
@@ -42,7 +58,7 @@ Given /^a cookbook (attributes|recipe) file with assignment (.*)$/ do |type, ass
   end
 end
 
-Given "a cookbook recipe that contains a group resource that uses the 'system' attribute" do
+Given "a cookbook recipe that contains a group resource that uses the 'system' bool attribute" do
   write_recipe %q{
     group "senge" do
       system true
@@ -50,6 +66,14 @@ Given "a cookbook recipe that contains a group resource that uses the 'system' a
   }
 end
 
+Given "a cookbook recipe that contains a user resource that uses the 'system' string attribute" do
+  write_recipe %q{
+    user "foo" do
+      system "bar"
+    end
+  }
+end
+
 Given /^a cookbook recipe that declares (too many )?execute resources varying only in the command in branching conditionals$/ do |too_many|
   extra_resource = %q{
     execute "bing" do
@@ -947,7 +971,7 @@ Given /^a cookbook that declares ([a-z]+) attributes via symbols$/ do |attribute
 end
 
 Given /^a cookbook that does not contain a definition and has (no|a) definitions directory$/ do |has_dir|
-  create_dir 'cookbooks/example/definitions/' unless has_dir == 'no'
+  create_directory 'cookbooks/example/definitions/' unless has_dir == 'no'
   write_recipe %q{
     log "A defining characteristic of this cookbook is that it has no definitions"
   }
@@ -1193,6 +1217,14 @@ Given /^a cookbook with a single recipe that creates a directory resource with (
                         'a literal and interpolated variable' => :literal_and_interpolated_symbol}[path_type])
 end
 
+Given 'a cookbook with a single recipe that logs an interpolated string heredoc' do
+  write_recipe %q(
+    Chef::Log.warn <<-LOG
+      Warning stuff has gone wrong: #{stuff}
+    LOG
+  )
+end
+
 Given 'a cookbook with a single recipe that searches but checks first (alternation) to see if this is server' do
   write_recipe %q{
     if Chef::Config[:solo] || we_dont_want_to_use_search
@@ -1275,6 +1307,20 @@ Given /^a cookbook with metadata that (specifies|does not specify) the cookbook
   }
 end
 
+Given /^a cookbook with metadata that (includes|does not include) a recommends keyword$/ do |includes|
+  write_metadata %Q{
+    depends "bar"
+    #{"recommends 'foo'" if includes == 'includes'}
+  }
+end
+
+Given /^a cookbook with metadata that (includes|does not include) a suggests keyword$/ do |includes|
+  write_metadata %Q{
+    depends "bar"
+    #{"suggests 'foo'" if includes == 'includes'}
+  }
+end
+
 Given /^a directory that contains a role file ([^ ]+) in (json|ruby) that defines role name (.*)$/ do |file_name, format, role_name|
   role(:role_name => %Q{"#{role_name}"}, :file_name => file_name, :format => format.to_sym)
 end
@@ -1708,7 +1754,7 @@ Given /^a template directory that contains a binary file (.*) that is not valid
   template_dir = 'cookbooks/example/templates/default'
   write_recipe ''
   write_file "#{template_dir}/innocent_template.erb", '<%= hello %>'
-  File.open("#{current_dir}/#{template_dir}/#{filename}", 'wb'){|f| f.putc(0x93)}
+  File.open("#{expand_path('.')}/#{template_dir}/#{filename}", 'wb'){|f| f.putc(0x93)}
 end
 
 Given 'each role directory has a role with a name that does not match the containing file name' do
@@ -1755,7 +1801,7 @@ end
 
 When /^I check the cookbook specifying ([^ ]+) as the Chef version$/ do |version|
   options = ['-c', version, 'cookbooks/example']
-  in_current_dir do
+  cd '.' do
     options = ['-I', 'rules/test.rb'] + options if Dir.exists?('rules')
   end
   run_lint(options)
@@ -1929,6 +1975,10 @@ Then /^the bare attribute keys warning 044 should not be displayed against the (
   expect_warning 'FC044', {:expect_warning => false, :line => 2, :file_type => :attributes}
 end
 
+Then /^the bare attribute keys warning 044 should not be displayed against the new line$/ do
+  expect_warning 'FC044', {:expect_warning => false, :line => 3, :file_type => :attributes}
+end
+
 Then 'the execute resource used to run git commands warning 040 should be displayed against the last resource' do
   expect_warning 'FC040', {:line => 7}
 end
@@ -1952,6 +2002,10 @@ Then 'the prefer mixlib shellout warning 048 should not be displayed against the
   expect_warning 'FC048', {:expect_warning => false, :line => 2}
 end
 
+Then 'the prefer mixlib shellout warning 048 should not be displayed against the user resource' do
+  expect_warning 'FC048', {:expect_warning => false, :line => 2}
+end
+
 Then /^the role name does not match file name warning 049 should( not)? be shown( against the second name)?$/ do |not_shown, second|
   expect_warning 'FC049', {:expect_warning => ! not_shown,
                            :file => 'roles/webserver.rb', :line => second ? 2 : 1}
@@ -2241,3 +2295,11 @@ Given(/^a cookbook with an? (.*) file with an interpolated name$/) do |file_type
   write_definition "apache_site", content if file_type == "definition"
   write_library "lib", content if file_type == "library"
 end
+
+Then /^the metadata using suggests warning 052 should be (shown|not shown) against the metadata file$/ do |show_warning|
+  expect_warning('FC052', :file => "metadata.rb", :line => 2, :expect_warning => show_warning == 'shown')
+end
+
+Then /^the metadata using recommends warning 053 should be (shown|not shown) against the metadata file$/ do |show_warning|
+  expect_warning('FC053', :file => "metadata.rb", :line => 2, :expect_warning => show_warning == 'shown')
+end

data/features/support/command_helpers.rb

@@ -62,6 +62,9 @@ module FoodCritic
       'FC049' => 'Role name does not match containing file name',
       'FC050' => 'Name includes invalid characters',
       'FC051' => 'Template partials loop indefinitely',
+      'FC052' => 'Metadata uses the unimplemented "suggests" keyword',
+      'FC053' => 'Metadata uses the unimplemented "recommends" keyword',
+      # FC054 was yanked and is considered reserved, do not reuse it
       'FCTEST001' => 'Test Rule'
     }
 
@@ -183,6 +186,9 @@ module FoodCritic
         {:short => 'f', :long => 'epic-fail TAGS',
          :description => "Fail the build based on tags. Use 'any' to fail on all warnings."},
 
+        {:short => 'l', :long => 'list',
+         :description => 'List all enabled rules and their descriptions.'},
+
         {:short => 't', :long => 'tags TAGS',
          :description => 'Check against (or exclude ~) rules with the specified tags.'},
 
@@ -273,9 +279,9 @@ module FoodCritic
     #
     # @param [Array] cmd_args The command line arguments.
     def run_lint(cmd_args)
-      in_current_dir do
+      cd '.' do
         show_context = cmd_args.include?('-C')
-        review, @status = FoodCritic::Linter.check(CommandLine.new(cmd_args))
+        review, @status = FoodCritic::Linter.run(CommandLine.new(cmd_args))
         @review =
           if review.nil? || (review.respond_to?(:warnings) && review.warnings.empty?)
             ''

data/features/support/env.rb

@@ -1,6 +1,10 @@
-require 'simplecov'
-SimpleCov.start do
-  add_filter '/features/'
+begin
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/features/'
+  end
+rescue LoadError
+  warn 'warning: simplecov gem not found; skipping coverage'
 end
 
 require 'aruba/cucumber'

data/lib/foodcritic/api.rb

@@ -396,8 +396,7 @@ module FoodCritic
       doc, xml_node = xml_document(doc, xml_node)
 
       if node.respond_to?(:each)
-        # First child is the node name
-        node.drop(1).each do |child|
+        node.each do |child|
           if position_node?(child)
             xml_position_node(doc, xml_node, child)
           else
@@ -493,7 +492,7 @@ module FoodCritic
       source = if file.to_s.split(File::SEPARATOR).include?('templates')
                  template_expressions_only(file)
                else
-                 File.read(file)
+                 File.read(file).encode('utf-8', 'binary', :undef => :replace)
                end
       build_xml(Ripper::SexpBuilder.new(source).parse)
     end
@@ -550,7 +549,9 @@ module FoodCritic
     end
 
     def template_expressions_only(file)
-      exprs = Template::ExpressionExtractor.new.extract(File.read(file))
+      exprs = Template::ExpressionExtractor.new.extract(
+        File.read(file).encode('utf-8', 'binary', :undef => :replace)
+      )
       lines = Array.new(exprs.map { |e| e[:line] }.max || 0, '')
       exprs.each do |e|
         lines[e[:line] - 1] += ';' unless lines[e[:line] - 1].empty?

data/lib/foodcritic/chef.rb

@@ -82,14 +82,10 @@ module FoodCritic
     end
 
     class Search
-      # The search grammars that ship with any Chef gems installed locally.
-      # These are returned in descending version order (a newer Chef version
-      #   could break our ability to load the grammar).
-      # Grammars are not available from Chef 11+.
+      # lucene.treetop used to be provided by chef gem
+      # We're keeping a local copy from chef 10.x
       def chef_search_grammars
-        Gem.path.map do |gem_path|
-          Dir["#{gem_path}/gems/chef-*/**/lucene.treetop"]
-        end.flatten.sort.reverse
+        [File.expand_path('../../..', __FILE__) + "/misc/lucene.treetop"]
       end
 
       # Create the search parser from the first loadable grammar.

data/lib/foodcritic/command_line.rb

@@ -23,6 +23,10 @@ module FoodCritic
                 'specified tags.') do |t|
           @options[:tags] << t
         end
+        opts.on('-l', '--list',
+                'List all enabled rules and their descriptions.') do |t|
+          @options[:list] = t
+        end                
         opts.on('-f', '--epic-fail TAGS',
                 "Fail the build based on tags. Use 'any' to fail "\
                 'on all warnings.') do |t|
@@ -55,6 +59,10 @@ module FoodCritic
                 'foodcritic/rules/**/*.rb') do |g|
           @options[:search_gems] = true
         end
+        opts.on("-P", "--progress",
+                "Show progress of files being checked") do
+          @options[:progress] = true
+        end
         opts.on('-R', '--role-path PATH',
                 'Role path(s) to check.') do |r|
           @options[:role_paths] << r
@@ -106,6 +114,13 @@ module FoodCritic
       @options.key?(:version)
     end
 
+    # Just list enabled rules, don't actually run a lint check?
+    #
+    # @return [Boolean] True if a rule listing is requested.
+    def list_rules?
+      @options.key?(:list)
+    end
+
     # The version string.
     #
     # @return [String] Current installed version.

data/lib/foodcritic/domain.rb

@@ -25,6 +25,20 @@ module FoodCritic
     end
   end
 
+  # Simple container for rule listings.
+  class RuleList
+    attr_reader :rules
+    def initialize(rules = [])
+      @rules = rules
+    end
+
+    def to_s
+      @rules.sort { |a,b| a.code <=> b.code }.
+        map { |r| r.to_s }.join("\n")
+    end
+
+  end
+
   # The collected warnings (if any) raised against a cookbook tree.
   class Review
     attr_reader :cookbook_paths, :warnings

data/lib/foodcritic/linter.rb

@@ -10,18 +10,21 @@ 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 = '11.10.4'
+    DEFAULT_CHEF_VERSION = '12.4.1'
     attr_reader :chef_version
 
     # Perform a lint check. This method is intended for use by the command-line
     # wrapper. If you are programatically using foodcritic you should use
     # `#check` below.
-    def self.check(cmd_line)
+    def self.run(cmd_line)
       # The first item is the string output, the second is exit code.
       return [cmd_line.help, 0] if cmd_line.show_help?
       return [cmd_line.version, 0] if cmd_line.show_version?
       if !cmd_line.valid_grammar?
         [cmd_line.help, 4]
+      elsif cmd_line.list_rules?
+        listing = FoodCritic::Linter.new.list(cmd_line.options)
+        [listing, 0]
       elsif cmd_line.valid_paths?
         review = FoodCritic::Linter.new.check(cmd_line.options)
         [review, review.failed? ? 3 : 0]
@@ -30,6 +33,26 @@ module FoodCritic
       end
     end
 
+    # List the rules that are currently in effect.
+    #
+    # The `options` are a hash where the valid keys are:
+    #
+    # * `:include_rules` - Paths to additional rules to apply
+    # * `:search_gems - If true then search for custom rules in installed gems.
+    # * `:tags` - The tags to filter rules based on
+    def list(options = {})
+      options = setup_defaults(options)
+      @options = options
+      load_rules
+
+      if options[:tags].any?
+        @rules = active_rules(options[:tags])
+      end
+
+      RuleList.new(@rules)
+    end
+
+
     # Review the cookbooks at the provided path, identifying potential
     # improvements.
     #
@@ -53,16 +76,23 @@ module FoodCritic
       paths = specified_paths!(options)
 
       # Loop through each file to be processed and apply the rules
-      files_to_process(paths).each do |p|
+      files = files_to_process(paths)
 
+      if options[:progress]
+        puts "Food Critic"
+        puts "Checking #{files.count} files"
+      end
+
+      files.each do |p|
         relevant_tags = if options[:tags].any?
                           options[:tags]
                         else
                           cookbook_tags(p[:filename])
                         end
 
-        active_rules(relevant_tags).each do |rule|
+        progress = '.'
 
+        active_rules(relevant_tags).each do |rule|
           state = {
             path_type: p[:path_type],
             file: p[:filename],
@@ -79,6 +109,8 @@ module FoodCritic
 
           matches = remove_ignored(matches, state[:rule], state[:file])
 
+          progress = 'x' if matches.any?
+
           # Convert the matches into warnings
           matches.each do |match|
             warnings << Warning.new(state[:rule],
@@ -87,9 +119,14 @@ module FoodCritic
             matched_rule_tags << state[:rule].tags
           end
         end
+
+        putc progress if options[:progress]
+
         last_dir = cookbook_dir(p[:filename])
       end
 
+      puts '' if options[:progress]
+
       Review.new(paths, warnings)
     end
 
@@ -141,6 +178,7 @@ module FoodCritic
       matches.reject do |m|
         matched_file = m[:filename] || file
         (line = m[:line]) && File.exist?(matched_file) &&
+           !File.directory?(matched_file) &&
            ignore_line_match?(File.readlines(matched_file)[line - 1], rule)
       end
     end
@@ -152,6 +190,8 @@ module FoodCritic
       else
         false
       end
+    rescue
+      false
     end
 
     # Some rules are version specific.