puppet-ghostbuster 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54bed6f908a3bb9aaae26087248857c8390028b7
-  data.tar.gz: 3904dae59b8117dfd6233afaf73688ed232c2e6b
+  metadata.gz: edacfbf4e6b6535eb54b8ca8ebadf3a52fda9541
+  data.tar.gz: 5fc919c331dfe03a3f6e9ce715eae083220be1fa
 SHA512:
-  metadata.gz: 0b6a6044ce239fd2aef83b436994b5bff3bb85f5214c3e5537317fa853414c090b517d7e4eea2853df38acab5d5ca1fa6a881366f8817f8f9ff20dd4a9a2b394
-  data.tar.gz: 68abfdd84fd16af1b06a32c06b6173b90b9b50bf4024d26eb4aca4026d27cf5b75b17ed5bb1ca26b588a5896466678f3067a303eb94620f038dce084f68e4887
+  metadata.gz: f432b78f191bcb16104160ef44dca6699da36556ded601664ec4df1acf16737ac287ff46a7ea48bf9c5f377299ce39752809556f6c83341e79163659b4596d59
+  data.tar.gz: a98974b7f24d5b42ab99b03e84b7c92701c80d116916bca7eab4afbfe6182c309d165485dc09afde1fe64ef9bcba8c75df7d4c4140ae3cf1e678c022588667a4

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [0.5.1](https://rubygems.org/gems/puppet-ghostbuster/versions/0.5.1) (2016-05-11)
+[Full Changelog](https://github.com/camptocamp/puppet-ghostbuster/compare/0.5.0...0.5.1)
+
+**Fixed bugs:**
+
+- Detect templates included in templates
+
 ## [0.5.0](https://rubygems.org/gems/puppet-ghostbuster/versions/0.5.0) (2016-05-10)
 [Full Changelog](https://github.com/camptocamp/puppet-ghostbuster/compare/0.4.5...0.5.0)
 

data/lib/puppet-ghostbuster/version.rb

@@ -1,3 +1,3 @@
 class PuppetGhostbuster
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

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

@@ -17,6 +17,10 @@ PuppetLint.new_check(:ghostbuster_templates) do
     Dir.glob('./**/manifests/**/*.pp')
   end
 
+  def templates
+    Dir.glob('./**/templates/**/*').select{ |f| File.file? f }
+  end
+
   def check
     m = path.match(%r{.*/([^/]+)/templates/(.+)$})
     return if m.nil?
@@ -32,6 +36,10 @@ PuppetLint.new_check(:ghostbuster_templates) do
       end
     end
 
+    templates.each do |template|
+      return if File.readlines(template).grep(%r{scope.function_template\(\['#{module_name}/#{template_name}'\]\)}).size > 0
+    end
+
     notify :warning, {
       :message => "Template #{module_name}/#{template_name} seems unused",
       :line    => 1,

data/spec/fixtures/modules/foo/manifests/bar.pp

@@ -0,0 +1,14 @@
+class foo::bar {
+  file { 'used_with_file':
+    content => file('foo/used_with_file'),
+  }
+  file { 'used_with_file_and_module_name':
+    content => file("${module_name}/used_with_file_and_module_name"),
+  }
+  file { 'used_with_template':
+    content => template('foo/used_with_template'),
+  }
+  file { 'used_with_template_and_module_name':
+    content => template("${module_name}/used_with_template_and_module_name"),
+  }
+}

data/spec/fixtures/modules/foo/templates/foo.erb

@@ -0,0 +1 @@
+<%= scope.function_template(['foo/used_in_template.erb']) -%>

data/spec/lib/puppet-ghostbuster_spec.rb

@@ -0,0 +1,17 @@
+module PuppetGhostbusterSpec
+  class PuppetDBRequest
+    def initialize(data)
+      @data = data
+    end
+
+    def data
+      @data
+    end
+  end
+
+  def expect_puppetdb_resources(request, data)
+    expect_any_instance_of(PuppetDB::Client).to \
+      receive(:request).with('resources', request)
+    .and_return(PuppetDBRequest.new(data))
+  end
+end

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

@@ -1,15 +1,5 @@
 require 'spec_helper'
 
-class PuppetDBRequest
-  def initialize(data)
-    @data = data
-  end
-
-  def data
-    @data
-  end
-end
-
 describe 'ghostbuster_classes' do
   #let(:path) { "./manifests/site.pp" }
   let(:path) { "./modules/foo/manifests/init.pp" }

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

@@ -1,46 +1,26 @@
 require 'spec_helper'
 
-class PuppetDBRequest
-  def initialize(data)
-    @data = data
-  end
-
-  def data
-    @data
-  end
-end
-
 describe 'ghostbuster_defines' do
-  let(:path) { "./modules/foo/manifests/init.pp" }
+  include PuppetGhostbusterSpec
 
   context 'with fix disabled' do
 
     context 'when define is used' do
       let(:code) { "define foo {}" }
-
-      before :each do
-        expect_any_instance_of(PuppetDB::Client).to \
-          receive(:request).with('resources', [:'=', 'type', 'Foo'])
-          .and_return(PuppetDBRequest.new([
-        {
-          'type' => 'Foo',
-          'title' => 'bar',
-        },
-        ]))
-      end
+      let(:path) { "./modules/foo/manifests/init.pp" }
 
       it 'should not detect any problem' do
+        expect_puppetdb_resources([:'=', 'type', 'Foo'], [{}])
         expect(problems).to have(0).problems
       end
     end
 
     context 'when define is not used' do
-      let(:code) { "define foo {}" }
+      let(:code) { "define bar {}" }
+      let(:path) { "./modules/bar/manifests/init.pp" }
 
       before :each do
-        expect_any_instance_of(PuppetDB::Client).to \
-          receive(:request).with('resources', [:'=', 'type', 'Foo'])
-          .and_return(PuppetDBRequest.new([]))
+        expect_puppetdb_resources([:'=', 'type', 'Bar'], [])
       end
 
       it 'should detect one problem' do
@@ -48,7 +28,7 @@ describe 'ghostbuster_defines' do
       end
 
       it 'should create a warning' do
-        expect(problems).to contain_warning('Define Foo seems unused')
+        expect(problems).to contain_warning('Define Bar seems unused')
       end
     end
   end

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

@@ -1,109 +1,108 @@
 require 'spec_helper'
 
 describe 'ghostbuster_files' do
-  let(:path) { "./modules/foo/files/bar/baz" }
+  include PuppetGhostbusterSpec
+
   let(:code) { "" }
 
   context 'with fix disabled' do
 
     context 'when file usage is found in puppetdb' do
+      let(:path) { "./modules/foo/files/bar" }
 
-      before :each do
-        expect_any_instance_of(PuppetDB::Client).to\
-          receive(:request).with(
-            'resources',
-            [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar/baz"],
+      it 'should not detect any problem' do
+        expect_puppetdb_resources(
+          [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar"],
+          [{}]
         )
-          .and_return(PuppetDBRequest.new([{}]))
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'when parent directory with recurse => true usage is found in puppetdb' do
+      let(:path) { "./modules/foo/files/bar/baz" }
+
+      it 'should not detect any problem' do
+        expect_puppetdb_resources(
+          [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar/baz"],
+          [])
+        expect_puppetdb_resources(
+          [:'and',
+             [:'or',
+              [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar"],
+              [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar/"],
+        ],
+        [:'=', ['parameter', 'recurse'], true],
+        ],
+          [{}])
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'when using full module name syntax' do
+      let(:path) { "./modules/foo/files/used_with_file" }
+
+      it 'should not detect any problem' do
+        expect_puppetdb_resources(
+          [:'=', ['parameter', 'source'], "puppet:///modules/foo/used_with_file"],
+          [])
+        expect(problems).to have(0).problems
       end
+    end
+
+    context 'when using $module_name syntax' do
+      let(:path) { "./modules/foo/files/used_with_file_and_module_name" }
 
       it 'should not detect any problem' do
+        expect_puppetdb_resources(
+          [:'=', ['parameter', 'source'], "puppet:///modules/foo/used_with_file_and_module_name"],
+          [])
         expect(problems).to have(0).problems
       end
     end
 
-    context 'when file usage is not found in puppetdb' do
+    context 'when file in ROOT is not used' do
+      let(:path) { "./modules/bar/files/foo" }
 
       before :each do
-        expect_any_instance_of(PuppetDB::Client).to\
-          receive(:request).with(
-            'resources',
-            [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar/baz"],
-        )
-          .and_return(PuppetDBRequest.new([]))
+        expect_puppetdb_resources(
+          [:'=', ['parameter', 'source'], "puppet:///modules/bar/foo"],
+          [])
+      end
+
+      it 'should detect one problem' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning("File bar/foo seems unused")
+      end
+    end
+
+    context 'when file in subdir is not used' do
+      let(:path) { "./modules/bar/files/foo/bar" }
+
+      before :each do
+        expect_puppetdb_resources(
+          [:'=', ['parameter', 'source'], "puppet:///modules/bar/foo/bar"],
+          [])
+        expect_puppetdb_resources(
+          [:'and',
+           [:'or',
+            [:'=', ['parameter', 'source'], "puppet:///modules/bar/foo"],
+            [:'=', ['parameter', 'source'], "puppet:///modules/bar/foo/"],
+        ],
+        [:'=', ['parameter', 'recurse'], true],
+        ],
+          [])
       end
 
-      context 'when parent directory with recurse => true usage is found in puppetdb' do
-        before :each do
-          expect_any_instance_of(PuppetDB::Client).to \
-            receive(:request).with(
-              'resources',
-              [:'and',
-               [:'or',
-                [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar"],
-                [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar/"],
-          ],
-          [:'=', ['parameter', 'recurse'], true],
-          ],
-          )
-            .and_return(PuppetDBRequest.new([
-          {
-          },
-          ]))
-        end
-
-        it 'should not detect any problem' do
-          expect(problems).to have(0).problems
-        end
+      it 'should detect one problem' do
+        expect(problems).to have(1).problems
       end
 
-      context 'when parent directory usage is not found in puppetdb' do
-        before :each do
-          expect_any_instance_of(PuppetDB::Client).to \
-            receive(:request).with(
-              'resources',
-              [:'and',
-               [:'or',
-                [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar"],
-                [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar/"],
-          ],
-          [:'=', ['parameter', 'recurse'], true],
-          ],
-          )
-            .and_return(PuppetDBRequest.new([]))
-        end
-
-        context 'when file usage is found in manifests' do
-
-          before :each do
-            expect(Dir).to receive(:glob){["./modules/foo/manifests/bar.pp" ]}
-          end
-
-          context 'when using full module name syntax' do
-            it 'should not detect any problem' do
-              expect(File).to receive(:readlines).with("./modules/foo/manifests/bar.pp").and_return(["file{'foo':", "  content => file('foo/bar/baz'),", "  }"])
-              expect(problems).to have(0).problems
-            end
-          end
-
-          context 'when using $module_name syntax' do
-            it 'should not detect any problem' do
-              expect(File).to receive(:readlines).with("./modules/foo/manifests/bar.pp").and_return(["file{'foo':", "  content => file('bar/foo'),", "  }"])
-              expect(File).to receive(:readlines).with("./modules/foo/manifests/bar.pp").and_return(["file{'foo':", '  content => file("${module_name}/bar/baz"),', "  }"])
-              expect(problems).to have(0).problems
-            end
-          end
-        end
-
-        context 'when file usage is not found in manifests' do
-          it 'should detect one problem' do
-            expect(problems).to have(1).problems
-          end
-
-          it 'should create a warning' do
-            expect(problems).to contain_warning("File foo/bar/baz seems unused")
-          end
-        end
+      it 'should create a warning' do
+        expect(problems).to contain_warning("File bar/foo/bar seems unused")
       end
     end
   end

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

@@ -1,40 +1,43 @@
 require 'spec_helper'
 
 describe 'ghostbuster_templates' do
-  let(:path) { "./modules/foo/templates/bar" }
   let(:code) { "" }
 
   context 'with fix disabled' do
 
-    context 'when template usage is found in manifests' do
+    context 'when using full module name syntax' do
+      let(:path) { "./modules/foo/templates/used_with_template" }
 
-      before :each do
-        expect(Dir).to receive(:glob){["./modules/foo/manifests/bar.pp" ]}
+      it 'should not detect any problem' do
+        expect(problems).to have(0).problems
       end
+    end
+
+    context 'when using $module_name syntax' do
+      let(:path) { "./modules/foo/templates/used_with_template_and_module_name" }
 
-      context 'when using full module name syntax' do
-        it 'should not detect any problem' do
-          expect(File).to receive(:readlines).with("./modules/foo/manifests/bar.pp").and_return(["file{'foo':", "  content => template('foo/bar'),", "  }"])
-          expect(problems).to have(0).problems
-        end
+      it 'should not detect any problem' do
+        expect(problems).to have(0).problems
       end
+    end
 
-      context 'when using $module_name syntax' do
-        it 'should not detect any problem' do
-          expect(File).to receive(:readlines).with("./modules/foo/manifests/bar.pp").and_return(["file{'foo':", "  content => template('bar/foo'),", "  }"])
-          expect(File).to receive(:readlines).with("./modules/foo/manifests/bar.pp").and_return(["file{'foo':", '  content => template("${module_name}/bar"),', "  }"])
-          expect(problems).to have(0).problems
-        end
+    context 'when using template in template' do
+      let(:path) { "./modules/foo/templates/used_in_template.erb" }
+
+      it 'should not detect any problem' do
+        expect(problems).to have(0).problems
       end
     end
 
     context 'when template usage is not found in manifests' do
+      let(:path) { "./modules/foo/templates/unused" }
+
       it 'should detect one problem' do
         expect(problems).to have(1).problems
       end
 
       it 'should create a warning' do
-        expect(problems).to contain_warning("Template foo/bar seems unused")
+        expect(problems).to contain_warning("Template foo/unused seems unused")
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,3 +1,9 @@
 require 'puppet-lint'
 
+require 'pathname'
+dir = Pathname.new(__FILE__).parent
+$LOAD_PATH.unshift(dir, File.join(dir, 'lib'), File.join(dir, '..', 'lib'))
+
+require 'puppet-ghostbuster_spec'
+
 PuppetLint::Plugins.load_spec_helper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-ghostbuster
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Camptocamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -170,6 +170,9 @@ files:
 - lib/puppet-lint/plugins/check_ghostbuster_files.rb
 - lib/puppet-lint/plugins/check_ghostbuster_templates.rb
 - puppet-ghostbuster.gemspec
+- spec/fixtures/modules/foo/manifests/bar.pp
+- spec/fixtures/modules/foo/templates/foo.erb
+- spec/lib/puppet-ghostbuster_spec.rb
 - spec/puppet-lint/plugins/ghostbuster_classes_spec.rb
 - spec/puppet-lint/plugins/ghostbuster_defines_spec.rb
 - spec/puppet-lint/plugins/ghostbuster_files_spec.rb