cem_acpt 0.10.7 → 0.10.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f55a13b7ba6760d6d6b36ca313f7cddf637ae86b76ab48613de5938cb16f4d0e
-  data.tar.gz: 63838f21061f45475f880a7e6966664b0a043938b2f74548f79afebaf9801eca
+  metadata.gz: 93cbd3354b97e498b8eba13d18b40a0294147c2e5d499ee3ce3a8c3cd809637d
+  data.tar.gz: d5879ac35af8d5fa25f4207b9efea2bc51fda8718a65a49aa38a87e7cb74e766
 SHA512:
-  metadata.gz: 3679136cf4a7f393254856444f9c9bc922f608c86068f984620f8bcae3b5636bbcd22ce9fb2f72c80ba1e00e44df22ff0d445fb729f7d0f598ad3ce0dbed67e6
-  data.tar.gz: a46c919e4d0418377d9d06e9fe4b5c253794d26ae8e5e5f43f9d8e6f72ac6da453fc326e9a86d918daacf35ef554ab19d56565aad4da76055de98b3922fcc536
+  metadata.gz: c02e967c85cc1b00840e2263f292af3a911d4675be2509228ad822d5014d586c7282cc81c6ea071d078970b7a7dcbdcf29755ea3c4befe56a1cb7209740d6fef
+  data.tar.gz: a0d1beae7b3ebe208a5310beccf5c8ba176f82a3840affad465cc7cf9ac47d76a1ae8b0eb8fc9f7d806302333bba3cd03b43b14ab9818212cefe57bc61330e92

data/.github/workflows/spec.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   tests:
     name: RSpec tests
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         ruby:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cem_acpt (0.10.7)
+    cem_acpt (0.10.8)
       async-http (>= 0.60, < 0.70)
       bcrypt_pbkdf (>= 1.0, < 2.0)
       deep_merge (>= 1.2, < 2.0)

data/lib/cem_acpt/utils/shell.rb

@@ -11,49 +11,186 @@ module CemAcpt
   module Utils
     # Generic utilities for running local shell commands
     module Shell
-      # Runs a command in a subshell and returns the Process::Status
-      # and the string output of the command.
+      # Class to represent a single piece of output data, along with the stream it came from (stdout or stderr).
+      # This class is used to buffer output data from shell commands before writing it to the output stream, allowing
+      # for real-time logging and processing of the output.
+      class OutputData
+        attr_reader :data, :stream
+
+        # Initializes a new OutputData instance.
+        # @param data [String] The output data captured from the shell command
+        # @param stream [Symbol] The stream the data came from, either :stdout or :stderr. Defaults to :stdout.
+        def initialize(data, stream = :stdout)
+          @data = data
+          @stream = stream
+        end
+
+        # @return [String] The string representation of the output data, which is just the data itself.
+        def to_s
+          data
+        end
+      end
+
+      # Class to handle output from shell commands, allowing for real-time logging and buffering of output data.
+      # The Output class captures both stdout and stderr, and can be configured to combine them or keep them separate.
+      # It also supports logging debug messages if the provided output object supports it.
+      class Output
+        attr_writer :log_title
+
+        # Initializes a new Output instance.
+        # @param output [IO] An IO object that implements `:<<` to write the output of the command to in real time.
+        #   Typically this is a Logger object. Defaults to $stdout.
+        #   If the object responds to `:debug`, the command will be logged at the debug level.
+        # @param raise_on_fail [Boolean] Whether to raise an error if writing to the output fails. Defaults to true.
+        # @param combine_out_err [Boolean] Whether to combine the output and error streams into the output. If false,
+        #   the stderr stream will not be written to the output stream or returned with the output string.
+        #   Defaults to true.
+        def initialize(output: $stdout, raise_on_fail: true, combine_out_err: true)
+          @output = output
+          validate_output_object!
+          @buffer = []
+          @closed = false
+          @raise_on_fail = raise_on_fail
+          @combine_out_err = combine_out_err
+        end
+
+        # @return [StringIO] The StringIO object capturing stdout
+        def stdout
+          @io_out ||= StringIO.new
+        end
+
+        # @return [StringIO] The StringIO object capturing stderr
+        def stderr
+          @io_err ||= StringIO.new
+        end
+
+        # @return [String] The log title used for logging, defaults to "Output"
+        def log_title
+          @log_title ||= "Output"
+        end
+
+        # @return [Boolean] Whether the output is closed
+        def closed?
+          @closed
+        end
+
+        # Logs a debug message to the output if it supports :debug, otherwise writes it to the output stream.
+        # @param msg [String] The message to log as debug
+        def debug(msg)
+          write("DEBUG: #{msg}\n", :stderr)
+          if @output.respond_to? :debug
+            @output.debug(log_title) { msg }
+          end
+        end
+
+        # Writes data to the output stream and captures it in the buffer. Handles both stdout and stderr based on the stream parameter.
+        # @param data [String] The data to write to the output
+        # @param stream [Symbol] The stream to write to, either :stdout or :stderr. Defaults to :stdout.
+        def write(data, stream = :stdout)
+          raise IOError, "Cannot write to closed output" if closed?
+          begin
+            validate_stream!(stream)
+            newlines = data.count("\n")
+            if newlines == 1 && data.end_with?("\n")
+              data_obj = OutputData.new(data, stream)
+              @buffer << data_obj
+              flush
+            elsif newlines > 0
+              data.split("\n").each do |part|
+                data_obj = OutputData.new("#{part}\n", stream)
+                @buffer << data_obj
+                flush
+              end
+            else
+              @buffer << OutputData.new(data, stream)
+            end
+          rescue StandardError => e
+            raise e if @raise_on_fail
+
+            # If there's an error writing to the output, we still want to capture the output in the buffer and not lose it.
+            msg = "Error writing to output: #{e.message}. Captured output: #{data}"
+            @buffer << OutputData.new(msg, :stderr)
+            flush
+          end
+        end
+        alias << write
+
+        # Flushes the buffer to the output stream in order. If combine_out_err is true, stderr data will be written to the same stream as stdout.
+        def flush
+          return if @buffer.empty?
+
+          @buffer.each do |data_obj|
+            data = data_obj.to_s
+            stream = @combine_out_err ? :stdout : data_obj.stream
+            @output << data if @output
+            send(stream).write(data)
+          end
+          @buffer.clear
+        end
+
+        # Closes the output, flushing any remaining buffered data. If raise_on_fail is true, any errors during flushing will be raised.
+        def close
+          flush unless @buffer.empty?
+          @closed = true
+        end
+
+        private
+
+        def validate_output_object!
+          raise ArgumentError, "Output object must support :<< method" unless @output.respond_to?(:<<)
+        end
+
+        def validate_stream!(stream)
+          raise ArgumentError, "Stream must be :stdout or :stderr" unless [:stdout, :stderr].include?(stream)
+        end
+      end
+
+      # Runs a command in a subshell and returns the the string output of the command.
       # @param cmd [String] The command to run
       # @param env [Hash] A hash of environment variables to set
-      # @param output [IO] An IO object that implements #:<< to write the output of the
+      # @param output [IO] An IO object that implements `:<<` to write the output of the
       #   command to in real time. Typically this is a Logger object. Defaults to $stdout.
-      #   If the object responds to #:debug, the command will be logged at the debug level.
+      #   If the object responds to `:debug`, the command will be logged at the debug level.
       # @param raise_on_fail [Boolean] Whether to raise an error if the command fails
       # @param combine_out_err [Boolean] Whether to combine the output and error streams into the output.
       #   If false, the stderr stream will not be written to the output stream or returned with
       #   the output string.
-      # @return [String] The string output of the command, and the error output of the command
+      # @return [String] The string output of the command
       def self.run_cmd(cmd, env = {}, output: $stdout, raise_on_fail: true, combine_out_err: true)
-        io_out = StringIO.new
-        if output.respond_to?(:debug)
-          output.debug('CemAcpt::Utils::Shell') { "Running command:\n\t#{cmd}\nWith environment:\n\t#{env}" }
-        elsif output
-          output << "Running command:\n\t#{cmd}\nWith environment:\n\t#{env}\n"
-        end
-        val = Open3.popen3(env, cmd) do |i, o, e, t|
-          i.close
-          o.sync = true
-          e.sync = true
-          output_thread = Thread.new do
-            while (line = o.gets("\n"))
-              output << line if output
-              io_out.write(line) unless line.chomp.empty?
-            end
-            if combine_out_err
-              while (line = e.gets("\n"))
-                output << line if output && combine_out_err
-                io_out.write(line) unless line.chomp.empty?
+        env.transform_keys!(&:to_s)
+        output = Output.new(output: output, raise_on_fail: raise_on_fail, combine_out_err: combine_out_err)
+        output.log_title = 'CemAcpt::Utils::Shell'
+        output.debug("Running command:\n\t#{cmd}\nWith environment:\n\t#{env}")
+        begin
+          val = Open3.popen3(env, cmd) do |i, o, e, t|
+            i.close
+            o.sync = true
+            e.sync = true
+            files = [o, e]
+            until files.all?(&:eof?)
+              ready = IO.select(files)
+              if ready
+                ready[0].each do |f|
+                  data = f.read_nonblock(4096)
+                  if f == o
+                    output.write(data, :stdout)
+                  elsif f == e
+                    output.write(data, :stderr)
+                  end
+                rescue IO::WaitReadable, EOFError
+                  next
+                end
               end
             end
+            t.value
           end
-          t.join
-          output_thread.exit
-          t.value
+        ensure
+          output.close unless output.closed?
         end
-        io_string = io_out.string
-        raise CemAcpt::ShellCommandError, "Error running command: #{cmd}\n#{io_string}" if raise_on_fail && !val.success?
-
-        io_string
+        if raise_on_fail && !val.success?
+          raise CemAcpt::ShellCommandError, "Error running command: #{cmd}\n#{output.stdout.string}\n#{output.stderr.string}"
+        end
+        output.stdout.string
       end
 
       # Mimics the behavior of the `which` command.

data/lib/cem_acpt/version.rb

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

data/lib/terraform/gcp/linux/main.tf

@@ -81,9 +81,9 @@ resource "google_compute_instance" "acpt-test-node" {
     }
 
     scheduling {
-        preemptible = true
-        automatic_restart = false
-        provisioning_model = "SPOT"
+        preemptible = false
+        automatic_restart = true
+        provisioning_model = "STANDARD"
         instance_termination_action = "DELETE"
         max_run_duration {
             seconds = each.value.max_run_duration

data/lib/terraform/gcp/windows/main.tf

@@ -80,9 +80,9 @@ resource "google_compute_instance" "acpt-test-node" {
     }
 
     scheduling {
-        preemptible = true
-        automatic_restart = false
-        provisioning_model = "SPOT"
+        preemptible = false
+        automatic_restart = true
+        provisioning_model = "STANDARD"
         instance_termination_action = "DELETE"
         max_run_duration {
             seconds = each.value.max_run_duration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.10.7
+  version: 0.10.8
 platform: ruby
 authors:
 - puppetlabs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2026-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -314,7 +314,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: CEM Acceptance Tests