abide_dev_utils 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75678bc1c177a3187619cfec9d2c25e566b08d91439c3b46c578c4202f4d9a7c
-  data.tar.gz: f9749e6c8ad3d5b0439a8fe0fd03ba3ea91e5c0052057eea43b3862c08b45fbd
+  metadata.gz: 9e53d77f476f80d886ab35e07bbfcf897f117d24be9fdf6cc3c31fc50b3d40e7
+  data.tar.gz: 1fc189884a7c351da992f6ad6e915cc0321c290c67b5e10ae3e35fb0bbc26d79
 SHA512:
-  metadata.gz: 97ba4b3b0898a40ed6df3facaf3aa03beb2d1375d61e1915c6566e107e6edffa083ab7af93827c2679c14a2503504cafd40d9275b12708f582c3723953b5c9c7
-  data.tar.gz: 2680eb354112e27223d590a645318ea14c4988dd0e331bf5a5f3b347402ead6398c8c07c1b7ded55704d76011522ff790459cf40452ceba8ca15dc2a19a76a7a
+  metadata.gz: 2dedd8ca47872aa859852f51172233ffefca9420004804d750969c0b7558caa10caba812570538c5e4989c021c2a6409620502f7459dfcd5027f9c7afafbb6fe
+  data.tar.gz: fe3b5f70661297672e171fce5f452c06a9042f2e101918caaf65be0527c5e401e22169bdfde0d1649b1d8ea6ce85c04262c7147c4fd8f0514d81e0bfdb2e860e

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

@@ -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,184 @@ 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.
+  * `--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:
+
+* `@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
+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 (
+  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',
+  }
+}
+
+```
+
+**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
+
+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
+
+## 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
 

data/abide_dev_utils.gemspec

@@ -41,6 +41,7 @@ Gem::Specification.new do |spec|
   # 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

@@ -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

@@ -3,7 +3,7 @@
 module Abide
   module CLI
     # @abstract
-    class Command < CmdParse::Command
+    class AbideCommand < CmdParse::Command
       include AbideDevUtils::Config
       def initialize(cmd_name, cmd_short, cmd_long, **opts)
         super(cmd_name, **opts)

data/lib/abide_dev_utils/cli/puppet.rb

@@ -4,7 +4,7 @@ require 'abide_dev_utils/cli/abstract'
 
 module Abide
   module CLI
-    class PuppetCommand < Command
+    class PuppetCommand < AbideCommand
       CMD_NAME = 'puppet'
       CMD_SHORT = 'Commands related to Puppet code'
       CMD_LONG = 'Namespace for commands related to Puppet code'
@@ -15,7 +15,7 @@ module Abide
       end
     end
 
-    class PuppetCoverageCommand < 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'
@@ -53,7 +53,7 @@ module Abide
       end
     end
 
-    class PuppetNewCommand < Command
+    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'
@@ -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

@@ -28,6 +28,7 @@ module Abide
         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('-N', '--number-fmt', 'Format Hiera control names based off of control number instead of name.') { |s| @data[:num] = true }
       end
 
       def execute(xccdf_file)

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/ppt.rb

@@ -9,7 +9,7 @@ module AbideDevUtils
     # the full namespace for all classes in that directory.
     # @param puppet_class_dir [String] path to a dir containing Puppet manifests
     # @return [String] The namespace for all classes in manifests in the dir
-    def find_class_namespace(puppet_class_dir)
+    def self.find_class_namespace(puppet_class_dir)
       path = Pathname.new(puppet_class_dir)
       mod_root = nil
       ns_parts = []
@@ -34,7 +34,7 @@ module AbideDevUtils
     # metadata.json, if it exists, or by using the parent directory name.
     # @param pathname [Pathname] A Pathname object of the module's manifests dir
     # @return [String] The module's namespace root
-    def find_mod_root(pathname)
+    def self.find_mod_root(pathname)
       metadata_file = nil
       pathname.entries.each do |e|
         metadata_file = "#{pathname}/metadata.json" if File.basename(e) == 'metadata.json'
@@ -52,7 +52,7 @@ module AbideDevUtils
 
     # @return [Array] An array of frozen arrays where each sub-array's
     #   index 0 is class_name and index 1 is the full path to the file.
-    def find_all_classes_and_paths(puppet_class_dir)
+    def self.find_all_classes_and_paths(puppet_class_dir)
       all_cap = []
       Dir.each_child(puppet_class_dir) do |c|
         path = "#{puppet_class_dir}/#{c}"

data/lib/abide_dev_utils/ppt/coverage.rb

@@ -13,12 +13,14 @@ module AbideDevUtils
       def self.generate(puppet_class_dir, hiera_path, profile = nil)
         coverage = {}
         coverage['classes'] = {}
-        all_cap = find_all_classes_and_paths(puppet_class_dir)
+        all_cap = AbideDevUtils::Ppt.find_all_classes_and_paths(puppet_class_dir)
         invalid_classes = find_invalid_classes(all_cap)
-        valid_classes = all_cap.dup.transpose[0] - invalid_classes
+        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]
@@ -50,9 +52,13 @@ module AbideDevUtils
         out_hash
       end
 
-      def self.find_valid_classes(all_cap)
+      def self.find_valid_classes(all_cap, invalid_classes)
         all_classes = all_cap.dup.transpose[0]
-        all_classes - find_invalid_classes(all_cap)
+        return [] if all_classes.nil?
+
+        return all_classes - invalid_classes unless invalid_classes.nil?
+
+        all_classes
       end
 
       def self.find_invalid_classes(all_cap)

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,53 +10,29 @@ 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
-        @obj_name = obj_name.split(':').reject(&:empty?).join('::') # removes 
-        @obj_basename = obj_name.split('::')[-1]
-        @root_dir = Pathname.new(opts.fetch(:root_dir, Dir.pwd))
-        @tmpl_dir = if opts.fetch(:absolute_template_dir, false)
-                      opts.fetch(:tmpl_dir)
-                    else
-                      "#{@root_dir}/#{opts.fetch(:tmpl_dir, 'object_templates')}"
-                    end
-        @tmpl_name = opts.fetch(:tmpl_name, "#{@obj_type}.erb")
-        @tmpl_path = Pathname.new("#{@tmpl_dir}/#{@tmpl_name}")
-        @type_path_map = opts.fetch(:type_path_map, {})
+        @obj_name = namespace_format(obj_name)
+        @opts = opts
         @vars = vars
+        class_vars
+        validate_class_vars
+        @tmpl_data = template_data(@opts.fetch(:tmpl_name, @obj_type))
       end
 
-      def obj_path
-        case @obj_type
-        when 'class'
-          obj_path_from_name
-        else
-          custom_obj_path
-        end
-      end
-
-      def template?
-        @tmpl_path.file?
-      end
-
-      def render
-        raise AbideDevUtils::Errors::Ppt::TemplateNotFoundError, @tmpl_path.to_s unless template?
-
-        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,
@@ -79,35 +56,112 @@ module AbideDevUtils
 
       private
 
-      def obj_path_from_name
-        parts = @obj_name.split('::')[1..-2]
-        parts.insert(0, 'manifests')
-        parts.insert(-1, "#{@obj_basename}#{DEFAULT_EXT}")
-        path = @root_dir + Pathname.new(parts.join('/'))
-        path.to_s
+      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 custom_obj_path
-        map_val = @type_path_map.fetch(@obj_type.to_sym, nil)
-        return obj_path_from_name if map_val.nil?
+      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)
 
-        if map_val.respond_to?(:key?)
-          custom_obj_path_from_hash(map_val)
-        else
-          abs_path = Pathname.new(map_val).absolute? ? map_val : "#{Dir.pwd}/#{map_val}"
-          "#{abs_path}/#{@obj_basename}#{DEFAULT_EXT}"
-        end
+        AbideDevUtils::Output.simple("Created file #{path}")
       end
 
-      def custom_obj_path_from_hash(map_val)
-        raise AbideDevUtils::Errors::Ppt::CustomObjPathKeyError, map_val unless map_val.key?(:path)
+      def build_obj; end
 
-        abs_path = Pathname.new(map_val[:path]).absolute? ? map_val[:path] : "#{Dir.pwd}/#{map_val[:path]}"
-        if map_val.key?(:extension)
-          "#{abs_path}/#{@obj_basename}#{map_val[:extension]}"
-        else
-          "#{abs_path}/#{@obj_basename}#{DEFAULT_EXT}"
+      def class_vars
+        @root_dir = Pathname.new(@opts.fetch(:root_dir, Dir.pwd))
+        @tmpl_dir = if @opts.fetch(:absolute_template_dir, false)
+                      @opts.fetch(:tmpl_dir)
+                    else
+                      "#{@root_dir}/#{@opts.fetch(:tmpl_dir, 'object_templates')}"
+                    end
+        @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
+      end
+
+      def basename(obj_name)
+        obj_name.split('::')[-1]
+      end
+
+      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 new_obj_path
+        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 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.0"
+  VERSION = "0.4.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], strategy: opts[:strategy])
       else
         AbideDevUtils::Output.simple("XCCDF type #{type} is unsupported!")
       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
 
@@ -33,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
@@ -88,15 +90,18 @@ module AbideDevUtils
 
         private
 
-        attr_accessor :doc, :parent_key, :hash, :profiles
+        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|
@@ -104,33 +109,51 @@ 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
         end
 
         def normalize_str(str)
-          str.delete('-').gsub(/\s/, '_').downcase
+          nstr = str.downcase
+          nstr.gsub!(/[^a-z0-9]$/, '')
+          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(/\./, '_'))
+        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)
-          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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Heston Snodgrass
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -108,6 +108,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 +256,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -278,6 +294,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
@@ -291,7 +308,7 @@ metadata:
   homepage_uri: https://github.com/hsnodgrass/abide_dev_utils
   source_code_uri: https://github.com/hsnodgrass/abide_dev_utils
   changelog_uri: https://github.com/hsnodgrass/abide_dev_utils
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -306,8 +323,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Helper utilities for developing Abide
 test_files: []