terraform_landscape 0.2.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98a71818264c2488766b447e16abbd2be9eb743ddd8faf717df0b0652742ea36
-  data.tar.gz: 883c3799319b75efb960a6e185897a581d2362e4499c0f442dcf155669221d04
+  metadata.gz: d67a499f9c9745e1444129aee8abdbbead348f66374080896e8dc15fd411e90c
+  data.tar.gz: 9a54df826e4075b9faee8fe9de305f95265c480eafaa955a01470945073e073b
 SHA512:
-  metadata.gz: d49d670112420768a487c6f69a009923a75607d8cfcc58beffa8824c96aec6ddd931a8c71b2281a69ea300558be4b05ce2058fb57b0ac1df101dac3e7fee0104
-  data.tar.gz: 42b90645cf8ab30928c2257afc11ebf943afe1216e9983f14c652808e8d22cd0a7b3cc9e988fa384b0158003696ed60b985b0b18959b7c2b80ff99497b574382
+  metadata.gz: 3bd6351fd9ad2847f496546032d42d20dd2676865ba0dca5146a44ebf921815d70cb93ae550fb8ae67f97690c28e9d9206fc7fa5ddf2fa281ddd1c8e5e532399
+  data.tar.gz: 589ca816d9f1ba3144ffc1e22d43fde6e846732ffdef0f327d068a06f978deb6c4f02329cc44bab4c94da50b7baa27f8d8c2e8e334ed3bed9dfb94ae3156a66c

data/grammar/terraform_plan.treetop

@@ -38,7 +38,7 @@ grammar TerraformPlan
   end
 
   rule resource_header
-    _? change:('~' / '-/+' / '-' / '+' / '<=') _ type:[a-zA-Z0-9_-]+ '.' name:[\S]+ _ '(' reason1:[^)]+ ')' _ '(' reason2:[^)]+ ')' {
+    ws? change:('~' / '-/+' / '-' / '+' / '<=') ws type:[a-zA-Z0-9_-]+ '.' name:[\S]+ ws '(' reason1:[^)]+ ')' ws '(' reason2:[^)]+ ')' {
       def to_ast
         {
           change: change.text_value.to_sym,
@@ -50,7 +50,7 @@ grammar TerraformPlan
       end
     }
     /
-    _? change:('~' / '-/+' / '-' / '+' / '<=') _ type:[a-zA-Z0-9_-]+ '.' name:[\S]+ _ '(' reason:[^)]+ ')' {
+    ws? change:('~' / '-/+' / '-' / '+' / '<=') ws type:[a-zA-Z0-9_-]+ '.' name:[\S]+ ws '(' reason:[^)]+ ')' {
       def to_ast
         {
           change: change.text_value.to_sym,
@@ -61,7 +61,7 @@ grammar TerraformPlan
       end
     }
     /
-    _? change:('~' / '-/+' / '-' / '+' / '<=') _ type:[a-zA-Z0-9_-]+ '.' name:[\S]+ {
+    ws? change:('~' / '-/+' / '-' / '+' / '<=') ws type:[a-zA-Z0-9_-]+ '.' name:[\S]+ {
       def to_ast
         {
           change: change.text_value.to_sym,
@@ -73,13 +73,13 @@ grammar TerraformPlan
   end
 
   rule attribute_list
-    _ item:attribute "\n" attrs:attribute_list {
+    ws item:attribute "\n" attrs:attribute_list {
       def to_ast
         item.to_ast.merge(attrs.to_ast)
       end
     }
     /
-    _ item:attribute {
+    ws item:attribute {
       def to_ast
         item.to_ast
       end
@@ -87,7 +87,7 @@ grammar TerraformPlan
   end
 
   rule attribute
-    attribute_name:(!': ' .)* ':' _? attribute_value:[^\n]+ {
+    attribute_name:(!': ' .)* ':' ws? attribute_value:[^\n]+ {
       def to_ast
         { attribute_name.text_value => sanitize_value_and_reason }
       end
@@ -115,7 +115,7 @@ grammar TerraformPlan
     }
   end
 
-  rule _
+  rule ws
     [ ]+
   end
 end

data/lib/terraform_landscape/cli.rb

@@ -30,9 +30,14 @@ module TerraformLandscape
 
     def define_commands
       command :print do |c|
-        c.action do
-          print
+        c.action do |_args, options|
+          print(options.__hash__)
         end
+        c.description = <<-TXT
+  Pretty-prints your Terraform plan output.
+
+  If an error occurs while parsing the Terraform output, print will automatically fall back on the original Terraform output. To view the stack trace instead, provide the global --trace option.
+        TXT
       end
 
       global_option '--no-color', 'Do not output any color' do
@@ -43,9 +48,9 @@ module TerraformLandscape
       default_command :print
     end
 
-    def print
+    def print(options)
       printer = Printer.new(@output)
-      printer.process_stream(STDIN)
+      printer.process_stream(ARGF, options)
     end
   end
 end

data/lib/terraform_landscape/constants.rb

@@ -6,4 +6,7 @@ module TerraformLandscape
 
   REPO_URL = 'https://github.com/coinbase/terraform_landscape'.freeze
   BUG_REPORT_URL = "#{REPO_URL}/issues".freeze
+
+  FALLBACK_MESSAGE = 'Terraform Landscape: a parsing error occured.' \
+                     ' Falling back to original Terraform output...'.freeze
 end

data/lib/terraform_landscape/printer.rb

@@ -1,16 +1,17 @@
 require 'stringio'
 
 module TerraformLandscape
-  # Takes output from Terraform executable nad outputs it in a prettified
+  # Takes output from Terraform executable and outputs it in a prettified
   # format.
   class Printer
     def initialize(output)
       @output = output
     end
 
-    def process_stream(io) # rubocop:disable Metrics/MethodLength
+    def process_stream(io, options = {}) # rubocop:disable Metrics/MethodLength
       apply = nil
       buffer = StringIO.new
+      original_tf_output = StringIO.new
       begin
         block_size = 1024
 
@@ -21,7 +22,9 @@ module TerraformLandscape
 
           readable_fds.each do |f|
             begin
-              buffer << strip_ansi(f.read_nonblock(block_size))
+              new_output = f.read_nonblock(block_size)
+              original_tf_output << new_output
+              buffer << strip_ansi(new_output)
             rescue IO::WaitReadable # rubocop:disable Lint/HandleExceptions
               # Ignore; we'll call IO.select again
             rescue EOFError
@@ -34,9 +37,17 @@ module TerraformLandscape
                                                     replace: ''))
           done = true if apply
         end
-        process_string(buffer.string)
 
-        @output.print apply if apply
+        begin
+          process_string(buffer.string)
+          @output.print apply if apply
+        rescue ParseError, TerraformPlan::ParseError => e
+          raise e if options[:trace]
+
+          @output.warning FALLBACK_MESSAGE
+          @output.print original_tf_output.string
+        end
+
         @output.write_from(io)
       ensure
         io.close
@@ -46,10 +57,15 @@ module TerraformLandscape
     def process_string(plan_output) # rubocop:disable Metrics/MethodLength
       scrubbed_output = strip_ansi(plan_output)
 
+      # Our grammar assumes output with Unix line endings
+      scrubbed_output.gsub!("\r\n", "\n")
+
       # Remove initialization messages like
       # "- Downloading plugin for provider "aws" (1.1.0)..."
+      # "- module.base_network"
       # as these break the parser which thinks "-" is a resource deletion
       scrubbed_output.gsub!(/^- .*\.\.\.$/, '')
+      scrubbed_output.gsub!(/^- module\..*$/, '')
 
       # Remove separation lines that appear after refreshing state
       scrubbed_output.gsub!(/^-+$/, '')

data/lib/terraform_landscape/terraform_plan.rb

@@ -2,7 +2,6 @@ require 'colorize'
 require 'diffy'
 require 'json'
 require 'treetop'
-require 'string_undump'
 
 ########################################################################
 # Represents the parsed output of `terraform plan`.
@@ -25,6 +24,10 @@ class TerraformLandscape::TerraformPlan # rubocop:disable Metrics/ClassLength
 
   DEFAULT_DIFF_CONTEXT_LINES = 5
 
+  UNICODE_ESCAPER = proc { |s|
+    format('\u%04X', s.codepoints[0])
+  }
+
   class ParseError < StandardError; end
 
   class << self
@@ -103,6 +106,10 @@ class TerraformLandscape::TerraformPlan # rubocop:disable Metrics/ClassLength
     longest_name_length + 8
   end
 
+  def undump(value)
+    value.encode('ASCII', fallback: UNICODE_ESCAPER).undump
+  end
+
   def json?(value)
     ['{', '['].include?(value.to_s[0]) &&
       (JSON.parse(value) rescue nil) # rubocop:disable Style/RescueModifier
@@ -179,8 +186,8 @@ class TerraformLandscape::TerraformPlan # rubocop:disable Metrics/ClassLength
   )
     # Since the attribute line is always of the form "old value" => "new value"
     attribute_value =~ /^ *(".*") *=> *(".*") *$/
-    old = Regexp.last_match[1].undump
-    new = Regexp.last_match[2].undump
+    old = undump(Regexp.last_match[1])
+    new = undump(Regexp.last_match[2])
 
     return if old == new && new != '<sensitive>' # Don't show unchanged attributes
 
@@ -219,7 +226,7 @@ class TerraformLandscape::TerraformPlan # rubocop:disable Metrics/ClassLength
     @out.print "    #{attribute_name}:".ljust(attribute_value_indent_amount, ' ')
                                        .colorize(change_color)
 
-    evaluated_string = attribute_value.undump
+    evaluated_string = undump(attribute_value)
     if json?(evaluated_string)
       @out.print to_pretty_json(evaluated_string).gsub("\n",
                                                        "\n#{attribute_value_indent}")

data/lib/terraform_landscape/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module TerraformLandscape
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.3.4'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terraform_landscape
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Coinbase
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-30 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -53,20 +53,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: string_undump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: treetop
   requirement: !ruby/object:Gem::Requirement
@@ -112,15 +98,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Pretty-print Terraform plan output