onceover-codequality 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d002a389642fbd94ce6014ecff04a722df6fc11b839f1b89da4af142a45939b
-  data.tar.gz: 85a5ed0c78832166281dad179ce1dcec6ee635f6a34738444273e3da263c7fba
+  metadata.gz: 539deb30ea7e0a162926b170e8adf94de19e7e469eb1212801daedc20b994318
+  data.tar.gz: ed7c7de7e391a6faac5e78e66b4edd6ed38868311a299a19e197bba873939471
 SHA512:
-  metadata.gz: 63a2b200eec20907c736b91a5bb853f362c5de63ae8b49f4bbef02f26ba06f1a71c3e362f1cb4d6901578a3948da3474c979863a4798d9876f2a4de410e2e06e
-  data.tar.gz: 8ad26cf6dbc73ab8915719af1fe1a421faf348dd1dadf995d9915602763608132a57b0b6e7e7c5555125f88296ee606fb8261a1f1544002c58d1a1d8fd90ab60
+  metadata.gz: 70ea401197ac110b5f53fbd3e4d433889d6171181e88c790ca2eabb5b8fb88163c5427b097875355c296aea3f595650ecf64b8dc1bacb5ef7ffe0f5e2ab75930
+  data.tar.gz: 14532de430f9523b8519fca0fe1b3a9aabb27f117446668eeed95ca1b5b4df1c2b70aa2bf0902cff8b930f830d0185dd2990d90524a5e6ba5bf20946a713a0df

data/lib/onceover/codequality/cli.rb

@@ -29,36 +29,20 @@ class Onceover
               html_docs = opts[:html_docs] || false
               status = true
 
-              if ! no_syntax
-                logger.info "Checking syntax..."
-                if ! Onceover::CodeQuality::Syntax.puppet
-                  status = false
-                  logger.error "Syntax test failed, see previous errors"
-                end
+              if ! no_puppetfile
+                status &= Onceover::CodeQuality::Puppetfile.puppetfile
               end
 
-              if ! no_lint
-                logger.info "Checking for lint..."
-                if ! Onceover::CodeQuality::Lint.puppet
-                  status = false
-                  logger.error "Lint test failed, see previous errors"
-                end
+              if ! no_syntax
+                status &= Onceover::CodeQuality::Syntax.puppet
               end
 
-              if ! no_puppetfile
-                logger.info "Checking Puppetfile"
-                if ! Onceover::CodeQuality::Puppetfile.puppetfile
-                  status = false
-                  logger.error "puppetfile syntax failed, see previous errors"
-                end
+              if ! no_lint
+                status &= Onceover::CodeQuality::Lint.puppet
               end
 
               if ! no_docs
-                logger.info "Generating documentation..."
-                if ! Onceover::CodeQuality::Docs.puppet_strings(html_docs)
-                  status = false
-                  logger.error "Documentation generation failed, see previous errors"
-                end
+                status &= Onceover::CodeQuality::Docs.puppet_strings(html_docs)
               end
 
               if status

data/lib/onceover/codequality/docs.rb

@@ -6,12 +6,18 @@ class Onceover
       LOCAL_MOD_DIR = "site"
 
       def self.puppet_strings(html_docs)
+        logger.info "Generating documentation..."
         status = true
         format = html_docs ? "html" : "markdown"
         if Dir.exist?(LOCAL_MOD_DIR)
           Dir.glob("#{LOCAL_MOD_DIR}/*/") { |dir|
             Dir.chdir(dir) {
-              status &= system("puppet strings generate --format #{format}")
+              # 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
             }
           }
         end

data/lib/onceover/codequality/lint.rb

@@ -25,10 +25,13 @@ class Onceover
         status = true
         LINT_PATHS.each { |p|
           if Dir.exists?(p)
-            logger.info("checking #{p}")
+            logger.info("checking lint in #{p}...")
             if ! system("puppet-lint #{LINT_OPTIONS.join ' '} #{p}")
               status = false
+            else
+              logger.info("...ok")
             end
+
           end
         }
 

data/lib/onceover/codequality/puppetfile.rb

@@ -4,11 +4,20 @@ class Onceover
     module Puppetfile
 
       def self.puppetfile
-        if File.exists? "Puppetfile"
-          status = system("bundle exec r10k puppetfile check")
+        status = true
+        if File.exist?("Puppetfile")
+          logger.info("Checking Puppetfile...")
+          output, s = Open3.capture2e("r10k puppetfile check")
+          ok = s.exitstatus.zero?
+          status &= ok
+
+          if ok
+            logger.info("...ok")
+          else
+            logger.error("Puppetfile validation failed: #{output}")
+          end
         else
-          puts "No Puppetfile found!"
-          status = false
+          logger.warn("No Puppetfile found... continuing")
         end
 
         status

data/lib/onceover/codequality/syntax.rb

@@ -1,23 +1,61 @@
-# puppet-syntax does everything we want so we just need a handy way to run
-# it and check the result
+require 'open3'
 class Onceover
   module CodeQuality
     module Syntax
+
       def self.puppet
         status = true
-        if File.exist?("Puppetfile")
-          status &= system("r10k puppetfile check")
+
+        #
+        # puppet-lint
+        #
+
+        logger.info("Checking syntax using 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...
+        inline_ruby = "require 'puppet-syntax/tasks/puppet-syntax' ; Rake::Task['syntax'].invoke"
+        output, s = Open3.capture2e("ruby", "-e", inline_ruby)
+        ok = s.exitstatus.zero?
+        status &= ok
+
+        if ok
+          logger.info("...ok")
         else
-          logger.warn("No Puppetfile found... continuing")
+          logger.error("puppet-syntax validation failed: #{output}")
         end
 
-        require 'puppet-syntax/tasks/puppet-syntax'
-        begin
-          Rake::Task['syntax'].invoke
-        rescue SystemExit => e
-          logger.error("Invalid syntax")
-          status &= e.status
+        #
+        # python yaml
+        #
+
+        # Python gives us "better" validation of YAML data then ruby, eg:
+        # ```yaml
+        #  foo: bar
+        # baz: clive
+        # ```
+        #
+        # would parse only the foo key in ruby, throwing away the baz key due to
+        # a perceived negative indent, whereas python would tell you to fix the
+        # file and make it consistent. This is yaml implementation dependent but
+        # 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", :err => File::NULL)
+          logger.info("Running 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?
+          status &= ok
+
+          if ok
+            logger.info("...ok")
+          else
+            logger.error("Puppetfile validation failed: #{output}")
+          end
+        else
+          logger.warn("Please install python and add it to your path for enhanced YAML validation")
         end
+
         status
       end
     end

data/lib/onceover/codequality/version.rb

@@ -1,5 +1,5 @@
 class Onceover
   module CodeQuality
-    VERSION = "0.4.2"
+    VERSION = "0.5.0"
   end
 end

data/res/validate_yaml.py

@@ -0,0 +1,24 @@
+import sys
+import os
+import re
+
+status = 0
+try:
+  import yaml
+  for root, dirs, files in os.walk("."):
+    for f in files:
+      # we want yaml files that are not in hidden (.) dirs. account for / vs \ on windows/linux
+      target = os.path.join(root, f)
+      if target.endswith(".yaml") and not re.match("^\.(/|\\\)\.", target):
+        try:
+          yaml.safe_load(open(target,"r"))
+        except Exception as e:
+          status = 1
+          print("YAML syntax error in %s: %s" % (target, str(e)))
+
+except ImportError as e:
+  print("Please install the python-yaml library: pip install pyyaml")
+
+
+sys.exit(status)
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onceover-codequality
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Declarative Systems
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,7 @@ files:
 - lib/onceover/codequality/syntax.rb
 - lib/onceover/codequality/version.rb
 - onceover-codequality.gemspec
+- res/validate_yaml.py
 homepage: https://github.com/declarativesystems/onceover-codequality
 licenses:
 - Apache-2.0