foodcritic 10.4.1 → 11.0.0

data/lib/foodcritic/rules/fc008.rb

@@ -7,8 +7,8 @@ rule "FC008", "Generated cookbook metadata needs updating" do
       { "maintainer_email" => "YOUR_EMAIL" },
       { "maintainer_email" => "you@example.com" },
     ].map do |metadata_hash|
-      ast.xpath(%Q{//command[ident/@value='#{metadata_hash.keys[0]}']/
-                   descendant::tstring_content[@value='#{metadata_hash.values[0]}']})
+      field, value = metadata_hash.to_a.first
+      field(ast, field).xpath("descendant::tstring_content[@value='#{value}']")
     end
   end
 end

data/lib/foodcritic/rules/fc029.rb

@@ -1,7 +1,7 @@
 rule "FC029", "No leading cookbook name in recipe metadata" do
   tags %w{correctness metadata}
   metadata do |ast, filename|
-    ast.xpath('//command[ident/@value="recipe"]').map do |declared_recipe|
+    field(ast, "recipe").map do |declared_recipe|
       next unless declared_recipe.xpath("count(//vcall|//var_ref)").to_i == 0
       recipe_name = declared_recipe.xpath('args_add_block/
         descendant::tstring_content[1]/@value').to_s

data/lib/foodcritic/rules/fc042.rb

@@ -1,6 +1,6 @@
 rule "FC042", "Prefer include_recipe to require_recipe" do
   tags %w{correctness deprecated}
   recipe do |ast|
-    ast.xpath('//command[ident/@value="require_recipe"]')
+    field(ast, "require_recipe")
   end
 end

data/lib/foodcritic/rules/fc052.rb

@@ -1,6 +1,6 @@
 rule "FC052", 'Metadata uses the deprecated "suggests" keyword' do
   tags %w{style metadata deprecated}
   metadata do |ast, filename|
-    ast.xpath(%q{//command[ident/@value='suggests']})
+    field(ast, "suggests")
   end
 end

data/lib/foodcritic/rules/fc053.rb

@@ -1,6 +1,6 @@
 rule "FC053", 'Metadata uses the deprecated "recommends" keyword' do
   tags %w{style metadata deprecated}
   metadata do |ast, filename|
-    ast.xpath(%q{//command[ident/@value='recommends']})
+    field(ast, "recommends")
   end
 end

data/lib/foodcritic/rules/fc057.rb

@@ -1,6 +1,6 @@
 rule "FC057", "Library provider does not declare use_inline_resources" do
   tags %w{correctness lwrp}
-  library do |ast, filename|
+  library do |ast|
     ast.xpath('//const_path_ref/const[@value="LWRPBase"]/..//const[@value="Provider"]/../../..').select do |x|
       x.xpath('//*[self::vcall or self::var_ref]/ident[@value="use_inline_resources"]').empty?
     end

data/lib/foodcritic/rules/fc058.rb

@@ -1,6 +1,6 @@
 rule "FC058", "Library provider declares use_inline_resources and declares #action_<name> methods" do
   tags %w{correctness lwrp}
-  library do |ast, filename|
+  library do |ast|
     ast.xpath('//const_path_ref/const[@value="LWRPBase"]/..//const[@value="Provider"]/../../..').select do |x|
       x.xpath('//*[self::vcall or self::var_ref]/ident[@value="use_inline_resources"]').length > 0 &&
         x.xpath(%q{//def[ident[contains(@value, 'action_')]]}).length > 0

data/lib/foodcritic/rules/fc060.rb

@@ -1,6 +1,6 @@
 rule "FC060", "LWRP provider declares use_inline_resources and declares #action_<name> methods" do
   tags %w{correctness lwrp}
-  provider do |ast, filename|
+  provider do |ast|
     use_inline_resources = !ast.xpath('//*[self::vcall or self::var_ref]/ident
       [@value="use_inline_resources"]').empty?
     if use_inline_resources

data/lib/foodcritic/rules/fc061.rb

@@ -2,9 +2,9 @@ rule "FC061", "Valid cookbook versions are of the form x.y or x.y.z" do
   tags %w{metadata correctness supermarket}
   metadata do |ast, filename|
     # matches a version method with a string literal with no interpolation
-    ver = ast.xpath('//command[ident/@value="version"]/args_add_block/args_add/string_literal[not(.//string_embexpr)]//tstring_content/@value')
-    if !ver.empty? && ver.to_s !~ /\A\d+\.\d+(\.\d+)?\z/
-      [file_match(filename)]
+    ver = field_value(ast, "version")
+    if ver && !ver.empty? && ver.to_s !~ /\A\d+\.\d+(\.\d+)?\z/
+      field(ast, "version")
     end
   end
 end

data/lib/foodcritic/rules/fc063.rb

@@ -2,7 +2,6 @@ rule "FC063", "Cookbook incorrectly depends on itself" do
   tags %w{metadata correctness}
   metadata do |ast, filename|
     name = cookbook_name(filename)
-    ast.xpath(%Q{//command[ident/@value='depends']/
-              descendant::tstring_content[@value='#{name}']})
+    field(ast, "depends").xpath("descendant::tstring_content[@value='#{name}']")
   end
 end

data/lib/foodcritic/rules/fc069.rb

@@ -2,8 +2,7 @@ rule "FC069", "Ensure standardized license defined in metadata" do
   tags %w{metadata supermarket license}
   metadata do |ast, filename|
     begin
-      license = ast.xpath(%Q{//command[ident/@value='license']/
-                            descendant::tstring_content}).attribute("value").to_s
+      license = field_value(ast, "license")
 
       # list of valid SPDX.org license strings. To build an array run this:
       # require 'json'
@@ -356,8 +355,7 @@ rule "FC069", "Ensure standardized license defined in metadata" do
       StandardML-NJ
       WXwindows
       }
-      valid << "All Rights Reserved" # Chef-DK's non-standard extra value
-      [file_match(filename)] unless valid.include?(license)
+      [file_match(filename)] unless valid.include?(license) || license =~ /all rights reserved/i
     rescue NoMethodError # no license in the metadata
       [file_match(filename)]
     end

data/lib/foodcritic/rules/fc078.rb

@@ -1,9 +1,8 @@
 rule "FC078", "Ensure cookbook shared under an OSI-approved open source license" do
-  tags %w{opensource}
+  tags %w{opensource license supermarket}
   metadata do |ast, filename|
     begin
-      license = ast.xpath(%Q{//command[ident/@value='license']/
-                            descendant::tstring_content}).attribute("value").to_s
+      license = field_value(ast, "license")
 
       # list of valid SPDX.org license strings. To build an array run this:
       # require 'json'

data/lib/foodcritic/rules/fc079.rb

@@ -0,0 +1,6 @@
+rule "FC079", "Deprecated easy_install_package resource usage" do
+  tags %w{deprecated chef13}
+  recipe do |ast|
+    find_resources(ast, type: "easy_install_package")
+  end
+end

data/lib/foodcritic/rules/fc080.rb

@@ -0,0 +1,6 @@
+rule "FC080", "User resource uses supports property" do
+  tags %w{deprecated chef13}
+  recipe do |ast|
+    find_resources(ast, type: "user").xpath(%q{descendant::fcall[ident/@value='supports']|descendant::command[ident/@value='supports']})
+  end
+end

data/lib/foodcritic/rules/fc081.rb

@@ -0,0 +1,6 @@
+rule "FC081", "Cookbook depends on the partial_search cookbook" do
+  tags %w{chef12}
+  metadata do |ast, filename|
+    [file_match(filename)] if declared_dependencies(ast).include?("partial_search")
+  end
+end

data/lib/foodcritic/rules/fc082.rb

@@ -0,0 +1,9 @@
+rule "FC082", "node.set or node.set_unless used to set node attributes" do
+  tags %w{chef14 deprecated}
+  def node_sets(ast)
+    ast.xpath('//call[(vcall|var_ref)/ident/@value="node"]
+    [ident[@value="set" or @value="set_unless"]]')
+  end
+  recipe { |ast| node_sets(ast) }
+  library { |ast| node_sets(ast) }
+end

data/lib/foodcritic/rules/fc083.rb

@@ -0,0 +1,6 @@
+rule "FC083", "Execute resource using 'path' property" do
+  tags %w{deprecated chef12}
+  recipe do |ast|
+    find_resources(ast, type: "execute").xpath('(.//command|.//fcall)[ident/@value="path"]')
+  end
+end

data/lib/foodcritic/rules/fc084.rb

@@ -0,0 +1,9 @@
+rule "FC084", "Deprecated Chef::REST class used" do
+  tags %w{chef13 deprecated}
+  def rest(ast)
+    ast.xpath('//const_path_ref/const[@value="REST"]/..//const[@value="Chef"]/../../..')
+  end
+  recipe { |ast| rest(ast) }
+  library { |ast| rest(ast) }
+
+end

data/lib/foodcritic/rules/fc085.rb

@@ -0,0 +1,12 @@
+rule "FC085", "Resource using new_resource.updated_by_last_action to converge resource" do
+  tags %w{chef13 deprecated}
+  def updated_by(ast)
+    ast.xpath('//call[(vcall|var_ref)/ident/@value="new_resource"]
+      [ident/@value="updated_by_last_action"]')
+  end
+
+  resource { |ast| updated_by(ast) }
+  provider { |ast| updated_by(ast) }
+  library { |ast| updated_by(ast) }
+
+end

data/lib/foodcritic/version.rb

@@ -1,4 +1,4 @@
 module FoodCritic
   # The current version of foodcritic
-  VERSION = "10.4.1"
+  VERSION = "11.0.0"
 end

data/spec/functional/fc007_spec.rb

@@ -0,0 +1,127 @@
+require "spec_helper"
+
+describe "FC007" do
+  metadata_file "name 'test'\ndepends 'dep'"
+  context "with an undeclared dependency" do
+    recipe_file 'include_recipe "foo"'
+
+    it { is_expected.to violate_rule }
+
+    context "with parens" do
+      recipe_file 'include_recipe("foo")'
+      it { is_expected.to violate_rule }
+    end
+
+    context "with ::default" do
+      recipe_file 'include_recipe "foo::default"'
+      it { is_expected.to violate_rule }
+    end
+
+    context "with parens and ::default" do
+      recipe_file 'include_recipe("foo::default")'
+      it { is_expected.to violate_rule }
+    end
+
+    # context 'with a partial expression' do
+    #   recipe_file 'include_recipe "foo::#{something}"'
+    #   it { pending; is_expected.to violate_rule }
+    # end
+  end
+
+  context "with a declared dependency" do
+    recipe_file 'include_recipe "dep"'
+
+    it { is_expected.to_not violate_rule }
+
+    context "with parens" do
+      recipe_file 'include_recipe("dep")'
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with ::default" do
+      recipe_file 'include_recipe "dep::default"'
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with parens and ::default" do
+      recipe_file 'include_recipe("dep::default")'
+      it { is_expected.to_not violate_rule }
+    end
+
+    # context 'with a partial expression' do
+    #   recipe_file 'include_recipe "dep::#{something}"'
+    #   it { pending; is_expected.to_not violate_rule }
+    # end
+  end
+  context "with an unknowable include_recipe" do
+    context "with a node attribute" do
+      recipe_file 'include_recipe node["foo"]'
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with a variable" do
+      recipe_file "include_recipe something"
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with a string expression" do
+      recipe_file 'include_recipe "#{something}"'
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with a parial string expression" do
+      recipe_file 'include_recipe "#{something}::default"'
+      it { is_expected.to_not violate_rule }
+    end
+  end
+
+  context "with an include from the same cookbook" do
+    recipe_file 'incldue_recipe "test::other"'
+    it { is_expected.to_not violate_rule }
+
+    context "with the shorthand syntax" do
+      recipe_file 'include_recipe "::other"'
+      it { is_expected.to_not violate_rule }
+    end
+  end
+
+  context "with multiple includes" do
+    recipe_file "include_recipe 'test::other'\ninclude_recipe 'foo'"
+    it { is_expected.to violate_rule.in("recipes/default.rb:2") }
+  end
+
+  context "with multiple dependencies" do
+    shared_examples "multiple includes" do
+      context "with declared includes" do
+        recipe_file %Q{include_recipe 'one'\ninclude_recipe "two"\ninclude_recipe 'three::default'}
+        it { is_expected.to_not violate_rule }
+      end
+
+      context "with undeclared includes" do
+        recipe_file %Q{include_recipe 'one'\ninclude_recipe "other"\ninclude_recipe 'foo::default'}
+        it { is_expected.to violate_rule.in("recipes/default.rb:2") }
+        it { is_expected.to violate_rule.in("recipes/default.rb:2") }
+      end
+    end
+
+    context "using multiple depends" do
+      metadata_file "name 'test'\ndepends 'one'\ndepends 'two'\ndepends 'three'"
+      it_behaves_like "multiple includes"
+    end
+
+    context "using a word array and a one-line block" do
+      metadata_file "name 'test'\n%w{one two three}.each {|d| depends d }"
+      it_behaves_like "multiple includes"
+    end
+
+    context "using a word array and a multi-line block" do
+      metadata_file "name 'test'\n%w{one two three}.each do |d|\n  depends d\nend"
+      it_behaves_like "multiple includes"
+    end
+
+    context "using a non-standard word array" do
+      metadata_file "name 'test'\n%w|one two three|.each {|d| depends d }"
+      it_behaves_like "multiple includes"
+    end
+  end
+end

data/spec/functional/fc049_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe "FC049" do
+  foodcritic_command("--no-progress", "-R", "roles")
+
+  context "with webserver.rb" do
+    context "with name webserver" do
+      file "roles/webserver.rb", 'name "webserver"'
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with name apache" do
+      file "roles/webserver.rb", 'name "apache"'
+      it { is_expected.to violate_rule }
+    end
+
+    context "with a string expression in the name" do
+      file "roles/webserver.rb", 'name "ap#{ache}"'
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with multiple names" do
+      file "roles/webserver.rb", "name 'apache'\nname 'webserver'"
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with multiple mismatched names" do
+      file "roles/webserver.rb", "name 'webserver'\nname 'apache'"
+      it { is_expected.to violate_rule }
+    end
+  end
+
+  context "with webserver.json" do
+    context "with name webserver" do
+      file "roles/webserver.json", '{"name": "webserver"}'
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with name apache" do
+      file "roles/webserver.json", '{"name": "apache"}'
+      it { is_expected.to_not violate_rule }
+    end
+  end
+
+  context "in -B mode" do
+    foodcritic_command("--no-progress", "-B", "roles")
+    file "roles/webserver.rb", 'name "apache"'
+    it { is_expected.to_not violate_rule }
+  end
+
+  context "in normal mode" do
+    foodcritic_command("--no-progress", "roles")
+    file "roles/webserver.rb", 'name "apache"'
+    it { is_expected.to_not violate_rule }
+  end
+end

data/spec/functional/fc050_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+
+describe "FC050" do
+  context "with a role" do
+    foodcritic_command("--no-progress", "-R", "roles")
+    let(:role_name) { "" }
+    file("roles/webserver.rb") { "name '#{role_name}'\nrun_list ['recipe[apache]']" }
+
+    context "with name webserver" do
+      let(:role_name) { "webserver" }
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with name web_server" do
+      let(:role_name) { "web_server" }
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with name web-server" do
+      let(:role_name) { "web-server" }
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with name webserver123" do
+      let(:role_name) { "webserver123" }
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with name Webserver" do
+      let(:role_name) { "Webserver" }
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with name web server" do
+      let(:role_name) { "web server" }
+      it { is_expected.to violate_rule }
+    end
+
+    context "with name webserver%" do
+      let(:role_name) { "webserver%" }
+      it { is_expected.to violate_rule }
+    end
+  end
+
+  context "with an environment" do
+    foodcritic_command("--no-progress", "-E", "environments")
+    let(:environment_name) { "" }
+    file("environments/production.rb") { "name '#{environment_name}'\ncookbook 'apache2'" }
+
+    context "with name production" do
+      let(:environment_name) { "production" }
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with name pre_production" do
+      let(:environment_name) { "pre_production" }
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with name production-eu" do
+      let(:environment_name) { "production-eu" }
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with name production2" do
+      let(:environment_name) { "production2" }
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with name Production" do
+      let(:environment_name) { "Production" }
+      it { is_expected.to_not violate_rule }
+    end
+
+    context "with name EU West" do
+      let(:environment_name) { "EU West" }
+      it { is_expected.to violate_rule }
+    end
+
+    context "with name production (eu-west)" do
+      let(:environment_name) { "production (eu-west)" }
+      it { is_expected.to violate_rule }
+    end
+  end
+end