cem_win_spec 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8fcf2f514c6b40b1c2df94ceb0c7fd4c53c6470b5cd603281dac2303b014bdd
-  data.tar.gz: 459a0859428ec4c326b570b7e436ed17b4637d6ae326fe991b8de1ff08ba50f4
+  metadata.gz: b8483cd4acfa3729cf4bd453fe3ef09a67c71ddd3dcee46f5dc3986e755ddf07
+  data.tar.gz: a4ef098f7125bf68579dd1b5902d5cb553ccfcbef355d8bd0e4f1d8900eae395
 SHA512:
-  metadata.gz: 0d0e040d58de283421fed1ed9fb22d15c6f19b72f89d9fcd31cffadea277e352f4ae8e0d2c46a7b57c39756c71a2fcd9100a889344934280559ad90c65e5d908
-  data.tar.gz: 8655104a3e2415b478bd9ded995dcdcc6043b0e3b46fc177bcc42e78bfeff872dd89b538ded90c055cfd72574c997eb5f9839cbdca1c89a186c9cb0b7eb8c5ab
+  metadata.gz: 8a1a521b044cc4c14a26efd6b8936f662dc1d2b173918337e49b591fe1178f6357aff317cd7dab4ae167688eea2304b75dc89fde8273bb8e7dcc3d22b8df8d33
+  data.tar.gz: a31a1631d32ca72d34f276920de7a9f22f34175afac7306e64f7158ec309cc66ce0e80aab6b3ac430627f170291b9e442fd7516a7231b242c059a39836f5e3e1

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    cem_win_spec (0.1.2)
+    cem_win_spec (0.1.4)
       parallel_tests (~> 3.4)
       puppet_forge (~> 4.1)
-      tty-spinner (~> 0.9)
       winrm (~> 2.3)
       winrm-fs (~> 1.3)
 
@@ -15,21 +14,22 @@ GEM
     builder (3.2.4)
     coderay (1.1.3)
     diff-lcs (1.5.0)
-    erubi (1.10.0)
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
+    erubi (1.12.0)
+    faraday (2.7.5)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-follow_redirects (0.3.0)
       faraday (>= 1, < 3)
-    faraday-net_http (2.0.3)
+    faraday-net_http (3.0.2)
     ffi (1.15.5)
     gssapi (1.3.1)
       ffi (>= 1.0.1)
-    gyoku (1.3.1)
+    gyoku (1.4.0)
       builder (>= 2.1.2)
+      rexml (~> 3.0)
     httpclient (2.8.3)
     little-plugger (1.1.4)
-    logging (2.3.0)
+    logging (2.3.1)
       little-plugger (~> 1.1)
       multi_json (~> 1.14)
     method_source (1.0.0)
@@ -81,10 +81,7 @@ GEM
     ruby2_keywords (0.0.5)
     rubyntlm (0.6.3)
     rubyzip (2.3.2)
-    semantic_puppet (1.0.4)
-    tty-cursor (0.7.1)
-    tty-spinner (0.9.3)
-      tty-cursor (~> 0.7)
+    semantic_puppet (1.1.0)
     unicode-display_width (2.1.0)
     winrm (2.3.6)
       builder (>= 2.1.2)
@@ -102,7 +99,9 @@ GEM
       winrm (~> 2.0)
 
 PLATFORMS
+  arm64-darwin-22
   x86_64-darwin-19
+  x86_64-darwin-20
 
 DEPENDENCIES
   cem_win_spec!

data/cem_win_spec.gemspec

@@ -30,7 +30,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "winrm", "~> 2.3"
   spec.add_dependency "winrm-fs", "~> 1.3"
-  spec.add_dependency "tty-spinner", "~> 0.9"
   spec.add_dependency "puppet_forge", "~> 4.1"
   spec.add_dependency "parallel_tests", "~> 3.4"
   spec.add_development_dependency "pry"

data/exe/cem-win-spec

@@ -19,6 +19,26 @@ parser = OptionParser.new do |opts|
     exit 0
   end
 
+  opts.on('-p', '--puppet-version [VERSION]', 'Puppet version to test against') do |version|
+    unless %w[7 8].include?(version)
+      warn "Unknown Puppet version: #{version}"
+      warn 'Valid versions are: 7, 8'
+      puts opts
+      exit 1
+    end
+    options[:puppet_version] = version
+  end
+
+  opts.on('-r', '--ruby-version [VERSION]', 'Ruby version to test against') do |version|
+    unless %w[2 3].include?(version)
+      warn "Unknown Ruby version: #{version}"
+      warn 'Valid versions are: 2, 3'
+      puts opts
+      exit 1
+    end
+    options[:ruby_version] = version
+  end
+
   opts.on('-o', '--operation [OPERATION]', 'Operation to perform (spec, clean_fixture_cache)') do |operation|
     unless %w[spec clean_fixture_cache].include?(operation)
       warn "Unknown operation: #{operation}"

data/lib/cem_win_spec/iap_tunnel.rb

@@ -4,6 +4,8 @@ require 'io/console'
 require_relative 'logging'
 
 module CemWinSpec
+  class IapTunnelStartError < StandardError; end
+
   # This class is used to create a tunnel to a GCP instance
   class IapTunnel
     include CemWinSpec::Logging
@@ -23,7 +25,9 @@ module CemWinSpec
     end
 
     def running?
-      !@pid.nil?
+      !@pid.nil? && Process.getpgid(@pid)
+    rescue Errno::ESRCH
+      false
     end
 
     def with
@@ -41,7 +45,12 @@ module CemWinSpec
       logger.info 'Starting IAP tunnel...'
       logger.debug "Running command: #{tunnel_cmd}"
       @pid = spawn(tunnel_cmd)
-      sleep(5)
+      sleep(3) # Give the tunnel a few seconds to start
+      Process.getpgid(@pid) # Check if the process starts successfully
+      logger.info "IAP tunnel started on port #{port}"
+    rescue Errno::ESRCH
+      @pid = nil
+      raise IapTunnelStartError, "Failed to start IAP tunnel on port #{port}: #{$ERROR_INFO}"
     end
 
     # This method stops the IAP tunnel

data/lib/cem_win_spec/rspec_test_cmds.rb

@@ -6,24 +6,25 @@ module CemWinSpec
   class RspecTestCmds
     DEFAULT_PATTERN = 'spec/{classes,defines}/**/*_spec.rb'
 
-    def initialize(pattern: DEFAULT_PATTERN)
+    def initialize(use_bundler: true, pattern: DEFAULT_PATTERN)
+      @use_bundler = use_bundler
       @pattern = pattern
     end
 
     def cmd_standalone(*args)
-      "bundle exec rake 'cem:spec_standalone#{rake_args(nil, *args)}'"
+      prefix "rake 'cem:spec_standalone#{rake_args(nil, *args)}'"
     end
 
     def cmd_parallel(*args)
-      "bundle exec rake 'cem:parallel_spec_standalone#{rake_args(*args)}'"
+      prefix "rake 'cem:parallel_spec_standalone#{rake_args(*args)}'"
     end
 
     def cmd_chunked(*files)
-      "bundle exec rake 'cem:parallel_spec_files#{rake_args(files.join(' '))}'"
+      prefix "rake 'cem:parallel_spec_files#{rake_args(files.join(' '))}'"
     end
 
     def prep_cmd
-      'bundle exec rake cem:win_spec_prep'
+      prefix 'rake cem:win_spec_prep'
     end
 
     def cmds(*args)
@@ -31,7 +32,7 @@ module CemWinSpec
     end
 
     def cleanup_cmd
-      'bundle exec rake cem:win_spec_clean'
+      prefix 'rake cem:win_spec_clean'
     end
 
     def spec_files
@@ -40,12 +41,16 @@ module CemWinSpec
 
     private
 
+    def prefix(cmd)
+      @use_bundler ? "bundle exec #{cmd}" : cmd
+    end
+
     def rake_args(*args)
       args.empty? ? '' : "[#{args.join(',')}]"
     end
 
     def rspec_cmd(file, *args)
-      "bundle exec rake 'cem:spec_standalone#{rake_args(file, *args)}'"
+      prefix "rake 'cem:spec_standalone#{rake_args(file, *args)}'"
     end
   end
 end

data/lib/cem_win_spec/test_runner.rb

@@ -38,13 +38,13 @@ module CemWinSpec
 
     def enable_long_paths(**opts)
       new_command('Enable long paths', **opts) do
-        remote_exec('Set-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1')
+        remote_run('Set-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1')
       end
     end
 
     def enable_symlinks(**opts)
       @enable_symlinks ||= new_command('Enable symlinks', **opts) do
-        remote_exec('fsutil behavior set SymlinkEvaluation L2L:1 R2R:1 L2R:1 R2L:1')
+        remote_run('fsutil behavior set SymlinkEvaluation L2L:1 R2R:1 L2R:1 R2L:1')
       end
     end
 
@@ -68,7 +68,7 @@ module CemWinSpec
         module_archive_build { |a| remote_upload(a, remote_working_dir) }
         module_dir = "#{remote_working_dir}\\#{File.basename(module_archive_path, '.tar.gz')}"
         logger.debug "Module uploaded to #{module_dir}.tar.gz, extracting..."
-        remote_exec("tar -xzf #{module_dir}.tar.gz -C #{remote_working_dir}")
+        remote_run("tar -xzf #{module_dir}.tar.gz -C #{remote_working_dir}")
         logger.debug "Module extracted to #{module_dir}"
         module_dir
       end
@@ -76,33 +76,38 @@ module CemWinSpec
 
     def setup_ruby(**opts)
       @setup_ruby ||= new_command('Set up ruby', **opts) do
-        remote_exec('bundle config disable_platform_warnings true')
-        remote_exec('bundle install')
+        remote_run(
+          [
+            'bundle config disable_platform_warnings true',
+            'bundle config set --local without \'local_development\'',
+            'bundle install',
+          ],
+        )
       end
     end
 
     def rspec_prep(**opts)
       @rspec_prep ||= new_command('Prepare rspec tests', **opts) do
-        remote_exec('bundle exec rake cem_win_spec:prep --trace')
+        remote_run('bundle exec rake cem_win_spec:prep --trace')
       end
     end
 
     def rspec_tests(**opts)
       @rspec_tests ||= new_command('Run rspec tests', **opts) do
-        remote_exec(rspec_cmd_standalone('false', 'progress', 'true'))
+        remote_run(rspec_cmd_standalone('false', 'progress', 'true'))
       end
     end
 
     def rspec_tests_parallel(**opts)
       @rspec_tests_parallel ||= new_command('Run rspec tests in parallel', **opts) do
-        remote_exec('bundle exec rake cem_win_spec:parallel_spec')
+        remote_run('bundle exec rake cem_win_spec:parallel_spec')
       end
     end
 
     def clean_up
       @clean_up ||= new_command('Cleanup') do |working_dir|
         if remote_available?
-          remote_exec(cleanup_cmd, quiet: true)
+          remote_run(cleanup_cmd, quiet: true)
         else
           logger.warn 'Cleanup not available'
         end
@@ -111,7 +116,7 @@ module CemWinSpec
 
     def clean_fixture_cache(**opts)
       @clean_cache ||= new_command('Clean fixture cache', **opts) do
-        remote_exec('bundle exec rake cem_win_spec:clean_fixture_cache')
+        remote_run('bundle exec rake cem_win_spec:clean_fixture_cache')
       end
     end
 

data/lib/cem_win_spec/version.rb

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

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative '../../logging'
+
+module CemWinSpec
+  module WinExec
+    class BaseCmd
+      include CemWinSpec::Logging
+
+      COMMAND_SEPARATOR = '; '
+      PUPPET_VER_TO_RUBY_VER = {
+        '7' => '278',
+        '8' => '322',
+      }.freeze
+
+      attr_accessor :working_dir, :env_vars, :puppet_version
+
+      def initialize(working_dir = nil, puppet_version: nil, **env_vars)
+        @working_dir = working_dir
+        self.puppet_version = puppet_version
+        self.env_vars = env_vars
+      end
+
+      # Sets the puppet version that will be used to execute the command
+      # @param value [String, nil] the puppet version
+      def puppet_version=(value)
+        if value.nil?
+          @puppet_version = nil
+          return
+        end
+
+        ver = value.to_s
+        raise ArgumentError, 'puppet_version only supports major versions 7 and 8' unless ver.match?(/^(7|8).*/)
+        unless ver.match?(/^(7|8)(\.\d+)?\.\d+$/)
+          ver = "#{ver}.0"
+        end
+
+        @puppet_version = ver
+      end
+
+      # Sets the environment variables that will be used to execute the command
+      # @param value [Hash] the environment variables
+      def env_vars=(value)
+        raise ArgumentError, 'env_vars must be a hash' unless value.is_a?(Hash)
+
+        value['PUPPET_GEM_VERSION'] = "~> #{puppet_version}" if puppet_version
+        value['FACTER_GEM_VERSION'] = 'https://github.com/puppetlabs/facter#main' if puppet_version
+        @env_vars = value
+      end
+
+      def available?
+        raise NotImplementedError
+      end
+
+      def run(cmd, *_args, **_kwargs)
+        raise NotImplementedError
+      end
+
+      # Returns the ruby version that will be used to execute the command
+      # The ruby version is determined by the puppet version that is set
+      # @return [String, nil] the ruby version or nil if the puppet version is not set
+      def ruby_version
+        return nil unless puppet_version
+
+        PUPPET_VER_TO_RUBY_VER[puppet_version.split('.')[0]]
+      end
+
+      def command(cmd)
+        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.join(COMMAND_SEPARATOR)
+      end
+
+      private
+
+      def log_command(cmd)
+        cmd = command(cmd)
+        logger.debug "Executing command:\n#{cmd.split(%r{\n|\r\n|;\s*}).map { |c| "  #> #{c}" }.join("\n")}"
+      end
+
+      def change_ruby_version_cmd
+        "uru #{ruby_version}"
+      end
+
+      def set_env_var_cmd(key, value)
+        "set #{key}=\"#{value}\""
+      end
+
+      def change_working_dir_cmd(dir)
+        "cd #{dir}"
+      end
+    end
+  end
+end

data/lib/cem_win_spec/win_exec/{local_exec.rb → cmd/local_cmd.rb}

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 require 'open3'
-require_relative 'base_exec'
+require_relative 'base_cmd'
 
 module CemWinSpec
   module WinExec
     # Class for executing local shell commands
-    class LocalExec < BaseExec
+    class LocalCmd < BaseCmd
       attr_reader :thread_results
 
-      def initialize(working_dir = nil)
+      def initialize(working_dir = nil, puppet_version: nil, **env_vars)
         @ran_in_thread = false
         @thread_results = {}
-        super(working_dir)
+        super(working_dir, puppet_version: puppet_version, **env_vars)
       end
 
       def available?
@@ -35,9 +35,9 @@ 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_exec(cmd, *_args, **_kwargs)
-        puts_cmd(cmd)
-        Process.detach(spawn(cd_working_dir(cmd)))
+      def bg_run(cmd, *_args, **_kwargs)
+        log_command(cmd)
+        Process.detach(spawn(command(cmd)))
       end
 
       # Execute a command in a new thread. This works by creating a new thread in a thread group
@@ -48,20 +48,20 @@ module CemWinSpec
       # Process::Status object.
       # @param cmd [String] The command to execute
       # @return [Array] An array of [:threaded, cmd]
-      def thread_exec(cmd, *_args, **_kwargs)
+      def thread_run(cmd, *_args, **_kwargs)
         @ran_in_thread = true
         th = Thread.new do
-          puts_cmd(cmd)
-          so, se, st = Open3.capture3(cd_working_dir(cmd))
+          log_command(cmd)
+          so, se, st = Open3.capture3(command(cmd))
           @thread_results[cmd] = [so, se, st]
         end
         thread_group.add th
         :threaded
       end
 
-      def exec(cmd, *_args, **_kwargs)
-        puts_cmd(cmd)
-        Open3.capture3(cd_working_dir(cmd))
+      def run(cmd, *_args, **_kwargs)
+        log_command(cmd)
+        Open3.capture3(command(cmd))
       end
 
       private

data/lib/cem_win_spec/win_exec/{winrm_exec.rb → cmd/winrm_cmd.rb}

@@ -2,32 +2,36 @@
 
 require 'winrm'
 require 'winrm-fs'
-require_relative 'base_exec'
+require_relative 'base_cmd'
 
 module CemWinSpec
   module WinExec
     # Class for executing PowerShell commands over WinRM
-    class WinRMExec < BaseExec
+    class WinRMCmd < BaseCmd
       attr_reader :conn_opts
 
-      def initialize(conn_opts, working_dir = nil, quiet: false)
+      def initialize(conn_opts, working_dir = nil, quiet: false, puppet_version: nil, **env_vars)
         @conn_opts = conn_opts
         @quiet = quiet
         @conn = new_conn(@conn_opts.to_h)
-        super(working_dir)
+        super(working_dir, puppet_version: puppet_version, **env_vars)
       end
 
       def available?
         @available
       end
 
-      def exec(cmd, *_args, **_kwargs)
-        puts_cmd(cmd)
+      def run(cmd, *_args, **_kwargs)
+        cmd = cmd.join('; ') if cmd.is_a?(Array)
+        log_command(cmd)
         shell = nil
         output = nil
         begin
           shell = conn.shell(:powershell)
-          output = shell.run(cd_working_dir(cmd))
+          output = shell.run(command(cmd)) do |stdout, stderr|
+            logger << stdout unless stdout.nil? || stdout.empty?
+            logger << stderr unless stderr.nil? || stderr.empty?
+          end
         rescue WinRM::WinRMAuthorizationError => e
           @available = false
           raise e
@@ -77,10 +81,19 @@ module CemWinSpec
       def new_conn(hash_opts)
         logger.debug "Creating connection to #{hash_opts[:endpoint]}"
         new_conn = WinRM::Connection.new(hash_opts)
-        new_conn.logger = logger
+        new_conn.logger = new_conn_logger
         new_conn
       end
 
+      def new_conn_logger
+        conn_logger = logger.dup
+        conn_logger.level = Logger::ERROR if @quiet
+        conn_logger.level = Logger::DEBUG if ENV['WINRM_DEBUG'] == 'true'
+        conn_logger.level = Logger::INFO if conn_logger.level == Logger::DEBUG && ENV.fetch('WINRM_DEBUG', 'false') != 'true'
+        logger.debug "WinRM connection logger level set to #{conn_logger.level}"
+        conn_logger
+      end
+
       def file_manager
         @file_manager ||= WinRM::FS::FileManager.new(conn)
       end

data/lib/cem_win_spec/win_exec/connection_opts.rb

@@ -49,7 +49,7 @@ module CemWinSpec
       end
 
       def pass
-        @pass ||= Digest::SHA256.hexdigest(pt_pass) unless pt_pass.nil?
+        Digest::SHA256.hexdigest(pt_pass) unless pt_pass.nil?
       end
 
       def endpoint
@@ -57,7 +57,7 @@ module CemWinSpec
       end
 
       def opts
-        @opts ||= new_opts(@kwargs)
+        @opts ||= create_new_opts(@kwargs)
       end
 
       def ==(other)
@@ -75,14 +75,14 @@ module CemWinSpec
       end
 
       def digest
-        Digest::SHA256.hexdigest([host, port, user, @pass, opts.values].join(':'))
+        Digest::SHA256.hexdigest([host, port, user, pt_pass, opts.values].join(':'))
       end
 
       # Merge new options into existing options and return a new ConnectionOpts object
       # @param [Hash] new_opts
       # @return [ConnectionOpts]
       def merge(**new_opts)
-        self.class.new(opts_merge(**new_opts))
+        self.class.new(**opts_merge(**new_opts))
       end
 
       def merge!(**new_opts)
@@ -139,7 +139,7 @@ module CemWinSpec
         password
       end
 
-      def new_opts(nopts = {})
+      def create_new_opts(nopts = {})
         logger.debug 'Creating new connection options opts'
         new_opts_h = CONN_DEFAULTS.dup.merge(nopts)
         new_opts_h[:transport] = new_opts_h[:transport].to_sym