terraspace 1.0.1 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b24e7a97ebf99ac393d03ef6ffec1381fae0508ae2c9f6bbaa9f0d7aad3139c3
-  data.tar.gz: 5f553f4265a69128ef74dc7fdf22ea1dafbe0b2f73396fa4fa9b98cfcf24060a
+  metadata.gz: cfdfafd180a61f7e43131770457ffa446c8bae59d3db9e68c9b9a8930fa6ca88
+  data.tar.gz: 684480a5c4454ee457c5e236574ace9424a514d0822c2693190de41354aea40d
 SHA512:
-  metadata.gz: 2cd672d6cd5bafdb40f2275a4ee34eab50ac3855b4df2ee535a89b3732f1fda7f07693da14bf2d9c82d49ae07871debdc115aca4e175068148917fa37b6694ec
-  data.tar.gz: b3103984ef841b2082abf33fd84505db942e09b1a6a8bd0ca0a45774dbb018a31c202f1a3cf9fb0c7a87f1a51abf3825acbd12b325fa12264150d42deb323af8
+  metadata.gz: 73bef840c84345011a8246128537d81d76fee4c73215ac3856e43814e04304bfcf16d54213eee2fb940650f3fe4c13df249d1476805090cc0fbd7524f00fed00
+  data.tar.gz: a4b3f901aa19c01de17a059bd907197d4b2f8276a72de4ea29381ee803291ea9e4f33cc8c9667358247868297fb3b784dab1f0b127c7a04a98f37a56c4e2a773

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.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
+
 ## [1.0.1] - 2022-01-15
 - [#189](https://github.com/boltops-tools/terraspace/pull/189) dotenv support
 

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,16 +12,26 @@ 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.build = ActiveSupport::OrderedOptions.new
       config.build.cache_dir = ":CACHE_ROOT/:REGION/:ENV/:BUILD_DIR"

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/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.1"
+  VERSION = "1.0.5"
 end

data/terraspace.gemspec

@@ -31,13 +31,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rainbow"
   spec.add_dependency "render_me_pretty"
   spec.add_dependency "rexml"
-  spec.add_dependency "terraspace-bundler", "~> 0.4.4"
+  spec.add_dependency "terraspace-bundler", ">= 0.5.0"
   spec.add_dependency "thor"
   spec.add_dependency "tty-tree"
   spec.add_dependency "zeitwerk"
 
   # core baseline plugins
-  spec.add_dependency "rspec-terraspace", "~> 0.3.0"
+  spec.add_dependency "rspec-terraspace", ">= 0.3.1"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.5
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-15 00:00:00.000000000 Z
+date: 2022-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -196,16 +196,16 @@ dependencies:
   name: terraspace-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -252,16 +252,16 @@ dependencies:
   name: rspec-terraspace
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -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