terraspace 2.1.6 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 449ffd121de77d38b64d44f30a56639714f27fd3b0a7c50b00c4f897157c9ef5
-  data.tar.gz: 815fddcc7cfa9b01e335de6d160d941c6d1b4a025b6bab902a1aa4552752b9df
+  metadata.gz: 9173675976a0e7207ae8ce912195535f2dc43c7bba91c5a90808559ce543df2d
+  data.tar.gz: 6c7b089a9bd1d82873ac5148fc276a0ad3578236f6cf89a3742ea049ef461bbe
 SHA512:
-  metadata.gz: dc167ec202e62e70dd129d4ac85dc30a4179576315b880303205569434d7e31a35e5d331df64b2e478efb0459fcb902764ec6c860af650ea7ec8dcbc7caefe47
-  data.tar.gz: da40e6f0760f535a0e604aad16b31ddd708090521c070469739a0e13d0129542676951892e1859fd779b4bcbbda15a168e260cd43dc4e41964bbc0a0a28ffb48
+  metadata.gz: 72de399e443552b2981df770e22d2a710721f526aacabff3210ee28d85c4c870a2bdf61f02576b4cc1170789229beaa92feb89eba2269a0dbd7f07ccd6e7a152
+  data.tar.gz: eb40bc9c321f6f1fa9f2ba3a4f14f9f831b4aefc23af251655b65dccb58ac838c9493fff8dcde7ec1de007015689627e1ffb4d9049bdd04c871cfb9f4b363bde

data/CHANGELOG.md

@@ -3,6 +3,21 @@
 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.
 
+## [2.2.1] - 2022-09-08
+- [#265](https://github.com/boltops-tools/terraspace/pull/265) import command
+
+## [2.2.0] - 2022-09-02
+- [#261](https://github.com/boltops-tools/terraspace/pull/261) extra layer also process env-extra
+- [#262](https://github.com/boltops-tools/terraspace/pull/262) improve graph dependency processing: replace tfvars so only output and depends_on are evaluated
+- [#263](https://github.com/boltops-tools/terraspace/pull/263) layering small improvements
+- layering small improvements: dont use layers that end with - only
+- rename env var to TS_SHOW_ALL_LAYERS to TS_LAYERING_SHOW
+
+## [2.1.7] - 2022-08-22
+- [#259](https://github.com/boltops-tools/terraspace/pull/259) fix TS_PROJECT for ts cloud
+- builder: skip examples
+- improve generated config app.rb
+
 ## [2.1.6] - 2022-08-19
 - [#258](https://github.com/boltops-tools/terraspace/pull/258) Fix terraform apply/destroy missing some passthrough options
 

data/lib/templates/base/project/config/app.rb

@@ -1,6 +1,6 @@
 # Docs: https://terraspace.cloud/docs/config/reference/
 Terraspace.configure do |config|
-  config.logger.level = :info
+  # config.logger.level = :info
 
   # To enable Terraspace Cloud set config.cloud.org
   # config.cloud.org = "ORG"          # required: replace with your org. only letters, numbers, underscore and dashes allowed

data/lib/terraspace/app.rb

@@ -47,7 +47,7 @@ module Terraspace
       config.bundle.logger = ts_logger
 
       config.cloud = ActiveSupport::OrderedOptions.new
-      config.cloud.project = "main"
+      config.cloud.project = Terraspace.project
       config.cloud.org = ENV['TS_ORG'] # required for Terraspace cloud
       config.cloud.record = "changes" # IE: changes or all
       config.cloud.stack = ":APP-:ROLE-:MOD_NAME-:ENV-:EXTRA-:REGION"
@@ -72,7 +72,7 @@ module Terraspace
       config.layering.enable_names = ActiveSupport::OrderedOptions.new
       config.layering.enable_names.expansion = true
       config.layering.names = {}
-      config.layering.show = false
+      config.layering.show = cast_boolean(ENV['TS_LAYERING_SHOW'])
       config.layering.mode = ENV['TS_LAYERING_MODE'] || "simple" # simple, namespace, provider
 
       config.summary = ActiveSupport::OrderedOptions.new
@@ -104,7 +104,7 @@ module Terraspace
     # so dont have to add activemodel as a dependency just for this method
     FALSE_VALUES = [nil, false, 0, "0", "f", "F", "false", "FALSE", "off", "OFF"].to_set
     def cast_boolean(value)
-      if value == ""
+      if value.nil? || value == ""
         nil
       else
         !FALSE_VALUES.include?(value)

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

@@ -0,0 +1,29 @@
+## Examples
+
+    terraspace import aws_instance.this i-088a0a47e2e852cc8
+    terraspace import  module.vpc.aws_vpc.this vpc-000782e4951a734c7
+    terraspace import vpc module.vpc.aws_vpc.this vpc-000782e4951a734c7
+
+A general workflow is to use terraspace plan, inspect what resources, are missing and and import resources based on that. The `state list` command is also useful.
+
+    terraspace plan vpc
+    terraspace import vpc module.vpc.aws_vpc.this vpc-000782e4951a734c7
+    terraspace plan vpc
+    terraspace import vpc module.vpc.aws_internet_gateway.this[0] igw-0fa4bec3b4b46948a
+    terraspace state list vpc
+
+Example with output:
+
+    $ terraspace import vpc module.vpc.aws_internet_gateway.this[0] igw-0fa4bec3b4b46948a
+    Building .terraspace-cache/us-west-2/dev/stacks/vpc
+    Current directory: .terraspace-cache/us-west-2/dev/stacks/vpc
+    => terraform import module.vpc.aws_internet_gateway.this[0] igw-0fa4bec3b4b46948a
+    module.vpc.aws_internet_gateway.this[0]: Importing from ID "igw-0fa4bec3b4b46948a"...
+    module.vpc.aws_internet_gateway.this[0]: Import prepared!
+      Prepared aws_internet_gateway for import
+    module.vpc.aws_internet_gateway.this[0]: Refreshing state... [id=igw-0fa4bec3b4b46948a]
+
+    Import successful!
+
+    The resources that were imported are shown above. These resources are now in
+    your Terraform state and will henceforth be managed by Terraform.

data/lib/terraspace/cli/import.rb

@@ -0,0 +1,12 @@
+class Terraspace::CLI
+  class Import < Base
+    def run
+      commander.run
+    end
+
+    def commander
+      Commander.new("import", @options)
+    end
+    memoize :commander
+  end
+end

data/lib/terraspace/cli.rb

@@ -109,6 +109,12 @@ module Terraspace
       Fmt.new(options.merge(mod: mod)).run
     end
 
+    desc "import ADDR ID", "Import existing infrastructure into your Terraform state"
+    long_desc Help.text(:import)
+    def import(mod, addr, id)
+      Import.new(options.merge(mod: mod, addr: addr, id: id)).run
+    end
+
     desc "info STACK", "Get info about stack."
     long_desc Help.text(:info)
     instance_option.call

data/lib/terraspace/compiler/erb/render.rb

@@ -6,7 +6,13 @@ module Terraspace::Compiler::Erb
 
     def build
       context = Context.new(@mod)
-      RenderMePretty.result(@src_path, context: context)
+      if @mod.resolved
+        RenderMePretty.result(@src_path, context: context)
+      else
+        # Replace contents so only the `output` and `depends_on` are evaluated
+        temp_path = Rewrite.new(@src_path).rewrite
+        RenderMePretty.result(temp_path, context: context)
+      end
     end
   end
 end

data/lib/terraspace/compiler/erb/rewrite.rb

@@ -0,0 +1,42 @@
+module Terraspace::Compiler::Erb
+  class Rewrite
+    def initialize(src_path)
+      @src_path = src_path
+    end
+
+    def rewrite
+      input = IO.read(@src_path)
+      output = replace(input)
+      tfvar_path = @src_path.sub(Terraspace.root,'')
+      temp_path = "/tmp/terraspace/rewrite#{tfvar_path}"
+      FileUtils.mkdir_p(File.dirname(temp_path))
+      IO.write(temp_path, output)
+      temp_path
+    end
+
+    # Replace contents so only the `output` and `depends_on` are evaluated
+    def replace(input)
+      lines = input.split("\n").map {|l| l+"\n"} # mimic IO.readlines
+      new_lines = lines.map do |line|
+        new_line(line)
+      end
+      new_lines.join('')
+    end
+
+    def new_line(line)
+      md = line.match(/.*(<% |<%=)/) || line.match(/.*<%$/)
+      if md
+        words = %w[output depends_on] # TODO: consider allowing user customizations
+        # IE: <%= output or <% depends_on
+        regexp = Regexp.new(".*<%.*#{words.join('|')}.*")
+        if line.match(regexp)
+          line # passthrough
+        else
+          line.sub('<%', '<%#') # replace with ERB opening comment
+        end
+      else
+        line # passthrough
+      end
+    end
+  end
+end

data/lib/terraspace/compiler/perform.rb

@@ -21,6 +21,9 @@ module Terraspace::Compiler
 
     def compile_module
       with_mod_file do |src_path|
+        # Skip examples. Dont want to process tfvars <%= output(...) %> which triggers dependency graph
+        # Also a speed improvement.
+        next if src_path.include?("#{@mod.root}/examples/")
         compile_mod_file(src_path)
       end
     end

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

@@ -70,6 +70,7 @@ class Terraspace::Compiler::Strategy::Tfvar
         sum += layer_levels(layer) unless layer.nil?
         sum
       end
+      all = all.reject { |layer| layer.ends_with?('-') }
       all.map! do |layer|
         layer = layer.blank? ? layer : "/#{layer}"
         [
@@ -92,7 +93,7 @@ class Terraspace::Compiler::Strategy::Tfvar
         logger.info "See: http://terraspace.test/docs/layering/instance-option/"
       end
       extra = Terraspace.extra || @mod.instance
-      levels = ["base", Terraspace.env, extra].reject(&:blank?) # layer levels. @mod.instance can be nil
+      levels = ["base", Terraspace.env, extra, "#{Terraspace.env}-#{extra}"].reject(&:blank?) # layer levels. @mod.instance can be nil
       levels.map! do |i|
         # base layer has prefix of '', reject with blank so it doesnt produce '//'
         [prefix, i].reject(&:blank?).join('/')
@@ -158,11 +159,11 @@ class Terraspace::Compiler::Strategy::Tfvar
       return unless @mod.resolved
       return if @@shown_layers[@mod.name]
       logger.debug "Layers for #{@mod.name}:"
-      show = Terraspace.config.layering.show || ENV['TS_SHOW_ALL_LAYERS']
+      show = Terraspace.config.layering.show || ENV['TS_LAYERING_SHOW_ALL']
       paths.each do |path|
         next if ARGV[0] == "all" # dont show layers with all command since fork happens after build
         next unless path.include?('.tfvars')
-        if ENV['TS_SHOW_ALL_LAYERS']
+        if ENV['TS_LAYERING_SHOW_ALL']
           message = "    #{pretty_path(path)}"
           message = "#{message} (found)".color(:yellow) if File.exist?(path)
           logger.info message

data/lib/terraspace/core.rb

@@ -20,7 +20,7 @@ module Terraspace
 
     def project
       if ENV['TS_PROJECT'].blank?
-        config.cloud.project
+        "main"
       else
         ENV['TS_PROJECT']
       end

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

@@ -117,6 +117,10 @@ module Terraspace::Terraform::Args
       auto_approve_arg
     end
 
+    def import_args
+      [@options[:addr], @options[:id]]
+    end
+
     def auto_approve_arg
       @options[:yes] || @options[:auto] ? ["-auto-approve"] : []
     end

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "2.1.6"
+  VERSION = "2.2.1"
 end

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

@@ -13,7 +13,7 @@ describe Terraspace::Compiler::Erb::Render do
     it "build" do
       allow(Terraspace::Terraform::RemoteState::Marker::Output).to receive(:stack_names).and_return("b1")
       result = render.build
-      expect(result).to eq "length = (unresolved)"
+      expect(result).to eq "length = (unresolved)\n"
     end
   end
 end

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

@@ -0,0 +1,30 @@
+describe Terraspace::Compiler::Erb::Rewrite do
+  let(:rewrite) { described_class.new(src_path) }
+
+  context "has output" do
+    let(:src_path) { fixture("rewrite/dev.tfvars") }
+    it "replace" do
+      input =<<~EOL
+        length = <%= output('b1.length') %>
+        foo = <%= foo %>
+        <% depends_on "b1" %>
+        <%
+        3.times do |i|
+          puts i
+        end
+        %>
+      EOL
+      text = rewrite.replace(input)
+      expect(text).to eq <<~EOL
+        length = <%= output('b1.length') %>
+        foo = <%#= foo %>
+        <% depends_on "b1" %>
+        <%#
+        3.times do |i|
+          puts i
+        end
+        %>
+      EOL
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 2.1.6
+  version: 2.2.1
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -571,6 +571,7 @@ files:
 - lib/terraspace/cli/help/down.md
 - lib/terraspace/cli/help/fmt.md
 - lib/terraspace/cli/help/force_unlock.md
+- lib/terraspace/cli/help/import.md
 - lib/terraspace/cli/help/info.md
 - lib/terraspace/cli/help/init.md
 - lib/terraspace/cli/help/list.md
@@ -604,6 +605,7 @@ files:
 - lib/terraspace/cli/help/tfc/sync.md
 - lib/terraspace/cli/help/up.md
 - lib/terraspace/cli/help/validate.md
+- lib/terraspace/cli/import.rb
 - lib/terraspace/cli/info.rb
 - lib/terraspace/cli/init.rb
 - lib/terraspace/cli/list.rb
@@ -703,6 +705,7 @@ files:
 - lib/terraspace/compiler/erb/context.rb
 - lib/terraspace/compiler/erb/helpers.rb
 - lib/terraspace/compiler/erb/render.rb
+- lib/terraspace/compiler/erb/rewrite.rb
 - lib/terraspace/compiler/expander.rb
 - lib/terraspace/compiler/expander/backend.rb
 - lib/terraspace/compiler/helper_extender.rb
@@ -926,6 +929,7 @@ files:
 - spec/terraspace/compiler/dsl/terraform_spec.rb
 - spec/terraspace/compiler/dsl/variable_spec.rb
 - spec/terraspace/compiler/erb/render_spec.rb
+- spec/terraspace/compiler/erb/rewrite_spec.rb
 - spec/terraspace/dependency/graph_spec.rb
 - spec/terraspace/dependency/helper/depends_on_spec.rb
 - spec/terraspace/dependency/helper/output_spec.rb
@@ -961,7 +965,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.3.21
 signing_key: 
 specification_version: 4
 summary: 'Terraspace: The Terraspace Framework'
@@ -1083,6 +1087,7 @@ test_files:
 - spec/terraspace/compiler/dsl/terraform_spec.rb
 - spec/terraspace/compiler/dsl/variable_spec.rb
 - spec/terraspace/compiler/erb/render_spec.rb
+- spec/terraspace/compiler/erb/rewrite_spec.rb
 - spec/terraspace/dependency/graph_spec.rb
 - spec/terraspace/dependency/helper/depends_on_spec.rb
 - spec/terraspace/dependency/helper/output_spec.rb