foodcritic 6.3.0 → 7.0.0

data/features/009_check_for_unrecognised_resource_attributes.feature

@@ -55,23 +55,12 @@ Feature: Check for unrecognised resource attributes
      When I check the cookbook
      Then the unrecognised attribute warning 009 should not be displayed
 
-  Scenario Outline: Install package with yum specifying architecture
-    Given a recipe that installs a package with yum specifying the architecture
+  Scenario Outline: Create raid array with mdadm specifying layout
+    Given a recipe that creates a raid array with mdadm specifying layout
      When I check the cookbook specifying <version> as the Chef version
      Then the unrecognised attribute warning 009 should be <shown>
   Examples:
-    | version | shown |
-    | 0.8.14  | true  |
-    | 0.9.6   | true  |
-    | 0.9.8   | false |
-
-  Scenario Outline: Retry a resource on failure
-    Given a recipe that installs a gem with 5 retries
-     When I check the cookbook specifying <version> as the Chef version
-     Then the unrecognised attribute warning 009 should be <shown>
-  Examples:
-    | version | shown |
-    | 0.8.16  | true  |
-    | 0.9.0   | true  |
-    | 0.10.2  | true  |
-    | 0.10.4  | false |
+    | version  | shown |
+    | 11.0.0   | true  |
+    | 12.5.1   | true  |
+    | 12.11.18 | false |

data/features/032_check_for_invalid_notification_timing.feature

@@ -6,17 +6,21 @@ Feature: Check for invalid notification timings
 
   Scenario Outline: Notification timings
     Given a cookbook recipe with a resource that <type> <notification_timing>
-    When I check the cookbook
+    When I check the cookbook specifying <version> as the Chef version
     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      |
+    | type       | notification_timing | version | display     |
+    | notifies   |                     | 12.6.0  | should not  |
+    | notifies   | before              | 12.4.0  | should      |
+    | notifies   | before              | 12.6.0  | should not  |
+    | notifies   | immediately         | 12.6.0  | should not  |
+    | notifies   | immediate           | 12.6.0  | should not  |
+    | notifies   | delayed             | 12.6.0  | should not  |
+    | notifies   | imediately          | 12.6.0  | should      |
+    | subscribes |                     | 12.6.0  | should not  |
+    | subscribes | before              | 12.4.0  | should      |
+    | subscribes | before              | 12.6.0  | should not  |
+    | subscribes | immediately         | 12.6.0  | should not  |
+    | subscribes | immediate           | 12.6.0  | should not  |
+    | subscribes | delayed             | 12.6.0  | should not  |
+    | subscribes | imediately          | 12.6.0  | should      |

data/features/038_check_for_invalid_action.feature

@@ -38,14 +38,11 @@ Feature: Check for invalid resource actions
     | service  | enble, start         | should     |
     | foo      | energize, revitalize | should not |
 
-  Scenario Outline: Reconfigure a package
-    Given a recipe that reconfigures a package
+  Scenario Outline: Try to mask a systemd service
+    Given a recipe that tries to mask a systemd service
      When I check the cookbook specifying <version> as the Chef version
-     Then the invalid resource action warning 038 <display> be displayed
+     Then the invalid resource action warning 038 should be <shown>
   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 |
+    | version   | shown  |
+    | 12.8.1    | false  |
+    | 12.7.2    | true   |

data/features/043_check_for_old_notification_style.feature

@@ -25,11 +25,4 @@ Feature: Check for old notification style
      Then the prefer new notification syntax warning 043 <displayed> be displayed
   Examples:
      | version | displayed  |
-     | 0.7.6   | should not |
-     | 0.8.16  | should not |
-     | 0.9.0   | should not |
-     | 0.9.10  | should     |
-     | 0.9.18  | should     |
-     | 0.10.0  | should     |
-     | 10.24.0 | should     |
      | 11.4.0  | should     |

data/features/step_definitions/cookbook_steps.rb

@@ -239,7 +239,7 @@ Given 'a cookbook provider that declares execute resources varying only in the c
 end
 
 Given /^a cookbook recipe that attempts to perform a search with (.*)$/ do |search_type|
-  recipe_with_search(search_type.include?('subexpression') ? :with_subexpression : search_type.gsub(' ', '_').to_sym)
+  recipe_with_search(search_type.include?('subexpression') ? :with_subexpression : search_type.tr(' ', '_').to_sym)
 end
 
 Given /^a cookbook recipe that declares a resource called ([^ ]+) with the condition (.*)(in|outside) a loop$/ do |name,condition,is_loop|
@@ -1731,19 +1731,21 @@ Given 'a recipe that installs a gem with 5 retries' do
   }
 end
 
-Given 'a recipe that installs a package with yum specifying the architecture' do
+Given 'a recipe that creates a raid array with mdadm specifying layout' do
   write_recipe %q{
-    yum_package "foo" do
-      arch "x86_64"
-      action :install
+    mdadm '/dev/md0' do
+      devices [ '/dev/sda', '/dev/sdb', '/dev/sdc', '/dev/sdd' ]
+      level 5
+      layout 'left-asymmetric'
+      action [ :create, :assemble ]
     end
   }
 end
 
-Given 'a recipe that reconfigures a package' do
+Given 'a recipe that tries to mask a systemd service' do
   write_recipe %q{
-    apt_package "foo" do
-      action :reconfig
+    service 'foo' do
+       action :mask
     end
   }
 end
@@ -1834,7 +1836,7 @@ end
 When /^I check the cookbook specifying ([^ ]+) as the Chef version$/ do |version|
   options = ['-c', version, 'cookbooks/example']
   cd '.' do
-    options = ['-I', 'rules/test.rb'] + options if Dir.exists?('rules')
+    options = ['-I', 'rules/test.rb'] + options if Dir.exist?('rules')
   end
   run_lint(options)
 end
@@ -1968,7 +1970,7 @@ end
 
 When /^I run it on the command line with the (?:unimplemented |)([^ ]+) option( with an argument)?$/ do |option, with_argument|
   options = []
-  if option.match(/\-\w$/)
+  if option =~ /\-\w$/
     options << option
   else
     options << "--#{option}"
@@ -2139,7 +2141,7 @@ Then /the build status should be (successful|failed)$/ do |build_outcome|
 end
 
 Then /^the build will (succeed|fail) with (?:no )?warnings(.*)$/ do |build_outcome, warnings|
-  assert_build_result(build_outcome == 'succeed', warnings.gsub(' ', '').split(','))
+  assert_build_result(build_outcome == 'succeed', warnings.delete(' ').split(','))
 end
 
 Then 'the check for server warning 003 should not be displayed against the condition' do
@@ -2299,6 +2301,10 @@ Then /^the unrecognised attribute warning 009 should be (true|false)$/ do |shown
   shown == 'true' ? expect_warning('FC009') : expect_no_warning('FC009')
 end
 
+Then /^the invalid resource action warning 038 should be (true|false)$/ do |shown|
+  shown == 'true' ? expect_warning('FC038') : expect_no_warning('FC038')
+end
+
 Then 'the unrecognised attribute warning 009 should be displayed against the correct resource' do
   expect_warning('FC009', :line => 7)
 end

data/features/support/command_helpers.rb

@@ -299,7 +299,7 @@ module FoodCritic
           elsif show_context
             ContextOutput.new.output(review)
           else
-            "#{review.to_s}\n"
+            "#{review}\n"
           end
       end
     end

data/foodcritic.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.homepage = 'http://foodcritic.io'
   s.license = 'MIT'
   s.executables << 'foodcritic'
-  s.required_ruby_version = ">= 2.0.0"
+  s.required_ruby_version = '>= 2.1.0'
   s.add_dependency('cucumber-core', '>= 1.3')
   s.add_dependency('nokogiri', '>= 1.5', '< 2.0')
   s.add_dependency('rake')
@@ -24,5 +24,4 @@ Gem::Specification.new do |s|
   s.files += Dir['Rakefile'] + Dir['Gemfile'] + Dir["*.gemspec"]
   s.files += Dir['spec/**/*'] + Dir['features/**/*']
   s.files += Dir['*.md'] + Dir['LICENSE'] + Dir['man/*']
-  s.required_ruby_version = '>= 2.0.0'
 end

data/lib/foodcritic/api.rb

@@ -75,26 +75,54 @@ module FoodCritic
       end
     end
 
-    # The name of the cookbook containing the specified file.
-    def cookbook_name(file)
-      fail ArgumentError, 'File cannot be nil or empty' if file.to_s.empty?
-
+    # Support function to retrieve a metadata field
+    def metadata_field(file, field)
       until (file.split(File::SEPARATOR) & standard_cookbook_subdirs).empty? do
         file = File.absolute_path(File.dirname(file.to_s))
       end
       file = File.dirname(file) unless File.extname(file).empty?
-      # We now have the name of the directory that contains the cookbook.
 
-      # We also need to consult the metadata in case the cookbook name has been
-      # overridden there. This supports only string literals.
       md_path = File.join(file, 'metadata.rb')
       if File.exist?(md_path)
-        name = read_ast(md_path).xpath("//stmts_add/
-          command[ident/@value='name']/
+        value = read_ast(md_path).xpath("//stmts_add/
+          command[ident/@value='#{field}']/
           descendant::tstring_content/@value").to_s
-        return name unless name.empty?
+        raise RuntimeError, "Cant read #{field} from #{md_path}" if value.to_s.empty?
+        return value
+      else
+        raise RuntimeError, "Cant find #{md_path}"
       end
-      File.basename(file)
+    end
+
+    # The name of the cookbook containing the specified file.
+    def cookbook_name(file)
+      fail ArgumentError, 'File cannot be nil or empty' if file.to_s.empty?
+
+      # Name is a special case as we want to fallback to the cookbook directory
+      # name if metadata_field fails
+      begin
+        metadata_field(file, 'name')
+      rescue RuntimeError
+        until (file.split(File::SEPARATOR) & standard_cookbook_subdirs).empty? do
+          file = File.absolute_path(File.dirname(file.to_s))
+        end
+        file = File.dirname(file) unless File.extname(file).empty?
+        File.basename(file)
+      end
+    end
+
+    # The maintainer of the cookbook containing the specified file.
+    def cookbook_maintainer(file)
+      fail ArgumentError, 'File cannot be nil or empty' if file.to_s.empty?
+
+      metadata_field(file, 'maintainer')
+    end
+
+    # The maintainer email of the cookbook containing the specified file.
+    def cookbook_maintainer_email(file)
+      fail ArgumentError, 'File cannot be nil or empty' if file.to_s.empty?
+
+      metadata_field(file, 'maintainer_email')
     end
 
     # The dependencies declared in cookbook metadata.
@@ -469,7 +497,7 @@ module FoodCritic
     end
 
     def patched_node_method?(meth, cookbook_dir)
-      return false if cookbook_dir.nil? || !Dir.exists?(cookbook_dir)
+      return false if cookbook_dir.nil? || !Dir.exist?(cookbook_dir)
 
       # TODO: Modify this to work with multiple cookbook paths
       cbk_tree_path = Pathname.new(File.join(cookbook_dir, '..'))
@@ -478,7 +506,7 @@ module FoodCritic
       libs.any? do |lib|
         !read_ast(lib).xpath(%Q{//class[count(descendant::const[@value='Chef'])
           > 0][count(descendant::const[@value='Node']) > 0]/descendant::def/
-          ident[@value='#{meth.to_s}']}).empty?
+          ident[@value='#{meth}']}).empty?
       end
     end
 

data/lib/foodcritic/linter.rb

@@ -1,6 +1,5 @@
 require 'optparse'
 require 'ripper'
-require 'rubygems'
 require 'set'
 
 module FoodCritic
@@ -10,7 +9,7 @@ module FoodCritic
 
     # The default version that will be used to determine relevant rules. This
     # can be over-ridden at the command line with the `--chef-version` option.
-    DEFAULT_CHEF_VERSION = '12.9.38'
+    DEFAULT_CHEF_VERSION = '12.11.18'
     attr_reader :chef_version
 
     # Perform a lint check. This method is intended for use by the command-line

data/lib/foodcritic/notifications.rb

@@ -50,7 +50,7 @@ module FoodCritic
             # The target resource action.
             action: notification_action(notify),
 
-            # The notification timing. Either `:immediate` or `:delayed`.
+            # The notification timing: `:before`, `:immediate` or `:delayed`.
             timing: notification_timing(notify)
           }
         )

data/lib/foodcritic/rules.rb

@@ -196,7 +196,6 @@ end
 
 rule 'FC015', 'Consider converting definition to a Custom Resource' do
   tags %w(style definitions lwrp)
-  applies_to { |version| version >= gem_version('0.7.12') }
   cookbook do |dir|
     Dir[File.join(dir, 'definitions', '*.rb')].reject do |entry|
       ['.', '..'].include? entry
@@ -206,7 +205,6 @@ end
 
 rule 'FC016', 'LWRP does not declare a default action' do
   tags %w(correctness lwrp)
-  applies_to { |version| version >= gem_version('0.7.12') }
   resource do |ast, filename|
     unless ["//ident/@value='default_action'",
      "//def/bodystmt/descendant::assign/
@@ -218,9 +216,6 @@ end
 
 rule 'FC017', 'LWRP does not notify when updated' do
   tags %w(correctness lwrp)
-  applies_to do |version|
-    version >= gem_version('0.7.12')
-  end
   provider do |ast, filename|
 
     use_inline_resources = !ast.xpath('//*[self::vcall or self::var_ref]/ident
@@ -251,7 +246,6 @@ end
 
 rule 'FC018', 'LWRP uses deprecated notification syntax' do
   tags %w(style lwrp deprecated)
-  applies_to { |version| version >= gem_version('0.9.10') }
   provider do |ast|
     ast.xpath("//assign/var_field/ivar[@value='@updated']").map do |class_var|
       match(class_var)
@@ -297,7 +291,6 @@ end
 
 rule 'FC021', 'Resource condition in provider may not behave as expected' do
   tags %w(correctness lwrp)
-  applies_to { |version| version >= gem_version('0.10.6') }
   provider do |ast|
     find_resources(ast).map do |resource|
       condition = resource.xpath(%q{//method_add_block/
@@ -312,7 +305,6 @@ end
 
 rule 'FC022', 'Resource condition within loop may not behave as expected' do
   tags %w(correctness)
-  applies_to { |version| version >= gem_version('0.10.6') }
   recipe do |ast|
     ast.xpath("//call[ident/@value='each']/../do_block[count(ancestor::
               method_add_block/method_add_arg/fcall/ident[@value='only_if' or
@@ -391,7 +383,6 @@ end
 
 rule 'FC025', 'Prefer chef_gem to compile-time gem install' do
   tags %w(style deprecated)
-  applies_to { |version| version >= gem_version('0.10.10') }
   recipe do |ast|
     gem_install = ast.xpath("//stmts_add/assign[method_add_block[command/ident/
       @value='gem_package'][do_block/stmts_add/command[ident/@value='action']
@@ -410,7 +401,6 @@ end
 
 rule 'FC026', 'Conditional execution block attribute contains only string' do
   tags %w(correctness)
-  applies_to { |version| version >= gem_version('0.7.4') }
   recipe do |ast|
     find_resources(ast).map { |r| resource_attributes(r) }.map do |resource|
       [resource['not_if'], resource['only_if']]
@@ -482,9 +472,14 @@ end
 rule 'FC032', 'Invalid notification timing' do
   tags %w(correctness notifications)
   recipe do |ast|
+    valid_timings = if resource_attribute?('file', 'notifies_before') then
+      [:delayed, :immediate, :before]
+    else
+      [:delayed, :immediate]
+    end
     find_resources(ast).select do |resource|
       notifications(resource).any? do |notification|
-        ! [:delayed, :immediate].include? notification[:timing]
+        ! valid_timings.include? notification[:timing]
       end
     end
   end
@@ -632,7 +627,6 @@ end
 
 rule 'FC043', 'Prefer new notification syntax' do
   tags %w(style notifications deprecated)
-  applies_to { |version| version >= gem_version('0.9.10') }
   recipe do |ast|
     find_resources(ast).select do |resource|
       notifications(resource).any? { |notify| notify[:style] == :old }

data/lib/foodcritic/version.rb

@@ -1,4 +1,4 @@
 module FoodCritic
   # The current version of foodcritic
-  VERSION = '6.3.0'
+  VERSION = '7.0.0'
 end

data/man/foodcritic.1

@@ -0,0 +1,81 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "FOODCRITIC" "1" "February 2016" "" ""
+.
+.SH "NAME"
+\fBfoodcritic\fR \- lint tool for chef cookbooks
+.
+.SH "SYNOPSIS"
+\fBfoodcritic\fR [\fIoptions\fR\.\.\.] \fIcookbook\fR\.\.\.
+.
+.P
+\fBfoodcritic\fR [\fIoptions\fR\.\.\.] \-\-list
+.
+.SH "DESCRIPTION"
+\fBfoodcritic\fR makes it easier to flag problems in your Chef cookbooks that will cause Chef to blow up when you attempt to converge\. This is about faster feedback\.
+.
+.P
+Each \fBcookbook\fR path specified will be examined for common problems and poor style\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-t\fR, \fB\-\-tags\fR \fITAGS\fR
+Only check against rules with the specified tags\. Prefix tags with a tilde \fB~\fR to exclude rules\.
+.
+.TP
+\fB\-l\fR, \fB\-\-list\fR
+Do not perform a lint check; instead simply list the rules that would be enabled based on the defaults and the rule selection options (\-t, \-I)
+.
+.TP
+\fB\-f\fR, \fB\-\-epic\-fail\fR \fITAGS\fR
+Exit non\-zero if any of the specified tags are matched\. Use the pseudo\-tag \fBany\fR to fail if any tag is matched\.
+.
+.TP
+\fB\-c\fR, \fB\-\-chef\-version\fR \fIVERSION\fR
+Only check against rules valid for this version of Chef\.
+.
+.TP
+\fB\-B\fR, \fB\-\-cookbook\-path\fR
+Cookbook path(s) to check\.
+.
+.TP
+\fB\-C\fR, \fB\-\-\fR[\fBno\-\fR]\fBcontext\fR
+Show lines matched against rather than the default summary\.
+.
+.TP
+\fB\-E\fR, \fB\-\-environment\-path\fR
+Environment path(s) to check\.
+.
+.TP
+\fB\-I\fR, \fB\-\-include\fR \fIPATH\fR
+Additional rule file path(s) to load\.
+.
+.TP
+\fB\-R\fR, \fB\-\-role\-path\fR
+Role path(s) to check\.
+.
+.TP
+\fB\-S\fR, \fB\-\-search\-grammar\fR \fIPATH\fR
+Specify grammar to use when validating search syntax\. (Default: the grammar of any installed Chef)
+.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Display the foodcritic version\.
+.
+.TP
+\fB\-X\fR, \fB\-\-exclude\fR \fIPATH\fR
+Exclude path(s) from being linted\.
+.
+.SH "RETURN VALUES"
+By default, \fBfoodcritic\fR will always return \fB0\fR\.
+.
+.P
+If \fB\-\-epic\-fail\fR is specified, then \fBfoodcritic\fR will return \fB3\fR if any tags are matched\.
+.
+.SH "COPYRIGHT"
+\fBfoodcritic\fR is Copyright 2011 by Andrew Crump\.
+.
+.SH "SEE ALSO"
+chef(1)