puppet-lint-roles_and_profiles-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21d70ef748ba82a8680ed21f0afb1dbed66ab250
+  data.tar.gz: 53ca9b19a35fb6329b75a44fbe31280184bd78e9
+SHA512:
+  metadata.gz: 2677efc5e828266cb8230f5aee9fcd15e141aa8f6a19fac3d827ded2c3d98d07e7808bac0fbee6973806796d44e9eedc96a04f39439934fdd324fd1660c405e0
+  data.tar.gz: 26ca3d361e718a279d1d996095a54c296154943ea46e12d6f93ef0c18264b960e74b3586a8430cf8b23dca3910048e2ae7d421d24e1351ef7bcc6eb3b877bf01

data/README.md

@@ -0,0 +1,49 @@
+# puppet-lint roles and profiles check
+
+Adds a new puppet-lint plugin to verify that your code matches Roles & Profiles
+paradigm.
+This plugin assumes that you role classes starts with ̀`roles`and your
+profiles classes starts with `profiles`.
+
+## Installation
+
+To use this plugin, add the following line to the Gemfile in your Puppet code
+base and run `bundle install`.
+
+```ruby
+gem 'puppet-lint-roles_and_profiles-check'
+```
+
+## Usage
+
+This plugin provides a new checks to `puppet-lint`.
+
+### node_definition
+
+**--fix support: No**
+
+This check will raise a warning is your node definition does not contain only a role declaration.
+
+```
+WARNING: expected only one role declaration
+```
+
+### roles_class_params
+
+**--fix support: No**
+
+This check will raise a warning for any parameter in your role definition.
+
+```
+WARNING: expected no class parameters
+```
+
+### roles_resource_declaration
+
+**--fix-support: No**
+
+This check will raise a warning for any resource declaration in you role defintion that is not a profile class.
+
+```
+WARNING: expected no resource declaration
+```

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

@@ -0,0 +1,64 @@
+PuppetLint.new_check(:node_definition) do
+
+  def node_indexes
+    @node_indexes ||= PuppetLint::Data.definition_indexes(:NODE)
+  end
+
+  def check
+    node_indexes.each do |node|
+      role_already_declared = false
+      resource_indexes.select { |r| r[:start] > node[:start] and r[:end] < node[:end] }.each do |resource|
+        if resource[:type].type != :CLASS or !resource[:type].next_code_token.next_code_token.value.start_with?('roles') or role_already_declared == true
+          notify :warning, {
+            :message => 'expected only one role declaration',
+            :line    => resource[:type].line,
+            :column  => resource[:type].column,
+            :token   => resource,
+          }
+        end
+        role_already_declared = true if resource[:type].type == :CLASS
+      end
+    end
+  end
+end
+
+PuppetLint.new_check(:roles_class_params) do
+  def check
+    class_indexes.select {|c| c[:name_token].value.start_with?('roles')}.each do |klass|
+      unless klass[:param_tokens].nil?
+        klass[:param_tokens].select {|t|t.type == :VARIABLE }.each do |token|
+          notify :warning, {
+            :message => 'expected no class parameters',
+            :line    => token.line,
+            :column  => token.column,
+          }
+        end
+      end
+    end
+  end
+end
+
+PuppetLint.new_check(:roles_resource_declaration) do
+  def check
+    class_indexes.select {|c| c[:name_token].value.start_with?('role')}.each do |klass|
+      resource_indexes.select { |r| r[:start] > klass[:start] and r[:end] < klass[:end] }.each do |resource|
+        if  resource[:type].type != :CLASS or !resource[:type].next_code_token.next_code_token.value.start_with?('profiles')
+          notify :warning, {
+            :message => 'expected no resource declaration',
+            :line    => resource[:type].line,
+            :column  => resource[:type].column,
+          }
+        end
+      end
+      tokens[klass[:start]..klass[:end]].select { |t| t.value == 'include' }.each do |token|
+        if !token.next_code_token.value.start_with?('profiles')
+          notify :warning, {
+            :message => 'expected no resource declaration',
+            :line    => token.line,
+            :column  => token.column,
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe 'node_definition' do
+  let(:msg) { 'expected only one role declaration' }
+
+  context 'with no node definition file' do
+    let(:code) do
+      <<-EOS
+class foo {
+}
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'with an empty node definition file' do
+    let(:code) do
+      <<-EOS
+node 'foo' {
+}
+class foo {
+}
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'with a node definition file that declares only a role' do
+    let(:code) do
+      <<-EOS
+node 'foo' {
+  class { 'roles::bar': }
+}
+class roles::bar {
+}
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'with a node definition file that declares a class that is not a role' do
+    let(:code) do
+      <<-EOS
+node 'foo' {
+  class { 'profiles::bar': }
+}
+class profiles::bar {
+}
+      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(2).in_column(3)
+    end
+  end
+
+  context 'with a node definition file that declares two roles' do
+    let(:code) do
+      <<-EOS
+node 'foo' {
+  class { 'roles::bar': }
+  class { 'roles::baz': }
+}
+class roles::bar {
+}
+class roles::baz {
+}
+      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(3)
+    end
+  end
+
+  context 'with a node definition file that declares a resource' do
+    let(:code) do
+      <<-EOS
+node 'foo' {
+  class { 'roles::bar': }
+  foo { 'bar': }
+}
+class roles::bar {
+}
+foo {
+}
+      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(3)
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe 'roles_class_params' do
+  let(:msg) { 'expected no class parameters' }
+
+  context 'when class is not a role' do
+    context 'with parameters' do
+      let(:code) do
+        <<-EOS
+class foo(
+  $bar = 'bar',
+) {
+}
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
+
+  context 'when class is a role' do
+    context 'with no parameters' do
+      let(:code) do
+        <<-EOS
+class roles::foo {
+}
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'with empty parenthesis' do
+      let(:code) do
+        <<-EOS
+class roles::foo(
+) {
+}
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'with one parameter' do
+      let(:code) do
+        <<-EOS
+class roles::foo(
+  $bar = 'bar',
+) {
+}
+        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(2).in_column(3)
+      end
+    end
+
+    context 'with two parameters' do
+      let(:code) do
+        <<-EOS
+class roles::foo(
+  $bar = 'bar',
+  $baz = 'baz',
+) {
+}
+        EOS
+      end
+
+      it 'should detect two problems' do
+        expect(problems).to have(2).problem
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(2).in_column(3)
+        expect(problems).to contain_warning(msg).on_line(3).in_column(3)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe 'roles_resource_declaration' do
+  let(:msg) { 'expected no resource declaration' }
+
+  context 'when class is not a role' do
+    context 'with parameters' do
+      let(:code) do
+        <<-EOS
+class foo(
+  $bar = 'bar',
+) {
+  baz { 'baz': }
+}
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
+
+  context 'when class is a role' do
+    context 'with no tokens' do
+      let(:code) do
+        <<-EOS
+class roles::foo {
+}
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'with profile declaration' do
+      let(:code) do
+        <<-EOS
+class roles::foo {
+  class { 'profiles::bar': }
+}
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'with any class declaration' do
+      let(:code) do
+        <<-EOS
+class roles::foo {
+  class { 'bar': }
+}
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(2).in_column(3)
+      end
+    end
+
+    context 'with profile inclusion' do
+      let(:code) do
+        <<-EOS
+class roles::foo {
+  include profiles::bar
+}
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'with any class inclusion' do
+      let(:code) do
+        <<-EOS
+class roles::foo {
+  include bar
+}
+        EOS
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(2).in_column(3)
+      end
+    end
+
+    context 'with one resource' do
+      let(:code) do 
+        <<-EOS
+class roles::foo {
+  include profiles::bar
+  bar { 'bar': }
+}
+        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(3)
+      end
+    end
+
+    context 'with two resources' do
+      let(:code) do 
+        <<-EOS
+class roles::foo {
+  include profiles::bar
+  bar { 'bar': }
+  quux { 'quux': }
+}
+        EOS
+      end
+
+      it 'should detect two problem' do
+        expect(problems).to have(2).problem
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(3).in_column(3)
+        expect(problems).to contain_warning(msg).on_line(4).in_column(3)
+      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,127 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-roles_and_profiles-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mickaël Canévet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-26 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
+      A puppet-lint plugin to check that:
+      - a node definition declares only a role,
+      - a role class does not have any param and only declares profiles,
+      - a profiles class can declare anything but a role.
+email: mickael.canevet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/puppet-lint/plugins/check_roles_and_profiles.rb
+- spec/puppet-lint/plugins/check_node_definition_spec.rb
+- spec/puppet-lint/plugins/check_roles_class_params_spec.rb
+- spec/puppet-lint/plugins/check_roles_resource_declaration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mcanevet/puppet-lint-roles_and_profiles-check
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A puppet-lint plugin to check some Roles&Profiles bests practices.
+test_files:
+- spec/puppet-lint/plugins/check_roles_class_params_spec.rb
+- spec/puppet-lint/plugins/check_node_definition_spec.rb
+- spec/puppet-lint/plugins/check_roles_resource_declaration_spec.rb
+- spec/spec_helper.rb