cem_acpt 0.2.5 → 0.6.0

data/lib/cem_acpt/rspec_utils.rb

@@ -1,242 +0,0 @@
-# frozen_string_literal: true
-
-require 'English'
-require 'open3'
-require 'pty'
-require 'shellwords'
-require_relative 'logging'
-
-module CemAcpt
-  # Module that provides methods and objects for running and managing RSpec
-  module RSpecUtils
-    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
-
-      # @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 [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`.
-      # @option opts [Boolean] :debug True if RSpec should run in debug mode, false if not. Mutually exclusive with
-      #   `:quiet`. Default is `false`.
-      # @option opts [Boolean] :quiet True if no output should be logged from RSpec command, false if output should
-      #   be logged. Mutually exclusive with `:debug`. Default is `false`.
-      # @option opts [Boolean] :use_bundler Whether or not `bundle exec` should be used to run the RSpec command.
-      #   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)
-      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
-        end
-      end
-
-      # Sets debug mode to `false`
-      def unset_debug
-        @debug = false
-      end
-
-      def quiet
-        @quiet && !debug
-      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
-      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 += ['--format', fmt.to_s.shellescape]
-          cmd += ['--out', out.to_s.shellescape] if out
-        end
-        cmd.compact
-      end
-
-      # Returns a string representation of the RSpec command
-      def to_s
-        to_a.join(' ')
-      end
-
-      # Executes the RSpec command on the current machine
-      # @param pty [Boolean] If true, execute command in a PTY. If false, execute command directly.
-      # @param log_prefix [String] A prefix to add to log messages generated while the command is running.
-      def execute(pty: true, log_prefix: 'RSPEC')
-        if pty
-          execute_pty(log_prefix: log_prefix)
-        else
-          execute_no_pty(log_prefix: log_prefix)
-        end
-      end
-
-      # Executes the RSpec command in a psuedo-terminal (PTY). First, it spawns a process
-      # for $SHELL, sets environment variables `export_envs`, then calls the current RSpec
-      # command in the shell and exits with the last exit code `$?`. Output is read from the
-      # RSpec command in near real-time in a blocking manner unless the `:quiet` option has
-      # been specified.
-      # @param log_prefix [String] A prefix to add to the log messages that are output from
-      #   the RSpec command.
-      # @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_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)
-        end
-        $CHILD_STATUS
-      end
-
-      # Executes the RSpec command using Open3.popen2e(). The output stream, which is both
-      # stderr and stdout, is read in real-time in a non-blocking manner.
-      # @param log_prefix [String] A prefix to add to the log messages that are output from
-      #   the RSpec command.
-      # @return [Integer] The exit code of the RSpec command
-      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|
-          stdin.close
-          quiet ? wait_io(std_out_err) : read_io(std_out_err, log_prefix: log_prefix)
-          exit_status = wait_thr.value
-        end
-        exit_status
-      end
-
-      # Kills the PTY process with `SIGKILL` if the process exists
-      def kill_pty
-        Process.kill('KILL', @pty_pid) unless @pty_pid.nil?
-      rescue Errno::ESRCH
-        true
-      end
-
-      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
-      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
-      end
-
-      # The base RSpec command if `:use_bundler` is `false`
-      def cmd_base_rspec
-        [@rspec]
-      end
-
-      # Puts export statements for each key-value pair in `env` to the given writer.
-      # Writer is the write pipe of a PTY session, or a similar IO object that can
-      # 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|
-          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
-      end
-
-      # Blocking wait on an IO stream. Wait stops once the IO stream has reached
-      # end of file.
-      # @param stdout [IO] An IO stream with output that can be read from.
-      def wait_io(stdout)
-        sleep(0.01) until stdout.eof?
-      end
-
-      # Reads and logs data from `stdout` in a near real-time, blocking manner.
-      # @param stdout [IO] An IO stream with output that can be read from.
-      # @param log_prefix [String] A string prefix that is added to log messages.
-      def read_io(stdout, log_prefix: 'RSPEC')
-        loop do
-          chunk = stdout.read_nonblock(4096).strip
-          async_info(chunk, log_prefix) unless chunk.nil? || chunk.empty?
-        rescue IO::WaitReadable
-          IO.select([stdout])
-          retry
-        rescue EOFError
-          break
-        end
-      end
-    end
-  end
-end