puppet-lint-file_ensure-check 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 304d76cda3e5fb47e9bc831b14d9ef234a9d07c2
-  data.tar.gz: c838921b89314ab4fac03deb3556afda43ca01f8
+  metadata.gz: cfa9f5e1fc0ea251d4bad7cf61e5afe8826fd5f8
+  data.tar.gz: 77cdaaabc6993fe383d7c813104f49dbe0857f4b
 SHA512:
-  metadata.gz: c429918c46ef5e85cb03ac35b99d39bba19d84d2763f410978dea325e67f590057d445d3c87c0a0a6293150f61290a2a67ee981857aaf5a4db109073b87b9a7b
-  data.tar.gz: 0597c6878e75da08f8137fd0a36f75cf25740841e677dcad1917af8893eb98329c4aa8f320cbe4d3ded5f6f3298093ed895b00da2202027d14e94cc36dfc51bd
+  metadata.gz: 3970c7fb794837a782894fcd3690674219e099de8438038637375e3a9b305ab92a322c77786c83d4c033e0d3bd711d125ec19113a5c6b228df49996ad7ed3342
+  data.tar.gz: 4f2c9fa4a829aaf148b090a7825cedb90c594336e567917a1ac59b92fdd10e6c28c6c147512887a93ef0c108a0c59eb31975bb2ea58777853e04902886af01db

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

@@ -2,19 +2,33 @@ PuppetLint.new_check(:file_ensure) do
   def check
     resource_indexes.each do |resource|
       if resource[:type].value == 'file'
-        attr = resource[:tokens].select { |t| t.type == :NAME && t.value == 'ensure' && t.next_code_token.type == :FARROW }
+        attr = resource[:tokens].select { |t| t.type == :NAME && \
+                                              t.value == 'ensure' && \
+                                              t.next_code_token.type == :FARROW }
         unless attr.empty?
           val_token = attr[0].next_code_token.next_code_token
           if val_token.value == 'present'
               notify :warning, {
-                :message => 'ensure set to present on file resource',
-                :line    => val_token.line,
-                :column  => val_token.column,
-                :token   => val_token,
+                :message  => 'ensure set to present on file resource',
+                :line     => val_token.line,
+                :column   => val_token.column,
+                :token    => val_token,
+                :resource => resource,
               }
           end
         end
       end
     end
   end
+
+  def fix(problem)
+    target_attr = problem[:resource][:tokens].select { |t| t.type == :NAME && \
+                                                           t.value == 'target' && \
+                                                           t.next_code_token.type == :FARROW }
+    if target_attr.empty?
+      problem[:token].value = 'file'
+    else
+      problem[:token].value = 'link'
+    end
+  end
 end

data/spec/puppet-lint/plugins/check_file_ensure/check_file_ensure_spec.rb

@@ -12,7 +12,8 @@ describe 'file_ensure' do
         }
 
         file { '/etc/fstab':
-          ensure => 'file',
+          ensure => 'target',
+          target => '/etc/mtab',
         }
         EOS
       }
@@ -31,11 +32,12 @@ describe 'file_ensure' do
 
         file { '/etc/fstab':
           ensure => 'present',
+          target => '/etc/mtab',
         }
         EOS
       }
 
-      it 'should detect a single problem' do
+      it 'should detect problems' do
         expect(problems).to have(2).problems
       end
 
@@ -45,4 +47,76 @@ describe 'file_ensure' do
       end
     end
   end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'correct file resource declarations' do
+      let (:code) {
+        <<-EOS
+        file { '/etc/sudoers':
+          ensure => file,
+        }
+
+        file { '/etc/fstab':
+          ensure => 'target',
+          target => '/etc/mtab',
+        }
+        EOS
+      }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+
+    context 'wrong file resource declarations' do
+      let (:code) {
+        <<-EOS
+        file { '/etc/sudoers':
+          ensure => present,
+        }
+
+        file { '/etc/fstab':
+          ensure => 'present',
+          target => '/etc/mtab',
+        }
+        EOS
+      }
+
+      it 'should detect two problems' do
+        expect(problems).to have(2).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_fixed(msg).on_line(2).in_column(21)
+        expect(problems).to contain_fixed(msg).on_line(6).in_column(21)
+      end
+
+      it 'should fix the ensure parameter' do
+        expect(manifest).to eq(
+          <<-EOS
+        file { '/etc/sudoers':
+          ensure => file,
+        }
+
+        file { '/etc/fstab':
+          ensure => 'link',
+          target => '/etc/mtab',
+        }
+          EOS
+        )
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-file_ensure-check
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Camptocamp