puppet-lint-reference_on_declaration_outside_of_class-check 1.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f58019a41dba9734b248d9948d161ca1a6667c8
+  data.tar.gz: 853ced4f419b00481ae4053c59a668c5d71492ee
+SHA512:
+  metadata.gz: c0f3b11ba2c770c908d8693257ea61841c9f28625b464dd7e5ea9acb0088a9edce1b32143dfd7f5f1fd5971649b0a86a7e19431751068124b7ec62fd4cc57267
+  data.tar.gz: b92dcb7d4858f70d16530c275aed5f42ccbe11956005747ba13da0cd81a0fc8d9aee776a9e7ff33f3a2cf45e017bebc3efed790a46888dca8e1d904e415552c1

data/.rspec

@@ -0,0 +1,3 @@
+--format
+documentation
+--colour

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,60 @@
+# puppet-lint plugin reference on declaration in class check
+
+**Note: this plugin will check for references which are declared outside of the class where the reference is used.**
+
+## Installation
+
+To use this plugin, add the following like to the Gemfile in your Puppet code
+base and run `bundle install`.
+
+```ruby
+gem 'puppet-lint-reference_on_declaration_outside_of_class-check'
+```
+
+## Usage
+
+This plugin provides one new check to `puppet-lint`.
+
+### reference_on_declaration_outside_of_class
+
+**--fix support: No**
+
+This check will raise a warning for any resource reference that is not declared inside the same class.
+
+
+```
+  class 'foo' {
+    package { 'foo':
+      ensure => present,
+    }
+    file { '/tmp/foo':
+      ensure  => file,
+      require => Package['foo2'],
+    }
+  }
+```
+and will result in the following warning:
+
+```
+WARNING: reference on non local resource declaration
+```
+
+### reference_on_foreign_class
+
+**--fix support: No**
+
+This check will raise a warning for any class reference that is not declared inside the class.
+
+```
+   class 'demo' {
+     class { 'demo::install': }
+     include demo::config
+     Class['demo::install'] -> Class['foobar']
+   }
+```
+and will result in the following warning:
+
+```
+WARNING: reference on a foreign class
+
+```

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

@@ -0,0 +1,45 @@
+PuppetLint.new_check(:reference_on_declaration_outside_of_class) do
+  def check
+    has_declaration = 0
+    resource_indexes.each do |resource|
+      resource[:tokens].select { |token|
+        [:CLASSREF].include? token.type
+      }.each do |token|
+        check_classref = token.value.to_s.downcase
+        check_title = token.next_token.next_token.value.to_s
+        tokens.select { |token2|
+          token2.value.to_s == check_classref and token2.next_token.next_token.next_token.next_token.value.to_s == check_title
+        }.each do |token2|
+          has_declaration = 1
+        end
+        if has_declaration == 0
+          notify :warning, {
+            :message => 'reference on a resource type declaration not included in the same class',
+            :line    => token.line,
+            :column  => token.column
+          }
+        end
+      end
+    end
+    tokens.select { |check_token|
+      [:CLASSREF].include? check_token.type
+    }.each do |check_token|
+      check_classref = check_token.value.to_s.downcase
+      check_title = check_token.next_token.next_token.value.to_s
+      if check_classref == 'class'
+        tokens.select { |token2|
+          token2.value.to_s == 'include' and token2.next_token.next_token.value.to_s == check_title
+        }.each do |token2|
+          has_declaration = 1
+        end
+        if has_declaration == 0
+          notify :warning, {
+            :message => 'reference on a resource type declaration not included in the same class',
+            :line    => check_token.line,
+            :column  => check_token.column
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'pry'
+PuppetLint.new_check(:reference_on_foreign_class) do
+  def check
+    has_declaration = 0
+    tokens.select { |check_token|
+      [:CLASSREF].include? check_token.type
+    }.each do |check_token|
+      check_classref = check_token.value.to_s.downcase
+      check_title = check_token.next_token.next_token.value.to_s
+      if check_classref == 'class'
+        tokens.select { |token2|
+          ( (token2.value.to_s == 'include' or token2.value.to_s == 'contain') and token2.next_code_token.value.to_s == check_title ) or ( token2.value.to_s == 'class' and token2.next_code_token.next_code_token.value.to_s == check_title)
+        }.each do |token2|
+          has_declaration = 1
+        end
+        if has_declaration == 0
+          notify :warning, {
+            :message => 'reference on a foreign class',
+            :line    => check_token.line,
+            :column  => check_token.column
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe 'reference_on_declaration_outside_of_class' do
+
+  context 'a proper reference on a local declaration' do
+    let(:code) { "
+      package { 'demo': ensure => present }
+      file { 'foo': ensure => file }
+      service { 'foo': subscribe => File['foo'] }
+            " }
+
+    it 'should detect no problem' do
+      expect(problems).to have(0).problem
+    end
+  end
+
+  context 'a proper reference on a local declaration using varaible' do
+    let(:code) { "
+      package { 'demo': ensure => present }
+      file { $cfgfile: ensure => file }
+      service { 'foo': subscribe => File[$cfgfile] }
+            " }
+
+    it 'should detect no problem' do
+      expect(problems).to have(0).problem
+    end
+  end
+
+  context 'a reference on a foreign declaration' do
+    let(:msg) { 'reference on a resource type declaration not included in the same class' }
+    let(:code) { "
+      package { 'demo2': ensure => present }
+      file { 'foofail': ensure => file }
+      service { 'foofail': subscribe => File['foo2'] }
+            " }
+
+    it 'should only detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning(msg)
+    end
+  end
+
+  context 'a reference on a foreign declaration using a variable' do
+    let(:msg) { 'reference on a resource type declaration not included in the same class' }
+    let(:code) { "
+      package { $pkgname: ensure => present }
+      file { 'foofail': ensure => file }
+      service { 'foofail': subscribe => Package[$pkgname2] }
+            " }
+
+    it 'should only detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning(msg)
+    end
+  end
+
+end

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

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe 'reference_on_foreign_class' do
+
+  context 'a proper reference on a local class include' do
+    let(:code) { "
+      class demo {
+        include demo::install
+        include demo::config
+        Class['demo::config'] -> Class['demo::install']
+      }
+            " }
+
+    it 'should detect no problem' do
+      expect(problems).to have(0).problem
+    end
+  end
+
+  context 'a proper reference on a local class type declaration' do
+    let(:code) { "
+      class demo2 {
+        class { demo2::install: }
+        class { demo2::config: }
+        Class['demo2::config'] -> Class['demo2::install']
+      }
+            " }
+
+    it 'should detect no problem' do
+      expect(problems).to have(0).problem
+    end
+  end
+
+
+  context 'a reference on a foreign class declaration' do
+    let(:msg) { 'reference on a foreign class' }
+    let(:code) { "
+      include base::demo
+      Class['demo'] -> Class['foo']
+            " }
+
+    it 'should only detect a single problem' do
+      expect(problems).to have(2).problem
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning(msg)
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-reference_on_declaration_outside_of_class-check
+version: !ruby/object:Gem::Version
+  version: 1.0.8
+platform: ruby
+authors:
+- Martin Alfke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-01 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: |2
+      Extends puppet-lint to ensure that a reference is made only on a declaration within the same class
+email: ma@example42.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/reference_on_declaration_outside_of_class.rb
+- lib/puppet-lint/plugins/reference_on_foreign_class.rb
+- spec/puppet-lint/plugins/reference_on_declaration_outside_of_class_spec.rb
+- spec/puppet-lint/plugins/reference_on_foreign_class_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/voxpupuli/puppet-lint-reference_on_declaration_outside_of_class-check
+licenses:
+- APL2
+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.4.8
+signing_key: 
+specification_version: 4
+summary: puppet-lint only reference on declarations in class check
+test_files:
+- spec/puppet-lint/plugins/reference_on_declaration_outside_of_class_spec.rb
+- spec/puppet-lint/plugins/reference_on_foreign_class_spec.rb
+- spec/spec_helper.rb