abide_dev_utils 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a27976b9f740b67261fa080eeba927bc6fc98e73ffb592fafdd91d4d612cc51f
-  data.tar.gz: 64778a0d476e2f96d70a14ab318b517c597aa3c5e33afd8939173385b013fe6c
+  metadata.gz: '03743386fed00b094d759cb20a53d25d807492fd98097564d140aa0cacfecce0'
+  data.tar.gz: be8082a88120f30f2754f79194a818c7640fd5f104c0c57dc07cd84d8bbc460f
 SHA512:
-  metadata.gz: e31df40e6dd34a57156ff517d39fcc036f5655ce2f31bf86b1ebb66754304575b7379e0a3751ae378bc81bc1520dbe095255012dc7e10b24e4f6c3f4a85e6551
-  data.tar.gz: c9dd204d55a37d389c0c8a4d3d281310b87241cbbd149ca029a3fa6a38fd8414bcb350467cd348cdd330fe946e6ee75625bfe2828319ad25d9eb8ed5cc37a9a3
+  metadata.gz: 1bcd5add724cc85cc95915d778a6320de028b351ea19920b712efe228a4e01efdb36bb2840f5b566f5cf8a3d9ebe90236138fdd0bc0d83e90fbe1f4a0cf67763
+  data.tar.gz: 91f71049317153abafaa32fd9bacdfbfa26b1ba2145ddd902238f6cbc8e31417540eee0812b67ecdb5b5b0c500f1b0ce02ee43b028c37ffb3d87753c75e1729e

data/README.md

@@ -88,6 +88,8 @@ Install the gem:
 
 ### Overview of Commands
 
+* `abide comply` - Command namespace for Puppet Comply commands
+  * `abide comply report` - Creates a scan report in YAML format by scraping Puppet Comply
 * `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
@@ -100,6 +102,34 @@ Install the gem:
 * `abide xccdf` - Command namespace for XCCDF commands
   * `abide xccdf to_hiera` - Converts a benchmark XCCDF file to a Hiera yaml file
 
+### Comply Command Reference
+
+#### report
+
+* Required positional parameters:
+  * `COMPLY_URL` - The URL of Puppet Comply
+  * `COMPLY_PASSWORD` - The password for the Puppet Comply user
+* Options:
+  * `--out-file`, `-o` - The path to save the scan report. Defaults to `./comply_scan_report.yaml`
+  * `--username`, `-u` - The Puppet Comply username. Defaults to `comply`
+  * `--status`, `-s` - A comma-separated list of check statuses to ONLY include in the report. Valid statuses are: `pass`, `fail`, `error`, `notapplicable`, `notchecked`, `unknown`, `informational`
+  * `--only`, `-O` - 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`.
+  * `--ignore`, `-I` - 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.
+
+Examples:
+
+Generating a report of all failed and err'd scan checks
+
+```sh
+abide comply report https://comply.my.instance 'my_comply_password!' -s fail,error
+```
+
+Generating a report for certain nodes only
+
+```sh
+abide comply report https://comply.my.instance 'my_comply_password!' -O specific-node.my.instance
+```
+
 ### Jira Command Reference
 
 #### from_coverage

data/abide_dev_utils.gemspec

@@ -45,6 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'console'
   spec.add_development_dependency 'github_changelog_generator'
   spec.add_development_dependency 'gem-release'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec', '~> 3.10'
   spec.add_development_dependency 'rubocop', '~> 1.8'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.1'

data/lib/abide_dev_utils/cli/comply.rb

@@ -80,7 +80,7 @@ module Abide
         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]
+        status = @data.fetch(:status, nil).nil? ? conf.fetch(:status, nil) : @data[:status]
         ignorelist = @data.fetch(:ignore, nil).nil? ? conf.fetch(:ignore, nil) : @data[:ignore]
         onlylist = @data.fetch(:only, nil).nil? ? conf.fetch(:only, nil) : @data[:only]
         report = AbideDevUtils::Comply.scan_report(comply_url,

data/lib/abide_dev_utils/version.rb

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

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

@@ -41,7 +41,7 @@ module AbideDevUtils
           @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, num)
+          @hash = make_hash(@doc, num)
         end
 
         def yaml_title
@@ -63,8 +63,8 @@ module AbideDevUtils
         # Convert the Hiera object to YAML string
         # @return [String] YAML-formatted string
         def to_yaml
-          yh = @hash[@parent_key.to_sym].transform_keys do |k|
-            "#{@parent_key}::#{k}"
+          yh = @hash.transform_keys do |k|
+            [@parent_key, k].join('::').strip
           end
           yh.to_yaml
         end
@@ -101,15 +101,15 @@ module AbideDevUtils
           Nokogiri.XML(File.open(xccdf_file))
         end
 
-        def make_hash(doc, parent_key, num)
-          hash = { parent_key.to_sym => { title: @title, version: @version } }
+        def make_hash(doc, num)
+          hash = { 'title' => @title, 'version' => @version }
           profiles = doc.xpath('xccdf:Benchmark/xccdf:Profile')
           profiles.each do |p|
             title = normalize_profile_name(p.xpath('./xccdf:title').children.to_s)
-            hash[parent_key.to_sym][title.to_sym] = []
+            hash[title.to_s] = []
             selects = p.xpath('./xccdf:select')
             selects.each do |s|
-              hash[parent_key.to_sym][title.to_sym] << normalize_ctrl_name(s['idref'].to_s, num)
+              hash[title.to_s] << normalize_ctrl_name(s['idref'].to_s, num)
             end
           end
           hash
@@ -120,14 +120,16 @@ module AbideDevUtils
           nstr.gsub!(/[^a-z0-9]$/, '')
           nstr.gsub!(/^[^a-z]/, '')
           nstr.gsub!(/^(l1_|l2_|ng_)/, '')
-          nstr.delete!('(/|\\)')
+          nstr.delete!('(/|\\|\+)')
           nstr.gsub!(UNDERSCORED, '_')
+          nstr.strip!
           nstr
         end
 
         def normalize_profile_name(prof)
           prof_name = normalize_str("profile_#{prof}")
           prof_name.gsub!(NEXT_GEN_WINDOWS, 'ngws')
+          prof_name.strip!
           prof_name
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Heston Snodgrass
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-16 00:00:00.000000000 Z
+date: 2021-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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
@@ -339,7 +353,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Helper utilities for developing Abide