cem_acpt 0.2.8-universal-java-17 → 0.2.9-universal-java-17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bf596ee67704455f907b1d68959a733bf938051108534dad444942de893e3cf
-  data.tar.gz: 9d47ed4ca9975d124d2550e51bcf00c945ad5f10b21c8fb8205f27365bd7f76b
+  metadata.gz: d4181b3fae3e4d3f0029314896873f2f604374cc4583473b0b05e689464d346f
+  data.tar.gz: 5e01be5d223962785a18e685f17cc1c3cd393f705cd2b5df174327a8631e1598
 SHA512:
-  metadata.gz: 16bdac45fb5384f85863967f64fa927a5bd610b483d6eab4f87cf45c55117cbe7fda818259f8b42fda621d9118bb46b8099fa7c7f5cd52a12d567691f729cc39
-  data.tar.gz: a3957f255f0643f6102df4c32628d21ebfe6f51d7cba25a122be80b48e5288a2569830f1a0995298db082a4bb79e64570af9de1617c3e2ed4f812a83c33f8a02
+  metadata.gz: e9dc631cf11d32f85405358a8bc4e8501afc290a15ed68e80688472de838cfdd81cf09e9a10d346f396de6f1c2505188c443c60e0d4b106b346fd77f079c311c
+  data.tar.gz: 7866ca7c6272369e15c2fbf3f2dd69ce6d6caf6d059b08ad686e7b2fcaf5d63d5d093dbfac076c4c68f3ac7c07f4bcacc2bcd01107667531e069821c00e90313

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cem_acpt (0.2.8-universal-java-17)
+    cem_acpt (0.2.9-universal-java-17)
       concurrent-ruby (>= 1.1, < 2.0)
       deep_merge (>= 1.2, < 2.0)
       ed25519 (>= 1.2, < 2.0)

data/lib/cem_acpt/rspec_utils.rb

@@ -12,13 +12,17 @@ module CemAcpt
     class BundlerNotFoundError < StandardError; end
     class RSpecNotFoundError < StandardError; end
 
-    # Holds and formats a RSpec command
-    class Command
-      include CemAcpt::LoggingAsync
-      attr_reader :debug, :format, :test_path, :use_bundler, :pty_pid
+    # Holds RSpec options used by Command
+    class Options
+      OPTIONS = %i[test_path bundle rspec use_bundler bundle_install format debug quiet env].freeze
 
+      attr_accessor(*OPTIONS)
+
+      # @param config [CemAcpt::Config] A config object
       # @param opts [Hash] options hash for the RSpec command
       # @option opts [String] :test_path The path (or glob path) to the test file(s) to run. If blank, runs all.
+      # @option opts [String] :bundle The path to the `bundle` binary.
+      # @option opts [String] :rspec The path to the `rspec` binary.
       # @option opts [Hash] :format Format options for rspec where the key is the format (documentation, json, etc)
       #   and the value is the out-file path. If you do not want to save the results of a format to a file, the
       #   value should be `nil`.
@@ -30,56 +34,97 @@ module CemAcpt
       #   Default is `true`.
       # @option opts [Boolean] :bundle_install Whether or not to run `bundle install` before the RSpec command
       #   if `use_bundler` is `true`.
-      # @option opts [Boolean] :use_shell Whether or not to add `$SHELL` as a prefix to the command
       # @option opts [Hash] :env Environment variables to prepend to the command
-      def initialize(opts = {})
-        @test_path = opts[:test_path]&.shellescape
-        @format = opts.fetch(:format, {})
-        @debug = opts.fetch(:debug, false)
-        @quiet = @debug ? false : opts.fetch(:quiet, false)
-        @use_bundler = opts.fetch(:use_bundler, false)
-        @bundle_install = opts.fetch(:bundle_install, false)
-        @env = opts.fetch(:env, {})
-        @pty_pid = nil
-        validate_and_set_bin_paths(opts)
+      def initialize(config, **opts)
+        @config = config
+        @opts = opts
+        define_option_instance_vars
+      end
+
+      # Finds and sets the paths to the `bundle` and `rspec` binaries. The paths can
+      # be either passed in as options in the `opts` Hash or interrogated from the
+      # system.
+      # @raise [CemAcpt::RSpecUtils::BundlerNotFoundError] if `@use_bundler` is true and
+      #   `bundle` binary is not found.
+      # @raise [CemAcpt::RSpecUtils::RSpecNotFoundError] if `rspec` binary is not found.
+      def resolve_bin_paths
+        %i[bundle rspec].each do |bin|
+          bin_path = instance_variable_get("@#{bin}") || `#{ENV['SHELL']} -c 'command -v #{bin}'`.strip
+          bin_not_found(bin, bin_path) unless bin_path && File.exist?(bin_path)
+          instance_variable_set("@#{bin}", bin_path)
+        end
+      end
+
+      # Detects if the current Ruby context is JRuby
+      def jruby?
+        Object.const_defined?('JRUBY_VERSION')
       end
 
-      # Sets debug mode to `true`
-      def set_debug
-        @debug = true
-        if @quiet
-          async_debug('Setting :quiet to false because :debug is now true.')
-          @quiet = false
+      private
+
+      def defaults
+        @defaults ||= { use_bundler: false,
+                        bundle_install: false,
+                        format: { documentation: nil },
+                        debug: false,
+                        quiet: false,
+                        env: {} }
+      end
+
+      def define_option_instance_vars
+        OPTIONS.each do |o|
+          val = @config.get("rspec.#{o}") || @opts[o] || defaults[o] || nil
+          instance_variable_set("@#{o}", val)
         end
       end
 
-      # Sets debug mode to `false`
-      def unset_debug
-        @debug = false
+      # Handles binary paths which are not found
+      # @param bin [Symbol] The binary that was not found, either :bundle or :rspec.
+      # @param bin_path [String] The path to the binary that was checked.
+      # @raise [CemAcpt::RSpecUtils::BundlerNotFoundError] if `@use_bundler` is true and
+      #   `bundle` binary is not found.
+      # @raise [CemAcpt::RSpecUtils::RSpecNotFoundError] if `rspec` binary is not found.
+      # @raise [RuntimeError] if `bin` is not :bundle or :rspec.
+      def bin_not_found(bin, bin_path)
+        msg_base = "#{bin} not found."
+        msg = bin_path.nil? ? "#{msg_base} Path is nil." : "#{msg_base} Path: #{bin_path}"
+        case bin
+        when :bundle
+          raise BundlerNotFoundError, msg if opts.use_bundler
+        when :rspec
+          raise RSpecNotFoundError, msg
+        else
+          raise "bin #{bin} not recognized!"
+        end
       end
+    end
+
+    # Holds and formats a RSpec command
+    class Command
+      include CemAcpt::LoggingAsync
+      attr_reader :opts, :pty_pid
+
+      def initialize(opts = Options.new)
+        raise 'opts must be instance of CemAcpt::RSpecUtils::Options' unless opts.is_a?(CemAcpt::RSpecUtils::Options)
 
-      def quiet
-        @quiet && !debug
+        @opts = opts
+        @opts.resolve_bin_paths
+        @opts.env = @opts.env.merge({ 'RSPEC_DEBUG' => 'true' }) if @opts.debug
+        @pty_pid = nil
       end
 
       # Adds a new format to the RSpec command
       # @param fmt [String] The name of the format (i.e. "documentation", "json", etc.)
       # @param out [String] If specified, saves the specified format to a file at this path
       def with_format(fmt, out: nil)
-        @format[fmt.to_sym] = out
-      end
-
-      # Environment variables that will be used for the RSpec command
-      # @return [Hash] A Hash of environment variables with each key pair being: <var name> => <var value>
-      def env
-        @debug ? @env.merge({ 'RSPEC_DEBUG' => 'true' }) : @env
+        opts.format[fmt.to_sym] = out
       end
 
       # Returns an array representation of the RSpec command
       def to_a
         cmd = cmd_base.dup
-        cmd << test_path if test_path
-        format.each do |fmt, out|
+        cmd << opts.test_path if opts.test_path
+        opts.format.each do |fmt, out|
           cmd += ['--format', fmt.to_s.shellescape]
           cmd += ['--out', out.to_s.shellescape] if out
         end
@@ -112,12 +157,12 @@ module CemAcpt
       # @return [Integer] The exit code of the RSpec command
       def execute_pty(log_prefix: 'RSPEC')
         async_debug("Executing RSpec command '#{self}' in PTY...", log_prefix)
-        PTY.spawn(env, ENV['SHELL']) do |r, w, pid|
+        PTY.spawn(opts.env, ENV['SHELL']) do |r, w, pid|
           @pty_pid = pid
           async_debug("Spawned RSpec PTY with PID #{@pty_pid}", log_prefix)
           export_envs(w)
           w.puts "#{self}; exit $?"
-          quiet ? wait_io(r) : read_io(r, log_prefix: log_prefix)
+          handle_io(r, log_prefix: log_prefix)
         end
         $CHILD_STATUS
       end
@@ -130,9 +175,9 @@ module CemAcpt
       def execute_no_pty(log_prefix: 'RSPEC')
         async_info("Executing RSpec command '#{self}' with Open3.popen2e()...", log_prefix)
         exit_status = nil
-        Open3.popen2e(env, to_s) do |stdin, std_out_err, wait_thr|
+        Open3.popen2e(opts.env, to_s) do |stdin, std_out_err, wait_thr|
           stdin.close
-          quiet ? wait_io(std_out_err) : read_io(std_out_err, log_prefix: log_prefix)
+          handle_io(std_out_err, log_prefix: log_prefix)
           exit_status = wait_thr.value
         end
         exit_status
@@ -147,26 +192,21 @@ module CemAcpt
 
       private
 
-      # Detects if the current Ruby context is JRuby
-      def jruby?
-        File.basename(RbConfig.ruby) == 'jruby'
-      end
-
       # The base RSpec command
       def cmd_base
-        use_bundler ? cmd_base_bundler : cmd_base_rspec
+        opts.use_bundler ? cmd_base_bundler : cmd_base_rspec
       end
 
       # The base RSpec command if `:use_bundler` is `true`.
       def cmd_base_bundler
-        base = [@bundle, 'exec', 'rspec']
-        base.unshift("#{@bundle} install;") if @bundle_install
+        base = [opts.bundle, 'exec', 'rspec']
+        base.unshift("#{opts.bundle} install;") if opts.bundle_install
         base
       end
 
       # The base RSpec command if `:use_bundler` is `false`
       def cmd_base_rspec
-        [@rspec]
+        [opts.rspec]
       end
 
       # Puts export statements for each key-value pair in `env` to the given writer.
@@ -174,46 +214,14 @@ module CemAcpt
       # pass the statements to a shell.
       # @param writer [IO] An IO object that supprts `puts` and can send statements to a shell
       def export_envs(writer)
-        env.each do |key, val|
+        @opts.env.each do |key, val|
           writer.puts "export #{key}=#{val}"
         end
       end
 
-      # Finds and sets the paths to the `bundle` and `rspec` binaries. The paths can
-      # be either passed in as options in the `opts` Hash or interrogated from the
-      # system.
-      # @param opts [Hash] The options hash
-      # @option opts [String] :bundle An absolute path on the system to the `bundle` binary.
-      # @option opts [String] :rspec An absolute path on the system to the `rspec` binary.
-      # @raise [CemAcpt::RSpecUtils::BundlerNotFoundError] if `@use_bundler` is true and
-      #   `bundle` binary is not found.
-      # @raise [CemAcpt::RSpecUtils::RSpecNotFoundError] if `rspec` binary is not found.
-      def validate_and_set_bin_paths(opts = {})
-        %i[bundle rspec].each do |bin|
-          bin_path = opts[bin] || `command -v #{bin}`.strip
-          bin_not_found(bin, bin_path) unless bin_path && File.exist?(bin_path)
-          instance_variable_set("@#{bin}", bin_path)
-        end
-      end
-
-      # Handles binary paths which are not found
-      # @param bin [Symbol] The binary that was not found, either :bundle or :rspec.
-      # @param bin_path [String] The path to the binary that was checked.
-      # @raise [CemAcpt::RSpecUtils::BundlerNotFoundError] if `@use_bundler` is true and
-      #   `bundle` binary is not found.
-      # @raise [CemAcpt::RSpecUtils::RSpecNotFoundError] if `rspec` binary is not found.
-      # @raise [RuntimeError] if `bin` is not :bundle or :rspec.
-      def bin_not_found(bin, bin_path)
-        msg_base = "#{bin} not found."
-        msg = bin_path.nil? ? "#{msg_base} Path is nil." : "#{msg_base} Path: #{bin_path}"
-        case bin
-        when :bundle
-          raise BundlerNotFoundError, msg if @use_bundler
-        when :rspec
-          raise RSpecNotFoundError, msg
-        else
-          raise "bin #{bin} not recognized!"
-        end
+      # Handles IO output
+      def handle_io(io_stream, **kwargs)
+        opts.quiet ? wait_io(io_stream) : read_io(io_stream, log_prefix: kwargs[:log_prefix])
       end
 
       # Blocking wait on an IO stream. Wait stops once the IO stream has reached

data/lib/cem_acpt/test_runner/runner.rb

@@ -145,12 +145,12 @@ module CemAcpt
         async_info("Running test #{@node.test_data[:test_name]} on node #{@node.node_name}...", log_prefix('RSPEC'))
         @node.run_tests do |cmd_env|
           cmd_opts = rspec_opts
-          cmd_opts[:env].merge!(cmd_env) if cmd_env
+          cmd_opts.env = cmd_opts.env.merge(cmd_env) if cmd_env
           # Documentation format gets logged in real time, JSON file is read after the fact
           begin
             @rspec_cmd = CemAcpt::RSpecUtils::Command.new(cmd_opts)
-            @rspec_cmd.execute(log_prefix: log_prefix('RSPEC'))
-            @run_result.from_json_file(cmd_opts[:format][:json])
+            @rspec_cmd.execute(pty: false, log_prefix: log_prefix('RSPEC'))
+            @run_result.from_json_file(cmd_opts.format[:json])
           rescue Errno::EIO => e
             async_error("failed to run rspec: #{@node.test_data[:test_name]}: #{$ERROR_INFO}", log_prefix('RSPEC'))
             @run_result.from_error(e)
@@ -191,19 +191,21 @@ module CemAcpt
 
       # Options used with RSpec
       def rspec_opts
-        opts = {
-          test_path: @node.test_data[:test_file],
-          use_bundler: @context.config.get('rspec.use_bundler') || false,
-          bundle_install: @context.config.get('rspec.bundle_install') || false,
-          format: @context.config.get('rspec.format') || { json: "results_#{@node.test_data[:test_name]}.json" },
-          debug: (@debug_mode && @context.config.get('verbose')),
-          quiet: @context.config.get('quiet'),
-          env: {
-            'TARGET_HOST' => @node.node_name,
-          }
-        }
-        opts[:format][:documentation] = nil unless @context.config.get('verbose') || @context.config.get('rspec.format')
-        opts
+        opts_test_path = @node.test_data[:test_file]
+        opts_env = { 'TARGET_HOST' => @node.node_name }
+        opts_debug = (@debug_mode && @context.config.get('verbose'))
+        opts_quiet = @context.config.get('quiet')
+        opts_format = if @context.config.get('verbose')
+                        { json: "results_#{@node.test_data[:test_name]}.json", documentation: nil }
+                      else
+                        { json: "results_#{@node.test_data[:test_name]}.json" }
+                      end
+        CemAcpt::RSpecUtils::Options.new(@context.config,
+                                         test_path: opts_test_path,
+                                         env: opts_env,
+                                         debug: opts_debug,
+                                         quiet: opts_quiet,
+                                         format: opts_format)
       end
     end
   end

data/lib/cem_acpt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CemAcpt
-  VERSION = '0.2.8'
+  VERSION = '0.2.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: universal-java-17
 authors:
 - puppetlabs