puppet-lint-wmf_styleguide-check 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 841557991f772264b442e532575961497bd111672ae7b189429039dd238f7c87
-  data.tar.gz: bda8b8d669e285f045f4f5074c111d4c507ebf4b1e4c125cbb5b61c789c055ac
+  metadata.gz: e71f6f797e858faf231fa273cb2aba57df48623a6e57cbd6089b030f1df2b49e
+  data.tar.gz: c206e2c526caadff5946d59bc772dd1ac3180587b4a79cdf9a2ba8ac87cb1cbf
 SHA512:
-  metadata.gz: 0b1d6a0c2718108fb86a2275789643ce26fa757cb7cd009d258f1bc23cc7d05bd7c0383a97c105149c3528b3b6f15ecbff35853ad9b04622d5f811b96fb5cc6e
-  data.tar.gz: 414bd06e086fce65860ec383886c954b7eb3e16b9ff2c4fbdce4ef431e855e4ced465ef127eda8dc113cd432085e6125fbb2b0a543b8c47d81b919f11292b683
+  metadata.gz: f79402564c3e8b07dfabbb434e0ffe781a97c366e52b8fe9e72c58e2a3da40dd1a5bb17ccf6b134897362f968a8dc105b825273575ffc6eb27a419a8fd9510c0
+  data.tar.gz: a2bd4bc48788639d2c8ec7795c39697a01e97510adf24b8a13050ece8672982d20f70b8efa6aa0188f61987c508804e8d4617cbe9718796c9ed10a10e7c611eb

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

@@ -145,9 +145,14 @@ class PuppetLint
         function? && ['hiera', 'hiera_array', 'hiera_hash', 'lookup'].include?(@value)
       end
 
+      def lookup?
+        # A function call specifically calling lookup
+        function? && ['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
+        # Check for include-like objects
+        @type == :NAME && ['include', 'require', 'contain'].include?(@value) && @next_code_token.type != :FARROW
       end
 
       def included_class
@@ -184,7 +189,7 @@ end
 # Checks and functions
 def check_profile(klass)
   # All parameters of profiles should have a default value that is a hiera lookup
-  params_without_hiera_defaults klass
+  params_without_lookup_defaults klass
   # All hiera lookups should be in parameters
   hiera_not_in_params klass
   # Only a few selected classes should be included in a profile
@@ -228,16 +233,18 @@ def hiera(klass)
   hiera_errors(klass.hiera_calls, klass)
 end
 
-def params_without_hiera_defaults(klass)
+def params_without_lookup_defaults(klass)
   # Finds parameters that have no hiera-defined default value.
   klass.params.each do |name, data|
-    next unless data[:value].select(&:hiera?).empty?
+    next unless data[:value].select(&:lookup?).empty?
+    common = "wmf-style: Parameter '#{name}' of class '#{klass.name}'"
+    message = if data[:value].select(&:hiera?).empty?
+                "#{common} has no call to lookup"
+              else
+                "#{common}: hiera is deprecated use lookup"
+              end
     token = data[:param]
-    msg = {
-      message: "wmf-style: Parameter '#{name}' of class '#{klass.name}' has no call to hiera",
-      line: token.line,
-      column: token.column
-    }
+    msg = { message: message, line: token.line, column: token.column }
     notify :error, msg
   end
 end
@@ -304,8 +311,8 @@ 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']
+  # Checks that a role only includes other roles and profiles
+  modules_include_ok = ['role', 'profile']
   klass.included_classes.each do |token|
     class_name = token.value.gsub(/^::/, '')
     module_name = class_name.split('::')[0]

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

@@ -24,8 +24,7 @@ EOF
 
 profile_ok = <<-EOF
 class profile::foobar (
-      $test=hiera('profile::foobar::test'),
-      $foo=hiera_array('profile::foobar::foo')
+      $test=lookup('profile::foobar::test'),
 ) {
       require ::profile::foo
       include ::passwords::redis
@@ -35,7 +34,10 @@ EOF
 
 profile_ko = <<-EOF
 class profile::fixme (
-      $test,
+      $test1,
+      $test2=hiera('profile::foobar::foo')
+      $test3=hiera_array('profile::foobar::foo')
+      $test4=hiera_hash('profile::foobar::foo')
 ) {
     include ::apache2::common
     $role = hiera('role')
@@ -45,7 +47,6 @@ EOF
 
 role_ok = <<-EOF
 class role::fizzbuz {
-      include standard
       include ::profile::base
       include ::profile::bar
       system::role { 'fizzbuzz': }
@@ -135,16 +136,19 @@ describe 'wmf_styleguide' do
   context 'profile with errors' do
     let(:code) { profile_ko }
     it 'should create errors for parameters without hiera defaults' do
-      expect(problems).to contain_error("wmf-style: Parameter 'test' of class 'profile::fixme' has no call to hiera").on_line(2).in_column(7)
+      expect(problems).to contain_error("wmf-style: Parameter 'test1' of class 'profile::fixme' has no call to lookup").on_line(2).in_column(7)
+      expect(problems).to contain_error("wmf-style: Parameter 'test2' of class 'profile::fixme': hiera is deprecated use lookup").on_line(3).in_column(7)
+      expect(problems).to contain_error("wmf-style: Parameter 'test3' of class 'profile::fixme': hiera is deprecated use lookup").on_line(4).in_column(7)
+      expect(problems).to contain_error("wmf-style: Parameter 'test4' of class 'profile::fixme': hiera is deprecated use lookup").on_line(5).in_column(7)
     end
     it 'should create errors for hiera calls in body' do
-      expect(problems).to contain_error("wmf-style: Found hiera call in class 'profile::fixme' for 'role'").on_line(5).in_column(13)
+      expect(problems).to contain_error("wmf-style: Found hiera call in class 'profile::fixme' for 'role'").on_line(8).in_column(13)
     end
     it 'should create errors for use of system::role' do
-      expect(problems).to contain_error("wmf-style: class 'profile::fixme' declares system::role, which should only be used in roles").on_line(6).in_column(5)
+      expect(problems).to contain_error("wmf-style: class 'profile::fixme' declares system::role, which should only be used in roles").on_line(9).in_column(5)
     end
     it 'should create errors for non-explicit class inclusion' do
-      expect(problems).to contain_error("wmf-style: profile 'profile::fixme' includes non-profile class apache2::common").on_line(4).in_column(13)
+      expect(problems).to contain_error("wmf-style: profile 'profile::fixme' includes non-profile class apache2::common").on_line(7).in_column(13)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-wmf_styleguide-check
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Giuseppe Lavagetto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2020-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -155,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: A puppet-lint plugin to check code adheres to the WMF coding guidelines