puppet-lint-wmf_styleguide-check 1.0.0

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

@@ -0,0 +1,180 @@
+require 'spec_helper'
+
+class_ok = <<-EOF
+class foo {
+      notice("foo!")
+      include ::foo::configuration
+      sysctl::setting { 'something':
+          value => 10,
+      }
+}
+EOF
+
+class_ko = <<-EOF
+class foo($t=hiera('foo::title')) {
+       $msg = hiera( "foo::bar")
+       notice($msg)
+       notice($t)
+       include ::passwords::redis
+       class { 'bar': }
+}
+EOF
+
+profile_ok = <<-EOF
+class profile::foobar ($test=hiera('profile::foobar::test')) {
+      require ::profile::foo
+      include ::passwords::redis
+      class { '::bar': }
+}
+EOF
+
+profile_ko = <<-EOF
+class profile::fixme (
+      $test,
+) {
+    include ::apache2::common
+    $role = hiera('role')
+    system::role { $role: }
+}
+EOF
+
+role_ok = <<-EOF
+class role::fizzbuz {
+      include standard
+      include ::profile::base
+      include ::profile::bar
+      system::role { 'fizzbuzz': }
+}
+EOF
+
+role_ko = <<-EOF
+class role::fixme () {
+      include ::monitoring::host
+      include ::profile::base
+      class { '::role::something': }
+}
+EOF
+
+define_ok = <<-EOF
+define foo::bar (
+       sysctl::setting { 'test': }
+       file { 'something':
+          content => template('something.erb')
+       }
+)
+EOF
+
+define_ko = <<-EOF
+define foo::fixme ($a=hiera('something')) {
+       include ::foo
+       class { '::bar': }
+}
+EOF
+
+node_ok = <<-EOF
+node /^test1.*\.example\.com$/ {
+     role(spare::system)
+}
+EOF
+
+node_ko = <<-EOF
+node 'fixme' {
+     role(spare::system,
+          mediawiki::appserver)
+     include base::firewall
+     interface::mapped { 'eth0':
+        foo => 'bar'
+     }
+}
+EOF
+
+describe 'wmf_styleguide' do
+  context 'class correctly written' do
+    let(:code) { class_ok }
+    it 'should not detect any problems' do
+      puts(problems)
+      expect(problems).to have(0).problems
+    end
+  end
+  context 'profile correctly written' do
+    let(:code) { profile_ok }
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+  context 'role correctly written' do
+    let(:code) { role_ok }
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'class with errors' do
+    let(:code) { class_ko }
+    it 'should create errors for hiera declarations' do
+      expect(problems).to contain_error("wmf-style: Found hiera call in class 'foo' for 'foo::title'").on_line(1).in_column(14)
+      expect(problems).to contain_error("wmf-style: Found hiera call in class 'foo' for 'foo::bar'").on_line(2).in_column(15)
+    end
+    it 'should create errors for included classes' do
+      expect(problems).to contain_error("wmf-style: class 'foo' includes passwords::redis from another module").on_line(5).in_column(16)
+      expect(problems).to contain_error("wmf-style: class 'foo' declares class bar from another module").on_line(6).in_column(16)
+    end
+  end
+
+  context 'profile with errors' do
+    let(:code) { profile_ko }
+    it 'should create errors for parameters without hiera defaults' do
+      expect(problems).to contain_error("wmf-style: Parameter 'test' of class 'profile::fixme' has no call to hiera").on_line(2).in_column(7)
+    end
+    it 'should create errors for hiera calls in body' do
+      expect(problems).to contain_error("wmf-style: Found hiera call in class 'profile::fixme' for 'role'").on_line(5).in_column(13)
+    end
+    it 'should create errors for use of system::role' do
+      expect(problems).to contain_error("wmf-style: class 'profile::fixme' declares system::role, which should only be used in roles").on_line(6).in_column(5)
+    end
+    it 'should create errors for non-explicit class inclusion' do
+      expect(problems).to contain_error("wmf-style: profile 'profile::fixme' includes non-profile class apache2::common").on_line(4).in_column(13)
+    end
+  end
+
+  context 'role with errors' do
+    let(:code) { role_ko }
+    it 'should generate errors for non-profile class inclusion' do
+      expect(problems).to contain_error("wmf-style: role 'role::fixme' includes monitoring::host which is neither a role nor a profile")
+    end
+  end
+  context 'defined type with no errors' do
+    let(:code) { define_ok }
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+  context 'defined type with violations' do
+    let(:code) { define_ko }
+    it 'should not contain hiera calls' do
+      expect(problems).to contain_error("wmf-style: Found hiera call in defined type 'foo::fixme' for 'something'").on_line(1)
+    end
+    it 'should not include or define any class' do
+      expect(problems).to contain_error("wmf-style: defined type 'foo::fixme' declares class bar from another module").on_line(3)
+    end
+  end
+
+  context 'node with no errors' do
+    let(:code) { node_ok }
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+  context 'node with violations' do
+    let(:code) { node_ko }
+    it 'should not have multiple roles applied' do
+      expect(problems).to contain_error("wmf-style: node 'fixme' includes multiple roles").on_line(2)
+    end
+    it 'should not include classes directly' do
+      expect(problems).to contain_error("wmf-style: node 'fixme' includes class base::firewall")
+    end
+    it 'should not declare any defined type' do
+      expect(problems).to contain_error("wmf-style: node 'fixme' declares interface::mapped")
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-wmf_styleguide-check
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Giuseppe Lavagetto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+description: |2
+      A puppet-lint plugin to check that the code adheres to the WMF coding guidelines:
+
+      * Check for hiera in non-profiles, and in the body of those
+      * Check for roles with declared resources that are not profiles
+      * Check for parametrized roles
+      * Check for node declarations not using the role keyword
+      * Check for system::role calls outside of roles
+      * Check for cross-module class inclusion
+      * Check for the use of the include keyword in profiles
+email: lavagetto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/check_wmf_styleguide.rb
+- spec/puppet-lint/plugins/check_wmf_styleguide_check_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wikimedia/operations-puppet-lint-wmf_styleguide-check
+licenses:
+- GPL-3.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.5.2.1
+signing_key: 
+specification_version: 4
+summary: A puppet-lint plugin to check code adheres to the WMF coding guidelines
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/check_wmf_styleguide_check_spec.rb