abide_dev_utils 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4ee71223292cc98028db5407eaef69cb2a0a150de9552b4d51d3b1ee17197bf
-  data.tar.gz: 3f56a0ad99e2ae3ccc8478210f7bb1961c4500267bedc1d42612c1947ee7c3fb
+  metadata.gz: 9e53d77f476f80d886ab35e07bbfcf897f117d24be9fdf6cc3c31fc50b3d40e7
+  data.tar.gz: 1fc189884a7c351da992f6ad6e915cc0321c290c67b5e10ae3e35fb0bbc26d79
 SHA512:
-  metadata.gz: 821d519b152ffc0a246939050b2b6117b5f3986fdf094d6333cfef8617b06c1572517a93b96f76039368c860715a4ef7ef39c78c039581369c4e61b484bce0c0
-  data.tar.gz: 6010ad3359da0de05b352e48210f3e4ddbd95b30e942598c6e6cfa77c175a1041ab87491d2a2afa15490a12fc197c549ab5d58dbb4bfc816e569afe5ac66dd9e
+  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

@@ -231,6 +231,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

@@ -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/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/new_obj.rb

@@ -22,9 +22,10 @@ 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, :root_dir, :tmpl_dir, :obj_path, :vars
+      attr_reader :obj_type, :obj_name, :root_dir, :tmpl_dir, :obj_path, :vars, :tmpl_data
 
       def build
         force = @opts.fetch(:force, false)
@@ -85,7 +86,6 @@ module AbideDevUtils
                     else
                       "#{@root_dir}/#{@opts.fetch(:tmpl_dir, 'object_templates')}"
                     end
-        @tmpl_data = template_data(@opts.fetch(:tmpl_name, @obj_type))
         @obj_path = new_obj_path
         @spec_tmpl = @opts.fetch(:spec_template, File.expand_path(File.join(__dir__, '../resources/generic_spec.erb')))
       end
@@ -129,7 +129,7 @@ module AbideDevUtils
         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] = "#{data[:obj_name].slice(/([^\s]+)(?:#{Regexp.quote(data[:ext])})/, 1)}_spec.rb"
+        data[:spec_name] = "#{@obj_name.split('::')[-1]}_spec.rb"
         data[:spec_path] = spec_path(data[:spec_base], data[:spec_name])
         data
       end

data/lib/abide_dev_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AbideDevUtils
-  VERSION = "0.3.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

@@ -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
@@ -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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Heston Snodgrass
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-01 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
@@ -292,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
@@ -307,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: []