puppet-lint-wmf_styleguide-check 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e71f6f797e858faf231fa273cb2aba57df48623a6e57cbd6089b030f1df2b49e
-  data.tar.gz: c206e2c526caadff5946d59bc772dd1ac3180587b4a79cdf9a2ba8ac87cb1cbf
+  metadata.gz: 02e709fa4e38aa92929077506d5cacdb8e3f17114bb75596224444f385f18aab
+  data.tar.gz: a392eead1036bdd3d1bcfd0546291d9c5f154b7a7b3797a30d0a8b7e70efa340
 SHA512:
-  metadata.gz: f79402564c3e8b07dfabbb434e0ffe781a97c366e52b8fe9e72c58e2a3da40dd1a5bb17ccf6b134897362f968a8dc105b825273575ffc6eb27a419a8fd9510c0
-  data.tar.gz: a2bd4bc48788639d2c8ec7795c39697a01e97510adf24b8a13050ece8672982d20f70b8efa6aa0188f61987c508804e8d4617cbe9718796c9ed10a10e7c611eb
+  metadata.gz: 51814c0df70fe7e80edff7c97bd89e9478a4dbc886ddff1d1bf82a536fa4a6a08759fce975826cc1d2fca0b100e3e66378f60ce07fb320cbc7536f6413b1dc8d
+  data.tar.gz: 18ad1c6221aca98d187ee93898d5aad4e820769a007e77332625bdbbb6418d47816b7002b89035e94f5b26daf3484f340b9f35b76ca6e443f378a6730c128b38

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

@@ -107,6 +107,11 @@ class PuppetResource
     @resource[:tokens].select(&:hiera?)
   end
 
+  def legacy_validate_calls
+    # Returns an array of all the tokens referencing calls to a stdlib legacy validate function
+    @resource[:tokens].select(&:legacy_validate?)
+  end
+
   def included_classes
     # Returns an array of all the classes included (with require/include)
     @resource[:tokens].map(&:included_class).compact
@@ -150,6 +155,11 @@ class PuppetLint
         function? && ['lookup'].include?(@value)
       end
 
+      def legacy_validate?
+        # A function calling one of the legacy stdlib validate functions
+        function? && @value.start_with?('validate_')
+      end
+
       def class_include?
         # Check for include-like objects
         @type == :NAME && ['include', 'require', 'contain'].include?(@value) && @next_code_token.type != :FARROW
@@ -274,6 +284,18 @@ def hiera_errors(tokens, klass)
   end
 end
 
+def legacy_validate_errors(klass)
+  # Helper for printing errors nicely
+  klass.legacy_validate_calls.each do |token|
+    msg = {
+      message: "wmf-style: Found legacy function (#{token.value}) call in #{klass.type} '#{klass.name}'",
+      line: token.line,
+      column: token.column
+    }
+    notify :error, msg
+  end
+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,
@@ -379,6 +401,7 @@ end
 
 def check_deprecations(resource)
   # Check the resource for declarations of deprecated defines
+  legacy_validate_errors resource
   deprecated_defines = ['base::service_unit']
   deprecated_defines.each do |deprecated|
     resource.resource?(deprecated).each do |token|

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

@@ -19,6 +19,8 @@ class foo($t=hiera('foo::title')) {
        notice($t)
        include ::passwords::redis
        class { 'bar': }
+       validate_foobar($param)
+       validate_re($param, '^.*$')
 }
 EOF
 
@@ -74,6 +76,8 @@ define_ko = <<-EOF
 define foo::fixme ($a=hiera('something')) {
        include ::foo
        class { '::bar': }
+       validate_foobar($param)
+       validate_re($param, '^.*$')
 }
 EOF
 
@@ -131,6 +135,10 @@ describe 'wmf_styleguide' do
       expect(problems).to contain_error("wmf-style: class 'foo' includes passwords::redis from another module").on_line(5).in_column(16)
       expect(problems).to contain_error("wmf-style: class 'foo' declares class bar from another module").on_line(6).in_column(16)
     end
+    it 'should create errors for validate_function' do
+      expect(problems).to contain_error("wmf-style: Found legacy function (validate_foobar) call in class 'foo'").on_line(7).in_column(8)
+      expect(problems).to contain_error("wmf-style: Found legacy function (validate_re) call in class 'foo'").on_line(8).in_column(8)
+    end
   end
 
   context 'profile with errors' do
@@ -172,6 +180,10 @@ describe 'wmf_styleguide' do
     it 'should not include or define any class' do
       expect(problems).to contain_error("wmf-style: defined type 'foo::fixme' declares class bar from another module").on_line(3)
     end
+    it 'should create errors for validate_function' do
+      expect(problems).to contain_error("wmf-style: Found legacy function (validate_foobar) call in defined type 'foo::fixme'").on_line(4).in_column(8)
+      expect(problems).to contain_error("wmf-style: Found legacy function (validate_re) call in defined type 'foo::fixme'").on_line(5).in_column(8)
+    end
   end
 
   context 'node with no errors' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-wmf_styleguide-check
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
 platform: ruby
 authors:
 - Giuseppe Lavagetto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,7 @@ description: |2
       * Check for cross-module class inclusion
       * Check for the use of the include keyword in profiles
       * Check for wmf-deprecated resources usage
+      * Check for deprecated validate_* functions
 email: lavagetto@gmail.com
 executables: []
 extensions: []
@@ -148,8 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A puppet-lint plugin to check code adheres to the WMF coding guidelines