Module: MuxTf::FormatterCommon

Included in:
InitFormatter, PlanFormatter
Defined in:
lib/mux_tf/formatter_common.rb

Instance Method Summary collapse

Instance Method Details

#emit_line_helper(result, &block) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/mux_tf/formatter_common.rb', line 95

def emit_line_helper(result, &block)
  result[:level] ||= result[:stream] == :stderr ? "error" : "info"
  result[:module] ||= result[:stream]
  result[:type] ||= "unknown"

  result[:message].lstrip! if result[:message] =~ /^\n/

  if result[:message].match(/^Terraform invocation failed in (.+)/)
    result[:type] = "tf_failed"

    lines = result[:message].split("\n")
    result[:diagnostic] = {
      "summary" => "Terraform invocation failed",
      "detail" => result[:message],
      roots: [],
      extra: []
    }

    lines.each do |line|
      if line.match(/^\s+\* \[(.+)\] exit status (\d+)$/)
        result[:diagnostic][:roots] << {
          path: $LAST_MATCH_INFO[1],
          status: $LAST_MATCH_INFO[2].to_i
        }
      elsif line.match(/^\d+ errors? occurred$/)
        # noop
      else
        result[:diagnostic][:extra] << line
      end
    end

    result[:message] = "Terraform invocation failed"
  end

  block.call(result)
end

#format_validation_range(dinfo, color) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/mux_tf/formatter_common.rb', line 147

def format_validation_range(dinfo, color)
  range = dinfo["range"]

  # filename: "../../../modules/pods/jane_pod/main.tf"
  # start:
  #   line: 151
  #   column: 27
  #   byte: 6632
  # end:
  #   line: 151
  #   column: 53
  #   byte: 6658

  context_lines = 3

  lines = range["start"]["line"]..range["end"]["line"]
  columns = range["start"]["column"]..range["end"]["column"]

  # on ../../../modules/pods/jane_pod/main.tf line 151, in module "jane":
  # 151:   jane_resources_preset = var.jane_resources_presetx
  output = []
  lines_info = if lines.size == 1
                 "#{lines.first}:#{columns.first}"
               else
                 "#{lines.first}:#{columns.first} to #{lines.last}:#{columns.last}"
               end
  output << "on: #{range['filename']} line#{lines.size > 1 ? 's' : ''}: #{lines_info}"

  # TODO: in terragrunt mode, we need to somehow figure out the path to the cache root, all the paths will end up being relative to that
  if File.exist?(range["filename"])
    file_lines = File.read(range["filename"]).split("\n")
    extract_range = (([lines.first - context_lines,
                       0].max)..([lines.last + context_lines, file_lines.length - 1].min))
    file_lines.each_with_index do |line, index|
      if extract_range.cover?(index + 1)
        if lines.cover?(index + 1)
          start_col = 1
          end_col = :max
          if index + 1 == lines.first
            start_col = columns.first
          elsif index + 1 == lines.last
            start_col = columns.last
          end
          painted_line = paint_line(line, color, start_col: start_col, end_col: end_col)
          output << "#{pastel.decorate('>', color)} #{index + 1}: #{painted_line}"
        else
          output << "  #{index + 1}: #{line}"
        end
      end
    end
  elsif dinfo["snippet"]
    snippet = dinfo["snippet"]
    # {
    #   "context"=>"locals",
    #   "code"=>"        aws_iam_policy.crossplane_aws_ecr.arn",
    #   "start_line"=>72,
    #   "highlight_start_offset"=>8,
    #   "highlight_end_offset"=>41,
    #   "values"=>[]
    # }
    output << "Code:"
    output << "in #{snippet['context']}" if snippet["context"]
    line = snippet["start_line"]
    snippet["code"].split("\n").each do |l|
      output << "#{line}: #{l}"
      line += 1
    end
  end

  if dinfo["snippet"] && dinfo["snippet"]["values"]&.any?
    snippet = dinfo["snippet"]
    output << ""
    output << "Values:"
    snippet["values"].each do |value|
      output << "  #{pastel.bold(value['traversal'])} #{value['statement']}"
    end
  end

  output
end

#paint_line(line, *paint_options, start_col: 1, end_col: :max) ⇒ Object 



228
229
230
231
232
233
234
 
# File 'lib/mux_tf/formatter_common.rb', line 228

def paint_line(line, *paint_options, start_col: 1, end_col: :max)
  end_col = line.length if end_col == :max
  prefix = line[0, start_col - 1]
  suffix = line[end_col..]
  middle = line[start_col - 1..end_col - 1]
  "#{prefix}#{pastel.decorate(middle, *paint_options)}#{suffix}"
end

#parse_non_json_plan_line(raw_line) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/mux_tf/formatter_common.rb', line 70

def parse_non_json_plan_line(raw_line)
  result = {}

  if raw_line.match(/^time=(?<timestamp>[^ ]+) level=(?<level>[^ ]+) msg=(?<message>.+?)(?: prefix=\[(?<prefix>.+?)\])?\s*$/)
    result.merge!($LAST_MATCH_INFO.named_captures.symbolize_keys)
    result[:module] = "terragrunt"
    result.delete(:prefix) unless result[:prefix]
    result[:prefix] = Pathname.new(result[:prefix]).relative_path_from(Dir.getwd).to_s if result[:prefix]

    result[:merge_up] = true if result[:message].match(/^\d+ errors? occurred:$/)
  elsif raw_line.strip == ""
    result[:blank] = true
  else
    result[:message] = raw_line
    result[:merge_up] = true
  end

  # time=2023-08-25T11:44:41-07:00 level=error msg=Terraform invocation failed in /Users/piotr/Work/janepods/.terragrunt-cache/BM86IAj5tW4bZga2lXeYT8tdOKI/V0IEypKSfyl-kHfCnRNAqyX02V8/modules/event-bus prefix=[/Users/piotr/Work/janepods/accounts/eks-dev/admin/apps/kube-system-event-bus]
  # time=2023-08-25T11:44:41-07:00 level=error msg=1 error occurred:
  #         * [/Users/piotr/Work/janepods/.terragrunt-cache/BM86IAj5tW4bZga2lXeYT8tdOKI/V0IEypKSfyl-kHfCnRNAqyX02V8/modules/event-bus] exit status 2
  #
  #
  result
end

#print_tg_error_line(parsed_line) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/mux_tf/formatter_common.rb', line 236

def print_tg_error_line(parsed_line)
  parsed_line[:message].split("\n").each do |line|
    next if line.strip == ""

    parsed_message = JSON.parse(line)
    raw_prefix = "[TG ERROR] "
    prefix = pastel.red(raw_prefix)
    index = 0
    lines = parsed_message["msg"].split("\n").map { |l|
      l = if index.zero?
            prefix + l
          else
            (" " * raw_prefix.length) + l
          end
      index += 1
      l
    }
    log lines, depth: 1
  end
end

#print_unhandled_error_line(parsed_line) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/mux_tf/formatter_common.rb', line 132

def print_unhandled_error_line(parsed_line)
  if parsed_line[:diagnostic]
    color = :red
    dinfo = parsed_line[:diagnostic]

    log "#{pastel.decorate(dinfo['severity'].capitalize, color)}: #{dinfo['summary']}", depth: 3
    log dinfo["detail"].split("\n"), depth: 4 if dinfo["detail"]
    log format_validation_range(dinfo, color), depth: 4 if dinfo["range"]
  elsif parsed_line[:message] =~ /^\[reset\]/
    log pastel.red(parsed_line[:message].gsub(/^\[reset\]/, "")), depth: 3
  else
    p parsed_line
  end
end

#tf_cmd_json(cmd_call_proc, &block) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/mux_tf/formatter_common.rb', line 5

def tf_cmd_json(cmd_call_proc, &block)
  last_stderr_line = nil
  handler = proc { |(stream, raw_line)| # rubocop:disable Metrics/BlockLength
    case stream
    when :command
      log "Running command: #{raw_line.strip} ...", depth: 2
    when :stdout
      begin
        parsed_line = JSON.parse(raw_line)
        parsed_line.keys.each do |key|
          if key[0] == "@"
            parsed_line[key[1..]] = parsed_line[key]
            parsed_line.delete(key)
          end
        end
        parsed_line.symbolize_keys!
        parsed_line[:stream] = stream
        if last_stderr_line
          emit_line_helper(last_stderr_line, &block)
          last_stderr_line = nil
        end
        emit_line_helper(parsed_line, &block)
      rescue JSON::ParserError
        # eg: "[WARN] Provider spacelift-io/spacelift (registry.opentofu.org) gpg key expired, this will fail in future versions of OpenTofu\n"
        # treat the line as a normal log line
        parsed_line = {
          message: raw_line.strip,
          module: "non-json-log"
        }
        parsed_line[:level] = raw_line[0..-2].strip if raw_line.match?(/^[A-Z]+/)
        parsed_line[:stream] = stream
        emit_line_helper(parsed_line, &block)
      end
    when :stderr
      parsed_line = parse_non_json_plan_line(raw_line)
      parsed_line[:stream] = stream

      if parsed_line[:blank]
        if last_stderr_line
          emit_line_helper(last_stderr_line, &block)
          last_stderr_line = nil
        end
      elsif parsed_line[:merge_up]
        if last_stderr_line
          last_stderr_line[:message] += "\n#{parsed_line[:message]}"
        else
          # this is just a standalone message then
          parsed_line.delete(:merge_up)
          last_stderr_line = parsed_line
        end
      elsif last_stderr_line
        emit_line_helper(last_stderr_line, &block)
        last_stderr_line = parsed_line
      else
        last_stderr_line = parsed_line
      end
    end
  }

  status = cmd_call_proc.call(handler)

  emit_line_helper(last_stderr_line, &block) if last_stderr_line
  status
end