abide_dev_utils 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03743386fed00b094d759cb20a53d25d807492fd98097564d140aa0cacfecce0'
-  data.tar.gz: be8082a88120f30f2754f79194a818c7640fd5f104c0c57dc07cd84d8bbc460f
+  metadata.gz: cf0d6affedd8f13f06af7f1f0db11666b9df2707d87a7685a4bd39ecd3e1519d
+  data.tar.gz: 0f20af443ff1e13f9e854daa5e7cf5ec45213dfe9a2f0390c250dac92a8cc8d3
 SHA512:
-  metadata.gz: 1bcd5add724cc85cc95915d778a6320de028b351ea19920b712efe228a4e01efdb36bb2840f5b566f5cf8a3d9ebe90236138fdd0bc0d83e90fbe1f4a0cf67763
-  data.tar.gz: 91f71049317153abafaa32fd9bacdfbfa26b1ba2145ddd902238f6cbc8e31417540eee0812b67ecdb5b5b0c500f1b0ce02ee43b028c37ffb3d87753c75e1729e
+  metadata.gz: '097e88fb6b19170c2b727fd8873fa3dbb766ace25a7538ab8cfbd0a35083cb11654b58fb7f45ee7130d7c4f4cb48b8b241de4849b0cb406de8f7eb62cf09ce68'
+  data.tar.gz: 4c0bc197da434b0ee25c9854b4b2af98a6ad9600733b734f9be21022ce312d7e8f0aea4f27c2217c3f56f7d2df26fedfe228f80b60fcd04da4ec08877a86bc54

data/abide_dev_utils.gemspec

@@ -34,10 +34,11 @@ Gem::Specification.new do |spec|
   # Prod dependencies
   spec.add_dependency 'nokogiri', '~> 1.11'
   spec.add_dependency 'cmdparse', '~> 3.0'
-  spec.add_dependency 'puppet', '>= 6.19'
+  spec.add_dependency 'puppet', '>= 6.23'
   spec.add_dependency 'jira-ruby', '~> 2.1'
   spec.add_dependency 'ruby-progressbar', '~> 1.11'
   spec.add_dependency 'selenium-webdriver', '~> 4.0.0.beta4'
+  spec.add_dependency 'google-cloud-storage', '~> 1.34'
 
   # Dev dependencies
   spec.add_development_dependency 'bundler'

data/lib/abide_dev_utils/cli/comply.rb

@@ -28,6 +28,10 @@ module Abide
       LONGCMD
       CMD_COMPLY_URL = 'The URL (including https://) of Puppet Comply'
       CMD_COMPLY_PASSWORD = 'The password for Puppet Comply'
+      OPT_TIMEOUT_DESC = <<~EOTO
+        The number of seconds you would like requests to wait before timing out. Defaults
+        to 10 seconds.
+      EOTO
       OPT_STATUS_DESC = <<~EODESC
         A comma-separated list of check statuses to ONLY include in the report.
         Valid statuses are: pass, fail, error, notapplicable, notchecked, unknown, informational
@@ -50,19 +54,26 @@ module Abide
         options.on('-u [USERNAME]', '--username [USERNAME]', 'The username for Comply (defaults to comply)') do |u|
           @data[:username] = u
         end
-        options.on('-s [STATUS]', '--status [STATUS]', OPT_STATUS_DESC) do |s|
-          status_array = s.nil? ? nil : s.split(',').map(&:downcase)
-          status_array&.map! { |i| i == 'notchecked' ? 'not checked' : i }
-          @data[:status] = status_array
+        options.on('-t [SECONDS]', '--timeout [SECONDS]', OPT_TIMEOUT_DESC) do |t|
+          @data[:timeout] = t
         end
-        options.on('-O [CERTNAME]', '--only [CERTNAME]', OPT_ONLY_NODES) do |o|
-          only_array = o.nil? ? nil : s.split(',').map(&:downcase)
-          @data[:only] = only_array
+        options.on('-s x,y,z', '--status x,y,x',
+                   %w[pass fail error notapplicable notchecked unknown informational],
+                   Array,
+                   OPT_STATUS_DESC) do |s|
+          s&.map! { |i| i == 'notchecked' ? 'not checked' : i }
+          @data[:status] = s
         end
-        options.on('-I [CERTNAME]', '--ignore [CERTNAME]', OPT_IGNORE_NODES) do |i|
-          ignore_array = i.nil? ? nil : i.split(',').map(&:downcase)
-          @data[:ignore] = ignore_array
+        options.on('--only x,y,z', Array, OPT_ONLY_NODES) do |o|
+          @data[:onlylist] = o
         end
+        options.on('--ignore x,y,z', Array, OPT_IGNORE_NODES) do |i|
+          @data[:ignorelist] = i
+        end
+        # options.on('-R', '--[no-]regression-test', OPT_REGRESSION_TEST) do |r|
+        #   @data[:regression] = r
+        # end
+        # options.on('--')
       end
 
       def help_arguments
@@ -79,16 +90,7 @@ module Abide
         conf = config_section('comply')
         comply_url = conf.fetch(:url) if comply_url.nil?
         comply_password = comply_password.nil? ? conf.fetch(:password, Abide::CLI::PROMPT.password) : comply_password
-        username = @data.fetch(:username, nil).nil? ? conf.fetch(:username, 'comply') : @data[:username]
-        status = @data.fetch(:status, nil).nil? ? conf.fetch(:status, nil) : @data[:status]
-        ignorelist = @data.fetch(:ignore, nil).nil? ? conf.fetch(:ignore, nil) : @data[:ignore]
-        onlylist = @data.fetch(:only, nil).nil? ? conf.fetch(:only, nil) : @data[:only]
-        report = AbideDevUtils::Comply.scan_report(comply_url,
-                                                   comply_password,
-                                                   username: username,
-                                                   status: status,
-                                                   ignorelist: ignorelist,
-                                                   onlylist: onlylist)
+        report = AbideDevUtils::Comply.build_report(comply_url, comply_password, conf, **@data)
         outfile = @data.fetch(:file, nil).nil? ? conf.fetch(:report_path, 'comply_scan_report.yaml') : @data[:file]
         Abide::CLI::OUTPUT.yaml(report, file: outfile)
       end

data/lib/abide_dev_utils/cli/puppet.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'abide_dev_utils/cli/abstract'
+require 'abide_dev_utils/output'
+require 'abide_dev_utils/ppt'
 
 module Abide
   module CLI
@@ -12,6 +14,10 @@ module Abide
         super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: true)
         add_command(PuppetCoverageCommand.new)
         add_command(PuppetNewCommand.new)
+        add_command(PuppetRenameCommand.new)
+        add_command(PuppetFixClassNamesCommand.new)
+        add_command(PuppetAuditClassNamesCommand.new)
+        add_command(PuppetAddCISCommentCommand.new)
       end
     end
 
@@ -38,12 +44,12 @@ module Abide
       end
 
       def execute(class_dir, hiera_file)
-        require 'abide_dev_utils/ppt'
+        require 'abide_dev_utils/ppt/coverage'
         Abide::CLI::VALIDATE.directory(class_dir)
         Abide::CLI::VALIDATE.file(hiera_file)
-        coverage = AbideDevUtils::Ppt::CoverageReport.generate(class_dir, hiera_file, @data[:profile])
+        coverage = AbideDevUtils::Ppt.generate_coverage_report(class_dir, hiera_file, @data[:profile])
         coverage.each do |k, v|
-          next if ['classes', 'benchmark'].include?(k)
+          next if k.match?(/classes|benchmark/)
 
           Abide::CLI::OUTPUT.simple("#{k} coverage: #{v[:coverage]}%")
         end
@@ -100,14 +106,115 @@ module Abide
       end
 
       def execute(type, name)
-        require 'abide_dev_utils/ppt/new_obj'
-        builder = AbideDevUtils::Ppt::NewObjectBuilder.new(
-          type,
-          name,
-          opts: @data,
-          vars: @data.fetch(:vars, '').split(',').map { |i| i.split('=') }.to_h # makes the str a hash
-        )
-        builder.build
+        AbideDevUtils::Ppt.build_new_object(type, name, @data)
+      end
+    end
+
+    class PuppetRenameCommand < AbideCommand
+      CMD_NAME = 'rename'
+      CMD_SHORT = 'Renames a Puppet class'
+      CMD_LONG = 'Renames a Puppet class. It does this by renaming the file and also the class name in the file. This command can also move class files based on the new class name.'
+      CMD_FROM_ARG = 'The current full class name'
+      CMD_TO_ARG = 'The new full class name'
+      def initialize
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false)
+        argument_desc(FROM: CMD_FROM_ARG, TO: CMD_TO_ARG)
+        options.on(
+          '-d',
+          '--declaration-only',
+          'Will not rename the class file, only the class declaration in the file'
+        ) { @data[:declaration_only] = true }
+        options.on(
+          '-t',
+          '--declaration-in-to-file',
+          'Use the path derived from the TO class name as the existing file path when renaming class declaration'
+        ) { @data[:declaration_in_to_file] = true }
+        options.on(
+          '-f',
+          '--force',
+          'Forces file move operations'
+        ) { @data[:force] = true }
+        options.on(
+          '-v',
+          '--verbose',
+          'Sets verbose mode on file operations'
+        ) { @data[:verbose] = true }
+      end
+
+      def execute(from, to)
+        AbideDevUtils::Ppt.rename_puppet_class(from, to, **@data)
+      end
+    end
+
+    class PuppetFixClassNamesCommand < AbideCommand
+      CMD_NAME = 'fix-class-names'
+      CMD_SHORT = 'Fixes Puppet class names that are mismatched'
+      CMD_LONG = 'Fixes Puppet class names that are mismatched'
+      CMD_MODE_ARG = '"file" or "class". If "file", the file names will be changed to match their class declarations. If "class", the class declarations will be changed to match the file names.'
+      CMD_DIR_ARG = 'The directory containing the Puppet class files'
+      def initialize
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false)
+        argument_desc(MODE: CMD_MODE_ARG, DIR: CMD_DIR_ARG)
+        options.on(
+          '-f',
+          '--force',
+          'Forces file move operations'
+        ) { @data[:force] = true }
+        options.on(
+          '-v',
+          '--verbose',
+          'Sets verbose mode on file operations'
+        ) { @data[:verbose] = true }
+      end
+
+      def execute(mode, dir)
+        case mode
+        when /^f.*/
+          AbideDevUtils::Ppt.fix_class_names_file_rename(dir, **@data)
+        when /^c.*/
+          AbideDevUtils::Ppt.fix_class_names_class_rename(dir, **@data)
+        else
+          raise ::ArgumentError, "Invalid mode. Mode:#{mode}"
+        end
+      end
+    end
+
+    class PuppetAuditClassNamesCommand < AbideCommand
+      CMD_NAME = 'audit-class-names'
+      CMD_SHORT = 'Finds Puppet classes in a directory that have names that do not match their path'
+      CMD_LONG = 'Finds Puppet classes in a directory that have names that do not match their path. This is helpful because class names that do not match their path structure break Puppet autoloading.'
+      CMD_DIR_ARG = 'The directory containing the Puppet class files'
+      def initialize
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false)
+        argument_desc(DIR: CMD_DIR_ARG)
+        options.on('-o [FILE]', '--out-file [FILE]', 'Save results to a file') { |f| @data[:file] = f }
+        options.on('-q', '--quiet', 'Do not print results to console') { @data[:quiet] = true }
+      end
+
+      def execute(dir)
+        if @data.fetch(:quiet, false) && !@data.key?(:file)
+          AbideDevUtils::Output.simple('ERROR: Specifying --quiet without --out-file is useless.', stream: $stderr)
+          exit 1
+        end
+
+        AbideDevUtils::Ppt.audit_class_names(dir, **@data)
+      end
+    end
+
+    class PuppetAddCISCommentCommand < AbideCommand
+      CMD_NAME = 'add-cis-comment'
+      CMD_SHORT = 'Adds the CIS recommendation name to the top of a .pp file'
+      CMD_LONG = 'Adds the CIS recommendation name to the top of a .pp file. Finds CIS recommendation by pattern-matching the class name against XCCDF recommendations.'
+      CMD_PATH_ARG = 'Path to a .pp file or to a directory containing .pp files'
+      CMD_XCCDF_ARG = 'Path to XCCDF file to source recommendation names from'
+      def initialize
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false)
+        argument_desc(PATH: CMD_PATH_ARG, XCCDF: CMD_XCCDF_ARG)
+        options.on('-N', '--number-format', 'Matches based on number-formatted control class names') { @data[:number_format] = true }
+      end
+
+      def execute(path, xccdf)
+        AbideDevUtils::Ppt.add_cis_comment(path, xccdf, number_format: @data.fetch(:number_format, false))
       end
     end
   end