foodcritic 2.2.0 → 3.0.0

data/features/ignore_via_line_comments.feature

@@ -49,3 +49,21 @@ Feature: Ignoring rules on per line basis
     | # ~FC002,~FC007 | FC002       |
     | # ~FC002,~FC039 |             |
     | # ~FC002        | FC039       |
+
+  Scenario Outline: Ignoring role rules
+    Given a ruby role that triggers FC049 with comment <comment>
+     When I check the role directory
+     Then the role name does not match file name warning 049 should <shown>
+  Examples:
+    | comment | shown        |
+    |         | be shown     |
+    | #~FC049 | not be shown |
+
+  Scenario Outline: Ignoring environment rules
+    Given a ruby environment that triggers FC050 with comment <comment>
+     When I check the environment directory
+     Then the invalid environment name warning 050 should <shown>
+  Examples:
+    | comment | shown        |
+    |         | be shown     |
+    | #~FC050 | not be shown |

data/features/individual_file.feature

@@ -4,9 +4,25 @@ Feature: Individual file
   As a developer
   I want to lint individual files in a cookbook
 
-  Scenario: Linting an individual file shows warnings only from that file
+  Scenario: Linting an individual recipe shows warnings only from that file
     Given a cookbook with a single recipe that reads node attributes via symbols,strings
       And a cookbook that declares normal attributes via symbols
      When I check the recipe
      Then the attribute consistency warning 019 should be displayed for the recipe
       And the attribute consistency warning 019 should not be displayed for the attributes
+
+  Scenario: Linting an individual role
+    Given a roles directory
+      And it contains a role file webserver.rb that defines the role name "apache"
+      And it contains a role file database.rb that defines the role name "postgresql"
+     When I check the webserver role only
+     Then the role name does not match file name warning 049 should be shown against the webserver role
+      And the role name does not match file name warning 049 should not be shown against the database role
+
+  Scenario: Linting an individual environment
+    Given an environments directory
+      And it contains an environment file production_eu.rb that defines the environment name "production (eu-west-1)"
+      And it contains an environment file production_us.rb that defines the environment name "production (us-east-1)"
+     When I check the eu environment file only
+     Then the invalid environment name warning 050 should be shown against the eu environment
+      And the invalid environment name warning 050 should not be shown against the us environment

data/features/multiple_paths.feature

@@ -4,8 +4,32 @@ Feature: Multiple paths
   As a developer
   I want to lint multiple paths at once
 
-  Scenario: Linting multiple individual cookbooks
+  Scenario Outline: Linting multiple individual cookbooks
     Given a cookbook with a single recipe that reads node attributes via symbols,strings
       And another cookbook with a single recipe that reads node attributes via strings
-     When I check both cookbooks
+     When I check both cookbooks with the command-line <command_line>
      Then the attribute consistency warning 019 should be shown
+  Examples:
+    | command_line                                            |
+    | example another_example                                 |
+    | -B example -B another_example                           |
+    | --cookbook-path example --cookbook-path another_example |
+    | -B example another_example                              |
+    | --cookbook-path example another_example                 |
+    | -B example --cookbook-path another_example              |
+
+  Scenario: Linting multiple role directories
+    Given two roles directories
+      And each role directory has a role with a name that does not match the containing file name
+     When I check both roles directories
+     Then the role name does not match file name warning 049 should be shown against the files in both directories
+
+  Scenario: Linting a cookbook, role and environment together
+    Given a cookbook with a single recipe that reads node attributes via symbols,strings
+      And another cookbook with a single recipe that reads node attributes via strings
+      And a directory that contains a role file webserver.rb in ruby that defines role name apache
+      And a directory that contains an environment file production.rb in ruby that defines environment name production (us-east)
+     When I check the cookbooks, role and environment together
+     Then the attribute consistency warning 019 should be shown
+      And the role name does not match file name warning 049 should be shown
+      And the invalid environment name warning 050 should be shown

data/features/step_definitions/cookbook_steps.rb

@@ -34,8 +34,20 @@ Given 'a cookbook attributes file with a do block that takes arguments' do
   }
 end
 
-Given /^a cookbook attributes file with assignment (.*)$/ do |assignment|
-  write_attributes assignment
+Given /^a cookbook (attributes|recipe) file with assignment (.*)$/ do |type, assignment|
+  if type == 'attributes'
+    write_attributes assignment
+  else
+    write_recipe assignment
+  end
+end
+
+Given "a cookbook recipe that contains a group resource that uses the 'system' attribute" do
+  write_recipe %q{
+    group "senge" do
+      system true
+    end
+  }
 end
 
 Given /^a cookbook recipe that declares (too many )?execute resources varying only in the command in branching conditionals$/ do |too_many|
@@ -69,6 +81,18 @@ Given /^a cookbook recipe that declares a ([^ ]+) resource with the ([^ ]+) attr
   }
 end
 
+Given /^a cookbook recipe that executes '([^']+)' with an execute resource$/ do |command|
+  write_recipe %Q{
+    execute "#{command}" do
+      action :run
+    end
+  }
+end
+
+Given /^a cookbook recipe that spawns a sub-process with (.*)$/ do |command|
+  write_recipe command
+end
+
 Given 'a cookbook recipe with a deploy resource that contains a template resource' do
   write_recipe %q{
     deploy '/foo/bar' do
@@ -429,8 +453,9 @@ Given /^a cookbook recipe that includes a recipe name from an( embedded)? expres
   }
 end
 
-Given /^a cookbook recipe that includes a(n un| )?declared recipe dependency( unscoped)?$/ do |undeclared,unscoped|
-  recipe_with_dependency(:is_declared => undeclared.strip.empty?, :is_scoped => unscoped.nil?)
+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
@@ -465,6 +490,17 @@ Given /a cookbook recipe that (install|upgrade)s (a gem|multiple gems)(.*)$/ do
   end
 end
 
+Given 'a cookbook recipe that refers to a hidden template' do
+  write_recipe %q{
+    template '/etc/.s3cfg' do
+      source '.s3cfg.erb'
+    end
+  }
+  write_file "cookbooks/example/templates/default/.s3cfg.erb", %q{
+    config=true
+  }
+end
+
 Given /^a cookbook recipe that refers to a (missing |local )?template( in a subdirectory)?$/ do |missing_or_local, sub_dir|
   sub_dir = sub_dir ? 'sub_dir/' : ''
   write_recipe %Q{
@@ -755,6 +791,16 @@ Given /^a cookbook that passes variables (.*) to a template with extension (.*)$
   }
 end
 
+Given /^a cookbook that passes variables (.*) to an inferred template$/ do |vars|
+  write_recipe %Q{
+    template "/tmp/config.conf" do
+      variables(
+        :#{vars.split(',').map{|v| "#{v} => node[:#{v}]"}.join(",\n:")}
+      )
+    end
+  }
+end
+
 Given /^a cookbook that contains a (short|long) ruby block$/ do |length|
   recipe_with_ruby_block(length.to_sym)
 end
@@ -805,10 +851,46 @@ Given /^a cookbook that contains a LWRP that (?:does not trigger notifications|d
   })
 end
 
+Given /^a cookbook that contains a LWRP that uses converge_by - (brace|do) block (with|without) parentheses$/ do |block_type, with_parens|
+  write_resource("site", %q{
+    actions :create
+    attribute :name, :kind_of => String, :name_attribute => true
+  })
+  if block_type == 'brace'
+    write_provider("site", %q{
+      action :create do
+        converge_by("Creating site #{new_resource.name}"){ Site.new(new_resource.name).create }
+      end
+    })
+  else
+    if with_parens == 'with'
+      write_provider("site", %q{
+        action :create do
+          converge_by("Creating site #{new_resource.name}") do
+            Site.new(new_resource.name).create
+          end
+        end
+      })
+    else
+      write_provider("site", %q{
+        action :create do
+          converge_by "Creating site #{new_resource.name}" do
+            Site.new(new_resource.name).create
+          end
+        end
+      })
+    end
+  end
+end
+
 Given /^a cookbook that contains a LWRP that uses the deprecated notification syntax(.*)$/ do |qualifier|
   cookbook_with_lwrp({:notifies => qualifier.include?('class variable') ? :class_variable : :deprecated_syntax})
 end
 
+Given 'a cookbook that contains a LWRP that uses use_inline_resources' do
+  cookbook_with_lwrp({:use_inline_resources => true})
+end
+
 Given 'a cookbook that contains a LWRP with multiple notifications' do
   write_resource("site", %q{
     actions :create, :delete
@@ -1176,6 +1258,22 @@ Given /^a cookbook with metadata that (specifies|does not specify) the cookbook
   }
 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
+
+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
+
 Given /^a ([a-z_]+) resource declared with the mode ([^\s]+)(?: with comment (.*)?)?$/ do |resource,mode,comment|
   recipe_resource_with_mode(resource, mode, comment)
 end
@@ -1192,6 +1290,17 @@ Given /^a file with multiple errors on one line(?: with comment (.*))?$/ do |com
   write_file "cookbooks/example/recipes/default.rb", %Q{node['run_state']['nginx_force_recompile'] = "\#{foo}"#{comment}}
 end
 
+Given(/^a LWRP with an action :create that notifies with (converge_by|updated_by_last_action) and another :delete that does not notify$/) do |notify_type|
+  cookbook_with_lwrp_actions([
+    {:name => :create, :notify_type => notify_type.to_sym},
+    {:name => :delete, :notify_type => :none}
+  ])
+end
+
+Given /^(?:a roles|an environments) directory$/ do
+
+end
+
 Given /^a Rakefile that defines (no lint task|a lint task with no block|a lint task with an empty block|a lint task with a block setting options to)(.*)?$/ do |task,options|
   rakefile(
     case task
@@ -1326,6 +1435,28 @@ Given /^a rule that (declares|does not declare) a version constraint(?: of ([^ ]
   end
 end
 
+Given /^a template that includes a partial( that includes the original template again)?$/ do |loops|
+  write_recipe %q{
+    template "/tmp/a" do
+      source "a.erb"
+      variables({
+        :config_var => "foo"
+      })
+    end
+  }
+  write_file 'cookbooks/example/templates/default/a.erb', '<%= render "b.erb" %>'
+  content = if loops
+    '<%= render "a.erb" %>'
+  else
+    '<%= @config_var %>'
+  end
+  write_file 'cookbooks/example/templates/default/b.erb', content
+end
+
+Given 'access to the man page documentation' do
+
+end
+
 Given /^another cookbook that has (an older )?chef-solo-search installed$/ do |older|
   if older.nil?
     write_library 'search', %q{
@@ -1374,6 +1505,16 @@ 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} %>
+  }
+end
+
 Given /^the template (.+)?contains the expression (.*)$/ do |ext,expr|
   file = if ext
     "templates/default/config#{ext.strip}"
@@ -1385,6 +1526,40 @@ Given /^the template (.+)?contains the expression (.*)$/ do |ext,expr|
   }
 end
 
+Given /^the template (.+)?contains partial includes of type (.*) with the expression (.*)$/ do |ext,type,expr|
+  file = if ext
+    "config#{ext.strip}"
+  else
+    'config.conf.erb'
+  end
+  if type == 'nested' and expr.split(',').length > 1
+    expressions = expr.split(',')
+    includes = (1..expressions.length).map{|i| "included_template_#{i}.erb"}
+    (Array(file) + includes).zip(includes).map do |parent, child|
+      content = if child
+        "<%= render '#{child}' %>"
+      else
+        expressions.map{|e| "<%= #{e} %>"}.join("\n")
+      end
+      [parent, content]
+    end.each do |template_name, content|
+      write_file "cookbooks/example/templates/default/#{template_name}", content
+    end
+  else
+    if type == 'no parentheses'
+      include_string = "<%= render 'included_template.erb' %>"
+    else
+      include_string = "<%= render('included_template.erb') %>"
+    end
+    write_file "cookbooks/example/templates/default/#{file}", %Q{
+      #{include_string}
+    }
+    write_file "cookbooks/example/templates/default/included_template.erb", %Q{
+      <%= #{expr} %>
+    }
+  end
+end
+
 Given 'unit tests under a top-level test directory' do
   minitest_spec_attributes
 end
@@ -1427,6 +1602,41 @@ Given /^a recipe that uses include_recipe$/ 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}
+    run_list "recipe[apache2]"
+  }.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}
+    run_list "recipe[apache2]"
+  }.strip
+end
+
+Given 'each role directory has a role with a name that does not match the containing file name' do
+  role(:dir => 'roles1', :role_name => '"apache"', :file_name => 'webserver.rb')
+  role(:dir => 'roles2', :role_name => '"postgresql"', :file_name => 'database.rb')
+end
+
+Given /^it contains an environment file (.*\.rb) that defines the environment name (.*)$/ do |file_name, env_name|
+  environment(:environment_name => env_name, :file_name => file_name)
+end
+
+Given /^it contains a role file ([a-z]+\.rb) that defines the role name (.*)$/ do |file_name, role_name|
+  role(:role_name => role_name, :file_name => file_name)
+end
+
 Given /^the cookbook metadata declares support for (.*)$/ do |supported_platforms|
   write_metadata(supported_platforms.split(',').map do |platform|
     "supports '#{platform}'"
@@ -1452,6 +1662,10 @@ Given 'two of the recipes read node attributes via symbols' do
   end
 end
 
+Given 'two roles directories' do
+
+end
+
 When /^I check the cookbook specifying ([^ ]+) as the Chef version$/ do |version|
   options = ['-c', version, 'cookbooks/example']
   in_current_dir do
@@ -1471,18 +1685,70 @@ Given /^the cookbook directory has a \.foodcritic file specifying tags (.*)$/ do
   run_lint(["cookbooks/example"])
 end
 
-When 'I check both cookbooks' do
+When 'I check both cookbooks specified as arguments' do
   run_lint(["cookbooks/another_example", "cookbooks/example"])
 end
 
+When /^I check both cookbooks with the command-line (.*)$/ do |command_line|
+  cmds = command_line.split(' ').map do |c|
+    if c.end_with?('example')
+      "cookbooks/#{c}"
+    else
+      c
+    end
+  end
+  run_lint(cmds)
+end
+
+When 'I check the cookbooks, role and environment together' do
+  run_lint([
+    '-B', 'cookbooks/another_example', '-B', 'cookbooks/example',
+    '-E', 'environments',
+    '-R', 'roles'
+  ])
+end
+
 When 'I check the cookbook without specifying a Chef version' do
   run_lint(['-I', 'rules/test.rb', 'cookbooks/example'])
 end
 
+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 recipe' do
   run_lint(["cookbooks/example/recipes/default.rb"])
 end
 
+When 'I compare the man page options against the usage options' do
+
+end
+
+When 'I check the role directory' do
+  run_lint ['-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 ['roles']
+    when 'cookbook' then ['-B', 'roles']
+    when 'role' then ['-R', 'roles']
+  end
+  run_lint(options)
+end
+
+When 'I check the webserver role only' do
+  run_lint ['-R', 'roles/webserver.rb']
+end
+
 When 'I list the available build tasks' do
   list_available_build_tasks
 end
@@ -1518,6 +1784,14 @@ When 'I run it on the command line specifying a cookbook that does not exist' do
   run_lint(['no-such-cookbook'])
 end
 
+When /^I run it on the command line specifying a( role|n environment) directory that does not exist$/ do |type|
+  if type.include?('role')
+    run_lint(['-R', 'no-such-role-dir'])
+  else
+    run_lint(['-E', 'no-such-environment-dir'])
+  end
+end
+
 When 'I run it on the command line with no arguments' do
   run_lint([])
 end
@@ -1541,6 +1815,10 @@ Then 'a warning for the custom rule should be displayed' do
   expect_output('BAR001: Use symbols in preference to strings to access node attributes: cookbooks/example/recipes/default.rb:1')
 end
 
+Then 'all options should be documented in the man page' do
+  man_page_options.should == usage_options_for_diff
+end
+
 Then /^an? '([^']+)' error should be displayed$/ do |expected_error|
   last_error.should include expected_error
 end
@@ -1559,6 +1837,40 @@ 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 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)
+end
+
+Then /^the invalid (role|environment) name warning 050 should( not)? be shown$/ do |type, not_shown|
+  file = type == 'role' ? 'roles/webserver.rb' : 'environments/production.rb'
+  expect_warning 'FC050', {:expect_warning => ! not_shown, :file => file}
+end
+
+Then /^the invalid environment name warning 050 should( not)? be shown against the (eu|us) environment$/ do |not_shown, env|
+  expect_warning 'FC050', {:expect_warning => ! not_shown,
+    :file => "environments/production_#{env}.rb", :line => 1}
+end
+
+Then 'the prefer mixlib shellout warning 048 should not be displayed against the group 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}
+end
+
+Then 'the role name does not match file name warning 049 should be shown against the files in both directories' do
+  expect_warning 'FC049', {:file => "roles1/webserver.rb", :line => 1}
+  expect_warning 'FC049', {:file => "roles2/database.rb", :line => 1}
+end
+
+Then /^the role name does not match file name warning 049 should( not)? be shown against the (webserver|database) role$/ do |not_shown, role|
+  expect_warning 'FC049', {:expect_warning => ! not_shown,
+                           :file => "roles/#{role}.rb", :line => 1}
+end
+
 Then 'the long ruby block warning 014 should be displayed against the long block only' do
   expect_warning 'FC014', {:expect_warning => false, :line => 1}
   expect_warning 'FC014', {:expect_warning => true, :line => 11}
@@ -1730,17 +2042,24 @@ Then /^the simple usage text should be displayed along with a (non-)?zero exit c
   usage_displayed(non_zero.nil?)
 end
 
+Then /^the template partials loop indefinitely warning 051 should (not )?be displayed against the templates$/ do |not_shown|
+  expect_warning('FC051', :file => 'templates/default/a.erb', :line => 1,
+                 :expect_warning => ! not_shown)
+  expect_warning('FC051', :file => 'templates/default/b.erb', :line => 1,
+                 :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 template(.*)?$/ do |not_shown, ext|
-  file = if ext
-    "templates/default/config#{ext.strip}"
-  else
+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'
+  else
+    "templates/default/config#{ext.strip}"
   end
   expect_warning('FC034', :file => file, :line => 1,
 		 :expect_warning => ! not_shown)