abide_dev_utils 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb6febf04efd889f8fae16d58b7951a1e209c57aef125a03017ac3fdc5229a88
-  data.tar.gz: f133a75839ef09396eba54bb6f563567c9f5cf7057aab1a03a5ec09598600cd8
+  metadata.gz: 5e19e043b233c6842331d4c4883a74d8557b163739e041d910b60b953acddc85
+  data.tar.gz: cf425a2b3a0c83ecd5e41cbee5d476fc7444e8984f4f03df12f91b36ad8aeee8
 SHA512:
-  metadata.gz: 798de0252108b50dbe3486f1edceb916e985039087ccf23f2ff0c2a0f1f1f75e0478a45c4a78b634968e197a03628869f968cf55236ab8b7e4bd7e3f1f9f17e1
-  data.tar.gz: e41abc0cbcd7bdb8ac3b700beed14479baf9287ad10c1bc8405d22384afb75df7e8a0dee0f9914f99e2b81576dff2b5d8f10b06a3dfe66595858fa6967e71eb1
+  metadata.gz: 52e685b3d446b7c6256fd0e45d0542dccc77490b75ccc6408e2ba66e8edbc49d76267446940b997a0e3ab6a7449e1c5a03323c98cc66dd34ca58fa87178d4602
+  data.tar.gz: 558295f45b37110781fcd22bc4cac8a450c520f706933ddc0fe908c4f2ef863b63029603ab3e1df09142a17c6238f3f5514f20e4fefcc1ed6e2a5531abc5a479

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [v0.1.0](https://github.com/hsnodgrass/abide_dev_utils/tree/v0.1.0) (2021-01-22)
+
+[Full Changelog](https://github.com/hsnodgrass/abide_dev_utils/compare/f24cea86afb34d0b4904576400db8b8039f1eecc...v0.1.0)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -4,5 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in abide_dev_utils.gemspec
 gemspec
-
-gem "rake", "~> 13.0"

data/README.md

@@ -2,15 +2,50 @@
 
 Helper library and CLI app for Abide development.
 
+Issues and pull requests are welcome!
+
+## Features
+
+### CLI
+
+* Type `abide -h` to see the CLI help menu
+* All commands have help menus
+* Tested on MacOS, should also work on Linux
+
+### PDK-like manifest generation from local ERB templates
+
+* Create a directory in your module called `object_templates` to hold ERB files
+* Generate manifests from those ERB files
+
+### XCCDF to Hiera conversion
+
+* Convert the contents of an XCCDF XML file to Hiera
+
+### Coverage Reporting
+
+* Generate a coverage report (i.e. how many CIS controls are covered by classes in your module)
+
+### Jira Integration
+
+* Create Jira issues in bulk from coverage reports
+
+### Supports Configuration via Local YAML file
+
+* Fully configurable via the `~/.abide_dev.yaml` file
+
 ## Installation
 
 ### CLI app
 
-```sh
-$ gem install abide_dev_utils
-...
-$ abide -h
-```
+Install from RubyGems:
+
+`gem install abide_dev_utils`
+
+Then to access the help menu:
+
+`abide -h`
+
+### As a dependency
 
 Add this line to your application's Gemfile:
 
@@ -26,9 +61,168 @@ Or install it yourself as:
 
 `$ gem install abide_dev_utils`
 
+### Build it yourself
+
+Clone this repo:
+
+`git clone <this repo>`
+
+Build the gem:
+
+`bundle exec rake build`
+
+The gem will be located at `pkg/<gem file>`
+
+Install the gem:
+
+`gem install pkg/<gem file>`
+
 ## Usage
 
-Coming soon, in the mean time run `abide -h` and `abide [command] -h` for help.
+* `abide -h` - CLI top-level help menu
+* `abide <command> -h` - Command-specific help menu
+
+### Overview of Commands
+
+* `abide jira` - Command namespace for Jira commands
+  * `abide jira auth` - Authenticate with Jira. Only useful as a stand-alone command to test authentication
+  * `abide jira from_coverage` - Creates a parent issue with subtasks from a Puppet coverage report
+  * `abide jira get_issue` - Gets a specific Jira issue
+  * `abide jira new_issue` - Creates a new Jira issue
+* `abide puppet` - Command namespace for Puppet commands
+  * `abide puppet coverage` - Generate a "coverage" report. This examines how many manifests you have in your Puppet module versus how many CIS controls exist in the local Hiera data and gives you a breakdown of what percentage of the selected CIS benchmark / profile you have successfully covered.
+  * `abide puppet new` - Generate a new manifest from a local ERB template. Functions similar to `pdk new` except you can create arbitrary manifests.
+* `abide test` - **BUGGED** Runs a module's test suite. Currently has issues with local gem environments.
+* `abide xccdf` - Command namespace for XCCDF commands
+  * `abide xccdf to_hiera` - Converts a benchmark XCCDF file to a Hiera yaml file
+
+### Jira Command Reference
+
+#### from_coverage
+
+* Required positional parameters:
+  * `REPORT` - A path to a JSON file generated by the `abide puppet coverage` command
+  * `PROJECT` - A Jira project code. This is typically an all-caps abbreviation of a Jira project
+* Options:
+  * `--dry-run`, `-d` - Prints the results of this command to the console instead of actually creating Jira issues
+
+### Puppet Command Reference
+
+#### coverage
+
+* Required positional parameters:
+  * `CLASS_DIR` - The path to the directory in your module that holds manifests named after the benchmark controls
+  * `HIERA_FILE` - The path to the Hiera file generated by the `abide xccdf to_hiera` command
+* Options:
+  * `--out-file`, `-o` - The path to save the coverage report JSON file
+  * `--profile`, `-p` - A benchmark profile to generate the report for. By default, generates the report for all profiles
+
+#### new
+
+* Required positional parameters:
+  * `TYPE` - The type of object you would like to generate. This value is the name of an ERB template without `.erb` located in your template directory
+  * `NAME` - The fully namespaced name of the new object. Subdirectories will be automatically created within `manifests` based on the namespacing of this parameter if the directories do not exist.
+* Options:
+  * `--template-dir`, `-t` - Name of the template directory relative to your module's root directory. Defaults to `object_templates`
+  * `--root-dir`, `-r` - Path to the root directory of your module. Defaults to the current working directory
+  * `--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.
+
+`abide puppet new` exposes a few variables for you to use in your templates by default:
+
+* `@obj_name` - The value of the `NAME` parameter passed into the command
+* `@vars` - A hash of any key=value pairs you passed into the command using `--vars`
+
+Examples:
+
+Lets assume we have a module at `~/test_module` and we have a directory in that module called `object_templates`. In the template directory, we have two ERB template files: `control_class.erb` and `util_class.erb`.
+
+* control_class.erb
+
+```text
+# @api private
+class <%= @obj_name %> (
+  Boolean $enforce = true,
+  Hash $config = {},
+) {
+  if $enforce {
+    warning('Class not implemented yet')
+  }
+}
+
+```
+
+* util_class.erb
+
+```text
+class <%= @obj_name %> (
+<% if @vars.key?('testvar1') -%>
+  $testparam1 = '<%= @vars['testvar1'] %>',
+<% else -%>
+  $testparam1 = undef,
+<% end -%>
+) {
+  file { $testparam1:
+    ensure => file,
+    mode   => '<%= @vars.fetch('testvar2', '0644') %>',
+  }
+}
+
+```
+
+```text
+$ cd ~/test_module
+$ ls object_templates
+control_class.erb  util_class.erb
+$ 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
+$ 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
+$ cat manifests/controls/test_new_control.pp
+# @api private
+class test_module::controls::test_new_control (
+  Boolean $enforce = true,
+  Hash $config = {},
+) {
+  if $enforce {
+    warning('Class not implemented yet')
+  }
+}
+
+$ cat manifests/utils/test_new_util.pp
+class test_module::utils::test_new_util (
+  $testparam1 = 'dude',
+) {
+  file { 'dude':
+    ensure => file,
+    mode   => 'sweet',
+  }
+}
+
+```
+
+### XCCDF Command Reference
+
+#### to_hiera
+
+NOTE: When converting XCCDF files to Hiera, control names are sanitized. This means that some characters will be changed to ensure the resulting control names in the Hiera file are valid for both YAML and Puppet class names. Here's what gets changed:
+
+* All letters are coverted to lower case
+* The first and last characters of the control name is dropped if they are not letters (a-z)
+* If a control name has a prefix of `l1_`, `l2_`, or `ng_`, that prefix is dropped
+  * Differentiation between profile level occurs outside of control names
+* The characters `/` and `\` are deleted. This means that paths are smashed together
+* Whitespace and the characters `(`, `)`, `.`, and `-` are substituted with underscores (`_`)
+
+* Required positional parameters:
+  * `XCCDF_FILE` - Path to an XCCDF XML file
+* Options:
+  * `--benchmark-type`, `-b` - The type of benchmark. Defaults to `cis`
+  * `--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
 
 ## Development
 

data/abide_dev_utils.gemspec

@@ -32,21 +32,24 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Prod dependencies
-  spec.add_dependency 'bundler', '~> 2.0'
   spec.add_dependency 'nokogiri', '~> 1.11'
   spec.add_dependency 'cmdparse', '~> 3.0'
-  spec.add_dependency 'puppet', '<= 6.19'
+  spec.add_dependency 'puppet', '>= 6.19'
   spec.add_dependency 'jira-ruby', '~> 2.1'
   spec.add_dependency 'ruby-progressbar', '~> 1.11'
 
   # Dev dependencies
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'github_changelog_generator'
+  spec.add_development_dependency 'gem-release'
   spec.add_development_dependency 'rspec', '~> 3.10'
   spec.add_development_dependency 'rubocop', '~> 1.8'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.1'
   spec.add_development_dependency 'rubocop-ast', '~> 1.4'
   spec.add_development_dependency 'rubocop-performance', '~> 1.9'
   spec.add_development_dependency 'rubocop-i18n', '~> 3.0'
-  spec.add_development_dependency 'fast_gettext', '~> 1.1'
+  spec.add_development_dependency 'fast_gettext', '~> 1.8'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/abide_dev_utils.rb

@@ -2,8 +2,9 @@
 
 require 'abide_dev_utils/version'
 require 'abide_dev_utils/xccdf'
-require 'abide_dev_utils/utils'
-require 'abide_dev_utils/errors'
+require 'abide_dev_utils/ppt'
+require 'abide_dev_utils/jira'
+require 'abide_dev_utils/config'
 
-# Just creates the namespace
+# Root namespace all modules / classes
 module AbideDevUtils; end

data/lib/abide_dev_utils/cli.rb

@@ -20,6 +20,7 @@ module Abide
       parser.main_options.version = AbideDevUtils::VERSION
       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(PuppetCommand.new)
       parser.add_command(XccdfCommand.new)
       parser.add_command(TestCommand.new)

data/lib/abide_dev_utils/cli/abstract.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Abide
+  module CLI
+    # @abstract
+    class AbideCommand < CmdParse::Command
+      include AbideDevUtils::Config
+      def initialize(cmd_name, cmd_short, cmd_long, **opts)
+        super(cmd_name, **opts)
+        short_desc(cmd_short)
+        long_desc(cmd_long)
+        add_command(CmdParse::HelpCommand.new, default: true) if opts[:takes_commands]
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/cli/jira.rb

@@ -36,7 +36,9 @@ module Abide
       def execute
         client = JIRA.client
         myself = JIRA.get_myself(client)
-        Abide::CLI::OUTPUT.simple("Successfully authenticated user #{myself.attrs['name']}!") unless myself.attrs['name'].empty?
+        return if myself.attrs['name'].empty?
+
+        Abide::CLI::OUTPUT.simple("Successfully authenticated user #{myself.attrs['name']}!")
       end
     end
 

data/lib/abide_dev_utils/cli/puppet.rb

@@ -1,30 +1,28 @@
 # frozen_string_literal: true
 
+require 'abide_dev_utils/cli/abstract'
+
 module Abide
   module CLI
-    class PuppetCommand < CmdParse::Command
+    class PuppetCommand < AbideCommand
       CMD_NAME = 'puppet'
       CMD_SHORT = 'Commands related to Puppet code'
       CMD_LONG = 'Namespace for commands related to Puppet code'
       def initialize
-        super(CMD_NAME, takes_commands: true)
-        short_desc(CMD_SHORT)
-        long_desc(CMD_LONG)
-        add_command(CmdParse::HelpCommand.new, default: true)
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: true)
         add_command(PuppetCoverageCommand.new)
+        add_command(PuppetNewCommand.new)
       end
     end
 
-    class PuppetCoverageCommand < CmdParse::Command
+    class PuppetCoverageCommand < AbideCommand
       CMD_NAME = 'coverage'
       CMD_SHORT = 'Generates control coverage report'
       CMD_LONG = 'Generates report of valid Puppet classes that match with Hiera controls'
       CMD_CLASS_DIR = 'Directory that holds Puppet manifests'
       CMD_HIERA_FILE = 'Hiera file generated from an XCCDF'
       def initialize
-        super(CMD_NAME, takes_commands: false)
-        short_desc(CMD_SHORT)
-        long_desc(CMD_LONG)
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false)
         argument_desc(CLASS_DIR: CMD_CLASS_DIR, HIERA_FILE: CMD_HIERA_FILE)
         options.on('-o [FILE]', '--out-file [FILE]', 'Path to save the coverage report') { |f| @data[:file] = f }
         options.on('-p [PROFILE]', '--profile [PROFILE]', 'Generate only for profile') { |p| @data[:profile] = p }
@@ -43,7 +41,7 @@ module Abide
         require 'abide_dev_utils/ppt'
         Abide::CLI::VALIDATE.directory(class_dir)
         Abide::CLI::VALIDATE.file(hiera_file)
-        coverage = AbideDevUtils::Ppt.coverage_report(class_dir, hiera_file, @data[:profile])
+        coverage = AbideDevUtils::Ppt::CoverageReport.generate(class_dir, hiera_file, @data[:profile])
         coverage.each do |k, v|
           next if ['classes', 'benchmark'].include?(k)
 
@@ -54,5 +52,54 @@ module Abide
         Abide::CLI::OUTPUT.json(coverage, file: @data[:file])
       end
     end
+
+    class PuppetNewCommand < AbideCommand
+      CMD_NAME = 'new'
+      CMD_SHORT = 'Generates a new Puppet object from templates'
+      CMD_LONG = 'Generates a new Puppet object (class, test, etc.) from templates stored in the module repo'
+      CMD_TYPE_ARG = 'The type of object to generate. This value must be the name of a template (without .erb) file in <template dir>'
+      CMD_NAME_ARG = 'The fully namespaced name of the new object'
+      def initialize
+        super(CMD_NAME, CMD_SHORT, CMD_LONG, takes_commands: false)
+        argument_desc(TYPE: CMD_TYPE_ARG, NAME: CMD_NAME_ARG)
+        options.on(
+          '-t [DIR]',
+          '--template-dir [DIR]',
+          'Path to the directory holding your ERB templates for custom objects. Defaults to "object_templates" in the root dir.'
+        ) { |t| @data[:tmpl_dir] = t }
+        options.on(
+          '-r [DIR]',
+          '--root-dir [DIR]',
+          'Path to the root directory of the module. Defaults to the current working directory.'
+        ) { |r| @data[:root_dir] = r }
+        options.on(
+          '-A',
+          '--absolute-template-dir',
+          'Use this flage if the template dir is an absolute path'
+        ) { |a| @data[:absolute_template_dir] = a }
+        options.on(
+          '-n [NAME]',
+          '--template-name [NAME]',
+          'Allows you to specify a name for the template if it is different from the basename (last segment) of the object name.'
+        )
+        options.on(
+          '-V [VARNAME=VALUE]',
+          '--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 }
+      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
+        )
+        result = builder.build
+        Abide::CLI::OUTPUT.simple(result)
+      end
+    end
   end
 end

data/lib/abide_dev_utils/errors.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'abide_dev_utils/errors/base'
 require 'abide_dev_utils/errors/general'
 require 'abide_dev_utils/errors/jira'
 require 'abide_dev_utils/errors/xccdf'
+require 'abide_dev_utils/errors/ppt'

data/lib/abide_dev_utils/errors/ppt.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/errors/base'
+
+module AbideDevUtils
+  module Errors
+    module Ppt
+      class ObjClassPathError < GenericError
+        @default = 'Invalid path for class:'
+      end
+
+      class CustomObjPathKeyError < GenericError
+        @default = 'Custom Object value hash does not have :path key: '
+      end
+
+      class CustomObjNotFoundError < GenericError
+        @default = 'Could not find custom object in map:'
+      end
+
+      class TemplateNotFoundError < GenericError
+        @default = 'Template does not exist at:'
+      end
+
+      class FailedToCreateFileError < GenericError
+        @default = 'Failed to create file:'
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/jira.rb

@@ -148,7 +148,7 @@ module AbideDevUtils
       false
     end
 
-    def self.summaries_from_coverage_report(report)
+    def self.summaries_from_coverage_report(report) # rubocop:disable Metrics/CyclomaticComplexity
       summaries = {}
       benchmark = nil
       report.each do |k, v|

data/lib/abide_dev_utils/ppt.rb

@@ -1,52 +1,10 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'pathname'
-require 'yaml'
-require 'puppet_pal'
+require 'abide_dev_utils/ppt/coverage'
+require 'abide_dev_utils/ppt/new_obj'
 
 module AbideDevUtils
   module Ppt
-    def self.coverage_report(puppet_class_dir, hiera_path, profile = nil)
-      coverage = {}
-      coverage['classes'] = {}
-      all_cap = find_all_classes_and_paths(puppet_class_dir)
-      invalid_classes = find_invalid_classes(all_cap)
-      valid_classes = all_cap.dup.transpose[0] - invalid_classes
-      coverage['classes']['invalid'] = invalid_classes
-      coverage['classes']['valid'] = valid_classes
-      hiera = YAML.safe_load(File.open(hiera_path))
-      matcher = profile.nil? ? /^profile_/ : /^profile_#{profile}/
-      hiera.each do |k, v|
-        key_base = k.split('::')[-1]
-        coverage['benchmark'] = v if key_base == 'title'
-        next unless key_base.match?(matcher)
-
-        coverage[key_base] = generate_uncovered_data(v, valid_classes)
-      end
-      coverage
-    end
-
-    def self.generate_uncovered_data(ctrl_list, valid_classes)
-      out_hash = {}
-      out_hash[:num_total] = ctrl_list.length
-      out_hash[:uncovered] = []
-      out_hash[:covered] = []
-      ctrl_list.each do |c|
-        if valid_classes.include?(c)
-          out_hash[:covered] << c
-        else
-          out_hash[:uncovered] << c
-        end
-      end
-      out_hash[:num_covered] = out_hash[:covered].length
-      out_hash[:num_uncovered] = out_hash[:uncovered].length
-      out_hash[:coverage] = Float(
-        (Float(out_hash[:num_covered]) / Float(out_hash[:num_total])) * 100.0
-      ).floor(3)
-      out_hash
-    end
-
     # Given a directory holding Puppet manifests, returns
     # the full namespace for all classes in that directory.
     # @param puppet_class_dir [String] path to a dir containing Puppet manifests
@@ -104,32 +62,5 @@ module AbideDevUtils
       end
       all_cap
     end
-
-    def self.find_valid_classes(all_cap)
-      all_classes = all_cap.dup.transpose[0]
-      all_classes - find_invalid_classes(all_cap)
-    end
-
-    def self.find_invalid_classes(all_cap)
-      invalid_classes = []
-      all_cap.each do |cap|
-        invalid_classes << cap[0] unless class_valid?(cap[1])
-      end
-      invalid_classes
-    end
-
-    def self.class_valid?(manifest_path)
-      compiler = Puppet::Pal::Compiler.new(nil)
-      ast = compiler.parse_file(manifest_path)
-      ast.body.body.statements.each do |s|
-        next unless s.respond_to?(:arguments)
-        next unless s.arguments.respond_to?(:each)
-
-        s.arguments.each do |i|
-          return false if i.value == 'Not implemented'
-        end
-      end
-      true
-    end
   end
 end

data/lib/abide_dev_utils/ppt/coverage.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'pathname'
+require 'yaml'
+require 'puppet_pal'
+require 'abide_dev_utils/ppt'
+
+module AbideDevUtils
+  module Ppt
+    class CoverageReport
+      include AbideDevUtils::Ppt
+      def self.generate(puppet_class_dir, hiera_path, profile = nil)
+        coverage = {}
+        coverage['classes'] = {}
+        all_cap = AbideDevUtils::Ppt.find_all_classes_and_paths(puppet_class_dir)
+        invalid_classes = find_invalid_classes(all_cap)
+        valid_classes = find_valid_classes(all_cap, invalid_classes)
+        coverage['classes']['invalid'] = invalid_classes
+        coverage['classes']['valid'] = valid_classes
+        hiera = YAML.safe_load(File.open(hiera_path))
+        profile&.gsub!(/^profile_/, '') unless profile.nil?
+
+        matcher = profile.nil? ? /^profile_/ : /^profile_#{profile}/
+        hiera.each do |k, v|
+          key_base = k.split('::')[-1]
+          coverage['benchmark'] = v if key_base == 'title'
+          next unless key_base.match?(matcher)
+
+          coverage[key_base] = generate_uncovered_data(v, valid_classes)
+        end
+        coverage
+      end
+
+      def self.generate_uncovered_data(ctrl_list, valid_classes)
+        out_hash = {}
+        out_hash[:num_total] = ctrl_list.length
+        out_hash[:uncovered] = []
+        out_hash[:covered] = []
+        ctrl_list.each do |c|
+          if valid_classes.include?(c)
+            out_hash[:covered] << c
+          else
+            out_hash[:uncovered] << c
+          end
+        end
+        out_hash[:num_covered] = out_hash[:covered].length
+        out_hash[:num_uncovered] = out_hash[:uncovered].length
+        out_hash[:coverage] = Float(
+          (Float(out_hash[:num_covered]) / Float(out_hash[:num_total])) * 100.0
+        ).floor(3)
+        out_hash
+      end
+
+      def self.find_valid_classes(all_cap, invalid_classes)
+        all_classes = all_cap.dup.transpose[0]
+        return [] if all_classes.nil?
+
+        return all_classes - invalid_classes unless invalid_classes.nil?
+
+        all_classes
+      end
+
+      def self.find_invalid_classes(all_cap)
+        invalid_classes = []
+        all_cap.each do |cap|
+          invalid_classes << cap[0] unless class_valid?(cap[1])
+        end
+        invalid_classes
+      end
+
+      def self.class_valid?(manifest_path)
+        compiler = Puppet::Pal::Compiler.new(nil)
+        ast = compiler.parse_file(manifest_path)
+        ast.body.body.statements.each do |s|
+          next unless s.respond_to?(:arguments)
+          next unless s.arguments.respond_to?(:each)
+
+          s.arguments.each do |i|
+            return false if i.value == 'Not implemented'
+          end
+        end
+        true
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/ppt/new_obj.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'pathname'
+require 'abide_dev_utils/prompt'
+require 'abide_dev_utils/errors/ppt'
+
+module AbideDevUtils
+  module Ppt
+    class NewObjectBuilder
+      DEFAULT_EXT = '.pp'
+
+      def initialize(obj_type, obj_name, opts: {}, vars: {})
+        @obj_type = obj_type
+        @obj_name = namespace_format(obj_name)
+        @opts = opts
+        @vars = vars
+        class_vars
+        validate_class_vars
+      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
+
+      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}"
+      end
+
+      # If a method gets called on the Hiera object which is not defined,
+      # this sends that method call to hash, then doc, then super.
+      def method_missing(method, *args, &block)
+        return true if ['exist?', 'exists?'].include?(method.to_s)
+
+        return @hash.send(method, *args, &block) if @hash.respond_to?(method)
+
+        return @doc.send(method, *args, &block) if @doc.respond_to?(method)
+
+        super(method, *args, &block)
+      end
+
+      # Checks the respond_to? of hash, doc, or super
+      def respond_to_missing?(method_name, include_private = false)
+        return true if ['exist?', 'exists?'].include?(method_name.to_s)
+
+        @hash || @doc || super
+      end
+
+      private
+
+      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')}"
+                    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
+      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
+        end
+      end
+
+      def namespace_format(name)
+        name.split(':').reject(&:empty?).join('::')
+      end
+
+      def obj_path_from_name
+        parts = @obj_name.split('::')[1..-2]
+        parts.insert(0, 'manifests')
+        parts.insert(-1, "#{basename(@obj_name)}#{DEFAULT_EXT}")
+        path = @root_dir + Pathname.new(parts.join('/'))
+        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
+      end
+    end
+  end
+end

data/lib/abide_dev_utils/version.rb

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

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

@@ -13,6 +13,7 @@ module AbideDevUtils
       # @!attribute [r] yaml_title
       class Hiera
         CONTROL_PREFIX = /^[\d.]+_/.freeze
+        UNDERSCORED = /(\s|\(|\)|-|\.)/.freeze
         XPATHS = {
           benchmark: {
             all: 'xccdf:Benchmark',
@@ -25,6 +26,7 @@ module AbideDevUtils
             relative_select: './xccdf:select'
           }
         }.freeze
+        NEXT_GEN_WINDOWS = /(next_generation_windows_security)/.freeze
 
         attr_reader :title, :version
 
@@ -88,7 +90,7 @@ module AbideDevUtils
 
         private
 
-        attr_accessor :doc, :parent_key, :hash, :profiles
+        attr_accessor :doc, :hash, :parent_key, :profiles
 
         def parse(xccdf_file)
           raise AbideDevUtils::Errors::FileNotFoundError, xccdf_file unless File.file?(xccdf_file)
@@ -111,26 +113,32 @@ module AbideDevUtils
         end
 
         def normalize_str(str)
-          str.delete('-').gsub(/\s/, '_').downcase
+          nstr = str.downcase
+          nstr.gsub!(/[^a-z]$/, '')
+          nstr.gsub!(/^[^a-z]/, '')
+          nstr.gsub!(/^(l1_|l2_|ng_)/, '')
+          nstr.delete!('(/|\\)')
+          nstr.gsub!(UNDERSCORED, '_')
+          nstr
         end
 
         def normalize_profile_name(prof)
-          normalize_str("profile_#{prof}")
+          prof_name = normalize_str("profile_#{prof}")
+          prof_name.gsub!(NEXT_GEN_WINDOWS, 'ngws')
+          prof_name
         end
 
         def normalize_ctrl_name(ctrl)
           new_ctrl = ctrl.split('_rule_')[-1].gsub(CONTROL_PREFIX, '')
-          normalize_str(new_ctrl.gsub(/\./, '_'))
+          normalize_str(new_ctrl)
         end
 
         def make_parent_key(doc, prefix)
           doc_title = normalize_str(doc.xpath(XPATHS[:benchmark][:title]).children.to_s)
-          if prefix.nil?
-            doc_title
-          else
-            sepped_prefix = prefix.end_with?('::') ? prefix : "#{prefix}::"
-            "#{sepped_prefix.chomp}#{doc_title}"
-          end
+          return doc_title if prefix.nil?
+
+          sepped_prefix = prefix.end_with?('::') ? prefix : "#{prefix}::"
+          "#{sepped_prefix.chomp}#{doc_title}"
         end
       end
     end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Heston Snodgrass
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -56,14 +42,14 @@ dependencies:
   name: puppet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.19'
 - !ruby/object:Gem::Dependency
@@ -94,6 +80,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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
+    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: gem-release
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +226,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.8'
 description: Provides a CLI with helpful utilities for developing Abide
 email:
 - hsnodgrass3@gmail.com
@@ -204,6 +246,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -215,6 +258,7 @@ files:
 - exe/abide
 - lib/abide_dev_utils.rb
 - lib/abide_dev_utils/cli.rb
+- lib/abide_dev_utils/cli/abstract.rb
 - lib/abide_dev_utils/cli/jira.rb
 - lib/abide_dev_utils/cli/puppet.rb
 - lib/abide_dev_utils/cli/test.rb
@@ -225,11 +269,14 @@ files:
 - lib/abide_dev_utils/errors/base.rb
 - lib/abide_dev_utils/errors/general.rb
 - lib/abide_dev_utils/errors/jira.rb
+- lib/abide_dev_utils/errors/ppt.rb
 - lib/abide_dev_utils/errors/xccdf.rb
 - lib/abide_dev_utils/files.rb
 - lib/abide_dev_utils/jira.rb
 - lib/abide_dev_utils/output.rb
 - lib/abide_dev_utils/ppt.rb
+- 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/utils/general.rb
 - lib/abide_dev_utils/validate.rb