foodcritic 2.2.0 → 3.0.0

data/features/007_check_for_undeclared_recipe_dependencies.feature

@@ -4,15 +4,16 @@ Feature: Check for undeclared recipe dependencies
   As a developer
   I want to identify included recipes that are not expressed in cookbook metadata
 
-  Scenario: Cookbook includes undeclared recipe dependency
-    Given a cookbook recipe that includes an undeclared recipe dependency
-    When I check the cookbook
-    Then the undeclared dependency warning 007 should be displayed
-
-  Scenario: Cookbook includes undeclared recipe dependency unscoped
-    Given a cookbook recipe that includes an undeclared recipe dependency unscoped
+  Scenario Outline: Cookbook includes undeclared recipe dependency
+    Given a cookbook recipe that includes an undeclared recipe dependency <qualifiers>
     When I check the cookbook
     Then the undeclared dependency warning 007 should be displayed
+  Examples:
+    | qualifiers                |
+    |                           |
+    | with parentheses          |
+    | unscoped                  |
+    | unscoped with parentheses |
 
   Scenario: Cookbook includes recipe via expression
     Given a cookbook recipe that includes a recipe name from an expression
@@ -29,41 +30,24 @@ Feature: Check for undeclared recipe dependencies
     | #{cookbook_name}::other        |
     | #{cbk}_other::other            |
 
-  Scenario: Cookbook includes declared recipe dependency
-    Given a cookbook recipe that includes a declared recipe dependency
-    When I check the cookbook
-    Then the undeclared dependency warning 007 should not be displayed
-
-  Scenario: Cookbook includes declared recipe dependency unscoped
-    Given a cookbook recipe that includes a declared recipe dependency unscoped
-    When I check the cookbook
-    Then the undeclared dependency warning 007 should not be displayed
-
-  Scenario: Cookbook includes several declared recipe dependencies
-    Given a cookbook recipe that includes several declared recipe dependencies - brace
-    When I check the cookbook
-    Then the undeclared dependency warning 007 should not be displayed
-
-  Scenario: Cookbook includes several declared recipe dependencies
-    Given a cookbook recipe that includes several declared recipe dependencies - block
+  Scenario Outline: Declared dependencies
+    Given a cookbook recipe that includes <dependency_type>
     When I check the cookbook
     Then the undeclared dependency warning 007 should not be displayed
+  Examples:
+    | dependency_type                                         |
+    | a declared recipe dependency                            |
+    | a declared recipe dependency unscoped                   |
+    | several declared recipe dependencies - block            |
+    | several declared recipe dependencies - brace            |
+    | a local recipe                                          |
+    | a local recipe where the directory is differently named |
 
   Scenario: Cookbook includes mix of declared and undeclared recipe dependencies
     Given a cookbook recipe that includes both declared and undeclared recipe dependencies
     When I check the cookbook
     Then the undeclared dependency warning 007 should be displayed only for the undeclared dependencies
 
-  Scenario: Cookbook includes local recipe
-    Given a cookbook recipe that includes a local recipe
-    When I check the cookbook
-    Then the undeclared dependency warning 007 should not be displayed
-
-  Scenario: Cookbook includes local recipe - name in metadata
-    Given a cookbook recipe that includes a local recipe where the directory is differently named
-    When I check the cookbook
-    Then the undeclared dependency warning 007 should not be displayed
-
   Scenario: Cookbook has no metadata file
     Given a cookbook that does not have defined metadata
     When I check the cookbook

data/features/017_check_for_no_lwrp_notifications.feature

@@ -23,3 +23,28 @@ Feature: Check for no LWRP notifications
     Given a cookbook that contains a LWRP with multiple notifications
     When I check the cookbook
     Then the LWRP does not notify when updated warning 017 should not be displayed against the provider file
+
+  Scenario Outline: LWRP using converge_by
+    Given a cookbook that contains a LWRP that uses converge_by - <block_type> block <with_parens> parentheses
+    When I check the cookbook
+    Then the LWRP does not notify when updated warning 017 should not be displayed against the provider file
+  Examples:
+    | block_type | with_parens |
+    | brace      | with        |
+    | do         | with        |
+    | do         | without     |
+
+  Scenario: LWRP using use_inline_resources
+    Given a cookbook that contains a LWRP that uses use_inline_resources
+     When I check the cookbook
+     Then the LWRP does not notify when updated warning 017 should not be displayed against the provider file
+
+  Scenario Outline: Warnings raised for actions individually
+    Given a LWRP with an action :create that notifies with <notify_type> and another :delete that does not notify
+    When I check the cookbook
+    Then the LWRP does not notify when updated warning 017 should not be shown against the :create action
+     And the LWRP does not notify when updated warning 017 should be shown against the :delete action
+  Examples:
+    | notify_type            |
+    | converge_by            |
+    | updated_by_last_action |

data/features/019_check_for_consistent_node_access.feature

@@ -53,6 +53,7 @@ Feature: Check for consistency in node access
       | reads    | strings          | platform? | not shown    |
       | reads    | symbols          | run_list  | not shown    |
       | reads    | symbols          | run_state | not shown    |
+      | reads    | strings          | run_state | not shown    |
       | reads    | strings          | set       | not shown    |
       | reads    | strings,symbols  | set       | shown        |
 

data/features/033_check_for_missing_template.feature

@@ -4,70 +4,26 @@ Feature: Check for missing template
   As a developer
   I want to identify template resources that refer to missing templates
 
-  Scenario: Missing template
-    Given a cookbook recipe that refers to a missing template
-     When I check the cookbook
-     Then the missing template warning 033 should be displayed
-
-  Scenario: Missing template (inferred)
-    Given a cookbook recipe that uses a missing inferred template
-     When I check the cookbook
-     Then the missing template warning 033 should be displayed
-
-  Scenario: Present template
-    Given a cookbook recipe that refers to a template
-     When I check the cookbook
-     Then the missing template warning 033 should not be displayed
-
-  Scenario: Present template (not .erb)
-    Given a cookbook recipe that refers to a template without an erb extension
-     When I check the cookbook
-     Then the missing template warning 033 should not be displayed
-
-  Scenario: Present template (subdirectory)
-    Given a cookbook recipe that refers to a template in a subdirectory
-     When I check the cookbook
-     Then the missing template warning 033 should not be displayed
-
-  Scenario: Present template (inferred)
-    Given a cookbook recipe that uses an inferred template
-     When I check the cookbook
-     Then the missing template warning 033 should not be displayed
-
-  Scenario: Template present in another cookbook
-    Given a cookbook recipe that uses a template from another cookbook
-     When I check the cookbook
-     Then the missing template warning 033 should not be displayed
-
-  Scenario: Local template
-    Given a cookbook recipe that refers to a local template
-     When I check the cookbook
-     Then the missing template warning 033 should not be displayed
-
-  Scenario: Template source name is an expression
-    Given a cookbook recipe that refers to a template with an expression
-     When I check the cookbook
-     Then the missing template warning 033 should not be displayed
-
-  Scenario: Template source is an expression (inferred)
-    Given a cookbook recipe that infers a template with an expression
-     When I check the cookbook
-     Then the missing template warning 033 should not be displayed
-
-  Scenario: Template name and source are expressions
-    Given a cookbook recipe that defines a template where name and source are both simple expressions
-     When I check the cookbook
-     Then the missing template warning 033 should not be displayed
-
-  Scenario: Template name is a complex expression
-    Given a cookbook recipe that defines a template where name is a complex expression
-     When I check the cookbook
-     Then the missing template warning 033 should not be displayed
-
-  Scenario: Template name and source are complex expressions
-    Given a cookbook recipe that defines a template where both the name and source are complex expressions
-     When I check the cookbook
-     Then the missing template warning 033 should not be displayed
+  Scenario Outline: Template types
+    Given a cookbook recipe that <template_type>
+     When I check the cookbook
+     Then the missing template warning 033 <warning>
+  Examples:
+    | template_type                                                             | warning                 |
+    | defines a template where both the name and source are complex expressions | should not be displayed |
+    | defines a template where name and source are both simple expressions      | should not be displayed |
+    | defines a template where name is a complex expression                     | should not be displayed |
+    | infers a template with an expression                                      | should not be displayed |
+    | refers to a hidden template                                               | should not be displayed |
+    | refers to a local template                                                | should not be displayed |
+    | refers to a missing template                                              | should be displayed     |
+    | refers to a template in a subdirectory                                    | should not be displayed |
+    | refers to a template                                                      | should not be displayed |
+    | refers to a template with an expression                                   | should not be displayed |
+    | refers to a template without an erb extension                             | should not be displayed |
+    | uses a missing inferred template                                          | should be displayed     |
+    | uses an inferred template                                                 | should not be displayed |
+    | uses a template from another cookbook                                     | should not be displayed |
 
   Scenario: Template within deploy resource
     Given a cookbook recipe with a deploy resource that contains a template resource

data/features/034_check_for_unused_template_variables.feature

@@ -35,3 +35,47 @@ Feature: Check for unused template variables
       | config_var,another_var | @another_var                | .conf.erb | should     |
       | config_var             | @config_var                 | .conf     | should not |
       | config_var,another_var | @another_var                | .conf     | should     |
+
+  Scenario Outline: Variables passed with includes
+    Given a cookbook that passes variables <variables> to a template with extension <extension>
+      And the template <extension> contains partial includes of type <type> with the expression <expression>
+     When I check the cookbook
+     Then the unused template variables warning 034 <displayed> be displayed against the template <extension>
+    Examples:
+      | variables              | expression                  | type           | extension | displayed  |
+      | config_var             | node[:configs][:config_var] | no parentheses | .conf.erb | should     |
+      | config_var             | @config_var                 | no parentheses | .conf.erb | should not |
+      | config_var             | @config_var['foo']          | no parentheses | .conf.erb | should not |
+      | config_var             | node[:configs][:config_var] | no parentheses | .conf.erb | should     |
+      | config_var,another_var | node[:configs][:config_var] | no parentheses | .conf.erb | should     |
+      | config_var,another_var | @config_var                 | no parentheses | .conf.erb | should     |
+      | config_var,another_var | @another_var                | no parentheses | .conf.erb | should     |
+      | config_var             | @config_var                 | no parentheses | .conf     | should not |
+      | config_var,another_var | @another_var                | no parentheses | .conf     | should     |
+      | config_var             | node[:configs][:config_var] | parentheses    | .conf.erb | should     |
+      | config_var             | @config_var                 | parentheses    | .conf.erb | should not |
+      | config_var             | @config_var['foo']          | parentheses    | .conf.erb | should not |
+      | config_var             | node[:configs][:config_var] | parentheses    | .conf.erb | should     |
+      | config_var,another_var | node[:configs][:config_var] | parentheses    | .conf.erb | should     |
+      | config_var,another_var | @config_var                 | parentheses    | .conf.erb | should     |
+      | config_var,another_var | @another_var                | parentheses    | .conf.erb | should     |
+      | config_var             | @config_var                 | parentheses    | .conf     | should not |
+      | config_var,another_var | @another_var                | parentheses    | .conf     | should     |
+      | config_var,another_var | @config_var,@another_var    | nested         | .conf     | should not |
+      | config_var,another_var | @config_var                 | nested         | .conf     | should     |
+
+  Scenario Outline: Template path is inferred
+    Given a cookbook that passes variables <variables> to an inferred template
+      And the inferred template contains the expression <expression>
+     When I check the cookbook
+     Then the unused template variables warning 034 <displayed> be displayed against the inferred template
+    Examples:
+      | variables              | expression                  | displayed  |
+      | config_var             | node[:configs][:config_var] | should     |
+      | config_var             | @config_var                 | should not |
+
+  Scenario: Template includes contain cycle
+    Given a template that includes a partial that includes the original template again
+     When I check the cookbook
+     Then the unused template variables warning 034 should not be displayed
+      And no error should have occurred

data/features/047_check_for_attribute_assignment_without_precedence.feature

@@ -0,0 +1,47 @@
+Feature: Check for attribute assignment without specified precedence
+
+  In order to ensure that my cookbooks continue to work with Chef 11+
+  As a developer
+  I want to identify node attribute assignment that does not specify the attribute precedence
+
+  Scenario Outline: Attribute assignment
+    Given a cookbook attributes file with assignment <assignment>
+     When I check the cookbook
+     Then the attribute assignment without precedence warning 047 <show_warning> be displayed against the attributes file
+  Examples:
+    | assignment                          | show_warning |
+    | node[:foo] = 'bar'                  | should       |
+    | node['foo'] = 'bar'                 | should       |
+    | node['foo'] = a_var                 | should       |
+    | a_var = node['foo']                 | should not   |
+    | node['foo']['bar'] = 'baz'          | should       |
+    | node['foo']['bar']['baz'] = 'fizz'  | should       |
+    | node.foo = 'bar'                    | should       |
+    | node.normal.foo = 'bar'             | should not   |
+    | node.normal['foo'] = 'bar'          | should not   |
+    | node.default['foo'] = 'bar'         | should not   |
+    | node.force_default['foo'] = 'bar'   | should not   |
+    | node.set['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       |
+    | node['foo']['bars'] << 'baz'        | should       |
+    | foo = node['bar']                   | should not   |
+    | baz << node['foo']['bars']          | should not   |
+    | node.run_state['foo'] = bar         | should not   |
+    | foo[:bar] << node['baz']            | should not   |
+    | node.default['foo'] << bar          | should not   |
+    | node.default_unless['foo'] = 'bar'  | should not   |
+    | node.normal_unless['foo'] = 'bar'   | should not   |
+    | node.set_unless['foo'] = 'bar'      | should not   |
+    | node.override_unless['foo'] = 'bar' | should not   |
+
+  Scenario Outline: Attribute assignment in recipe
+    Given a cookbook recipe file with assignment <assignment>
+     When I check the cookbook
+     Then the attribute assignment without precedence warning 047 <show_warning> be displayed
+  Examples:
+    | assignment                 | show_warning |
+    | node[:foo] = 'bar'         | should       |
+    | node.normal['foo'] = 'bar' | should not   |

data/features/048_check_for_shellout.feature

@@ -0,0 +1,34 @@
+Feature: Check for spawning without Mixlib::ShellOut
+
+  In order to work more easily with spawned processes
+  As a developer
+  I want to use the Mixlib::ShellOut library rather than basic ruby constructs
+
+  Scenario Outline: Spawning a sub-process
+    Given a cookbook recipe that spawns a sub-process with <command>
+     When I check the cookbook
+     Then the prefer mixlib shellout warning 048 <show_warning> be displayed
+  Examples:
+    | command                                | show_warning |
+    | `ls`                                   | should       |
+    | `#{cmd}`                               | should       |
+    | %x{ls}                                 | should       |
+    | %x[ls]                                 | should       |
+    | %x{#{cmd} some_dir}                    | should       |
+    | %x{#{cmd} some_dir}                    | should       |
+    | system "ls"                            | should       |
+    | system("ls")                           | should       |
+    | system cmd                             | should       |
+    | system(cmd)                            | should       |
+    | system("#{cmd} some_dir")              | should       |
+    | Mixlib::ShellOut.new('ls').run_command | should not   |
+
+  Scenario: Execute resource
+    Given a cookbook recipe that executes 'ls' with an execute resource
+     When I check the cookbook
+     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
+     When I check the cookbook
+     Then the prefer mixlib shellout warning 048 should not be displayed against the group resource

data/features/049_check_for_role_name_mismatch_with_file_name.feature

@@ -0,0 +1,31 @@
+Feature: Identify roles names that do not match filenames
+
+  In order to avoid confusion
+  As a developer
+  I want to identify roles whose names differ from their filename
+
+  Scenario Outline: Illustrates role paths
+    Given a directory that contains a role file <filename> in <format> that defines role name <role_name>
+     When I check the role directory as a <path_type> path
+     Then the role name does not match file name warning 049 <show_warning> be shown
+  Examples:
+    | filename       | format | role_name | path_type | show_warning |
+    | webserver.rb   | ruby   | webserver | role      | should not   |
+    | webserver.rb   | ruby   | apache    | role      | should       |
+    | webserver.json | json   | webserver | role      | should not   |
+    | webserver.json | json   | apache    | role      | should not   |
+    | webserver.rb   | ruby   | webserver | cookbook  | should not   |
+    | webserver.rb   | ruby   | apache    | cookbook  | should not   |
+    | webserver.rb   | ruby   | webserver | default   | should not   |
+    | webserver.rb   | ruby   | apache    | default   | should not   |
+
+  Scenario: Role name references variable
+    Given a directory that contains a ruby role with an expression as its name
+     When I check the role directory
+     Then the role name does not match file name warning 049 should not be shown
+
+  Scenario: Multiple role names declared
+    Given a directory that contains a ruby role that declares the role name more than once
+      And the last role name declared does not match the containing filename
+     When I check the role directory
+     Then the role name does not match file name warning 049 should be shown against the second name

data/features/050_check_for_invalid_name.feature

@@ -0,0 +1,33 @@
+Feature: Check for invalid names
+
+  In order to identify issues more quickly
+  As a developer
+  I want to identify roles or environments whose names are invalid
+
+  Scenario Outline: Role name validity
+    Given a ruby role file that defines a role with name <role_name>
+     When I check the role directory
+     Then the invalid role name warning 050 <show_warning> be shown
+  Examples:
+    | role_name    | show_warning |
+    | webserver    | should not   |
+    | web_server   | should not   |
+    | web-server   | should not   |
+    | webserver123 | should not   |
+    | Webserver    | should not   |
+    | web server   | should       |
+    | webserver%   | should       |
+
+  Scenario Outline: Environment name validity
+    Given a ruby environment file that defines an environment with name <environment_name>
+     When I check the environment directory
+     Then the invalid environment name warning 050 <show_warning> be shown
+  Examples:
+    | environment_name     | show_warning |
+    | production           | should not   |
+    | pre_production       | should not   |
+    | production-eu        | should not   |
+    | production2          | should not   |
+    | Production           | should not   |
+    | EU West              | should       |
+    | production (eu-west) | should       |

data/features/051_check_for_template_partial_loops.feature

@@ -0,0 +1,21 @@
+Feature: Check for template partial includes cycle
+
+  In order to avoid failures at converge time
+  As a developer
+  I want to identify when a template uses partials that would loop
+
+  Scenario: Template without includes
+    Given a cookbook recipe that refers to a template
+    When I check the cookbook
+    Then the template partials loop indefinitely warning 051 should not be displayed against the templates
+
+  Scenario: Template includes do not cycle
+    Given a template that includes a partial
+     When I check the cookbook
+     Then the template partials loop indefinitely warning 051 should not be displayed against the templates
+
+  Scenario: Template includes contain cycle
+    Given a template that includes a partial that includes the original template again
+     When I check the cookbook
+     Then the template partials loop indefinitely warning 051 should be displayed against the templates
+      And no error should have occurred

data/features/command_line_help.feature

@@ -14,6 +14,16 @@ Feature: Command line help
      When I run it on the command line specifying a cookbook that does not exist
      Then the simple usage text should be displayed along with a non-zero exit code
 
+  Scenario: Non-existent role directory
+    Given I have installed the lint tool
+     When I run it on the command line specifying a role directory that does not exist
+     Then the simple usage text should be displayed along with a non-zero exit code
+
+  Scenario: Non-existent environment directory
+    Given I have installed the lint tool
+     When I run it on the command line specifying an environment directory that does not exist
+     Then the simple usage text should be displayed along with a non-zero exit code
+
   Scenario: Command help
     Given I have installed the lint tool
      When I run it on the command line with the help option
@@ -41,3 +51,8 @@ Feature: Command line help
      Then the simple usage text should be displayed along with a non-zero exit code
      Then the style warning 002 should not be displayed
       And the current version should not be displayed
+
+  Scenario: Refer to the man page
+    Given access to the man page documentation
+     When I compare the man page options against the usage options
+     Then all options should be documented in the man page