cem_win_spec 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f80bb9bd51e4ad8a8d005504e107a6c7761a4f8c63da2fe2df69f84e1afb1b4
-  data.tar.gz: 6eb10d5243db33711faa2b8f21914e05f3ce16cc6514ae6add15159f03c53266
+  metadata.gz: 1b5689dd8fae43d58612457473f06c19baa7e798443f6393c87dda2c84b1a2f4
+  data.tar.gz: 1535bc2325b68cdb08475020b79e1d1d96df40803800e13c5b273cf6e63778f6
 SHA512:
-  metadata.gz: 3203c1ce68eb0c392c3968b82cf80066023545b1a4522d415b1f199538bdfd7cef34c4b2e4c8bd154ddec5e95fe5fe1f5b88652aeac81f2650f8a1b27bf3a8f4
-  data.tar.gz: 8ef99fac173500c73992db6f059a704674f862bf17563a3f3aff05507eb01e715a829ea822bf6c1f3845bdae9640f90f8d178247c57ad28eb402250fc8046b48
+  metadata.gz: d58a1f16b67591c42c7566cb102023ab07f5706d0638fc5b2d89cdc4bf1c4d89101779faec8dd864b220b2edd663bd1004e721d5f91db0616af98557ab962ff9
+  data.tar.gz: cafa3f69e03a737e06f840afd92abe2cc8c95d7f83cb8bfa5c043b2656ab59bec868c84467c3da6ee060451bd0515cfe4fc57c8fb21a73c7c15807fb3edc690f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cem_win_spec (0.1.7)
+    cem_win_spec (0.1.9)
       parallel_tests (~> 3.4)
       puppet_forge (~> 4.1)
       winrm (~> 2.3)
@@ -11,17 +11,20 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    bigdecimal (3.1.6)
-    builder (3.2.4)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
     coderay (1.1.3)
     diff-lcs (1.5.0)
-    erubi (1.12.0)
-    faraday (2.9.0)
-      faraday-net_http (>= 2.0, < 3.2)
+    erubi (1.13.0)
+    faraday (2.12.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
     faraday-follow_redirects (0.3.0)
       faraday (>= 1, < 3)
-    faraday-net_http (3.1.0)
-      net-http
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
     ffi (1.16.3)
     gssapi (1.3.1)
       ffi (>= 1.0.1)
@@ -29,16 +32,18 @@ GEM
       builder (>= 2.1.2)
       rexml (~> 3.0)
     httpclient (2.8.3)
+    json (2.8.2)
     little-plugger (1.1.4)
-    logging (2.3.1)
+    logger (1.7.0)
+    logging (2.4.0)
       little-plugger (~> 1.1)
       multi_json (~> 1.14)
     method_source (1.0.0)
-    minitar (0.9)
+    minitar (0.12.1)
     multi_json (1.15.0)
-    net-http (0.4.1)
+    net-http (0.5.0)
       uri
-    nori (2.7.0)
+    nori (2.7.1)
       bigdecimal
     parallel (1.22.1)
     parallel_tests (3.13.0)
@@ -82,19 +87,21 @@ GEM
     rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    rubyntlm (0.6.3)
+    rubyntlm (0.6.5)
+      base64
     rubyzip (2.3.2)
     semantic_puppet (1.1.0)
     unicode-display_width (2.1.0)
-    uri (0.13.0)
-    winrm (2.3.6)
+    uri (1.0.2)
+    winrm (2.3.9)
       builder (>= 2.1.2)
       erubi (~> 1.8)
       gssapi (~> 1.2)
       gyoku (~> 1.0)
       httpclient (~> 2.2, >= 2.2.0.2)
       logging (>= 1.6.1, < 3.0)
-      nori (~> 2.0)
+      nori (~> 2.0, >= 2.7.1)
+      rexml (~> 3.0)
       rubyntlm (~> 0.6.0, >= 0.6.3)
     winrm-fs (1.3.5)
       erubi (~> 1.8)

data/exe/cem-win-spec

@@ -77,3 +77,4 @@ parser.parse!
 
 operation = options[:operation] || :spec
 CemWinSpec.run(operation, options)
+exit CemWinSpec.exit_code

data/lib/cem_win_spec/logging.rb

@@ -38,7 +38,7 @@ module CemWinSpec
 
     class << self
       def log_setup!(options = {})
-        console_l_level = if options[:debug]
+        console_l_level = if (options.key?(:debug) && options[:debug]) || ENV['RUNNER_DEBUG']
                             new_log_level('debug')
                           else
                             new_log_level('info')

data/lib/cem_win_spec/test_runner.rb

@@ -98,13 +98,17 @@ module CemWinSpec
       end
     end
 
-    def clean_up(working_dir)
-      @clean_up ||= new_command('Cleanup') do |working_dir|
-        if remote_available?
-          remote_run(cleanup_cmd, working_dir, quiet: true)
-        else
-          logger.warn 'Cleanup not available'
-        end
+    def clean_up(**opts)
+      @clean_up ||= new_command('Cleanup', **opts) do
+        remote_run(
+          [
+            "Get-ChildItem -Path #{remote_working_dir} -Force -Recurse | Remove-Item -Force -Recurse",
+            "Remove-Item #{remote_working_dir} -Force",
+          ],
+          ruby_cmd: false,
+          add_envs: false,
+          chdir: false,
+        )
       end
     end
 
@@ -142,12 +146,5 @@ module CemWinSpec
         end
       end
     end
-
-    def cleanup_cmd(working_dir)
-      <<~EOS
-        Get-ChildItem #{working_dir} -Recurse | Remove-Item -Force
-        Remove-Item -Force #{working_dir}
-      EOS
-    end
   end
 end

data/lib/cem_win_spec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CemWinSpec
-  VERSION = "0.1.7"
+  VERSION = "0.1.9"
 end

data/lib/cem_win_spec/win_exec/cmd/base_cmd.rb

@@ -49,6 +49,7 @@ module CemWinSpec
 
         value['PUPPET_GEM_VERSION'] = "~> #{puppet_version}" if puppet_version
         value['FACTER_GEM_VERSION'] = 'https://github.com/puppetlabs/facter#main' if puppet_version
+        value.delete('password') if value.key?('password')
         @env_vars = value
       end
 
@@ -69,18 +70,26 @@ module CemWinSpec
         PUPPET_VER_TO_RUBY_VER[puppet_version.split('.')[0]]
       end
 
-      def command(cmd)
+      # Formats the command to be run
+      # @param cmd [String, Array[String]] the command to be run
+      # @param ruby_cmd [Boolean] Whether the command is a ruby command and should be ran
+      #   in a ruby context. If false, the command will not set up the Uru ruby environment.
+      # @param add_envs [Boolean] Whether to add the environment variables to the command
+      # @param chdir [Boolean] Whether to change the working directory to the working dir
+      # @return [String] the formatted command
+      def command(cmd, ruby_cmd: true, add_envs: true, chdir: true, **_kwargs)
+        cmd = cmd.join(COMMAND_SEPARATOR) if cmd.is_a?(Array)
         cmd = [cmd]
-        cmd.unshift(change_ruby_version_cmd) if ruby_version # executes third
-        env_vars.each { |k, v| cmd.unshift(set_env_var_cmd(k, v)) } if env_vars.any? # executes second
-        cmd.unshift(change_working_dir_cmd(working_dir)) if working_dir # executes first
+        cmd.unshift(change_ruby_version_cmd) if ruby_cmd && ruby_version # executes third
+        env_vars.each { |k, v| cmd.unshift(set_env_var_cmd(k, v)) } if add_envs && env_vars.any? # executes second
+        cmd.unshift(change_working_dir_cmd(working_dir)) if chdir && working_dir # executes first
         cmd.join(COMMAND_SEPARATOR)
       end
 
       private
 
       def log_command(cmd)
-        cmd = command(cmd)
+        cmd.gsub!(/\$env:password = "\w+"/, '$env:password = [REDACTED]')
         logger.debug "Executing command:\n#{cmd.split(%r{\n|\r\n|;\s*}).map { |c| "  #> #{c}" }.join("\n")}"
       end
 

data/lib/cem_win_spec/win_exec/cmd/local_cmd.rb

@@ -35,9 +35,10 @@ module CemWinSpec
       # This is useful for running commands that should not block the current process
       # and that you don't need stdout/stderr from.
       # @param cmd [String] The command to execute
-      def bg_run(cmd, *_args, **_kwargs)
+      def bg_run(cmd, *_args, **kwargs)
+        cmd = command(cmd, **kwargs)
         log_command(cmd)
-        Process.detach(spawn(command(cmd)))
+        Process.detach(spawn())
       end
 
       # Execute a command in a new thread. This works by creating a new thread in a thread group
@@ -48,20 +49,22 @@ module CemWinSpec
       # Process::Status object.
       # @param cmd [String] The command to execute
       # @return [Array] An array of [:threaded, cmd]
-      def thread_run(cmd, *_args, **_kwargs)
+      def thread_run(cmd, *_args, **kwargs)
         @ran_in_thread = true
         th = Thread.new do
+          cmd = command(cmd, **kwargs)
           log_command(cmd)
-          so, se, st = Open3.capture3(command(cmd))
+          so, se, st = Open3.capture3(cmd)
           @thread_results[cmd] = [so, se, st]
         end
         thread_group.add th
         :threaded
       end
 
-      def run(cmd, *_args, **_kwargs)
+      def run(cmd, *_args, **kwargs)
+        cmd = command(cmd, **kwargs)
         log_command(cmd)
-        Open3.capture3(command(cmd))
+        Open3.capture3(cmd)
       end
 
       private

data/lib/cem_win_spec/win_exec/cmd/winrm_cmd.rb

@@ -21,14 +21,22 @@ module CemWinSpec
         @available
       end
 
-      def run(cmd, *_args, **_kwargs)
-        cmd = cmd.join('; ') if cmd.is_a?(Array)
+      # Run a command over WinRM
+      # @param cmd [String] The command to run
+      # @param kwargs [Hash] Additional options for the command
+      #   These following options are available:
+      #   - :ruby_cmd [Boolean] Whether the command is a ruby command and should be ran
+      #       in a ruby context. If false, the command will not set up the Uru ruby environment.
+      #   - :add_envs [Boolean] Whether to add the environment variables to the command
+      #   - :chdir [Boolean] Whether to change the working directory to the working dir
+      def run(cmd, *_args, **kwargs)
+        cmd = command(cmd, **kwargs)
         log_command(cmd)
         shell = nil
         output = nil
         begin
           shell = conn.shell(:powershell)
-          output = shell.run(command(cmd)) do |stdout, stderr|
+          output = shell.run(cmd) do |stdout, stderr|
             logger << stdout if stdout
             logger << stderr if stderr
           end

data/lib/cem_win_spec/win_exec/factory.rb

@@ -35,12 +35,12 @@ module CemWinSpec
       # @return [Exec] An Exec object
       def build(title, merge: true, user: nil, pass: nil, working_dir: nil, **opts, &block)
         logger.debug "Building Wexec object for #{title}"
-        build_conn_opts(merge: merge, user: user, pass: pass, **opts)
+        build_conn_opts(merge: merge, user: user, pass: pass, **@init_opts.merge(opts))
         logger.debug 'Created ConnectionOpts'
         wexec = Exec.new
         wexec.add_title title
         wexec.add_local_cmd @current_local_cmd
-        wexec.add_remote_cmd get_remote_cmd(working_dir, **@init_opts.merge(opts))
+        wexec.add_remote_cmd get_remote_cmd(working_dir, **@current_conn_opts.to_h)
         wexec.add_iap_tunnel @iap_tunnel
         wexec.add_ma_builder @ma_builder
         wexec.add_rspec_test_cmds @rspec_test_cmds
@@ -68,7 +68,7 @@ module CemWinSpec
           @current_conn_opts = ConnectionOpts.new(new_host: 'localhost', new_port: @iap_tunnel.port, user: user, pass: pass, **opts)
           return @current_conn_opts
         end
-        
+
         if need_new_conn_opts?(new_host: 'localhost', new_port: @iap_tunnel.port, user: user, pass: pass, **opts)
           if merge
             logger.debug 'Merging ConnectionOpts with new options'

data/lib/cem_win_spec.rb

@@ -8,16 +8,24 @@ module CemWinSpec
     include CemWinSpec::Logging
   end
 
+  def self.exit_code
+    @exit_code ||= 0
+  end
+
+  def self.exit_code=(value)
+    @exit_code = value
+  end
+
   def self.signal_handler(runner)
     Signal.trap('INT') do
-      puts 'Caught interrupt, killing tunnel and exiting'
-      runner.iap_tunnel.stop(wait: false, log: false)
+      puts 'Caught SIGINT, killing tunnel and exiting'
+      runner&.iap_tunnel&.stop(wait: false, log: false)
       exit 1
     end
     Signal.trap('TERM') do
-      puts 'Caught interrupt, killing tunnel and exiting'
-      runner.iap_tunnel.stop(wait: false, log: false)
-      exit 1
+      puts 'Caught SIGTERM, killing tunnel and exiting'
+      runner&.iap_tunnel&.stop(wait: false, log: false)
+      exit!
     end
   end
 
@@ -38,6 +46,7 @@ module CemWinSpec
     logger.debug "Created TestRunner: #{runner}"
     signal_handler(runner)
     logger.debug 'Set up signal handler'
+    working_dir = nil
     begin
       sre_out = setup_remote_environment(runner)
       working_dir = sre_out.stdout.chomp
@@ -49,8 +58,12 @@ module CemWinSpec
       case operation
       when :spec
         run_spec(runner, module_dir, **options)
+        # We set this to 0 if the tests pass because this can be set to 1 earlier by commands that fail and retry.
+        self.exit_code = 0
       when :clean_fixture_cache
         clean_fixture_cache(runner, module_dir, **options)
+        # We set this to 0 if the tests pass because this can be set to 1 earlier by commands that fail and retry.
+        self.exit_code = 0
       else
         raise ArgumentError, "Unknown operation: #{operation}"
       end
@@ -67,15 +80,24 @@ module CemWinSpec
         handle_run_error(e)
       end
     ensure
-      runner&.clean_up(working_dir) if working_dir
-      runner&.iap_tunnel&.stop(wait: false, log: false)
+      if working_dir
+        begin
+          logger.info "Cleaning up working directory #{working_dir}"
+          clean_up(runner, working_dir, **options)
+          logger.debug 'Finished cleaning up working directory'
+        rescue StandardError => e
+          handle_run_error(e)
+        end
+      end
+      runner&.iap_tunnel&.stop(log: false)
+      logger.info 'Finished running cem-win-spec'
     end
   end
 
   def self.handle_run_error(err)
     logger.fatal "Error: #{err.message}"
     logger.debug err.backtrace.join("\n")
-    exit 1
+    self.exit_code = 1
   end
 
   def self.retry_spec_on_error(runner, module_dir, **options)
@@ -126,6 +148,21 @@ module CemWinSpec
                                   reuse_tunnel: false,
                                   **opts).run
     end
+    if output.stderr&.include?('Tests Failed')
+      logger.error 'Tests failed'
+      self.exit_code = 1
+    end
+  end
+
+  # Clean up the remote working directory
+  # @param options [Hash] Options for the test runner
+  def self.clean_up(runner, working_dir, **opts)
+    validate_output do
+      runner.clean_up(operation_timeout: 300,
+                      receive_timeout: 310,
+                      working_dir: working_dir,
+                      **opts).run
+    end
   end
 
   # Clean the remote fixture cache
@@ -164,7 +201,7 @@ module CemWinSpec
     end
 
     unless output.send(validation_method)
-      raise CemWinSpecValidationError, "Output validation \"#{validation_method}\" failed: #{output}"
+      raise CemWinSpecValidationError, "Output validation \"#{validation_method}\" failed:\n#{output}"
     end
     output
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cem_win_spec
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Heston Snodgrass
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: winrm
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Write a short summary, because RubyGems requires one.