terraspace 0.6.16 → 0.6.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c50b3dfbe37199a7e64fa53fdd2df157d63c045ee0101d25702d52a78b6ff555
-  data.tar.gz: 9731b4341f086406fb11c9436ef434f52261f6161b6c73f00bbefb5d75869944
+  metadata.gz: 4f7c8d0d2152329290209a2cf2d1745499939ed4b5adc56a053a779281a382bf
+  data.tar.gz: eb5d9eb7eb83059cc80751bb16a7a3b8c75f44ea44f5857f433b41c6a48d5283
 SHA512:
-  metadata.gz: 041ffd7c3b81c6160d8332c93583013865cd8c70b7825dd6af570e91a1a59e4c65aa39a9b6745c35b76692b43fb2df89e390dd380ecf3dcb8c78f3bf21a338c0
-  data.tar.gz: bce08f9c7cc634f06d53e9d50255cec2db886c65c2b8e23cbee855fc87080d2ad1a0787ef55c250b93b80e894d1c4d6a72034e5ed33d4ac2beaf1c4a090966f7
+  metadata.gz: 4884550da0751047f57c4b96df4c7a0689a1beef6ab38fc3d83e9795c1a95186cdaa260de5698ceaf84b11b01509b54893a31f99c22d0e4ab752f7b78160bee9
+  data.tar.gz: b99ca01f18ff9583ef362410c82ae59947a646186a06f07f6b55acfd2d6a3e24a9c010ee9e72907e65e02914c339ebaf920038d2cd68ad204facbde40b8763fd

data/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.6.20] - 2021-12-14
+- [#162](https://github.com/boltops-tools/terraspace/pull/162) expand_string? interface method so plugins can decide whether or not to expand the string
+- improve seed generator column spacing
+
+## [0.6.19] - 2021-11-24
+- [#149](https://github.com/boltops-tools/terraspace/pull/149) change default fallback mod strategy to Mod::Tf instead of Mod::Pass for ERB support
+- [#152](https://github.com/boltops-tools/terraspace/pull/152) fix naming typo in cli help
+- [#153](https://github.com/boltops-tools/terraspace/pull/153) only remove and create log dir if it exists
+- [#155](https://github.com/boltops-tools/terraspace/pull/155) add terraspace bundle example cli help
+- [#157](https://github.com/boltops-tools/terraspace/pull/157) handle edge case: Enter a value chopped off
+- [#158](https://github.com/boltops-tools/terraspace/pull/158) use pass strategy for binary files
+- [#159](https://github.com/boltops-tools/terraspace/pull/159) process terraform.tfvars file with erb, change default processing strategy back to pass
+
+## [0.6.18] - 2021-10-28
+- [#147](https://github.com/boltops-tools/terraspace/pull/147) improve error message output
+- [#148](https://github.com/boltops-tools/terraspace/pull/148) Improve shim wrapper generator
+
+## [0.6.17] - 2021-10-02
+- [#142](https://github.com/boltops-tools/terraspace/pull/142) improve builder skip check: check if its a dir
+
 ## [0.6.16] - 2021-10-01
 - [#141](https://github.com/boltops-tools/terraspace/pull/141) terraspace output: remove extra newline at the end
 

data/SECURITY.md

@@ -0,0 +1,3 @@
+# Security Policy
+
+Refer to: https://terraspace.cloud/docs/policies/security/

data/lib/terraspace/cli/clean/logs.rb

@@ -4,7 +4,6 @@ class Terraspace::CLI::Clean
       action = @options[:truncate] ? "truncate" : "remove"
       are_you_sure?(action)
       @options[:truncate] ? truncate : remove
-      logger.info "Logs #{action}d" # IE: Logs truncated or Logs removed
     end
 
     def truncate
@@ -14,6 +13,7 @@ class Terraspace::CLI::Clean
     end
 
     def remove
+      return unless File.exist?(log_root)
       puts "Removing all files in #{pretty_log_root}/" unless @options[:mute]
       FileUtils.rm_rf(log_root)
       FileUtils.mkdir_p(log_root)

data/lib/terraspace/cli/help/bundle.md

@@ -16,3 +16,9 @@
 ## Info on a module
 
     terraspace bundle info MODULE
+
+## Import Example As Stack
+
+You can import a module's example as a stack.
+
+    terraspace bundle example MODULE EXAMPLE

data/lib/terraspace/cli/help/init.md

@@ -1,4 +1,4 @@
-Typically, Terrasapce auto init should handle initialization. You can run init if you need to though.
+Typically, Terraspace auto init should handle initialization. You can run init if you need to though.
 
 ## Example
 

data/lib/terraspace/cli/new/shim.rb

@@ -18,7 +18,6 @@ class Terraspace::CLI::New
     end
 
     def create
-      return unless File.exist?(".git")
       dest = @path
       template "terraspace", dest
       chmod dest, 0755
@@ -44,6 +43,8 @@ class Terraspace::CLI::New
 
             export PATH=#{dir}:/$PATH
 
+        Also note, the shim wrapper contains starter code. Though it should generally work for most systems,
+        it might require adjustments depending on your system.
       EOL
     end
 

data/lib/terraspace/compiler/builder/skip.rb

@@ -0,0 +1,28 @@
+class Terraspace::Compiler::Builder
+  class Skip
+    def initialize(mod, src_path)
+      @mod, @src_path = mod, src_path
+    end
+
+    def check?
+      return true unless File.file?(@src_path)
+
+      # skip certain folders
+      check_dirs?(
+        "config/args",
+        "config/helpers",
+        "config/hooks",
+        "test",
+        "tfvars",
+      )
+    end
+
+    def check_dirs?(*names)
+      names.flatten.detect { |name| check_dir?(name) }
+    end
+
+    def check_dir?(name)
+      @src_path.include?("#{@mod.root}/#{name}/")
+    end
+  end
+end

data/lib/terraspace/compiler/builder.rb

@@ -72,13 +72,7 @@ module Terraspace::Compiler
     end
 
     def skip?(src_path)
-      return true unless File.file?(src_path)
-      # certain folders will be skipped
-      src_path.include?("#{@mod.root}/config/args") ||
-      src_path.include?("#{@mod.root}/config/helpers") ||
-      src_path.include?("#{@mod.root}/config/hooks") ||
-      src_path.include?("#{@mod.root}/test") ||
-      src_path.include?("#{@mod.root}/tfvars")
+      Skip.new(@mod, src_path).check?
     end
 
     def search(expr)

data/lib/terraspace/compiler/strategy/mod/tfvars.rb

@@ -0,0 +1,4 @@
+class Terraspace::Compiler::Strategy::Mod
+  class Tfvars < Tf
+  end
+end

data/lib/terraspace/compiler/strategy/mod.rb

@@ -1,3 +1,5 @@
+require "open3"
+
 module Terraspace::Compiler::Strategy
   class Mod < AbstractBase
     def run
@@ -9,8 +11,15 @@ module Terraspace::Compiler::Strategy
     def strategy_class(path)
       ext = File.extname(path).sub('.','')
       return Mod::Pass if ext.empty? # infinite loop without this
-      return Mod::Pass if Terraspace.pass_file?(path)
+      return Mod::Pass if Terraspace.pass_file?(path) or !text_file?(path)
+      # Fallback to Mod::Tf for all other files. ERB useful for terraform.tfvars
       "Terraspace::Compiler::Strategy::Mod::#{ext.camelize}".constantize rescue Mod::Pass
     end
+
+    # Thanks: https://stackoverflow.com/questions/2355866/ruby-how-to-determine-if-file-being-read-is-binary-or-text
+    def text_file?(filename)
+      file_type, status = Open3.capture2e("file", filename)
+      status.success? && file_type.include?("text")
+    end
   end
 end

data/lib/terraspace/plugin/expander/interface.rb

@@ -34,6 +34,7 @@ module Terraspace::Plugin::Expander
     #
     def expansion(string)
       return string unless string.is_a?(String) # in case of nil
+      return string unless expand_string?(string)
 
       string = string.dup
       vars = string.scan(/:\w+/) # => [":ENV", ":BUILD_DIR"]
@@ -43,6 +44,11 @@ module Terraspace::Plugin::Expander
       strip(string)
     end
 
+    # interface method
+    def expand_string?(string)
+      true
+    end
+
     # remove leading and trailing common separators.
     #
     # This is useful for when INSTANCE is not set.

data/lib/terraspace/seeder/content.rb

@@ -49,7 +49,7 @@ class Terraspace::Seeder
     end
 
     def rpad
-      all_vars.keys.map(&:size).max
+      all_vars.keys.map(&:size).max + 2
     end
     memoize :rpad
 

data/lib/terraspace/shell/error.rb

@@ -2,7 +2,7 @@ class Terraspace::Shell
   class Error
     attr_accessor :lines
     def initialize
-      @lines = '' # holds aggregation of all error lines
+      @lines = [] # holds aggregation of all error lines
     end
 
     def known?
@@ -11,11 +11,11 @@ class Terraspace::Shell
 
     def instance
       if reinit_required?
-        Terraspace::InitRequiredError.new(@lines)
+        Terraspace::InitRequiredError.new(message)
       elsif bucket_not_found?
-        Terraspace::BucketNotFoundError.new(@lines)
+        Terraspace::BucketNotFoundError.new(message)
       elsif shared_cache_error?
-        Terraspace::SharedCacheError.new(@lines)
+        Terraspace::SharedCacheError.new(message)
       end
     end
 
@@ -34,7 +34,8 @@ class Terraspace::Shell
     end
 
     def message
-      @lines.gsub("\n", ' ').squeeze(' ') # remove double whitespaces and newlines
+      # For error messages, terraform lines from buffer do not contain newlines. So join with newline
+      @lines.join("\n")
     end
 
     def shared_cache_error?

data/lib/terraspace/shell.rb

@@ -71,8 +71,49 @@ module Terraspace
     end
 
     def suppress_newline(line)
-      line.size == 8192 && line[-1] != "\n" || # when buffer is very large buffer.split("\n") only gives 8192 chars at a time
-      line.include?("Enter a value:") # prompt
+      # Regular prompt
+      line.include?("Enter a value:") ||
+      # Edge case: When buffer is very large buffer.split("\n") only gives 8192 chars at a time
+      line.size == 8192 && line[-1] != "\n" ||
+      # Edge case: "value:" chopped off "Enter a" and "value" prompt
+      # Very hard to reproduce. Happens 1/5 times on terraspace up autoscaling example.
+      # Sometimes lines come in as:
+      #   [...,"  Only 'yes' will be accepted to approve.", "", "  \e[1mEnter a"]
+      #   [" value:\e[0m \e[0m"]
+      line.match(/Enter a$/) || line.match(/^ value:/) # chopped off prompt
+      # line.include?(" value:") && lines.last.match(/Enter a$/) # chopped off prompt
+    end
+
+    def handle_stdout(line, newline: true)
+      # Terraspace logger has special stdout method so original terraform output
+      # can be piped to jq. IE:
+      #   terraspace show demo --json | jq
+      if logger.respond_to?(:stdout) && !@options[:log_to_stderr]
+        logger.stdout(line, newline: newline)
+      else
+        logger.info(line)
+      end
+    end
+
+    def handle_input(stdin, line)
+      # Edge case: "value:" chopped off "Enter a" and "value" prompt
+      #   This means "Enter a value:" is not needed but leaving it for now
+      patterns = [
+        /^ value:/,
+        "Enter a value:",
+        "\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
+      ]
+      matched = patterns.any? do |pattern|
+        if pattern.is_a?(String)
+          line.include?(pattern)
+        else # Regexp
+          line.match(pattern)
+        end
+      end
+      if matched
+        answer = $stdin.gets
+        stdin.write_nonblock(answer)
+      end
     end
 
     def handle_stderr(line)
@@ -91,17 +132,6 @@ module Terraspace
       files.find { |f| !f.eof }.nil?
     end
 
-    def handle_input(stdin, line)
-      patterns = [
-        "Enter a value:",
-        "\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
-      ]
-      if patterns.any? { |pattern| line.include?(pattern) }
-        answer = $stdin.gets
-        stdin.write_nonblock(answer)
-      end
-    end
-
     def exit_status(status)
       return if status == 0
 
@@ -113,16 +143,5 @@ module Terraspace
         exit status
       end
     end
-
-    def handle_stdout(line, newline: true)
-      # Terraspace logger has special stdout method so original terraform output
-      # can be piped to jq. IE:
-      #   terraspace show demo --json | jq
-      if logger.respond_to?(:stdout) && !@options[:log_to_stderr]
-        logger.stdout(line, newline: newline)
-      else
-        logger.info(line)
-      end
-    end
   end
 end

data/lib/terraspace/terraform/runner/retryer.rb

@@ -9,10 +9,11 @@ class Terraspace::Terraform::Runner
     end
 
     def retry?
-      if @retries <= 3 && !@stop_retrying
+      max_retries = ENV['TS_MAX_RETRIES'] ? ENV['TS_MAX_RETRIES'].to_i : 3
+      if @retries <= max_retries && !@stop_retrying
         true # will retry
       else
-        logger.info "ERROR: #{@exception.message}"
+        logger.info "ERROR after max retries #{max_retries}: #{@exception.message}"
         false # will not retry
       end
     end

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "0.6.16"
+  VERSION = "0.6.20"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.6.16
+  version: 0.6.20
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -384,6 +384,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - exe/terraspace
 - lib/templates/base/arg/terraform.rb.tt
 - lib/templates/base/git_hook/hook.sh
@@ -578,6 +579,7 @@ files:
 - lib/terraspace/compiler/backend/parser.rb
 - lib/terraspace/compiler/basename.rb
 - lib/terraspace/compiler/builder.rb
+- lib/terraspace/compiler/builder/skip.rb
 - lib/terraspace/compiler/cleaner.rb
 - lib/terraspace/compiler/cleaner/backend_change.rb
 - lib/terraspace/compiler/commands_concern.rb
@@ -613,6 +615,7 @@ files:
 - lib/terraspace/compiler/strategy/mod/pass.rb
 - lib/terraspace/compiler/strategy/mod/rb.rb
 - lib/terraspace/compiler/strategy/mod/tf.rb
+- lib/terraspace/compiler/strategy/mod/tfvars.rb
 - lib/terraspace/compiler/strategy/tfvar.rb
 - lib/terraspace/compiler/strategy/tfvar/base.rb
 - lib/terraspace/compiler/strategy/tfvar/layer.rb
@@ -849,7 +852,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: 'Terraspace: The Terraspace Framework'