puppet-lint-metrics-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d51581998a6c07979046e2f521f0adff298e2feb
+  data.tar.gz: 8ccd7883109b2c468e3265a5a84d85b450603370
+SHA512:
+  metadata.gz: 8604ae5a4cd11e6e6f6d0ce1a0ce43dc55a23cc0e1f55debffda75d0f768219ef49a9c1bce3b740738b07af1de504739ad28f53f6d637275e03aa88d6b0d5981
+  data.tar.gz: c7ccbb60524c49e3b79d2df186cd885d4c40ef5c07a89db950cda4bdcdcd26238fa3a9237f35ea3717e7800cc0bb8c3666f08b7886252689810092608c267b1d

data/README.md

@@ -0,0 +1,50 @@
+# puppet-lint-metrics-check
+
+[![Build Status](https://img.shields.io/travis/danzilio/puppet-lint-metrics-check.svg)](https://travis-ci.org/danzilio/puppet-lint-metrics-check)
+[![Gem Version](https://img.shields.io/gem/v/puppet-lint-metrics-check.svg)](https://rubygems.org/gems/puppet-lint-metrics-check)
+[![Gem Downloads](https://img.shields.io/gem/dt/puppet-lint-metrics-check.svg)](https://rubygems.org/gems/puppet-lint-metrics-check)
+
+A puppet-lint plugin to analyze your code and report code quality metrics. Right now this code only supports the Assignment Branch Condition metric. For more information on how we compute this metric, please see [docs/abc_metric.md](docs/abc_metric.md).
+
+## Installing
+### From the command line
+```shell
+$ gem install puppet-lint-metrics-check
+```
+
+### In a Gemfile
+```ruby
+gem 'puppet-lint-metrics-check'
+```
+
+## Checks
+### Assignment Branch Condition Size
+
+This check calculates the Assignment Branch Condition (ABC) size for your manifest. By default, if the ABC size calculated for your manifest is above 30 a warning will be reported, if it's above 100 puppet-lint will report an error.
+
+You can customize the warning and error thresholds using the `PuppetLint.configuration.metrics_abc_error` and `PuppetLint.configuration.metrics_abc_warning` methods. You can configure these values in your `Rakefile`.
+
+#### To set the error threshold to 50
+
+```ruby
+PuppetLint.configuration.metrics_abc_error = 50
+```
+
+#### To set the warning threshold to 10
+
+```ruby
+PuppetLint.configuration.metrics_abc_warning = 10
+```
+
+#### Disabling the check
+To disable this check, you can add `--no-abc_metric-check` to your puppet-lint command line.
+
+```shell
+$ puppet-lint --no-abc_metric-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_abc_metric')
+```

data/lib/puppet-lint/metrics/abc.rb

@@ -0,0 +1,107 @@
+require 'puppet'
+
+class PuppetLint
+  module Metrics
+    class Abc
+      attr_reader :metrics
+
+      def initialize()
+        @@abc_visitor ||= Puppet::Pops::Visitor.new(nil, "abc", 0, 0)
+        @metrics = {
+          assignment: 0,
+          branch: 0,
+          conditional: 0,
+        }
+      end
+
+      def compute(target)
+        target.eAllContents.each { |m| abc(m) }
+        [@metrics, Math.sqrt(@metrics[:assignment]**2 + @metrics[:branch]**2 + @metrics[:conditional]**2).round(2)]
+      end
+
+      def abc(o)
+        @@abc_visitor.visit_this_0(self, o)
+      end
+
+      def abc_Object(o)
+        nil
+      end
+
+      def conditional
+        @metrics[:conditional] += 1
+      end
+
+      def branch
+        @metrics[:branch] += 1
+      end
+
+      def assignment
+        @metrics[:assignment] += 1
+      end
+
+      def abc_AssignmentExpression(o)
+        assignment
+      end
+
+      def abc_AttributeOperation(o)
+        assignment
+      end
+
+      def abc_ResourceExpression(o)
+        branch
+      end
+
+      def abc_CollectorExpression(o)
+        branch
+      end
+
+      def abc_CallExpression(o)
+        branch
+      end
+
+      def abc_BlockExpression(o)
+        branch
+      end
+
+      def abc_EqualityExpression(o)
+        conditional
+      end
+
+      def abc_MatchExpression(o)
+        conditional
+      end
+
+      def abc_NotMatchExpression(o)
+        conditional
+      end
+
+      def abc_ComparisonExpression(o)
+        conditional
+      end
+
+      def abc_InExpression(o)
+        conditional
+      end
+
+      def abc_NotExpression(o)
+        conditional
+      end
+
+      def abc_IfExpression(o)
+        conditional
+      end
+
+      def abc_UnlessExpression(o)
+        conditional
+      end
+
+      def abc_CaseExpression(o)
+        conditional
+      end
+
+      def abc_SelectorExpression(o)
+        conditional
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'puppet-lint/metrics/abc'
+
+PuppetLint.new_check(:abc_size) do
+  def check
+    @warn = PuppetLint.configuration.metrics_abc_warning || 30
+    @fail = PuppetLint.configuration.metrics_abc_error || 100
+
+    parser = Puppet::Pops::Parser::EvaluatingParser.new
+    program = parser.parse_string(manifest_lines.join("\n"))
+    abc_metric = PuppetLint::Metrics::Abc.new
+
+    abc_size = abc_metric.compute(program.model).last
+
+    notification = {
+      :message => "assignment branch condition size is #{abc_size}",
+      :line    => 0,
+      :column  => 0,
+    }
+
+    if @fail > abc_size
+      if abc_size >= @warn
+        notify :warning, notification
+      end
+    else
+      notify :error, notification
+    end
+  end
+end

data/spec/spec/puppet-lint/plugins/check_abc_size/check_abc_size_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe 'abc_size' do
+  context 'warn when abc is above the configured warning size' do
+    before do
+      PuppetLint.configuration.metrics_abc_warning = 0
+    end
+
+    let(:code) do
+      <<-EOS
+      include foo
+      EOS
+    end
+
+    it 'should have one problem' do
+      expect(problems).to have(1).problems
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning('assignment branch condition size is 1.0')
+    end
+  end
+
+  context 'fail when abc is above the configured failure size' do
+    before do
+      PuppetLint.configuration.metrics_abc_error = 0
+    end
+
+    let(:code) do
+      <<-EOS
+      include foo
+      EOS
+    end
+
+    it 'should have one problem' do
+      expect(problems).to have(1).problems
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_error('assignment branch condition size is 1.0')
+    end
+  end
+
+  context 'do nothing when abc is within parameters' do
+    before do
+      PuppetLint.configuration.metrics_abc_warning = 30
+      PuppetLint.configuration.metrics_abc_error = 100
+    end
+
+    let(:code) do
+      <<-EOS
+      include foo
+      EOS
+    end
+
+    it 'should have one problem' do
+      expect(problems).to have(0).problems
+    end
+
+    it 'should create a warning' do
+      expect(problems).not_to contain_error('assignment branch condition size is 1.0')
+      expect(problems).not_to contain_warning('assignment branch condition size is 1.0')
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-metrics-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Danzilio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-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: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !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 puppet-lint plugin to check code quality metrics.
+email: david@danzilio.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/puppet-lint/metrics/abc.rb
+- lib/puppet-lint/plugins/check_abc_size.rb
+- spec/spec/puppet-lint/plugins/check_abc_size/check_abc_size_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/danzilio/puppet-lint-metrics-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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A puppet-lint plugin to check code quality metrics.
+test_files:
+- spec/spec/puppet-lint/plugins/check_abc_size/check_abc_size_spec.rb
+- spec/spec_helper.rb