foodcritic 3.0.3 → 4.0.0

data/features/001_check_node_access.feature

@@ -0,0 +1,60 @@
+Feature: Check Node Access
+
+  In order to be consistent in the way I access node attributes and to avoid confusing people new to Ruby
+  As a developer
+  I want to identify if the cookbooks access node attributes with symbols rather than strings
+
+  Scenario: Cookbook recipe accesses attributes via symbols
+    Given a cookbook with a single recipe that reads node attributes via symbols
+    When I check the cookbook
+    Then the node access warning 001 should be displayed
+
+  Scenario: Cookbook recipe accesses multiple attributes via symbols
+    Given a cookbook with a single recipe that accesses multiple node attributes via symbols
+    When I check the cookbook
+    Then the node access warning 001 should be displayed for each match
+
+  Scenario: Assignment of node attributes accessed via symbols
+    Given a cookbook with a single recipe that assigns node attributes accessed via symbols to a local variable
+    When I check the cookbook
+    Then the node access warning 001 should be displayed
+
+  Scenario: Cookbook recipe accesses nested attributes via symbols
+    Given a cookbook with a single recipe that accesses nested node attributes via symbols
+    When I check the cookbook
+    Then the node access warning 001 should be displayed twice for the same line
+
+  Scenario: Cookbook recipe accesses attributes via strings
+    Given a cookbook with a single recipe that reads node attributes via strings
+    When I check the cookbook
+    Then the node access warning 001 should not be displayed
+
+  Scenario: Cookbook recipe access attributes via strings and searches
+    Given a cookbook with a single recipe that searches based on a node attribute accessed via strings
+    When I check the cookbook
+    Then the node access warning 001 should not be displayed
+
+  Scenario: Cookbook recipe access attributes via symbols for template
+    Given a cookbook with a single recipe that passes node attributes accessed via symbols to a template
+    When I check the cookbook
+    Then the node access warning 001 should be displayed against the variables
+
+  Scenario: Cookbook recipe sets default attributes via symbols
+    Given a cookbook that declares default attributes via symbols
+    When I check the cookbook
+    Then the node access warning 001 should be displayed against the attributes file
+
+  Scenario: Cookbook recipe overrides attributes via symbols
+    Given a cookbook that declares override attributes via symbols
+    When I check the cookbook
+    Then the node access warning 001 should be displayed against the attributes file
+
+  Scenario: Cookbook recipe sets attributes via symbols
+    Given a cookbook that declares set attributes via symbols
+    When I check the cookbook
+    Then the node access warning 001 should be displayed against the attributes file
+
+  Scenario: Cookbook recipe sets normal attributes via symbols
+    Given a cookbook that declares normal attributes via symbols
+    When I check the cookbook
+    Then the node access warning 001 should be displayed against the attributes file

data/features/003_check_for_chef_server.feature

@@ -46,6 +46,11 @@ Feature: Check for Chef Server
     When I check the cookbook
     Then the check for server warning 003 should not be displayed against the condition
 
+  Scenario: Search checking for server (ternary)
+    Given a cookbook with a single recipe that searches but checks first (ternary) to see if this is server
+    When I check the cookbook
+    Then the check for server warning 003 should not be displayed against the condition
+
   Scenario Outline: Search checking for server (return)
     Given a cookbook with a single recipe that searches but returns first (<format>) if search is not supported
     When I check the cookbook

data/features/006_check_file_mode.feature

@@ -25,6 +25,7 @@ Feature: Check file mode
       | file          |   644  | invalid             |
       | file          |   044  | invalid             |
       | file          | "0644" |   valid             |
+      | file          | ary[1] |   valid             |
       | template      |  00400 |   valid             |
       | template      |   400  | invalid             |
       | template      |  "400" |   valid             |

data/features/022_check_for_dodgy_conditions_within_loop.feature

@@ -31,3 +31,13 @@ Feature: Check for dodgy resource conditions within a loop
     Given a resource declared with a guard within a loop with multiple block arguments
     When I check the cookbook
     Then the dodgy resource condition warning 022 should not be shown
+
+  Scenario: Resource guard contains a block
+    Given a resource that declares a guard containing a block
+     When I check the cookbook
+     Then the dodgy resource condition warning 022 should not be shown
+
+  Scenario: Loop in a definition
+    Given a resource declared within a definition
+    When I check the cookbook
+    Then the dodgy resource condition warning 022 should not be shown

data/features/040_check_raw_git_usage.feature

@@ -31,7 +31,13 @@ Feature: Check for direct usage of git
     | git fetch origin                                    | should     |
     | git checkout master                                 | should     |
     | git reset --hard                                    | should     |
+    | git status && git pull                              | should     |
     | git show                                            | should not |
     | echo 'bob' && git show                              | should not |
     | gitk                                                | should not |
     | curl http://github.com/                             | should not |
+
+  Scenario: Multiple execute resources
+    Given a cookbook recipe with multiple execute resources where the last uses git
+     When I check the cookbook
+     Then the execute resource used to run git commands warning 040 should be displayed against the last resource

data/features/047_check_for_attribute_assignment_without_precedence.feature

@@ -21,8 +21,10 @@ Feature: Check for attribute assignment without specified precedence
     | node.normal['foo'] = 'bar'          | should not   |
     | node.default['foo'] = 'bar'         | should not   |
     | node.force_default['foo'] = 'bar'   | should not   |
+    | node.default!['foo'] = 'bar'        | should not   |
     | node.set['foo'] = 'bar'             | should not   |
     | node.override['foo'] = 'bar'        | should not   |
+    | node.override!['foo'] = 'bar'       | should not   |
     | node.force_override['foo'] = 'bar'  | should not   |
     | node.automatic_attrs['foo'] = 'bar' | should not   |
     | node['foos'] << 'bar'               | should       |

data/features/build_framework_support.feature

@@ -67,6 +67,16 @@ I want to be able to invoke the lint tool from my build
     | style              | {:fail_tags => ['correctness,style']}        | fail          | FC002       |
     | style,correctness  | {:fail_tags => [], :tags => ['correctness']} | succeed       | FC006       |
 
+  @context
+  Scenario: Specify that contexts should be shown
+    Given a cookbook with a single recipe that reads node attributes via symbols,strings
+      And the cookbook has a Gemfile that includes rake and foodcritic
+      And a Rakefile that defines a lint task with a block setting options to {:context => true}
+      When I run the build
+      Then the recipe filename should be displayed
+      And the attribute consistency warning 019 should be displayed below
+      And the line number and line of code that triggered the warning should be displayed
+
   Scenario Outline: Specify paths to lint
     Given a cookbook that has <problems> problems
       And the cookbook has a Gemfile that includes rake and foodcritic

data/features/exclude_paths_to_lint.feature

@@ -0,0 +1,19 @@
+Feature: Exclude paths from being linted
+
+  In order to avoid linting some paths that are not really from the cookbook
+  As a developer
+  I want to be able to exclude some files or directories from the passed paths
+
+  Scenario: Don't exclude a non cookbook directory
+    Given a cookbook that has style problems
+      And unit tests under a top-level test directory
+     When I check the cookbook without excluding the test directory
+     Then warnings will be displayed against the tests
+      And the style warning 002 should be displayed
+
+  Scenario: Exclude a non cookbook directory
+    Given a cookbook that has style problems
+      And unit tests under a top-level test directory
+     When I check the cookbook excluding the test directory
+     Then no warnings will be displayed against the tests
+      And the style warning 002 should be displayed

data/features/show_lines_matched.feature

@@ -6,15 +6,15 @@ Feature: Show Lines Matched
   I want to be able to see the lines the warning matches against, with context
 
   Scenario: Recipe with a single warning
-    Given a cookbook with a single recipe that reads node attributes via symbols,strings
+    Given a cookbook with a single recipe that reads node attributes via symbols
      When I check the cookbook, specifying that context should be shown
      Then the recipe filename should be displayed
-      And the attribute consistency warning 019 should be displayed below
+      And the node access warning 001 should be displayed below
       And the line number and line of code that triggered the warning should be displayed
 
   Scenario: Recipe with a multiple warnings of the same type
-    Given a cookbook with a single recipe that reads multiple node attributes via symbols,strings
+    Given a cookbook with a single recipe that accesses multiple node attributes via symbols
      When I check the cookbook, specifying that context should be shown
      Then the recipe filename should be displayed
-      And the attribute consistency warning 019 should be displayed below
+      And the node access warning 001 should be displayed below
       And the line number and line of code that triggered the warnings should be displayed

data/features/sort_warnings.feature

@@ -7,4 +7,4 @@ Feature: Sort warnings
   Scenario: Recipe has warnings on lines that don't sort non-numerically
     Given a cookbook with a single recipe which accesses node attributes with symbols on lines 2 and 10
     When I check the cookbook
-    Then the attribute consistency warning 019 should warn on lines 2 and 10 in that order
+    Then the node access warning 001 should warn on lines 2 and 10 in that order

data/features/step_definitions/cookbook_steps.rb

@@ -758,6 +758,20 @@ Given 'a cookbook recipe with a service resource with an action specified via a
   }.strip
 end
 
+Given 'a cookbook recipe with multiple execute resources where the last uses git' do
+  write_recipe %q{
+    execute "one" do
+      command "ls -al"
+    end
+    execute "two" do
+      command "df -H"
+    end
+    execute "three" do
+      command "git clone https://example.org/bar.git"
+    end
+  }.strip
+end
+
 Given 'a cookbook template that uses all variables passed' do
   write_recipe %q{
     template "/tmp/config.conf" do
@@ -1045,13 +1059,10 @@ Given 'a cookbook with a single recipe that mixes node access types in an interp
   }
 end
 
-Given 'a cookbook with a single recipe that reads multiple node attributes via symbols,strings' do
+Given 'a cookbook with a single recipe that accesses multiple node attributes via symbols' do
   write_recipe %q{
     node[:foo] = 'bar'
-    node[:baz] = 'foo'
-    node[:wham] = 'shazam'
-    node['testing'] = 'bar'
-    node['testing2'] = 'bar2'
+    node[:testing] = 'bar'
   }
 end
 
@@ -1159,12 +1170,12 @@ Given 'a cookbook with a single recipe which accesses node attributes with symbo
     # Here we access the node attributes via a symbol
     foo = node[:foo]
 
-    # String access is in the majority
-    node['foo']
-    node['bar']
-    node['baz']
+    directory "/tmp/foo" do
+      owner "root"
+      group "root"
+      action :create
+    end
 
-    # Second access via a symbol
     bar = node[:bar]
   }
 end
@@ -1203,6 +1214,12 @@ Given /^a cookbook with a single recipe that searches but checks first( \(string
   }
 end
 
+Given 'a cookbook with a single recipe that searches but checks first (ternary) to see if this is server' do
+  write_recipe %Q{
+    required_node = Chef::Config[:solo] ? node : search(:node, query).first
+  }
+end
+
 Given /^a cookbook with a single recipe that searches but checks with a negative first to see if this is server$/ do
   write_recipe %q{
     unless Chef::Config['solo']
@@ -1437,6 +1454,40 @@ Given 'a resource declared with a guard within a loop with multiple block argume
   }
 end
 
+Given 'a resource that declares a guard containing a block' do
+  write_recipe %q{
+    template '/etc/foo' do
+      not_if do
+        s = false
+        node['mylist'].each do |realm|
+          s = node['mylist'][realm].empty?
+          break if s
+        end
+        s
+      end
+      owner 'root'
+      group 'root'
+      mode '0644'
+      source 'foo.erb'
+    end
+  }
+end
+
+
+Given 'a resource declared within a definition' do
+  write_recipe %q{
+    define :toto, {
+    } do
+      [:a, :b].each do |x|
+        package x do
+          not_if { node['foo'] == x }
+          action :install
+        end
+      end
+    end
+  }
+end
+
 Given /^a rule that (declares|does not declare) a version constraint(?: of ([^ ]+)? to ([^ ]+)?)?$/ do |constraint, from, to|
   if from || to
     rule_with_version_constraint(from, to)
@@ -1736,6 +1787,10 @@ When /^I check both cookbooks with the command-line (.*)$/ do |command_line|
   run_lint(cmds)
 end
 
+When 'I check both roles directories' do
+  run_lint ['-R', 'roles1', '-R', 'roles2']
+end
+
 When 'I check the cookbooks, role and environment together' do
   run_lint([
     '-B', 'cookbooks/another_example', '-B', 'cookbooks/example',
@@ -1752,14 +1807,15 @@ When 'I check the environment directory' do
   run_lint ['-E', 'environments']
 end
 
-When 'I check both roles directories' do
-  run_lint ['-R', 'roles1', '-R', 'roles2']
-end
-
 When 'I check the eu environment file only' do
   run_lint ['-E', 'environments/production_eu.rb']
 end
 
+When /^I check the cookbook( without)? excluding the ([^ ]+) directory$/ do |no_exclude, dir|
+  options = no_exclude.nil? ? ['-X', dir] : []
+  run_lint(options + ['cookbooks/example'])
+end
+
 When 'I check the recipe' do
   run_lint(["cookbooks/example/recipes/default.rb"])
 end
@@ -1852,11 +1908,11 @@ Then 'a warning for the custom rule should be displayed' do
 end
 
 Then 'all options should be documented in the man page' do
-  man_page_options.should == usage_options_for_diff
+  man_page_options.must_equal usage_options_for_diff
 end
 
 Then /^an? '([^']+)' error should be displayed$/ do |expected_error|
-  last_error.should include expected_error
+  last_error.must_include expected_error
 end
 
 Then 'the attribute consistency warning 019 should be shown for both of the recipes that use symbols' do
@@ -1873,6 +1929,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 execute resource used to run git commands warning 040 should be displayed against the last resource' do
+  expect_warning 'FC040', {:line => 7}
+end
+
 Then /^the LWRP does not notify when updated warning 017 should( not)? be shown against the :([^ ]+) action$/ do |not_shown, action|
   line = action == 'create' ? 1 : 8
   expect_warning('FC017', :file_type => :provider, :expect_warning => ! not_shown, :line => line)
@@ -1914,15 +1974,19 @@ end
 
 Then /^the lint task will be listed( under the different name)?$/ do |diff_name|
   expected_name = diff_name ? 'lint' : 'foodcritic'
-  build_tasks.should include([expected_name, 'Lint Chef cookbooks'])
+  build_tasks.must_include([expected_name, 'Lint Chef cookbooks'])
 end
 
 Then 'no error should have occurred' do
   assert_no_error_occurred
 end
 
-Then /^no warnings will be displayed against the tests$/ do
-  assert_no_test_warnings
+Then /^(no )?warnings will be displayed against the tests$/ do |no_display|
+  if no_display.nil?
+    assert_test_warnings
+  else
+    assert_no_test_warnings
+  end
 end
 
 Then 'the attribute consistency warning 019 should warn on lines 2 and 10 in that order' do
@@ -1982,7 +2046,7 @@ Then /^the build will (succeed|fail) with (?:no )?warnings(.*)$/ do |build_outco
 end
 
 Then 'the check for server warning 003 should not be displayed against the condition' do
-  expect_warning("FC003", :line => 5, :expect_warning => false)
+  expect_warning("FC003", :line => nil, :expect_warning => false)
 end
 
 Then /^the check for server warning 003 should not be displayed against the search after the (.*) conditional$/ do |format|
@@ -2038,10 +2102,10 @@ end
 
 Then /^the line number and line of code that triggered the warning(s)? should be displayed$/ do |multiple|
   if multiple.nil?
-    expect_line_shown 2, "log node['foo']"
+    expect_line_shown 1, "log node[:foo]"
   else
-    expect_line_shown 4, "    node['testing'] = 'bar'"
-    expect_line_shown 5, "    node['testing2'] = 'bar2'"
+    expect_line_shown 1, "node[:foo] = 'bar'"
+    expect_line_shown 2, "    node[:testing] = 'bar'"
   end
 end
 
@@ -2053,6 +2117,35 @@ Then /^the no leading cookbook name warning 029 should be (not )?shown$/ do |sho
   expect_warning('FC029', :line => 1, :expect_warning => should_not.nil?, :file => 'metadata.rb')
 end
 
+Then 'the node access warning 001 should be displayed for each match' do
+  expect_warning('FC001', :line => 1)
+  expect_warning('FC001', :line => 2)
+end
+
+Then 'the node access warning 001 should be displayed against the variables' do
+  expect_warning('FC001', :line => 4)
+  expect_warning('FC001', :line => 5)
+end
+
+Then 'the node access warning 001 should be displayed twice for the same line' do
+  expect_warning('FC001', :line => 1, :num_occurrences => 2)
+end
+
+Then 'the node access warning 001 should warn on lines 2 and 10 in that order' do
+  expected_warnings = [2, 10].map do |line|
+    "FC001: Use strings in preference to symbols to access node attributes: cookbooks/example/recipes/default.rb:#{line}"
+  end
+  expect_output(expected_warnings.join("\n"))
+end
+
+Then 'the node access warning 001 should be displayed for the recipe' do
+  expect_warning('FC001')
+end
+
+Then 'the node access warning 001 should not be displayed for the attributes' do
+  expect_warning("FC001", :file_type => :attributes, :line => 1, :expect_warning => false)
+end
+
 Then 'the prefer chef_gem to manual install warning 025 should be shown' do
   expect_warning('FC025', :line => nil)
 end
@@ -2115,7 +2208,7 @@ end
 
 Then 'the usage text should include an option for specifying tags that will fail the build' do
   expect_usage_option('f', 'epic-fail TAGS',
-    "Fail the build if any of the specified tags are matched ('any' -> fail on any match).")
+    "Fail the build based on tags. Use 'any' to fail on all warnings.")
 end
 
 Then /^the warnings shown should be (.*)$/ do |warnings|

data/features/support/command_helpers.rb

@@ -5,8 +5,16 @@ module FoodCritic
   # Unless the environment variable FC_FORK_PROCESS is set to 'true' then the features will be run in the same process.
   module CommandHelpers
 
+    include MiniTest::Assertions
+
+    attr_writer :assertions
+    def assertions
+      @assertions ||= 0
+    end
+
     # The warning codes and messages displayed to the end user.
     WARNINGS = {
+      'FC001' => 'Use strings in preference to symbols to access node attributes',
       'FC002' => 'Avoid string interpolation where not required',
       'FC003' => 'Check whether you are running with chef server before using server-specific features',
       'FC004' => 'Use a service resource to start and stop services',
@@ -131,6 +139,12 @@ module FoodCritic
       expect_output(Regexp.new(expected_switch))
     end
 
+    def has_test_warnings?(output)
+      output.split("\n").grep(/FC[0-9]+:/).map do |warn|
+        File.basename(File.dirname(warn.split(':').take(3).last.strip))
+      end.include?('test')
+    end
+
     def man_page_options
       man_path = Pathname.new(__FILE__) + '../../../man/foodcritic.1.ronn'
       option_lines = File.read(man_path).split('## ').find do |s|
@@ -167,10 +181,10 @@ module FoodCritic
          :description => 'Only check against rules valid for this version of Chef.'},
 
         {:short => 'f', :long => 'epic-fail TAGS',
-         :description => "Fail the build if any of the specified tags are matched ('any' -> fail on any match)."},
+         :description => "Fail the build based on tags. Use 'any' to fail on all warnings."},
 
         {:short => 't', :long => 'tags TAGS',
-         :description => 'Only check against rules with the specified tags.'},
+         :description => 'Check against (or exclude ~) rules with the specified tags.'},
 
         {:short => 'B', :long => 'cookbook-path PATH',
          :description => 'Cookbook path(s) to check.'},
@@ -191,7 +205,10 @@ module FoodCritic
          :description => 'Specify grammar to use when validating search syntax.'},
 
         {:short => 'V', :long => 'version',
-         :description => 'Display the foodcritic version.'}
+         :description => 'Display the foodcritic version.'},
+
+        {:short => 'X', :long => 'exclude PATH',
+         :description => 'Exclude path(s) from being linted.'}
 
       ]
     end
@@ -213,9 +230,9 @@ module FoodCritic
     # @param [String] output The warning to check for.
     def expect_output(output)
       if output.respond_to?(:~)
-        @review.should match(output)
+        @review.must_match(output)
       else
-        @review.should include(output)
+        @review.must_include(output)
       end
     end
 
@@ -224,20 +241,32 @@ module FoodCritic
     # @param [String] output The output to check for.
     def expect_no_output(output)
       if output.respond_to?(:~)
-        @review.should_not match(output)
+        @review.wont_match(output)
       else
-        @review.should_not include(output)
+        @review.wont_include(output)
       end
     end
 
     # Assert that an error occurred following a lint check.
     def assert_error_occurred
-      @status.should_not == 0
+      @status.wont_equal 0
     end
 
     # Assert that no error occurred following a lint check.
     def assert_no_error_occurred
-      @status.should == 0
+      @status.must_equal 0
+    end
+
+    # Assert that warnings have not been raised against the test code which
+    # should have been excluded from linting.
+    def assert_no_test_warnings
+      refute has_test_warnings?(@review)
+    end
+
+    # Assert that warnings have been raised against the test code which
+    # shouldn't have been excluded from linting.
+    def assert_test_warnings
+      assert has_test_warnings?(@review)
     end
 
     # Run a lint check with the provided command line arguments.
@@ -278,9 +307,13 @@ module FoodCritic
     # Assert that warnings have not been raised against the test code which
     # should have been excluded from linting.
     def assert_no_test_warnings
-      all_output.split("\n").grep(/FC[0-9]+:/).map do |warn|
-        File.basename(File.dirname(warn.split(':').take(3).last.strip))
-      end.should_not include 'test'
+      refute has_test_warnings?(all_output)
+    end
+
+    # Assert that warnings have been raised against the test code which
+    # shouldn't have been excluded from linting.
+    def assert_test_warnings
+      assert has_test_warnings?(all_output)
     end
 
     # The available tasks for this build