foodcritic 4.0.0 → 5.0.0

data/lib/foodcritic/rake_task.rb

@@ -4,8 +4,7 @@ require 'rake/tasklib'
 module FoodCritic
   module Rake
     class LintTask < ::Rake::TaskLib
-      attr_accessor :name, :files
-      attr_writer :options
+      attr_accessor :name, :files, :options
 
       def initialize(name = :foodcritic)
         @name = name
@@ -15,24 +14,29 @@ module FoodCritic
         define
       end
 
-      def options
-        {
-          fail_tags: ['correctness'], # differs to default cmd-line behaviour
-          cookbook_paths: @files,
-          exclude_paths: ['test/**/*', 'spec/**/*', 'features/**/*'],
-          context: false,
-        }.merge(@options)
-      end
 
       def define
         desc 'Lint Chef cookbooks' unless ::Rake.application.last_comment
         task(name) do
-          result = FoodCritic::Linter.new.check(options)
+          puts "Starting Foodcritic linting..."
+          result = FoodCritic::Linter.new.check(options.merge(default_options))
           printer = options[:context] ? ContextOutput.new : SummaryOutput.new
           printer.output(result) if result.warnings.any?
           abort if result.failed?
+          puts "Completed!"
         end
       end
+
+      private
+      def default_options
+        {
+          fail_tags: ['correctness'], # differs to default cmd-line behaviour
+          cookbook_paths: files,
+          exclude_paths: ['test/**/*', 'spec/**/*', 'features/**/*'],
+          context: false,
+          chef_version: FoodCritic::Linter::DEFAULT_CHEF_VERSION
+        }
+      end
     end
   end
 end

data/lib/foodcritic/rules.rb

@@ -22,7 +22,7 @@ rule 'FC002', 'Avoid string interpolation where not required' do
   recipe do |ast|
     ast.xpath(%q{//*[self::string_literal | self::assoc_new]/string_add[
       count(descendant::string_embexpr) = 1 and
-      count(tstring_content|string_add/tstring_content) = 0]})
+      count(string_add) = 0]})
   end
 end
 
@@ -618,7 +618,7 @@ rule 'FC041', 'Execute resource used to run curl or wget commands' do
   recipe do |ast|
     find_resources(ast, type: 'execute').select do |cmd|
       cmd_str = (resource_attribute(cmd, 'command') || resource_name(cmd)).to_s
-      (cmd_str.include?('curl ') || cmd_str.include?('wget '))
+      (cmd_str.match(/^curl.*(-o|>|--output).*$/) || cmd_str.include?('wget '))
     end
   end
 end
@@ -646,10 +646,17 @@ rule 'FC044', 'Avoid bare attribute keys' do
     declared = ast.xpath('//descendant::var_field/ident/@value').map do |v|
       v.to_s
     end
+
     ast.xpath('//assign/*[self::vcall or self::var_ref]
               [count(child::kw) = 0]/ident').select do |v|
+
+      local_declared = v.xpath("ancestor::*[self::brace_block or self::do_block]
+                                /block_var/descendant::ident/@value").map do |v|
+          v.to_s
+        end
+
       (v['value'] != 'secure_password') &&
-        !declared.include?(v['value']) &&
+        !(declared + local_declared).uniq.include?(v['value']) &&
         !v.xpath("ancestor::*[self::brace_block or self::do_block]/block_var/
                   descendant::ident/@value='#{v['value']}'")
     end
@@ -698,9 +705,18 @@ 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]')
+
+    xstring_literal=ast.xpath('//xstring_literal')
+    next xstring_literal if xstring_literal.any?
+
+    ast.xpath('//*[self::command or self::fcall]/ident[@value="system"]').select do |x|
+      resource_name = x.xpath('ancestor::do_block/preceding-sibling::command/ident/@value')
+      if resource_name.any? && resource_attribute?(resource_name.to_s, 'system')
+        next false
+      end
+      next x.xpath('count(following-sibling::args_add_block/descendant::kw[@value="true" or @value="false"]) = 0')
+    end
+
   end
 end
 
@@ -739,3 +755,19 @@ rule 'FC051', 'Template partials loop indefinitely' do
     end.map { |t| file_match(t) }
   end
 end
+
+rule 'FC052', 'Metadata uses the unimplemented "suggests" keyword' do
+  tags %w(style metadata)
+  metadata do |ast, filename|
+    ast.xpath(%Q(//command[ident/@value='suggests']))
+  end
+end
+
+rule 'FC053', 'Metadata uses the unimplemented "recommends" keyword' do
+  tags %w(style metadata)
+  metadata do |ast, filename|
+    ast.xpath(%Q(//command[ident/@value='recommends']))
+  end
+end
+
+# NOTE: FC054 was yanked and should be considered reserved, do not reuse it

data/lib/foodcritic/version.rb

@@ -1,4 +1,4 @@
 module FoodCritic
   # The current version of foodcritic
-  VERSION = '4.0.0'
+  VERSION = '5.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" "June 2014" "" ""
+.TH "FOODCRITIC" "1" "September 2015" "" ""
 .
 .SH "NAME"
 \fBfoodcritic\fR \- lint tool for chef cookbooks
@@ -9,6 +9,9 @@
 .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\.
 .
@@ -22,6 +25,10 @@ Each \fBcookbook\fR path specified will be examined for common problems and poor
 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\.
 .

data/man/foodcritic.1.ronn

@@ -5,6 +5,8 @@ foodcritic(1) -- lint tool for chef cookbooks
 
 `foodcritic` [<options>...] <cookbook>...
 
+`foodcritic` [<options>...] --list
+
 
 ## DESCRIPTION
 
@@ -22,6 +24,11 @@ poor style.
    Only check against rules with the specified tags. Prefix
    tags with a tilde `~` to exclude rules.
 
+ * `-l`, `--list`:
+   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)
+
  * `-f`, `--epic-fail` <TAGS>:
    Exit non-zero if any of the specified tags are matched.
    Use the pseudo-tag `any` to fail if any tag is matched.

data/misc/lucene.treetop

@@ -0,0 +1,150 @@
+#
+# Author:: Seth Falcon (<seth@opscode.com>)
+# Copyright:: Copyright (c) 2010-2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+grammar Lucene
+
+  rule body
+    (expression / space)* <Body>
+  end
+
+  rule expression
+    operation / group / field / field_range / term / string
+  end
+
+  rule term
+    keyword valid_letter+ <Term> / !keyword !"?" valid_letter <Term>
+  end
+
+  rule field
+    field_name ":" (term/string/group) <Field>
+  end
+
+  rule field_range
+    field_name ":" "[" range_value " TO " range_value "]" <InclFieldRange>
+    /
+    field_name ":" "{" range_value " TO " range_value "}" <ExclFieldRange>
+  end
+
+  rule field_name
+    !keyword valid_letter+ <FieldName>
+  end
+
+  rule range_value
+    valid_letter+ <RangeValue> / "*" <RangeValue>
+  end
+
+  rule group
+    space? '(' body ')' space? <Group>
+  end
+
+  rule operation
+    binary_op / unary_op / fuzzy_op / boost_op
+  end
+
+  rule unary_op
+    not_op / required_op / prohibited_op
+  end
+
+  rule binary_op
+    (group / field / field_range / term) space? boolean_operator space+ body <BinaryOp>
+  end
+
+  rule boolean_operator
+    and_operator / or_operator
+  end
+
+  rule and_operator
+    'AND' <AndOperator> / '&&' <AndOperator>
+  end
+
+  rule or_operator
+    'OR' <OrOperator> / '||' <OrOperator>
+  end
+
+  rule not_op
+    not_operator space (group / field / field_range / term / string) <UnaryOp>
+    /
+    bang_operator space? (group / field / field_range / term / string) <UnaryOp>
+  end
+
+  rule not_operator
+    'NOT' <NotOperator>
+  end
+
+  rule bang_operator
+    '!' <NotOperator>
+  end
+
+  rule required_op
+    !valid_letter required_operator (term/string) <UnaryOp>
+    /
+    required_operator (term/string) <UnaryOp>
+  end
+  
+  rule required_operator
+    '+' <RequiredOperator>
+  end
+
+  rule prohibited_op
+    !valid_letter prohibited_operator (field/field_range/term/string) <UnaryOp>
+  end
+
+  rule prohibited_operator
+    '-' <ProhibitedOperator>
+  end
+
+  rule boost_op
+    (term/string) '^' fuzzy_param <BoostOp>
+  end
+
+  rule fuzzy_op
+    (term/string) '~' fuzzy_param? (space / !valid_letter) <FuzzyOp>
+  end
+
+  rule fuzzy_param
+    [0-9] '.'? [0-9] <FuzzyParam> / [0-9]+ <FuzzyParam>
+  end
+
+  rule string
+    '"' term (space term)* '"' <Phrase>
+  end
+
+  rule keyword
+    'AND' / 'OR' / 'NOT'
+  end
+
+  rule valid_letter
+    start_letter+ ([a-zA-Z0-9@*?_.-] / '\\' special_char)*
+  end
+
+  rule start_letter
+    [a-zA-Z0-9@._*] / '\\' special_char
+  end
+
+  rule end_letter
+    [a-zA-Z0-9*?_.] / '\\' special_char
+  end
+
+  rule special_char
+    [-+&|!(){}\[\]^"~*?:\\]
+  end
+
+  rule space
+    [\s]+
+  end
+end

data/spec/foodcritic/command_line_spec.rb

@@ -61,4 +61,14 @@ describe FoodCritic::CommandLine do
       refute FoodCritic::CommandLine.new(["lib", "lib2"]).valid_paths?
     end
   end
+
+  describe "#list_rules?" do
+    it "returns false if ---list is not specified" do
+      refute FoodCritic::CommandLine.new([]).list_rules?
+    end
+
+    it "returns true if --list is specified" do
+      assert FoodCritic::CommandLine.new(['--list']).list_rules?
+    end
+  end
 end

data/spec/foodcritic/domain_spec.rb

@@ -23,6 +23,25 @@ describe FoodCritic::Review do
   end
 end
 
+describe FoodCritic::RuleList do
+  it "is instantiable with no warnings" do
+    FoodCritic::RuleList.new([])
+  end
+
+  let(:rule) { FoodCritic::Rule.new('FCTEST001', 'Test rule') }
+
+  describe "#rules" do
+
+    it 'is empty when instantiated with an empty rule list' do
+      assert FoodCritic::RuleList.new([]).rules.empty?
+    end
+
+    it 'contains the given rule' do
+      assert FoodCritic::RuleList.new([rule]).rules.include?(rule)
+    end
+  end
+end
+
 describe FoodCritic::Rule do
   let(:rule) { FoodCritic::Rule.new('FCTEST001', 'Test rule') }
 

data/spec/foodcritic/linter_spec.rb

@@ -11,7 +11,7 @@ describe FoodCritic::Linter do
 
   describe "chef version" do
     it "should be the latest stable version of Chef" do
-      FoodCritic::Linter::DEFAULT_CHEF_VERSION.must_equal "11.10.4"
+      FoodCritic::Linter::DEFAULT_CHEF_VERSION.must_equal "12.4.1"
     end
   end
 
@@ -42,6 +42,18 @@ describe FoodCritic::Linter do
 
   end
 
+  describe "#list_rules" do
+
+    it "does not require cookbook_path, role_path or environment_path to be specified" do
+      linter.list(:list => true)
+    end
+
+    it "returns a rule listing" do
+      linter.list(:list => true).must_respond_to(:rules)
+    end
+  end
+
+
   describe "#load_files!" do
     let(:default_rules_file) do
       File.expand_path(File.join(File.dirname(__FILE__), '../../lib/foodcritic/rules.rb'))

data/spec/regression/cookbooks.txt

@@ -1,16 +1,6 @@
-7-zip:5dad0850d7c8ad5e63a0ae655f1ee2b17adfcd12
 activemq:5dce4ca5283d2a6252130a2d800b9387a57d6e01
-ant:2bd97f4bb7c8bcd37ea3bb3615a5f306e65d80a0
-apache2:29056c1a0a04cb718651ff0f522204ec651f94f0
 apparmor:fd09a6fda4f6fc722d4c8d5b8a5c815feda280c0
-application:da3eb5ac8fc20e9db7213c3b22f0a7856a73778c
-application_java:8aff84b60fb27c8fc228d86c6eca5949ba5a93a8
-application_nginx:a67bc25b95d33565d2c368b41c46f7366fb2a1e4
-application_php:08de9c64cd01b67e411f14f407254a36fed273c6
-application_python:b738476bd7d37a0a1e10094da32c6a5f4759cdb6
-application_ruby:812efe31df6c3c1607ed73f45e0adca7723b6c64
 apt:ea834265247cc8b507ac37ab3a34a9b44ed27a11
-ark:aa82cb6d9d83f12c3f4fa5969f56ce809529bf72
 aws:a9530561bf559c6db2cb40a93b125607c5ef3efa
 bluepill:1d6422afcbc910e587c9639e4e0a28c72727c90b
 boost:14f30e36040a4fcd038f030d9ee1c7fb29b08b68
@@ -19,117 +9,67 @@ chef:dac09eea9fa0d611b7b010160d6b8fa7f4d6ae1e
 chef-client:7fc4472c9913c9cb1762f979e05047a674318ef5
 chef-server:d98b96d69962c7988b9640fe5bee09f771ba8977
 chef_handler:d147ca9644f146b97a2d53324ca344321799b45f
-cloudkick:3f48cee9dc854914d002ea7e21380f60528583bd
-couchdb:cad1afe6cb51e31f6ad8f289a761d638fbfee8c2
 cron:dce04363b6a02d36f8da88f202cedfae2daa6a2c
-daemontools:7ff23d4884138e957bef04a1e63e8c240020fcc1
 database:1ab3822ca50824fbdc14f7c89341faa7ae1e90cb
-djbdns:d3b2dd6e0fe1faf6193d44b794685b59acaf2da2
 dmg:11caf56f57a1168a891f01f0614a01b879aff624
 drbd:e65b60894b48855163c3a13ead40fb897d66c4b8
 dynect:5ef2328cc612cc4c36882742367af0e2bdbd0367
-emacs:96d1026a6a6cdab979c7ef54fc27fe49b1f5d8ca
 erlang:58290537b49b495bc18e7a06d9d7560b4d239582
 fail2ban:7b1939c9bc345f3a449545cb8e7ddb8190a6fe5f
 firewall:81a8db5a868f9f486ba694a7fe8eb969a2ae99d1
 freebsd:f7a4457507caab966448f4e37709370df05d6167
 gecode:87dc9114bf79e67b8eea9f2a0c42929040d08e4b
 gems:6f8c222cf8326b5266ca3c68344accbbf8d5c468
-getting-started:ec6b8de327daa43403560a1204a2ac7645a3b959
-git:f971753d7bac72c4decf2dddda8f9be5289ae324
-glance:ce4ee4fbc75309e1f7eae8eda1841d8bd1a2d8ec
-gnu_parallel:ad31c1d7411686b8b54ce726d9cf8d864a33fcaf
-god:2e1691b7d9383a7f3fc6fe0ad285801a3397decb
 gunicorn:89be74c6b47bdb980ee1d98f9aae6b747f1d11e8
-hadoop:eab8f63f9a47714a6ca05821285db6043dc7be5e
-haproxy:6b7a212d1c82ac420cba3335a31e32f346d149fa
 heartbeat:da496afa31286512a9b977974bec5ff51d6de9d8
 homebrew:f42d8d09d8ae3d45f5bdb680dd52da351cb80e2e
-horizon:736422cecad62a939f1721df66b6388e9bc489de
 iis:ab7e4823d375e8eb4f927dee5b7ab0591301cb0e
-imagemagick:20aec29c45ee3c04616bb3fa3cd5ddf4baf48f00
 iptables:da126cf900af3cc36bf212973bb8d0be69fa2b9f
-java:81d7d7f8f831405af1f42c8bb4230e6456b493be
 jetty:d165775c2c7ce3cc484cbe8c7aadf6649505d078
-jira:328b662dbf07078fa5841035260ade016f3dd1f1
 jpackage:23e6f4b717620455ee9d29cbf82d9a7ab7fa6e5b
 keepalived:629c8e4c5251f6125be9f6eacecb1369fcb1cd4c
-keystone:7d54242ac6edfffd1ed017914018a02d07ef5194
 kickstart:6523fca008362ed72f8fbb25f0c7af70d563b96d
-logrotate:e1b6ee784954218652f817211e22fea9baf042f6
 logwatch:706174796a3bc1d85d57d3aee792e78cb13570ac
 lvm:57bd5291fbaa41e7a13f25c4553cdacbfc3ad3dd
-man:f52cfeaa6a8ca0979eee235e6d9c7243104af2f5
 maradns:e975ded4303432629ad37234cb7a05c9d6edcf73
 maven:e486321f1e89f7ad2b9700c08fcbc68c32daa599
 memcached:db13b6c4088e93faf995441df4aa856adc84c565
-mercurial:5b8f95e1a8b74bc92d6b2e119e2cf31bc76ad059
 motd-tail:e01096b73c387a46302f63ae6f838fac94e0ca81
-munin:ac753f2ff5be33473a36c9b22625d0d7a47f485a
 mysql:1709b1ea22339a0c829cf5ced8c5a7ed4a186615
-nagios:a21ac7b3ee2384b31ffdee7986ba2891235bd845
-nginx:638280b3125e68d0903a60b167206f9be5bc2cca
-nova:04417ae3bca444b6870f3551ad3528c3ba661d0c
 nscd:28f37aaf70228c0f5b55c36b78bf3fbd56cb3112
-ntp:288935754b2c25017e3e0890ffb1a35b2a9f4668
 ohai:8ad8c92b14d5198ffa5ebd094acd83ba0c5c828c
 openldap:2f21ae90544b4f938e554f914955e3fac1a885de
 openssh:a61b47fb0efbdab731e7929506bb1dc6902f0091
 openssl:7f5b84a942f015191ade6badf65a49f1fe7b05b1
-openvpn:1d9838ca3cec981e1ab78d1160821d77f26978b3
-ossec:44dddb496e595d200c802b515adfd4ac2e497647
-pacman:77efa35dca9e53bc6c67773b217df645429e53f4
 partial_search:9a96d68a4af2eff1cf5d3e8ed7ff2ede723a09c8
 passenger_apache2:793f7bbaac7a883d5f9ef1414260718e33958ae8
-pdns:bf14786602b43a15025275c1acf73a52eac9d577
 perl:bd6f978aea0ad7e65a8e6266951476b717a9a074
 php:f3f5db8d823db821ac696f7b52b2a613c1e2f167
 postfix:d7d149e7a7235b2733455e524d86e3a984b9b97c
-postgresql:cdeb1ccca7cfd5564706315a8d95986658b5c300
 powershell:4b175affe1a8a7d091a8ca905a580bf975af5edc
-pxe_dust:8f2e8ebd9f41086fe1033a613197da357aa075b5
-python:34cb929504f9972d9d0ce66cad70254d3ab36f21
-rabbitmq:b297e3137c37d3ed9a4e4fc17f9fc6a56e9a98f4
-radiant:5bc888a4dfa3cc5f397a196706434bae12ff61b3
-reprepro:30bc7be95a03f16dc042de3b5605a0e8b5153a4e
 resolver:105ad0a2fc9c065a7c4455cfc07ab7771b8e0da0
 rsync:41756f404fc39f3ce407cce9fe03294dd907c0fe
 rsyslog:8830d558d2ee3126fef56ea3a25a4f0253ce269f
-runit:378c918b78a7e5f0819211fc8bce034ee071dcc9
-samba:c68e51b0bfaf8770a3e89224858aa0a095dd725a
-sbuild:ce41bcfdf06baf35c6e0c254c6f39a823d350b05
-screen:ba61c6529958decb2ebcc133c198cf37b16b8aaa
-selinux:7a1b10b4f3191272c07bc3a8efcd7f50dda52d18
-snort:e829f5e2a8d7c5dd8799216371692b07fd6f636f
 sql_server:d9702f8fc29f208c9e712627cda64ccae2d71321
 sqlite:3efb50f4166f04f1afefa21f7f8fe7e9082b37ed
 ssh_known_hosts:a89f0c32e8e2c408a2e153153cc703f1184c6b72
 stompserver:bf81830bb7783f4198565201c825c23267e1d515
 subversion:cad4c069deca1fbbfb6b8f4d21b6c341cc9c6b55
 sudo:00d024f293afb9df4fea23ba127529d67c1daf14
-supervisor:83d4e59560cf35050819b12a6625b4c43753fbd3
-swift:73c8bf74330a07850645c9e2115596781681e6fc
 tftp:f4016b14eae2c0fe7fb48020bf28039c2de043a4
-thrift:f7e0f2ec87b1e7bf382870b785cf74973bdbc9f8
-tmux:d023930b19325d3366a12174f9df227a95ca5fcd
 tomcat:8934392833cef89b7b779b4cd36ad46d088b643b
-trac:7c5d613102701a88c51af80b9f492a9adc5c8f93
 transmission:c3d62aa4741a55b693630d9cc48b012ff22d2e7b
 ubuntu:7d21b626873ee397755d59aa222cf7fa681f6e90
-ucspi-tcp:6140c33bbffdce20c94409485de3f42de4861a09
 ufw:6bc6de62a84f6fa6f172edf0a490f1a332e89e29
 unicorn:bacbb2400dcb476dd53784aa965fa9329e8c3869
 users:c51c96afca83b382678dc21b8deb25677e6a3d8a
-varnish:359ce3329f576884815b4146dc889970c8908e40
 vim:88e8d018267d2cd5cfa3260ce55a0025f52dae6f
 webpi:6cb4fde9dedf2abc980fa49880753512baa26b23
 whitelist-node-attrs:2d76a2d179096e3ab048547d0d7849238ac2a5d3
 windows:1601558f5fce30bed47bfc6d458a80891e127c61
 wix:422b8da1dcf706bb4742d83abc44a649522afe83
-wordpress:e159cf1147107c7dffdccf676b8dda4faa507259
 xfs:7f1033820459324a863b2955e774cfa366fbc70f
 xml:0b538834aa26c4df5918aa193029d285d7b1d4de
 yum:b1191511b011790b2fc5c35cfbc78d0cc7bbc5b8
-zenoss:d2bbe7fc3d4fdade89b324ab856b156c0c3cf8cc
 zlib:45342f78d2866c3b2f443e693df562317e37963d
 zsh:3bff82836677564478ffc90dfb487ffc986702f3