foodcritic 0.2.0 → 0.3.0

data/lib/foodcritic/helpers.rb

@@ -1,89 +1,91 @@
+require 'nokogiri'
+require 'xmlsimple'
+
 module FoodCritic
 
   # Helper methods that form part of the Rules DSL.
   module Helpers
 
-    # Given an AST type and parsed tree, return the matching subset.
+    # Create a match from the specified node.
     #
-    # @param [Symbol] type The type of AST node to look for
-    # @param [Array] node The parsed AST (or part there-of)
-    # @return [Array] Matching nodes
-    def ast(type, node)
-      result = []
-      result = [node] if node.first == type
-      node.each { |n| result += ast(type, n) if n.respond_to?(:each) }
-      result
+    # @param [Nokogiri::XML::Node] node The node to create a match for
+    # @return [Hash] Hash with the matched node name and position with the recipe
+    def match(node)
+      pos = node.xpath('descendant::pos').first
+      {:matched => node.name, :line => pos['line'], :column => pos['column']}
     end
 
     # Does the specified recipe check for Chef Solo?
     #
-    # @param [Array] ast The AST of the cookbook recipe to check.
+    # @param [Nokogiri::XML::Node] ast The AST of the cookbook recipe to check.
     # @return [Boolean] True if there is a test for Chef::Config[:solo] in the recipe
     def checks_for_chef_solo?(ast)
-      arefs = ast(:aref, ast)
-      arefs.any? do |aref|
-        ast(:@const, aref).map { |const| const[1] } == ['Chef', 'Config'] and
-            ast(:@ident, ast(:symbol, aref)).map { |sym| sym.drop(1).first }.include? 'solo'
-      end
+      ! ast.xpath(%q{//if/aref[count(descendant::const[@value = 'Chef' or @value = 'Config']) = 2 and
+          count(descendant::ident[@value='solo']) > 0]}).empty?
+    end
+
+    # Searches performed by the specified recipe.
+    #
+    # @param [Nokogiri::XML::Node] ast The AST of the cookbook recipe to check.
+    # @return [Boolean] True if the recipe performs a search
+    def searches(ast)
+      ast.xpath("//fcall/ident[@value = 'search']")
     end
 
     # Find Chef resources of the specified type.
     # TODO: Include blockless resources
     #
-    # @param [Array] ast The AST of the cookbook recipe to check
+    # @param [Nokogiri::XML::Node] ast The AST of the cookbook recipe to check
     # @param [String] type The type of resource to look for (or nil for all resources)
     def find_resources(ast, type = nil)
-      ast(:method_add_block, ast).find_all do |resource|
-        resource[1][0] == :command and resource[1][1][0] == :@ident and (type.nil? || resource[1][1][1] == type)
-      end
+      ast.xpath(%Q{//method_add_block[command/ident#{type.nil? ? '' : "[@value='#{type}']"}]})
     end
 
     # Return the type, e.g. 'package' for a given resource
     #
-    # @param [Array] resource The resource AST
+    # @param [Nokogiri::XML::Node] resource The resource AST
     # @return [String] The type of resource
     def resource_type(resource)
-      resource[1][1][1]
+      resource.xpath('string(command/ident/@value)')
     end
 
     # Retrieve the name attribute associated with the specified resource.
     #
-    # @param [Array] resource The resource AST to lookup the name attribute under
+    # @param [Nokogiri::XML::Node] resource The resource AST to lookup the name attribute under
     def resource_name(resource)
-      ast(:@tstring_content, resource[1]).flatten[1]
+      resource.xpath('string(command//tstring_content/@value)')
     end
 
     # Retrieve a single-valued attribute from the specified resource.
     #
     # @param [String] name The attribute name
-    # @param [Array] resource The resource AST to lookup the attribute under
+    # @param [Nokogiri::XML::Node] resource The resource AST to lookup the attribute under
     # @return [String] The attribute value for the specified attribute
     def resource_attribute(name, resource)
-      cmd = ast(:command, ast(:do_block, resource))
-      atts = cmd.find_all { |att| ast(:@ident, att).flatten.drop(1).first == name }
-      value = ast(:@tstring_content, atts).flatten.drop(1)
-      unless value.empty?
-        return value.first
-      end
-      nil
+      resource_attributes(resource)[name]
     end
 
     # Retrieve all attributes from the specified resource.
     #
-    # @param [Array] resource The resource AST
+    # @param [Nokogiri::XML::Node] resource The resource AST
     # @return [Hash] The resource attributes
     def resource_attributes(resource)
       atts = {:name => resource_name(resource)}
-      ast(:command, ast(:do_block, resource)).find_all{|cmd| cmd.first == :command}.each do |cmd|
-        atts[cmd[1][1]] = ast(:@tstring_content, cmd[2]).flatten[1] || ast(:@ident, cmd[2]).flatten[1]
+      resource.xpath('do_block/descendant::command').each do |att|
+        if att.xpath('descendant::symbol').empty?
+          att_value = att.xpath('string(descendant::tstring_content/@value)')
+        else
+          att_value = att.xpath('string(descendant::symbol/ident/@value)').to_sym
+        end
+        atts[att.xpath('string(ident/@value)')] = att_value
       end
       atts
     end
 
     # Retrieve all resources of a given type
     #
-    # @param [Array] ast The recipe AST
-    # @return [Array] The matching resources
+    # @param [Nokogiri::XML::Node] ast The recipe AST
+    # @return [Hash] The matching resources
     def resources_by_type(ast)
       result = Hash.new{|hash, key| hash[key] = Array.new}
       find_resources(ast).each{|resource| result[resource_type(resource)] << resource}
@@ -92,7 +94,7 @@ module FoodCritic
 
     # Retrieve the attributes as a hash for all resources of a given type.
     #
-    # @param [Array] ast The recipe AST
+    # @param [Nokogiri::XML::Node] ast The recipe AST
     # @return [Hash] An array of resource attributes keyed by type.
     def resource_attributes_by_type(ast)
       result = {}
@@ -101,6 +103,77 @@ module FoodCritic
       end
       result
     end
+
+    # Retrieve the recipes that are included within the given recipe AST.
+    #
+    # @param [Nokogiri::XML::Node] ast The recipe AST
+    # @return [Hash] include_recipe nodes keyed by included recipe name
+    def included_recipes(ast)
+      # we only support literal strings, ignoring sub-expressions
+      included = ast.xpath(%q{//command[ident/@value = 'include_recipe' and count(descendant::string_embexpr) = 0]/
+        descendant::tstring_content})
+      Hash[included.map{|recipe|recipe['value']}.zip(included)]
+    end
+
+    # The name of the cookbook containing the specified file.
+    #
+    # @param [String] file The file in the cookbook
+    # @return [String] The name of the containing cookbook
+    def cookbook_name(file)
+      File.basename(File.absolute_path(File.join(File.dirname(file), '..')))
+    end
+
+    # The dependencies declared in cookbook metadata.
+    #
+    # @param [Nokogiri::XML::Node] ast The metadata rb AST
+    # @return [Array] List of cookbooks depended on
+    def declared_dependencies(ast)
+      deps = ast.xpath("//command[ident/@value='depends']/descendant::args_add/descendant::tstring_content")
+      # handle quoted word arrays
+      var_ref = ast.xpath("//command[ident/@value='depends']/descendant::var_ref/ident")
+      deps += ast.xpath(%Q{//block_var/params/ident#{var_ref.first['value']}/ancestor::method_add_block/
+          call/descendant::tstring_content}) unless var_ref.empty?
+      deps.map{|dep| dep['value']}
+    end
+
+    # If the provided node is the line / column information.
+    #
+    # @param [Nokogiri::XML::Node] node A node within the AST
+    # @return [Boolean] True if this node holds the position data
+    def position_node?(node)
+      node.respond_to?(:length) and node.length == 2 and node.respond_to?(:all?) and node.all?{|child| child.respond_to?(:to_i)}
+    end
+
+    # Recurse the nested arrays provided by Ripper to create an intermediate Hash for ease of searching.
+    #
+    # @param [Nokogiri::XML::Node] node The AST
+    # @return [Hash] The friendlier Hash.
+    def ast_to_hash(node)
+      result = {}
+      if node.respond_to?(:each)
+        node.drop(1).each do |child|
+          if position_node?(child)
+            result[:pos] = {:line => child.first, :column => child[1]}
+          else
+            if child.respond_to?(:first)
+              result[child.first.to_s.gsub(/[^a-z_]/, '')] = ast_to_hash(child)
+            else
+              result[:value] = child  unless child.nil?
+            end
+          end
+        end
+      end
+      result
+    end
+
+    # Read the AST for the given Ruby file
+    #
+    # @param [String] file The file to read
+    # @return [Nokogiri::XML::Node] The recipe AST
+    def read_file(file)
+      Nokogiri::XML(XmlSimple.xml_out(ast_to_hash(Ripper::SexpBuilder.new(IO.read(file)).parse)))
+    end
+
   end
 
 end

data/lib/foodcritic/linter.rb

@@ -5,6 +5,8 @@ module FoodCritic
   # The main entry point for linting your Chef cookbooks.
   class Linter
 
+    include FoodCritic::Helpers
+
     # Create a new Linter, loading any defined rules.
     def initialize
       load_rules
@@ -17,11 +19,10 @@ module FoodCritic
     def check(cookbook_path)
       warnings = []
       files_to_process(cookbook_path).each do |file|
-        ast = Ripper::SexpBuilder.new(IO.read(file)).parse
+        ast = read_file(file)
         @rules.each do |rule|
-          rule.recipe.yield(ast).each do |match|
-            warnings << Warning.new(rule, match.merge({:filename => file}))
-          end
+          matches = rule.recipe.yield(ast, File.expand_path(file))
+          matches.each{|match| warnings << Warning.new(rule, match.merge({:filename => file}))} unless matches.nil?
         end
       end
       Review.new(warnings)

data/lib/foodcritic/rules.rb

@@ -1,48 +1,25 @@
 rule "FC002", "Avoid string interpolation where not required" do
   description "When setting a resource value avoid string interpolation where not required."
   recipe do |ast|
-    matches = []
-    self.ast(:string_literal, ast).each do |literal|
-      embed_expr = self.ast(:string_embexpr, literal)
-      if embed_expr.size == 1
-        literal[1].reject! { |expr| expr == embed_expr.first }
-        if self.ast(:@tstring_content, literal).empty?
-          self.ast(:@ident, embed_expr).map { |ident| ident.flatten.drop(1) }.each do |ident|
-            matches << {:matched => ident[0], :line => ident[1], :column => ident[2]}
-          end
-        end
-      end
-    end
-    matches
+    ast.xpath(%q{//string_literal[count(descendant::string_embexpr) = 1 and
+      count(string_add/tstring_content|string_add/string_add/tstring_content) = 0]}).map{|str| match(str)}
   end
 end
 
 rule "FC003", "Check whether you are running with chef server before using server-specific features" do
   description "Ideally your cookbooks should be usable without requiring chef server."
   recipe do |ast|
-    matches = []
-    function_calls = self.ast(:@ident, self.ast(:fcall, ast)).map { |fcall| fcall.drop(1).flatten }
-    searches = function_calls.find_all { |fcall| fcall.first == 'search' }
-    unless searches.empty? || checks_for_chef_solo?(ast)
-      searches.each { |s| matches << {:matched => s[0], :line => s[1], :column => s[2]} }
-    end
-    matches
+    checks_for_chef_solo?(ast) ? [] : searches(ast).map{|s| match(s)}
   end
 end
 
 rule "FC004", "Use a service resource to start and stop services" do
   description "Avoid use of execute to control services - use the service resource instead."
   recipe do |ast|
-    matches = []
     find_resources(ast, 'execute').find_all do |cmd|
-      cmd_str = resource_attribute('command', cmd)
-      cmd_str = resource_name(cmd) if cmd_str.nil?
+      cmd_str = (resource_attribute('command', cmd) || resource_name(cmd)).to_s
       cmd_str.include?('/etc/init.d') || cmd_str.start_with?('service ') || cmd_str.start_with?('/sbin/service ')
-    end.each do |service_cmd|
-      exec = ast(:@ident, service_cmd).first.drop(1).flatten
-      matches << {:matched => exec[0], :line => exec[1], :column => exec[2]}
-    end
-    matches
+    end.map{|cmd| match(cmd)}
   end
 end
 
@@ -54,10 +31,30 @@ rule "FC005", "Avoid repetition of resource declarations" do
     resource_attributes_by_type(ast).each do |type, resource_atts|
         sorted_atts = resource_atts.map{|atts| atts.to_a.sort{|x,y| x.first.to_s <=> y.first.to_s }}
         if sorted_atts.all?{|att| (att - sorted_atts.inject{|atts,a| atts & a}).length == 1}
-          first_resource = ast(:@ident, find_resources(ast, type).first).first[2]
-          matches << {:matched => type, :line => first_resource[0], :column => first_resource[1]}
+          matches << match(find_resources(ast, type).first)
         end
     end
     matches
   end
-end
+end
+
+rule "FC006", "Mode should be quoted or fully specified when setting file permissions" do
+  description "Not quoting mode when setting permissions can lead to incorrect permissions being set."
+  recipe do |ast|
+    ast.xpath(%q{//ident[@value='mode']/parent::command/descendant::int[string-length(@value) < 4]/
+      ancestor::method_add_block}).map{|resource| match(resource)}
+  end
+end
+
+rule "FC007", "Ensure recipe dependencies are reflected in cookbook metadata" do
+  description "You are including a recipe that is not in the current cookbook and not defined as a dependency in your cookbook metadata."
+  recipe do |ast,filename|
+    metadata_path = File.join(File.dirname(filename), '..', 'metadata.rb')
+    next unless File.exists? metadata_path
+    undeclared = included_recipes(ast).keys.map{|recipe|recipe.split('::').first} - [cookbook_name(filename)] -
+        declared_dependencies(read_file(metadata_path))
+    included_recipes(ast).map do |recipe, resource|
+      match(resource) if undeclared.include?(recipe) || undeclared.any?{|u| recipe.start_with?("#{u}::")}
+    end.compact
+  end
+end

data/lib/foodcritic/version.rb

@@ -1,3 +1,3 @@
 module FoodCritic
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,30 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-01 00:00:00.000000000 Z
-dependencies: []
+date: 2011-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2157802560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157802560
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: &2157800260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157800260
 description: Lint tool for Opscode Chef cookbooks.
 email: 
 executables:
@@ -18,13 +40,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/foodcritic.rb
 - lib/foodcritic/domain.rb
+- lib/foodcritic/dsl.rb
+- lib/foodcritic/helpers.rb
 - lib/foodcritic/linter.rb
 - lib/foodcritic/rules.rb
-- lib/foodcritic/helpers.rb
 - lib/foodcritic/version.rb
-- lib/foodcritic/dsl.rb
+- lib/foodcritic.rb
 - bin/foodcritic
 homepage: http://acrmp.github.com/foodcritic
 licenses:
@@ -47,12 +69,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1647657478747687717
+      hash: 927165501432344600
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: foodcritic-0.2.0
+summary: foodcritic-0.3.0
 test_files: []
 has_rdoc: