MuranoCLI 3.2.1.pre.beta.6 → 3.2.1.pre.beta.7

data/spec/cmd_common.rb

@@ -1,507 +0,0 @@
-# Copyright © 2016-2017 Exosite LLC. All Rights Reserved
-# License: PROPRIETARY. See LICENSE.txt.
-# frozen_string_literal: true
-
-# vim:tw=0:ts=2:sw=2:et:ai
-# Unauthorized copying of this file is strictly prohibited.
-
-require 'highline'
-# Set HighLine's $terminal global.
-require 'highline/import'
-require 'os'
-require 'pathname'
-require 'rainbow'
-require 'shellwords'
-require 'time'
-require 'timeout'
-require 'tmpdir'
-require 'webmock/rspec'
-
-require 'MrMurano/progress'
-require 'MrMurano/Config'
-require 'MrMurano/HttpAuthed'
-
-require 'webmock_snapshot'
-
-# Prevent Commander from registering its at_exit hook.
-# - Also print warning if spec exits, which rspec doesn't see as wrong.
-# - Note that this comes before importing Commander.
-$exited_abnormally = false
-
-$catpured_io = false
-
-def capture_stdio
-  return if $catpured_io
-  $murcli_wasin = $stdin # (lb): Could probably just use STDIN and skip this global.
-  $murcli_wasout = $stdout
-  $murcli_waserr = $stderr
-  $murcli_wasterm = $terminal
-  $catpured_io = true
-end
-capture_stdio
-
-def restore_stdio
-  return unless $catpured_io
-  $stdin = $murcli_wasin
-  $stdout = $murcli_wasout
-  $stderr = $murcli_waserr
-  $terminal = $murcli_wasterm
-  $murcli_wasin = nil
-  $murcli_wasout = nil
-  $murcli_waserr = nil
-  $murcli_wasterm = nil
-  $catpured_io = false
-end
-
-at_exit do
-  if $exited_abnormally
-    restore_stdio
-    warn('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!')
-    warn(%(              ____                 ))
-    warn(%{            ,%(   Y`.              })
-    warn(%(           /        \              ))
-    warn(%(           \ ()  () /              ))
-    warn(%{            `. /\ ,%(              })
-    warn(%(        8====| "" |====8           ))
-    warn(%(             `LLLU'                ))
-    warn(%(                                   ))
-    warn('¡Unexpected spec exit killed rspec!')
-    warn('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!')
-    # DEVs: If you see this message, the last test exited unexpectedly.
-    warn('')
-    warn("Died on: #{$exited_abnormally}")
-    warn('')
-  end
-end
-alias original_at_exit at_exit unless defined?(original_at_exit)
-
-def at_exit(*args, &block)
-  #original_at_exit *args, &block
-  # pass!
-end
-
-require 'MrMurano/Commander-Entry'
-
-module Commander
-  class Command
-    attr_writer :when_called
-    #def when_called=(args)
-    #  @when_called = args
-    #end
-
-    def peek_when_called
-      @when_called
-    end
-  end
-
-  class Runner
-    def force_args(args)
-      @args = args
-    end
-  end
-end
-
-RSpec.shared_context 'CI_CMD' do
-  # capcmd makes an Open3-ready `murano` command from a list of args.
-  def capcmd(*args)
-    args = [args] unless args.is_a? Array
-    args.flatten!
-    testdir = File.realpath(@testdir.to_s)
-    if ENV['CI_MR_EXE'].nil?
-      args[0] = File.join(testdir, 'bin', args[0])
-      args.unshift('ruby', "-I#{File.join(testdir, 'lib')}")
-    else
-      args[0] = File.join(testdir, (args[0] + '.exe'))
-    end
-    args.push '--trace'
-    args.push '-c', 'fullerror'
-    # The spinner output would make it hard to write expects().
-    args.push '--no-progress'
-
-    # FIXME: (lb): Is this necessary? Commenting out for now; will delete later.
-    ## Save the token.
-    #args.push '--cache'
-
-    if Gem.win_platform?
-      cmd = args.map do |i|
-        case i
-        when /[ ]/
-          %("#{i}")
-        when /[\*#]/
-          i.gsub(/([\*#])/, '^\1')
-        else
-          i
-        end
-      end.join(' ')
-    else
-      cmd = Shellwords.join(args)
-    end
-    #pp cmd
-    cmd
-  end
-
-  # *** Utility fcns: symlinks.
-
-  # Makes a symlink to the /tmp project dir.
-  def mk_symlink
-    # Make it easy to debug tests, e.g., add breakpoint before capcmd('murano', ...)
-    # run test, then open another terminal window and `cd /tmp/murcli-test`.
-    # NOTE: When run on Jenkins, Dir.tmpdir() returns the path to the project directory!
-    #   Since this is for DEVs only, we can hack around this.
-    tmpdir = Dir.tmpdir()
-    return unless tmpdir == '/tmp'
-    @dev_symlink = File.join(tmpdir, 'murcli-test')
-    FileUtils.rm(@dev_symlink, force: true)
-    begin
-      FileUtils.ln_s(Dir.pwd, @dev_symlink)
-    rescue NotImplementedError => err
-      # This happens on Windows...
-      require 'rbconfig'
-      # Check the platform, e.g., "linux-gnu", or other.
-      #is_windows = (
-      #  RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-      #)
-      unless OS.windows?
-        warn(
-          'Unexpected: ln_s failed on non-Windows machine / ' \
-          "host_os: #{RbConfig::CONFIG['host_os']} / err: #{err}"
-        )
-      end
-    end
-  end
-
-  # Removes the /tmp project directory symlink.
-  def rm_symlink
-    FileUtils.rm(@dev_symlink, force: true) if defined?(@dev_symlink)
-  end
-
-  # *** Utility fcns: Murano Solutions management: create/delete/expunge.
-
-  def murano_solutions_expunge_yes
-    out, err = murano_command_safe('solutions expunge', '-y')
-    expect(out).to \
-      eq('').or \
-        eq("No solutions found\n").or \
-          match(/^Deleted [\d]+ solutions?/)
-    expect(MrMurano::Progress.strip_color(err)).to eq('').or eq("No solutions found\n")
-  end
-
-  def project_up(skip_link: false)
-    # Preemptive clean up!
-    murano_solutions_expunge_yes if defined?(PRE_EXPUNGE) && PRE_EXPUNGE
-
-    @proj_name_prod = @snapshotter.resolve_var(
-      'product.name', rname('MurCLITestProd')
-    )
-    # NOTE: Do not use alias, which resolves to base command, but without options.
-    #   E.g., use 'solution create', ...; and not 'product create'.
-    out, err = murano_command_run(
-      'solution create', '--type', 'product', @proj_name_prod, '--save',
-    )
-    expect(err).to eq('')
-    expect(out.chomp).to match(/^[a-zA-Z0-9]+$/)
-
-    @proj_name_appy = @snapshotter.resolve_var(
-      'application.name', rname('MurCLITestAppy')
-    )
-    out, err = murano_command_run(
-      'solution create', '--type', 'application', @proj_name_appy, '--save',
-    )
-    expect(err).to eq('')
-    soln_id = out
-    expect(soln_id.chomp).to match(/^[a-zA-Z0-9]+$/)
-
-    project_up_link unless skip_link
-  end
-
-  def project_up_link
-    out, err = murano_command_run('assign set')
-    olines = out.lines
-    expect(strip_fancy(olines[0])).to eq(
-      "Linked '#{@proj_name_prod}' to '#{@proj_name_appy}'\n"
-    )
-    expect(olines[1]).to eq("Created default event handler\n")
-    expect(err).to eq('')
-  end
-
-  def project_down
-    return if defined?(PRE_EXPUNGE) && PRE_EXPUNGE
-
-    out, err = murano_command_run('solution delete', @proj_name_appy, '-y')
-    expect(out).to eq('')
-    expect(err).to eq('')
-
-    out, err = murano_command_run('solution delete', @proj_name_prod, '-y')
-    expect(out).to eq('')
-    expect(err).to eq('')
-  end
-
-  # Utility fcns: Strings.
-
-  # rname makes a random Murano-acceptable Solution name.
-  def rname(name='')
-    #"#{name}-#{Random.new.rand.hash.abs.to_s(16)}"
-    # MUR-2454: Product name may only contain letters and numbers.
-    #"#{name}#{Random.new.rand.hash.abs.to_s(16)}"
-    # MUR-XXXX: Product name must be lowercase.
-    # 2017-06-01: From [cr]: "I'll be having bizapi convert to lower case
-    #  in the short term, and pegasus is updating to allow upper case."
-    #  LATER: Remove .downcase once PAAS fixed.
-    "#{name.downcase}#{Random.new.rand.hash.abs.to_s(16)}"
-  end
-
-  def strip_fancy(str)
-    # Windows has a complaint about the fancy quotes if you don't encode!, which is
-    #
-    #   expected: "Linked \u2018syncdowntestprd1e8b4034\u2019
-    #               to \u2018syncdowntestapp23d5135b\u2019\n"
-    #        got: "Linked \xE2\x80\x98syncdowntestprd1e8b4034\xE2\x80\x99
-    #               to \xE2\x80\x98syncdowntestapp23d5135b\xE2\x80\x99\n"
-    #
-    # or, to put it another way,
-    #
-    #     -Linked ?syncdowntestprd1e8b4034? to ?syncdowntestapp23d5135b?
-    #     +Linked ΓÇÿsyncdowntestprd1e8b4034ΓÇÖ to ΓÇÿsyncdowntestapp23d5135bΓÇÖ
-    #
-    # which we can solve with an encode call. (Or but using norm quotes.)
-    str.nil? && '' ||
-      str.encode!(
-        'UTF-8', 'UTF-8'
-      ).tr(%(‘), %(')).tr(%(’), %('))
-  end
-
-  # *** rb-commander goodies
-
-  def murano_command_run(cmd, *args)
-    murano_command_runner(cmd, *args)
-  end
-
-  def murano_command_run_gentle(cmd, *args)
-    murano_command_runner(cmd, *args, skip_cfg: true)
-  end
-
-  def murano_command_exits(cmd, *args)
-    murano_command_runner(cmd, *args, wont_run: true)
-  end
-
-  def murano_command_safe(cmd, *args)
-    murano_command_runner(cmd, *args, wont_run: :unknown)
-  end
-
-  def murano_command_wont_parse(cmd, *args)
-    murano_command_runner(cmd, *args, wont_parse: true)
-  end
-
-  def murano_command_runner(
-    cmd, *args, wont_run: false, wont_parse: false, skip_cfg: false, stdin_data: nil
-  )
-    # DEVS: If you want to set a breakpoint within a command under test,
-    # you need to break into byebug before stdio is redirected.
-    # Just break, then [c]ontinue, and break again within the test,
-    # and then interactive debugging will work. I.e., uncomment this:
-    #
-    #   require 'byebug' ; byebug if true
-    #
-    # Though really you just need to break once:
-    #
-    #   require 'byebug' ; byebug if !defined?(@@broken)
-    #   @@broken = true
-
-    capture_stdio
-    tmpout = StringIO.new
-    tmperr = StringIO.new
-
-    unless stdin_data.nil?
-      $stdin = StringIO.new
-      $stdin.print(stdin_data)
-      $stdin.rewind
-    end
-
-    # Commander's `say` calls HighLine's $terminal.say, so redirect that, too.
-    hline = HighLine.new($stdin, tmpout)
-    $terminal = hline
-    # DEVs: If you set a byebug break after this point, the byebug will
-    #   show when the code breaks, but you'll see no echo or output. So
-    #   comment this code out if you're debugging.
-    $stdout = tmpout
-    $stderr = tmperr
-
-    $exited_abnormally = "#{cmd} #{args.join(' ')}"
-
-    MrMurano::HttpAuthed.instance.credentials_reset
-
-    # When Commander is loaded, it sets an at_exit hook, which we monkey
-    # patch in ReCommander. Since Config.validate_cmd is called before
-    # at_exit, it uses runner.command_exit to tell ReCommander's at_exit
-    # monkey patch not to call Commander.run!. Via rspec, we don't use the
-    # at_exit hook, or ReCommander.
-    unless skip_cfg
-      $cfg = MrMurano::Config.new(::Commander::Runner.instance)
-      $cfg.load
-      $cfg['tool.no-progress'] = true
-
-      # In case the test runner installed a project file.
-      $project = MrMurano::ProjectFile.new
-      $project.load
-    end
-    $cfg.validate_cmd
-
-    runner = ::Commander::Runner.instance
-    unless defined?(runner.command_exit) && runner.command_exit
-      # (lb): Commander's at_exit hook calls runner.run! which runs the
-      # command that was determined with Commander was loaded. I tried a
-      # few different ways to reset Runner.instance, but nothing worked;
-      # our best bet is to just call the command directly.
-      the_cmd = command(cmd.to_sym)
-      raise "Specified command not recognized! “#{cmd}”" if the_cmd.nil?
-      when_called = the_cmd.peek_when_called.dup
-
-      runner.force_args(args.dup)
-      #runner.parse_global_options
-      if wont_parse
-        expect { runner.old_parse_global_options }.to raise_error(SystemExit)
-      else
-        runner.old_parse_global_options
-        runner.remove_global_options runner.options, args
-        if wont_run == true
-          expect { the_cmd.run(*args) }.to raise_error(SystemExit)
-        else
-          begin
-            the_cmd.run(*args)
-          rescue StandardError => _err
-            # This is unexpected. Leave $exited_abnormally so we warn the user.
-            restore_stdio
-            raise
-          rescue SystemExit => _err
-            if wont_run != :unknown
-              # This happens if the CLI calls exit, but the test runner was not
-              # expecting it to exit (because otherwise the test runner would
-              # have called this method with wont_run: true). So long as our
-              # $exited_abnormally works as intended, we have nothing to do.
-              restore_stdio
-              unless tmpout.string.empty?
-                puts "ERROR: Unexpected `exit`: out: #{tmpout.string}"
-              end
-              unless tmperr.string.empty?
-                puts "ERROR: Unexpected `exit`: err: #{tmperr.string}"
-              end
-              if tmpout.string.empty? && tmperr.string.empty?
-                puts 'ERROR: Unexpected `exit`: but no stdout nor stderr message'
-              end
-              raise
-            end
-          end
-        end
-      end
-
-      # Reset proxy_options otherwise Commander::Command.call
-      # uses them the next time this command is called.
-      the_cmd.proxy_options = []
-      the_cmd.when_called = when_called
-    end
-    runner.command_exit = nil
-
-    $exited_abnormally = false
-    # Ruby provides std i/o constants, so we could do this:
-    #   $stdout, $stderr = STDOUT, STDERR
-    restore_stdio
-
-    HighLine.use_color = true
-    Rainbow.enabled = true
-
-    [
-      MrMurano::Progress.strip_color(tmpout.string),
-      MrMurano::Progress.strip_color(tmperr.string),
-    ]
-  end
-
-  def cmd_verify_help(cmd_name)
-    stdout, stderr = murano_command_run(cmd_name)
-    expect(stdout).to start_with(
-      "  NAME:\n\n    murano #{cmd_name}\n\n  DESCRIPTION:\n\n    "
-    )
-    expect(stderr).to eq('')
-  end
-
-  # *** before() and around()
-
-  before(:context) do
-    @timeit_time0 = Time.now
-  end
-
-  after(:context) do
-    elapsed_secs = Time.now - @timeit_time0
-    puts "\n  .. elapsed: #{elapsed_secs.round(2)} secs."
-  end
-
-  # Before: Load Config.
-  before(:example) do |example|
-    $cfg = MrMurano::Config.new
-    $cfg.load
-
-    # Manage snapshot testing.
-    @snapshotter = MrMurano::Snapshot::WebMock.instance
-    @snapshotter.reset(example)
-    @snapshotter.establish_mocks
-  end
-
-  after(:example) do
-    @snapshotter.terminate_mocks
-  end
-
-  # Around: Make project dir under /tmp.
-  around(:example) do |example|
-    # Load the byebug library now, before changing directories.
-    # This sets Setting[:histfile]. Within byebug, try `show histfile`.
-    # Make sure this is set now, otherwise, byebug crashes, e.g.,
-    #   <Errno::ENOENT: No such file or directory @ rb_sysopen -
-    #       /tmp/d20170830-10087-h7tq6a/project/.byebug_history>
-    # This happens if the first call to byebug is after the chdir.
-    # Byebug creates the histfile in the tmp dir. So the next time
-    # the method containing `byebug` is called, it's from within a
-    # different tmp dir, and the old tmp dir has been removed. So
-    # byebug crashes trying to access the old, missing histfile.
-    require 'byebug/settings/histfile'
-    _ignored = ::Byebug::HistfileSetting::DEFAULT
-
-    $exited_abnormally = example.example.to_s
-
-    @testdir = Pathname.new(Dir.pwd).realpath
-    Dir.mktmpdir do |hdir|
-      saved_home = Dir.home
-      ENV['HOME'] = hdir
-      Dir.chdir(hdir) do
-        Dir.mkdir('.murano')
-
-        Dir.chdir('.murano') do
-          begin
-            FileUtils.ln_s(File.join(saved_home, '.murano', 'tokens'), 'tokens')
-          rescue NotImplementedError => err
-            require 'rbconfig'
-            unless OS.windows?
-              warn(
-                'Unexpected: ln_s failed on non-Windows machine / ' \
-                "host_os: #{RbConfig::CONFIG['host_os']} / err: #{err}"
-              )
-            end
-          end
-        end
-
-        @tmpdir = File.join(hdir, 'project')
-        Dir.mkdir(@tmpdir)
-        Dir.chdir(@tmpdir) do
-          mk_symlink
-          # Timeout after 300 secs/5 mins.
-          Timeout.timeout(300) do
-            example.run
-          end
-          rm_symlink
-        end
-      end
-      ENV['HOME'] = saved_home
-    end
-
-    $exited_abnormally = false
-  end
-end
-