puppet-lint-wmf_styleguide-check 1.1.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7980b85ac1476eb1cfd7107a024a8d01f56d3aaa13bc4adf6542b52edeb862a8
-  data.tar.gz: f5b71a6c23db3e26deec5d4f2a2d036ad4dbaeb26e0aa80d2049bf6e95e830eb
+  metadata.gz: d19787901dc3b130c947494d15441a83a3554456f2bb999f7612667d2c01556d
+  data.tar.gz: 331e919394e9c138cc432ea935d8fa7b3f632b987a27f84bae5858371a76c493
 SHA512:
-  metadata.gz: 814e0b269f85a970e883534f42a12f201e0afaf530f47474e7bbfaf685dd0ae549a529de9c639768c6e34f11d53bb66425e7c31a4a25cf0d6bb6d60f9c614238
-  data.tar.gz: 8b85af51045fc558202c404ce87f20c0ca14dc76538ea30bde1abd68c3eac4ac154e1a77a309ff08b9e96ed93aca6945e870d117553259a68aa09d45d7b68b91
+  metadata.gz: ed879dd47323e5098ba8f8ea7301ff917ffe249209df05fbe1d95194a3409cdcf8c3218fb2473c47dffde5aa46fa663e16bfc5e71187421f3cbceb0a2417ec11
+  data.tar.gz: f6552ff1c0da1f1cdad84f76a3316d78674eab5490b0a5c6a16ec734125769c90a7372b7b452cb953af207f11b2406ab510b3544dafdd4fbc5f62bd4f0d22ddb

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?
@@ -280,7 +280,6 @@ end
 
 def lookup_not_in_params(klass)
   # Checks if a lookup call is not in a parameter declaration. Used to check profiles
-
   # 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
@@ -493,8 +492,62 @@ 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
+        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: 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,
+            problem: 'node_regex'
+          }
+          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
@@ -538,4 +591,20 @@ PuppetLint.new_check(:wmf_styleguide) do
       check_node node
     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.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'
+    method = "fix_#{problem[:problem]}"
+    send(method, problem) if respond_to? method
+  end
 end

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,6 +118,42 @@ node 'fixme' {
 }
 EOF
 
+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_start = <<-EOF
+node /test1.*\\.eqiad\\./ {
+     role(spare::system)
+}
+EOF
+
+node_regex_with_end = <<-EOF
+node /^test1.*\\.eqiad\\.wmnet$/ {
+     role(spare::system)
+}
+EOF
+
+node_regex_fixed = <<-EOF
+node /^test1.*\\.eqiad\\./ {
+     role(spare::system)
+}
+EOF
+
+node_regex_fixed_wmf_tld = <<-EOF
+node /^test1.*\\.eqiad\\./ {
+     role(spare::system)
+}
+EOF
+
 deprecation_ko = <<-EOF
 define test() {
    base::service_unit{ 'test2': }
@@ -218,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
@@ -238,6 +301,37 @@ 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: 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_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
 
   context 'defined type with deprecations' do
@@ -246,4 +340,27 @@ describe 'wmf_styleguide' do
       expect(problems).to contain_error("wmf-style: 'test' should not include the deprecated define 'base::service_unit'")
     end
   end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'node regex with start violation' do
+      let(:code) { node_regex_missing_start }
+      it { expect(manifest).to eq(node_regex_fixed) }
+    end
+    context 'node regex with end violation' do
+      let(:code) { node_regex_with_end }
+      it { expect(manifest).to eq(node_regex_fixed) }
+    end
+    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.0
+  version: 1.1.3
 platform: ruby
 authors:
 - Giuseppe Lavagetto
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2023-08-11 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,9 +163,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: A puppet-lint plugin to check code adheres to the WMF coding guidelines
 test_files: