Class: Terraspace::Shell

Inherits:
Object
  • Object
show all
Includes:
Util::Logging
Defined in:
lib/terraspace/shell.rb,
lib/terraspace/shell/error.rb

Defined Under Namespace

Classes: Error

Instance Method Summary collapse

Methods included from Util::Logging

#logger

Constructor Details

#initialize(mod, command, options = {}) ⇒ Shell 



7
8
9
 
# File 'lib/terraspace/shell.rb', line 7

def initialize(mod, command, options={})
  @mod, @command, @options = mod, command, options
end

Instance Method Details

#exit_status(status) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/terraspace/shell.rb', line 49

def exit_status(status)
  return if status == 0

  exit_on_fail = @options[:exit_on_fail].nil? ? true : @options[:exit_on_fail]
  if @error && @error.known?
    raise @error.instance
  elsif exit_on_fail
    logger.error "Error running command: #{@command}".color(:red)
    exit status
  end
end

#mimic_terraform_input(stdin, stdout) ⇒ Object

Terraform doesnt seem to stream the line that prompts with “Enter a value:” when using Open3.popen3 Hack around it by mimicking the “Enter a value:” prompt

Note: system does stream the prompt but using Open3.popen3 so we can capture output to save to logs.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/terraspace/shell.rb', line 65

def mimic_terraform_input(stdin, stdout)
  shown = false
  patterns = [
    "Only 'yes' will be accepted", # prompt for apply. can happen on apply
    "\e[0m\e[1mvar.", # prompts for variable input. can happen on plan or apply. looking for bold marker also in case "var." shows up somewhere else
  ]
  while out = stdout.gets
    logger.info(out) unless shown && out.include?("Enter a value:")
    shown = false if out.include?("Enter a value:") # reset shown in case of multiple input prompts

    # Sometimes stdout doesnt flush and show "Enter a value: ", so mimic it
    if patterns.any? { |pattern| out.include?(pattern) }
      print "  Enter a value: ".bright
      shown = true
      stdin.write_nonblock($stdin.gets)
    end
  end
end

#popen3(env) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/terraspace/shell.rb', line 30

def popen3(env)
  Open3.popen3(env, @command, chdir: @mod.cache_dir) do |stdin, stdout, stderr, wait_thread|
    mimic_terraform_input(stdin, stdout)
    while err = stderr.gets
      @error ||= Error.new
      @error.lines << err # aggregate all error lines
      unless @error.known?
        # Sometimes may print a "\e[31m\n" which like during dependencies fetcher init
        # suppress it so dont get a bunch of annoying "newlines"
        next if err == "\e[31m\n" && @options[:suppress_error_color]
        logger.error(err)
      end
    end

    status = wait_thread.value.exitstatus
    exit_status(status)
  end
end

#run ⇒ Object

requires @mod to be set quiet useful for RemoteState::Fetcher



13
14
15
16
17
18
 
# File 'lib/terraspace/shell.rb', line 13

def run
  msg = "=> #{@command}"
  @options[:quiet] ? logger.debug(msg) : logger.info(msg)
  return if ENV['TS_TEST']
  shell
end

#shell ⇒ Object 



20
21
22
23
24
25
26
27
28
 
# File 'lib/terraspace/shell.rb', line 20

def shell
  env = @options[:env] || {}
  env.stringify_keys!
  if @options[:shell] == "system" # terraspace console
    system(env, @command, chdir: @mod.cache_dir)
  else
    popen3(env)
  end
end