puppet-lint-absolute_template_path 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 869f58dd0ff55cbdcc027e57a37134f48ea56ec3
+  data.tar.gz: ad3c0f145b2ba3b983575a337909dded4854218e
+SHA512:
+  metadata.gz: 5478f4591bc33c21e9578dff93c99b0aad6ea7c3337345cfde77946093b5e5098c42b0a98b8c7f424c74bd1fe34aaa2db91069375889fba4e3a879885d65b9af
+  data.tar.gz: 05608cc37772f0b82ce8ab5036bd0fff3835c5104907d7ecbac5754e996c3f132e1a10e3857fbf79e8cbf0236429ec7ceda291f7aeaab6849e64c4fd29e47690

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Dean Wilson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# puppet-lint absolute template path check
+
+A new check for puppet-lint that checks template paths are in the
+relative `template('example/template.erb')` form rather than the absolute
+`template('/etc/puppet/modules/example/templates/template.erb')` format.
+
+## Installation
+
+To use this plugin add the following line to your Gemfile
+
+```ruby
+gem 'puppet-lint-absolute_template_path'
+```
+
+and then run `bundle install`.
+
+## Usage
+
+This plugin provides a new check to `puppet-lint`.
+
+```
+WARNING: template module paths should be relative, not absolute on line 5
+```

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

@@ -0,0 +1,29 @@
+PuppetLint.new_check(:absolute_template_path) do
+  def check
+    resource_indexes.each do |resource|
+      if resource[:type].value == "file"
+        resource[:param_tokens].select { |param_token|
+          param_token.value == 'content'
+        }.each do |content_token|
+
+          value_token = content_token.next_code_token.next_code_token
+
+          if value_token.value.start_with? 'template'
+            template_path = value_token.next_code_token.next_code_token.value
+
+            if template_path.start_with? '/'
+
+              notify :warning, {
+                :message     => 'template module paths should be relative, not absolute',
+                :line        => value_token.line,
+                :column      => value_token.column,
+                :param_token => content_token,
+                :value_token => value_token,
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe 'absolute_template_path' do
+
+  let(:msg) { 'template module paths should be relative, not absolute' }
+
+  context 'with fix disabled' do
+    context 'template with a relative module path' do
+      let(:code) do
+        <<-EOS
+          class template_tester {
+            file { '/tmp/template':
+              content => template('example/template.erb'),
+            }
+          }
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'template with an absolute module path' do
+      let(:code) do
+        <<-EOS
+          class template_tester {
+            file { '/tmp/template':
+              content => template('/etc/puppet/modules/example/template.erb'),
+            }
+          }
+        EOS
+      end
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should create a warning' do
+         expect(problems).to contain_warning(msg).on_line(3).in_column(26)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-absolute_template_path
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dean Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    A new check for puppet-lint that checks all template paths are in
+  the\n    template('example/template.erb') form rather than \n    template('/etc/puppet/modules/example/templates/template.erb')\n"
+email: dean.wilson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/puppet-lint/plugins/absolute_template_path.rb
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/absolute_template_path_spec.rb
+homepage: https://github.com/deanwilson/puppet-lint-absolute_template_path
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: puppet-lint absolute template path check
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/absolute_template_path_spec.rb