puppet-lint-wmf_styleguide-check 1.0.7 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02e709fa4e38aa92929077506d5cacdb8e3f17114bb75596224444f385f18aab
-  data.tar.gz: a392eead1036bdd3d1bcfd0546291d9c5f154b7a7b3797a30d0a8b7e70efa340
+  metadata.gz: 899c8c3526bd03b42700fe80c845fc590fc60876ef10410e1216fcab6e4ac7e5
+  data.tar.gz: 4ed16c3cff59cfa2c72b6dca1af26210daca111ff92e984c999087acd5c44b62
 SHA512:
-  metadata.gz: 51814c0df70fe7e80edff7c97bd89e9478a4dbc886ddff1d1bf82a536fa4a6a08759fce975826cc1d2fca0b100e3e66378f60ce07fb320cbc7536f6413b1dc8d
-  data.tar.gz: 18ad1c6221aca98d187ee93898d5aad4e820769a007e77332625bdbbb6418d47816b7002b89035e94f5b26daf3484f340b9f35b76ca6e443f378a6730c128b38
+  metadata.gz: b550d1bf27ecffec3b069cf131367232a0b65dc8da3c6296054aa6d1c634b655bd291cece4bf6c71fbb4a2e41939f6455c86a8a594e36d1fe486178f24eec3b8
+  data.tar.gz: d0641b8fd0fe54e5430a1fab4f5e0b40d24d97243ceed0d8195d9faeaa2c57700b91597af050c962b959aed2c0fba6edb4600badc66286d91440df31a57e9110

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

@@ -102,9 +102,14 @@ class PuppetResource
     class? && (module_name == role_module)
   end
 
-  def hiera_calls
+  def lookup_calls
+    # Returns an array of all the tokens referencing calls to lookup
+    @resource[:tokens].select(&:lookup?)
+  end
+
+  def legacy_hiera_calls
     # Returns an array of all the tokens referencing calls to hiera
-    @resource[:tokens].select(&:hiera?)
+    @resource[:tokens].select(&:legacy_hiera?)
   end
 
   def legacy_validate_calls
@@ -145,9 +150,9 @@ class PuppetLint
         [:NAME, :FUNCTION_NAME].include?(@type) && @next_code_token.type == :LPAREN
       end
 
-      def hiera?
-        # A function call specifically calling hiera
-        function? && ['hiera', 'hiera_array', 'hiera_hash', 'lookup'].include?(@value)
+      def legacy_hiera?
+        # Using old hiera call
+        function? && ['hiera', 'hiera_array', 'hiera_hash'].include?(@value)
       end
 
       def lookup?
@@ -198,10 +203,10 @@ end
 
 # Checks and functions
 def check_profile(klass)
-  # All parameters of profiles should have a default value that is a hiera lookup
+  # All parameters of profiles should have a default value that is a lookup
   params_without_lookup_defaults klass
-  # All hiera lookups should be in parameters
-  hiera_not_in_params klass
+  # All lookup lookups should be in parameters
+  lookup_not_in_params klass
   # Only a few selected classes should be included in a profile
   profile_illegal_include klass
   # System::role only goes in roles
@@ -210,7 +215,7 @@ end
 
 def check_role(klass)
   # Hiera lookups within a role are forbidden
-  hiera klass
+  lookup klass
   # A role should only include profiles
   include_not_profile klass
   # A call, and only one, to system::role will be done
@@ -220,8 +225,8 @@ def check_role(klass)
 end
 
 def check_class(klass)
-  # No hiera lookups allowed in a class.
-  hiera klass
+  # No lookup lookups allowed in a class.
+  lookup klass
   # Cannot include or declare classes from other modules
   class_illegal_include klass
   illegal_class_declaration klass
@@ -230,28 +235,42 @@ def check_class(klass)
 end
 
 def check_define(define)
-  # No hiera calls are admitted in defines. ever.
-  hiera define
+  # No lookup calls are admitted in defines. ever.
+  lookup define
   # No class can be included in defines, like in classes
   class_illegal_include define
   # Non-profile defines should respect the rules for classes
   illegal_class_declaration define unless define.module_name == 'profile'
 end
 
-def hiera(klass)
-  # Searches for hiera calls inside classes and defines.
-  hiera_errors(klass.hiera_calls, klass)
+def lookup(klass)
+  # Searches for lookup calls inside classes and defines.
+  lookup_errors(klass.lookup_calls, klass)
+end
+
+def legacy_hiera(klass)
+  # No calls to legacy hiera
+  tokens = klass.legacy_hiera_calls
+  tokens.each do |token|
+    msg = {
+      message: "wmf-style: Found deprecated function (#{token.value}) " \
+               "in #{klass.type} '#{klass.name}', use lookup instead",
+      line: token.line,
+      column: token.column
+    }
+    notify :error, msg
+  end
 end
 
 def params_without_lookup_defaults(klass)
-  # Finds parameters that have no hiera-defined default value.
+  # Finds parameters that have no lookup-defined default value.
   klass.params.each do |name, data|
     next unless data[:value].select(&:lookup?).empty?
     common = "wmf-style: Parameter '#{name}' of class '#{klass.name}'"
-    message = if data[:value].select(&:hiera?).empty?
+    message = if data[:value].select(&:legacy_hiera?).empty?
                 "#{common} has no call to lookup"
               else
-                "#{common}: hiera is deprecated use lookup"
+                "#{common} hiera is deprecated use lookup"
               end
     token = data[:param]
     msg = { message: message, line: token.line, column: token.column }
@@ -259,24 +278,24 @@ def params_without_lookup_defaults(klass)
   end
 end
 
-def hiera_not_in_params(klass)
-  # Checks if a hiera call is not in a parameter declaration. Used to check profiles
+def lookup_not_in_params(klass)
+  # Checks if a lookup 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|
+  # Any lookup call that is not inside a parameter declaration is a violation
+  tokens = klass.lookup_calls.reject do |token|
     maybe_param = token.prev_code_token.prev_code_token
     klass.params.keys.include?(maybe_param.value)
   end
-  hiera_errors(tokens, klass)
+  lookup_errors(tokens, klass)
 end
 
-def hiera_errors(tokens, klass)
-  # Helper for printing hiera errors nicely
+def lookup_errors(tokens, klass)
+  # Helper for printing lookup errors nicely
   tokens.each do |token|
-    # hiera ( 'some::label' )
+    # lookup ( '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}'",
+      message: "wmf-style: Found lookup call in #{klass.type} '#{klass.name}' for '#{value}'",
       line: token.line,
       column: token.column
     }
@@ -402,6 +421,7 @@ end
 def check_deprecations(resource)
   # Check the resource for declarations of deprecated defines
   legacy_validate_errors resource
+  legacy_hiera resource
   deprecated_defines = ['base::service_unit']
   deprecated_defines.each do |deprecated|
     resource.resource?(deprecated).each do |token|
@@ -420,13 +440,18 @@ def check_node(node)
   title = node[:title_tokens].map(&:value).join(', ')
   node[:tokens].each do |token|
     msg = nil
-    if token.hiera?
+    if token.lookup?
       msg = {
-        message: "wmf-style: Found hiera call in node '#{title}'",
+        message: "wmf-style: node '#{title}' calls lookup function",
+        line: token.line,
+        column: token.column
+      }
+    elsif token.legacy_hiera?
+      msg = {
+        message: "wmf-style: node '#{title}' calls legacy #{token.value} function",
         line: token.line,
         column: token.column
       }
-
     elsif token.class_include?
       msg = {
         message: "wmf-style: node '#{title}' includes class #{token.included_class.value}",
@@ -445,12 +470,6 @@ def check_node(node)
         line: token.line,
         column: token.column
       }
-    elsif token.role_keyword? && token.next_code_token.next_code_token.next_code_token.type != :RPAREN
-      msg = {
-        message: "wmf-style: node '#{title}' includes multiple roles",
-        line: token.line,
-        column: token.column
-      }
     end
     notify :error, msg if msg
   end
@@ -474,6 +493,15 @@ PuppetLint.new_check(:wmf_styleguide) do
       # If we're not within a node definition, skip this token
       next unless in_node_def
       case token.type
+      when :REGEX
+        if !token.value.start_with?('^') || !token.value.end_with?('$')
+          msg = {
+            message: "wmf-style: regex node matching must match the whole string (^...$), got: #{token.value}",
+            line: token.line,
+            column: token.column
+          }
+          notify :error, msg
+        end
       when :LBRACE
         title_tokens = tokens[start + 1..(i - 1)].select(&:node_def?) if braces_level.zero?
         braces_level += 1

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

@@ -14,13 +14,16 @@ EOF
 
 class_ko = <<-EOF
 class foo($t=hiera('foo::title')) {
-       $msg = hiera( "foo::bar")
+       $msg = lookup( "foo::bar")
        notice($msg)
        notice($t)
        include ::passwords::redis
        class { 'bar': }
        validate_foobar($param)
        validate_re($param, '^.*$')
+       hiera('foobar')
+       hiera_hash('foobar')
+       hiera_array('foobar')
 }
 EOF
 
@@ -42,7 +45,7 @@ class profile::fixme (
       $test4=hiera_hash('profile::foobar::foo')
 ) {
     include ::apache2::common
-    $role = hiera('role')
+    $role = lookup('role')
     system::role { $role: }
 }
 EOF
@@ -78,23 +81,46 @@ define foo::fixme ($a=hiera('something')) {
        class { '::bar': }
        validate_foobar($param)
        validate_re($param, '^.*$')
+       hiera('foobar')
+       hiera_hash('foobar')
+       hiera_array('foobar')
 }
 EOF
 
 node_ok = <<-EOF
-node /^test1.*\.example\.com$/ {
+node /^test1.*\\.example\\.com$/ {
      role(spare::system)
 }
 EOF
 
 node_ko = <<-EOF
 node 'fixme' {
-     role(spare::system,
-          mediawiki::appserver)
      include base::firewall
      interface::mapped { 'eth0':
         foo => 'bar'
      }
+     lookup('foobar')
+     hiera('foobar')
+     hiera_array('foobar')
+     hiera_hash('foobar')
+}
+EOF
+
+node_regex_missing_start = <<-EOF
+node /test1.*\\.example\\.com$/ {
+     role(spare::system)
+}
+EOF
+
+node_regex_missing_end = <<-EOF
+node /^test1.*\\.example\\.com/ {
+     role(spare::system)
+}
+EOF
+
+node_regex_missing_both = <<-EOF
+node /test1.*\\.example\\.com/ {
+     role(spare::system)
 }
 EOF
 
@@ -128,8 +154,8 @@ describe 'wmf_styleguide' do
   context 'class with errors' do
     let(:code) { class_ko }
     it 'should create errors for hiera declarations' do
-      expect(problems).to contain_error("wmf-style: Found hiera call in class 'foo' for 'foo::title'").on_line(1).in_column(14)
-      expect(problems).to contain_error("wmf-style: Found hiera call in class 'foo' for 'foo::bar'").on_line(2).in_column(15)
+      expect(problems).to contain_error("wmf-style: Found deprecated function (hiera) in class 'foo', use lookup instead").on_line(1).in_column(14)
+      expect(problems).to contain_error("wmf-style: Found lookup call in class 'foo' for 'foo::bar'").on_line(2).in_column(15)
     end
     it 'should create errors for included classes' do
       expect(problems).to contain_error("wmf-style: class 'foo' includes passwords::redis from another module").on_line(5).in_column(16)
@@ -139,18 +165,27 @@ describe 'wmf_styleguide' 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
+    it 'should create errors for hiera function' do
+      expect(problems).to contain_error("wmf-style: Found deprecated function (hiera) in class 'foo', use lookup instead").on_line(9).in_column(8)
+    end
+    it 'should create errors for hiera_hash function' do
+      expect(problems).to contain_error("wmf-style: Found deprecated function (hiera_hash) in class 'foo', use lookup instead").on_line(10).in_column(8)
+    end
+    it 'should create errors for hiera_array function' do
+      expect(problems).to contain_error("wmf-style: Found deprecated function (hiera_array) in class 'foo', use lookup instead").on_line(11).in_column(8)
+    end
   end
 
   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 '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)
+      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(8).in_column(13)
+      expect(problems).to contain_error("wmf-style: Found lookup 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(9).in_column(5)
@@ -175,7 +210,7 @@ describe 'wmf_styleguide' do
   context 'defined type with violations' do
     let(:code) { define_ko }
     it 'should not contain hiera calls' do
-      expect(problems).to contain_error("wmf-style: Found hiera call in defined type 'foo::fixme' for 'something'").on_line(1)
+      expect(problems).to contain_error("wmf-style: Found deprecated function (hiera) in defined type 'foo::fixme', use lookup instead").on_line(1)
     end
     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)
@@ -184,6 +219,15 @@ describe 'wmf_styleguide' 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
+    it 'should create errors for hiera function' do
+      expect(problems).to contain_error("wmf-style: Found deprecated function (hiera) in defined type 'foo::fixme', use lookup instead").on_line(6).in_column(8)
+    end
+    it 'should create errors for hiera_hash function' do
+      expect(problems).to contain_error("wmf-style: Found deprecated function (hiera_hash) in defined type 'foo::fixme', use lookup instead").on_line(7).in_column(8)
+    end
+    it 'should create errors for hiera_array function' do
+      expect(problems).to contain_error("wmf-style: Found deprecated function (hiera_array) in defined type 'foo::fixme', use lookup instead").on_line(8).in_column(8)
+    end
   end
 
   context 'node with no errors' do
@@ -194,15 +238,43 @@ describe 'wmf_styleguide' do
   end
   context 'node with violations' do
     let(:code) { node_ko }
-    it 'should not have multiple roles applied' do
-      expect(problems).to contain_error("wmf-style: node 'fixme' includes multiple roles").on_line(2)
-    end
     it 'should not include classes directly' do
       expect(problems).to contain_error("wmf-style: node 'fixme' includes class base::firewall")
     end
     it 'should not declare any defined type' do
       expect(problems).to contain_error("wmf-style: node 'fixme' declares interface::mapped")
     end
+    it 'should not call lookup' do
+      expect(problems).to contain_error("wmf-style: node 'fixme' calls lookup function")
+    end
+    it 'should not call hiera' do
+      expect(problems).to contain_error("wmf-style: node 'fixme' calls legacy hiera function")
+    end
+    it 'should not call hiera_array' do
+      expect(problems).to contain_error("wmf-style: node 'fixme' calls legacy hiera_array function")
+    end
+    it 'should not call hiera_hash' do
+      expect(problems).to contain_error("wmf-style: node 'fixme' calls legacy hiera_hash function")
+    end
+  end
+
+  context 'node regex with start violation' do
+    let(:code) { node_regex_missing_start }
+    it 'should start the regex with ^' do
+      expect(problems).to contain_error('wmf-style: regex node matching must match the whole string (^...$), got: test1.*\\.example\\.com$')
+    end
+  end
+  context 'node regex with end violation' do
+    let(:code) { node_regex_missing_end }
+    it 'should end the regex with $' do
+      expect(problems).to contain_error('wmf-style: regex node matching must match the whole string (^...$), got: ^test1.*\\.example\\.com')
+    end
+  end
+  context 'node regex with start and end violations' do
+    let(:code) { node_regex_missing_both }
+    it 'should start the regex with ^ and end it with $' do
+      expect(problems).to contain_error('wmf-style: regex node matching must match the whole string (^...$), got: test1.*\\.example\\.com')
+    end
   end
 
   context 'defined type with deprecations' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-wmf_styleguide-check
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.1
 platform: ruby
 authors:
 - Giuseppe Lavagetto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
 description: |2
       A puppet-lint plugin to check that the code adheres to the WMF coding guidelines:
 
@@ -149,10 +163,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: A puppet-lint plugin to check code adheres to the WMF coding guidelines
 test_files:
-- spec/spec_helper.rb
 - spec/puppet-lint/plugins/check_wmf_styleguide_check_spec.rb
+- spec/spec_helper.rb