puppet-lint-version_comparison-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f268cbd291c0bbfb8297dffed518b0224410cae7
+  data.tar.gz: 85d703692cb86a74fbe4d4fe73d0c66eb836f20d
+SHA512:
+  metadata.gz: 7e7a1c6690bfadea8ed2b5510cd77cbb0d29699cdc2033b8908f18e8c8cb1c232f211bcbd018ed603e0133987ba9b2be3c58f0c34e33187ce3742594c7661157
+  data.tar.gz: e61c0c2b2a12061cd46def83bcf2cfb3c1085512023d04afd5c9d889077d8153cac786fa7f8ca661e1af22ab60852fb618f638b7978ac386e6739db74e50ba03

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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,43 @@
+puppet-lint-version_comparison-check
+=================================
+
+[![Build Status](https://travis-ci.org/camptocamp/puppet-lint-version_comparison-check.svg)](https://travis-ci.org/camptocamp/puppet-lint-version_comparison-check)
+[![Code Climate](https://codeclimate.com/github/camptocamp/puppet-lint-version_comparison-check/badges/gpa.svg)](https://codeclimate.com/github/camptocamp/puppet-lint-version_comparison-check)
+[![Gem Version](https://badge.fury.io/rb/puppet-lint-version_comparison-check.svg)](http://badge.fury.io/rb/puppet-lint-version_comparison-check)
+[![Coverage Status](https://img.shields.io/coveralls/camptocamp/puppet-lint-version_comparison-check.svg)](https://coveralls.io/r/camptocamp/puppet-lint-version_comparison-check?branch=master)
+
+A puppet-lint plugin to check for versions compared as numbers.
+
+## Checks
+
+### Version compared as number
+
+Versions should be managed as strings, and compared using the `versioncmp()` function.
+
+Not doing so will fail with the future parser starting with Puppet 3.7.4.
+
+#### What you have done
+
+```puppet
+if $version >= '4' { }
+```
+
+#### What you should have done
+
+```puppet
+if versioncmp($version, '4') >= 0 { }
+```
+
+#### Disabling the check
+
+To disable this check, you can add `--no-version_comparison-check` to your puppet-lint command line.
+
+```shell
+$ puppet-lint --no-version_comparison-check path/to/file.pp
+```
+
+Alternatively, if you’re calling puppet-lint via the Rake task, you should insert the following line to your `Rakefile`.
+
+```ruby
+PuppetLint.configuration.send('disable_version_comparison')
+```

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

@@ -0,0 +1,70 @@
+PuppetLint.new_check(:version_comparison) do
+  def is_num_comparison?(token)
+    return false unless token
+    return true if [:GREATEREQUAL, :GREATERTHAN, :LESSEQUAL, :LESSTHAN].include?(token.type)
+    return true if [:ISEQUAL, :NOTEQUAL].include?(token.type) && \
+                   token.next_code_token && \
+                   token.next_code_token.type == :NUMBER
+  end
+
+  def check
+    tokens.each_with_index do |token, token_idx|
+      next unless token.type == :VARIABLE
+      next unless token.value =~ /(?:version|release)$/
+      next unless is_num_comparison?(token.next_code_token)
+      notify :warning, {
+        :message => 'version compared as number',
+        :line    => token.line,
+        :column  => token.column,
+        :token   => token,
+      }
+    end
+  end 
+
+  def compared_value(token)
+    token.next_code_token.next_code_token.value
+  end
+
+  def fix(problem)
+    versioncmp = PuppetLint::Lexer::Token.new(
+      :NAME, 'versioncmp',
+      problem[:token].line, problem[:token].column,
+    )
+    lparen = PuppetLint::Lexer::Token.new(
+      :LPAREN, '(',
+      problem[:token].line, problem[:token].column+1,
+    )
+    rparen = PuppetLint::Lexer::Token.new(
+      :RPAREN, ')',
+      problem[:token].line, problem[:token].column+2 # not +2
+    )
+    space = PuppetLint::Lexer::Token.new(
+      :WHITESPACE, ' ',
+      problem[:token].line, problem[:token].column+3 # not +3
+    )
+    comma = PuppetLint::Lexer::Token.new(
+      :COMMA, ',',
+      problem[:token].line, problem[:token].column+4 # not +4
+    )
+    value = PuppetLint::Lexer::Token.new(
+      :SSTRING, compared_value(problem[:token]),
+      problem[:token].line, problem[:token].column+5 # not +5
+    )
+
+    idx = tokens.index(problem[:token])
+    # Set compare value to 0
+    value_token = problem[:token].next_code_token.next_code_token
+    value_token.value = 0
+    value_token.type = :NUMBER
+    # Insert ')' after value
+    tokens.insert(idx+2, space)
+    tokens.insert(idx+2, rparen)
+    # Insert value as string after comma
+    tokens.insert(idx+2, value)
+    # Insert comma after token
+    tokens.insert(idx+1, comma)
+    # Insert 'versioncmp(' before token
+    tokens.insert(idx, lparen)
+    tokens.insert(idx, versioncmp)
+  end
+end

data/spec/puppet-lint/plugins/check_version_comparison/version_comparison_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe 'version_comparison' do
+  let(:msg) { 'version compared as number' }
+
+  context 'with fix disabled' do
+    context 'when versions are not compared to numbers' do
+      let(:code) do
+        <<-EOS
+        if versioncmp($::lsbmajdistrelease, '4') >= 0 { }
+        if versioncmp($version, '1') <= 0 { }
+        if versioncmp($some_version, '3') < 0 { }
+        if $mod::params::version == '2' { }
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'when versions are compared to numbers' do
+      let(:code) do
+        <<-EOS
+        if $::lsbmajdistrelease >= 4 { }
+        if $version <= 1 { }
+        if $some_version < 3 { }
+        if $mod::params::version == 2 { }
+        EOS
+      end
+
+      it 'should detect 4 problems' do
+        expect(problems).to have(4).problems
+      end
+
+      it 'should create warnings' do
+        expect(problems).to contain_warning(msg).on_line(1).in_column(12)
+        expect(problems).to contain_warning(msg).on_line(2).in_column(12)
+        expect(problems).to contain_warning(msg).on_line(3).in_column(12)
+        expect(problems).to contain_warning(msg).on_line(4).in_column(12)
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'when versions are not compared to numbers' do
+      let(:code) do
+        <<-EOS
+        if versioncmp($::lsbmajdistrelease, '4') >= 0 { }
+        if versioncmp($version, '1') <= 0 { }
+        if versioncmp($some_version, '3') < 0 { }
+        if $mod::params::version == '2' { }
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'when versions are compared to numbers' do
+      let(:code) do
+        <<-EOS
+        if $::lsbmajdistrelease >= 4 { }
+        if $version <= 1 { }
+        if $some_version < 3 { }
+        if $mod::params::version == 2 { }
+        EOS
+      end
+
+      it 'should detect 4 problems' do
+        expect(problems).to have(4).problems
+      end
+
+      it 'should create warnings' do
+        expect(problems).to contain_fixed(msg).on_line(1).in_column(12)
+        expect(problems).to contain_fixed(msg).on_line(2).in_column(12)
+        expect(problems).to contain_fixed(msg).on_line(3).in_column(12)
+        expect(problems).to contain_fixed(msg).on_line(4).in_column(12)
+      end
+
+      it 'should should use versioncmp' do
+        expect(manifest).to eq(
+        <<-EOS
+        if versioncmp($::lsbmajdistrelease, '4') >= 0 { }
+        if versioncmp($version, '1') <= 0 { }
+        if versioncmp($some_version, '3') < 0 { }
+        if versioncmp($mod::params::version, '2') == 0 { }
+        EOS
+        )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-version_comparison-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Camptocamp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-19 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: mime-types
+  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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !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
+      A puppet-lint plugin to check for versions compared as numbers.
+email: raphael.pinson@camptocamp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/check_version_comparison.rb
+- spec/puppet-lint/plugins/check_version_comparison/version_comparison_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/camptocamp/puppet-lint-version_comparison-check
+licenses:
+- Apache-2.0
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A puppet-lint plugin to check for versions compared as numbers.
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/check_version_comparison/version_comparison_spec.rb