terraspace 0.6.11 → 0.6.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aff7c57d034f741f93405653b027fa5f6fc7cd149bb705401777c46d9d784ce
-  data.tar.gz: 108a8ba1f3945df8a2aa682df18715952462182fc79a0ee2387c83c969f5d683
+  metadata.gz: c50b3dfbe37199a7e64fa53fdd2df157d63c045ee0101d25702d52a78b6ff555
+  data.tar.gz: 9731b4341f086406fb11c9436ef434f52261f6161b6c73f00bbefb5d75869944
 SHA512:
-  metadata.gz: 05bfd0234b175533d1f8e477aaa3fffd6c1397d5c3640bde82217f18ec339e02698b37dabcf79e800f57f2c148fc6923f06c697e740fbd58561abaac5bbe903b
-  data.tar.gz: f9c2ff7ae00c5495c30da0b9db1d7f7c6dcc73045dcb6396d8df284e3d79e5c3a6607723629bae7d5d09446e3296ea1e27f9cefdb5cfd6ade419f429bb0ea5da
+  metadata.gz: 041ffd7c3b81c6160d8332c93583013865cd8c70b7825dd6af570e91a1a59e4c65aa39a9b6745c35b76692b43fb2df89e390dd380ecf3dcb8c78f3bf21a338c0
+  data.tar.gz: bce08f9c7cc634f06d53e9d50255cec2db886c65c2b8e23cbee855fc87080d2ad1a0787ef55c250b93b80e894d1c4d6a72034e5ed33d4ac2beaf1c4a090966f7

data/CHANGELOG.md

@@ -3,6 +3,28 @@
 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.16] - 2021-10-01
+- [#141](https://github.com/boltops-tools/terraspace/pull/141) terraspace output: remove extra newline at the end
+
+## [0.6.15] - 2021-10-01
+- [#140](https://github.com/boltops-tools/terraspace/pull/140) fix terraspace output and Enter a value handling
+
+## [0.6.14] - 2021-09-30
+- [#134](https://github.com/boltops-tools/terraspace/pull/134) Use file not plan for the var-files argument
+- [#139](https://github.com/boltops-tools/terraspace/pull/139) Fix terraspace output to not add extra newlines
+- terraspace list: change default to show both stacks and modules
+
+## [0.6.13] - 2021-08-10
+- use terraspace-bundler 0.4.0
+
+## [0.6.12] - 2021-07-26
+- [#128](https://github.com/boltops-tools/terraspace/pull/128) Improve terraspace state comands and Terraspace.argv for internal usage
+- [#129](https://github.com/boltops-tools/terraspace/pull/129) use Dir.glob(expr, File::FNM_DOTMATCH) so dotfiles are copied, allowing .terraform-version for tfenv
+- allow -h to help outside terraspace project generally
+- require rspec-terraspace 0.3.0
+- state subcommands: straight delegate args
+- Terraspace.argv for consistency with terraspace test
+
 ## [0.6.11] - 2021-06-22
 - [#120](https://github.com/boltops-tools/terraspace/pull/120) version check handles a major change
 

data/lib/terraspace/cli/check_setup.rb

@@ -35,7 +35,7 @@ class Terraspace::CLI
     end
 
     def check_command?
-      ARGV[0] == "check_setup"
+      Terraspace.argv[0] == "check_setup"
     end
 
     def terraform_is_not_installed

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

@@ -0,0 +1,30 @@
+## Examples
+
+    terraspace state list demo
+    terraspace state mv demo
+    terraspace state pull demo
+    terraspace state push demo
+    terraspace state replace demo
+    terraspace state rm demo
+    terraspace state show demo
+
+## Args Straight Delegation
+
+The `terraspace state` command delegates to the `terraform state` commands passing the arguments straight through. Refer to the underlying `terraform` command help for arguments.  Example:
+
+    terraform state list -h
+    ...
+    Options:
+    ...
+    -id=ID              Filters the results to include only instances whose
+                          resource types have an attribute named "id" whose value
+                          equals the given id string.
+
+This means we can use the `-id` or `--id` option and terraspace will pass it straight through. Example:
+
+    terraspace state list demo --id enabled-bull
+    Building .terraspace-cache/us-west-2/dev/stacks/demo
+    Built in .terraspace-cache/us-west-2/dev/stacks/demo
+    Current directory: .terraspace-cache/us-west-2/dev/stacks/demo
+    => terraform state list --id enabled-bull
+    random_pet.this

data/lib/terraspace/cli/init.rb

@@ -98,7 +98,7 @@ class Terraspace::CLI
 
     # only top level command considered
     def calling_command
-      ARGV[0]
+      Terraspace.argv[0]
     end
   end
 end

data/lib/terraspace/cli.rb

@@ -28,7 +28,7 @@ module Terraspace
       option :reconfigure, type: :boolean, desc: "Add terraform -reconfigure option"
     }
     type_option = Proc.new {
-      option :type, default: "stack", aliases: %w[t], desc: "Type: stack, module, or all"
+      option :type, default: "all", aliases: %w[t], desc: "Type: stack, module, or all"
     }
 
     desc "all SUBCOMMAND", "all subcommands"
@@ -189,8 +189,8 @@ module Terraspace
 
     desc "state SUBCOMMAND STACK", "Run state."
     long_desc Help.text(:state)
-    def state(subcommand, mod)
-      State.new(options.merge(subcommand: subcommand, mod: mod)).run
+    def state(subcommand, mod, *rest)
+      State.new(options.merge(subcommand: subcommand, mod: mod, rest: rest)).run
     end
 
     desc "test", "Run test."

data/lib/terraspace/command.rb

@@ -30,6 +30,9 @@ module Terraspace
       include Terraspace::Util::Logging
 
       def dispatch(m, args, options, config)
+        # Terraspace.argv provides consistency when terraspace is being called by rspec-terrspace test harness
+        Terraspace.argv = args.clone # important to clone since Thor removes the first argv
+
         check_standalone_install!
         check_project!(args.first)
 
@@ -42,7 +45,6 @@ module Terraspace
         # as well thor's normal way:
         #
         #   terraspace help command
-        help_flags = Thor::HELP_MAPPINGS + ["help"]
         if args.length > 1 && !(args & help_flags).empty?
           args -= help_flags
           args.insert(-2, "help")
@@ -59,6 +61,11 @@ module Terraspace
         super
       end
 
+      def help_flags
+        Thor::HELP_MAPPINGS + ["help"]
+      end
+      private :help_flags
+
       def check_standalone_install!
         return unless opt?
         version_manager = "rvm" if rvm?
@@ -94,6 +101,7 @@ module Terraspace
       def check_project!(command_name)
         return if subcommand?
         return if command_name.nil?
+        return if help_flags.include?(Terraspace.argv.last) # IE: -h help
         return if %w[-h -v check_setup completion completion_script help new test version].include?(command_name)
         return if File.exist?("#{Terraspace.root}/config/app.rb")
         logger.error "ERROR: It doesnt look like this is a terraspace project. Are you sure you are in a terraspace project?".color(:red)

data/lib/terraspace/compiler/builder.rb

@@ -37,7 +37,7 @@ module Terraspace::Compiler
 
     def build_config_terraform
       expr = "#{Terraspace.root}/config/terraform/**/*"
-      Dir.glob(expr).each do |path|
+      search(expr).each do |path|
         next unless File.file?(path)
         next if path.include?('config/terraform/tfvars')
         build_config_file(basename(path))
@@ -45,13 +45,13 @@ module Terraspace::Compiler
     end
 
     def build_config_file(file)
-      existing = Dir.glob("#{@mod.root}/#{file}").first
+      existing = search("#{@mod.root}/#{file}").first
       return if existing && existing.ends_with?(".tf") # do not overwrite existing backend.tf, provider.tf, etc
 
       if file.ends_with?(".rb")
-        src_path = Dir.glob("#{@mod.root}/#{basename(file)}").first # existing source. IE: backend.rb in module folder
+        src_path = search("#{@mod.root}/#{basename(file)}").first # existing source. IE: backend.rb in module folder
       end
-      src_path ||= Dir.glob("#{Terraspace.root}/config/terraform/#{file}").first
+      src_path ||= search("#{Terraspace.root}/config/terraform/#{file}").first
       build_mod_file(src_path) if src_path
     end
 
@@ -65,7 +65,7 @@ module Terraspace::Compiler
     end
 
     def with_path(path)
-      Dir.glob(path).each do |src_path|
+      search(path).each do |src_path|
         next if skip?(src_path)
         yield(src_path)
       end
@@ -80,5 +80,9 @@ module Terraspace::Compiler
       src_path.include?("#{@mod.root}/test") ||
       src_path.include?("#{@mod.root}/tfvars")
     end
+
+    def search(expr)
+      Dir.glob(expr, File::FNM_DOTMATCH)
+    end
   end
 end

data/lib/terraspace/compiler/commands_concern.rb

@@ -11,8 +11,8 @@ module Terraspace::Compiler
     def command_is?(*commands)
       commands.flatten!
       commands.map!(&:to_s)
-      commands.include?(ARGV[0]) ||                  # IE: terraspace up
-      ARGV[0] == "all" && commands.include?(ARGV[1]) # IE: terraspace all up
+      commands.include?(Terraspace.argv[0]) ||                  # IE: terraspace up
+      Terraspace.argv[0] == "all" && commands.include?(Terraspace.argv[1]) # IE: terraspace all up
     end
   end
 end

data/lib/terraspace/compiler/dsl/syntax/helpers/common.rb

@@ -19,7 +19,7 @@ module Terraspace::Compiler::Dsl::Syntax::Helpers
     #     terraspace_command('-') => "terraspace-up-demo"
     #
     def terraspace_command(separator=' ')
-      args = ARGV[0..1] || []
+      args = Terraspace.argv[0..1] || []
       command = ["terraspace"] + args
       command.join(separator)
     end

data/lib/terraspace/core.rb

@@ -58,5 +58,15 @@ module Terraspace
         i.is_a?(Regexp) ? path =~ i : path.include?(i)
       end
     end
+
+    # Terraspace.argv provides consistency when terraspace is being called by rspec-terrspace test harness
+    # So use Terraspace.argv instead of ARGV constant
+    def argv=(argv)
+      @@argv = argv
+    end
+
+    def argv
+      @@argv
+    end
   end
 end

data/lib/terraspace/logger.rb

@@ -20,8 +20,12 @@ module Terraspace
     # Used to allow terraform output to always go to stdout
     # Terraspace output goes to stderr by default
     # See: terraspace/shell.rb
-    def stdout(msg)
-      puts msg
+    def stdout(msg, newline: true)
+      if newline
+        puts msg
+      else
+        print msg
+      end
     end
   end
 end

data/lib/terraspace/shell.rb

@@ -20,13 +20,18 @@ module Terraspace
     def shell
       env = @options[:env] || {}
       env.stringify_keys!
-      if @options[:shell] == "system" # terraspace console
+      if system?
         system(env, @command, chdir: @mod.cache_dir)
       else
         popen3(env)
       end
     end
 
+    def system?
+      @options[:shell] == "system" || # terraspace console
+      ENV['TS_RUNNER_SYSTEM'] # allow manual override
+    end
+
     def popen3(env)
       Open3.popen3(env, @command, chdir: @mod.cache_dir) do |stdin, stdout, stderr, wait_thread|
         handle_streams(stdin, stdout, stderr)
@@ -54,7 +59,7 @@ module Terraspace
             lines = buffer.split("\n")
             lines.each do |line|
               if f.fileno == stdout.fileno
-                handle_stdout(line)
+                handle_stdout(line, newline: !suppress_newline(line))
                 handle_input(stdin, line)
               else
                 handle_stderr(line)
@@ -65,6 +70,11 @@ module Terraspace
       end
     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
+    end
+
     def handle_stderr(line)
       @error ||= Error.new
       @error.lines << line # aggregate all error lines
@@ -81,19 +91,14 @@ module Terraspace
       files.find { |f| !f.eof }.nil?
     end
 
-    # 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.
     def handle_input(stdin, line)
-      # stdout doesnt seem to flush and show "Enter a value: " look for earlier output
       patterns = [
-        "Only 'yes' will be accepted", # prompt for apply. can happen on apply
+        "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) }
-        print "\n  Enter a value: ".bright
-        stdin.write_nonblock($stdin.gets)
+        answer = $stdin.gets
+        stdin.write_nonblock(answer)
       end
     end
 
@@ -109,16 +114,12 @@ module Terraspace
       end
     end
 
-    def handle_stdout(line)
-      prompted = line.include?('Enter a value')
-      @prompt_shown ||= prompted
-      return if @prompt_shown && prompted
-
+    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)
+        logger.stdout(line, newline: newline)
       else
         logger.info(line)
       end

data/lib/terraspace/terraform/args/default.rb

@@ -11,12 +11,24 @@ module Terraspace::Terraform::Args
       # https://terraspace.cloud/docs/ci-automation/
       ENV['TF_IN_AUTOMATION'] = '1' if @options[:auto]
 
-      args_meth = "#{@name}_args"
+      args = []
+
+      if straight_delegate_args?
+        args += @options[:rest]
+        args.flatten!
+      end
+
+      args_meth = "#{@name}_args".gsub(' ', '_') # IE: apply_args, init_args
       if respond_to?(args_meth)
-        send(args_meth)
-      else
-        []
+        args += send(args_meth)
       end
+
+      args
+    end
+
+    # delegate args straight through for special commands, currently state seems to be the only case
+    def straight_delegate_args?
+      @name.include?("state") # IE: "state list", "state pull", "state show"
     end
 
     def force_unlock_args
@@ -28,7 +40,7 @@ module Terraspace::Terraform::Args
       var_files = @options[:var_files]
       if var_files
         var_files.each do |file|
-          copy_to_cache(plan)
+          copy_to_cache(file)
         end
         args << var_files.map { |f| "-var-file #{f}" }.join(' ')
       end

data/lib/terraspace/version.rb

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

data/terraspace.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "memoist"
   spec.add_dependency "rainbow"
   spec.add_dependency "render_me_pretty"
-  spec.add_dependency "terraspace-bundler", "~> 0.3.0"
+  spec.add_dependency "terraspace-bundler", "~> 0.4.0"
   spec.add_dependency "thor"
   spec.add_dependency "tty-tree"
   spec.add_dependency "zeitwerk"
@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "terraspace_plugin_aws", "~> 0.3.0"
   spec.add_dependency "terraspace_plugin_azurerm", "~> 0.3.0"
   spec.add_dependency "terraspace_plugin_google", "~> 0.3.0"
-  spec.add_dependency "rspec-terraspace", "~> 0.2.0"
+  spec.add_dependency "rspec-terraspace", "~> 0.3.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.6.11
+  version: 0.6.16
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -254,14 +254,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -532,6 +532,7 @@ files:
 - lib/terraspace/cli/help/refresh.md
 - lib/terraspace/cli/help/seed.md
 - lib/terraspace/cli/help/show.md
+- lib/terraspace/cli/help/state.md
 - lib/terraspace/cli/help/summary.md
 - lib/terraspace/cli/help/test.md
 - lib/terraspace/cli/help/tfc/destroy.md
@@ -848,7 +849,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: 'Terraspace: The Terraspace Framework'