foodcritic 2.1.0 → 2.2.0

data/features/025_check_for_deprecated_gem_install.feature

@@ -0,0 +1,30 @@
+Feature: Check for deprecated gem install
+
+  In order to be clear and concise in my Chef recipes
+  As a developer
+  I want to use chef_gem in preference to manual compile-time gem install
+
+  Scenario: Normal gem install
+    Given a cookbook recipe that installs a gem
+     When I check the cookbook specifying 0.10.10 as the Chef version
+     Then the prefer chef_gem to manual install warning 025 should not be displayed
+
+  Scenario: Compile-time gem install
+    Given a cookbook recipe that installs a gem at compile time using the deprecated syntax
+     When I check the cookbook specifying 0.10.10 as the Chef version
+     Then the prefer chef_gem to manual install warning 025 should be shown
+
+  Scenario: Compile-time gem upgrade
+    Given a cookbook recipe that upgrades a gem at compile time using the deprecated syntax
+     When I check the cookbook specifying 0.10.10 as the Chef version
+     Then the prefer chef_gem to manual install warning 025 should be shown
+
+  Scenario: Compile-time gem install - multiple from array
+    Given a cookbook recipe that installs multiple gems from an array at compile time using the deprecated syntax
+     When I check the cookbook specifying 0.10.10 as the Chef version
+     Then the prefer chef_gem to manual install warning 025 should be shown
+
+  Scenario: Compile-time gem install - multiple from wordlist
+    Given a cookbook recipe that installs multiple gems from a word list at compile time using the deprecated syntax
+     When I check the cookbook specifying 0.10.10 as the Chef version
+     Then the prefer chef_gem to manual install warning 025 should be shown

data/features/026_check_for_conditional_block_string.feature

@@ -0,0 +1,20 @@
+Feature: Check for conditional attribute blocks with only strings
+
+  In order to avoid wrongly actioning a resource
+  As a developer
+  I want to identify conditional attribute blocks that consist only of strings
+
+  Scenario Outline:
+    Given a cookbook recipe that declares a resource with a <conditional_attribute>
+    When I check the cookbook
+    Then the conditional block contains only string warning 026 should be <show_warning>
+
+  Examples:
+    | conditional_attribute                   | show_warning |
+    | not_if { "ls foo" }                     | shown        |
+    | not_if do "ls foo" end                  | shown        |
+    | only_if { "ls #{node['foo']['path']}" } | shown        |
+    | not_if { "ls #{foo.method()}" }         | shown        |
+    | only_if { foo.bar }                     | not shown    |
+    | not_if { foo.to_s }                     | not shown    |
+    | not_if { File.exists?("/etc/foo") }     | not shown    |

data/features/027_check_for_internal_attribute_use.feature

@@ -0,0 +1,22 @@
+Feature: Check for use of internal attributes
+
+  In order to avoid confusion about the expected state of a converged node
+  As a developer
+  I want to identify calls to 'internal' resource attributes
+
+  Scenario Outline: Access of internal attributes
+    Given a cookbook recipe that declares a <resource> resource with the <attribute> attribute set to <value>
+    When I check the cookbook
+    Then the resource sets internal attribute warning 027 should be <show_warning>
+
+  Examples:
+    | resource | attribute    | value              | show_warning |
+    | service  | enabled      | true               | shown        |
+    | service  | enabled      | false              | shown        |
+    | service  | enabled      | [].include?('foo') | shown        |
+    | service  | running      | true               | shown        |
+    | service  | running      | false              | shown        |
+    | service  | running      | [].include?('foo') | shown        |
+    | service  | service_name | "foo"              | not shown    |
+    | my_lwrp  | enabled      | true               | not shown    |
+    | my_lwrp  | running      | true               | not shown    |

data/features/028_check_for_incorrect_platform_method.feature

@@ -0,0 +1,20 @@
+Feature: Check for incorrect platform method usage
+
+  In order to avoid running code intended for another platform
+  As a developer
+  I want to identify conditionals that wrongly use node.platform?
+
+  Scenario Outline: Platform conditionals
+    Given a cookbook recipe that wraps a platform-specific resource in a <conditional> conditional
+    When I check the cookbook
+    Then the incorrect platform usage warning 028 should be <show_warning>
+
+  Examples:
+    | conditional                         | show_warning |
+    | platform? 'linux'                   | not shown    |
+    | platform?('linux')                  | not shown    |
+    | platform?('linux', 'mac_os_x')      | not shown    |
+    | node.platform? 'linux'              | shown        |
+    | node.platform?('linux')             | shown        |
+    | node.platform?('linux', 'mac_os_x') | shown        |
+    | node.platform == 'linux'            | not shown    |

data/features/029_check_for_no_leading_cookbook_name.feature

@@ -0,0 +1,18 @@
+Feature: Check for no leading cookbook name
+
+  In order to ensure cookbook recipes are correctly listed
+  As a developer
+  I want to identify recipes defined in metadata that do not include the leading cookbook name
+
+  Scenario Outline: Recipe declaration in metadata
+    Given a cookbook with metadata that declares a recipe with <declaration>
+    When I check the cookbook
+    Then the no leading cookbook name warning 029 should be <show_warning>
+
+  Examples:
+    | declaration                                     | show_warning |
+    | recipe "example", "Installs Example"            | not shown    |
+    | recipe "example::default", "Installs Example"   | not shown    |
+    | recipe "default", "Installs Example"            | shown        |
+    | recipe my_var, "Installs Example"               | not shown    |
+    | recipe "#{my_var}::default", "Installs Example" | not shown    |

data/features/030_check_for_debugger_breakpoints.feature

@@ -0,0 +1,25 @@
+Feature: Check for debugger breakpoints
+
+  In order to avoid halting a converge
+  As a developer
+  I want to identify debugger breakpoints that have not been removed
+
+  Scenario Outline: Debugger breakpoints
+    Given a cookbook with a <component> that <includes> a breakpoint
+    When I check the cookbook
+    Then the debugger breakpoint warning 030 should be <show_warning> against the <component>
+
+  Examples:
+    | component | includes         | show_warning |
+    | library   | does not include | not shown    |
+    | library   | includes         | shown        |
+    | metadata  | does not include | not shown    |
+    | metadata  | includes         | shown        |
+    | provider  | does not include | not shown    |
+    | provider  | includes         | shown        |
+    | recipe    | does not include | not shown    |
+    | recipe    | includes         | shown        |
+    | resource  | does not include | not shown    |
+    | resource  | includes         | shown        |
+    | template  | does not include | not shown    |
+    | template  | includes         | shown        |

data/features/031_check_for_metadata_existence.feature

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

data/features/032_check_for_invalid_notification_timing.feature

@@ -0,0 +1,22 @@
+Feature: Check for invalid notification timings
+
+  In order to flag invalid notifications more quickly
+  As a developer
+  I want to identify notifications that have an invalid timing type
+
+  Scenario Outline: Notification timings
+    Given a cookbook recipe with a resource that <type> <notification_timing>
+    When I check the cookbook
+    Then the invalid notification timing warning 032 <display> be displayed
+  Examples:
+    | type       | notification_timing | display     |
+    | notifies   |                     | should not  |
+    | notifies   | immediately         | should not  |
+    | notifies   | immediate           | should not  |
+    | notifies   | delayed             | should not  |
+    | notifies   | imediately          | should      |
+    | subscribes |                     | should not  |
+    | subscribes | immediately         | should not  |
+    | subscribes | immediate           | should not  |
+    | subscribes | delayed             | should not  |
+    | subscribes | imediately          | should      |

data/features/033_check_for_missing_template.feature

@@ -0,0 +1,75 @@
+Feature: Check for missing template
+
+  In order to ensure the Chef run is successful
+  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: Template within deploy resource
+    Given a cookbook recipe with a deploy resource that contains a template resource
+     When I check the cookbook
+     Then the missing template warning 033 should not be displayed against the template

data/features/034_check_for_unused_template_variables.feature

@@ -0,0 +1,37 @@
+Feature: Check for unused template variables
+
+  In order to identify failure to parameterise template variables
+  As a developer
+  I want to identify variables passed to templates that are not used
+
+  Scenario: All variables present in template
+    Given a cookbook template that uses all variables passed
+     When I check the cookbook
+     Then the unused template variables warning 034 should not be displayed
+
+  Scenario Outline: No variables passed
+    Given a cookbook that passes no variables to a template
+      And the template contains the expression <expression>
+     When I check the cookbook
+     Then the unused template variables warning 034 should not be displayed against the template
+    Examples:
+      | expression                  |
+      | node[:configs][:config_var] |
+      | @config_var                 |
+
+  Scenario Outline: Variables passed
+    Given a cookbook that passes variables <variables> to a template with extension <extension>
+      And the template <extension> contains 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                  | extension | displayed  |
+      | config_var             | node[:configs][:config_var] | .conf.erb | should     |
+      | config_var             | @config_var                 | .conf.erb | should not |
+      | config_var             | @config_var['foo']          | .conf.erb | should not |
+      | config_var             | node[:configs][:config_var] | .conf.erb | should     |
+      | config_var,another_var | node[:configs][:config_var] | .conf.erb | should     |
+      | config_var,another_var | @config_var                 | .conf.erb | should     |
+      | config_var,another_var | @another_var                | .conf.erb | should     |
+      | config_var             | @config_var                 | .conf     | should not |
+      | config_var,another_var | @another_var                | .conf     | should     |

data/features/037_check_for_invalid_notification_action.feature

@@ -0,0 +1,34 @@
+Feature: Check for invalid notification actions
+
+  In order to flag invalid notifications more quickly
+  As a developer
+  I want to identify notifications that have an action which is invalid for the notified resource
+
+  Scenario Outline: Notification actions
+    Given a cookbook recipe with a resource that notifies a <resource> to <action>
+    When I check the cookbook
+    Then the invalid notification action warning 037 <display> be displayed
+  Examples:
+    | resource | action  | display    |
+    | service  | restart | should not |
+    | service  | nothing | should not |
+    | service  | create  | should     |
+    | execute  | run     | should not |
+    | execute  | execute | should     |
+
+  Scenario Outline: Subscription actions
+    Given a cookbook recipe with a <source> resource that subscribes to <action> when notified by a remote_file
+    When I check the cookbook
+    Then the invalid notification action warning 037 <display> be displayed
+  Examples:
+    | source   | action  | display    |
+    | service  | restart | should not |
+    | service  | nothing | should not |
+    | service  | create  | should     |
+    | execute  | run     | should not |
+    | execute  | execute | should     |
+
+  Scenario: Notification action is an expression
+    Given a cookbook recipe with a resource that notifies where the action is an expression
+     When I check the cookbook
+     Then the invalid notification action warning 037 should not be displayed

data/features/038_check_for_invalid_action.feature

@@ -0,0 +1,51 @@
+Feature: Check for invalid resource actions
+
+  In order to avoid failure at converge time
+  As a developer
+  I want to identify resources that have an invalid action
+
+  Scenario: Resource with default action
+    Given a cookbook recipe with a service resource that does not specify an action
+    When I check the cookbook
+    Then the invalid resource action warning 038 should not be displayed
+
+  Scenario: Resource with variable action
+    Given a cookbook recipe with a service resource with an action specified via a variable
+    When I check the cookbook
+    Then the invalid resource action warning 038 should not be displayed
+
+  Scenario Outline: Resource actions
+    Given a cookbook recipe with a <resource> resource with action <action>
+    When I check the cookbook
+    Then the invalid resource action warning 038 <display> be displayed
+  Examples:
+    | resource | action  | display    |
+    | service  | restart | should not |
+    | service  | nothing | should not |
+    | service  | none    | should     |
+    | service  | create  | should     |
+    | execute  | run     | should not |
+    | execute  | go      | should     |
+    | foo      | none    | should not |
+
+  Scenario Outline: Multiple actions
+    Given a cookbook recipe with a <resource> resource with actions <actions>
+    When I check the cookbook
+    Then the invalid resource action warning 038 <display> be displayed
+  Examples:
+    | resource | actions              | display    |
+    | service  | enable, start        | should not |
+    | service  | enble, start         | should     |
+    | foo      | energize, revitalize | should not |
+
+  Scenario Outline: Reconfigure a package
+    Given a recipe that reconfigures a package
+     When I check the cookbook specifying <version> as the Chef version
+     Then the invalid resource action warning 038 <display> be displayed
+  Examples:
+    | version      | display    |
+    | 0.9.2        | should     |
+    | 0.10.0       | should     |
+    | 0.10.6.beta3 | should not |
+    | 0.10.6       | should not |
+    | 11.4.0       | should not |

data/features/039_check_for_key_access_to_node_methods.feature

@@ -0,0 +1,33 @@
+Feature: Check for key access to node methods
+
+  In order to avoid failure at converge time
+  As a developer
+  I want to identify attempts to access node methods as attributes
+
+  Scenario Outline: Resource actions
+    Given a cookbook recipe that refers to <node_access>
+    When I check the cookbook
+    Then the node method cannot be accessed with key warning 039 <display> be displayed
+  Examples:
+    | node_access              | display    |
+    | node['foo']              | should not |
+    | node[:foo]               | should not |
+    | node.foo                 | should not |
+    | node.chef_environment    | should not |
+    | node[:chef_environment]  | should     |
+    | node['chef_environment'] | should     |
+    | node.run_state['foo']    | should not |
+    | node.run_state[:foo]     | should not |
+    | node.run_state.foo       | should not |
+    | node['run_state']['foo'] | should     |
+    | node[:run_state][:foo]   | should     |
+    | node['foo']['run_state'] | should not |
+    | node[:foo][:run_state]   | should not |
+    | node['tags']             | should not |
+    | node[:tags]              | should not |
+    | node.tags                | should not |
+
+  Scenario: Expressions that look like node access
+    Given a cookbook recipe that has a confusingly named local variable "default"
+    When I check the cookbook
+    Then the node method cannot be accessed with key warning 039 should not be displayed

data/features/040_check_raw_git_usage.feature

@@ -0,0 +1,37 @@
+Feature: Check for direct usage of git
+
+  In order to access source control repositories idiomatically
+  As a developer
+  I want to use resources for repository access rather than executing git directly
+
+  Scenario Outline: Execute resource
+    Given a cookbook recipe with an execute resource named <name>
+    When I check the cookbook
+    Then the execute resource used to run git commands warning 040 <display> be displayed
+  Examples:
+    | name                   | display    |
+    | git pull               | should     |
+    | git clone              | should     |
+    | git fetch              | should     |
+    | git checkout           | should     |
+    | git reset --hard       | should     |
+    | git show               | should not |
+    | echo 'bob' && git show | should not |
+    | which foo              | 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 git commands warning 040 <display> be displayed
+  Examples:
+    | command                                             | display    |
+    | git clone https://github.com/git/git.git            | should     |
+    | git clone --depth 10 https://github.com/git/git.git | should     |
+    | git pull                                            | should     |
+    | git fetch origin                                    | should     |
+    | git checkout master                                 | should     |
+    | git reset --hard                                    | should     |
+    | git show                                            | should not |
+    | echo 'bob' && git show                              | should not |
+    | gitk                                                | should not |
+    | curl http://github.com/                             | should not |