onceover-codequality 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62bf60e630876715685b9a6cf9c92f7664481b86ce6a3fc2544146891d416a13
-  data.tar.gz: 690ee5d1ff1655aca38c26c05711e2bbe401c01686c9a981c4040e025241a01b
+  metadata.gz: ee41694d81a21ab44a8d2c7b6630740ac8caa219d64e2bbcf14fadf1f9d919af
+  data.tar.gz: a3a16cc00241852ee07f0cf162cdd2fb10187c9218912ef814f3f13dcd6ce44d
 SHA512:
-  metadata.gz: ae234b3b18058e23d409dee9d3fcbe31c1df4b1d047386e96d940f066aafab0ebdda10ac2ccc1017e7f8acc60709b25b8a1c98062bf58f6f91327ea15132dece
-  data.tar.gz: efe6218964f4329e9e20ab2546b744b851a5daab8e334257f8dae9a9cb757bfed6a4ac0b0bcd1dbebd8847fe7cb1a8846e8fd5806eb57ec5e2d588459a20a496
+  metadata.gz: 6f63484487dc3d9211652a827648879b1d8c9dc76e7720b959dff30e17357061bd249cc5eb1fc5a22ac3fe714809e36bdd2cff65f72e4ddf2ac6dedcb6b1ea78
+  data.tar.gz: 75e20bdd744457c8783c903f290cc4238d83f3d44479db02146f00f666daacab8041cb7d0abead69df1b468ed0e441b488cb0863a48f89d5b2e3e021b8757f65

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
-/.yardoc
-/Gemfile.lock
+**/.yardoc
+**/REFERENCE.md
+/spec/fixtures/**/doc
 /_yardoc/
 /coverage/
 /doc/
@@ -12,3 +13,4 @@
 .rspec_status
 /.idea
 *.gem
+

data/Gemfile.lock

@@ -0,0 +1,143 @@
+PATH
+  remote: .
+  specs:
+    onceover-codequality (0.6.0)
+      onceover (~> 3)
+      puppet-lint (~> 2)
+      puppet-strings (~> 2)
+      puppet-syntax (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    backticks (1.0.2)
+    blockenspiel (0.5.0)
+    colored (1.2)
+    cri (2.15.6)
+    deep_merge (1.2.1)
+    diff-lcs (1.3)
+    facter (2.5.1)
+    faraday (0.13.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    fast_gettext (1.1.2)
+    gettext (3.2.9)
+      locale (>= 2.0.5)
+      text (>= 1.3.0)
+    gettext-setup (0.30)
+      fast_gettext (~> 1.1.0)
+      gettext (>= 3.0.2)
+      locale
+    git (1.5.0)
+    hiera (3.5.0)
+    hocon (1.2.5)
+    httpclient (2.8.3)
+    json (2.2.0)
+    little-plugger (1.1.4)
+    locale (2.1.2)
+    log4r (1.1.10)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    metaclass (0.0.4)
+    minitar (0.8)
+    mocha (1.9.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.13.1)
+    multipart-post (2.1.1)
+    onceover (3.13.4)
+      backticks (>= 1.0.2)
+      colored (~> 1.2)
+      cri (>= 2.6)
+      deep_merge (>= 1.0.0)
+      git
+      json (>= 1.8.2)
+      logging (>= 2.0.0)
+      parallel_tests (>= 2.0.0)
+      puppet (>= 3.4.0)
+      puppetlabs_spec_helper (>= 0.4.0)
+      r10k (>= 2.1.0)
+      rake (>= 10.0.0)
+      rspec (>= 3.0.0)
+      rspec-puppet (>= 2.4.0)
+      rspec_junit_formatter (>= 0.2.0)
+      table_print (>= 1.0.0)
+      versionomy (>= 0.5.0)
+    parallel (1.17.0)
+    parallel_tests (2.29.1)
+      parallel
+    pathspec (0.2.1)
+    puppet (6.4.2)
+      facter (> 2.0.1, < 4)
+      fast_gettext (~> 1.1.2)
+      hiera (>= 3.2.1, < 4)
+      httpclient (~> 2.8)
+      locale (~> 2.1)
+      multi_json (~> 1.10)
+      puppet-resource_api (~> 1.5)
+      semantic_puppet (~> 1.0)
+    puppet-lint (2.3.6)
+    puppet-resource_api (1.8.3)
+      hocon (>= 1.0)
+    puppet-strings (2.2.0)
+      rgen
+      yard (~> 0.9.5)
+    puppet-syntax (2.4.3)
+      rake
+    puppet_forge (2.2.9)
+      faraday (>= 0.9.0, < 0.14.0)
+      faraday_middleware (>= 0.9.0, < 0.13.0)
+      gettext-setup (~> 0.11)
+      minitar
+      semantic_puppet (~> 1.0)
+    puppetlabs_spec_helper (2.14.1)
+      mocha (~> 1.0)
+      pathspec (~> 0.2.1)
+      puppet-lint (~> 2.0)
+      puppet-syntax (~> 2.0)
+      rspec-puppet (~> 2.0)
+    r10k (3.3.0)
+      colored (= 1.2)
+      cri (= 2.15.6)
+      gettext-setup (~> 0.24)
+      log4r (= 1.1.10)
+      multi_json (~> 1.10)
+      puppet_forge (~> 2.2.8)
+    rake (10.5.0)
+    rgen (0.8.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-puppet (2.7.5)
+      rspec
+    rspec-support (3.8.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    semantic_puppet (1.0.2)
+    table_print (1.5.6)
+    text (1.3.1)
+    versionomy (0.5.0)
+      blockenspiel (~> 0.5)
+    yard (0.9.19)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  onceover-codequality!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/lib/onceover/codequality.rb

@@ -3,7 +3,6 @@ require "onceover/codequality/cli"
 
 class Onceover
   module CodeQuality
-    # Your code goes here...
   end
 end
 

data/lib/onceover/codequality/cli.rb

@@ -2,6 +2,8 @@ require "onceover/codequality/lint"
 require "onceover/codequality/syntax"
 require "onceover/codequality/docs"
 require "onceover/codequality/puppetfile"
+require "onceover/codequality/executor"
+require "onceover/codequality/formatter"
 class Onceover
   module CodeQuality
     class CLI
@@ -29,6 +31,8 @@ class Onceover
               html_docs = opts[:html_docs] || false
               status = true
 
+              logger.info "Running Code Quality tests"
+
               if ! no_puppetfile
                 status &= Onceover::CodeQuality::Puppetfile.puppetfile
               end
@@ -46,9 +50,9 @@ class Onceover
               end
 
               if status
-                logger.info "Code Quality tests passed, have a nice day"
+                logger.info "Code Quality tests PASSED, have a nice day"
               else
-                logger.error "Code Quality tests failed, see previous error"
+                logger.error "Code Quality tests FAILED, see previous error(s)"
                 exit 1
               end
             end

data/lib/onceover/codequality/docs.rb

@@ -6,18 +6,16 @@ class Onceover
       LOCAL_MOD_DIR = "site"
 
       def self.puppet_strings(html_docs)
-        logger.info "Generating documentation..."
         status = true
-        format = html_docs ? "html" : "markdown"
+        format = html_docs ? "--markup html" : "--format markdown"
         if Dir.exist?(LOCAL_MOD_DIR)
           Dir.glob("#{LOCAL_MOD_DIR}/*/") { |dir|
             Dir.chdir(dir) {
+              CodeQuality::Formatter.start_test("Generate documentation in #{dir}")
               # puppet strings prints useful metrics so don't swallow its output
-              s = system("puppet strings generate --format #{format}")
-              if ! s
-                logger.error("Error running puppet strings - see previous output")
-              end
-              status &= s
+              output, ok = CodeQuality::Executor.run("puppet strings generate #{format}")
+              status &= ok
+              CodeQuality::Formatter.end_test(output, ok, true)
             }
           }
         end

data/lib/onceover/codequality/executor.rb

@@ -0,0 +1,14 @@
+class Onceover
+  module CodeQuality
+    module Executor
+
+      # Capture all program output and check the exit status was zero
+      def self.run(*command)
+        output, s = Open3.capture2e(*command)
+        ok = s.exitstatus.zero?
+
+        return output, ok
+      end
+    end
+  end
+end

data/lib/onceover/codequality/formatter.rb

@@ -0,0 +1,28 @@
+class Onceover
+  module CodeQuality
+    module Formatter
+
+      START_TEST = "Checking".freeze
+      MSG_TEST_OK = "...OK".freeze
+
+
+      def self.start_test(test_name)
+        logger.info "Checking #{test_name}..."
+      end
+
+      def self.end_test(output, ok, show_output=false)
+        if !ok || show_output
+          output.each_line do |line|
+            logger.info("\t#{line.chomp}")
+          end
+        end
+
+        if ok
+          logger.info "...OK"
+        else
+          logger.error "...FAILED"
+        end
+      end
+    end
+  end
+end

data/lib/onceover/codequality/lint.rb

@@ -5,7 +5,7 @@ class Onceover
       # Apply linting to the manifests directory and each module under `site`
       LINT_PATHS = [
         "manifests",
-      ].concat(Dir.glob('site/*').select {|f| File.directory? f})
+      ]
 
       # use our default options unless user has created own settings
       if ! File.exist? ".puppet-lint.rc"
@@ -23,15 +23,18 @@ class Onceover
 
       def self.puppet
         status = true
-        LINT_PATHS.each { |p|
-          if Dir.exists?(p)
-            logger.info("checking lint in #{p}...")
-            if ! system("puppet-lint #{LINT_OPTIONS.join ' '} #{p}")
-              status = false
-            else
-              logger.info("...ok")
-            end
 
+        # wait until runtime to scan directories for unit tests
+        lint_paths = LINT_PATHS.concat(
+          Dir.glob('site/*')
+          .select { |f| File.directory? f}
+        )
+        lint_paths.each { |p|
+          if Dir.exists?(p)
+            CodeQuality::Formatter.start_test("lint in #{p}")
+            output, ok = CodeQuality::Executor.run("puppet-lint #{LINT_OPTIONS.join ' '} #{p}")
+            status &= ok
+            CodeQuality::Formatter.end_test(output, ok)
           end
         }
 

data/lib/onceover/codequality/puppetfile.rb

@@ -6,16 +6,12 @@ class Onceover
       def self.puppetfile
         status = true
         if File.exist?("Puppetfile")
-          logger.info("Checking Puppetfile...")
-          output, s = Open3.capture2e("r10k puppetfile check")
-          ok = s.exitstatus.zero?
+          CodeQuality::Formatter.start_test("Puppetfile")
+          output, ok = CodeQuality::Executor.run("r10k puppetfile check")
+
           status &= ok
 
-          if ok
-            logger.info("...ok")
-          else
-            logger.error("Puppetfile validation failed: #{output}")
-          end
+          CodeQuality::Formatter.end_test(output, ok)
         else
           logger.warn("No Puppetfile found... continuing")
         end

data/lib/onceover/codequality/syntax.rb

@@ -1,4 +1,4 @@
-require 'open3'
+
 class Onceover
   module CodeQuality
     module Syntax
@@ -10,7 +10,7 @@ class Onceover
         # puppet-syntax
         #
 
-        logger.info("Checking syntax using puppet-syntax rake task...")
+        CodeQuality::Formatter.start_test("puppet-syntax rake task")
         # puppet-syntax seems to assign $stdout/$stderr internally in ways that
         # prevent capturing output. As a nasty hack, run it as inline ruby and
         # capture the output from the process...
@@ -19,15 +19,10 @@ class Onceover
           PuppetSyntax.exclude_paths = ['vendor/**/*','spec/templates/*.erb']
           Rake::Task['syntax'].invoke
         RUBY_CODE
-        output, s = Open3.capture2e("ruby", "-e", inline_ruby)
-        ok = s.exitstatus.zero?
+        #output, s = Open3.capture2e("ruby", "-e", inline_ruby)
+        output, ok = CodeQuality::Executor.run("ruby", "-e", inline_ruby)
         status &= ok
-
-        if ok
-          logger.info("...ok")
-        else
-          logger.error("puppet-syntax validation failed: #{output}")
-        end
+        CodeQuality::Formatter.end_test(output, ok)
 
         #
         # python yaml
@@ -45,17 +40,11 @@ class Onceover
         # users would be advised to fix the file, so lets _also_ validate yaml
         # files with python if available on our path...
         if system("python --version && python -c 'import yaml'", :err => File::NULL)
-          logger.info("Running additional python YAML validation")
+          CodeQuality::Formatter.start_test("Additional python YAML validation")
           script = File.join(File.dirname(File.expand_path(__FILE__)), "../../../res/validate_yaml.py")
-          output, s = Open3.capture2e("python #{script}")
-          ok = s.exitstatus.zero?
+          output, ok = CodeQuality::Executor.run("python #{script}")
           status &= ok
-
-          if ok
-            logger.info("...ok")
-          else
-            logger.error("Puppetfile validation failed: #{output}")
-          end
+          CodeQuality::Formatter.end_test(output, ok)
         else
           logger.warn("Please install python and pyyaml for enhanced YAML validation (pip install pyyaml)")
         end

data/lib/onceover/codequality/version.rb

@@ -1,5 +1,5 @@
 class Onceover
   module CodeQuality
-    VERSION = "0.5.3"
+    VERSION = "0.6.0"
   end
 end

data/onceover-codequality.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   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 "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onceover-codequality
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Declarative Systems
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2019-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -127,6 +128,8 @@ files:
 - lib/onceover/codequality.rb
 - lib/onceover/codequality/cli.rb
 - lib/onceover/codequality/docs.rb
+- lib/onceover/codequality/executor.rb
+- lib/onceover/codequality/formatter.rb
 - lib/onceover/codequality/lint.rb
 - lib/onceover/codequality/puppetfile.rb
 - lib/onceover/codequality/syntax.rb