Modernize test_bundle and use verbose output (Trace currently) so we …

…can check what's happening

src/cli/test/test_bundle.rb

@@ -1,177 +1,173 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require 'openstudio'
 
 # test bundle capability in CLI
 # currently CLI cannot do bundle install, rely on system bundle for that for now
 # in future, bundle install should be done like: openstudio --bundle_install Gemfile --bundle_path ./test_gems
 class Bundle_Test < Minitest::Test
+  # Poor man's enum
+  LOCK_NO_LOCK = 'no lock'
+  LOCK_NATIVE = 'native'
+  LOCK_RUBY = 'ruby'
+
+  # Name of folder used as BUNDLE_PATH
+  BUNDLE_PATH = 'test_gems'
+
+  # Verbosity
+  LOGLEVEL = 'Trace'
+
+  def bold(msg); "\e[1m#{msg}\e[22m" end
+
+  def colorize(msg, color_code); "\e[#{color_code}m#{msg}\e[0m"; end
+  def black(msg); colorize(msg, 30) end
+  def red(msg); colorize(msg, 31) end
+  def green(msg); colorize(msg, 32) end
+  def yellow(msg); colorize(msg, 33) end
+  def blue(msg); colorize(msg, 34) end
+  def magenta(msg); colorize(msg, 35) end
+  def cyan(msg); colorize(msg, 36) end
+  def gray(msg); colorize(msg, 37) end
+
+  def run_command(cmd)
+    puts yellow("$ #{cmd}")
+    system(cmd)
+  end
 
   def rm_if_exist(p)
-    if File.exist?(p)
-      # comment out if you want to test without rebundling
-      FileUtils.rm_rf(p)
+    return unless File.exist?(p)
+
+    puts gray("Removing '#{p}'") if LOGLEVEL == 'Trace'
+    # comment out if you want to test without rebundling
+    FileUtils.rm_rf(p)
+  end
+
+  def run_bundle_install(subfolder, lock:)
+    puts bold(cyan("Running bundle install in #{subfolder} with lock='#{lock}'"))
+    Dir.chdir(subfolder) do
+      assert(run_command("bundle config set --local path #{BUNDLE_PATH}"))
+      assert(run_command('bundle install'))
+      if lock == LOCK_NATIVE
+        if /mingw/.match(RUBY_PLATFORM) || /mswin/.match(RUBY_PLATFORM)
+          assert(run_command('bundle lock --add_platform mswin64'))
+        end
+      elsif lock == LOCK_RUBY
+        assert(run_command('bundle lock --add_platform ruby'))
+      end
     end
   end
 
-  def test_bundle
-    original_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), 'bundle'))
+  def run_cli_with_bundle(subfolder)
+    puts bold(magenta("Running CLI with bundle and bundle_path in #{subfolder}"))
+    Dir.chdir(subfolder) do
+      cmd = "'#{OpenStudio.getOpenStudioCLI}' --bundle Gemfile --bundle_path './#{BUNDLE_PATH}' --loglevel #{LOGLEVEL} test.rb"
+      assert(run_command(cmd))
+    end
+  end
 
-    rm_if_exist('Gemfile.lock')
-    rm_if_exist('./test_gems')
-    rm_if_exist('./bundle')
+  def cleanup_artifacts(subfolder, remove_gemfile_and_gemspec: false)
+    rm_if_exist(File.join(subfolder, 'Gemfile.lock'))
+    rm_if_exist(File.join(subfolder, BUNDLE_PATH))
+    rm_if_exist(File.join(subfolder, '.bundle'))
 
-    assert(system('bundle install --path ./test_gems'))
-    assert(system('bundle lock --add_platform ruby'))
-    assert(system("'#{OpenStudio::getOpenStudioCLI}' --bundle Gemfile --bundle_path './test_gems' --loglevel Trace test.rb"))
+    return unless remove_gemfile_and_gemspec
 
-  ensure
-    Dir.chdir(original_dir)
+    rm_if_exist(File.join(subfolder, 'openstudio-gems.gemspec'))
+    rm_if_exist(File.join(subfolder, 'Gemfile'))
   end
 
-  def test_bundle_git
-    original_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), 'bundle_git'))
+  def run_bundle_test(install:, lock:, run_cli: true)
+    # NOTE: if you have a test named `test_bundle_no_install` this looks for a
+    # subfolder named `bundle_no_install` with test.rb in there
+    subfolder_name = caller_locations(1, 1)[0].label.gsub(/^test_/, '')
+    subfolder = File.join(File.dirname(__FILE__), subfolder_name)
+    assert_path_exists(subfolder)
 
-    rm_if_exist('Gemfile.lock')
-    rm_if_exist('./test_gems')
-    rm_if_exist('./bundle')
+    cleanup_artifacts(subfolder)
 
-    assert(system('bundle install --path ./test_gems'))
-    assert(system('bundle lock --add_platform ruby'))
-    assert(system("'#{OpenStudio::getOpenStudioCLI}' --bundle Gemfile --bundle_path './test_gems' --loglevel Trace test.rb"))
+    run_bundle_install(subfolder, lock: lock) if install
+    return unless run_cli
 
-  ensure
-    Dir.chdir(original_dir)
+    run_cli_with_bundle(subfolder)
   end
 
-  def test_bundle_native
-    original_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), 'bundle_native'))
-
-    if /mingw/.match(RUBY_PLATFORM) || /mswin/.match(RUBY_PLATFORM)
-      skip("Native gems not supported on Windows")
-    else
-      skip("Native gems not supported on Unix or Mac")
-    end
+  def test_bundle
+    run_bundle_test(install: true, lock: LOCK_RUBY)
+  end
 
-    rm_if_exist('Gemfile.lock')
-    rm_if_exist('./test_gems')
-    rm_if_exist('./bundle')
+  def test_bundle_git
+    run_bundle_test(install: true, lock: LOCK_RUBY)
+  end
 
-    assert(system('bundle install --path ./test_gems'))
-    #assert(system('bundle lock --add_platform ruby'))
+  def test_bundle_native
     if /mingw/.match(RUBY_PLATFORM) || /mswin/.match(RUBY_PLATFORM)
-      assert(system('bundle lock --add_platform mswin64'))
+      skip('Native gems not supported on Windows')
+    else
+      skip('Native gems not supported on Unix or Mac')
     end
-    assert(system("'#{OpenStudio::getOpenStudioCLI}' --bundle Gemfile --bundle_path './test_gems' --loglevel Trace test.rb"))
 
-  ensure
-    Dir.chdir(original_dir)
+    run_bundle_test(install: true, lock: LOCK_NATIVE)
   end
 
-
   # Test for #5181 - This adds a bundle dependency on a native gem we DO have it the CLI
   def test_bundle_native_embedded
-    Dir.chdir(File.join(File.dirname(__FILE__), 'bundle_native_embedded')) do
-
-      rm_if_exist('Gemfile.lock')
-      rm_if_exist('./test_gems')
-      rm_if_exist('./bundle')
-
-      assert(system('bundle install --path ./test_gems'))
-      #assert(system('bundle lock --add_platform ruby'))
-      if /mingw/.match(RUBY_PLATFORM) || /mswin/.match(RUBY_PLATFORM)
-        assert(system('bundle lock --add_platform mswin64'))
-      end
-      assert(system("'#{OpenStudio::getOpenStudioCLI}' --bundle Gemfile --bundle_path './test_gems' --loglevel Trace test.rb"))
-
-    end
+    run_bundle_test(install: true, lock: LOCK_NATIVE)
   end
 
   def test_bundle_no_install
-    original_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), 'bundle_no_install'))
-
-    rm_if_exist('Gemfile.lock')
-    rm_if_exist('./test_gems')
-    rm_if_exist('./bundle')
-
-    #assert(system('bundle install --path ./test_gems'))
-    #assert(system('bundle lock --add_platform ruby'))
+    subfolder = File.join(File.dirname(__FILE__), 'bundle_no_install')
+    assert_path_exists(subfolder)
+    cleanup_artifacts(subfolder)
 
     # intentionally called with dependencies not found in the CLI, expected to fail
-    assert_equal(system("'#{OpenStudio::getOpenStudioCLI}' --bundle Gemfile --loglevel Trace test.rb"), false)
-
-  ensure
-    Dir.chdir(original_dir)
+    Dir.chdir(subfolder) do
+      assert_equal(run_command("'#{OpenStudio.getOpenStudioCLI}' --bundle Gemfile --loglevel Trace test.rb"), false)
+    end
   end
 
   def test_no_bundle
-    original_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), 'no_bundle'))
-
-    puts "'#{OpenStudio::getOpenStudioCLI}' --loglevel Trace test.rb"
-    assert(system("'#{OpenStudio::getOpenStudioCLI}' --loglevel Trace test.rb"))
-
-  ensure
-    Dir.chdir(original_dir)
+    Dir.chdir(File.join(File.dirname(__FILE__), 'no_bundle')) do
+      puts "'#{OpenStudio.getOpenStudioCLI}' --loglevel Trace test.rb"
+      assert(run_command("'#{OpenStudio.getOpenStudioCLI}' --loglevel Trace test.rb"))
+    end
   end
 
   def test_bundle_default
-
     original_dir = Dir.pwd
 
-    if !defined?(OpenStudio::CLI) || !OpenStudio::CLI
-      skip("Embedded gems not available unless CLI")
-    end
+    skip('Embedded gems not available unless CLI') if !defined?(OpenStudio::CLI) || !OpenStudio::CLI
 
-    Dir.chdir(File.join(File.dirname(__FILE__), 'bundle_default'))
+    subfolder = File.join(File.dirname(__FILE__), 'bundle_default')
+    assert_path_exists(subfolder)
 
-    rm_if_exist('openstudio-gems.gemspec')
-    rm_if_exist('Gemfile')
-    rm_if_exist('Gemfile.lock')
-    rm_if_exist('./test_gems')
-    rm_if_exist('./bundle')
+    cleanup_artifacts(subfolder, remove_gemfile_and_gemspec: true)
 
-    assert(EmbeddedScripting::hasFile(':/openstudio-gems.gemspec'))
-    assert(EmbeddedScripting::hasFile(':/Gemfile'))
-    assert(EmbeddedScripting::hasFile(':/Gemfile.lock'))
+    embedded_files_to_extract = [
+      'openstudio-gems.gemspec', 'Gemfile', 'Gemfile.lock'
+    ]
+    embedded_files_to_extract.each do |fname|
+      embedded_path = ":/#{fname}"
 
-    File.open(File.join(File.dirname(__FILE__), 'bundle_default', 'openstudio-gems.gemspec'), 'w') do |f|
-      f.puts EmbeddedScripting::getFileAsString(':/openstudio-gems.gemspec')
-      begin
-        f.fsync
-      rescue
-        f.flush
-      end
-    end
-    File.open(File.join(File.dirname(__FILE__), 'bundle_default', 'Gemfile'), 'w') do |f|
-      f.puts EmbeddedScripting::getFileAsString(':/Gemfile')
-      begin
-        f.fsync
-      rescue
-        f.flush
-      end
-    end
-    File.open(File.join(File.dirname(__FILE__), 'bundle_default', 'Gemfile.lock'), 'w') do |f|
-      f.puts EmbeddedScripting::getFileAsString(':/Gemfile.lock')
-      begin
-        f.fsync
-      rescue
-        f.flush
+      assert(EmbeddedScripting.hasFile(embedded_path), "Failed to locate embedded file at #{embedded_path}")
+
+      File.open(File.join(subfolder, fname), 'w') do |f|
+        f.puts EmbeddedScripting.getFileAsString(embedded_path)
+        begin
+          f.fsync
+        rescue StandardError
+          f.flush
+        end
       end
     end
 
-    # just use embedded gems
-    assert(system("'#{OpenStudio::getOpenStudioCLI}' --loglevel Trace test.rb"))
+    Dir.chdir(subfolder) do
+      # just use embedded gems
+      assert(run_command("'#{OpenStudio.getOpenStudioCLI}' --loglevel Trace test.rb"))
 
-    # DLM: do we need to be able to pass a Gemfile without a bundle?
-    # don't pass bundle_path since we want to use embedded gems
-    #assert(system("'#{OpenStudio::getOpenStudioCLI}' --bundle './Gemfile' --loglevel Trace test.rb"))
-
-  ensure
-    Dir.chdir(original_dir)
+      # DLM: do we need to be able to pass a Gemfile without a bundle?
+      # don't pass bundle_path since we want to use embedded gems
+      # assert(run_command("'#{OpenStudio::getOpenStudioCLI}' --bundle './Gemfile' --loglevel Trace test.rb"))
+    end
   end
-
 end