abide_dev_utils 0.6.0 → 0.9.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.9.3
 platform: ruby
 authors:
-- Heston Snodgrass
+- abide-team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-24 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.34'
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -290,22 +304,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-description: Provides a CLI with helpful utilities for developing Abide
+description: Provides a CLI with helpful utilities for developing compliance Puppet
+  code
 email:
-- hsnodgrass3@gmail.com
+- abide-team@puppet.com
 executables:
 - abide
 extensions: []
 extra_rdoc_files: []
 files:
-- ".dockerignore"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
-- Dockerfile
+- CODEOWNERS
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -339,24 +354,23 @@ files:
 - lib/abide_dev_utils/mixins.rb
 - lib/abide_dev_utils/output.rb
 - lib/abide_dev_utils/ppt.rb
+- lib/abide_dev_utils/ppt/api.rb
 - lib/abide_dev_utils/ppt/class_utils.rb
 - lib/abide_dev_utils/ppt/coverage.rb
 - lib/abide_dev_utils/ppt/new_obj.rb
+- lib/abide_dev_utils/ppt/score_module.rb
 - lib/abide_dev_utils/prompt.rb
 - lib/abide_dev_utils/resources/generic_spec.erb
 - lib/abide_dev_utils/validate.rb
 - lib/abide_dev_utils/version.rb
 - lib/abide_dev_utils/xccdf.rb
-- lib/abide_dev_utils/xccdf/cis.rb
-- lib/abide_dev_utils/xccdf/cis/hiera.rb
-- lib/abide_dev_utils/xccdf/utils.rb
-homepage: https://github.com/hsnodgrass/abide_dev_utils
+homepage: https://github.com/puppetlabs/abide_dev_utils
 licenses:
 - MIT
 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
+  homepage_uri: https://github.com/puppetlabs/abide_dev_utils
+  source_code_uri: https://github.com/puppetlabs/abide_dev_utils
+  changelog_uri: https://github.com/puppetlabs/abide_dev_utils
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -365,7 +379,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -375,5 +389,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: Helper utilities for developing Abide
+summary: Helper utilities for developing compliance Puppet code
 test_files: []

data/.dockerignore

@@ -1 +0,0 @@
-Gemfile.lock

data/Dockerfile

@@ -1,23 +0,0 @@
-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/lib/abide_dev_utils/xccdf/cis/hiera.rb

@@ -1,166 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-require 'nokogiri'
-require 'abide_dev_utils/errors'
-require 'abide_dev_utils/xccdf/utils'
-
-module AbideDevUtils
-  module XCCDF
-    module CIS
-      # Creates a Hiera structure by parsing a CIS XCCDF benchmark
-      # @!attribute [r] title
-      # @!attribute [r] version
-      # @!attribute [r] yaml_title
-      class Hiera
-        include AbideDevUtils::XCCDF::Utils
-
-        # CONTROL_PREFIX = /^[\d.]+_/.freeze
-        # UNDERSCORED = /(\s|\(|\)|-|\.)/.freeze
-        # XPATHS = {
-        #   benchmark: {
-        #     all: 'xccdf:Benchmark',
-        #     title: 'xccdf:Benchmark/xccdf:title',
-        #     version: 'xccdf:Benchmark/xccdf:version'
-        #   },
-        #   profiles: {
-        #     all: 'xccdf:Benchmark/xccdf:Profile',
-        #     relative_title: './xccdf:title',
-        #     relative_select: './xccdf:select'
-        #   }
-        # }.freeze
-        # NEXT_GEN_WINDOWS = /(next_generation_windows_security)/.freeze
-
-        attr_reader :title, :version
-
-        # Creates a new Hiera object
-        # @param xccdf_file [String] path to an XCCDF file
-        # @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, num: false)
-          @doc = parse(xccdf_file)
-          @title = xpath(CIS_XPATHS[:benchmark][:title]).children.to_s
-          @version = xpath(CIS_XPATHS[:benchmark][:version]).children.to_s
-          @profiles = xpath(CIS_XPATHS[:profiles][:all])
-          @parent_key = make_parent_key(@doc, parent_key_prefix)
-          @hash = make_hash(@doc, number_format: num)
-        end
-
-        def yaml_title
-          normalize_string(@title)
-        end
-
-        # Convert the Hiera object to a hash
-        # @return [Hash]
-        def to_h
-          @hash
-        end
-
-        # Convert the Hiera object to a string
-        # @return [String]
-        def to_s
-          @hash.inspect
-        end
-
-        # Convert the Hiera object to YAML string
-        # @return [String] YAML-formatted string
-        def to_yaml
-          yh = @hash.transform_keys do |k|
-            [@parent_key, k].join('::').strip
-          end
-          yh.to_yaml
-        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
-
-        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, number_format: false)
-          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[title.to_s] = []
-            selects = p.xpath('./xccdf:select')
-            selects.each do |s|
-              hash[title.to_s] << normalize_control_name(s['idref'].to_s, number_format: number_format)
-            end
-          end
-          hash
-        end
-
-        # def normalize_str(str)
-        #   nstr = str.downcase
-        #   nstr.gsub!(/[^a-z0-9]$/, '')
-        #   nstr.gsub!(/^[^a-z]/, '')
-        #   nstr.gsub!(/^(l1_|l2_|ng_)/, '')
-        #   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
-
-        # 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_string(doc.xpath(CIS_XPATHS[:benchmark][:title]).children.to_s)
-          return doc_title if prefix.nil?
-
-          sepped_prefix = prefix.end_with?('::') ? prefix : "#{prefix}::"
-          "#{sepped_prefix.chomp}#{doc_title}"
-        end
-      end
-    end
-  end
-end

data/lib/abide_dev_utils/xccdf/cis.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'abide_dev_utils/xccdf/cis/hiera'

data/lib/abide_dev_utils/xccdf/utils.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-require 'nokogiri'
-require 'abide_dev_utils/validate'
-require 'pry'
-
-module AbideDevUtils
-  module XCCDF
-    module Utils
-      CONTROL_PREFIX = /^[\d.]+_/.freeze
-      UNDERSCORED = /(\s|\(|\)|-|\.)/.freeze
-      CIS_NEXT_GEN_WINDOWS = /(next_generation_windows_security)/.freeze
-      CIS_XPATHS = {
-        benchmark: {
-          all: 'xccdf:Benchmark',
-          title: 'xccdf:Benchmark/xccdf:title',
-          version: 'xccdf:Benchmark/xccdf:version'
-        },
-        profiles: {
-          all: 'xccdf:Benchmark/xccdf:Profile',
-          relative_title: './xccdf:title',
-          relative_select: './xccdf:select'
-        }
-      }.freeze
-
-      def parse(xccdf_file)
-        AbideDevUtils::Validate.file(xccdf_file)
-        File.open(xccdf_file) { |f| Nokogiri::XML(f) }
-      end
-
-      def normalize_string(str)
-        nstr = str.downcase
-        nstr.gsub!(/[^a-z0-9]$/, '')
-        nstr.gsub!(/^[^a-z]/, '')
-        nstr.gsub!(/^(l1_|l2_|ng_)/, '')
-        nstr.delete!('(/|\\|\+)')
-        nstr.gsub!(UNDERSCORED, '_')
-        nstr.strip!
-        nstr
-      end
-
-      def normalize_profile_name(prof)
-        prof_name = normalize_string("profile_#{prof}")
-        prof_name.gsub!(NEXT_GEN_WINDOWS, 'ngws')
-        prof_name.strip!
-        prof_name
-      end
-
-      def normalize_control_name(control, number_format: false)
-        return number_normalize_control(control) if number_format
-
-        name_normalize_control(control)
-      end
-
-      def name_normalize_control(control)
-        new_ctrl = control.split('benchmarks_rule_')[-1].gsub(CONTROL_PREFIX, '')
-        normalize_string(new_ctrl)
-      end
-
-      def number_normalize_control(control)
-        part = control.split('benchmarks_rule_')[-1]
-        numpart = CONTROL_PREFIX.match(part).to_s.chop.gsub(UNDERSCORED, '_')
-        "c#{numpart}"
-      end
-
-      def text_normalize_control(control)
-        control = control['idref'].to_s unless control.respond_to?(:split)
-
-        control.split('benchmarks_rule_')[-1].tr('_', ' ')
-      end
-
-      def all_cis_recommendations(parsed_xccdf)
-        parsed_xccdf.xpath('//xccdf:select').uniq
-      end
-
-      def find_cis_recommendation(name, recommendations, number_format: false)
-        recommendations.each do |reco|
-          if normalize_control_name(reco['idref'].to_s, number_format: number_format) == name
-            return text_normalize_control(reco['idref'].to_s)
-          end
-        end
-      end
-    end
-  end
-end