onceover-codequality 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 621dd3879252731da1ead692746cb93c74c1f324
+  data.tar.gz: 56c5923d93076bd3f1d5e80491aca65c1ffb78c7
+SHA512:
+  metadata.gz: c87747e88e8e2b5aed6eb0445f2316e90cbcdb18c20d667ec5e6c0dad6e8aa1ebb0167733aa0e5624cdbea3b3ffd2816d32aa7c252512fe7f9ff95559de1e2a4
+  data.tar.gz: 6236720885d9123824f82a61a5fe65a0b3cd66e50ce522ff7a4f1a3084fb19dc0d58dc52d096a532d908463a479752809e02ceae5a0e4ffe1e8c23c5e3eef965

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/.idea
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in onceover-helloworld.gemspec
+gemspec

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,109 @@
+# Onceover::CodeQuality
+
+This is the Code Quality plugin for [Onceover](https://github.com/dylanratcliffe/onceover), _The gateway drug to automated infrastructure testing with Puppet_
+
+## What does it do?
+The plugin checks your control repository for:
+
+* Linting
+* Syntax
+
+For sure you can hack around with rake/make and hack something up each time but aint nobody got time for that!
+
+## Installation
+
+Install the `onceover-codequality` gem by adding it to your `Gemfile` or by running the following command:
+
+```shell
+$ gem install onceover-codequality
+```
+
+## Usage
+
+Installing the codequality gem creates a new item within onceover's `run` command: `codequality`.  See `onceover run codequality --help` for all available options.
+
+The command will return `1` to the system if any tests fail, otherwise `0`, which makes it perfect to include in build pipelines.
+
+
+**Check all code in the control repository for Lint and Syntax errors**
+
+```shell
+$ onceover run codequality
+```
+
+**Skip Lint check**
+
+```shell
+$onceover run codequality --no_lint
+```
+
+**Skip syntax check**
+
+```shell
+$ onceover run codequality --no_syntax
+```
+
+## Sample output
+
+**All clear**
+
+```shell
+$ onceover run codequality
+INFO   -> Checking for lint...
+INFO   -> checking manifests
+INFO   -> checking site/role
+INFO   -> Checking syntax...
+---> syntax:manifests
+---> syntax:templates
+---> syntax:hiera:yaml
+INFO   -> Code Quality tests passed, have a nice day
+```
+
+**Lint and syntax errors**
+
+```shell
+$ onceover run codequality
+INFO   -> Checking for lint...
+INFO   -> checking manifests
+INFO   -> checking site/role
+./manifests/example.pp - WARNING: class not documented on line 1
+./manifests/webserver.pp - WARNING: class not documented on line 1
+./manifests/database_server.pp - WARNING: class not documented on line 1
+ERROR  -> Lint test failed, see previous errors
+INFO   -> Checking syntax...
+---> syntax:manifests
+Could not parse for environment *root*: Syntax error at 'ensure' at /home/geoff/crud/control-repo/manifests/bogus.pp:2:3
+ERROR  -> Syntax test failed, see previous errors
+ERROR  -> Code Quality tests failed, see previous error
+$ echo $?
+1
+```
+
+## FAQ
+
+**`WARN: Unresolved specs during Gem::Specification.reset`**
+
+I get these errors when I run `onceover run codequality` but everything seems to work, what gives?:
+
+```
+WARN: Unresolved specs during Gem::Specification.reset:
+      rake (>= 0)
+      hiera (< 4, >= 2.0)
+      gettext (>= 3.0.2)
+WARN: Clearing out unresolved specs.
+Please report a bug if this causes problems.
+```
+
+Beats me - something to do with rubygems.  The best way to beat this message is to use [bundler](https://github.com/bundler/bundler) which basically you should already be doing anyway (for your own sanity):
+
+```shell
+$ bundle exec onceover run codequality
+```
+
+## Development
+
+If you have new ideas for things to check this might be a handy place to add them, please open a ticket, otherwise see the [helloworld plugin](https://github.com/declarativesystems/onceover-helloworld) if you want to have a go at writing a plugin of your own.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/declarativesystems/onceover-codequality.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "onceover/helloworld"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/onceover/codequality/cli.rb

@@ -0,0 +1,53 @@
+require "onceover/codequality/lint"
+require "onceover/codequality/syntax"
+class Onceover
+  module CodeQuality
+    class CLI
+
+        def self.command
+          @cmd ||= Cri::Command.define do
+            name 'codequality'
+            usage 'codequality [--no-lint] [--no-syntax]'
+            summary "Code Quality checking for onceover"
+            description <<-DESCRIPTION
+Check files in your Control Repository for Lint and Syntax errors
+            DESCRIPTION
+          
+            option :l, :no_lint, 'Do not check for lint errors', :argument => :optional
+            option :x, :no_syntax, 'Do not check for syntax errors', :argument => :optional
+
+            run do |opts, args, cmd|
+              no_lint = opts[:no_lint] || false
+              no_syntax = opts[:no_syntax] || false
+              status = true
+              if ! no_lint
+                logger.info "Checking for lint..."
+                if ! Onceover::CodeQuality::Lint.puppet
+                  status = false
+                  logger.error "Lint test failed, see previous errors"
+                end
+              end
+
+              if ! no_syntax
+                logger.info "Checking syntax..."
+                if ! Onceover::CodeQuality::Syntax.puppet
+                  status = false
+                  logger.error "Syntax test failed, see previous errors"
+                end
+              end
+
+              if status
+                logger.info "Code Quality tests passed, have a nice day"
+              else
+                logger.error "Code Quality tests failed, see previous error"
+                exit 1
+              end
+            end
+          end
+        end
+      end
+  end
+end
+
+Onceover::CLI::Run.command.add_command(Onceover::CodeQuality::CLI.command)
+

data/lib/onceover/codequality/lint.rb

@@ -0,0 +1,36 @@
+class Onceover
+  module CodeQuality
+    module Lint
+
+      # Apply linting to the manifests directory and each module under `site` 
+      LINT_PATHS = [
+        "manifests",
+      ].concat(Dir.glob('site/*').select {|f| File.directory? f})
+
+      LINT_OPTIONS = [
+        "--relative",
+        "--fail-on-warnings",
+        "--no-double_quoted_strings-check",
+        "--no-80chars-check",
+        "--no-variable_scope-check",
+        "--no-quoted_booleans-check",
+      ]
+
+      def self.puppet
+        status = true
+        LINT_PATHS.each { |p|
+          if Dir.exists?(p)
+            Dir.chdir(p) do
+              logger.info("checking #{p}")
+              if ! system("puppet-lint #{LINT_OPTIONS.join ' '} . ")
+                status = false
+              end
+            end
+          end
+        }
+
+        status
+      end
+    end
+  end
+end

data/lib/onceover/codequality/syntax.rb

@@ -0,0 +1,19 @@
+# puppet-syntax does everything we want so we just need a handy way to run
+# it and check the result
+class Onceover
+  module CodeQuality
+    module Syntax
+      def self.puppet
+        # rake task contains an exit statement so run it in a subshell to
+        # capture and continue
+        status = system(
+"ruby << EOD
+    require 'puppet-syntax/tasks/puppet-syntax'
+    Rake::Task['syntax'].invoke
+EOD")
+        status
+      end
+    end
+  end
+end
+

data/lib/onceover/codequality/version.rb

@@ -0,0 +1,5 @@
+class Onceover
+  module CodeQuality
+    VERSION = "0.1.0"
+  end
+end

data/lib/onceover/codequality.rb

@@ -0,0 +1,10 @@
+require "onceover/codequality/version"
+require "onceover/codequality/cli"
+
+class Onceover
+  module CodeQuality
+    # Your code goes here...
+  end
+end
+
+

data/onceover-codequality.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "onceover/codequality/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "onceover-codequality"
+  spec.version       = Onceover::CodeQuality::VERSION
+  spec.authors       = ["Declarative Systems"]
+  spec.email         = ["sales@declarativesystems.com"]
+  spec.license       = "Apache-2.0"
+
+  spec.summary       = %q{Lint and syntax validation for onceover}
+  spec.homepage      = "https://github.com/declarativesystems/onceover-codequality"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency 'onceover', '~> 3'
+  spec.add_runtime_dependency 'puppet-syntax', '~> 2'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: onceover-codequality
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Declarative Systems
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: onceover
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: puppet-syntax
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: 
+email:
+- sales@declarativesystems.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/onceover/codequality.rb
+- lib/onceover/codequality/cli.rb
+- lib/onceover/codequality/lint.rb
+- lib/onceover/codequality/syntax.rb
+- lib/onceover/codequality/version.rb
+- onceover-codequality.gemspec
+homepage: https://github.com/declarativesystems/onceover-codequality
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Lint and syntax validation for onceover
+test_files: []