terraspace 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f265061c3973d32dcbea50e12b291ee22041dc2e5bc2cf2521907dd4d74b0703
-  data.tar.gz: 97e6064b47fe37f11660fe05512e1750b23f96cd7bc7ea1bef0aa512884922de
+  metadata.gz: cfdfafd180a61f7e43131770457ffa446c8bae59d3db9e68c9b9a8930fa6ca88
+  data.tar.gz: 684480a5c4454ee457c5e236574ace9424a514d0822c2693190de41354aea40d
 SHA512:
-  metadata.gz: bb0ccae4efe36fae839a755561e9b6829b998c4ec653f7a9a24c8a67a6e9da9ff9e5b81ad1134018edceed75b5859e12cce280819e2792a203da7a65f4997087
-  data.tar.gz: '0269f857a01274f4c9b64b051c724fff030582e2d62b9222da04ae0828e7770160645a4dee01a0a0c791921197d08ce87f420e5fa24678e961e76fb267c9377b'
+  metadata.gz: 73bef840c84345011a8246128537d81d76fee4c73215ac3856e43814e04304bfcf16d54213eee2fb940650f3fe4c13df249d1476805090cc0fbd7524f00fed00
+  data.tar.gz: a4b3f901aa19c01de17a059bd907197d4b2f8276a72de4ea29381ee803291ea9e4f33cc8c9667358247868297fb3b784dab1f0b127c7a04a98f37a56c4e2a773

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 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
 

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/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,5 +1,6 @@
 module Terraspace::Compiler
   class Select
+    include Terraspace::App::CallableOption::Concern
     include Terraspace::Util::Logging
 
     def initialize(path)
@@ -22,48 +23,42 @@ module Terraspace::Compiler
     end
 
     def include_stacks
-      include_option(: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
-      include_option(:exclude_stacks)
-    end
-
-    def include_option(name)
-      option = all[name]  # IE: include_stacks or exclude_stacks
-      option ||= all[:ignore_stacks] if name == :exclude_stacks
-      case option
-      when nil
-        return nil
-      when Array
-        return option
-      when -> (c) { c.respond_to?(:public_instance_methods) && c.public_instance_methods.include?(:call) }
-        object= option.new
-      when -> (c) { c.respond_to?(:call) }
-        object = option
+      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
-        raise "Invalid option for config.all.#{name}"
-      end
-
-      if object
-        result = object.call(@stack_name)
-        unless result.is_a?(Array) || result.is_a?(NilClass)
-          message = "ERROR: The config.all.#{name} needs to return an Array or nil"
-          logger.info message.color(:yellow)
-          logger.info <<~EOL
-            The config.all.#{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
+        return
       end
-      result
+      callable_option(
+        config_name: config_name,
+        config_value: config_value,
+        passed_args: [@stack_name],
+      )
     end
 
   private
-    def all
-      Terraspace.config.all
+    def config
+      Terraspace.config
     end
 
     def extract_stack_name(path)
@@ -72,7 +67,7 @@ module Terraspace::Compiler
 
     @@ignore_stacks_deprecation_warning = nil
     def ignore_stacks_deprecation_warning
-      return unless all.ignore_stacks
+      return unless config.all.ignore_stacks
       return if @@ignore_stacks_deprecation_warning
       puts <<~EOL.color(:yellow)
         DEPRECATED:  config.all.ignore_stacks

data/lib/terraspace/version.rb

@@ -1,3 +1,3 @@
 module Terraspace
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraspace
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-01-23 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