daptiv-foodcritic-rules 0.0.1

data/lib/foodcritic/rules/rules.rb

@@ -0,0 +1,168 @@
+#
+# Author:: Seth Vargo <sethvargo@gmail.com>
+# Foodcritic:: Rules
+#
+# Copyright 2012, Seth Vargo, CustomInk, LLC
+#
+# 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.
+
+
+rule 'CINK001', 'Missing CHANGELOG in markdown format' do
+  tags %w{style changelog}
+  cookbook do |path|
+    filepath = File.join(path, 'CHANGELOG.md')
+    unless File.exists?(filepath)
+      [ file_match(filepath) ]
+    end
+  end
+end
+
+rule 'CINK002', 'Prefer single-quoted strings' do
+  tags %w{style strings}
+  cookbook do |path|
+    recipes = Dir["#{path}/**/*.rb"]
+    recipes.collect do |recipe|
+      lines = File.readlines(recipe)
+
+      lines.collect.with_index do |line, index|
+        # Don't flag if there is a #{} or ' in the line
+        if line.match('"(.*)"') && !line.match('\A\s?#') && !line.match('\'(.*)"(.*)"(.*)\'') && !line.match('"(.*)(#{.+}|\'|\\\a|\\\b|\\\r|\\\n|\\\s|\\\t)(.*)"')
+          {
+            :filename => recipe,
+            :matched => recipe,
+            :line => index + 1,
+            :column => 0
+          }
+        end
+      end.compact
+    end.flatten
+  end
+end
+
+# The message was changed from the original message.
+rule 'CINK003', 'Don\'t hardcode user or group' do
+  tags %w{bug}
+  cookbook do |path|
+    recipes = Dir["#{path}/**/*.rb"]
+    recipes.collect do |recipe|
+      lines = File.readlines(recipe)
+
+      lines.collect.with_index do |line, index|
+        if line.match('(group|owner)\s+[\\\'\"](apache|www-data|http|www)[\\\'\"]')
+          {
+            :filename => recipe,
+            :matched => recipe,
+            :line => index+1,
+            :column => 0
+          }
+        end
+      end.compact
+    end.flatten
+  end
+end
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+#Etsy Foodcritic rules
+@coreservices = ["httpd", "mysql", "memcached", "postgresql-server"]
+@coreservicepackages = ["httpd", "Percona-Server-server-51", "memcached", "postgresql-server"]
+@corecommands = ["yum -y", "yum install", "yum reinstall", "yum remove", "mkdir", "useradd", "usermod", "touch"]
+
+rule "ETSY001", "Package or yum_package resource used with :upgrade action" do
+  tags %w{correctness recipe etsy}
+  recipe do |ast|
+    pres = find_resources(ast, :type => 'package').find_all do |cmd|
+      cmd_str = (resource_attribute(cmd, 'action') || resource_name(cmd)).to_s
+      cmd_str.include?('upgrade')
+    end
+    ypres = find_resources(ast, :type => 'yum_package').find_all do |cmd|
+      cmd_str = (resource_attribute(cmd, 'action') || resource_name(cmd)).to_s
+      cmd_str.include?('upgrade')
+    end
+    pres.concat(ypres).map{|cmd| match(cmd)}
+  end
+end
+
+#ETSY002 and ETSY003 removed as they were added to mainline foodcritic as FC040 and FC041
+
+# This rule does not detect execute resources defined inside a conditional, as foodcritic rule FC023 (Prefer conditional attributes)
+# already provides this. It's recommended to use both rules in conjunction. (foodcritic -t etsy,FC023)
+rule "ETSY004", "Execute resource defined without conditional or action :nothing" do
+  tags %w{style recipe etsy}
+  recipe do |ast,filename|
+    pres = find_resources(ast, :type => 'execute').find_all do |cmd|
+      cmd_actions = (resource_attribute(cmd, 'action') || resource_name(cmd)).to_s
+      condition = cmd.xpath('//ident[@value="only_if" or @value="not_if" or @value="creates"][parent::fcall or parent::command or ancestor::if]')
+      (condition.empty? && !cmd_actions.include?("nothing"))
+    end.map{|cmd| match(cmd)}
+  end
+end
+
+rule "ETSY005", "Action :restart sent to a core service" do
+  tags %w{style recipe etsy}
+  recipe do |ast, filename|
+    find_resources(ast).select do |resource|
+      notifications(resource).any? do |notification|
+        @coreservices.include?(notification[:resource_name]) and
+            notification[:action] == :restart
+      end
+    end
+  end
+end
+
+rule "ETSY006", "Execute resource used to run chef-provided command" do
+  tags %w{style recipe etsy}
+  recipe do |ast|
+    find_resources(ast, :type => 'execute').find_all do |cmd|
+      cmd_str = (resource_attribute(cmd, 'command') || resource_name(cmd)).to_s
+      @corecommands.any? { |corecommand| cmd_str.include? corecommand }
+    end.map{|c| match(c)}
+  end
+end
+
+
+rule "ETSY007", "Package or yum_package resource used to install core package without specific version number" do
+  tags %w{style recipe etsy}
+  recipe do |ast,filename|
+    pres = find_resources(ast, :type => 'package').find_all do |cmd|
+      cmd_str = (resource_attribute(cmd, 'version') || resource_name(cmd)).to_s
+      cmd_action = (resource_attribute(cmd, 'action') || resource_name(cmd)).to_s
+      cmd_str == resource_name(cmd) && @coreservicepackages.any? { |svc| resource_name(cmd) == svc } && cmd_action.include?('install')
+    end
+    ypres = find_resources(ast, :type => 'yum_package').find_all do |cmd|
+      cmd_str = (resource_attribute(cmd, 'version') || resource_name(cmd)).to_s
+      cmd_action = (resource_attribute(cmd, 'action') || resource_name(cmd)).to_s
+      cmd_str == resource_name(cmd) && @coreservicepackages.any? { |svc| resource_name(cmd) == svc } && cmd_action.include?('install')
+    end
+    pres.concat(ypres).map{|cmd| match(cmd)}
+  end
+end
+
+#######################################################################################################################
+# Daptiv Rules
+
+rule 'DAPTIV001', 'Missing .tailor file. All cookbooks should comply with style recommendations.' do
+  tags %w{style tailor}
+  cookbook do |path|
+    filepath = File.join(path, '.tailor')
+    unless File.exists?(filepath)
+      [ file_match(filepath) ]
+    end
+  end
+end
+
+rule 'DAPTIV002', 'Prefer include_attribute syntax to require_relative.' do
+  recipe do |ast|
+    ast.xpath('//command[ident/@value="require_relative"]')
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: daptiv-foodcritic-rules
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Shawn Neal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: foodcritic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Daptiv Foodcritic 2.2 and greater rules for Chef 11 and greater
+email:
+- sneal@daptiv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/foodcritic/rules/rules.rb
+homepage: https://github.com/daptiv/foodcritic_rules
+licenses:
+- APACHE2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Daptiv Foodcritic rules for Chef
+test_files: []