terraspace 1.0.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0161019335d6d328b768dc5f50962776c3f1f9c9d28f1e963b082fe457f45ab
-  data.tar.gz: 520f8388b0814c8fe29781768cd7c390ddfdf011ba48150d8b2052f8b674b738
+  metadata.gz: 57c0c4f1c1fce5c1dd8fcd7447f5bc5a82e17d66e5353f4d092d492c137021e5
+  data.tar.gz: 81a4ba08410e898a1dd057625ca556392e746c4b48a3453874472c60424c3949
 SHA512:
-  metadata.gz: e4b2c9e7285e22d0e3b1e97191a181694c85c0ff185798be9320ee3783c422d380b3ee1ca4b1a15893baf215c74618890b87416f0ab5dd5ec8524a8af438bae4
-  data.tar.gz: fd33e4677f1f0aefeb2bad8e9470d8eca758d16da98615d8889076930b27b4ccba43dae144521bf5ea324cb4d0c0e7cd93681c8c2925ba41ff644858672d78cd
+  metadata.gz: e629795fd75ad23d343ec28390e76756650f11740c6b380ad3df87cb216f7a998acfea282ebb1a1399343c3db2b5abe452705bb82fd61e76a8cd1a2ca258300b
+  data.tar.gz: 7104217cb56ee3ba2317d4d2abe0d4f760fe35de359903349a97bef4c2de3c92aaff3e0605789fd9e970f8a841a2203dedc9d740d9bddf127d2555a3f3818f30

data/CHANGELOG.md

@@ -3,6 +3,18 @@
 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.0.6] - 2022-01-24
+- [#195](https://github.com/boltops-tools/terraspace/pull/195) improve autodetection for plugin expander for backend like remote
+
+## [1.0.5] - 2022-01-23
+- [#194](https://github.com/boltops-tools/terraspace/pull/194) ability to allow and deny envs, regions, and stacks
+
+## [1.0.4] - 2022-01-21
+- [#193](https://github.com/boltops-tools/terraspace/pull/193) improve all include_stacks and exclude_stacks option
+
+## [1.0.3] - 2022-01-20
+- [#192](https://github.com/boltops-tools/terraspace/pull/192) run super-early boot hooks before dotenv load
+
 ## [1.0.2] - 2022-01-17
 - [#190](https://github.com/boltops-tools/terraspace/pull/190) update terraspace-bundler gem depedency to 0.5.0
 

data/lib/terraspace/app/callable_option/concern.rb

@@ -0,0 +1,12 @@
+class Terraspace::App::CallableOption
+  module Concern
+    def callable_option(options={})
+      callable_option = Terraspace::App::CallableOption.new(
+        config_name: options[:config_name],
+        config_value: options[:config_value],
+        passed_args: options[:passed_args],
+      )
+      callable_option.object
+    end
+  end
+end

data/lib/terraspace/app/callable_option.rb

@@ -0,0 +1,58 @@
+# Class represents a terraspace option that is possibly callable. Examples:
+#
+#    config.allow.envs
+#    config.allow.regions
+#    config.deny.envs
+#    config.deny.regions
+#    config.all.include_stacks
+#    config.all.exclude_stacks
+#
+# Abstraction is definitely obtuse. Using it to get rid of duplication.
+#
+class Terraspace::App
+  class CallableOption
+    include Terraspace::Util::Logging
+
+    def initialize(options={})
+      @options = options
+      # Example:
+      # config_name:  config.allow.envs
+      # config_value: ["dev"]
+      # args:         [@stack_name] # passed to object.call
+      @config_name = options[:config_name]
+      @config_value = options[:config_value]
+      @passed_args = options[:passed_args]
+    end
+
+    # Returns either an Array or nil
+    def object
+      case @config_value
+      when nil
+        return nil
+      when Array
+        return @config_value
+      when -> (c) { c.respond_to?(:public_instance_methods) && c.public_instance_methods.include?(:call) }
+        object= @config_value.new
+      when -> (c) { c.respond_to?(:call) }
+        object = @config_value
+      else
+        raise "Invalid option for #{@config_name}"
+      end
+
+      if object
+        result = @passed_args.empty? ? object.call : object.call(*@passed_args)
+        unless result.is_a?(Array) || result.is_a?(NilClass)
+          message = "ERROR: The #{@config_name} needs to return an Array or nil"
+          logger.info message.color(:yellow)
+          logger.info <<~EOL
+            The #{@config_name} when assigned a class, object, or proc must implement
+            the call method and return an Array or nil.
+            The current return value is a #{result.class}
+          EOL
+          raise message
+        end
+      end
+      result
+    end
+  end
+end

data/lib/terraspace/app.rb

@@ -12,17 +12,29 @@ module Terraspace
 
     def defaults
       config = ActiveSupport::OrderedOptions.new
+
       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.up = true
-      config.all.ignore_stacks = nil
-      config.all.include_stacks = nil
+
       config.allow = ActiveSupport::OrderedOptions.new
       config.allow.envs = nil
       config.allow.regions = nil
+      config.allow.stacks = nil
+      config.deny = ActiveSupport::OrderedOptions.new
+      config.deny.envs = nil
+      config.deny.regions = nil
+      config.deny.stacks = nil
+
+      config.all.exclude_stacks = nil
+      config.all.include_stacks = nil
+      config.all.consider_allow_deny_stacks = true
+
       config.auto_create_backend = true
+      config.autodetect = ActiveSupport::OrderedOptions.new
+      config.autodetect.expander = nil
       config.build = ActiveSupport::OrderedOptions.new
       config.build.cache_dir = ":CACHE_ROOT/:REGION/:ENV/:BUILD_DIR"
       config.build.cache_root = nil # defaults to /full/path/to/.terraspace-cache

data/lib/terraspace/autodetect.rb

@@ -2,13 +2,9 @@ module Terraspace
   class Autodetect
     def plugin
       plugins = Terraspace::Plugin.meta.keys
-      if plugins.size == 1
-        plugins.first
-      else
-        precedence = %w[aws azurerm google]
-        precedence.find do |p|
-          plugins.include?(p)
-        end
+      precedence = %w[aws azurerm google]
+      precedence.find do |p|
+        plugins.include?(p)
       end
     end
   end

data/lib/terraspace/booter.rb

@@ -1,8 +1,8 @@
 module Terraspace
   module Booter
     def boot
-      Dotenv.new.load!
       run_hooks
+      Dotenv.new.load!
       Terraspace::Bundle.require # load plugins
       load_plugin_default_configs
       Terraspace::App::Inits.run_all

data/lib/terraspace/builder/allow/base.rb

@@ -0,0 +1,59 @@
+class Terraspace::Builder::Allow
+  class Base
+    include Terraspace::App::CallableOption::Concern
+
+    def initialize(mod)
+      @mod = mod # Only Region subclass uses @mod but keeping interface same for Env for simplicity
+      @stack_name = mod.name
+    end
+
+    def check!
+      messages = []
+      unless allowed?
+        messages << message # message is interface method
+      end
+      unless messages.empty?
+        puts "ERROR: The configs do not allow this.".color(:red)
+        puts messages
+        exit 1
+      end
+    end
+
+    def allowed?
+      if allows.nil? && denys.nil?
+        true
+      elsif denys.nil?
+        allows.include?(check_value)
+      elsif allows.nil?
+        !denys.include?(check_value)
+      else
+        allows.include?(check_value) && !denys.include?(check_value)
+      end
+    end
+
+    def allows
+      callable_option(
+        config_name: "config.allow.#{config_name}",
+        config_value: config.dig(:allow, config_name),
+        passed_args: [@stack_name],
+      )
+    end
+
+    def denys
+      callable_option(
+        config_name: "config.deny.#{config_name}",
+        config_value: config.dig(:deny, config_name),
+        passed_args: [@stack_name],
+      )
+    end
+
+  private
+    def config
+      Terraspace.config
+    end
+
+    def config_name
+      self.class.to_s.split('::').last.underscore.pluralize.to_sym # ActiveSuport::HashWithIndifferentAccess#dig requires symbol
+    end
+  end
+end

data/lib/terraspace/builder/allow/env.rb

@@ -0,0 +1,17 @@
+class Terraspace::Builder::Allow
+  class Env < Base
+    # interface method
+    def message
+      messages = []
+      messages << "This env is not allowed to be used: TS_ENV=#{Terraspace.env}"
+      messages << "Allow envs: #{allows.join(', ')}" if allows
+      messages << "Deny envs: #{denys.join(', ')}" if denys
+      messages.join("\n")
+    end
+
+    # interface method
+    def check_value
+      Terraspace.env
+    end
+  end
+end

data/lib/terraspace/builder/allow/region.rb

@@ -0,0 +1,31 @@
+class Terraspace::Builder::Allow
+  class Region < Base
+    # interface method
+    def message
+      messages = []
+      word = config_name.to_s # IE: regions or locations
+      messages << "This #{word.singularize} is not allowed to be used: Detected current #{word.singularize}=#{current_region}"
+      messages << "Allow #{word}: #{allows.join(', ')}" if allows
+      messages << "Deny #{word}: #{denys.join(', ')}" if denys
+      messages.join("\n")
+    end
+
+    # interface method
+    def check_value
+      current_region
+    end
+
+    def current_region
+      expander = Terraspace::Compiler::Expander.autodetect(@mod).expander
+      expander.region
+    end
+
+    def config_name
+      if config.allow.locations || config.deny.locations
+        :locations # ActiveSuport::HashWithIndifferentAccess#dig requires symbol
+      else
+        super # :regions
+      end
+    end
+  end
+end

data/lib/terraspace/builder/allow/stack.rb

@@ -0,0 +1,17 @@
+class Terraspace::Builder::Allow
+  class Stack < Base
+    # interface method
+    def message
+      messages = []
+      messages << "This stack is not allowed to be used for TS_ENV=#{Terraspace.env}"
+      messages << "Allow stacks: #{allows.join(', ')}" if allows
+      messages << "Deny stacks: #{denys.join(', ')}" if denys
+      messages.join("\n")
+    end
+
+    # interface method
+    def check_value
+      @mod.name
+    end
+  end
+end

data/lib/terraspace/builder/allow.rb

@@ -5,39 +5,9 @@ class Terraspace::Builder
     end
 
     def check!
-      messages = []
-      unless env_allowed?
-        messages << "This env is not allowed to be used: TS_ENV=#{Terraspace.env}"
-        messages << "Allowed envs: #{config.allow.envs.join(', ')}"
-      end
-      unless region_allowed?
-        messages << "This region is not allowed to be used: Detected current region=#{current_region}"
-        messages << "Allowed regions: #{config.allow.regions.join(', ')}"
-      end
-      unless messages.empty?
-        puts "ERROR: The configs do not allow this.".color(:red)
-        puts messages
-        exit 1
-      end
-    end
-
-    def env_allowed?
-      return true unless config.allow.envs
-      config.allow.envs.include?(Terraspace.env)
-    end
-
-    def region_allowed?
-      return true unless config.allow.regions
-      config.allow.regions.include?(current_region)
-    end
-
-    def current_region
-      expander = Terraspace::Compiler::Expander.autodetect(@mod).expander
-      expander.region
-    end
-
-    def config
-      Terraspace.config
+      Env.new(@mod).check!
+      Stack.new(@mod).check!
+      Region.new(@mod).check!
     end
   end
 end

data/lib/terraspace/compiler/expander/backend.rb

@@ -12,7 +12,7 @@ class Terraspace::Compiler::Expander
       @mod = mod
     end
 
-    COMMENT = /^\s+#/
+    COMMENT = /^\s*#/
     # Works for both backend.rb DSL and backend.tf ERB
     def detect
       return nil unless src_path # no backend file. returning nil means a local backend

data/lib/terraspace/compiler/expander.rb

@@ -3,8 +3,8 @@ module Terraspace::Compiler
     extend Memoist
     delegate :expand, :expansion, to: :expander
 
-    def initialize(mod, name)
-      @mod, @name = mod, name
+    def initialize(mod, backend=nil)
+      @mod, @backend = mod, backend
     end
 
     def expander
@@ -12,27 +12,51 @@ module Terraspace::Compiler
     end
     memoize :expander
 
+    # IE: TerraspacePluginAws::Interfaces::Expander
     def expander_class
-      # IE: TerraspacePluginAws::Interfaces::Expander
-      klass_name = Terraspace::Plugin.klass("Expander", backend: @name)
-      klass_name ? klass_name.constantize : Terraspace::Plugin::Expander::Generic
-    rescue NameError
+      class_name = expander_class_name
+      class_name ? class_name.constantize : Terraspace::Plugin::Expander::Generic
+    rescue NameError => e
+      logger.debug "#{e.class}: #{e.message}"
       Terraspace::Plugin::Expander::Generic
     end
 
+    def expander_class_name
+      plugin = Terraspace.config.autodetect.expander # contains plugin name. IE: aws, azurerm, google
+      if plugin
+        # early return for user override of autodetection
+        return Terraspace::Plugin.klass("Expander", plugin: plugin) # can return nil
+      end
+
+      backend = @backend || parse_backend
+      class_name = Terraspace::Plugin.klass("Expander", backend: backend) # can return nil
+      unless class_name
+        backend = plugin_backend
+        class_name = Terraspace::Plugin.klass("Expander", backend: backend) # can return nil
+      end
+      class_name
+    end
+
+    # autodetect by parsing backend.tf or backend.rb
+    def parse_backend
+      Backend.new(@mod).detect
+    end
+
+    # autodetect by looking up loaded plugins
+    def plugin_backend
+      plugin = Terraspace::Autodetect.new.plugin # IE: aws, azurerm, google
+      if plugin
+        data = Terraspace::Plugin.meta[plugin]
+        data[:backend] # IE: s3, azurerm, gcs
+      end
+    end
+
     class << self
       extend Memoist
-
       def autodetect(mod, opts={})
-        backend = opts[:backend] || find_backend(mod)
-        new(mod, backend)
+        new(mod, opts)
       end
       memoize :autodetect
-
-      def find_backend(mod)
-        Backend.new(mod).detect
-      end
-      memoize :find_backend
     end
   end
 end

data/lib/terraspace/compiler/select.rb

@@ -1,28 +1,79 @@
 module Terraspace::Compiler
   class Select
+    include Terraspace::App::CallableOption::Concern
+    include Terraspace::Util::Logging
+
     def initialize(path)
       @path = path
       @stack_name = extract_stack_name(path)
     end
 
     def selected?
-      all = Terraspace.config.all
-      # Key difference between include_stacks vs all.include_stacks option is that
-      # the option can be nil. The local variable is guaranteed to be an Array.
-      # This simplifies the logic.
-      include_stacks = all.include_stacks || []
-      ignore_stacks  = all.ignore_stacks  || []
-
-      if all.include_stacks.nil?
-        !ignore_stacks.include?(@stack_name)
+      ignore_stacks_deprecation_warning
+      if include_stacks.nil? && exclude_stacks.nil?
+        true
+      elsif include_stacks.nil?
+        !exclude_stacks.include?(@stack_name)
+      elsif exclude_stacks.nil?
+        include_stacks.include?(@stack_name)
       else
-        stacks = include_stacks - ignore_stacks
+        stacks = include_stacks - exclude_stacks
         stacks.include?(@stack_name)
       end
     end
 
+    def include_stacks
+      if config.all.include_stacks
+        config_name = "config.all.include_stacks"
+        config_value = config.dig(:all, :include_stacks)
+      elsif config.all.consider_allow_deny_stacks
+        config_name = "config.allow.stacks"
+        config_value = config.dig(:allow, :stacks)
+      else
+        return
+      end
+      callable_option(
+        config_name: config_name,
+        config_value: config_value,
+        passed_args: [@stack_name],
+      )
+    end
+
+    def exclude_stacks
+      if config.all.exclude_stacks
+        config_name = "config.all.exclude_stacks"
+        config_value = config.dig(:all, :exclude_stacks)
+      elsif config.all.consider_allow_deny_stacks
+        config_name = "config.deny.stacks"
+        config_value = config.dig(:deny, :stacks)
+      else
+        return
+      end
+      callable_option(
+        config_name: config_name,
+        config_value: config_value,
+        passed_args: [@stack_name],
+      )
+    end
+
+  private
+    def config
+      Terraspace.config
+    end
+
     def extract_stack_name(path)
       path.sub(%r{.*(app|vendor)/stacks/}, '')
     end
+
+    @@ignore_stacks_deprecation_warning = nil
+    def ignore_stacks_deprecation_warning
+      return unless config.all.ignore_stacks
+      return if @@ignore_stacks_deprecation_warning
+      puts <<~EOL.color(:yellow)
+        DEPRECATED:  config.all.ignore_stacks
+        Instead use: config.all.exclude_stacks
+      EOL
+      @@ignore_stacks_deprecation_warning = true
+    end
   end
 end

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "1.0.2"
+  VERSION = "1.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.6
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -478,12 +478,18 @@ files:
 - lib/terraspace/all/runner.rb
 - lib/terraspace/all/summary.rb
 - lib/terraspace/app.rb
+- lib/terraspace/app/callable_option.rb
+- lib/terraspace/app/callable_option/concern.rb
 - lib/terraspace/app/inits.rb
 - lib/terraspace/autodetect.rb
 - lib/terraspace/autoloader.rb
 - lib/terraspace/booter.rb
 - lib/terraspace/builder.rb
 - lib/terraspace/builder/allow.rb
+- lib/terraspace/builder/allow/base.rb
+- lib/terraspace/builder/allow/env.rb
+- lib/terraspace/builder/allow/region.rb
+- lib/terraspace/builder/allow/stack.rb
 - lib/terraspace/bundle.rb
 - lib/terraspace/cli.rb
 - lib/terraspace/cli/all.rb