Class: MuxTf::PlanUtils

Inherits:
Object
  • Object
show all
Extended by:
TerraformHelpers, PiotrbCliUtils::Util
Includes:
Coloring
Defined in:
lib/mux_tf/plan_utils.rb

Constant Summary collapse

KNOWN_AFTER_APPLY = 
"(known after apply)"
SENSITIVE = 
"(sensitive value)"

Class Method Summary collapse

Methods included from TerraformHelpers

tf_apply, tf_force_unlock, tf_init, tf_plan, tf_show, tf_validate

Methods included from Coloring

included, #pastel

Class Method Details

.colorize_symbol(symbol) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/mux_tf/plan_utils.rb', line 112

def colorize_symbol(symbol)
  case symbol
  when "+"
    pastel.green(symbol)
  when "~"
    pastel.yellow(symbol)
  else
    warning "Unknown symbol: #{symbol.inspect}"
    symbol
  end
end

.format_value(change) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/mux_tf/plan_utils.rb', line 210

def format_value(change)
  symbol, _key, *value_arg = change

  mode = :both
  case symbol
  when "+", "-"
    mode = :first
  when "~"
    mode = :both
  else
    warning "Unknown symbol: #{symbol.inspect}"
  end

  format_value_diff(mode, value_arg)
end

.format_value_diff(mode, value_arg) ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/mux_tf/plan_utils.rb', line 187

def format_value_diff(mode, value_arg)
  case mode
  when :both
    vleft = in_display_representation(value_arg[0])
    vright = in_display_representation(value_arg[1])
    if [vleft, vright].any? { |v| v.is_a?(String) && v.include?("\n") }
      if pastel.strip(vright) == KNOWN_AFTER_APPLY
        "#{vleft} -> #{vright}".split("\n")
      else
        string_diff(pastel.strip(vleft), pastel.strip(vright))
      end
    else
      "#{vleft} -> #{vright}".split("\n")
    end
  when :right
    vright = in_display_representation(value_arg[1])
    vright.split("\n")
  when :left, :first
    vleft = in_display_representation(value_arg[0])
    vleft.split("\n")
  end
end

.get_pretty_action_and_symbol(actions) ⇒ Object

format_value_diff(mode, value_arg)

when Hash
  if value_arg.keys.all? { |k| k.is_a?(Integer) }
    # assuming its a hash notation of array keys changes
    value_arg.keys.sort.map { |k| "[#{k}] #{format_value(value_arg[k], symbol)[0]}" }
  else
    [value_arg.inspect]
  end
else
  [value_arg.inspect]
end

end



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/mux_tf/plan_utils.rb', line 252

def get_pretty_action_and_symbol(actions)
  case actions
  when ["update"]
    pretty_action = "updated in-place"
    symbol = "~"
  when ["create"]
    pretty_action = "created"
    symbol = "+"
  else
    warning "Unknown action: #{actions.inspect}"
    pretty_action = actions.inspect
    symbol = "?"
  end

  [pretty_action, symbol]
end

.in_display_representation(value) ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize, Metrics/MethodLength



146
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
 
# File 'lib/mux_tf/plan_utils.rb', line 146

def in_display_representation(value) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize, Metrics/MethodLength
  if valid_json?(value)
    json_body = JSON.pretty_generate(JSON.parse(value))
    wrap(json_body, prefix: "json(", suffix: ")", color: :gray)
  elsif valid_yaml?(value)
    yaml_body = YAML.dump(YAML.safe_load(value))
    yaml_body.gsub!(/^---\n/, "")
    wrap(yaml_body, prefix: "yaml(", suffix: ")", newline: true, color: :gray, indent: 2)
  elsif [KNOWN_AFTER_APPLY, SENSITIVE].include?(value)
    pastel.gray(value)
  elsif value.is_a?(String) && value.include?("\n")
    wrap(value, prefix: "<<- EOT", suffix: "EOT", newline: true, color: :gray)
  # elsif value.is_a?(Array)
  #   body = value.ai.rstrip
  #   wrap(body, prefix: "", suffix: "", newline: false, color: :gray, indent: 2)
  elsif value.is_a?(Array)
    max_key = value.length.to_s.length
    body = "["
    value.each_with_index do |v, _index|
      # body += "\n  #{in_display_representation(index).ljust(max_key)}: "
      body += "\n"
      body += indent(in_display_representation(v), indent: 2, first_line_indent: 2)
      body += ","
    end
    body += "\n]"
    body
  elsif value.is_a?(Hash)
    max_key = value.keys.map(&:length).max
    body = "{"
    value.each do |k, v|
      body += "\n  #{in_display_representation(k).ljust(max_key)}: "
      body += indent(in_display_representation(v), indent: 2, first_line_indent: 0)
      body += ","
    end
    body += "\n}"
    body
  else
    value.inspect
  end
end

.indent(text, indent: 2, first_line_indent: 0) ⇒ Object 



136
137
138
139
140
141
142
143
144
 
# File 'lib/mux_tf/plan_utils.rb', line 136

def indent(text, indent: 2, first_line_indent: 0)
  text.split("\n").map.with_index { |line, index|
    if index.zero?
      "#{' ' * first_line_indent}#{line}"
    else
      "#{' ' * indent}#{line}"
    end
  }.join("\n")
end

.string_diff(value1, value2) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/mux_tf/plan_utils.rb', line 79

def string_diff(value1, value2)
  value1 = value1.split("\n")
  value2 = value2.split("\n")

  output = []
  diffs = Diff::LCS.diff value1, value2
  diffs.each do |diff|
    hunk = Diff::LCS::Hunk.new(value1, value2, diff, 5, 0)
    diff_lines = hunk.diff(:unified).split("\n")
    # diff_lines.shift # remove the first line
    output += diff_lines.map { |line| " #{line}" }
  end
  output
end

.text_version_of_plan_show(plan_filename) ⇒ Object 



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/mux_tf/plan_utils.rb', line 330

def text_version_of_plan_show(plan_filename)
  result = tf_show(plan_filename, capture: true, json: true)
  data = result.parsed_output

  # Plan: 0 to add, 1 to change, 0 to destroy.

  output = []

  output << "Terraform will perform the following actions:"

  if data["resource_drift"]
    output << ""
    output << "Resource Drift:"
    data["resource_drift"].each do |resource|
      output << tf_show_json_resource(resource)
    end
  end

  if data["resource_changes"]
    output << ""
    output << "Resource Changes:"
    data["resource_changes"].each do |resource|
      output << tf_show_json_resource(resource) if resource["change"]["actions"] != ["no-op"]
    end
  end

  output.join("\n")
end

.tf_show_json_resource(resource) ⇒ Object

Example

# kubectl_manifest.crossplane-provider-controller-config["aws-ecr"] will be updated in-place
~ resource "kubectl_manifest" "crossplane-provider-controller-config" {
      id                      = "/apis/pkg.crossplane.io/v1alpha1/controllerconfigs/aws-ecr-config"
      name                    = "aws-ecr-config"
    ~ yaml_body               = (sensitive value)
    ~ yaml_body_parsed        = <<-EOT
          apiVersion: pkg.crossplane.io/v1alpha1
          kind: ControllerConfig
          metadata:
            annotations:
        -     eks.amazonaws.com/role-arn: <AWS_PROVIDER_ARN> <<- irsa
        +     eks.amazonaws.com/role-arn: arn:aws:iam::852088082597:role/admin-crossplane-provider-aws-ecr
            name: aws-ecr-config
          spec:
            podSecurityContext:
              fsGroup: 2000
      EOT
      # (12 unchanged attributes hidden)
  }



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/mux_tf/plan_utils.rb', line 289

def tf_show_json_resource(resource) # rubocop:disable Metrics/AbcSize
  pretty_action, symbol = get_pretty_action_and_symbol(resource["change"]["actions"])

  output = []

  global_indent = " " * 2

  output << ""
  output << "#{global_indent}#{pastel.bold("# #{resource['address']}")} will be #{pretty_action}"
  output << "#{global_indent}#{colorize_symbol(symbol)} resource \"#{resource['type']}\" \"#{resource['name']}\" {"
  diff = tf_show_json_resource_diff(resource)
  max_diff_key_length = diff.map { |change| change[1].length }.max
  diff.each do |change|
    change_symbol, key, *_values = change
    prefix = format("#{global_indent}  #{colorize_symbol(change_symbol)} %s = ", key.ljust(max_diff_key_length))
    blank_prefix = " " * pastel.strip(prefix).length
    format_value(change).each_with_index do |line, index|
      output << if index.zero?
                  "#{prefix}#{line}"
                else
                  "#{blank_prefix}#{line}"
                end
    end
  end
  # max_diff_key_length = diff.keys.map(&:length).max
  # diff.each do |key, value|
  #   prefix = format("#{global_indent}  #{colorize_symbol(symbol)} %s = ", key.ljust(max_diff_key_length))
  #   blank_prefix = " " * pastel.strip(prefix).length
  #   format_value(value, symbol).each_with_index do |line, index|
  #     output << if index.zero?
  #                 "#{prefix}#{line}"
  #               else
  #                 "#{blank_prefix}#{line}"
  #               end
  #   end
  # end
  output << "#{global_indent}}"

  output.join("\n")
end

.tf_show_json_resource_diff(resource) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/mux_tf/plan_utils.rb', line 62

def tf_show_json_resource_diff(resource)
  before = resource["change"]["before"] || {}
  after = resource["change"]["after"] || {}

  update_placeholders(after, resource["change"]["after_unknown"], KNOWN_AFTER_APPLY)

  before = before.sort.to_h
  after = after.sort.to_h

  update_placeholders(before, resource["change"]["before_sensitive"], SENSITIVE)
  update_placeholders(after, resource["change"]["after_sensitive"], SENSITIVE)

  # hash_diff = HashDiff::Comparison.new(before, after)
  # similarity: 0.0, numeric_tolerance: 1, array_path: true,
  Hashdiff.diff(before, after, use_lcs: false)
end

.update_placeholders(dst, src, placeholder) ⇒ Object

rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength



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
 
# File 'lib/mux_tf/plan_utils.rb', line 24

def update_placeholders(dst, src, placeholder) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
  return unless src

  case src
  when Array
    src.each_with_index do |v, index|
      case v
      when TrueClass
        dst[index] = placeholder
      when FalseClass
        # do nothing
      when Hash
        dst[index] ||= {}
        update_placeholders(dst[index], v, placeholder)
      else
        warning "Unknown array value (index: #{index}) for sensitive: #{v.inspect}"
      end
    end
  when Hash
    src.each do |key, value|
      case value
      when TrueClass
        dst[key] = placeholder
      when FalseClass
        # do nothing
      when Array
        dst[key] ||= []
        update_placeholders(dst[key], value, placeholder)
      when Hash
        dst[key] ||= {}
        update_placeholders(dst[key], value, placeholder)
      else
        warning "Unknown value (key: #{key}) for sensitive: #{value.inspect}"
      end
    end
  end
end

.valid_json?(value) ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
97
98
 
# File 'lib/mux_tf/plan_utils.rb', line 94

def valid_json?(value)
  value.is_a?(String) && !!JSON.parse(value)
rescue JSON::ParserError
  false
end

.valid_yaml?(value) ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/mux_tf/plan_utils.rb', line 100

def valid_yaml?(value)
  if value.is_a?(String)
    parsed = YAML.safe_load(value)
    parsed.is_a?(Hash) || parsed.is_a?(Array)
  else
    false
  end
rescue Psych::SyntaxError => e
  ap e
  false
end

.warning(message, binding_arg: binding) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
 
# File 'lib/mux_tf/plan_utils.rb', line 13

def warning(message, binding_arg: binding)
  stack = binding_arg.send(:caller)
  stack_line = stack[0].match(/^(?<path>.+):(?<ln>\d+):in `(?<method>.+)'$/).named_captures
  stack_line["path"].gsub!(MuxTf::ROOT, pastel.gray("{mux_tf}"))
  msg = [
    "#{pastel.orange('WARNING')}: #{message}",
    "at #{pastel.cyan(stack_line['path'])}:#{pastel.white(stack_line['ln'])}:in `#{pastel.cyan(stack_line['method'])}'"
  ]
  puts msg.join(" - ")
end

.wrap(text, prefix: "(", suffix: ")", newline: false, color: nil, indent: 0) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/mux_tf/plan_utils.rb', line 124

def wrap(text, prefix: "(", suffix: ")", newline: false, color: nil, indent: 0)
  result = String.new
  result << (color ? pastel.decorate(prefix, color) : prefix)
  result << "\n" if newline
  result << text.split("\n").map { |line|
    "#{' ' * indent}#{line}"
  }.join("\n")
  result << "\n" if newline
  result << (color ? pastel.decorate(suffix, color) : suffix)
  result
end