terraspace 1.1.0 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6c8809128dbbbf51d0f654c92784a879c88cab49d31e15e2a1d827c4b40d051
-  data.tar.gz: c557bd4692fddd9a1bf859a986566780cb6ccd6024dcdb3e7979138a42f1e00e
+  metadata.gz: 50baca1ee67aedb6160857e20b413db3e31923ee2f6bd8347723e2445d9b59ef
+  data.tar.gz: 0ac181788709d0700c0cfcd8085c375b453e84aef6333b9c93b446ff1bb30938
 SHA512:
-  metadata.gz: 8b28d7d1b8565fa0f646fda57163b6d21486db7e7f704ebe657a219335e66504206769e487cec9dc3f30da06ac793e28d81b1709ebd4c32a39a70a5d8668be05
-  data.tar.gz: 1a09efc8d460c9267371aca9dbb130e4dbb1c9268ea870e19d6a9734aa48e0134b3cee09aedfe894acfd2c7e956a1fed4bf7b38cad9cf9b13b935802bd2fa4a7
+  metadata.gz: ce1c04ca24e818cef35397bf9fb7cadb9e9b28838a0e15c3ec18e0e4d0b49d3bdfba4bb01e6d3e9788e5410e99c44dc827ec79a0432ae94d90fd4413c2c446ad
+  data.tar.gz: 95d7c2cea1917b0e3c919a43afadf24b2970dbd87c2d46d5b5846d62c6e9cc115751a7ab63defb74ad1c79917984262a7d9987eee1134e87d2778c9edcc3a175

data/CHANGELOG.md

@@ -3,6 +3,25 @@
 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.
 
+## [1.1.4] - 2022-02-21
+- [#210](https://github.com/boltops-tools/terraspace/pull/210) write files without magic conversion, fixes #209
+- cleanup argv and root
+- write files without magic conversion, fixes #209
+
+## [1.1.3] - 2022-02-17
+- [#207](https://github.com/boltops-tools/terraspace/pull/207) dont fork when all.concurrency = 1
+
+## [1.1.2] - 2022-02-17
+- [#200](https://github.com/boltops-tools/terraspace/pull/200) fix terraspace typos
+- [#202](https://github.com/boltops-tools/terraspace/pull/202) Windows support: fix include_dir for windows
+- [#203](https://github.com/boltops-tools/terraspace/pull/203) Fix ERB for windows
+- [#204](https://github.com/boltops-tools/terraspace/pull/204) improve file check
+- setup check terraform_bin windows support
+- slight layering improvement strip trailing slash, helps with custom layering
+
+## [1.1.1] - 2022-02-02
+- [#199](https://github.com/boltops-tools/terraspace/pull/199) build required dependent stacks as part of terraspace up
+
 ## [1.1.0] - 2022-01-30
 - [#196](https://github.com/boltops-tools/terraspace/pull/196) terraspace all: build modules in batches and only each specific stack
 - [#197](https://github.com/boltops-tools/terraspace/pull/197) all plan --output and all up --plan options

data/lib/terraspace/all/runner.rb

@@ -41,26 +41,35 @@ module Terraspace::All
       concurrency = Terraspace.config.all.concurrency
       batch.sort_by(&:name).each_slice(concurrency) do |slice|
         slice.each do |node|
-          pid = fork do
-            build_stack(node.name)
-            run_terraspace(node.name)
+          if fork?
+            pid = fork do
+              deploy_stack(node)
+            end
+            @pids[pid] = node.name # store mod_name mapping
+          else
+            deploy_stack(node)
           end
-          @pids[pid] = node.name # store mod_name mapping
         end
       end
+      return unless fork?
       wait_for_child_proccess
       summarize     # also reports lower-level error info
       report_errors # reports finall errors and possibly exit
     end
 
+    def deploy_stack(node)
+      build_stack(node.name)
+      run_terraspace(node.name)
+    end
+
     def build_modules
-      builder = Terraspace::Builder.new(@options.merge(mod: "placeholder", quiet: true, clean: true))
-      builder.build(modules: true, stack: false)
+      builder = Terraspace::Builder.new(@options.merge(mod: "placeholder", clean: true, quiet: true, include_stacks: :none))
+      builder.build(modules: true)
     end
 
     def build_stack(name)
-      builder = Terraspace::Builder.new(@options.merge(mod: name, quiet: true, clean: false))
-      builder.build(modules: false, stack: true)
+      builder = Terraspace::Builder.new(@options.merge(mod: name, clean: false, quiet: true, include_stacks: :root_only))
+      builder.build(modules: false)
     end
 
     def wait_for_child_proccess
@@ -109,7 +118,7 @@ module Terraspace::All
     end
 
     def run_terraspace(mod_name)
-      set_log_path!(mod_name)
+      set_log_path!(mod_name) if fork?
       name = command_map(@command)
       o = @options.merge(mod: mod_name, yes: true, build: false, input: false, log_to_stderr: true)
       o.merge!(quiet: false) if @command == "init" # noisy so can filter and summarize output
@@ -123,6 +132,10 @@ module Terraspace::All
       end
     end
 
+    def fork?
+      Terraspace.config.all.concurrency > 1
+    end
+
     def set_log_path!(mod_name)
       command = terraspace_command(mod_name)
       path = log_path(mod_name)

data/lib/terraspace/app.rb

@@ -16,7 +16,7 @@ module Terraspace
       config.all = ActiveSupport::OrderedOptions.new
       config.all.concurrency = 5
       config.all.exit_on_fail = ActiveSupport::OrderedOptions.new
-      config.all.exit_on_fail.down = true
+      config.all.exit_on_fail.down = false
       config.all.exit_on_fail.plan = true
       config.all.exit_on_fail.up = true
 

data/lib/terraspace/builder/children.rb

@@ -0,0 +1,42 @@
+class Terraspace::Builder
+  class Children
+    include Terraspace::Util::Logging
+
+    def initialize(mod, options={})
+      @mod, @options = mod, options
+      @queue = []
+    end
+
+    def build
+      dependencies = Terraspace::Dependency::Registry.data
+      # Find out if current deploy stack contains dependency
+      found = dependencies.find do |parent_child|
+        parent, _ = parent_child.split(':')
+        parent == @mod.name
+      end
+      return unless found
+
+      # Go down graph children, which are the dependencies to build a queue
+      parent, _ = found.split(':')
+      node = Terraspace::Dependency::Node.find_by(name: parent)
+      build_queue(node)
+
+      logger.debug "Terraspace::Builder::Children @queue #{@queue}"
+
+      # Process queue in reverse order to build leaf nodes first
+      @queue.reverse.each do |node|
+        mod = Terraspace::Mod.new(node.name, @options)
+        Terraspace::Compiler::Perform.new(mod).compile
+      end
+    end
+
+    # Use depth first traversal to build queue
+    def build_queue(node)
+      node.children.each do |child|
+        @queue << child
+        build_queue(child)
+      end
+      @queue
+    end
+  end
+end

data/lib/terraspace/builder.rb

@@ -4,23 +4,40 @@ module Terraspace
     include Compiler::DirsConcern
     include Hooks::Concern
 
+    # @include_stacks can be 3 values: root_with_children, none, root_only
+    #
+    #     none: dont build any stacks at all. used by `terraspace all up`
+    #     root_only: only build root stack. used by `terraspace all up`
+    #     root_with_children: build all parent stacks as well as the root stack. normal `terraspace up`
+    #
+    def initialize(options={})
+      super
+      @include_stacks = @options[:include_stacks] || :root_with_children
+    end
+
     def run
       return if @options[:build] == false
       Terraspace::CLI::Setup::Check.check!
       check_allow!
       @mod.root_module = true
       clean
+      resolve_dependencies if @include_stacks == :root_with_children
       build
     end
 
-    def build(modules: true, stack: true)
+    def resolve_dependencies
+      resolver = Terraspace::Dependency::Resolver.new(@options.merge(quiet: true))
+      resolver.resolve # returns batches
+    end
+
+    def build(modules: true)
       build_dir = Util.pretty_path(@mod.cache_dir)
       placeholder_stack_message
       logger.info "Building #{build_dir}" unless @options[:quiet] # from terraspace all
       FileUtils.mkdir_p(@mod.cache_dir) # so terraspace before build hooks work
       run_hooks("terraspace.rb", "build") do
         build_dir("modules") if modules
-        build_root_module if stack
+        build_stacks
         logger.info "Built in #{build_dir}" unless @options[:quiet] # from terraspace all
       end
     end
@@ -29,16 +46,23 @@ module Terraspace
       Allow.new(@mod).check!
     end
 
-    def build_root_module
-      @mod.resolved = true
-      Compiler::Perform.new(@mod).compile
+    def build_stacks
+      return if @include_stacks == :none
+      build_children_stacks if @include_stacks == :root_with_children
+      Compiler::Perform.new(@mod).compile # @include_stacks :root or :root_with_children
+    end
+
+    # Build stacks that are part of the dependency graph. Because .terraspace-cache folders
+    # need to exist so `terraform state pull` works to get the state info.
+    def build_children_stacks
+      children = Children.new(@mod, @options)
+      children.build
     end
 
     def build_dir(type_dir)
       with_each_mod(type_dir) do |mod|
-        mod.resolved = true
         is_root_module = mod.cache_dir == @mod.cache_dir
-        next if is_root_module # handled by build_root_module
+        next if is_root_module # handled by build_stacks
         Compiler::Perform.new(mod).compile
       end
     end

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

@@ -1,9 +1,9 @@
 ## Example
 
     $ terraspace check_setup
-    Detected Terrspace version: 0.3.3
+    Detected Terraspace version: 0.3.3
     Detected Terraform bin: /home/ec2-user/.tfenv/bin/terraform
     Detected Terraform v0.13.2
     Terraspace requires Terraform v0.12.x and above
     You're all set!
-    $
+    $

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

@@ -50,7 +50,7 @@ class Terraspace::CLI::New
 
   private
     def switch_ruby_version_line
-      rbenv_installed = system("type rbenv 2>&1 > /dev/null")
+      rbenv_installed = system("type rbenv > /dev/null 2>&1")
       if rbenv_installed
         'eval "$(rbenv init -)"'
       end

data/lib/terraspace/cli/setup/check.rb

@@ -11,7 +11,7 @@ class Terraspace::CLI::Setup
 
     # Used for the CLI
     def run
-      puts "Detected Terrspace version: #{Terraspace::VERSION}"
+      puts "Detected Terraspace version: #{Terraspace::VERSION}"
       if terraform_bin
         puts "Detected Terraform bin: #{terraform_bin}"
         puts "Detected #{terraform_version_message}"
@@ -65,8 +65,12 @@ class Terraspace::CLI::Setup
     end
 
     def terraform_bin
-      out = `type terraform 2>&1`.strip
-      return unless $?.success?
+      if Gem.win_platform?
+        out = "is terraform.exe".strip
+      else
+        out = `type terraform 2>&1`.strip
+        return unless $?.success?
+      end
       md = out.match(/is (.*)/)
       md[1] if md
     end

data/lib/terraspace/command.rb

@@ -30,7 +30,7 @@ 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 provides consistency when terraspace is being called by rspec-terraspace test harness
         Terraspace.argv = args.clone # important to clone since Thor removes the first argv
 
         check_standalone_install!

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

@@ -8,28 +8,29 @@ class Terraspace::Compiler::Strategy::Mod
       @filename = filename
     end
 
-    @@already_reported = false
     def check
-      unless file_installed?
-        return true if @@already_reported
-        logger.warn <<~EOL.color(:yellow)
-          WARN: The command 'file' is not installed.
-          Unable to check if files are text or binary files as a part of the Terraspace compile processing.
-          Assuming all files are not binary file.
+      return true if Gem.win_platform? # assume text file if on windows
+      return true unless file_installed?
 
-          Please install the file command to remove this warning message.
-        EOL
-        @@already_reported = true
-        return true
-      end
       # Thanks: https://stackoverflow.com/questions/2355866/ruby-how-to-determine-if-file-being-read-is-binary-or-text
       file_type, status = Open3.capture2e("file", @filename)
       status.success? && file_type.include?("text")
     end
 
   private
+    @@has_file = nil
     def file_installed?
-      system("type file > /dev/null 2>&1")
+      return @@has_file unless @@has_file.nil?
+      @@has_file = system("type file > /dev/null 2>&1")
+      unless @@has_file
+        logger.warn <<~EOL.color(:yellow)
+          WARN: The command 'file' is not installed.
+          Unable to check if files are text or binary files as a part of the Terraspace compile processing.
+          Assuming all files are not binary file.
+          Please install the file command to remove this warning message.
+        EOL
+      end
+     @@has_file
     end
   end
 end

data/lib/terraspace/compiler/strategy/tfvar/layer.rb

@@ -58,8 +58,9 @@ class Terraspace::Compiler::Strategy::Tfvar
     end
 
     def full_layering
-      # layers is defined in Terraspace::Layering module
-      layers.inject([]) do |sum, layer|
+      # layers defined in Terraspace::Layering module
+      all = layers.map { |layer| layer.sub(/\/$/,'') } # strip trailing slash
+      all.inject([]) do |sum, layer|
         sum += layer_levels(layer) unless layer.nil?
         sum
       end

data/lib/terraspace/compiler/writer.rb

@@ -34,7 +34,7 @@ module Terraspace::Compiler
       if content.respond_to?(:path) # IO filehandle
         FileUtils.cp(content.path, dest_path) # preserves permission
       else # just content
-        IO.write(dest_path, content)
+        IO.write(dest_path, content, mode: "wb")
       end
       logger.debug "Created #{Terraspace::Util.pretty_path(dest_path)}"
     end

data/lib/terraspace/core.rb

@@ -11,11 +11,8 @@ module Terraspace
     def root
       @@root ||= ENV['TS_ROOT'] || Dir.pwd
     end
-
     # allow testing frameworks to switch roots
-    def root=(v)
-      @@root = v
-    end
+    cattr_writer :root
 
     def cache_root
       ENV['TS_CACHE_ROOT'] || config.build.cache_root || "#{root}/.terraspace-cache"
@@ -59,24 +56,9 @@ module Terraspace
       end
     end
 
-    # Terraspace.argv provides consistency when terraspace is being called by rspec-terrspace test harness
+    # Terraspace.argv provides consistency when terraspace is being called by rspec-terraspace test harness
     # So use Terraspace.argv instead of ARGV constant
-    def argv=(argv)
-      @@argv = argv
-    end
-
-    def argv
-      @@argv
-    end
-
-    @@check_project = true
-    def check_project
-      @@check_project
-    end
-
-    # allow testing frameworks to disable
-    def check_project=(v)
-      @@check_project = v
-    end
+    cattr_accessor :argv
+    cattr_accessor :check_project, default: true
   end
 end

data/lib/terraspace/dependency/resolver.rb

@@ -8,6 +8,7 @@ module Terraspace::Dependency
 
     def resolve
       with_each_mod("stacks") do |mod|
+        mod.resolved = false
         Terraspace::Compiler::Perform.new(mod).compile_tfvars(write: false)
       end
 

data/lib/terraspace/ext/core/module.rb

@@ -5,8 +5,15 @@ class Module
   #    include Provider
   #    # etc
   #
+  # Caller lines are different for OSes:
+  #
+  #   windows: "C:/Ruby31-x64/lib/ruby/gems/3.1.0/gems/terraspace-1.1.1/lib/terraspace/builder.rb:34:in `build'"
+  #   linux: "/home/ec2-user/.rvm/gems/ruby-3.0.3/gems/terraspace-1.1.1/lib/terraspace/compiler/dsl/syntax/mod.rb:4:in `<module:Mod>'"
+  #
   def include_dir(dir)
-    calling_file = caller[0].split(':').first # IE: /home/ec2-user/environment/terraspace/lib/terraspace/compiler/dsl/syntax/mod.rb
+    caller_line = caller[0]
+    parts = caller_line.split(':')
+    calling_file = caller_line.match(/^[a-zA-Z]:/) ? parts[1] : parts[0]
     parent_dir = File.dirname(calling_file)
 
     full_dir = "#{parent_dir}/#{dir}"

data/lib/terraspace/mod.rb

@@ -15,6 +15,7 @@ module Terraspace
       @name, @options = placeholder(name), options
       @consider_stacks = options[:consider_stacks].nil? ? true : options[:consider_stacks]
       @instance = options[:instance]
+      @resolved = true # more common case
     end
 
     def placeholder(name)

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

@@ -49,7 +49,7 @@ module Terraspace::Plugin::Summary
     def download_statefiles
       return unless download?
       FileUtils.rm_rf(@dest_folder)
-      logger.info("Downloading statefiles to #{@dest_folder}")
+      logger.debug("Downloading statefiles to #{@dest_folder}")
       download # INTERFACE METHOD
     end
 

data/lib/terraspace/terraform/remote_state/fetcher.rb

@@ -48,7 +48,7 @@ module Terraspace::Terraform::RemoteState
     def output_error(type)
       msg = case type
       when :key_not_found
-        "Output #{@output_key} was not found for the #{@parent.name} tfvars file. Either #{@child.name} stack has not been deployed yet or it does not have this output: #{@output_key}"
+        "Output #{@output_key} was not found for the #{@parent.name} tfvars file. Either #{@child.name} stack has not been deployed yet or it does not have this output: #{@output_key}. Also, if local backend is being used and has been removed/cleaned, then it will also result zero-byte state.json with the 'terraform state pull' used to download the terraform state and output will not be found."
       when :state_not_found
         "Output #{@output_key} could not be looked up for the #{@parent.name} tfvars file. #{@child.name} stack needs to be deployed"
       when :bucket_not_found
@@ -63,7 +63,7 @@ module Terraspace::Terraform::RemoteState
     @@download_shown = false
     def pull
       return if @@pull_successes[cache_key]
-      logger.info "Downloading tfstate files for dependencies defined in tfvars..." unless @@download_shown || @options[:quiet]
+      logger.debug "Downloading tfstate files for dependencies defined in tfvars..." unless @@download_shown || @options[:quiet]
       @@download_shown = true
       logger.debug "Downloading tfstate for stack: #{@child.name}"
 

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "1.1.0"
+  VERSION = "1.1.4"
 end

data/spec/terraspace/compiler/erb/render_spec.rb

@@ -1,6 +1,10 @@
 describe Terraspace::Compiler::Erb::Render do
   let(:render) { described_class.new(mod, src_path) }
-  let(:mod)    { Terraspace::Mod.new("a1") }
+  let(:mod)    do
+    mod = Terraspace::Mod.new("a1")
+    mod.resolved = false
+    mod
+  end
 
   # Only testing mod unresolved as a sanity check and its worth the ROI.
   # The resolved would the Fetcher. We have unit tests to cover those other changes.

data/terraspace.gemspec

@@ -12,6 +12,10 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://terraspace.cloud"
   spec.license       = "Apache-2.0"
 
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/boltops-tools/terraspace"
+  spec.metadata["changelog_uri"] = "https://github.com/boltops-tools/terraspace/blob/master/CHANGELOG.md"
+
   spec.files         = File.directory?('.git') ? `git ls-files`.split($/) : Dir.glob("**/*")
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.4
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-30 00:00:00.000000000 Z
+date: 2022-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -490,6 +490,7 @@ files:
 - lib/terraspace/builder/allow/env.rb
 - lib/terraspace/builder/allow/region.rb
 - lib/terraspace/builder/allow/stack.rb
+- lib/terraspace/builder/children.rb
 - lib/terraspace/bundle.rb
 - lib/terraspace/cli.rb
 - lib/terraspace/cli/all.rb
@@ -869,7 +870,10 @@ files:
 homepage: https://terraspace.cloud
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  homepage_uri: https://terraspace.cloud
+  source_code_uri: https://github.com/boltops-tools/terraspace
+  changelog_uri: https://github.com/boltops-tools/terraspace/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: