compliance_engine 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca4c111afd1a2840ec2a266bea8e12f195a9cc8c262eef7676280382b63868b5
-  data.tar.gz: a59bc32c198332f65882d2a3950cfa2a89c8f48d0da58bf93d77d9e2cc555427
+  metadata.gz: f5129c30257114df1399ae314ff6a0fb5d383de5bd4782b8b31dc060ea274870
+  data.tar.gz: 8dfaa1d2feaf1a43ea6551851eac5a586f2d4e2b4148efcd14cad21c32c93cba
 SHA512:
-  metadata.gz: 6503e8068deaec3d98bb6783689ae599fa149b3fe2299f1e101ca23f46488db680f4685f36a7670f68c3480977ce9ed539c96d0bb5b6df0f952ea5267d3ed935
-  data.tar.gz: 0a0afadab618fa6d86fece7ebb270342e59b788d84b8e321f97c053758a8d0e2b7e68127ccaf4228e2ba65978566fd6ff3bec05b137f829e58ebfc15314b937e
+  metadata.gz: b4839e2648adfc6c1ea91d16c45a5494a6ad4da6521d816e16b9d0b3127b80d696d6f0cbb5249294cf6e0f21177809fbe9b8efd6c3665e3aae1bee6a02570134
+  data.tar.gz: 68a0a04f93e3c007eec4287a92d6d19ace0ba37e9a739200474802ef28c6cb24b01257cec5e23f8b8e2cb8f29cf397641ac1e2fc5a1c117ca1db43f1932c2c3d

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.4.0 / 2026-04-20
+* Route Puppet Hiera backend log messages through Puppet's logging system (#96)
+* Fix JRuby compatibility: convert internal requires to require_relative so the library loads correctly inside Puppet Server / OpenVox Server when installed as a Puppet module rather than a standalone gem
+* Replace PDK with puppet-modulebuilder for Puppet Forge builds
+* Add Beaker acceptance test suite covering puppet apply, server/agent, cache leakage, and environment leakage scenarios
+
 ### 0.3.0 / 2026-03-19
 * Hash-like Collection methods return Collection objects (#37)
 

data/compliance_engine.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'deep_merge', '~> 1.2'
-  spec.add_dependency 'irb', '~> 1.14'
+  spec.add_dependency 'irb', '~> 1.14' unless RUBY_PLATFORM == 'java'
   spec.add_dependency 'logger', '~> 1.4'
   spec.add_dependency 'observer', '~> 0.1'
   spec.add_dependency 'rubyzip', '>= 2.3', '< 4'

data/lib/compliance_engine/ce.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
+require_relative '../compliance_engine'
 
 # A compliance engine data CE
 class ComplianceEngine::Ce < ComplianceEngine::Component

data/lib/compliance_engine/ces.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
+require_relative '../compliance_engine'
 
 # A collection of compliance engine data CEs
 class ComplianceEngine::Ces < ComplianceEngine::Collection

data/lib/compliance_engine/check.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
+require_relative '../compliance_engine'
 
 # A compliance engine data check
 class ComplianceEngine::Check < ComplianceEngine::Component

data/lib/compliance_engine/checks.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
+require_relative '../compliance_engine'
 
 # A collection of compliance engine data checks
 class ComplianceEngine::Checks < ComplianceEngine::Collection

data/lib/compliance_engine/cli.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
+require_relative '../compliance_engine'
 require 'thor'
 
 # Compliance Engine CLI

data/lib/compliance_engine/collection.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
+require_relative '../compliance_engine'
 
 # A generic compliance engine data collection
 class ComplianceEngine::Collection

data/lib/compliance_engine/component.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
+require_relative '../compliance_engine'
 require 'deep_merge'
 
 # A generic compliance engine data component
@@ -216,14 +216,14 @@ class ComplianceEngine::Component
 
     if fragment['remediation'].key?('disabled')
       message = "Remediation disabled for #{fragment}"
-      reason = fragment['remediation']['disabled']&.map { |value| value['reason'] }&.reject(&:nil?)&.join("\n")
+      reason = fragment['remediation']['disabled']&.map { |value| value['reason'] }&.compact&.join("\n")
       message += "\n#{reason}" unless reason.nil?
       ComplianceEngine.log.info message
       return true
     end
 
     if fragment['remediation'].key?('risk')
-      risk_level = fragment['remediation']['risk']&.map { |value| value['level'] }&.select { |value| value.is_a?(Integer) }&.max
+      risk_level = fragment['remediation']['risk']&.map { |value| value['level'] }&.grep(Integer)&.max
       if risk_level.is_a?(Integer) && risk_level >= enforcement_tolerance
         ComplianceEngine.log.info "Remediation risk #{risk_level} exceeds enforcement enforcement_tolerance #{enforcement_tolerance} for #{fragment}"
         return true

data/lib/compliance_engine/control.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
+require_relative '../compliance_engine'
 
 # A compliance engine data control
 class ComplianceEngine::Control < ComplianceEngine::Component

data/lib/compliance_engine/controls.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
+require_relative '../compliance_engine'
 
 # A collection of compliance engine data controls
 class ComplianceEngine::Controls < ComplianceEngine::Collection

data/lib/compliance_engine/data.rb

@@ -1,23 +1,23 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
-require 'compliance_engine/version'
-require 'compliance_engine/component'
-require 'compliance_engine/ce'
-require 'compliance_engine/check'
-require 'compliance_engine/control'
-require 'compliance_engine/profile'
-require 'compliance_engine/collection'
-require 'compliance_engine/ces'
-require 'compliance_engine/checks'
-require 'compliance_engine/controls'
-require 'compliance_engine/profiles'
-
-require 'compliance_engine/data_loader'
-require 'compliance_engine/data_loader/json'
-require 'compliance_engine/data_loader/yaml'
-require 'compliance_engine/module_loader'
-require 'compliance_engine/environment_loader'
+require_relative '../compliance_engine'
+require_relative 'version'
+require_relative 'component'
+require_relative 'ce'
+require_relative 'check'
+require_relative 'control'
+require_relative 'profile'
+require_relative 'collection'
+require_relative 'ces'
+require_relative 'checks'
+require_relative 'controls'
+require_relative 'profiles'
+
+require_relative 'data_loader'
+require_relative 'data_loader/json'
+require_relative 'data_loader/yaml'
+require_relative 'module_loader'
+require_relative 'environment_loader'
 
 require 'deep_merge'
 require 'json'

data/lib/compliance_engine/data_loader/file.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
-require 'compliance_engine/data_loader'
+require_relative '../../compliance_engine'
+require_relative '../data_loader'
 
 # Load compliance engine data from a file
 class ComplianceEngine::DataLoader::File < ComplianceEngine::DataLoader

data/lib/compliance_engine/data_loader/json.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
-require 'compliance_engine/data_loader/file'
+require_relative '../../compliance_engine'
+require_relative 'file'
 
 require 'json'
 

data/lib/compliance_engine/data_loader/yaml.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
-require 'compliance_engine/data_loader/file'
+require_relative '../../compliance_engine'
+require_relative 'file'
 
 require 'yaml'
 

data/lib/compliance_engine/data_loader.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
+require_relative '../compliance_engine'
 require 'observer'
 
 # Load compliance engine data

data/lib/compliance_engine/environment_loader/zip.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
-require 'compliance_engine/environment_loader'
+require_relative '../../compliance_engine'
+require_relative '../environment_loader'
 require 'zip/filesystem'
 
 # Load compliance engine data from a zip file containing a Puppet environment

data/lib/compliance_engine/environment_loader.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
-require 'compliance_engine/module_loader'
+require_relative '../compliance_engine'
+require_relative 'module_loader'
 
 # Load compliance engine data from a Puppet environment
 class ComplianceEngine::EnvironmentLoader

data/lib/compliance_engine/module_loader.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
-require 'compliance_engine/data_loader/json'
-require 'compliance_engine/data_loader/yaml'
+require_relative '../compliance_engine'
+require_relative 'data_loader/json'
+require_relative 'data_loader/yaml'
 
 # Load compliance engine data from a Puppet module
 class ComplianceEngine::ModuleLoader

data/lib/compliance_engine/profile.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
+require_relative '../compliance_engine'
 
 # A compliance engine data profile
 class ComplianceEngine::Profile < ComplianceEngine::Component

data/lib/compliance_engine/profiles.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'compliance_engine'
+require_relative '../compliance_engine'
 
 # A collection of compliance engine data profiles
 class ComplianceEngine::Profiles < ComplianceEngine::Collection

data/lib/compliance_engine/puppet_logger.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ComplianceEngine
+  # Routes ComplianceEngine log messages through Puppet's logging system.
+  # Used as a drop-in replacement for the default Logger when running inside Puppet.
+  class PuppetLogger
+    def initialize(*_args, **_kwargs)
+      ensure_puppet_available!
+    end
+
+    def debug(msg)
+      ensure_puppet_available!
+      ::Puppet.debug(msg)
+    end
+
+    def info(msg)
+      ensure_puppet_available!
+      ::Puppet.info(msg)
+    end
+
+    def warn(msg)
+      ensure_puppet_available!
+      ::Puppet.warning(msg)
+    end
+
+    def error(msg)
+      ensure_puppet_available!
+      ::Puppet.err(msg)
+    end
+
+    def fatal(msg)
+      ensure_puppet_available!
+      ::Puppet.crit(msg)
+    end
+
+    def level; end
+
+    def level=(_val); end
+
+    private
+
+    def ensure_puppet_available!
+      return if defined?(::Puppet)
+
+      raise ComplianceEngine::Error,
+            'ComplianceEngine::PuppetLogger requires Puppet to be loaded, but ::Puppet is not defined'
+    end
+  end
+end

data/lib/compliance_engine/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ComplianceEngine
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 
   # Handle supported compliance data versions
   class Version

data/lib/compliance_engine.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'compliance_engine/version'
-require 'compliance_engine/data'
+require_relative 'compliance_engine/version'
+require_relative 'compliance_engine/data'
 require 'logger'
 
 # Work with compliance data
@@ -26,7 +26,7 @@ module ComplianceEngine
 
   # Get the logger
   #
-  # @return [Logger]
+  # @return [Logger, ComplianceEngine::PuppetLogger]
   def self.log
     return @log unless @log.nil?
 
@@ -36,8 +36,20 @@ module ComplianceEngine
   end
 
   # Set the logger
-  # @param logger [Logger] The logger to use
+  #
+  # @param value [Logger, ComplianceEngine::PuppetLogger] The logger to use
   def self.log=(value)
     @log = value
   end
+
+  # Install a PuppetLogger unless a logger has already been explicitly configured.
+  # Extracted so the behaviour can be unit-tested without reloading enforcement.rb.
+  #
+  # @return [void]
+  def self.install_puppet_logger
+    return unless @log.nil?
+
+    require_relative 'compliance_engine/puppet_logger'
+    @log = PuppetLogger.new
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compliance_engine
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Steven Pritchard
@@ -147,6 +147,7 @@ files:
 - lib/compliance_engine/module_loader.rb
 - lib/compliance_engine/profile.rb
 - lib/compliance_engine/profiles.rb
+- lib/compliance_engine/puppet_logger.rb
 - lib/compliance_engine/version.rb
 homepage: https://simp-project.com/docs/sce/
 licenses:
@@ -154,7 +155,7 @@ licenses:
 metadata:
   homepage_uri: https://simp-project.com/docs/sce/
   source_code_uri: https://github.com/simp/rubygem-simp-compliance_engine
-  changelog_uri: https://github.com/simp/rubygem-simp-compliance_engine/releases/tag/0.3.0
+  changelog_uri: https://github.com/simp/rubygem-simp-compliance_engine/releases/tag/0.4.0
   bug_tracker_uri: https://github.com/simp/rubygem-simp-compliance_engine/issues
 rdoc_options: []
 require_paths: