abide_dev_utils 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 368f622d5a56407f757e47a212edaf4279afb6a5e36f075b0f1ce2e283463d53
-  data.tar.gz: 329f00503b626b086375c1b725d72758e90fb32a18cec37028348a1613d8bac3
+  metadata.gz: 5e19e043b233c6842331d4c4883a74d8557b163739e041d910b60b953acddc85
+  data.tar.gz: cf425a2b3a0c83ecd5e41cbee5d476fc7444e8984f4f03df12f91b36ad8aeee8
 SHA512:
-  metadata.gz: 170f8389cc8a0c27e0bd6cb152ef3a1b314203b2e970ac838e2eb514728f1faec11ed0e057d81cbb8a26acccfc7a23299673bdf814e5e60f35eaddf91c6446b3
-  data.tar.gz: 5077c372590de6d0f40931f69f4d70a35be289440ad5e26f93730c4fab171f38262ec81d13616b2f7fba01ccba4c14cc6e82e2ca3a186f09207f7918e624aaca
+  metadata.gz: 52e685b3d446b7c6256fd0e45d0542dccc77490b75ccc6408e2ba66e8edbc49d76267446940b997a0e3ab6a7449e1c5a03323c98cc66dd34ca58fa87178d4602
+  data.tar.gz: 558295f45b37110781fcd22bc4cac8a450c520f706933ddc0fe908c4f2ef863b63029603ab3e1df09142a17c6238f3f5514f20e4fefcc1ed6e2a5531abc5a479

data/README.md

@@ -2,6 +2,8 @@
 
 Helper library and CLI app for Abide development.
 
+Issues and pull requests are welcome!
+
 ## Features
 
 ### CLI
@@ -206,6 +208,15 @@ class test_module::utils::test_new_util (
 
 #### 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:

data/lib/abide_dev_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AbideDevUtils
-  VERSION = "0.2.2"
+  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',
@@ -89,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)
@@ -116,8 +117,8 @@ module AbideDevUtils
           nstr.gsub!(/[^a-z]$/, '')
           nstr.gsub!(/^[^a-z]/, '')
           nstr.gsub!(/^(l1_|l2_|ng_)/, '')
-          nstr.delete!('-')
-          nstr.gsub!(/(\s|\(|\))/, '_')
+          nstr.delete!('(/|\\)')
+          nstr.gsub!(UNDERSCORED, '_')
           nstr
         end
 
@@ -129,7 +130,7 @@ module AbideDevUtils
 
         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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Heston Snodgrass
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri