abide_dev_utils 0.2.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e19e043b233c6842331d4c4883a74d8557b163739e041d910b60b953acddc85
-  data.tar.gz: cf425a2b3a0c83ecd5e41cbee5d476fc7444e8984f4f03df12f91b36ad8aeee8
+  metadata.gz: a27976b9f740b67261fa080eeba927bc6fc98e73ffb592fafdd91d4d612cc51f
+  data.tar.gz: 64778a0d476e2f96d70a14ab318b517c597aa3c5e33afd8939173385b013fe6c
 SHA512:
-  metadata.gz: 52e685b3d446b7c6256fd0e45d0542dccc77490b75ccc6408e2ba66e8edbc49d76267446940b997a0e3ab6a7449e1c5a03323c98cc66dd34ca58fa87178d4602
-  data.tar.gz: 558295f45b37110781fcd22bc4cac8a450c520f706933ddc0fe908c4f2ef863b63029603ab3e1df09142a17c6238f3f5514f20e4fefcc1ed6e2a5531abc5a479
+  metadata.gz: e31df40e6dd34a57156ff517d39fcc036f5655ce2f31bf86b1ebb66754304575b7379e0a3751ae378bc81bc1520dbe095255012dc7e10b24e4f6c3f4a85e6551
+  data.tar.gz: c9dd204d55a37d389c0c8a4d3d281310b87241cbbd149ca029a3fa6a38fd8414bcb350467cd348cdd330fe946e6ee75625bfe2828319ad25d9eb8ed5cc37a9a3

data/.dockerignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Dockerfile

@@ -0,0 +1,23 @@
+FROM ruby:2.7.3-alpine
+
+ARG version
+
+RUN mkdir /extvol && \
+    apk update && \
+    apk add git build-base
+
+VOLUME /extvol
+
+WORKDIR /usr/src/app
+
+RUN mkdir -p ./lib/abide_dev_utils/
+COPY Gemfile abide_dev_utils.gemspec ./
+COPY lib/abide_dev_utils/version.rb lib/abide_dev_utils
+RUN bundle install
+
+COPY . .
+
+RUN bundle exec rake build && \
+    gem install pkg/abide_dev_utils-${version}.gem
+
+ENTRYPOINT [ "abide" ]

data/README.md

@@ -29,6 +29,10 @@ Issues and pull requests are welcome!
 
 * Create Jira issues in bulk from coverage reports
 
+### Puppet Comply Report Generation
+
+* Allows you ot programatically generate compliance reports from Puppet Comply
+
 ### Supports Configuration via Local YAML file
 
 * Fully configurable via the `~/.abide_dev.yaml` file
@@ -128,6 +132,8 @@ Install the gem:
   * `--absolute-template-dir`, `-A` - Allows you to specify an absolute path with `--template-dir`. This is useful if your template directory is not relative to your module's root directory
   * `--template-name`, `-n` - Allows you to specify a template name if it is different than the `TYPE` parameter
   * `--vars`, `-V` - Comma-separated key=value pairs to pass in to the template renderer. This allows you to pass arbitrary values that can be used in your templates.
+  * `--spec-template`, `-S` - Path to an ERB template to use for rspec test generation instead of the default
+  * `--force`, `-f` - Skips any prompts and executes the command
 
 `abide puppet new` exposes a few variables for you to use in your templates by default:
 
@@ -179,8 +185,10 @@ $ ls manifests
 init.pp
 $ abide puppet new control_class 'test_module::controls::test_new_control'
 Created file /Users/the.dude/test_module/manifests/controls/test_new_control.pp
+Created file /Users/the.dude/test_module/spec/classes/controls/test_new_control_spec.rb
 $ abide puppet new util_class 'test_module::utils::test_new_util' -v 'testvar1=dude,testvar2=sweet'
 Created file /Users/the.dude/test_module/manifests/utils/test_new_util.pp
+Created file /Users/the.dude/test_module/spec/classes/utils/test_new_util_spec.rb
 $ cat manifests/controls/test_new_control.pp
 # @api private
 class test_module::controls::test_new_control (
@@ -204,6 +212,9 @@ class test_module::utils::test_new_util (
 
 ```
 
+**NOTE**: You can use two special prefixes on your template files to denote where the rspec test should be generated for that object.
+If the prefix `c-` is used, the test will be generated in the `spec/classes` directory. If the prefix `d-` is used, the test will be generated in the `spec/defines` directory. For example, to create a template for a defined type, name the template something like this: `d-my_defined_type.pp.erb`.
+
 ### XCCDF Command Reference
 
 #### to_hiera
@@ -224,6 +235,15 @@ NOTE: When converting XCCDF files to Hiera, control names are sanitized. This me
   * `--out-file`, `-o` - A path to a file where you would like to save the generated Hiera
   * `--parent-key-prefix`, `-p` - Allows you to append a prefix to all top-level Hiera keys
 
+## Docker
+
+A Dockerfile has been provided in this repo for convenience since Ruby environments can be painful to deal with. To abide_dev_utils with Docker:
+
+* Build the Dockerfile: `docker build . -t abide_dev_utils --build-arg version=<semver>`
+* Run the commands using the container: `docker run -it abide_dev_utils --help`
+* The container declares a volume for external resources such as files. To use the volume, add the following flag to your `docker run` commands: `-v /path/to/my/files:/extvol`
+  * When using the volume, all paths should be absolute based on the root directory `/extvol`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/abide_dev_utils.gemspec

@@ -37,10 +37,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'puppet', '>= 6.19'
   spec.add_dependency 'jira-ruby', '~> 2.1'
   spec.add_dependency 'ruby-progressbar', '~> 1.11'
+  spec.add_dependency 'selenium-webdriver', '~> 4.0.0.beta4'
 
   # Dev dependencies
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'console'
   spec.add_development_dependency 'github_changelog_generator'
   spec.add_development_dependency 'gem-release'
   spec.add_development_dependency 'rspec', '~> 3.10'

data/lib/abide_dev_utils/cli.rb

@@ -3,6 +3,7 @@
 require 'cmdparse'
 require 'abide_dev_utils/version'
 require 'abide_dev_utils/constants'
+require 'abide_dev_utils/cli/comply'
 require 'abide_dev_utils/cli/puppet'
 require 'abide_dev_utils/cli/xccdf'
 require 'abide_dev_utils/cli/test'
@@ -21,6 +22,7 @@ module Abide
       parser.main_options.banner = ROOT_CMD_BANNER
       parser.add_command(CmdParse::HelpCommand.new, default: true)
       parser.add_command(CmdParse::VersionCommand.new(add_switches: true))
+      parser.add_command(ComplyCommand.new)
       parser.add_command(PuppetCommand.new)
       parser.add_command(XccdfCommand.new)
       parser.add_command(TestCommand.new)

data/lib/abide_dev_utils/cli/abstract.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'abide_dev_utils/config'
+
 module Abide
   module CLI
     # @abstract

data/lib/abide_dev_utils/cli/comply.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/comply'
+require 'abide_dev_utils/cli/abstract'
+
+module Abide
+  module CLI
+    class ComplyCommand < AbideCommand
+      CMD_NAME = 'comply'
+      CMD_SHORT = 'Commands related to Puppet Comply'
+      CMD_LONG = 'Namespace for commands related to Puppet Comply'
+      def initialize
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: true)
+        add_command(ComplyReportCommand.new)
+      end
+    end
+
+    class ComplyReportCommand < AbideCommand
+      CMD_NAME = 'report'
+      CMD_SHORT = 'Generates a yaml report of Puppet Comply scan results'
+      CMD_LONG = <<~LONGCMD
+        Generates a yaml file that shows the scan results of all nodes in Puppet Comply.
+        This command utilizes Selenium WebDriver and the Google Chrome browser to automate
+        clicking through the Comply UI and building a report. In order to use this command,
+        you MUST have Google Chrome installed and you MUST install the chromedriver binary.
+        More info and instructions can be found here:
+        https://www.selenium.dev/documentation/en/getting_started_with_webdriver/.
+      LONGCMD
+      CMD_COMPLY_URL = 'The URL (including https://) of Puppet Comply'
+      CMD_COMPLY_PASSWORD = 'The password for Puppet Comply'
+      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
+      EODESC
+      OPT_IGNORE_NODES = <<~EOIGN
+        A comma-separated list of node certnames to ignore building reports for. This
+        options is mutually exclusive with --only and, if both are set, --only will take precedence
+        over this option.
+      EOIGN
+      OPT_ONLY_NODES = <<~EOONLY
+        A comma-separated list of node certnames to ONLY build reports for. No other
+        nodes will have reports built for them except the ones specified. This option
+        is mutually exclusive with --ignore and, if both are set, this options will
+        take precedence over --ignore.
+      EOONLY
+      def initialize
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false)
+        argument_desc(COMPLY_URL: CMD_COMPLY_URL, COMPLY_PASSWORD: CMD_COMPLY_PASSWORD)
+        options.on('-o [FILE]', '--out-file [FILE]', 'Path to save the report') { |f| @data[:file] = f }
+        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
+        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
+        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
+        end
+      end
+
+      def help_arguments
+        <<~ARGHELP
+          Arguments:
+              COMPLY_URL        #{CMD_COMPLY_URL}
+              COMPLY_PASSWORD   #{CMD_COMPLY_PASSWORD}
+
+        ARGHELP
+      end
+
+      def execute(comply_url = nil, comply_password = nil)
+        Abide::CLI::VALIDATE.filesystem_path(`command -v chromedriver`.strip)
+        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.fecth(: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)
+        outfile = @data.fetch(:file, nil).nil? ? conf.fetch(:report_path, 'comply_scan_report.yaml') : @data[:file]
+        Abide::CLI::OUTPUT.yaml(report, file: outfile)
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/cli/jira.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'abide_dev_utils/config'
 require 'abide_dev_utils/jira'
 
 module Abide
   module CLI
+    CONFIG = AbideDevUtils::Config
     JIRA = AbideDevUtils::Jira
 
     class JiraCommand < CmdParse::Command
@@ -57,8 +59,8 @@ module Abide
       def execute(issue)
         client = JIRA.client(options: {})
         issue = client.Issue.find(issue)
-        console = @data[:file].nil? ? true : false
-        out_json = issue.attrs.select { |_,v| !v.nil? || !v.empty? }
+        console = @data[:file].nil?
+        out_json = issue.attrs.select { |_, v| !v.nil? || !v.empty? }
         Abide::CLI::OUTPUT.json(out_json, console: console, file: @data[:file])
       end
     end

data/lib/abide_dev_utils/cli/puppet.rb

@@ -87,6 +87,16 @@ module Abide
           '--vars [VARNAME=VALUE]',
           'Allows you to specify comma-separated variable names and values that will be converted into a hash that is available for you to use in your templates'
         ) { |v| @data[:vars] = v }
+        options.on(
+          '-S [PATH]',
+          '--spec-template [PATH]',
+          'Path to an ERB template to use for rspec test generation instead of the default'
+        )
+        options.on(
+          '-f',
+          '--force',
+          'Skips any prompts and executes the command'
+        ) { |_| @data[:force] = true }
       end
 
       def execute(type, name)
@@ -97,8 +107,7 @@ module Abide
           opts: @data,
           vars: @data.fetch(:vars, '').split(',').map { |i| i.split('=') }.to_h # makes the str a hash
         )
-        result = builder.build
-        Abide::CLI::OUTPUT.simple(result)
+        builder.build
       end
     end
   end

data/lib/abide_dev_utils/cli/test.rb

@@ -35,10 +35,10 @@ module Abide
         @litmus_im = [CMD_LIT_BASE, "'litmus:install_module'"]
         @litmus_ap = [CMD_LIT_BASE, "'litmus:acceptance:parallel'"]
         @litmus_td = [CMD_LIT_BASE, "'litmus:tear_down'"]
-        validate_env_and_opts
       end
 
       def execute(suite)
+        validate_env_and_opts
         case suite.downcase
         when /^a[A-Za-z]*/
           run_command(@validate)

data/lib/abide_dev_utils/cli/xccdf.rb

@@ -27,7 +27,12 @@ module Abide
         long_desc(CMD_LONG)
         options.on('-b [TYPE]', '--benchmark-type [TYPE]', 'XCCDF Benchmark type') { |b| @data[:type] = b }
         options.on('-o [FILE]', '--out-file [FILE]', 'Path to save file') { |f| @data[:file] = f }
-        options.on('-p [PREFIX]', '--parent-key-prefix [PREFIX]', 'A prefix to append to the parent key') { |p| @data[:parent_key_prefix] = p }
+        options.on('-p [PREFIX]', '--parent-key-prefix [PREFIX]', 'A prefix to append to the parent key') do |p|
+          @data[:parent_key_prefix] = p
+        end
+        options.on('-N', '--number-fmt', 'Format Hiera control names based off of control number instead of name.') do
+          @data[:num] = true
+        end
       end
 
       def execute(xccdf_file)
@@ -40,8 +45,7 @@ module Abide
 
       def to_hiera(xccdf_file)
         xfile = AbideDevUtils::XCCDF.to_hiera(xccdf_file, @data)
-        console = @data[:file].nil? ? true : false
-        Abide::CLI::OUTPUT.yaml(xfile, console: console, file: @data[:file])
+        Abide::CLI::OUTPUT.yaml(xfile, console: @data[:file].nil?, file: @data[:file])
       end
     end
   end

data/lib/abide_dev_utils/comply.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'selenium-webdriver'
+require 'abide_dev_utils/output'
+
+module AbideDevUtils
+  module Comply
+    def self.scan_report(url, password, username: 'comply', status: nil, ignorelist: nil, onlylist: nil)
+      begin
+        AbideDevUtils::Output.simple 'Starting headless Chrome...'
+        options = Selenium::WebDriver::Chrome::Options.new
+        options.args = %w[
+          --headless
+          --test-type
+          --disable-gpu
+          --no-first-run
+          --no-default-browser-check
+          --ignore-certificate-errors
+          --start-maximized
+        ]
+        driver = Selenium::WebDriver.for :chrome, options: options
+        driver.get(url)
+        bypass_ssl_warning_page(driver)
+        AbideDevUtils::Output.simple "Logging into Comply at #{url}..."
+        login_to_comply(driver, username: username, password: password)
+        AbideDevUtils::Output.simple 'Finding nodes with scan reports...'
+        links = find_node_report_links(driver)
+        AbideDevUtils::Output.simple 'Building scan reports, this may take a while...'
+        build_report(driver, links, status: status, ignorelist: ignorelist, onlylist: onlylist)
+      ensure
+        driver.quit
+      end
+    end
+
+    def self.ignore_no_such_element
+      begin
+        yield
+      rescue Selenium::WebDriver::Error::NoSuchElementError => e
+        AbideDevUtils::Output.simple "Ignored exception #{e}", stream: $stderr
+      end
+    end
+
+    def self.wait_on(timeout = 10)
+      Selenium::WebDriver::Wait.new(timeout: timeout).until do
+        yield
+      end
+    end
+
+    def self.bypass_ssl_warning_page(driver)
+      ignore_no_such_element do
+        driver.find_element(id: 'details-button').click
+        driver.find_element(id: 'proceed-link').click
+      end
+    end
+
+    def self.login_to_comply(driver, username: 'comply', password: 'compliance')
+      wait_on { driver.find_element(id: 'username') }
+      driver.find_element(id: 'username').send_keys username
+      driver.find_element(id: 'password').send_keys password
+      driver.find_element(id: 'kc-login').click
+    end
+
+    def self.find_node_report_links(driver)
+      wait_on { driver.find_element(class: 'metric-containers-failed-hosts-count') }
+      hosts = driver.find_element(class: 'metric-containers-failed-hosts-count')
+      table = hosts.find_element(class: 'rc-table')
+      table_body = table.find_element(tag_name: 'tbody')
+      wait_on { table_body.find_element(tag_name: 'a') }
+      table_body.find_elements(tag_name: 'a')
+    end
+
+    def self.build_report(driver, links, status: nil, ignorelist: nil, onlylist: nil)
+      all_checks = {}
+      original_window = driver.window_handle
+      links.each do |link|
+        if !onlylist.nil? && !onlylist.empty?
+          next unless onlylist.include?(link.text)
+        elsif !ignorelist.nil? && !ignorelist.empty?
+          next if ignorelist.include?(link.text)
+        end
+        begin
+          node_name = link.text
+          progress = AbideDevUtils::Output.progress title: "Builingd report for #{node_name}", total: nil
+          link_url = link.attribute('href')
+          driver.manage.new_window(:tab)
+          wait_on { driver.window_handles.length == 2 }
+          progress.increment
+          driver.switch_to.window driver.window_handles[1]
+          driver.get(link_url)
+          wait_on { driver.find_element(class: 'details-scan-info') }
+          progress.increment
+          wait_on { driver.find_element(class: 'details-table') }
+          progress.increment
+          report = {}
+          report['scan_results'] = {}
+          scan_info_table = driver.find_element(class: 'details-scan-info')
+          scan_info_table_rows = scan_info_table.find_elements(tag_name: 'tr')
+          progress.increment
+          check_table_body = driver.find_element(tag_name: 'tbody')
+          check_table_rows = check_table_body.find_elements(tag_name: 'tr')
+          progress.increment
+          scan_info_table_rows.each do |row|
+            key = row.find_element(tag_name: 'h5').text
+            value = row.find_element(tag_name: 'strong').text
+            report[key.downcase.gsub(/:/, '').gsub(/ /, '_')] = value
+            progress.increment
+          end
+          check_table_rows.each do |row|
+            chk_objs = row.find_elements(tag_name: 'td')
+            chk_objs.map!(&:text)
+            if status.nil? || status.include?(chk_objs[1].downcase)
+              report['scan_results'][chk_objs[0][/^[0-9.]+/, 0]] = {
+                'name' => chk_objs[0].gsub(/\n/, ' '),
+                'status' => chk_objs[1]
+              }
+            end
+            progress.increment
+          end
+          all_checks[node_name] = report
+          driver.close
+          AbideDevUtils::Output.simple "Created report for #{node_name}"
+        ensure
+          driver.switch_to.window original_window
+        end
+      end
+      all_checks
+    end
+  end
+end

data/lib/abide_dev_utils/config.rb

@@ -7,18 +7,41 @@ module AbideDevUtils
     DEFAULT_PATH = "#{File.expand_path('~')}/.abide_dev.yaml"
 
     def self.to_h(path = DEFAULT_PATH)
+      return {} unless File.file?(path)
+
+      h = YAML.safe_load(File.open(path), [Symbol])
+      h.transform_keys(&:to_sym)
+    end
+
+    def to_h(path = DEFAULT_PATH)
+      return {} unless File.file?(path)
+
       h = YAML.safe_load(File.open(path), [Symbol])
       h.transform_keys(&:to_sym)
     end
 
     def self.config_section(section, path = DEFAULT_PATH)
       h = to_h(path)
-      s = h[section.to_sym]
+      s = h.fetch(section.to_sym, nil)
+      return {} if s.nil?
+
+      s.transform_keys(&:to_sym)
+    end
+
+    def config_section(section, path = DEFAULT_PATH)
+      h = to_h(path)
+      s = h.fetch(section.to_sym, nil)
+      return {} if s.nil?
+
       s.transform_keys(&:to_sym)
     end
 
     def self.fetch(key, default = nil, path = DEFAULT_PATH)
       to_h(path).fetch(key, default)
     end
+
+    def fetch(key, default = nil, path = DEFAULT_PATH)
+      to_h(path).fetch(key, default)
+    end
   end
 end

data/lib/abide_dev_utils/errors/xccdf.rb

@@ -8,5 +8,9 @@ module AbideDevUtils
     class XPathSearchError < GenericError
       @default = 'XPath seach failed to find anything at:'
     end
+
+    class StrategyInvalidError < GenericError
+      @default = 'Invalid strategy selected. Should be either \'name\' or \'num\''
+    end
   end
 end

data/lib/abide_dev_utils/jira.rb

@@ -86,6 +86,8 @@ module AbideDevUtils
 
     def self.client(options: {})
       opts = merge_options(options)
+      return client_from_prompts if opts.empty?
+
       opts[:username] = AbideDevUtils::Prompt.username if opts[:username].nil?
       opts[:password] = AbideDevUtils::Prompt.password if opts[:password].nil?
       opts[:site] = AbideDevUtils::Prompt.single_line('Jira URL') if opts[:site].nil?
@@ -133,6 +135,16 @@ module AbideDevUtils
       end
     end
 
+    # def self.new_issues_from_comply_report(client, project, report, dry_run: false)
+    #   dr_prefix = dry_run ? 'DRY RUN: ' : ''
+    #   i_attrs = all_project_issues_attrs(project)
+    #   rep_sums = summaries_from_coverage_report(report)
+    #   rep_sums.each do |k, v|
+    #     next if summary_exist?(k, i_attrs)
+
+    #     progress = AbideDevUtils::Output.progress(title: "#{dr_prefix}Creating Tasks", total: nil)
+    #     v.each do |s|
+
     def self.merge_options(options)
       config.merge(options)
     end
@@ -165,6 +177,11 @@ module AbideDevUtils
       summaries.transform_keys { |k| "#{COV_PARENT_SUMMARY_PREFIX}#{benchmark}-#{k}"}
     end
 
+    # def self.summaries_from_comply_report(report)
+    #   summaries = {}
+    #   report.each do |_, v|
+    # end
+
     class Dummy
       def attrs
         { 'fields' => {

data/lib/abide_dev_utils/ppt/new_obj.rb

@@ -2,6 +2,7 @@
 
 require 'erb'
 require 'pathname'
+require 'abide_dev_utils/output'
 require 'abide_dev_utils/prompt'
 require 'abide_dev_utils/errors/ppt'
 
@@ -9,6 +10,10 @@ module AbideDevUtils
   module Ppt
     class NewObjectBuilder
       DEFAULT_EXT = '.pp'
+      VALID_EXT = /(\.pp|\.rb)\.erb$/.freeze
+      TMPL_PATTERN = /^[a-zA-Z][^\s]*\.erb$/.freeze
+      OBJ_PREFIX = /^(c-|d-)/.freeze
+      PREFIX_TEST_PATH = { 'c-' => 'classes', 'd-' => 'defines' }.freeze
 
       def initialize(obj_type, obj_name, opts: {}, vars: {})
         @obj_type = obj_type
@@ -17,25 +22,17 @@ module AbideDevUtils
         @vars = vars
         class_vars
         validate_class_vars
+        @tmpl_data = template_data(@opts.fetch(:tmpl_name, @obj_type))
       end
 
-      attr_reader :obj_type, :obj_name, :tmpl_name, :root_dir, :tmpl_dir, :tmpl_path, :type_path_map, :obj_path, :vars
-
-      def render
-        ERB.new(File.read(@tmpl_path.to_s), 0, '<>-').result(binding)
-      end
+      attr_reader :obj_type, :obj_name, :root_dir, :tmpl_dir, :obj_path, :vars, :tmpl_data
 
       def build
-        continue = File.exist?(obj_path) ? AbideDevUtils::Prompt.yes_no('File exists, would you like to overwrite?') : true
-        return "Not overwriting file #{obj_path}" unless continue
-
-        dir, = Pathname.new(obj_path).split
-        Pathname.new(dir).mkpath unless Dir.exist?(dir)
-        content = render
-        File.open(obj_path, 'w') { |f| f.write(render) } unless content.empty?
-        raise AbideDevUtils::Errors::Ppt::FailedToCreateFileError, obj_path unless File.file?(obj_path)
-
-        "Created file #{obj_path}"
+        force = @opts.fetch(:force, false)
+        obj_cont = force ? true : continue?(obj_path)
+        spec_cont = force ? true : continue?(@tmpl_data[:spec_path])
+        write_file(obj_path, @tmpl_data[:path]) if obj_cont
+        write_file(@tmpl_data[:spec_path], @spec_tmpl) if spec_cont
       end
 
       # If a method gets called on the Hiera object which is not defined,
@@ -59,42 +56,98 @@ module AbideDevUtils
 
       private
 
+      def continue?(path)
+        continue = if File.exist?(path)
+                     AbideDevUtils::Prompt.yes_no('File exists, would you like to overwrite?')
+                   else
+                     true
+                   end
+        AbideDevUtils::Output.simple("Not overwriting file #{path}") unless continue
+
+        continue
+      end
+
+      def write_file(path, tmpl_path)
+        dir, = Pathname.new(path).split
+        Pathname.new(dir).mkpath unless Dir.exist?(dir)
+        content = render(tmpl_path)
+        File.open(path, 'w') { |f| f.write(content) } unless content.empty?
+        raise AbideDevUtils::Errors::Ppt::FailedToCreateFileError, path unless File.file?(path)
+
+        AbideDevUtils::Output.simple("Created file #{path}")
+      end
+
+      def build_obj; end
+
       def class_vars
-        @tmpl_name = @opts.fetch(:tmpl_name, "#{@obj_type}.erb")
         @root_dir = Pathname.new(@opts.fetch(:root_dir, Dir.pwd))
         @tmpl_dir = if @opts.fetch(:absolute_template_dir, false)
                       @opts.fetch(:tmpl_dir)
                     else
-                      "#{@opts.fetch(:root_dir, Dir.pwd)}/#{@opts.fetch(:tmpl_dir, 'object_templates')}"
+                      "#{@root_dir}/#{@opts.fetch(:tmpl_dir, 'object_templates')}"
                     end
-        @tmpl_path = Pathname.new("#{@tmpl_dir}/#{@opts.fetch(:tmpl_name, "#{@obj_type}.erb")}")
-        @type_path_map = @opts.fetch(:type_path_map, {})
         @obj_path = new_obj_path
+        @spec_tmpl = @opts.fetch(:spec_template, File.expand_path(File.join(__dir__, '../resources/generic_spec.erb')))
       end
 
       def validate_class_vars
         raise AbideDevUtils::Errors::PathNotDirectoryError, @root_dir unless Dir.exist? @root_dir
         raise AbideDevUtils::Errors::PathNotDirectoryError, @tmpl_dir unless Dir.exist? @tmpl_dir
-        raise AbideDevUtils::Errors::Ppt::TemplateNotFoundError, @tmpl_path.to_s unless @tmpl_path.file?
       end
 
       def basename(obj_name)
         obj_name.split('::')[-1]
       end
 
-      def new_obj_path
-        if obj_type == 'class'
-          obj_path_from_name
-        else
-          custom_obj_path
+      def prefix
+        pfx = basename.match(OBJ_PREFIX)
+        return pfx[1] unless pfx.empty?
+      end
+
+      def templates
+        return [] if Dir.entries(tmpl_dir).empty?
+
+        file_names = Dir.entries(tmpl_dir).select { |f| f.match?(TMPL_PATTERN) }
+        file_names.map { |i| File.join(tmpl_dir, i) }
+      end
+
+      def template_data(query)
+        raise AbideDevUtils::Errors::Ppt::TemplateNotFoundError, @tmpl_dir if Dir.entries(@tmpl_dir).empty?
+
+        data = {}
+        pattern = /#{Regexp.quote(query)}/
+        templates.each do |i|
+          pn = Pathname.new(i)
+          next unless pn.basename.to_s.match?(pattern)
+
+          data[:path] = pn.to_s
+          data[:fname] = pn.basename.to_s
         end
+        raise AbideDevUtils::Errors::Ppt::TemplateNotFoundError, @tmpl_dir unless data.key?(:fname)
+
+        data[:ext] = data[:fname].match?(VALID_EXT) ? data[:fname].match(VALID_EXT)[1] : '.pp'
+        data[:pfx] = data[:fname].match?(OBJ_PREFIX) ? data[:fname].match(OBJ_PREFIX)[1] : 'c-'
+        data[:spec_base] = PREFIX_TEST_PATH[data[:pfx]]
+        data[:obj_name] = normalize_obj_name(data.dup)
+        data[:spec_name] = "#{@obj_name.split('::')[-1]}_spec.rb"
+        data[:spec_path] = spec_path(data[:spec_base], data[:spec_name])
+        data
+      end
+
+      def normalize_obj_name(data)
+        new_name = data[:fname].slice(/^(?:#{Regexp.quote(data[:pfx])})?(?<name>[^\s.]+)(?:#{Regexp.quote(data[:ext])})?\.erb$/, 'name')
+        "#{new_name}#{data[:ext]}"
+      end
+
+      def render(path)
+        ERB.new(File.read(path), 0, '<>-').result(binding)
       end
 
       def namespace_format(name)
         name.split(':').reject(&:empty?).join('::')
       end
 
-      def obj_path_from_name
+      def new_obj_path
         parts = @obj_name.split('::')[1..-2]
         parts.insert(0, 'manifests')
         parts.insert(-1, "#{basename(@obj_name)}#{DEFAULT_EXT}")
@@ -102,27 +155,13 @@ module AbideDevUtils
         path.to_s
       end
 
-      def custom_obj_path
-        map_val = type_path_map.fetch(@obj_type.to_sym, nil)
-        return obj_path_from_name if map_val.nil?
-
-        if map_val.respond_to?(:key?)
-          custom_obj_path_from_hash(map_val, @obj_name)
-        else
-          abs_path = Pathname.new(map_val).absolute? ? map_val : "#{Dir.pwd}/#{map_val}"
-          "#{abs_path}/#{basename(@obj_name)}#{DEFAULT_EXT}"
-        end
-      end
-
-      def custom_obj_path_from_hash(map_val, obj_name)
-        raise AbideDevUtils::Errors::Ppt::CustomObjPathKeyError, map_val unless map_val.key?(:path)
-
-        abs_path = Pathname.new(map_val[:path]).absolute? ? map_val[:path] : "#{Dir.pwd}/#{map_val[:path]}"
-        if map_val.key?(:extension)
-          "#{abs_path}/#{basename(obj_name)}#{map_val[:extension]}"
-        else
-          "#{abs_path}/#{basename(obj_name)}#{DEFAULT_EXT}"
-        end
+      def spec_path(base_dir, spec_name)
+        parts = @obj_name.split('::')[1..-2]
+        parts.insert(0, 'spec')
+        parts.insert(1, base_dir)
+        parts.insert(-1, spec_name)
+        path = @root_dir + Pathname.new(parts.join('/'))
+        path.to_s
       end
     end
   end

data/lib/abide_dev_utils/resources/generic_spec.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '<%= @obj_name %>' do
+  on_supported_os.each do |os, os_facts|
+    context "on #{os}" do
+      let(:facts) { os_facts }
+
+      it { is_expected.to compile }
+    end
+  end
+end

data/lib/abide_dev_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AbideDevUtils
-  VERSION = "0.2.3"
+  VERSION = "0.5.0"
 end

data/lib/abide_dev_utils/xccdf.rb

@@ -15,7 +15,7 @@ module AbideDevUtils
       type = opts.fetch(:type, 'cis')
       case type.downcase
       when 'cis'
-        AbideDevUtils::XCCDF::CIS::Hiera.new(xccdf_file, parent_key_prefix: opts[:parent_key_prefix])
+        AbideDevUtils::XCCDF::CIS::Hiera.new(xccdf_file, parent_key_prefix: opts[:parent_key_prefix], num: opts[:num])
       else
         AbideDevUtils::Output.simple("XCCDF type #{type} is unsupported!")
       end

data/lib/abide_dev_utils/xccdf/cis/hiera.rb

@@ -35,13 +35,13 @@ module AbideDevUtils
         # @param parent_key_prefix [String] a string to be prepended to the
         #   top-level key in the Hiera structure. Useful for namespacing
         #   the top-level key.
-        def initialize(xccdf_file, parent_key_prefix: nil)
+        def initialize(xccdf_file, parent_key_prefix: nil, num: false)
           @doc = parse(xccdf_file)
           @title = xpath(XPATHS[:benchmark][:title]).children.to_s
           @version = xpath(XPATHS[:benchmark][:version]).children.to_s
           @profiles = xpath(XPATHS[:profiles][:all])
           @parent_key = make_parent_key(@doc, parent_key_prefix)
-          @hash = make_hash(@doc, @parent_key)
+          @hash = make_hash(@doc, @parent_key, num)
         end
 
         def yaml_title
@@ -92,13 +92,16 @@ module AbideDevUtils
 
         attr_accessor :doc, :hash, :parent_key, :profiles
 
+        # Accepts a path to an xccdf xml file and returns a parsed Nokogiri object of the file
+        # @param xccdf_file [String] path to an xccdf xml file
+        # @return [Nokogiri::Node] A Nokogiri node object of the XML document
         def parse(xccdf_file)
           raise AbideDevUtils::Errors::FileNotFoundError, xccdf_file unless File.file?(xccdf_file)
 
           Nokogiri.XML(File.open(xccdf_file))
         end
 
-        def make_hash(doc, parent_key)
+        def make_hash(doc, parent_key, num)
           hash = { parent_key.to_sym => { title: @title, version: @version } }
           profiles = doc.xpath('xccdf:Benchmark/xccdf:Profile')
           profiles.each do |p|
@@ -106,7 +109,7 @@ module AbideDevUtils
             hash[parent_key.to_sym][title.to_sym] = []
             selects = p.xpath('./xccdf:select')
             selects.each do |s|
-              hash[parent_key.to_sym][title.to_sym] << normalize_ctrl_name(s['idref'].to_s)
+              hash[parent_key.to_sym][title.to_sym] << normalize_ctrl_name(s['idref'].to_s, num)
             end
           end
           hash
@@ -114,7 +117,7 @@ module AbideDevUtils
 
         def normalize_str(str)
           nstr = str.downcase
-          nstr.gsub!(/[^a-z]$/, '')
+          nstr.gsub!(/[^a-z0-9]$/, '')
           nstr.gsub!(/^[^a-z]/, '')
           nstr.gsub!(/^(l1_|l2_|ng_)/, '')
           nstr.delete!('(/|\\)')
@@ -128,11 +131,23 @@ module AbideDevUtils
           prof_name
         end
 
-        def normalize_ctrl_name(ctrl)
-          new_ctrl = ctrl.split('_rule_')[-1].gsub(CONTROL_PREFIX, '')
+        def normalize_ctrl_name(ctrl, num)
+          return num_normalize_ctrl(ctrl) if num
+
+          name_normalize_ctrl(ctrl)
+        end
+
+        def name_normalize_ctrl(ctrl)
+          new_ctrl = ctrl.split('benchmarks_rule_')[-1].gsub(CONTROL_PREFIX, '')
           normalize_str(new_ctrl)
         end
 
+        def num_normalize_ctrl(ctrl)
+          part = ctrl.split('benchmarks_rule_')[-1]
+          numpart = CONTROL_PREFIX.match(part).to_s.chop.gsub(UNDERSCORED, '_')
+          "c#{numpart}"
+        end
+
         def make_parent_key(doc, prefix)
           doc_title = normalize_str(doc.xpath(XPATHS[:benchmark][:title]).children.to_s)
           return doc_title if prefix.nil?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Heston Snodgrass
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
@@ -242,11 +270,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -259,10 +289,12 @@ files:
 - lib/abide_dev_utils.rb
 - lib/abide_dev_utils/cli.rb
 - lib/abide_dev_utils/cli/abstract.rb
+- lib/abide_dev_utils/cli/comply.rb
 - lib/abide_dev_utils/cli/jira.rb
 - lib/abide_dev_utils/cli/puppet.rb
 - lib/abide_dev_utils/cli/test.rb
 - lib/abide_dev_utils/cli/xccdf.rb
+- lib/abide_dev_utils/comply.rb
 - lib/abide_dev_utils/config.rb
 - lib/abide_dev_utils/constants.rb
 - lib/abide_dev_utils/errors.rb
@@ -278,6 +310,7 @@ files:
 - lib/abide_dev_utils/ppt/coverage.rb
 - lib/abide_dev_utils/ppt/new_obj.rb
 - lib/abide_dev_utils/prompt.rb
+- lib/abide_dev_utils/resources/generic_spec.erb
 - lib/abide_dev_utils/utils/general.rb
 - lib/abide_dev_utils/validate.rb
 - lib/abide_dev_utils/version.rb