terraspace 0.6.2 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02ed3895b8039e7424e31139ce9f8e20c5d4a60142e8d3da64b5a68ce9e52004
-  data.tar.gz: 14617bab09a51e8229a209536585b5ff460355ac2c13cef26dd067b37a878cc0
+  metadata.gz: 790cbc55c399a3130eaaaa9e1e3af636a2b182cb28c2ca008e14a48d75883e47
+  data.tar.gz: 72d05ffb527f163d2b3be47542b77764ddbc599858e6dde6381058e992bc531c
 SHA512:
-  metadata.gz: 742c92857e31d85b66e7e232b14facd1745d9a35347e4634732670bd0b011937e4e46bcc7157e83cd9db10025a325004a6b391d21688b1e86c3bacf1ff8e429b
-  data.tar.gz: c3010333589ed88a15541a563cde963ae6d9e500acf519911966636563dadb9c698db9cb933945bf243d838d45b8c1fdf151f0602c887d9cbea09250069c3fa5
+  metadata.gz: a598f6c5e693d42c113a5aac0f4d2e63c41821a2414095ed65415fa6b11ab1636ce48d6a98ada24557c6b685642f1ac420fc9850544bd1cbda80e3de91036d48
+  data.tar.gz: f0a0955bbc1f7846e855141514a69b0aaffc81283081a5a90384fb85e4ec7946a65f19fa1dc3ff5df0e7c9f656ac5563fecca2c8a1a1959c83fa29d9daeae4bd

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.
 
+## [0.6.7] - 2021-05-05
+- [#108](https://github.com/boltops-tools/terraspace/pull/108) provide runner context to terraspace hook
+
+## [0.6.6] - 2021-04-15
+- [#101](https://github.com/boltops-tools/terraspace/pull/101) terraspace force-unlock command
+- [#102](https://github.com/boltops-tools/terraspace/pull/102) fix terraspace all summarized logging
+- [#103](https://github.com/boltops-tools/terraspace/pull/103) config.build.pass_files with default files use pass strategy
+
+## [0.6.5] - 2021-03-24
+- [#96](https://github.com/boltops-tools/terraspace/pull/96) terraspace fmt: ability to specific module or stack
+
+## [0.6.4] - 2021-03-22
+- [#94](https://github.com/boltops-tools/terraspace/pull/94) terraspace fmt command
+
+## [0.6.3] - 2021-03-12
+- [#91](https://github.com/boltops-tools/terraspace/pull/91) Camelcase
+- [#92](https://github.com/boltops-tools/terraspace/pull/92) disable terraform.plugin_cache by default
+- skip build config/helpers
+
 ## [0.6.2] - 2021-03-05
 - [#90](https://github.com/boltops-tools/terraspace/pull/90) Boot hooks: new and improved boot hooks interface
 - remove old config.hooks.on_boot

data/lib/terraspace/all/runner.rb

@@ -104,7 +104,7 @@ module Terraspace::All
     def run_terraspace(mod_name)
       set_log_path!(mod_name)
       name = command_map(@command)
-      o = @options.merge(mod: mod_name, yes: true, build: false, input: false)
+      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
       case @command
       when "up"

data/lib/terraspace/app.rb

@@ -27,6 +27,8 @@ module Terraspace
       config.build.cache_dir = ":CACHE_ROOT/:REGION/:ENV/:BUILD_DIR"
       config.build.cache_root = nil # defaults to /full/path/to/.terraspace-cache
       config.build.clean_cache = nil # defaults to /full/path/to/.terraspace-cache
+      config.build.default_pass_files = ["/files/"]
+      config.build.pass_files = []
       config.bundle = ActiveSupport::OrderedOptions.new
       config.bundle.logger = ts_logger
       config.init = ActiveSupport::OrderedOptions.new
@@ -45,7 +47,7 @@ module Terraspace
       config.terraform = ActiveSupport::OrderedOptions.new
       config.terraform.plugin_cache = ActiveSupport::OrderedOptions.new
       config.terraform.plugin_cache.dir = ENV['TF_PLUGIN_CACHE_DIR'] || "#{Terraspace.tmp_root}/plugin_cache"
-      config.terraform.plugin_cache.enabled = true
+      config.terraform.plugin_cache.enabled = false
       config.terraform.plugin_cache.purge_on_error = true
       config.test_framework = "rspec"
       config.tfc = ActiveSupport::OrderedOptions.new

data/lib/terraspace/cli.rb

@@ -27,6 +27,9 @@ module Terraspace
     reconfigure_option = Proc.new {
       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"
+    }
 
     desc "all SUBCOMMAND", "all subcommands"
     long_desc Help.text(:all)
@@ -82,6 +85,20 @@ module Terraspace
       Down.new(options.merge(mod: mod)).run
     end
 
+    desc "force_unlock", "Calls terrform force-unlock"
+    long_desc Help.text(:force_unlock)
+    instance_option.call
+    def force_unlock(mod, lock_id)
+      Commander.new("force-unlock", options.merge(mod: mod, lock_id: lock_id)).run
+    end
+
+    desc "fmt", "Run terraform fmt"
+    long_desc Help.text(:fmt)
+    type_option.call
+    def fmt(mod=nil)
+      Fmt.new(options.merge(mod: mod)).run
+    end
+
     desc "info STACK", "Get info about stack."
     long_desc Help.text(:info)
     instance_option.call
@@ -100,7 +117,7 @@ module Terraspace
 
     desc "list", "List stacks and modules."
     long_desc Help.text(:list)
-    option :type, default: "stack", aliases: %w[t], desc: "Type: stack, module, or all"
+    type_option.call
     def list
       List.new(options).run
     end

data/lib/terraspace/cli/concerns/source_dirs.rb

@@ -0,0 +1,13 @@
+module Terraspace::CLI::Concerns
+  module SourceDirs
+    # used by list
+    def source_dirs
+      Dir.glob("{app,vendor}/{modules,stacks}/*").select { |p| File.directory?(p) }.sort
+    end
+
+    # dont include vendor: used by fmt
+    def app_source_dirs
+      Dir.glob("{app}/{modules,stacks}/*").select { |p| File.directory?(p) }.sort
+    end
+  end
+end

data/lib/terraspace/cli/fmt.rb

@@ -0,0 +1,40 @@
+class Terraspace::CLI
+  class Fmt
+    include Concerns::SourceDirs
+    include Terraspace::Util::Logging
+
+    def initialize(options={})
+      @options = options
+      @mod_name = options[:mod]
+    end
+
+    def run
+      logger.info "Formating terraform files"
+      dirs.each do |dir|
+        format(dir)
+      end
+    end
+
+    def format(dir)
+      Runner.new(dir).format!
+    end
+
+  private
+    def dirs
+      if @mod_name
+        type_dirs.select { |p| p.include?(@mod_name) }
+      else
+        type_dirs
+      end
+    end
+
+    def type_dirs
+      type = @options[:type]
+      if type
+        app_source_dirs.select { |p| p.include?("/#{type.pluralize}/") }
+      else
+        app_source_dirs
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+class Terraspace::CLI::Fmt
+  class Runner
+    include Terraspace::CLI::Concerns::SourceDirs
+    include Terraspace::Util::Logging
+    SKIP_PATTERN = /\.skip$/
+
+    def initialize(dir)
+      @dir = dir
+    end
+
+    def format!
+      logger.info @dir.color(:green)
+      Dir.chdir(@dir) do
+        skip_rename
+        begin
+          terraform_fmt
+        ensure
+          restore_rename
+        end
+      end
+    end
+
+    def skip_rename
+      tf_files.each do |path|
+        if !skip?(path) && erb?(path)
+          FileUtils.mv(path, "#{path}.skip")
+        end
+      end
+    end
+
+    def terraform_fmt
+      sh "terraform fmt"
+    end
+
+    def sh(command)
+      logger.debug("=> #{command}")
+      success = system(command)
+      return if success
+      logger.info "WARN: There were some errors running terraform fmt for files in #{@dir}:".color(:yellow)
+      logger.info "The errors are shown above"
+    end
+
+    def restore_rename
+      tf_files.each do |path|
+        if skip?(path) && erb?(path)
+          FileUtils.mv(path, path.sub(SKIP_PATTERN, '')) # original name
+        end
+      end
+    end
+
+  private
+    def skip?(path)
+      !!(path =~ SKIP_PATTERN)
+    end
+
+    def erb?(path)
+      IO.readlines(path).detect { |l| l.include?('<%') }
+    end
+
+    def tf_files
+      Dir.glob("#{Terraspace.root}/#{@dir}/**/*.{tf,skip}").select { |p| File.file?(p) }
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+## Example
+
+Format all source files.
+
+    $ terraspace fmt
+    Formating terraform files
+    app/modules/example
+    main.tf
+    outputs.tf
+    variables.tf
+    app/stacks/demo
+    main.tf
+
+Format specific module or stack.
+
+    $ terraspace fmt stack1
+    $ terraspace fmt module1
+
+Format scoping to module or stack types. In case there's a module and stack with the same name.
+
+    $ terraspace fmt example -t module
+    $ terraspace fmt demo -t stacke

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

@@ -0,0 +1,7 @@
+## Example
+
+    terraspace force_unlock demo ab7f3469-2a5f-07b9-29c5-dec1537ec8b0
+
+Instance option:
+
+    terraspace force_unlock demo -i 2 ab7f3469-2a5f-07b9-29c5-dec1537ec8b0

data/lib/terraspace/cli/list.rb

@@ -1,13 +1,14 @@
 class Terraspace::CLI
   class List
+    include Concerns::SourceDirs
+
     def initialize(options={})
       @options = options
       @type_dir = normalized_type
     end
 
     def run
-      dirs = Dir.glob("{app,vendor}/{modules,stacks}/*").select { |p| File.directory?(p) }
-      dirs.sort.each do |path|
+      source_dirs.each do |path|
         if @type_dir
           puts path if path.include?("/#{@type_dir}/")
         else

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

@@ -26,9 +26,9 @@ class Terraspace::CLI::New
 
     def helper_class
       if type == "project"
-        "Terraspace::#{type.camelize}::#{name.camelize}Helper"
+        "Terraspace::#{type.camelcase}::#{name.camelcase}Helper"
       else
-        "Terraspace::#{type.camelize}::#{stack.camelize}::#{name.camelize}Helper"
+        "Terraspace::#{type.camelcase}::#{stack.camelcase}::#{name.camelcase}Helper"
       end
     end
 

data/lib/terraspace/compiler/builder.rb

@@ -74,10 +74,11 @@ module Terraspace::Compiler
     def skip?(src_path)
       return true unless File.file?(src_path)
       # certain folders will be skipped
-      src_path.include?("#{@mod.root}/tfvars") ||
       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}/test") ||
+      src_path.include?("#{@mod.root}/tfvars")
     end
   end
 end

data/lib/terraspace/compiler/helper_extender.rb

@@ -5,7 +5,7 @@ module Terraspace::Compiler
       full_dir = "#{@mod.root}/config/helpers"
       Dir.glob("#{full_dir}/**/*").each do |path|
         regexp = Regexp.new(".*/helpers/")
-        klass = path.sub(regexp, '').sub('.rb','').camelize
+        klass = path.sub(regexp, '').sub('.rb','').camelcase
         klass = "#{mod_namespace}::#{klass}"
         require path # able to use require instead of load since each helper has unique namespace
         send :extend, klass.constantize
@@ -15,8 +15,8 @@ module Terraspace::Compiler
     # IE: mod_namespace = Terraspace::Module::Demo
     # Use separate namespaces scope with module name so custom helper methods from different modules are isolated.
     def mod_namespace
-      mod_name = @mod.name.camelize
-      ns = "Terraspace::#{@mod.type.camelize}".constantize # IE: Terraspace::Module or Terraspace::Stack
+      mod_name = @mod.name.camelcase
+      ns = "Terraspace::#{@mod.type.camelcase}".constantize # IE: Terraspace::Module or Terraspace::Stack
       if ns.const_defined?(mod_name.to_sym)
         "#{ns}::#{mod_name}".constantize
       else

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

@@ -1,14 +1,15 @@
 module Terraspace::Compiler::Strategy
   class Mod < AbstractBase
     def run
-      ext = File.extname(@src_path).sub('.','')
-      klass = strategy_class(ext)
+      klass = strategy_class(@src_path)
       strategy = klass.new(@mod, @src_path) # IE: Terraspace::Compiler::Strategy::Mod::Rb.new
       strategy.run
     end
 
-    def strategy_class(ext)
+    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)
       "Terraspace::Compiler::Strategy::Mod::#{ext.camelize}".constantize rescue Mod::Pass
     end
   end

data/lib/terraspace/compiler/writer.rb

@@ -10,11 +10,17 @@ module Terraspace::Compiler
     end
 
     def dest_path
-      name = @dest_name || @src_path.sub('.rb','.tf.json')
+      name = get_name
       name = basename(name)
       "#{dest_dir}/#{name}"
     end
 
+    def get_name
+      return @dest_name if @dest_name
+      return @src_path if Terraspace.pass_file?(@src_path)
+      @src_path.sub('.rb','.tf.json')
+    end
+
     def dest_dir
       if @mod.is_a?(Terraspace::Mod::Remote)
         File.dirname(@src_path) # for Mod::Remote src is dest

data/lib/terraspace/core.rb

@@ -51,5 +51,12 @@ module Terraspace
     def logger=(v)
       @@logger = v
     end
+
+    def pass_file?(path)
+      pass_files = config.build.pass_files + config.build.default_pass_files
+      pass_files.uniq.detect do |i|
+        i.is_a?(Regexp) ? path =~ i : path.include?(i)
+      end
+    end
   end
 end

data/lib/terraspace/ext.rb

@@ -1,2 +1,3 @@
 require_relative "ext/bundler"
 require_relative "ext/core/module"
+require_relative "ext/core/string"

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

@@ -0,0 +1,5 @@
+class String
+  def camelcase
+    self.underscore.camelize
+  end
+end

data/lib/terraspace/hooks/runner.rb

@@ -2,6 +2,17 @@ module Terraspace::Hooks
   class Runner
     include Terraspace::Util
 
+    # exposing mod and hook so terraspace hooks have access to them via runner context. IE:
+    #
+    #     class EnvExporter
+    #       def call(runner)
+    #         puts "runner.hook #{runner.hook}"
+    #       end
+    #     end
+    #
+    # Docs: http://terraspace.cloud/docs/config/hooks/ruby/#method-argument
+    #
+    attr_reader :mod, :hook
     def initialize(mod, hook)
       @mod, @hook = mod, hook
       @execute = @hook["execute"]
@@ -12,12 +23,24 @@ module Terraspace::Hooks
       when String
         Terraspace::Shell.new(@mod, @execute, exit_on_fail: @hook["exit_on_fail"]).run
       when -> (e) { e.respond_to?(:public_instance_methods) && e.public_instance_methods.include?(:call) }
-        @execute.new.call
+        executor = @execute.new
       when -> (e) { e.respond_to?(:call) }
-        @execute.call
+        executor = @execute
       else
         logger.warn "WARN: execute option not set for hook: #{@hook.inspect}"
       end
+
+      if executor
+        meth = executor.method(:call)
+        case meth.arity
+        when 0
+          executor.call # backwards compatibility
+        when 1
+          executor.call(self)
+        else
+          raise "The #{executor} call method definition has been more than 1 arguments and is not supported"
+        end
+      end
     end
   end
 end

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

@@ -3,7 +3,7 @@ require "tempfile"
 module Terraspace::Terraform::Args
   class Default
     def initialize(mod, name, options={})
-      @mod, @name, @options = mod, name, options
+      @mod, @name, @options = mod, name.underscore, options
       @quiet = @options[:quiet].nil? ? true : @options[:quiet]
     end
 
@@ -11,14 +11,18 @@ module Terraspace::Terraform::Args
       # https://terraspace.cloud/docs/ci-automation/
       ENV['TF_IN_AUTOMATION'] = '1' if @options[:auto]
 
-      if %w[apply destroy init output plan show].include?(@name)
-        meth = "#{@name}_args"
-        send(meth)
+      args_meth = "#{@name}_args"
+      if respond_to?(args_meth)
+        send(args_meth)
       else
         []
       end
     end
 
+    def force_unlock_args
+      [" -force #{@options[:lock_id]}"]
+    end
+
     def apply_args
       args = auto_approve_arg
       var_files = @options[:var_files]

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "0.6.2"
+  VERSION = "0.6.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.7
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -482,7 +482,10 @@ files:
 - lib/terraspace/cli/completer.rb
 - lib/terraspace/cli/completer/script.rb
 - lib/terraspace/cli/completer/script.sh
+- lib/terraspace/cli/concerns/source_dirs.rb
 - lib/terraspace/cli/down.rb
+- lib/terraspace/cli/fmt.rb
+- lib/terraspace/cli/fmt/runner.rb
 - lib/terraspace/cli/help.rb
 - lib/terraspace/cli/help/all/down.md
 - lib/terraspace/cli/help/all/graph.md
@@ -504,6 +507,8 @@ files:
 - lib/terraspace/cli/help/completion_script.md
 - lib/terraspace/cli/help/console.md
 - lib/terraspace/cli/help/down.md
+- lib/terraspace/cli/help/fmt.md
+- lib/terraspace/cli/help/force_unlock.md
 - lib/terraspace/cli/help/info.md
 - lib/terraspace/cli/help/init.md
 - lib/terraspace/cli/help/list.md
@@ -623,6 +628,7 @@ files:
 - lib/terraspace/ext.rb
 - lib/terraspace/ext/bundler.rb
 - lib/terraspace/ext/core/module.rb
+- lib/terraspace/ext/core/string.rb
 - lib/terraspace/hooks/builder.rb
 - lib/terraspace/hooks/concern.rb
 - lib/terraspace/hooks/dsl.rb