onceover-codequality 0.5.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cc85533082f17d96152a3c59fc6348ea8be68b55042b6d1bb0f6cff652ef2a4
-  data.tar.gz: 87de572b5cfa41d75e561b11b6203a8b08ea9697dc6b34b9c5c9c08eb62b48b3
+  metadata.gz: c942e82eac32f3f3c723d0ed967fab3744b69bacd15a9dc79dad592ecccdeb9e
+  data.tar.gz: 5eb8ae6bb4b184eb7f5ac0244785f2fac2116f3891cfd0439abafc7e4fb1e61f
 SHA512:
-  metadata.gz: dc5f19fa30675b22d3dcfa22426160270cfa701daf5b5e42873308276850a069af0b6457b0b637d28bc071ed767c63b0c93910dfece1874e5a349c573409a568
-  data.tar.gz: 3613935fb0d6dca40cd26275db0db1242bf796b3e820b67085e55157db4e8a2035b5b64c89ec539961e71890538cd3dc8fa7317131201d90c626350448340302
+  metadata.gz: dd9b554d0958919559c5eabf71d5ee50c7803aeaee7dc3374f07ab00deabbe0e0202a55b7dc4c981a71466bd92f8d474cdfd480023adbadf75485e426c2767d8
+  data.tar.gz: 2ff44b19c6783658a3871665de84b0108dc4f69bcb91487d508387b762a1975295083fff8608892905c8c90f226b2ec378b3b36122e2a0d1012b8eaffde5c27b

data/.gitignore

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

data/Gemfile.lock

@@ -0,0 +1,154 @@
+PATH
+  remote: .
+  specs:
+    onceover-codequality (0.8.0)
+      onceover (~> 3)
+      puppet-lint (~> 2)
+      puppet-strings (~> 2)
+      puppet-syntax (~> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    backticks (1.0.2)
+    blockenspiel (0.5.0)
+    colored (1.2)
+    colored2 (3.1.2)
+    concurrent-ruby (1.1.8)
+    cri (2.15.11)
+    deep_merge (1.2.1)
+    diff-lcs (1.3)
+    facter (4.0.51)
+      hocon (~> 1.3)
+      thor (>= 1.0.1, < 2.0)
+    faraday (0.17.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.14.0)
+      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.34)
+      fast_gettext (~> 1.1.0)
+      gettext (>= 3.0.2, < 3.3.0)
+      locale
+    git (1.8.1)
+      rchardet (~> 1.8)
+    hiera (3.6.0)
+    hocon (1.3.1)
+    little-plugger (1.1.4)
+    locale (2.1.3)
+    log4r (1.1.10)
+    logging (2.3.0)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.14)
+    minitar (0.9)
+    mocha (1.12.0)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    onceover (3.19.1)
+      backticks (>= 1.0.2)
+      colored (~> 1.2)
+      cri (>= 2.6)
+      deep_merge (>= 1.0.0)
+      git
+      logging (>= 2.0.0)
+      multi_json (~> 1.10)
+      parallel_tests (>= 2.0.0)
+      puppet (>= 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)
+      terminal-table (>= 1.8.0)
+      versionomy (>= 0.5.0)
+    parallel (1.20.1)
+    parallel_tests (3.4.0)
+      parallel
+    pathspec (0.2.1)
+    puppet (7.4.0)
+      concurrent-ruby (~> 1.0)
+      deep_merge (~> 1.0)
+      facter (> 2.0.1, < 5)
+      fast_gettext (~> 1.1)
+      hiera (>= 3.2.1, < 4)
+      locale (~> 2.1)
+      multi_json (~> 1.10)
+      puppet-resource_api (~> 1.5)
+      scanf (~> 1.0)
+      semantic_puppet (~> 1.0)
+    puppet-lint (2.4.2)
+    puppet-resource_api (1.8.13)
+      hocon (>= 1.0)
+    puppet-strings (2.6.0)
+      rgen
+      yard (~> 0.9.5)
+    puppet-syntax (3.1.0)
+      puppet (>= 5)
+      rake
+    puppet_forge (2.3.4)
+      faraday (>= 0.9.0, < 0.18.0, != 0.13.1)
+      faraday_middleware (>= 0.9.0, < 0.15.0)
+      gettext-setup (~> 0.11)
+      minitar
+      semantic_puppet (~> 1.0)
+    puppetlabs_spec_helper (3.0.0)
+      mocha (~> 1.0)
+      pathspec (>= 0.2.1, < 1.1.0)
+      puppet-lint (~> 2.0)
+      puppet-syntax (>= 2.0, < 4)
+      rspec-puppet (~> 2.0)
+    r10k (3.7.0)
+      colored2 (= 3.1.2)
+      cri (>= 2.15.10, < 3.0.0)
+      fast_gettext (~> 1.1.0)
+      gettext (>= 3.0.2, < 3.3.0)
+      gettext-setup (~> 0.24)
+      log4r (= 1.1.10)
+      multi_json (~> 1.10)
+      puppet_forge (~> 2.3.0)
+    rake (13.0.1)
+    rchardet (1.8.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.8.0)
+      rspec
+    rspec-support (3.8.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    scanf (1.0.0)
+    semantic_puppet (1.0.3)
+    terminal-table (3.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    text (1.3.1)
+    thor (1.1.0)
+    unicode-display_width (1.7.0)
+    versionomy (0.5.0)
+      blockenspiel (~> 0.5)
+    yard (0.9.26)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  onceover-codequality!
+  rake (~> 13.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,9 @@ require "onceover/codequality/lint"
 require "onceover/codequality/syntax"
 require "onceover/codequality/docs"
 require "onceover/codequality/puppetfile"
+require "onceover/codequality/environment"
+require "onceover/codequality/executor"
+require "onceover/codequality/formatter"
 class Onceover
   module CodeQuality
     class CLI
@@ -29,6 +32,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 +51,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

@@ -1,26 +1,26 @@
 # Support for generating documentation using Puppet Strings for each module
-# listed in the site directory
+# listed in the environment.conf modulepath
 class Onceover
   module CodeQuality
     module Docs
-      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) {
-              # 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
+        format = html_docs ? "--markup html" : "--format markdown"
+
+        CodeQuality::Environment.get_site_dirs.each { |local_mod_dir|
+          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
+                output, ok = CodeQuality::Executor.run("puppet strings generate #{format}")
+                status &= ok
+                CodeQuality::Formatter.end_test(output, ok, true)
+              }
             }
-          }
-        end
+          end
+        }
 
         status
       end

data/lib/onceover/codequality/environment.rb

@@ -0,0 +1,34 @@
+class Onceover
+  module CodeQuality
+    module Environment
+
+      ENVIRONMENT_CONF = "environment.conf"
+
+      # Latest best practice is to change the name of `site` to be
+      # `site-modules`. This means we need to start processing `environment.conf`
+      # to extract this...
+      def self.get_site_dirs()
+        if File.exist?(ENVIRONMENT_CONF)
+          #modulepath = site-modules:modules:$basemodulepath
+          modulepath = open(ENVIRONMENT_CONF) { |f| f.each_line.find { |line| line.include?("modulepath") } }
+
+          begin
+            environments = modulepath.split("=")[1].split(":").reject { |e|
+              # reject any elements containing interpolation or referencing modules
+              # loaded by r10k
+              e =~ /\$/ || e == "modules" || e =~ /[\\.\/]/
+            }.map {
+              |e| e.strip
+            }
+          rescue NoMethodError => e
+            raise "Malformed environment configuration: #{ENVIRONMENT_CONF}"
+          end
+        else
+          raise "Missing environment configuration: #{ENVIRONMENT_CONF}"
+        end
+
+        environments
+      end
+    end
+  end
+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,19 @@ 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(
+          CodeQuality::Environment.get_site_dirs.each { |site_dir|
+            Dir.glob("#{site_dir}/*").select { |f| File.directory? f}
+          }
+        )
+        lint_paths.each { |p|
+          if Dir.exist?(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,19 +40,13 @@ 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 add it to your path for enhanced YAML validation")
+          logger.warn("Please install python and pyyaml for enhanced YAML validation (pip install pyyaml)")
         end
 
         status

data/lib/onceover/codequality/version.rb

@@ -1,5 +1,5 @@
 class Onceover
   module CodeQuality
-    VERSION = "0.5.2"
+    VERSION = "0.8.0"
   end
 end

data/onceover-codequality.gemspec

@@ -20,12 +20,12 @@ 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 "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_runtime_dependency 'onceover', '~> 3'
-  spec.add_runtime_dependency 'puppet-syntax', '~> 2'
+  spec.add_runtime_dependency 'puppet-syntax', '~> 3'
   spec.add_runtime_dependency 'puppet-lint', '~> 2'
   spec.add_runtime_dependency 'puppet-strings', '~> 2'
 end

data/res/validate_yaml.py

@@ -7,9 +7,9 @@ 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
+      # we want yaml files that are not in hidden (.) dirs or vendor directory. account for / vs \ on windows/linux
       target = os.path.join(root, f)
-      if target.endswith(".yaml") and not re.match("^\.(/|\\\)\.", target):
+      if target.endswith(".yaml") and not re.match("^\.(/|\\\)(\.|vendor)", target):
         try:
           yaml.safe_load(open(target,"r"))
         except Exception as e:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onceover-codequality
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Declarative Systems
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ 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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: puppet-lint
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -127,6 +128,9 @@ files:
 - lib/onceover/codequality.rb
 - lib/onceover/codequality/cli.rb
 - lib/onceover/codequality/docs.rb
+- lib/onceover/codequality/environment.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