abide_dev_utils 0.17.2 → 0.18.0

data/lib/abide_dev_utils/{cem → sce}/hiera_data/resource_data.rb

@@ -2,17 +2,17 @@
 
 require 'abide_dev_utils/errors'
 require 'abide_dev_utils/ppt/facter_utils'
-require 'abide_dev_utils/cem/hiera_data/resource_data/control'
-require 'abide_dev_utils/cem/hiera_data/resource_data/resource'
+require 'abide_dev_utils/sce/hiera_data/resource_data/control'
+require 'abide_dev_utils/sce/hiera_data/resource_data/resource'
 
 module AbideDevUtils
-  module CEM
+  module Sce
     module HieraData
       module ResourceData
         # Creates Benchmark objects from a Puppet module
         # @param pupmod [AbideDevUtils::Ppt::PuppetModule] A PuppetModule instance
         # @param skip_errors [Boolean] True skips errors and loads non-erroring benchmarks, false raises the error.
-        # @return [Array<AbideDevUtils::CEM::Benchmark>] Array of Benchmark instances
+        # @return [Array<AbideDevUtils::Sce::Benchmark>] Array of Benchmark instances
         def self.benchmarks_from_puppet_module(pupmod, ignore_all_errors: false, ignore_framework_mismatch: true)
           frameworks = pupmod.hiera_conf.local_hiera_files(hierarchy_name: 'Mapping Data').each_with_object([]) do |hf, ary|
             parts = hf.path.split(pupmod.hiera_conf.default_datadir)[-1].split('/')
@@ -81,7 +81,8 @@ module AbideDevUtils
           end
 
           def mapper
-            @mapper ||= AbideDevUtils::CEM::HieraData::MappingData::Mapper.new(module_name, framework, load_mapping_data)
+            @mapper ||= AbideDevUtils::Sce::HieraData::MappingData::Mapper.new(module_name, framework,
+                                                                               load_mapping_data)
           end
 
           def map_data
@@ -260,18 +261,18 @@ module AbideDevUtils
           def load_mapping_data
             files = case module_name
                     when /_windows$/
-                      cem_windows_mapping_files
+                      sce_windows_mapping_files
                     when /_linux$/
-                      cem_linux_mapping_files
+                      sce_linux_mapping_files
                     else
-                      raise "Module name '#{module_name}' is not a CEM module"
+                      raise "Module name '#{module_name}' is not a SCE module"
                     end
             validate_mapping_files_framework(files).each_with_object({}) do |f, h|
               h[File.basename(f.path, '.yaml')] = YAML.load_file(f.path)
             end
           end
 
-          def cem_linux_mapping_files
+          def sce_linux_mapping_files
             facts = [['os.name', osname], ['os.release.major', major_version]]
             mapping_files = hiera_conf.local_hiera_files_with_facts(*facts, hierarchy_name: 'Mapping Data')
             raise AbideDevUtils::Errors::MappingFilesNotFoundError, facts if mapping_files.nil? || mapping_files.empty?
@@ -279,7 +280,7 @@ module AbideDevUtils
             mapping_files
           end
 
-          def cem_windows_mapping_files
+          def sce_windows_mapping_files
             facts = ['os.release.major', major_version]
             mapping_files = hiera_conf.local_hiera_files_with_fact(facts[0], facts[1], hierarchy_name: 'Mapping Data')
             raise AbideDevUtils::Errors::MappingFilesNotFoundError, facts if mapping_files.nil? || mapping_files.empty?

data/lib/abide_dev_utils/{cem → sce}/hiera_data.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module AbideDevUtils
-  module CEM
+  module Sce
     module HieraData; end
   end
 end

data/lib/abide_dev_utils/{cem → sce}/mapping/mapper.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'abide_dev_utils/cem/hiera_data/mapping_data/map_data'
-require 'abide_dev_utils/cem/hiera_data/mapping_data/mixins'
+require 'abide_dev_utils/sce/hiera_data/mapping_data/map_data'
+require 'abide_dev_utils/sce/hiera_data/mapping_data/mixins'
 
 module AbideDevUtils
-  module CEM
+  module Sce
     module Mapping
       ALL_TYPES = %w[hiera_title_num number hiera_title title vulnid ruleid].freeze
       FRAMEWORK_TYPES = {
         'cis' => %w[hiera_title_num number hiera_title title],
-        'stig' => %w[vulnid ruleid],
+        'stig' => %w[vulnid ruleid]
       }.freeze
       CIS_TYPES = %w[hiera_title_num number hiera_title title].freeze
       STIG_TYPES = %w[vulnid ruleid].freeze
@@ -180,11 +180,11 @@ module AbideDevUtils
         def load_framework(framework)
           case framework.downcase
           when 'cis'
-            self.class.include AbideDevUtils::CEM::Mapping::MixinCIS
-            extend AbideDevUtils::CEM::Mapping::MixinCIS
+            self.class.include AbideDevUtils::Sce::Mapping::MixinCIS
+            extend AbideDevUtils::Sce::Mapping::MixinCIS
           when 'stig'
-            self.class.include AbideDevUtils::CEM::Mapping::MixinSTIG
-            extend AbideDevUtils::CEM::Mapping::MixinSTIG
+            self.class.include AbideDevUtils::Sce::Mapping::MixinSTIG
+            extend AbideDevUtils::Sce::Mapping::MixinSTIG
           else
             raise "Invalid framework: #{framework}"
           end
@@ -192,7 +192,10 @@ module AbideDevUtils
 
         def map_data_by_type(map_type)
           found_map_data = map_data.find { |x| x.type == map_type }
-          raise "Failed to find map data with type #{map_type}; Meta: #{{framework: framework, module_name: module_name}}" unless found_map_data
+          unless found_map_data
+            raise "Failed to find map data with type #{map_type}; Meta: #{{ framework: framework,
+                                                                            module_name: module_name }}"
+          end
 
           found_map_data
         end

data/lib/abide_dev_utils/{cem → sce}/validate/resource_data.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require 'abide_dev_utils/ppt'
-require 'abide_dev_utils/cem/benchmark'
+require 'abide_dev_utils/sce/benchmark'
 
 module AbideDevUtils
-  module CEM
+  module Sce
     module Validate
       # Validation methods for resource data
       module ResourceData
@@ -12,7 +12,7 @@ module AbideDevUtils
 
         def self.controls_without_maps(module_dir = Dir.pwd)
           pupmod = AbideDevUtils::Ppt::PuppetModule.new(module_dir)
-          benchmarks = AbideDevUtils::CEM::Benchmark.benchmarks_from_puppet_module(pupmod)
+          benchmarks = AbideDevUtils::Sce::Benchmark.benchmarks_from_puppet_module(pupmod)
           without_maps = benchmarks.each_with_object({}) do |benchmark, hsh|
             puts "Validating #{benchmark.title}..."
             hsh[benchmark.title] = benchmark.controls.each_with_object([]) do |ctrl, no_maps|

data/lib/abide_dev_utils/{cem → sce}/validate/strings/base_validator.rb

@@ -3,7 +3,7 @@
 require_relative 'validation_finding'
 
 module AbideDevUtils
-  module CEM
+  module Sce
     module Validate
       module Strings
         # Base class for validating Puppet Strings objects. This class can be used directly, but it is

data/lib/abide_dev_utils/{cem → sce}/validate/strings/puppet_class_validator.rb

@@ -4,7 +4,7 @@ require_relative 'base_validator'
 require_relative '../../../validate'
 
 module AbideDevUtils
-  module CEM
+  module Sce
     module Validate
       module Strings
         # Validates a Puppet Class from a Puppet Strings hash
@@ -30,7 +30,7 @@ module AbideDevUtils
             new_finding(
               :error,
               :no_description_or_summary,
-              finding_data(valid_description: valid_desc, valid_summary: valid_summary),
+              finding_data(valid_description: valid_desc, valid_summary: valid_summary)
             )
           end
 
@@ -90,7 +90,8 @@ module AbideDevUtils
             return true if def_val.nil?
 
             if param.types.first.start_with?('Optional[') && def_val != 'undef'
-              new_finding(:error, :param_optional_without_undef_default, param: param.name, default_value: def_val, name: name, file: file)
+              new_finding(:error, :param_optional_without_undef_default, param: param.name, default_value: def_val,
+                                                                         name: name, file: file)
               return false
             end
             true

data/lib/abide_dev_utils/{cem → sce}/validate/strings/puppet_defined_type_validator.rb

@@ -3,7 +3,7 @@
 require_relative 'puppet_class_validator'
 
 module AbideDevUtils
-  module CEM
+  module Sce
     module Validate
       module Strings
         # Validates Puppet Defined Type strings objects

data/lib/abide_dev_utils/{cem → sce}/validate/strings/validation_finding.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module AbideDevUtils
-  module CEM
+  module Sce
     module Validate
       module Strings
         # Represents a validation finding (warning or error)

data/lib/abide_dev_utils/{cem → sce}/validate/strings.rb

@@ -5,7 +5,7 @@ require_relative 'strings/puppet_class_validator'
 require_relative 'strings/puppet_defined_type_validator'
 
 module AbideDevUtils
-  module CEM
+  module Sce
     module Validate
       # Validation objects and methods for Puppet Strings
       module Strings
@@ -62,7 +62,7 @@ module AbideDevUtils
               file: item.file,
               line: item.line,
               errors: item.errors,
-              warnings: item.warnings,
+              warnings: item.warnings
             }
           end
 

data/lib/abide_dev_utils/{cem → sce}/validate.rb

@@ -4,8 +4,8 @@ require_relative 'validate/resource_data'
 require_relative 'validate/strings'
 
 module AbideDevUtils
-  module CEM
-    # Namespace for CEM validation modules / classes
+  module Sce
+    # Namespace for SCE validation modules / classes
     module Validate; end
   end
 end

data/lib/abide_dev_utils/{cem.rb → sce.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require 'abide_dev_utils/xccdf'
-require 'abide_dev_utils/cem/generate'
-require 'abide_dev_utils/cem/validate'
+require 'abide_dev_utils/sce/generate'
+require 'abide_dev_utils/sce/validate'
 
 module AbideDevUtils
-  # Methods for working with Compliance Enforcement Modules (CEM)
-  module CEM
+  # Methods for working with Security Compliance Enforcement (SCE) modules
+  module Sce
     def self.xccdf
       return @xccdf if defined?(@xccdf)
 
@@ -33,7 +33,7 @@ module AbideDevUtils
       {
         number: xccdf.control_parts(rule_id).first,
         hiera_title: xccdf.name_normalize_control(rule_id),
-        hiera_title_num: xccdf.number_normalize_control(rule_id),
+        hiera_title_num: xccdf.number_normalize_control(rule_id)
       }
     end
 
@@ -62,7 +62,7 @@ module AbideDevUtils
           change_report << {
             type: :identifier_update,
             from: key,
-            to: new_key,
+            to: new_key
           }
         end
         new_control_configs[key] = val_hash unless changed

data/lib/abide_dev_utils/version.rb

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

data/lib/abide_dev_utils/xccdf.rb

@@ -10,13 +10,11 @@ require 'abide_dev_utils/output'
 module AbideDevUtils
   # Contains modules and classes for working with XCCDF files
   module XCCDF
-    # Generate map for CEM
+    # Generate map for SCE
     def self.gen_map(xccdf_file, **opts)
       type = opts.fetch(:type, 'cis')
       case type.downcase
-      when 'cis'
-        Benchmark.new(xccdf_file).gen_map(**opts)
-      when 'stig'
+      when /cis|stig/
         Benchmark.new(xccdf_file).gen_map(**opts)
       else
         raise AbideDevUtils::Errors::UnsupportedXCCDFError, "XCCDF type #{type} is unsupported!"
@@ -144,12 +142,11 @@ module AbideDevUtils
           # STIG control
           vuln_id = mdata[4]
           group = @benchmark.xpath("Group[@id='#{vuln_id}']")
-          if group.xpath('Rule').length != 1
-            raise AbideDevUtils::Errors::ControlPartsError, control
-          end
+          raise AbideDevUtils::Errors::ControlPartsError, control if group.xpath('Rule').length != 1
+
           rule_id = group.xpath('Rule/@id').first.value
           title = group.xpath('Rule/title').text
-          return [vuln_id, rule_id, title]
+          [vuln_id, rule_id, title]
         else
           raise AbideDevUtils::Errors::ControlPartsError, control
         end
@@ -263,7 +260,9 @@ module AbideDevUtils
       def map_indexed(indicies: [], index: 'title', framework: 'cis', key_prefix: '')
         c_map = profiles.each_with_object({}) do |profile, obj|
           obj[profile.level.downcase] = {} unless obj[profile.level.downcase].is_a?(Hash)
-          obj[profile.level.downcase][profile.title.downcase] = map_controls_hash(profile, indicies, index).sort_by { |k, _| k }.to_h
+          obj[profile.level.downcase][profile.title.downcase] = map_controls_hash(profile, indicies, index).sort_by do |k, _|
+            k
+          end.to_h
         end
 
         c_map['benchmark'] = { 'title' => title, 'version' => version }
@@ -423,7 +422,8 @@ module AbideDevUtils
         elsif title.include?(CIS_TITLE_MARKER)
           return :cis
         end
-        raise AbideDevUtils::Errors::UnsupportedXCCDFError, "XCCDF type is unsupported!"
+
+        raise AbideDevUtils::Errors::UnsupportedXCCDFError, 'XCCDF type is unsupported!'
       end
     end
 

data/lib/abide_dev_utils.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require 'abide_dev_utils/version'
-require 'abide_dev_utils/xccdf'
-require 'abide_dev_utils/ppt'
-require 'abide_dev_utils/jira'
-require 'abide_dev_utils/config'
-require 'abide_dev_utils/comply'
+require_relative 'abide_dev_utils/version'
+require_relative 'abide_dev_utils/xccdf'
+require_relative 'abide_dev_utils/ppt'
+require_relative 'abide_dev_utils/jira'
+require_relative 'abide_dev_utils/config'
+require_relative 'abide_dev_utils/comply'
+require_relative 'abide_dev_utils/sce'
 
 # Root namespace all modules / classes
 module AbideDevUtils; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.18.0
 platform: ruby
 authors:
 - abide-team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-29 00:00:00.000000000 Z
+date: 2024-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: metadata-json-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -341,6 +355,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yaml"
 - ".github/workflows/mend_ruby.yaml"
 - ".gitignore"
 - ".rspec"
@@ -359,33 +374,12 @@ files:
 - bin/setup
 - exe/abide
 - lib/abide_dev_utils.rb
-- lib/abide_dev_utils/cem.rb
-- lib/abide_dev_utils/cem/benchmark.rb
-- lib/abide_dev_utils/cem/generate.rb
-- lib/abide_dev_utils/cem/generate/coverage_report.rb
-- lib/abide_dev_utils/cem/generate/reference.rb
-- lib/abide_dev_utils/cem/hiera_data.rb
-- lib/abide_dev_utils/cem/hiera_data/mapping_data.rb
-- lib/abide_dev_utils/cem/hiera_data/mapping_data/map_data.rb
-- lib/abide_dev_utils/cem/hiera_data/mapping_data/mixins.rb
-- lib/abide_dev_utils/cem/hiera_data/resource_data.rb
-- lib/abide_dev_utils/cem/hiera_data/resource_data/control.rb
-- lib/abide_dev_utils/cem/hiera_data/resource_data/parameters.rb
-- lib/abide_dev_utils/cem/hiera_data/resource_data/resource.rb
-- lib/abide_dev_utils/cem/mapping/mapper.rb
-- lib/abide_dev_utils/cem/validate.rb
-- lib/abide_dev_utils/cem/validate/resource_data.rb
-- lib/abide_dev_utils/cem/validate/strings.rb
-- lib/abide_dev_utils/cem/validate/strings/base_validator.rb
-- lib/abide_dev_utils/cem/validate/strings/puppet_class_validator.rb
-- lib/abide_dev_utils/cem/validate/strings/puppet_defined_type_validator.rb
-- lib/abide_dev_utils/cem/validate/strings/validation_finding.rb
 - lib/abide_dev_utils/cli.rb
 - lib/abide_dev_utils/cli/abstract.rb
-- lib/abide_dev_utils/cli/cem.rb
 - lib/abide_dev_utils/cli/comply.rb
 - lib/abide_dev_utils/cli/jira.rb
 - lib/abide_dev_utils/cli/puppet.rb
+- lib/abide_dev_utils/cli/sce.rb
 - lib/abide_dev_utils/cli/test.rb
 - lib/abide_dev_utils/cli/xccdf.rb
 - lib/abide_dev_utils/comply.rb
@@ -394,12 +388,12 @@ files:
 - lib/abide_dev_utils/dot_number_comparable.rb
 - lib/abide_dev_utils/errors.rb
 - lib/abide_dev_utils/errors/base.rb
-- lib/abide_dev_utils/errors/cem.rb
 - lib/abide_dev_utils/errors/comply.rb
 - lib/abide_dev_utils/errors/gcloud.rb
 - lib/abide_dev_utils/errors/general.rb
 - lib/abide_dev_utils/errors/jira.rb
 - lib/abide_dev_utils/errors/ppt.rb
+- lib/abide_dev_utils/errors/sce.rb
 - lib/abide_dev_utils/errors/xccdf.rb
 - lib/abide_dev_utils/files.rb
 - lib/abide_dev_utils/gcloud.rb
@@ -436,6 +430,27 @@ files:
 - lib/abide_dev_utils/prompt.rb
 - lib/abide_dev_utils/puppet_strings.rb
 - lib/abide_dev_utils/resources/generic_spec.erb
+- lib/abide_dev_utils/sce.rb
+- lib/abide_dev_utils/sce/benchmark.rb
+- lib/abide_dev_utils/sce/generate.rb
+- lib/abide_dev_utils/sce/generate/coverage_report.rb
+- lib/abide_dev_utils/sce/generate/reference.rb
+- lib/abide_dev_utils/sce/hiera_data.rb
+- lib/abide_dev_utils/sce/hiera_data/mapping_data.rb
+- lib/abide_dev_utils/sce/hiera_data/mapping_data/map_data.rb
+- lib/abide_dev_utils/sce/hiera_data/mapping_data/mixins.rb
+- lib/abide_dev_utils/sce/hiera_data/resource_data.rb
+- lib/abide_dev_utils/sce/hiera_data/resource_data/control.rb
+- lib/abide_dev_utils/sce/hiera_data/resource_data/parameters.rb
+- lib/abide_dev_utils/sce/hiera_data/resource_data/resource.rb
+- lib/abide_dev_utils/sce/mapping/mapper.rb
+- lib/abide_dev_utils/sce/validate.rb
+- lib/abide_dev_utils/sce/validate/resource_data.rb
+- lib/abide_dev_utils/sce/validate/strings.rb
+- lib/abide_dev_utils/sce/validate/strings/base_validator.rb
+- lib/abide_dev_utils/sce/validate/strings/puppet_class_validator.rb
+- lib/abide_dev_utils/sce/validate/strings/puppet_defined_type_validator.rb
+- lib/abide_dev_utils/sce/validate/strings/validation_finding.rb
 - lib/abide_dev_utils/validate.rb
 - lib/abide_dev_utils/version.rb
 - lib/abide_dev_utils/xccdf.rb
@@ -454,6 +469,7 @@ metadata:
   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
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -469,7 +485,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Helper utilities for developing compliance Puppet code

data/lib/abide_dev_utils/cem/generate.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'abide_dev_utils/cem/generate/reference'
-require 'abide_dev_utils/cem/generate/coverage_report'
-
-module AbideDevUtils
-  module CEM
-    # Namespace for objects and methods used in `abide cem generate` subcommands
-    module Generate; end
-  end
-end