terraspace 2.2.14 → 2.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6aa27ac1150e1d8a655455563ed6b65ebbcb7393c6f93c70cbb2c6940a06b9a
-  data.tar.gz: d314706f83d8376cfed32d2cf1c96c19e4ce1b8196da53c8f69b93af838dc13c
+  metadata.gz: b9c22ae76e1a5a79215b5ab6da41cc2c7df6d2cee1a21bbf365de2bdeaef4223
+  data.tar.gz: 5d791b92e6baedce784edd7fd2dbd5d61fce961774f3a1486f3dca3e070b7dc3
 SHA512:
-  metadata.gz: dd0e67073071970c300fffe59988b934a72fcb7755d78e5257034c41d963a39395d8a6a379d8cdd536201aa85c8601abcaadeb261afd91fe56b842e0726520a6
-  data.tar.gz: 8d8bb60a136df285e62014e7a8f40c07d7d9dda3ef7c08fa024fca0bd4dbe0c81f8b902b9b50939127bfb70cd39fa841a9c65a84067f2e9286bd241f4b99bd18
+  metadata.gz: 6d530a184243d107a63ff98bfbd23bc40d1902f9b1611ae95089a684d71bf93bdddebc257238136ce7aad150641618ff811d129740561782c688702489258607
+  data.tar.gz: 9cbbe9eaedf4f790e49628d55804e7a072c956639d3e31fb3089da1d99833990ea61ee16c1af2ec659a0b0b0935e57d518d8c523f4f218ae9fbcbd762e1617d2

data/CHANGELOG.md

@@ -3,6 +3,19 @@
 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.16] - 2024-01-12
+- [#339](https://github.com/boltops-tools/terraspace/pull/339) Use Terraspace.tmp_root value instead of hard-coded '/tmp/terraspace'
+- [#345](https://github.com/boltops-tools/terraspace/pull/345) Update to use terraform_bin for state pull and help
+
+## [2.2.15] - 2023-10-18
+- [#331](https://github.com/boltops-tools/terraspace/pull/331) adding tainting/untainting as a terraspace command
+- [#332](https://github.com/boltops-tools/terraspace/pull/332) terraspace fmt: generalize and pass through fmt option
+- [#333](https://github.com/boltops-tools/terraspace/pull/333) remove unused noop and verbose options
+- [#334](https://github.com/boltops-tools/terraspace/pull/334) fix taint and untaint and support pass through args
+- [#335](https://github.com/boltops-tools/terraspace/pull/335) use tofu fork when available
+- [#336](https://github.com/boltops-tools/terraspace/pull/336) improve tfvars lookup location to include config/stacks/demo/tfvars
+- [#337](https://github.com/boltops-tools/terraspace/pull/337) update cli help examples to config/stacks/demo/tfvars folder
+
 ## [2.2.14] - 2023-09-12
 - [#329](https://github.com/boltops-tools/terraspace/pull/329) fix terraspace check
 

data/lib/terraspace/check.rb

@@ -77,11 +77,10 @@ module Terraspace
       EOL
     end
 
-    # Note opentf is not an official fork yet. Mocked it out for testing.
-    # Should be ready to swap out the official fork name when it is ready.
-    BINS = %w[opentf terraform]
+    BINS = %w[tofu terraform]
     @@terraform_bin = nil
     def terraform_bin
+      return ENV['TS_TERRAFORM_BIN'] if ENV['TS_TERRAFORM_BIN']
       return @@terraform_bin if @@terraform_bin.present?
       BINS.each do |bin|
         if Gem.win_platform?
@@ -115,8 +114,8 @@ module Terraspace
     #
     # Another example
     #
-    #     $ opentf --version
-    #     OpenTF v0.12.24
+    #     $ tofu --version
+    #     OpenTofu v1.6.0
     #
     # Note: The -json option is only available in v0.13+
     def terraform_version

data/lib/terraspace/cli/fmt/runner.rb

@@ -2,10 +2,9 @@ class Terraspace::CLI::Fmt
   class Runner
     include Terraspace::CLI::Concerns::SourceDirs
     include Terraspace::Util::Logging
-    SKIP_PATTERN = /\.skip$/
 
-    def initialize(dir)
-      @dir = dir
+    def initialize(dir, options)
+      @dir, @options = dir, options
     end
 
     def format!
@@ -13,7 +12,7 @@ class Terraspace::CLI::Fmt
 
       exit_status = nil
       Dir.chdir(@dir) do
-        skip_rename
+        rename_to_skip_fmt
         begin
           exit_status = terraform_fmt
         ensure
@@ -23,7 +22,7 @@ class Terraspace::CLI::Fmt
       exit_status
     end
 
-    def skip_rename
+    def rename_to_skip_fmt
       tf_files.each do |path|
         if !skip?(path) && erb?(path)
           FileUtils.mv(path, "#{path}.skip")
@@ -32,19 +31,29 @@ class Terraspace::CLI::Fmt
     end
 
     def terraform_fmt
-      sh "#{Terraspace.terraform_bin} fmt"
+      sh "#{Terraspace.terraform_bin} fmt #{args}"
+    end
+
+    def args
+      mod = nil # not needed here
+      pass = Terraspace::Terraform::Args::Pass.new(mod, "fmt", @options)
+      pass.args.flatten.join(' ')
     end
 
     def sh(command)
       logger.debug("=> #{command}")
-      success = system(command)
-      unless success
-        logger.info "WARN: There were some errors running terraform fmt for files in #{@dir}:".color(:yellow)
+      system(command)
+      case $?.exitstatus
+      when 2 # errors fmt
+        logger.info "WARN: There were some errors running #{Terraspace.terraform_bin} fmt for files in #{@dir}:".color(:yellow)
         logger.info "The errors are shown above"
+      when 3 # fmt ran and changes were made
+        logger.debug "fmt ran and changes were made unless -check or -write=false"
       end
       $?.exitstatus
     end
 
+    SKIP_PATTERN = /\.skip$/
     def restore_rename
       tf_files.each do |path|
         if skip?(path) && erb?(path)

data/lib/terraspace/cli/fmt.rb

@@ -10,7 +10,7 @@ class Terraspace::CLI
 
     @@exit_status = 0
     def run
-      logger.info "Formating terraform files"
+      logger.info "Formatting terraform files"
       dirs.each do |dir|
         exit_status = format(dir)
         @@exit_status = exit_status if exit_status != 0
@@ -19,7 +19,7 @@ class Terraspace::CLI
     end
 
     def format(dir)
-      Runner.new(dir).format!
+      Runner.new(dir, @options).format!
     end
 
   private

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

@@ -24,3 +24,13 @@ Format scoping to module or stack types. In case there's a module and stack with
 Format all, so both modules and stacks:
 
     $ terraspace fmt -t all
+
+Check format of all source files, but don't fix. Examples:
+
+    $ terraspace fmt demo -write=false -list
+    $ terraspace fmt demo -check
+    $ terraspace fmt -write=false -list
+
+## Some Notes
+
+The `terraspace fmt` will only format terraform source files that do not have any ERB templating logic in it. It will format the files directly in your source code. IE: app/stacks/demo

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

@@ -3,5 +3,5 @@
     $ terraspace seed demo
     Seeding tfvar files for demo
     Reading: .terraspace-cache/us-west-2/dev/stacks/demo/variables.tf
-          create  app/stacks/demo/tfvars/dev.tfvars
+          create  config/stacks/demo/tfvars/dev.tfvars
     $

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

@@ -0,0 +1,13 @@
+## Examples
+
+    terraspace taint ec2 aws_instance.my_instance
+
+Example with output:
+
+	$ terraspace taint ec2 aws_instance.my_instance
+	Building .terraspace-cache/us-east-1/dev/stacks/ec2
+	Hook: Running terraspace before build hook.
+	Current directory: .terraspace-cache/us-east-1/dev/stacks/ec2
+	 => terraform taint aws_instance.my_instance
+	Resource instance aws_instance.my_instance has been successfully tainted.
+	Releasing state lock. This may take a few moments...

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

@@ -0,0 +1,13 @@
+## Examples
+
+    terraspace untaint ec2 aws_instance.my_instance
+
+Example with output:
+
+	$ terraspace taint ec2 aws_instance.my_instance
+	Building .terraspace-cache/us-east-1/dev/stacks/ec2
+	Hook: Running terraspace before build hook.
+	Current directory: .terraspace-cache/us-east-1/dev/stacks/ec2
+	 => terraform untaint aws_instance.my_instance
+	Resource instance aws_instance.my_instance has been successfully untainted.
+	Releasing state lock. This may take a few moments...

data/lib/terraspace/cli/taint.rb

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

data/lib/terraspace/cli/untaint.rb

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

data/lib/terraspace/cli.rb

@@ -2,9 +2,6 @@ module Terraspace
   class CLI < Command
     include Concern
 
-    class_option :verbose, type: :boolean
-    class_option :noop, type: :boolean
-
     yes_option = Proc.new {
       option :yes, aliases: :y, type: :boolean, desc: "-auto-approve the terraform apply"
     }
@@ -111,8 +108,9 @@ module Terraspace
     desc "fmt", "Run terraform fmt"
     long_desc Help.text(:fmt)
     type_option.call
-    def fmt(mod=nil)
-      Fmt.new(options.merge(mod: mod)).run
+    def fmt(*args)
+      mod = args.shift if args.first && !args.first.include?('-')
+      Fmt.new(options.merge(mod: mod, args: args)).run
     end
 
     desc "import STACK ADDR ID", "Import existing infrastructure into your Terraform state"
@@ -214,6 +212,12 @@ module Terraspace
       State.new(options.merge(subcommand: subcommand, mod: mod, rest: rest)).run
     end
 
+    desc "taint STACK ADDR", "Mark a resource instance as not fully functional."
+    long_desc Help.text(:taint)
+    def taint(mod, addr, *args)
+      Taint.new(options.merge(mod: mod, addr: addr, args: args)).run
+    end
+
     desc "test", "Run test."
     long_desc Help.text(:test)
     def test
@@ -228,6 +232,12 @@ module Terraspace
       Commander.new("output", options.merge(mod: mod, args: args)).run
     end
 
+    desc "untaint STACK ADDR", "Remove the 'tainted' state from a resource instance."
+    long_desc Help.text(:untaint)
+    def untaint(mod, addr, *args)
+      Untaint.new(options.merge(mod: mod, addr: addr, args: args)).run
+    end
+
     desc "up STACK", "Deploy infrastructure stack."
     long_desc Help.text(:up)
     auto_option.call

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

@@ -8,7 +8,7 @@ module Terraspace::Compiler::Erb
       input = IO.read(@src_path)
       output = replace(input)
       tfvar_path = @src_path.sub(Terraspace.root,'')
-      temp_path = "/tmp/terraspace/rewrite#{tfvar_path}"
+      temp_path = "#{Terraspace.tmp_root}/rewrite#{tfvar_path}"
       FileUtils.mkdir_p(File.dirname(temp_path))
       IO.write(temp_path, output)
       temp_path

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

@@ -39,9 +39,10 @@ class Terraspace::Compiler::Strategy::Tfvar
     end
 
     def paths
-      project_paths = full_paths(project_tfvars_dir)
-      stack_paths   = full_paths(stack_tfvars_dir)
-      paths = (project_paths + stack_paths).uniq
+      config_terraform = full_paths(config_terraform_tfvars_dir) # deprecated
+      app_stacks = full_paths(app_stacks_tfvars_dir) # deprecated
+      config_stacks = full_paths(config_stacks_tfvars_dir)   # recommended
+      paths = (config_terraform + app_stacks + config_stacks).uniq
       show_layers(paths)
       paths.select do |path|
         File.exist?(path)
@@ -131,27 +132,19 @@ class Terraspace::Compiler::Strategy::Tfvar
       layers
     end
 
-    def project_tfvars_dir
+    # IE: config/terraform/tfvars
+    def config_terraform_tfvars_dir
       "#{Terraspace.root}/config/terraform/tfvars"
     end
 
-    # seed dir takes higher precedence than the tfvars folder within the stack module. Example:
-    #
-    #     seed/tfvars/stacks/demo (folder must have *.tfvars or *.rb files)
-    #     app/stacks/demo/tfvars
-    #
-    # This allows user to take over the tfvars embedded in the stack if they need to. Generally,
-    # putting tfvars in within the app/stacks/MOD/tfvars folder seems cleaner and easier to follow.
-    #
-    # Will also consider app/modules/demo/tfvars. Though modules to be reuseable and stacks is where business logic
-    # should go.
-    #
-    def stack_tfvars_dir
-      seed_dir = "#{Terraspace.root}/seed/tfvars/#{@mod.build_dir(disable_extra: true)}"
-      mod_dir = "#{@mod.root}/tfvars"
+    # IE: app/stacks/demo/tfvars
+    def app_stacks_tfvars_dir
+      "#{@mod.root}/tfvars"
+    end
 
-      empty = Dir.glob("#{seed_dir}/*").empty?
-      empty ? mod_dir : seed_dir
+    # IE: config/stacks/demo/tfvars
+    def config_stacks_tfvars_dir
+      "#{Terraspace.root}/config/#{@mod.build_dir(disable_extra: true)}/tfvars"
     end
 
     @@shown_layers = {}

data/lib/terraspace/seeder/where.rb

@@ -5,30 +5,19 @@ class Terraspace::Seeder
     end
 
     def dest_path
-      case @options[:where]
-      when "app"
-        app_path
-      when "seed"
-        seed_path
+      if @options[:where] == "app"
+        seed_path("app")
       else
-        infer_dest_path
+        seed_path("config")
       end
     end
 
-    def infer_dest_path
-      @mod.type == "stack" ? app_path : seed_path
-    end
-
-    def app_path
-      "#{Terraspace.root}/app/#{@mod.build_dir}/tfvars/#{seed_file}.tfvars"
-    end
-
-    def seed_path
-      "#{Terraspace.root}/seed/tfvars/#{@mod.build_dir}/#{seed_file}.tfvars"
+    def seed_path(folder)
+      "#{Terraspace.root}/#{folder}/#{@mod.build_dir(disable_extra: true)}/tfvars/#{seed_file}.tfvars"
     end
 
     def seed_file
-      @options[:instance] || Terraspace.env
+      [Terraspace.app, Terraspace.role, Terraspace.env, Terraspace.extra].compact.join("/")
     end
   end
 end

data/lib/terraspace/terraform/api/vars/json.rb

@@ -16,7 +16,7 @@ class Terraspace::Terraform::Api::Vars
     rescue JSON::ParserError => e
       # TODO: show exact line with error
       logger.info("ERROR in json: #{e.class}: #{e.message}")
-      path = "/tmp/terraspace/debug/vars.json"
+      path = "#{Terraspace.tmp_root}/terraspace/debug/vars.json"
       logger.info("Result also written to #{path} for inspection")
       FileUtils.mkdir_p(File.dirname(path))
       IO.write(path, result)

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

@@ -114,7 +114,7 @@ module Terraspace::Terraform::Args
 
     @@terraform_help = {}
     def terraform_help(name)
-      @@terraform_help[name] ||= `terraform #{name} -help`
+      @@terraform_help[name] ||= `#{Terraspace.terraform_bin} #{name} -help`
     end
   end
 end

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

@@ -121,6 +121,14 @@ module Terraspace::Terraform::Args
       [@options[:addr], @options[:id]]
     end
 
+    def taint_args
+      [@options[:addr]]
+    end
+
+    def untaint_args
+      [@options[:addr]]
+    end
+
     def auto_approve_arg
       @options[:yes] || @options[:auto] ? ["-auto-approve"] : []
     end

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

@@ -71,7 +71,7 @@ module Terraspace::Terraform::RemoteState
       return unless success
 
       FileUtils.mkdir_p(File.dirname(state_path))
-      command = "cd #{@child.cache_dir} && terraform state pull > #{state_path}"
+      command = "cd #{@child.cache_dir} && #{Terraspace.terraform_bin} state pull > #{state_path}"
       logger.debug "=> #{command}"
       success = system(command)
       # Can error if using a old terraform version and the statefile was created with a newer version of terraform

data/lib/terraspace/terraform/tfc/runs/pruner.rb

@@ -66,7 +66,7 @@ class Terraspace::Terraform::Tfc::Runs
       action = discardable?(item) ? "Discarded" : "Cancelled"
       p = ItemPresenter.new(item)
       msg = "#{action} #{p.id} #{p.message}" # note id is named run-xxx
-      logger.info("NOOP: #{msg}") && return if @options[:noop]
+      logger.info("NOOP: #{msg}") && return if ENV['NOOP']
 
       if discardable?(item)
         api.runs.discard(id)

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "2.2.14"
+  VERSION = "2.2.16"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 2.2.14
+  version: 2.2.16
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
+date: 2024-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -599,12 +599,14 @@ files:
 - lib/terraspace/cli/help/show.md
 - lib/terraspace/cli/help/state.md
 - lib/terraspace/cli/help/summary.md
+- lib/terraspace/cli/help/taint.md
 - lib/terraspace/cli/help/test.md
 - lib/terraspace/cli/help/tfc/destroy.md
 - lib/terraspace/cli/help/tfc/list.md
 - lib/terraspace/cli/help/tfc/runs/list.md
 - lib/terraspace/cli/help/tfc/runs/prune.md
 - lib/terraspace/cli/help/tfc/sync.md
+- lib/terraspace/cli/help/untaint.md
 - lib/terraspace/cli/help/up.md
 - lib/terraspace/cli/help/validate.md
 - lib/terraspace/cli/import.rb
@@ -640,10 +642,12 @@ files:
 - lib/terraspace/cli/setup.rb
 - lib/terraspace/cli/state.rb
 - lib/terraspace/cli/summary.rb
+- lib/terraspace/cli/taint.rb
 - lib/terraspace/cli/test.rb
 - lib/terraspace/cli/tfc.rb
 - lib/terraspace/cli/tfc/runs.rb
 - lib/terraspace/cli/tfc_concern.rb
+- lib/terraspace/cli/untaint.rb
 - lib/terraspace/cli/up.rb
 - lib/terraspace/cloud/api.rb
 - lib/terraspace/cloud/api/cani.rb
@@ -966,7 +970,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.5.4
 signing_key: 
 specification_version: 4
 summary: 'Terraspace: The Terraspace Framework'