terraspace 0.6.0 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e6515cd30855a02e17147354db57995da471812f6437611140f715726268bb6
-  data.tar.gz: 33a4066b1a30d091fe7881bbafccc0778f47715d6bea7671ba9f011e1f3702a5
+  metadata.gz: 75c6662ef1dbdb9fc52cdde609425bf17c780b20989692491f30cae96f04a10d
+  data.tar.gz: 6f3723c71e6e895633f3108950afb0cabace1d927216661aad06416e588bfdd8
 SHA512:
-  metadata.gz: 6b3b7c108ac28b8cf83c4cde07ed64f4fc84d8109bc77c5b1ddaa3018e70393e9cb57cbc7fc65315e7877e55833bd434695753ed8cb71b31bb249a440c96c910
-  data.tar.gz: 3b85a43ae356e6c95def1ab614ef86af19e3c875752d265a5de55ada4f66b12830d514d2655841f973690b449d8fc38f610ac6b146ba943e3d37d72694e86d79
+  metadata.gz: dc9c700c27a5e725532c940955316c4cad16e724a094885df3ea419b40d26fb26d9be959af5131114602efa73a5329fd9fab60b1cd09e86856efcd4f4f0942c2
+  data.tar.gz: 5f2f327d1aebf535ad92864c9c2cf312b426bd0e814273e12e718351015bd8652487ba34978e0bc3aeab464fb3ebf7362dba08412f02ef83fd76d1ec9ea47d60

data/CHANGELOG.md

@@ -3,11 +3,27 @@
 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.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
+
+## [0.6.1] - 2021-03-04
+- [#89](https://github.com/boltops-tools/terraspace/pull/89) rename option to enable_names.expansion
+
 ## [0.6.0] - 2021-03-03
-- Update README.md
 - [#87](https://github.com/boltops-tools/terraspace/pull/87) rename cloud to tfc command and improvements
 - [#88](https://github.com/boltops-tools/terraspace/pull/88) custom layering support
-- Rename `terraspace cloud` to `terraspace tfc` and tfc improvements
 - Improve stdout handling, so this works: `terraspace show demo --json | jq`
 - `terraspace plan --output plan.save` writes to relative cache path.
 - `terraspace up --plan plan.save` copies plan.save to cache path.

data/lib/terraspace/app.rb

@@ -29,7 +29,6 @@ module Terraspace
       config.build.clean_cache = nil # defaults to /full/path/to/.terraspace-cache
       config.bundle = ActiveSupport::OrderedOptions.new
       config.bundle.logger = ts_logger
-      config.hooks = Hooks.new
       config.init = ActiveSupport::OrderedOptions.new
       config.init.mode = "auto" # auto, never, always
       config.log = ActiveSupport::OrderedOptions.new
@@ -40,13 +39,13 @@ module Terraspace
       config.layering = ActiveSupport::OrderedOptions.new
       config.layering.names = {}
       config.layering.enable_names = ActiveSupport::OrderedOptions.new
-      config.layering.enable_names.cache_dir = true
+      config.layering.enable_names.expansion = true
       config.summary = ActiveSupport::OrderedOptions.new
       config.summary.prune = false
       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/booter.rb

@@ -1,10 +1,9 @@
 module Terraspace
   module Booter
     def boot
+      run_hooks
       Terraspace::Bundle.require # load plugins
       load_plugin_default_configs
-      Terraspace.config # load project config
-      Terraspace::App::Hooks.run_hook(:on_boot)
       Terraspace::App::Inits.run_all
       set_plugin_cache!
     end
@@ -24,6 +23,23 @@ module Terraspace
       dir
     end
 
+    # Special boot hooks run super early, even before plugins are loaded.
+    # Useful for setting env vars and other early things.
+    #
+    #    config/boot.rb
+    #    config/boot/dev.rb
+    #
+    def run_hooks
+      run_hook
+      run_hook(Terraspace.env)
+    end
+
+    def run_hook(env=nil)
+      name = env ? "boot/#{env}" : "boot"
+      path = "#{Terraspace.root}/config/#{name}.rb"
+      require path if File.exist?(path)
+    end
+
     extend self
   end
 end

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,13 @@ module Terraspace
       Down.new(options.merge(mod: mod)).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 +110,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/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/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/plugin/expander/interface.rb

@@ -70,7 +70,7 @@ module Terraspace::Plugin::Expander
     def var_value(name)
       name = name.sub(':','').downcase
       value = send(name)
-      if name == "namespace" && Terraspace.config.layering.enable_names.cache_dir
+      if name == "namespace" && Terraspace.config.layering.enable_names.expansion
         value = friendly_name(value)
       end
       value

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "0.6.0"
+  VERSION = "0.6.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.5
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -461,7 +461,6 @@ files:
 - lib/terraspace/all/runner.rb
 - lib/terraspace/all/summary.rb
 - lib/terraspace/app.rb
-- lib/terraspace/app/hooks.rb
 - lib/terraspace/app/inits.rb
 - lib/terraspace/autoloader.rb
 - lib/terraspace/booter.rb
@@ -483,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
@@ -505,6 +507,7 @@ 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/info.md
 - lib/terraspace/cli/help/init.md
 - lib/terraspace/cli/help/list.md
@@ -624,6 +627,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

data/lib/terraspace/app/hooks.rb

@@ -1,18 +0,0 @@
-class Terraspace::App
-  class Hooks
-    class_attribute :hooks
-    self.hooks = {}
-
-    def on_boot(&block)
-      self.class.hooks[:on_boot] = block
-    end
-
-    class << self
-      def run_hook(name)
-        name = name.to_sym
-        hook = hooks[name]
-        hook.call if hook
-      end
-    end
-  end
-end