cem_win_spec 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8483cd4acfa3729cf4bd453fe3ef09a67c71ddd3dcee46f5dc3986e755ddf07
-  data.tar.gz: a4ef098f7125bf68579dd1b5902d5cb553ccfcbef355d8bd0e4f1d8900eae395
+  metadata.gz: 0c99510b91f69ac85f4e529d51134f797546bca8ee7ede74629a08620280b4c6
+  data.tar.gz: 57aa64d9931b08ce6a1e49178303643ded631334b43612707ee7383fb8c07426
 SHA512:
-  metadata.gz: 8a1a521b044cc4c14a26efd6b8936f662dc1d2b173918337e49b591fe1178f6357aff317cd7dab4ae167688eea2304b75dc89fde8273bb8e7dcc3d22b8df8d33
-  data.tar.gz: a31a1631d32ca72d34f276920de7a9f22f34175afac7306e64f7158ec309cc66ce0e80aab6b3ac430627f170291b9e442fd7516a7231b242c059a39836f5e3e1
+  metadata.gz: bdc2ba16b32de3f4e5eff3f327d5407cb7d377cb836ae971b9c7dd57b771d8b1e7d7347c312006e52e77302c8ff2c61c899d5f82e39336aefa8bfb41dca0e865
+  data.tar.gz: 07f97ff0b736be471fea8cd9db08ce10c070353e03c5e523fc301b75a39a6689e77149ea95933d55c7cda5110f93983e562305bf4020472025fadde500293a31

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cem_win_spec (0.1.4)
+    cem_win_spec (0.1.6)
       parallel_tests (~> 3.4)
       puppet_forge (~> 4.1)
       winrm (~> 2.3)
@@ -15,7 +15,7 @@ GEM
     coderay (1.1.3)
     diff-lcs (1.5.0)
     erubi (1.12.0)
-    faraday (2.7.5)
+    faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-follow_redirects (0.3.0)

data/lib/cem_win_spec/fixture_cache.rb

@@ -8,6 +8,8 @@ require 'puppet_forge'
 require 'yaml'
 
 module CemWinSpec
+  class FixtureCacheError < StandardError; end
+
   # Class for managing cached fixtures
   # Fixture caching is used to speed up test runs by reusing the same
   # Puppet modules between test runs instead of downloading them each time.
@@ -24,11 +26,10 @@ module CemWinSpec
     attr_reader :cache_dir, :cache_entries
 
     def initialize
-      raise 'FixtureCache must be ran on Windows' unless Gem.win_platform?
-
+      validate_platform!
       @cache_dir = CACHE_DIR
       @cache_entries = setup_and_load_cache
-      @entries_digest = Digest::SHA256.hexdigest(@cache_entries.to_s)
+      @entries_digest = hexdigest(@cache_entries.to_s)
       @dependencies = dependencies_from_metadata
       setup!
     end
@@ -43,6 +44,8 @@ module CemWinSpec
         puts "Downloading #{name} #{data[:version]}..."
         download_and_cache(name, data[:release_slug], data[:checksum])
       end
+    rescue StandardError => e
+      handle_error(e, 'Failed to setup fixture cache')
     ensure
       save_cache_entries
     end
@@ -52,16 +55,37 @@ module CemWinSpec
       raise "Directory #{fixtures_dir} does not exist" unless File.directory?(fixtures_dir)
 
       @cache_entries.each do |_, path|
-        ::FileUtils.cp_r(path, fixtures_dir)
-        interim_mod_path = File.join(fixtures_dir, File.basename(path))
         final_mod_path = File.join(fixtures_dir, File.basename(path).split('-').last)
-        ::FileUtils.mv(interim_mod_path, final_mod_path)
-        puts "Copied #{File.basename(path)} to #{final_mod_path}"
+        ::FileUtils.remove_entry_secure(final_mod_path) if File.exist?(final_mod_path)
+        ::FileUtils.cp_r(path, final_mod_path)
+        puts "Copied #{path} to #{final_mod_path}"
       end
+    rescue StandardError => e
+      handle_error(e, "Failed to copy fixtures to #{fixtures_dir}")
     end
 
     private
 
+    def validate_platform!
+      return if Gem.win_platform?
+
+      $stderr.puts 'ERROR: FixtureCache must run on Windows'
+      raise FixtureCacheError, 'FixtureCache must run on Windows'
+    end
+
+    def hexdigest(str)
+      Digest(:SHA256).hexdigest(str)
+    end
+
+    def handle_error(e, msg = 'Fixture cache error')
+      $stderr.puts "ERROR: #{msg}: #{e}"
+      raise e if e.is_a?(FixtureCacheError)
+
+      new_err = FixtureCacheError.new("#{msg}: #{e}")
+      new_err.set_backtrace(e.backtrace)
+      raise new_err
+    end
+
     def dependencies_from_metadata
       raise "File metadata.json not found in current directory #{Dir.pwd}" unless File.exist?('metadata.json')
 
@@ -81,6 +105,8 @@ module CemWinSpec
           release_slug: latest_valid_release.slug,
         }
       end
+    rescue StandardError => e
+      handle_error(e, 'Failed to get dependencies from metadata.json')
     end
 
     def dep_version_req_satisfied?(version_req, version)
@@ -88,6 +114,8 @@ module CemWinSpec
       raise "Invalid version requirement #{version_req}" unless reqs.to_a.length > 1
 
       reqs.to_a[1..-1].all? { |req| version_req_satisfied?(req, version) }
+    rescue StandardError => e
+      handle_error(e, 'Failed checking version requirement satisfaction')
     end
 
     def version_req_satisfied?(version_req, version)
@@ -95,7 +123,7 @@ module CemWinSpec
     end
 
     def module_checksum(name, version_req, version)
-      Digest::SHA256.hexdigest("#{name}#{version_req}#{version}")
+      hexdigest("#{name}#{version_req}#{version}")
     end
 
     def manifest
@@ -114,6 +142,8 @@ module CemWinSpec
       end
       puts "Loading cache manifest #{manifest}..."
       YAML.load_file(manifest)
+    rescue StandardError => e
+      handle_error(e, 'Failed to setup and load cache')
     end
 
     def cached?(checksum)
@@ -132,13 +162,17 @@ module CemWinSpec
                                    File.join(module_cache_dir, 'temp'))
       cache_entries[checksum] = File.join(module_cache_dir, name)
       puts "Downloaded #{release_slug} to #{File.join(module_cache_dir, name)}"
+    rescue StandardError => e
+      handle_error(e, "Failed to download and cache #{name} with slug #{release_slug} and checksum #{checksum}")
     end
 
     def save_cache_entries
-      return if @entries_digest == Digest::SHA256.hexdigest(cache_entries.to_s)
+      return if @entries_digest == hexdigest(cache_entries.to_s)
 
       File.write(manifest, cache_entries.to_yaml)
       puts "Saved cache manifest #{manifest}"
+    rescue StandardError => e
+      handle_error(e, "Failed to save cache manifest #{manifest}")
     end
   end
 end

data/lib/cem_win_spec/module_archive_builder.rb

@@ -8,50 +8,37 @@ module CemWinSpec
   class ModuleArchiveBuilder
     include CemWinSpec::Logging
 
-    FILE_ALLOWLIST = %w[
-      data
-      files
-      lib
-      manifests
-      plans
-      spec
-      tasks
-      types
-      .fixtures.yml
-      .gitignore
-      .rspec
-      .rubocop.yml
-      .yardopts
-      hiera.yaml
-      Gemfile
-      metadata.json
-      Rakefile
+    FILE_EXCLUDELIST = %w[
+      .git/**/*
+      data/benchmarks/**/*
+      dev/**/*
+      spec/fixtures/modules/*
+      pkg/**/*
+      Gemfile.lock
     ].freeze
 
-    attr_reader :module_dir, :allowlist, :tempdir, :archive
+    attr_reader :module_dir, :excludelist, :tempdir, :archive
 
-    def initialize(module_dir = Dir.pwd, allowlist: FILE_ALLOWLIST)
+    def initialize(module_dir = Dir.pwd, excludelist: FILE_EXCLUDELIST)
       @module_dir = module_dir
       @module_name = File.basename(module_dir)
-      @allowlist = allowlist
+      @excludelist = excludelist
     end
 
     alias path archive
 
-    def build
+    def build(remove_when_complete: true)
       create_tempdir
       copy_module_to_tempdir
       remove_unwanted_files
       create_archive
       if block_given?
         begin
-          yield archive
-        ensure
-          FileUtils.rm_rf(archive) if archive && File.exist?(archive)
+          yield File.join(tempdir, archive)
         end
       end
     ensure
-      FileUtils.rm_rf(tempdir) if tempdir && File.exist?(tempdir)
+      FileUtils.rm_rf(tempdir) if remove_when_complete && tempdir && File.exist?(tempdir)
     end
 
     private
@@ -62,22 +49,30 @@ module CemWinSpec
     end
 
     def copy_module_to_tempdir
-      FileUtils.cp_r(module_dir, tempdir)
+      FileUtils.cp_r(module_dir, tempdir, preserve: false)
       logger.debug "Copied #{module_dir} to #{tempdir}"
       @temp_module_dir = File.join(tempdir, @module_name)
     end
 
-    def remove_unwanted_files
-      to_remove = Dir.glob("*", File::FNM_DOTMATCH, base: @temp_module_dir).reject { |f| allowlist.include?(f) || %w[. ..].include?(f) }
-      to_remove.each do |file|
-        FileUtils.rm_rf(File.join(@temp_module_dir, file))
-        logger.debug "Removed #{file} from #{@temp_module_dir}"
+    def unwanted_files
+      unwanted = []
+      Dir.glob('**/*', File::FNM_DOTMATCH, base: @temp_module_dir) do |f|
+        next if %w[. ..].include?(f)
+
+        unwanted << File.join(@temp_module_dir, f) if excludelist.any? { |e| File.fnmatch?(e, f, File::FNM_DOTMATCH) }
       end
+      unwanted
+    end
+
+    def remove_unwanted_files
+      FileUtils.rm_rf(unwanted_files, verbose: (logger.level.first <= Logger::DEBUG))
     end
 
     def create_archive
       @archive = "#{@module_name}.tar.gz"
-      `tar -czf #{archive} -C #{tempdir} #{@module_name}`
+      Dir.chdir(tempdir) do
+        `COPYFILE_DISABLE=1 tar -czf #{archive} --no-acls --no-xattrs #{@module_name}`
+      end
       logger.info "Created module archive #{archive}"
     end
   end

data/lib/cem_win_spec/rake_tasks.rb

@@ -81,7 +81,7 @@ namespace 'cem_win_spec' do
   task :prep do
     puts 'Preparing spec data...'
     data_fix = cem_win_spec_base_path_in_fixtures(cem_win_spec_data_dir)
-    if File.directory?(data_fix)
+    if Dir.exist?(data_fix)
       puts "Removing old #{data_fix} directory..."
       ::FileUtils.remove_entry_secure(data_fix)
     end
@@ -91,16 +91,23 @@ namespace 'cem_win_spec' do
       raise 'Spec data copy failed!'
     end
     hiera_fix = cem_win_spec_base_path_in_fixtures(cem_win_spec_hiera_conf)
+    if File.file?(hiera_fix)
+      puts "Removing old #{hiera_fix} file..."
+      ::FileUtils.remove_entry_secure(hiera_fix)
+    end
     puts "Copying Hiera config to #{hiera_fix}..."
     ::FileUtils.cp(cem_win_spec_hiera_conf, hiera_fix)
-    unless File.exist?(hiera_fix)
-      raise 'Hiera config copy failed!'
-    end
+    raise 'Hiera config copy failed!' unless File.exist?(hiera_fix)
+    
     puts 'Spec data prepared successfully'
-    puts 'Preparing module fixtures...'
-    mod_fix = cem_win_spec_base_path_in_fixtures('modules')
+    puts 'Setting up module fixture cache...'
     cache = CemWinSpec::FixtureCache.new
+    puts 'Copying module fixtures to spec fixtures directory...'
+    mod_fix = cem_win_spec_base_path_in_fixtures('modules')
     cache.copy_fixtures_to(mod_fix)
+    puts 'Removing old module symlink...'
+    link_path = File.join(mod_fix, 'cem_windows')
+    ::FileUtils.remove_entry_secure(link_path) if File.exist?(link_path)
     puts 'Module fixtures prepared successfully'
   end
 
@@ -108,9 +115,10 @@ namespace 'cem_win_spec' do
   task :parallel_spec_standalone do
     spec_files = Rake::FileList[cem_win_spec_pattern]
     pargs = ['--type', 'rspec']
-    pargs << '--trace' if cem_win_spec_trace
+    pargs << '--verbose' if cem_win_spec_trace
     rspec_args = ['--']
     rspec_args << '--fail-fast' if cem_win_spec_fail_fast
+    rspec_args << '--backtrace' if cem_win_spec_trace
     rspec_args.concat(['--format', cem_win_spec_format])
     pargs.concat(rspec_args)
     pargs << '--'

data/lib/cem_win_spec/test_runner.rb

@@ -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_run("tar -xzf #{module_dir}.tar.gz -C #{remote_working_dir}")
+        remote_run("tar -C #{remote_working_dir} -xzf #{module_dir}.tar.gz")
         logger.debug "Module extracted to #{module_dir}"
         module_dir
       end

data/lib/cem_win_spec/version.rb

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

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

@@ -29,8 +29,8 @@ module CemWinSpec
         begin
           shell = conn.shell(:powershell)
           output = shell.run(command(cmd)) do |stdout, stderr|
-            logger << stdout unless stdout.nil? || stdout.empty?
-            logger << stderr unless stderr.nil? || stderr.empty?
+            logger << stdout if stdout
+            logger << stderr if stderr
           end
         rescue WinRM::WinRMAuthorizationError => e
           @available = false

data/lib/cem_win_spec.rb

@@ -56,16 +56,37 @@ module CemWinSpec
         raise ArgumentError, "Unknown operation: #{operation}"
       end
     rescue StandardError => e
-      logger.fatal "Error: #{e.message}"
-      logger.debug e.backtrace.join("\n")
-      exit 1
+      if operation == :spec
+        begin
+          logger.warn "Error running spec: #{e.message}"
+          logger.debug e.backtrace.join("\n")
+          retry_spec_on_error(runner, module_dir, **options)
+        rescue StandardError => err
+          handle_run_error(err)
+        end
+      else
+        handle_run_error(e)
+      end
     end
   end
 
+  def self.handle_run_error(err)
+    logger.fatal "Error: #{err.message}"
+    logger.debug err.backtrace.join("\n")
+    exit 1
+  end
+
+  def self.retry_spec_on_error(runner, module_dir, **options)
+    logger.info 'Cleaning cache and trying again...'
+    clean_fixture_cache_out = clean_fixture_cache(runner, module_dir, **options)
+    check_output!(clean_fixture_cache_out, runner)
+    spec_out = run_spec(runner, module_dir, **options)
+    check_output!(spec_out, runner)
+  end
+
   def self.setup_remote_environment(runner)
     runner.enable_long_paths.run
     runner.enable_symlinks.run
-    runner.enable_symlinks.run
     working_dir_out = runner.create_working_dir.run
     working_dir = working_dir_out.stdout.chomp
     logger.debug "Working dir: #{working_dir}"
@@ -99,8 +120,7 @@ module CemWinSpec
   def self.check_output!(output, runner = nil)
     unless output.success?
       runner&.iap_tunnel&.stop(wait: false, log: false)
-      logger.fatal "Command failed with exit code #{output.exitcode}"
-      exit output.exitcode
+      raise "Command failed with exit code #{output.exitcode}"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cem_win_spec
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Heston Snodgrass
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-31 00:00:00.000000000 Z
+date: 2023-09-26 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.10
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: Write a short summary, because RubyGems requires one.