puppet-lint-wmf_styleguide-check 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7980b85ac1476eb1cfd7107a024a8d01f56d3aaa13bc4adf6542b52edeb862a8
-  data.tar.gz: f5b71a6c23db3e26deec5d4f2a2d036ad4dbaeb26e0aa80d2049bf6e95e830eb
+  metadata.gz: '0996980289ea98e58b4da21e94d46732a5fec1cda561ddcd979ec647c91db633'
+  data.tar.gz: d8b5d617cb4ba1f1765670171cf157b723d73428410b8f1e564d8f160f20a046
 SHA512:
-  metadata.gz: 814e0b269f85a970e883534f42a12f201e0afaf530f47474e7bbfaf685dd0ae549a529de9c639768c6e34f11d53bb66425e7c31a4a25cf0d6bb6d60f9c614238
-  data.tar.gz: 8b85af51045fc558202c404ce87f20c0ca14dc76538ea30bde1abd68c3eac4ac154e1a77a309ff08b9e96ed93aca6945e870d117553259a68aa09d45d7b68b91
+  metadata.gz: c8056b429179de7156ecdb3ccb09bad40c9c4ae0c487a2177ca8073b204e4de935da30ac993b3c94ebf896f0140f9bee36707cf045cfeb5e3617c34142debeb2
+  data.tar.gz: 96531a80875d9aa641a8a34ac3a541ab1ad75c0b4fb37228324c6312e2ba736749e3532de77bb6d8412ea5b3c5d973977f69f09a83d2ec10310d9cd3f028f9b4

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

@@ -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,6 +492,17 @@ 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,
+            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?
         braces_level += 1
@@ -538,4 +548,15 @@ PuppetLint.new_check(:wmf_styleguide) do
       check_node node
     end
   end
+
+  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?('$')
+  end
+
+  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,7 @@ define foo::fixme ($a=hiera('something')) {
 EOF
 
 node_ok = <<-EOF
-node /^test1.*\.example\.com$/ {
+node /^test1.*\\.example\\.com$/ {
      role(spare::system)
 }
 EOF
@@ -106,6 +106,30 @@ node 'fixme' {
 }
 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
+
+node_regex_fixed = <<-EOF
+node /^test1.*\\.example\\.com$/ {
+     role(spare::system)
+}
+EOF
+
 deprecation_ko = <<-EOF
 define test() {
    base::service_unit{ 'test2': }
@@ -240,10 +264,52 @@ describe 'wmf_styleguide' do
     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
     let(:code) { deprecation_ko }
     it 'should not' 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_missing_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) }
+    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.2
 platform: ruby
 authors:
 - Giuseppe Lavagetto
 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
@@ -163,11 +163,10 @@ 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.2.5
 signing_key: 
 specification_version: 4
 summary: A puppet-lint plugin to check code adheres to the WMF coding guidelines
 test_files:
-- spec/puppet-lint/plugins/check_wmf_styleguide_check_spec.rb
 - spec/spec_helper.rb
+- spec/puppet-lint/plugins/check_wmf_styleguide_check_spec.rb