foodcritic 2.2.0 → 3.0.0

data/lib/foodcritic/rake_task.rb

@@ -9,7 +9,7 @@ module FoodCritic
 
       def initialize(name = :foodcritic)
         @name = name
-        @files = Dir.pwd
+        @files = [Dir.pwd]
         @options = {}
         yield self if block_given?
         define
@@ -17,6 +17,7 @@ module FoodCritic
 
       def options
         {:fail_tags => ['correctness'], # differs to default cmd-line behaviour
+         :cookbook_paths => @files,
          :exclude_paths => ['test/**/*', 'spec/**/*', 'features/**/*']
         }.merge(@options)
       end
@@ -24,7 +25,7 @@ module FoodCritic
       def define
         desc "Lint Chef cookbooks"
         task(name) do
-          result = FoodCritic::Linter.new.check(files, options)
+          result = FoodCritic::Linter.new.check(options)
           if result.warnings.any?
             puts result
           end

data/lib/foodcritic/rules.rb

@@ -208,12 +208,30 @@ rule "FC017", "LWRP does not notify when updated" do
     version >= gem_version("0.7.12")
   end
   provider do |ast, filename|
-    if ast.xpath(%q{//*[self::call or self::command_call]/
-                 *[self::vcall or self::var_ref/ident/
-                 @value='new_resource']/../
-                 ident[@value='updated_by_last_action']}).empty?
-      [file_match(filename)]
+
+    use_inline_resources = ! ast.xpath('//*[self::vcall or self::var_ref]/ident
+      [@value="use_inline_resources"]').empty?
+
+    unless use_inline_resources
+      actions = ast.xpath('//method_add_block/command[ident/@value="action"]/
+        args_add_block/descendant::symbol/ident')
+
+      actions.reject do |action|
+        blk = action.xpath('ancestor::command[1]/
+          following-sibling::*[self::do_block or self::brace_block]')
+        empty = ! blk.xpath('stmts_add/void_stmt').empty?
+        converge_by = ! blk.xpath('descendant::*[self::command or self::fcall]
+          /ident[@value="converge_by"]').empty?
+
+        updated_by_last_action = ! blk.xpath('descendant::*[self::call or
+          self::command_call]/*[self::vcall or self::var_ref/ident/
+          @value="new_resource"]/../ident[@value="updated_by_last_action"]
+        ').empty?
+
+        empty || converge_by || updated_by_last_action
+      end
     end
+
   end
 end
 
@@ -240,7 +258,7 @@ rule "FC019", "Access node attributes in a consistent manner" do
     types = [:string, :symbol, :vivified].map do |type|
       {:access_type => type, :count => files.map do |file|
         attribute_access(file[:ast], :type => type, :ignore_calls => true,
-                          :cookbook_dir => cookbook_dir).tap do |ast|
+          :cookbook_dir => cookbook_dir, :ignore => 'run_state').tap do |ast|
           unless ast.empty?
             (asts[type] ||= []) << {:ast => ast, :path => file[:path]}
           end
@@ -466,17 +484,29 @@ end
 rule "FC034", "Unused template variables" do
   tags %w{correctness}
   recipe do |ast,filename|
-    Array(resource_attributes_by_type(ast)['template']).select do
-      |t| t['variables'] and t['variables'].respond_to?(:xpath)
+    Array(resource_attributes_by_type(ast)['template']).select do |t|
+      t['variables'] and t['variables'].respond_to?(:xpath)
     end.map do |resource|
-      template_path = template_paths(filename).find do |p|
-        File.basename(p) == resource['source']
+      all_templates = template_paths(filename)
+      template_path = all_templates.find do |path|
+        File.basename(path) == template_file(resource)
       end
       next unless template_path
-      passed_vars = resource['variables'].xpath('symbol/ident/@value').map{|tv| tv.to_s}
-      template_vars = read_ast(template_path).xpath('//var_ref/ivar/' +
-        '@value').map{|v| v.to_s.sub(/^@/, '')}
-      file_match(template_path) unless (passed_vars - template_vars).empty?
+      passed_vars = resource['variables'].xpath(
+        'symbol/ident/@value').map{|tv| tv.to_s}
+
+      begin
+        template_vars = templates_included(
+          all_templates, template_path).map do |template|
+            read_ast(template).xpath('//var_ref/ivar/@value').map do |v|
+              v.to_s.sub(/^@/, '')
+            end
+        end.flatten
+
+        file_match(template_path) unless (passed_vars - template_vars).empty?
+      rescue RecursedTooFarError
+        []
+      end
     end.compact
   end
 end
@@ -608,3 +638,64 @@ rule "FC046", "Attribute assignment uses assign unless nil" do
     attribute_access(ast).map{|a| a.xpath('ancestor::opassign/op[@value="||="]')}
   end
 end
+
+rule "FC047", "Attribute assignment does not specify precedence" do
+  tags %w{attributes correctness}
+  recipe do |ast|
+    attribute_access(ast).map do |att|
+      exclude_att_types = '[count(following-sibling::ident[
+        is_att_type(@value) or @value = "run_state"]) = 0]'
+      att.xpath(%Q{ancestor::assign[*[self::field | self::aref_field]
+        [descendant::*[self::vcall | self::var_ref][ident/@value="node"]
+        #{exclude_att_types}]]}, AttFilter.new) +
+        att.xpath(%Q{ancestor::binary[@value="<<"]/*[position() = 1][self::aref]
+          [descendant::*[self::vcall | self::var_ref]#{exclude_att_types}
+          /ident/@value="node"]}, AttFilter.new)
+    end
+  end
+end
+
+rule "FC048", "Prefer Mixlib::ShellOut" do
+  tags %w{style processes}
+  recipe do |ast|
+    ast.xpath('//xstring_literal | //*[self::command or self::fcall]/
+      ident[@value="system"][count(following-sibling::args_add_block/
+      descendant::kw[@value="true" or @value="false"]) = 0]')
+  end
+end
+
+rule "FC049", "Role name does not match containing file name" do
+  tags %w{style roles}
+  role do |ast, filename|
+    role_name_specified = field_value(ast, :name)
+    role_name_file = Pathname.new(filename).basename.sub_ext('').to_s
+    if role_name_specified and role_name_specified != role_name_file
+      field(ast, :name)
+    end
+  end
+end
+
+rule "FC050", "Name includes invalid characters" do
+  tags %w{correctness environments roles}
+  def invalid_name(ast)
+    field(ast, :name) unless field_value(ast, :name) =~ /^[a-zA-Z0-9_\-]+$/
+  end
+  environment{|ast| invalid_name(ast)}
+  role{|ast| invalid_name(ast)}
+end
+
+rule "FC051", "Template partials loop indefinitely" do
+  tags %w{correctness}
+  recipe do |_,filename|
+    cbk_templates = template_paths(filename)
+
+    cbk_templates.select do |template|
+      begin
+        templates_included(cbk_templates, template)
+        false
+      rescue RecursedTooFarError
+        true
+      end
+    end.map{|t| file_match(t)}
+  end
+end

data/lib/foodcritic/template.rb

@@ -13,7 +13,7 @@ module FoodCritic
       def extract(template_code)
         @expressions = []
         convert(template_code)
-        @expressions
+        expressions(template_code)
       end
 
       def add_expr(src, code, indicator)
@@ -38,6 +38,39 @@ module FoodCritic
         @expressions << {:type => :statement, :code => code.strip}
       end
 
+      private
+
+      def expressions(template_code)
+        expr_lines = expressions_with_lines(template_code)
+        expr_lines.map do |expr, line|
+          e = @expressions.find{|e| e[:code] == expr}
+          {:code => expr, :type => e[:type], :line => line} if e
+        end.compact
+      end
+
+      def expressions_with_lines(template_code)
+        lines = lines_with_offsets(template_code)
+        expression_offsets(template_code).map do |expr_offset, code|
+          [code, lines.find {|line, offset| offset >= expr_offset}.first]
+        end
+      end
+
+      def expression_offsets(template_code)
+        expr_offsets = []
+        template_code.scan(DEFAULT_REGEXP) do |m|
+          expr_offsets << [Regexp.last_match.offset(0).first, m[1].strip]
+        end
+        expr_offsets
+      end
+
+      def lines_with_offsets(template_code)
+        line_offsets = []
+        template_code.scan(/$/) do |m|
+          line_offsets << Regexp.last_match.offset(0).first
+        end
+        line_offsets.each_with_index.map{| pos, ln| [ln +1, pos]}
+      end
+
     end
 
   end

data/lib/foodcritic/version.rb

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

data/man/foodcritic.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "FOODCRITIC" "1" "July 2013" "" ""
+.TH "FOODCRITIC" "1" "August 2013" "" ""
 .
 .SH "NAME"
 \fBfoodcritic\fR \- lint tool for chef cookbooks
@@ -30,14 +30,26 @@ Exit non\-zero if any of the specified tags are matched\. Use the pseudo\-tag \f
 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)
 .

data/man/foodcritic.1.ronn

@@ -28,12 +28,21 @@ poor style.
  * `-c`, `--chef-version` <VERSION>:
    Only check against rules valid for this version of Chef.
 
+ * `-B`, `--cookbook-path`:
+   Cookbook path(s) to check.
+
  * `-C`, `--`[`no-`]`context`:
    Show lines matched against rather than the default summary.
 
+ * `-E`, `--environment-path`:
+   Environment path(s) to check.
+
  * `-I`, `--include` <PATH>:
    Additional rule file path(s) to load.
 
+ * `-R`, `--role-path`:
+   Role path(s) to check.
+
  * `-S`, `--search-grammar` <PATH>:
    Specify grammar to use when validating search syntax.
    (Default: the grammar of any installed Chef)

data/spec/foodcritic/api_spec.rb

@@ -21,6 +21,8 @@ describe FoodCritic::Api do
         :chef_solo_search_supported?,
         :cookbook_name,
         :declared_dependencies,
+        :field,
+        :field_value,
         :file_match,
         :find_resources,
         :gem_version,
@@ -40,9 +42,10 @@ describe FoodCritic::Api do
         :ruby_code?,
         :searches,
         :standard_cookbook_subdirs,
-	:supported_platforms,
+        :supported_platforms,
         :template_file,
         :template_paths,
+        :templates_included,
         :valid_query?
       ])
     end
@@ -87,6 +90,51 @@ describe FoodCritic::Api do
       ast = parse_ast(%q{baz = search(:node, "name:#{node['foo']['bar']}")[0]})
       api.attribute_access(ast, :type => :symbol).must_be_empty
     end
+    describe :ignoring_attributes do
+      it "doesn't ignore run_state by default for backwards compatibility" do
+        ast = parse_ast("node.run_state['bar'] = 'baz'")
+        api.attribute_access(ast).wont_be_empty
+      end
+      it "allows run_state to be ignored" do
+        ast = parse_ast("node.run_state['bar'] = 'baz'")
+        api.attribute_access(ast, :ignore => ['run_state']).must_be_empty
+      end
+      it "allows run_state to be ignored (symbols access)" do
+        ast = parse_ast("node.run_state[:bar] = 'baz'")
+        api.attribute_access(ast, :ignore => ['run_state']).must_be_empty
+      end
+      it "allows any attribute to be ignored" do
+        ast = parse_ast("node['bar'] = 'baz'")
+        api.attribute_access(ast, :ignore => ['bar']).must_be_empty
+      end
+      it "allows any attribute to be ignored (symbols access)" do
+        ast = parse_ast("node[:bar] = 'baz'")
+        api.attribute_access(ast, :ignore => ['bar']).must_be_empty
+      end
+      it "allows any attribute to be ignored (dot access)" do
+        ast = parse_ast("node.bar = 'baz'")
+        api.attribute_access(ast, :ignore => ['bar']).must_be_empty
+      end
+      it "includes the children of attributes" do
+        ast = parse_ast("node['foo']['bar'] = 'baz'")
+        api.attribute_access(ast).map{|a| a['value']}.must_equal(%w{foo bar})
+      end
+      it "does not include children of removed attributes" do
+        ast = parse_ast("node['foo']['bar'] = 'baz'")
+        api.attribute_access(ast, :ignore => ['foo']).must_be_empty
+      end
+      it "coerces ignore values to enumerate them" do
+        ast = parse_ast("node.run_state['bar'] = 'baz'")
+        api.attribute_access(ast, :ignore => 'run_state').must_be_empty
+      end
+      it "can ignore multiple attributes" do
+        ast = parse_ast(%q{
+          node['bar'] = 'baz'
+          node.foo = 'baz'
+        })
+        api.attribute_access(ast, :ignore => %w{foo bar}).must_be_empty
+      end
+    end
   end
 
   describe "#checks_for_chef_solo?" do
@@ -184,6 +232,86 @@ describe FoodCritic::Api do
     end
   end
 
+  describe "#field" do
+    describe :simple_ast do
+      let(:ast){ parse_ast('name "webserver"') }
+      it "raises if the field name is nil" do
+        lambda{api.field(ast, nil)}.must_raise ArgumentError
+      end
+      it "raises if the field name is empty" do
+        lambda{api.field(ast, '')}.must_raise ArgumentError
+      end
+      it "returns empty if the field is not present" do
+        api.field(ast, :common_name).must_be_empty
+      end
+      it "accepts a string for the field name" do
+        api.field(ast, 'name').wont_be_empty
+      end
+      it "accepts a symbol for the field name" do
+        api.field(ast, :name).wont_be_empty
+      end
+    end
+    it "returns fields when the value is an embedded string expression" do
+      ast = parse_ast(%q{
+        name "#{foo}_#{bar}"
+      }.strip)
+      api.field(ast, :name).size.must_equal 1
+    end
+    it "returns fields when the value is a method call" do
+      ast = parse_ast(%q{
+        name generate_name
+      }.strip)
+      api.field(ast, :name).size.must_equal 1
+    end
+    it "returns both fields if the field is specified twice" do
+      ast = parse_ast(%q{
+        name "webserver"
+        name "database"
+      }.strip)
+      api.field(ast, :name).size.must_equal 2
+    end
+  end
+
+  describe "#field_value" do
+    describe :simple_ast do
+      let(:ast){ parse_ast('name "webserver"') }
+      it "raises if the field name is nil" do
+        lambda{api.field_value(ast, nil)}.must_raise ArgumentError
+      end
+      it "raises if the field name is empty" do
+        lambda{api.field_value(ast, '')}.must_raise ArgumentError
+      end
+      it "is falsy if the field is not present" do
+        refute api.field_value(ast, :common_name)
+      end
+      it "accepts a string for the field name" do
+        api.field_value(ast, 'name').must_equal 'webserver'
+      end
+      it "accepts a symbol for the field name" do
+        api.field_value(ast, :name).must_equal 'webserver'
+      end
+    end
+    it "is falsy when the value is an embedded string expression" do
+      ast = parse_ast(%q{
+        name "#{foo}_#{bar}"
+      }.strip)
+      refute api.field_value(ast, :name)
+    end
+    it "is falsy when the value is a method call" do
+      ast = parse_ast(%q{
+        name generate_name('foo')
+      }.strip)
+      refute api.field_value(ast, :name)
+    end
+    it "returns the last value if the field is specified twice" do
+      ast = parse_ast(%q{
+        name "webserver"
+        name "database"
+      }.strip)
+      api.field_value(ast, :name).must_equal 'database'
+    end
+  end
+
   describe "#file_match" do
     it "includes the provided filename in the match" do
       api.file_match("foo.rb")[:filename].must_equal "foo.rb"
@@ -1612,4 +1740,85 @@ describe FoodCritic::Api do
     end
   end
 
+  describe "#templates_included" do
+
+    def all_templates
+      [
+        'templates/default/main.erb',
+        'templates/default/included_1.erb',
+        'templates/default/included_2.erb'
+      ]
+    end
+
+    def template_ast(content)
+      parse_ast(FoodCritic::Template::ExpressionExtractor.new.extract(
+        content).map{|e| e[:code]}.join(';'))
+    end
+
+    it "returns the path of the containing template when there are no partials" do
+      ast = parse_ast('<%= foo.erb %>')
+      api.stub :read_ast, ast do
+        api.templates_included(['foo.erb'], 'foo.erb').must_equal ['foo.erb']
+      end
+    end
+
+    it "returns the path of the containing template and any partials" do
+      api.instance_variable_set(:@asts, {
+        :main =>  template_ast('<%= render "included_1.erb" %>
+                                <%= render "included_2.erb" %>'),
+        :ok => template_ast('<%= @foo %>')
+      })
+      def api.read_ast(path)
+        case path
+          when /main/ then @asts[:main]
+          else @asts[:ok]
+        end
+      end
+      api.templates_included(all_templates,
+        'templates/default/main.erb').must_equal(
+          ['templates/default/main.erb',
+           'templates/default/included_1.erb',
+           'templates/default/included_2.erb']
+      )
+    end
+
+    it "doesn't mistake render options for partial template names" do
+      api.instance_variable_set(:@asts, {
+        :main =>  template_ast('<%= render "included_1.erb",
+                               :variables => {:foo => "included_2.erb"} %>'),
+        :ok => template_ast('<%= @foo %>')
+      })
+      def api.read_ast(path)
+        case path
+          when /main/ then @asts[:main]
+          else @asts[:ok]
+        end
+      end
+      api.templates_included(all_templates,
+        'templates/default/main.erb').must_equal(
+          ['templates/default/main.erb', 'templates/default/included_1.erb']
+      )
+    end
+
+    it "raises if included partials have cycles" do
+      api.instance_variable_set(:@asts, {
+        :main =>  template_ast('<%= render "included_1.erb" %>
+                                <%= render "included_2.erb" %>'),
+        :loop => template_ast('<%= render "main.erb" %>'),
+        :ok => template_ast('<%= foo %>')
+      })
+      def api.read_ast(path)
+        case path
+          when /main/ then @asts[:main]
+          when /included_2/ then @asts[:loop]
+          else @asts[:ok]
+        end
+      end
+      err = lambda do
+        api.templates_included(all_templates, 'templates/default/main.erb')
+      end.must_raise(FoodCritic::Api::RecursedTooFarError)
+      err.message.must_equal 'templates/default/main.erb'
+    end
+  end
+
 end