puppet-lint-wmf_styleguide-check 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 827734026504a15ef6e6c2e3003499a467f3a222
-  data.tar.gz: ba471ad1f7f634ca080cc5c0a1d93e9877343420
+  metadata.gz: 9c6f25a5336a67bced26bf736edb5f6281848cf3
+  data.tar.gz: 2a94fc2862a3784a34c94423d30339860bd90268
 SHA512:
-  metadata.gz: 4460a00a245dbfad6e9105287f76479e7182ade5a47bf6f12a0804983a55cbaee7db026c6cd765e31279f211c8d12a09f4576042c56d6ffdc4f0bafadd268fd4
-  data.tar.gz: 6877ce5a41f58aa4055fd01b0cdbb151cdf0620fd5336c419e4e1c6c7dcbd16a70c7adea13ca0c992f8b080ba3f5284d8edb39be11c29b6621dcd2ed6bd37a51
+  metadata.gz: 4d97adb3bec7f26f5d8c4d1ff141c001ab65d96ca7e399ccc9c7f958bed52efe982fa0daf06a3b8b9f05204152675d6f736ffe46bd49c5e16dc8c35f0f1bb826
+  data.tar.gz: c9390bc0b776df8b3c578a5654cb0b597dce8a3287406a8097a01cdcb05fbbd50ba9a6afc143fcd7052c079c45174ee477e0313586b5259a6f7f7ba6ea6c50af

data/lib/puppet-lint/plugins/check_wmf_styleguide.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 # Class to manage puppet resources.
+# See how we extend PuppetLint::Lexer::Token below to understand how we filter
+# tokens within a parsed resource.
 class PuppetResource
   attr_accessor :profile_module, :role_module
 
@@ -49,63 +53,79 @@ class PuppetResource
   # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
 
   def params
+    # Lazy-load and return all the parameters of the resource
     @params || parse_params
   end
 
   def profile_module
+    # Return the name of the module where profiles are located
     @profile_module || 'profile'
   end
 
   def role_module
+    # Return the name of the module where roles are located
     @role_module || 'role'
   end
 
   def class?
+    # True if this is a class,
     @resource[:type] == :CLASS
   end
 
   def name
+    # Extract a normalized resource name (without the :: prefix if present)
     @resource[:name_token].value.gsub(/^::/, '')
   end
 
   def path
+    # Path of the resource
     @resource[:path]
   end
 
   def filename
-    puts @resource
+    # File name of the resource
     @resource[:filename]
   end
 
   def module_name
+    # Module containing this resource
     name.split('::')[0]
   end
 
   def profile?
+    # True if the resource is in the profile module
     class? && (module_name == profile_module)
   end
 
   def role?
+    # True if the resource is in the role module
     class? && (module_name == role_module)
   end
 
   def hiera_calls
+    # Returns an array of all the tokens referencing calls to hiera
     @resource[:tokens].select(&:hiera?)
   end
 
   def included_classes
+    # Returns an array of all the classes included (with require/include)
     @resource[:tokens].map(&:included_class).compact
   end
 
   def declared_classes
+    # Returns an array of all the declared classes
     @resource[:tokens].map(&:declared_class).compact
   end
 
   def declared_resources
+    # Returns an array of all the declared classes
     @resource[:tokens].select(&:declared_type?)
   end
 
   def resource?(name)
+    # Arguments:
+    #   name (string) Name of the resource we want to search
+    # Returns an array of all the defines of the specified resource
     @resource[:tokens].select { |t| t.declared_type? && t.value.gsub(/^::/, '') == name }
   end
 end
@@ -116,18 +136,22 @@ class PuppetLint
     class Token
       # Extend the basic token with utility functions
       def function?
+        # A function is something that has a name and is followed by a left parens
         @type == :NAME && @next_code_token.type == :LPAREN
       end
 
       def hiera?
-        function? && @value == 'hiera'
+        # A function call specifically calling hiera
+        function? && ['hiera', 'hiera_array', 'hiera_hash', 'lookup'].include?(@value)
       end
 
       def class_include?
+        # Object is either "include" or "require", and the next token is not a =>
         @type == :NAME && ['include', 'require'].include?(@value) && @next_code_token.type != :FARROW
       end
 
       def included_class
+        # Fetch the token describing the included class
         return unless class_include?
         return @next_code_token.next_code_token if @next_code_token.type == :LPAREN
         @next_code_token
@@ -141,6 +165,7 @@ class PuppetLint
       end
 
       def declared_type?
+        # The token is a name and the next token is a {, while the previous one is not "class"
         @type == :NAME && @next_code_token.type == :LBRACE && @prev_code_token.type != :CLASS
       end
 
@@ -149,6 +174,7 @@ class PuppetLint
       end
 
       def role_keyword?
+        # This is a function with name "role"
         @type == :NAME && @value = 'role' && @next_code_token.type == :LPAREN
       end
     end
@@ -198,6 +224,7 @@ def check_define(define)
 end
 
 def hiera(klass)
+  # Searches for hiera calls inside classes and defines.
   hiera_errors(klass.hiera_calls, klass)
 end
 
@@ -216,6 +243,9 @@ def params_without_hiera_defaults(klass)
 end
 
 def hiera_not_in_params(klass)
+  # Checks if a hiera call is not in a parameter declaration. Used to check profiles
+
+  # Any hiera call that is not inside a parameter declaration is a violation
   tokens = klass.hiera_calls.reject do |token|
     maybe_param = token.prev_code_token.prev_code_token
     klass.params.keys.include?(maybe_param.value)
@@ -224,7 +254,9 @@ def hiera_not_in_params(klass)
 end
 
 def hiera_errors(tokens, klass)
+  # Helper for printing hiera errors nicely
   tokens.each do |token|
+    # hiera ( 'some::label' )
     value = token.next_code_token.next_code_token.value
     msg = {
       message: "wmf-style: Found hiera call in #{klass.type} '#{klass.name}' for '#{value}'",
@@ -236,6 +268,9 @@ def hiera_errors(tokens, klass)
 end
 
 def profile_illegal_include(klass)
+  # Check if a profile includes any class that's not allowed there.
+  # Allowed are: any other profile, or a class from the passwords module,
+  # plus a couple parameter classes
   modules_include_ok = ['profile', 'passwords']
   classes_include_ok = ['lvs::configuration', 'network::constants']
   klass.included_classes.each do |token|
@@ -253,6 +288,7 @@ def profile_illegal_include(klass)
 end
 
 def class_illegal_include(klass)
+  # A class should only include classes from the same module.
   modules_include_ok = [klass.module_name]
   klass.included_classes.each do |token|
     class_name = token.value.gsub(/^::/, '')
@@ -268,6 +304,7 @@ def class_illegal_include(klass)
 end
 
 def include_not_profile(klass)
+  # Checks that a role only includes other roles, profiles and/or the special class "standard"
   modules_include_ok = ['role', 'profile', 'standard']
   klass.included_classes.each do |token|
     class_name = token.value.gsub(/^::/, '')
@@ -312,6 +349,7 @@ def check_no_system_role(klass)
 end
 
 def check_system_role(klass)
+  # Check that a role does indeed declare system::role
   return if klass.resource?('system::role').length == 1
   msg = {
     message: "wmf-style: role '#{klass.name}' should declare system::role once",
@@ -322,6 +360,7 @@ def check_system_role(klass)
 end
 
 def check_no_defines(klass)
+  # In a role, check if there is any define apart from one system::role call
   return if klass.declared_resources == klass.resource?('system::role')
   msg = {
     message: "wmf-style: role '#{klass.name}' should not include defines",
@@ -331,6 +370,21 @@ def check_no_defines(klass)
   notify :error, msg
 end
 
+def check_deprecations(resource)
+  # Check the resource for declarations of deprecated defines
+  deprecated_defines = ['base::service_unit']
+  deprecated_defines.each do |deprecated|
+    resource.resource?(deprecated).each do |token|
+      msg = {
+        message: "wmf-style: '#{resource.name}' should not include the deprecated define '#{token.value}'",
+        line: token.line,
+        column: token.column
+      }
+      notify :error, msg
+    end
+  end
+end
+
 # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/AbcSize, Metrics/CyclomaticComplexity
 def check_node(node)
   title = node[:title_tokens].map(&:value).join(', ')
@@ -355,7 +409,7 @@ def check_node(node)
         line: token.line,
         column: token.column
       }
-    elsif token.declared_type?
+    elsif token.declared_type? && token.value != 'interface::add_ip6_mapped'
       msg = {
         message: "wmf-style: node '#{title}' declares #{token.value}",
         line: token.line,
@@ -420,6 +474,7 @@ PuppetLint.new_check(:wmf_styleguide) do
       else
         check_class klass
       end
+      check_deprecations klass
     end
   end
 
@@ -428,6 +483,7 @@ PuppetLint.new_check(:wmf_styleguide) do
     defined_type_indexes.each do |df|
       define = PuppetResource.new(df)
       check_define define
+      check_deprecations define
     end
     node_indexes.each do |node|
       check_node node

data/spec/puppet-lint/plugins/check_wmf_styleguide_check_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 class_ok = <<-EOF
@@ -21,7 +23,10 @@ class foo($t=hiera('foo::title')) {
 EOF
 
 profile_ok = <<-EOF
-class profile::foobar ($test=hiera('profile::foobar::test')) {
+class profile::foobar (
+      $test=hiera('profile::foobar::test'),
+      $foo=hiera_array('profile::foobar::foo')
+) {
       require ::profile::foo
       include ::passwords::redis
       class { '::bar': }
@@ -88,6 +93,12 @@ node 'fixme' {
 }
 EOF
 
+deprecation_ko = <<-EOF
+define test() {
+   base::service_unit{ 'test2': }
+}
+EOF
+
 describe 'wmf_styleguide' do
   context 'class correctly written' do
     let(:code) { class_ok }
@@ -177,4 +188,11 @@ describe 'wmf_styleguide' do
       expect(problems).to contain_error("wmf-style: node 'fixme' declares interface::mapped")
     end
   end
+
+  context 'defined type with deprecations' do
+    let(:code) { deprecation_ko }
+    it 'should not' do
+      expect(problems).to contain_error("wmf-style: 'test' should not include the deprecated define 'base::service_unit'")
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet-lint'
 
 PuppetLint::Plugins.load_spec_helper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-wmf_styleguide-check
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Giuseppe Lavagetto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2018-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +84,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -118,6 +118,7 @@ description: |2
       * Check for system::role calls outside of roles
       * Check for cross-module class inclusion
       * Check for the use of the include keyword in profiles
+      * Check for wmf-deprecated resources usage
 email: lavagetto@gmail.com
 executables: []
 extensions: []
@@ -128,7 +129,7 @@ files:
 - lib/puppet-lint/plugins/check_wmf_styleguide.rb
 - spec/puppet-lint/plugins/check_wmf_styleguide_check_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/wikimedia/operations-puppet-lint-wmf_styleguide-check
+homepage: https://github.com/lavagetto/puppet-lint-wmf_styleguide-check
 licenses:
 - GPL-3.0
 metadata: {}
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A puppet-lint plugin to check code adheres to the WMF coding guidelines