rspec-terraform 0.1.0.pre.43 → 0.1.0.pre.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d338f5e02d75bdf58441300199c8902f712adf6582abff8b9e5021230c2d344
-  data.tar.gz: 16844e10dec62df8e57c1b84216c0f95742586be4fcca7792195d680e526200e
+  metadata.gz: f5e1e41e777f174198e1de6459ef21f280d11227fd2a0b97e0d6604458b48e34
+  data.tar.gz: 071164c5440ab7b9a094c0125c7d562acb40d235485baac554dfd6e14bbc55fb
 SHA512:
-  metadata.gz: 49b0bc41cde756000e9e74218ab4b2c9ab451e19b8dbdf6f84a3d1d0329c7d6a1bb94ea801bfd15caaa374c512173b62dd137b610c942efafb5401180bc970ea
-  data.tar.gz: 0631d0581d8f6c6f9a13d8e6edcd9a714b44b6487803c95c0d4a3a5ec5650b129a80fe70054162121b0330e7430cdcf35171727eb406a7da6f964a247f676b43
+  metadata.gz: d8f45a75288ba61061d435320509688ac960e4be4b1842b62d4a4c87cc6e5a75af656f6b6fad60b39fbe24f12060cc8d9d1bec4038616efb2d7dea02649caba9
+  data.tar.gz: d2e42b5ca9bbfbcb59842e656e9d2816fb838c8bed600aaeaeb008f6601dd64755fa8ac33c27b79cc38c84efc2c8f99b612b25498c98f0292c0fb115433e9e4d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-terraform (0.1.0.pre.43)
+    rspec-terraform (0.1.0.pre.45)
       confidante (>= 0.27)
       rspec (>= 3.0)
       ruby-terraform (= 1.7.0.pre.17)
@@ -145,8 +145,8 @@ GEM
       parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.12.1)
-      rubocop (~> 1.31)
+    rubocop-rspec (2.13.1)
+      rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     ruby-terraform (1.7.0.pre.17)
       immutable-struct (~> 2.4)

data/lib/rspec/terraform/helpers/apply.rb

@@ -2,65 +2,41 @@
 
 require 'ruby_terraform'
 
+require_relative './base'
 require_relative '../configuration/var_captor'
 
 module RSpec
   module Terraform
     module Helpers
-      # rubocop:disable Metrics/ClassLength
-      class Apply
-        attr_reader(
-          :configuration_provider,
-          :binary,
-          :logger,
-          :stdin,
-          :stdout,
-          :stderr,
-          :execution_mode
-        )
-
-        def initialize(opts = {})
-          @configuration_provider =
-            opts[:configuration_provider] || Configuration.identity_provider
-          @binary = opts[:binary] || 'terraform'
-          @logger = opts[:logger]
-          @stdin = opts[:stdin]
-          @stdout = opts[:stdout]
-          @stderr = opts[:stderr]
-          @execution_mode = opts[:execution_mode] || :in_place
-        end
-
+      class Apply < Base
         def execute(overrides = {}, &block)
           parameters = with_configuration_provider_parameters(overrides)
           parameters = with_resolved_vars(parameters, &block)
           parameters = with_mandatory_parameters(parameters)
 
-          ensure_required_parameters(parameters)
-
-          clean(parameters)
-          init(parameters)
-          apply(parameters)
+          execute_if_required(parameters) do
+            validate(parameters)
+            clean(parameters)
+            init(parameters)
+            apply(parameters)
+          end
         end
 
         private
 
-        def with_configuration_provider_parameters(parameters)
-          configuration_provider.resolve(parameters)
-        end
-
-        def with_resolved_vars(parameters, &block)
-          return parameters unless block_given?
+        def execute_if_required(parameters, &block)
+          only_if = parameters[:only_if]
+          only_if_args = only_if ? [parameters].slice(0, only_if.arity) : []
+          should_execute = only_if ? only_if.call(*only_if_args) : true
 
-          var_captor = Configuration::VarCaptor.new(parameters[:vars] || {})
-          block.call(var_captor)
-          parameters.merge(vars: var_captor.to_h)
+          block.call if should_execute
         end
 
-        def with_mandatory_parameters(parameters)
-          parameters.merge(
+        def mandatory_parameters
+          {
             input: false,
             auto_approve: true
-          )
+          }
         end
 
         def required_parameters(execution_mode)
@@ -70,28 +46,6 @@ module RSpec
           }[execution_mode] || []
         end
 
-        def ensure_required_parameters(parameters)
-          missing_parameters =
-            required_parameters(execution_mode)
-              .filter { |parameter| parameters[parameter].nil? }
-
-          return if missing_parameters.empty?
-
-          raise_missing_parameters(missing_parameters)
-        end
-
-        def raise_missing_parameters(parameters)
-          parameters = parameters.collect { |parameter| "`:#{parameter}`" }
-          if parameters.count == 1
-            raise StandardError,
-                  "Required parameter: #{parameters[0]} missing."
-          else
-            parameters = "#{parameters[..-2].join(', ')} and #{parameters[-1]}"
-            raise StandardError,
-                  "Required parameters: #{parameters} missing."
-          end
-        end
-
         def clean(parameters)
           return unless execution_mode == :isolated
 
@@ -145,18 +99,7 @@ module RSpec
           apply_parameters
         end
         # rubocop:enable Metrics/MethodLength
-
-        def command_options
-          {
-            binary: binary,
-            logger: logger,
-            stdin: stdin,
-            stdout: stdout,
-            stderr: stderr
-          }
-        end
       end
-      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/rspec/terraform/helpers/base.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative '../configuration/var_captor'
+
+module RSpec
+  module Terraform
+    module Helpers
+      class Base
+        attr_reader(
+          :configuration_provider,
+          :binary,
+          :logger,
+          :stdin,
+          :stdout,
+          :stderr,
+          :execution_mode
+        )
+
+        def initialize(opts = {})
+          @configuration_provider =
+            opts[:configuration_provider] || Configuration.identity_provider
+          @binary = opts[:binary] || 'terraform'
+          @logger = opts[:logger]
+          @stdin = opts[:stdin]
+          @stdout = opts[:stdout]
+          @stderr = opts[:stderr]
+          @execution_mode = opts[:execution_mode] || :in_place
+        end
+
+        private
+
+        def with_configuration_provider_parameters(parameters)
+          configuration_provider.resolve(parameters)
+        end
+
+        def with_resolved_vars(parameters, &block)
+          return parameters unless block_given?
+
+          var_captor = Configuration::VarCaptor.new(parameters[:vars] || {})
+          block.call(var_captor)
+          parameters.merge(vars: var_captor.to_h)
+        end
+
+        def with_mandatory_parameters(parameters)
+          parameters.merge(mandatory_parameters)
+        end
+
+        def raise_missing_parameters(parameters)
+          parameters = parameters.collect { |parameter| "`:#{parameter}`" }
+          if parameters.count == 1
+            raise StandardError,
+                  "Required parameter: #{parameters[0]} missing."
+          else
+            parameters = "#{parameters[..-2].join(', ')} and #{parameters[-1]}"
+            raise StandardError,
+                  "Required parameters: #{parameters} missing."
+          end
+        end
+
+        def validate(parameters)
+          missing_parameters =
+            required_parameters(execution_mode)
+              .filter { |parameter| parameters[parameter].nil? }
+
+          return if missing_parameters.empty?
+
+          raise_missing_parameters(missing_parameters)
+        end
+
+        def mandatory_parameters
+          {}
+        end
+
+        def required_parameters(_)
+          []
+        end
+
+        def command_options
+          {
+            binary: binary,
+            logger: logger,
+            stdin: stdin,
+            stdout: stdout,
+            stderr: stderr
+          }
+        end
+      end
+    end
+  end
+end

data/lib/rspec/terraform/helpers/destroy.rb

@@ -2,57 +2,32 @@
 
 require 'ruby_terraform'
 
-require_relative '../configuration/var_captor'
+require_relative './base'
 
 module RSpec
   module Terraform
     module Helpers
-      # rubocop:disable Metrics/ClassLength
-      class Destroy
-        attr_reader(
-          :configuration_provider,
-          :binary,
-          :logger,
-          :stdin,
-          :stdout,
-          :stderr,
-          :execution_mode
-        )
-
-        def initialize(opts = {})
-          @configuration_provider =
-            opts[:configuration_provider] || Configuration.identity_provider
-          @binary = opts[:binary] || 'terraform'
-          @logger = opts[:logger]
-          @stdin = opts[:stdin]
-          @stdout = opts[:stdout]
-          @stderr = opts[:stderr]
-          @execution_mode = opts[:execution_mode] || :in_place
-        end
-
+      class Destroy < Base
         def execute(overrides = {}, &block)
           parameters = with_configuration_provider_parameters(overrides)
           parameters = with_resolved_vars(parameters, &block)
 
-          ensure_required_parameters(parameters)
-
-          clean(parameters)
-          init(parameters)
-          destroy(parameters)
+          execute_if_required(parameters) do
+            validate(parameters)
+            clean(parameters)
+            init(parameters)
+            destroy(parameters)
+          end
         end
 
         private
 
-        def with_configuration_provider_parameters(parameters)
-          configuration_provider.resolve(parameters)
-        end
-
-        def with_resolved_vars(parameters, &block)
-          return parameters unless block_given?
+        def execute_if_required(parameters, &block)
+          only_if = parameters[:only_if]
+          only_if_args = only_if ? [parameters].slice(0, only_if.arity) : []
+          should_execute = only_if ? only_if.call(*only_if_args) : true
 
-          var_captor = Configuration::VarCaptor.new(parameters[:vars] || {})
-          block.call(var_captor)
-          parameters.merge(vars: var_captor.to_h)
+          block.call if should_execute
         end
 
         def required_parameters(execution_mode)
@@ -62,28 +37,6 @@ module RSpec
           }[execution_mode] || []
         end
 
-        def ensure_required_parameters(parameters)
-          missing_parameters =
-            required_parameters(execution_mode)
-              .filter { |parameter| parameters[parameter].nil? }
-
-          return if missing_parameters.empty?
-
-          raise_missing_parameters(missing_parameters)
-        end
-
-        def raise_missing_parameters(parameters)
-          parameters = parameters.collect { |parameter| "`:#{parameter}`" }
-          if parameters.count == 1
-            raise StandardError,
-                  "Required parameter: #{parameters[0]} missing."
-          else
-            parameters = "#{parameters[..-2].join(', ')} and #{parameters[-1]}"
-            raise StandardError,
-                  "Required parameters: #{parameters} missing."
-          end
-        end
-
         def clean(parameters)
           return unless execution_mode == :isolated
 
@@ -137,18 +90,7 @@ module RSpec
           destroy_parameters
         end
         # rubocop:enable Metrics/MethodLength
-
-        def command_options
-          {
-            binary: binary,
-            logger: logger,
-            stdin: stdin,
-            stdout: stdout,
-            stderr: stderr
-          }
-        end
       end
-      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/rspec/terraform/helpers/output.rb

@@ -2,38 +2,17 @@
 
 require 'ruby_terraform'
 
+require_relative './base'
+
 module RSpec
   module Terraform
     module Helpers
-      # rubocop:disable Metrics/ClassLength
-      class Output
-        attr_reader(
-          :configuration_provider,
-          :binary,
-          :logger,
-          :stdin,
-          :stdout,
-          :stderr,
-          :execution_mode
-        )
-
-        def initialize(opts = {})
-          @configuration_provider =
-            opts[:configuration_provider] || Configuration.identity_provider
-          @binary = opts[:binary] || 'terraform'
-          @logger = opts[:logger]
-          @stdin = opts[:stdin]
-          @stdout = opts[:stdout]
-          @stderr = opts[:stderr]
-          @execution_mode = opts[:execution_mode] || :in_place
-        end
-
+      class Output < Base
         def execute(overrides = {})
           parameters = with_configuration_provider_parameters(overrides)
           parameters = with_mandatory_parameters(parameters)
 
-          ensure_required_parameters(parameters)
-
+          validate(parameters)
           clean(parameters)
           init(parameters)
           output_value = output(parameters)
@@ -43,14 +22,14 @@ module RSpec
 
         private
 
-        def with_configuration_provider_parameters(parameters)
-          configuration_provider.resolve(parameters)
+        def with_mandatory_parameters(parameters)
+          parameters.merge(mandatory_parameters)
         end
 
-        def with_mandatory_parameters(parameters)
-          parameters.merge(
+        def mandatory_parameters
+          {
             json: true
-          )
+          }
         end
 
         def required_parameters(execution_mode)
@@ -60,28 +39,6 @@ module RSpec
           }[execution_mode] || []
         end
 
-        def ensure_required_parameters(parameters)
-          missing_parameters =
-            required_parameters(execution_mode)
-              .filter { |parameter| parameters[parameter].nil? }
-
-          return if missing_parameters.empty?
-
-          raise_missing_parameters(missing_parameters)
-        end
-
-        def raise_missing_parameters(parameters)
-          parameters = parameters.collect { |parameter| "`:#{parameter}`" }
-          if parameters.count == 1
-            raise StandardError,
-                  "Required parameter: #{parameters[0]} missing."
-          else
-            parameters = "#{parameters[..-2].join(', ')} and #{parameters[-1]}"
-            raise StandardError,
-                  "Required parameters: #{parameters} missing."
-          end
-        end
-
         def clean(parameters)
           return unless execution_mode == :isolated
 
@@ -134,18 +91,7 @@ module RSpec
 
           output_parameters
         end
-
-        def command_options
-          {
-            binary: binary,
-            logger: logger,
-            stdin: stdin,
-            stdout: stdout,
-            stderr: stderr
-          }
-        end
       end
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/rspec/terraform/helpers/plan.rb

@@ -4,40 +4,17 @@ require 'ruby_terraform'
 require 'securerandom'
 require 'stringio'
 
-require_relative '../configuration/var_captor'
+require_relative './base'
 
 module RSpec
   module Terraform
     module Helpers
-      # rubocop:disable Metrics/ClassLength
-      class Plan
-        attr_reader(
-          :configuration_provider,
-          :binary,
-          :logger,
-          :stdin,
-          :stdout,
-          :stderr,
-          :execution_mode
-        )
-
-        def initialize(opts = {})
-          @configuration_provider =
-            opts[:configuration_provider] || Configuration.identity_provider
-          @binary = opts[:binary] || 'terraform'
-          @logger = opts[:logger]
-          @stdin = opts[:stdin]
-          @stdout = opts[:stdout]
-          @stderr = opts[:stderr]
-          @execution_mode = opts[:execution_mode] || :in_place
-        end
-
+      class Plan < Base
         def execute(overrides = {}, &block)
           parameters = with_configuration_provider_parameters(overrides)
           parameters = with_resolved_vars(parameters, &block)
 
-          ensure_required_parameters(parameters)
-
+          validate(parameters)
           clean(parameters)
           init(parameters)
           plan_file = plan(parameters)
@@ -48,18 +25,6 @@ module RSpec
 
         private
 
-        def with_configuration_provider_parameters(parameters)
-          configuration_provider.resolve(parameters)
-        end
-
-        def with_resolved_vars(parameters, &block)
-          return parameters unless block_given?
-
-          var_captor = Configuration::VarCaptor.new(parameters[:vars] || {})
-          block.call(var_captor)
-          parameters.merge(vars: var_captor.to_h)
-        end
-
         def required_parameters(execution_mode)
           {
             in_place: [:configuration_directory],
@@ -67,28 +32,6 @@ module RSpec
           }[execution_mode] || []
         end
 
-        def ensure_required_parameters(parameters)
-          missing_parameters =
-            required_parameters(execution_mode)
-              .filter { |parameter| parameters[parameter].nil? }
-
-          return if missing_parameters.empty?
-
-          raise_missing_parameters(missing_parameters)
-        end
-
-        def raise_missing_parameters(parameters)
-          parameters = parameters.collect { |parameter| "`:#{parameter}`" }
-          if parameters.count == 1
-            raise StandardError,
-                  "Required parameter: #{parameters[0]} missing."
-          else
-            parameters = "#{parameters[..-2].join(', ')} and #{parameters[-1]}"
-            raise StandardError,
-                  "Required parameters: #{parameters} missing."
-          end
-        end
-
         def clean(parameters)
           return unless execution_mode == :isolated
 
@@ -177,18 +120,7 @@ module RSpec
             json: true
           )
         end
-
-        def command_options
-          {
-            binary: binary,
-            logger: logger,
-            stdin: stdin,
-            stdout: stdout,
-            stderr: stderr
-          }
-        end
       end
-      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/rspec/terraform/helpers/var.rb

@@ -1,38 +1,18 @@
 # frozen_string_literal: true
 
+require_relative './base'
 require_relative '../configuration/var_captor'
 
 module RSpec
   module Terraform
     module Helpers
-      class Var
-        attr_reader(:configuration_provider)
-
-        def initialize(opts = {})
-          @configuration_provider =
-            opts[:configuration_provider] || Configuration.identity_provider
-        end
-
+      class Var < Base
         def execute(overrides = {}, &block)
           parameters = with_configuration_provider_parameters(overrides)
           parameters = with_resolved_vars(parameters, &block)
 
           parameters[:vars][parameters[:name].to_sym]
         end
-
-        private
-
-        def with_configuration_provider_parameters(parameters)
-          configuration_provider.resolve(parameters)
-        end
-
-        def with_resolved_vars(parameters, &block)
-          return parameters unless block_given?
-
-          var_captor = Configuration::VarCaptor.new(parameters[:vars] || {})
-          block.call(var_captor)
-          parameters.merge(vars: var_captor.to_h)
-        end
       end
     end
   end

data/lib/rspec/terraform/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Terraform
-    VERSION = '0.1.0.pre.43'
+    VERSION = '0.1.0.pre.45'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-terraform
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.43
+  version: 0.1.0.pre.45
 platform: ruby
 authors:
 - InfraBlocks Maintainers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: confidante
@@ -305,6 +305,7 @@ files:
 - lib/rspec/terraform/configuration/var_captor.rb
 - lib/rspec/terraform/helpers.rb
 - lib/rspec/terraform/helpers/apply.rb
+- lib/rspec/terraform/helpers/base.rb
 - lib/rspec/terraform/helpers/destroy.rb
 - lib/rspec/terraform/helpers/output.rb
 - lib/rspec/terraform/helpers/plan.rb