puppet-lint-wmf_styleguide-check 1.1.2 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0996980289ea98e58b4da21e94d46732a5fec1cda561ddcd979ec647c91db633'
-  data.tar.gz: d8b5d617cb4ba1f1765670171cf157b723d73428410b8f1e564d8f160f20a046
+  metadata.gz: 54c6fe22c9d84651ff87c3731d412676e09b531e395ce3124dac997550db5b7a
+  data.tar.gz: 47143edec121e62799273e771c77ae1fe82711708da154363f311f6427f4348a
 SHA512:
-  metadata.gz: c8056b429179de7156ecdb3ccb09bad40c9c4ae0c487a2177ca8073b204e4de935da30ac993b3c94ebf896f0140f9bee36707cf045cfeb5e3617c34142debeb2
-  data.tar.gz: 96531a80875d9aa641a8a34ac3a541ab1ad75c0b4fb37228324c6312e2ba736749e3532de77bb6d8412ea5b3c5d973977f69f09a83d2ec10310d9cd3f028f9b4
+  metadata.gz: e9c1db9492965bf77d8705ab9b2220a47cae1d66cf6a34981fca517f2fe80937d63da80844f463faac22245729036ba0a7dc92a5b8b6984484a216701d23d863
+  data.tar.gz: 0cfad3cc8ce589560568ab5ec796dc8b35010e11482e6f2540ce8d2af08844d037be3f0c180dbe2d19b8bf23c8a5195abf96d3194c71747006512287112ac4bf

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

@@ -190,7 +190,7 @@ class PuppetLint
       end
 
       def node_def?
-        [:SSTRING, :STRING, :NAME, :REGEX].include?(@type)
+        [:SSTRING, :STRING, :NAME, :REGEX, :DEFAULT].include?(@type)
       end
 
       def role_keyword?
@@ -218,8 +218,6 @@ def check_role(klass)
   lookup klass
   # A role should only include profiles
   include_not_profile klass
-  # A call, and only one, to system::role will be done
-  check_system_role klass
   # No defines should be present in a role
   check_no_defines klass
 end
@@ -395,17 +393,6 @@ def check_no_system_role(klass)
   end
 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",
-    line: 1,
-    column: 1
-  }
-  notify :error, msg
-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')
@@ -493,9 +480,40 @@ PuppetLint.new_check(:wmf_styleguide) do
       next unless in_node_def
       case token.type
       when :REGEX
-        if !token.value.start_with?('^') || !token.value.end_with?('$')
+        unless token.value.start_with?('^')
+          msg = {
+            message: "wmf-style: node regex must match the start of the hostname with '^' got: #{token.value}",
+            line: token.line,
+            column: token.column,
+            token: token,
+            problem: 'node_regex'
+          }
+          notify :error, msg
+        end
+        if token.value.end_with?('$')
+          msg = {
+            message: "wmf-style: node regex must not match the end of the hostname with '$' got: #{token.value}",
+            line: token.line,
+            column: token.column,
+            token: token,
+            problem: 'node_regex'
+          }
+          notify :error, msg
+        end
+        ['.wmnet', '.org'].each do |tld|
+          next unless token.value.index(tld)
           msg = {
-            message: "wmf-style: regex node matching must match the whole string (^...$), got: #{token.value}",
+            message: "wmf-style: node regex must not contain the '#{tld}' tld got: #{token.value}",
+            line: token.line,
+            column: token.column,
+            token: token,
+            problem: 'node_regex'
+          }
+          notify :error, msg
+        end
+        if !token.value.match(/\\?\.wikimedia\\?\.org/) && !token.value.end_with?('\.')
+          msg = {
+            message: "wmf-style: datacenter node regex must match subdomain end with '\.': #{token.value}",
             line: token.line,
             column: token.column,
             token: token,
@@ -504,7 +522,19 @@ PuppetLint.new_check(:wmf_styleguide) do
           notify :error, msg
         end
       when :LBRACE
-        title_tokens = tokens[start + 1..(i - 1)].select(&:node_def?) if braces_level.zero?
+        if braces_level.zero?
+          title_tokens = tokens[start + 1..(i - 1)].select(&:node_def?)
+          unless title_tokens[0].type == :REGEX || title_tokens[0].type == :DEFAULT
+            msg = {
+              message: "wmf-style: node definition must use a regex, got: #{title_tokens[0].value}",
+              line: token.line,
+              column: token.column,
+              token: token,
+              problem: 'node_regex'
+            }
+            notify :error, msg
+          end
+        end
         braces_level += 1
       when :RBRACE
         braces_level -= 1
@@ -549,10 +579,15 @@ PuppetLint.new_check(:wmf_styleguide) do
     end
   end
 
+  # rubocop:disable Metrics/AbcSize
   def fix_node_regex(problem)
     problem[:token].value.insert(0, '^') unless problem[:token].value.start_with?('^')
-    problem[:token].value << '$' unless problem[:token].value.end_with?('$')
+    problem[:token].value.chop! if problem[:token].value.end_with?('$')
+    ['wmnet', 'org'].each do |tld|
+      problem[:token].value.slice!(/#{tld}/) if problem[:token].value =~ /\\?\.#{tld}/
+    end
   end
+  # rubocop:enable Metrics/AbcSize
 
   def fix(problem)
     raise PuppetLint::NoFix unless problem[:problem] == 'node_regex'

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

@@ -88,7 +88,19 @@ define foo::fixme ($a=hiera('something')) {
 EOF
 
 node_ok = <<-EOF
-node /^test1.*\\.example\\.com$/ {
+node /^test1.*\\.eqiad\\./ {
+     role(spare::system)
+}
+EOF
+
+node_ok_wikimedia = <<-EOF
+node /^test1.*\\.wikimedia\\./ {
+     role(spare::system)
+}
+EOF
+
+node_default = <<-EOF
+node default {
      role(spare::system)
 }
 EOF
@@ -106,26 +118,38 @@ node 'fixme' {
 }
 EOF
 
-node_regex_missing_start = <<-EOF
-node /test1.*\\.example\\.com$/ {
+node_regex_with_wmf_tld = <<-EOF
+node /^test1.*\\.eqiad\\.wmnet/ {
+     role(spare::system)
+}
+EOF
+
+node_regex_with_org_tld = <<-EOF
+node /^test1.*\\.wikimedia\\.org/ {
      role(spare::system)
 }
 EOF
 
-node_regex_missing_end = <<-EOF
-node /^test1.*\\.example\\.com/ {
+node_regex_missing_start = <<-EOF
+node /test1.*\\.eqiad\\./ {
      role(spare::system)
 }
 EOF
 
-node_regex_missing_both = <<-EOF
-node /test1.*\\.example\\.com/ {
+node_regex_with_end = <<-EOF
+node /^test1.*\\.eqiad\\.wmnet$/ {
      role(spare::system)
 }
 EOF
 
 node_regex_fixed = <<-EOF
-node /^test1.*\\.example\\.com$/ {
+node /^test1.*\\.eqiad\\./ {
+     role(spare::system)
+}
+EOF
+
+node_regex_fixed_wmf_tld = <<-EOF
+node /^test1.*\\.eqiad\\./ {
      role(spare::system)
 }
 EOF
@@ -242,6 +266,21 @@ describe 'wmf_styleguide' do
       expect(problems).to have(0).problems
     end
   end
+
+  context 'node wikimedia.org with no errors' do
+    let(:code) { node_ok_wikimedia }
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'node default with no errors' do
+    let(:code) { node_default }
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
   context 'node with violations' do
     let(:code) { node_ko }
     it 'should not include classes directly' do
@@ -262,24 +301,36 @@ describe 'wmf_styleguide' do
     it 'should not call hiera_hash' do
       expect(problems).to contain_error("wmf-style: node 'fixme' calls legacy hiera_hash function")
     end
+    it 'should use a regex' do
+      expect(problems).to contain_error('wmf-style: node definition must use a regex, got: fixme')
+    end
+  end
+
+  context 'node regex with wmnet tld violation' do
+    let(:code) { node_regex_with_wmf_tld }
+    it 'should not contain the wmnet tld' do
+      expect(problems).to contain_error("wmf-style: node regex must not contain the '.wmnet' tld got: ^test1.*\\.eqiad\\.wmnet")
+    end
+  end
+
+  context 'node regex with org tld violation' do
+    let(:code) { node_regex_with_org_tld }
+    it 'should not contain the wmnet tld' do
+      expect(problems).to contain_error("wmf-style: node regex must not contain the '.org' tld got: ^test1.*\\.wikimedia\\.org")
+    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$')
+      expect(problems).to contain_error("wmf-style: node regex must match the start of the hostname with '^' got: test1.*\\.eqiad\\.")
     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')
+    let(:code) { node_regex_with_end }
+    it 'should not end the regex with $' do
+      expect(problems).to contain_error("wmf-style: node regex must not match the end of the hostname with '$' got: ^test1.*\\.eqiad\\.wmnet$")
     end
   end
 
@@ -304,12 +355,12 @@ describe 'wmf_styleguide' do
       it { expect(manifest).to eq(node_regex_fixed) }
     end
     context 'node regex with end violation' do
-      let(:code) { node_regex_missing_end }
+      let(:code) { node_regex_with_end }
       it { expect(manifest).to eq(node_regex_fixed) }
     end
-    context 'node regex with start and end violations' do
-      let(:code) { node_regex_missing_both }
-      it { expect(manifest).to eq(node_regex_fixed) }
+    context 'node regex with tld violation' do
+      let(:code) { node_regex_with_wmf_tld }
+      it { expect(manifest).to eq(node_regex_fixed_wmf_tld) }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-wmf_styleguide-check
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.4
 platform: ruby
 authors:
 - Giuseppe Lavagetto
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2024-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -148,7 +148,7 @@ homepage: https://github.com/lavagetto/puppet-lint-wmf_styleguide-check
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,10 +163,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.4.20
+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