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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5e1e41e777f174198e1de6459ef21f280d11227fd2a0b97e0d6604458b48e34
-  data.tar.gz: 071164c5440ab7b9a094c0125c7d562acb40d235485baac554dfd6e14bbc55fb
+  metadata.gz: 2595a9e060198c8472a6a91148d1d0e8c11532efee15fef65d9c732605b17a8d
+  data.tar.gz: e63395a9eb9228904cf3641b27e8f98d383757e1f2caa32a4249db296de99162
 SHA512:
-  metadata.gz: d8f45a75288ba61061d435320509688ac960e4be4b1842b62d4a4c87cc6e5a75af656f6b6fad60b39fbe24f12060cc8d9d1bec4038616efb2d7dea02649caba9
-  data.tar.gz: d2e42b5ca9bbfbcb59842e656e9d2816fb838c8bed600aaeaeb008f6601dd64755fa8ac33c27b79cc38c84efc2c8f99b612b25498c98f0292c0fb115433e9e4d
+  metadata.gz: a8cf7c02682147df95b9229c8fbf923b0cb1d35fc2b3b104452b560bbc5f0ee796d0fac397bc24ce188d7293ec7bc49bbed9782846d3e381aac20be9d2e89d94
+  data.tar.gz: 531a6420c69096768cb72f8593bea6e8e1d347ebe0182cc58e7a8c9b2ca76cfc67ec89b67c47bf1579712978a5d76a38bc850683cfe192adead3ca1e7d8e9368

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-terraform (0.1.0.pre.45)
+    rspec-terraform (0.1.0.pre.46)
       confidante (>= 0.27)
       rspec (>= 3.0)
       ruby-terraform (= 1.7.0.pre.17)
@@ -145,7 +145,7 @@ GEM
       parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.13.1)
+    rubocop-rspec (2.13.2)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     ruby-terraform (1.7.0.pre.17)
@@ -178,7 +178,7 @@ GEM
     thor (1.2.1)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.2.0)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   arm64-darwin-21

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

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+require_relative '../configuration/var_captor'
+
+module RSpec
+  module Terraform
+    module Helpers
+      # rubocop:disable Metrics/ModuleLength
+      module Actions
+        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
+
+          block.call if should_execute
+        end
+
+        def clean(parameters)
+          return unless execution_mode == :isolated
+
+          FileUtils.rm_rf(parameters[:configuration_directory])
+          FileUtils.mkdir_p(parameters[:configuration_directory])
+        end
+
+        def remove(parameters, file)
+          FileUtils.rm_f(
+            File.join(parameters[:configuration_directory], file)
+          )
+        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 init(parameters)
+          init_command.execute(init_parameters(parameters))
+        end
+
+        def apply(parameters)
+          apply_command.execute(apply_parameters(parameters))
+        end
+
+        def destroy(parameters)
+          destroy_command.execute(destroy_parameters(parameters))
+        end
+
+        def plan(parameters)
+          plan_parameters = plan_parameters(parameters)
+          plan_command.execute(plan_parameters)
+          plan_parameters[:out]
+        end
+
+        def show(parameters, plan_file)
+          stdout = StringIO.new
+          show_command(stdout: stdout)
+            .execute(show_parameters(parameters, plan_file))
+          stdout.string
+        end
+
+        def output(parameters)
+          stdout = StringIO.new
+          output_command(stdout: stdout)
+            .execute(output_parameters(parameters))
+          stdout.string
+        end
+
+        private
+
+        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 instantiate_command(klass, opts = {})
+          klass.new(command_options.merge(opts))
+        end
+
+        def init_command
+          instantiate_command(RubyTerraform::Commands::Init)
+        end
+
+        def apply_command
+          instantiate_command(RubyTerraform::Commands::Apply)
+        end
+
+        def destroy_command
+          instantiate_command(RubyTerraform::Commands::Destroy)
+        end
+
+        def plan_command
+          instantiate_command(RubyTerraform::Commands::Plan)
+        end
+
+        def show_command(opts = {})
+          instantiate_command(RubyTerraform::Commands::Show, opts)
+        end
+
+        def output_command(opts = {})
+          instantiate_command(RubyTerraform::Commands::Output, opts)
+        end
+
+        def init_parameters(parameters)
+          init_parameters = parameters.merge(
+            chdir: parameters[:configuration_directory],
+            input: false
+          )
+          if execution_mode == :isolated
+            init_parameters =
+              init_parameters.merge(from_module: parameters[:source_directory])
+          end
+
+          init_parameters
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def apply_parameters(parameters)
+          apply_parameters =
+            parameters.merge(
+              chdir: parameters[:configuration_directory],
+              input: false,
+              auto_approve: true
+            )
+
+          if parameters[:state_file]
+            apply_parameters =
+              apply_parameters.merge(state: parameters[:state_file])
+          end
+
+          apply_parameters
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        # rubocop:disable Metrics/MethodLength
+        def destroy_parameters(parameters)
+          destroy_parameters =
+            parameters.merge(
+              chdir: parameters[:configuration_directory],
+              input: false,
+              auto_approve: true
+            )
+
+          if parameters[:state_file]
+            destroy_parameters =
+              destroy_parameters.merge(state: parameters[:state_file])
+          end
+
+          destroy_parameters
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        # rubocop:disable Metrics/MethodLength
+        def plan_parameters(parameters)
+          plan_parameters =
+            parameters.merge(
+              chdir: parameters[:configuration_directory],
+              out: parameters[:plan_file_name] ||
+                "#{SecureRandom.hex[0, 10]}.tfplan",
+              input: false
+            )
+
+          if parameters[:state_file]
+            plan_parameters =
+              plan_parameters.merge(state: parameters[:state_file])
+          end
+
+          plan_parameters
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def show_parameters(parameters, plan_file)
+          parameters.merge(
+            chdir: parameters[:configuration_directory],
+            path: plan_file,
+            no_color: true,
+            json: true
+          )
+        end
+
+        def output_parameters(parameters)
+          output_parameters =
+            parameters.merge(
+              chdir: parameters[:configuration_directory]
+            )
+
+          if parameters[:state_file]
+            output_parameters =
+              output_parameters.merge(state: parameters[:state_file])
+          end
+
+          output_parameters
+        end
+      end
+      # rubocop:enable Metrics/ModuleLength
+    end
+  end
+end

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

@@ -3,16 +3,13 @@
 require 'ruby_terraform'
 
 require_relative './base'
-require_relative '../configuration/var_captor'
 
 module RSpec
   module Terraform
     module Helpers
       class Apply < Base
         def execute(overrides = {}, &block)
-          parameters = with_configuration_provider_parameters(overrides)
-          parameters = with_resolved_vars(parameters, &block)
-          parameters = with_mandatory_parameters(parameters)
+          parameters = resolve_parameters(overrides, &block)
 
           execute_if_required(parameters) do
             validate(parameters)
@@ -24,14 +21,6 @@ module RSpec
 
         private
 
-        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
-
-          block.call if should_execute
-        end
-
         def mandatory_parameters
           {
             input: false,
@@ -45,60 +34,6 @@ module RSpec
             isolated: %i[source_directory configuration_directory]
           }[execution_mode] || []
         end
-
-        def clean(parameters)
-          return unless execution_mode == :isolated
-
-          FileUtils.rm_rf(parameters[:configuration_directory])
-          FileUtils.mkdir_p(parameters[:configuration_directory])
-        end
-
-        def init(parameters)
-          init_command.execute(init_parameters(parameters))
-        end
-
-        def apply(parameters)
-          apply_command.execute(apply_parameters(parameters))
-        end
-
-        def init_command
-          RubyTerraform::Commands::Init.new(command_options)
-        end
-
-        def apply_command
-          RubyTerraform::Commands::Apply.new(command_options)
-        end
-
-        def init_parameters(parameters)
-          init_parameters = parameters.merge(
-            chdir: parameters[:configuration_directory],
-            input: false
-          )
-          if execution_mode == :isolated
-            init_parameters =
-              init_parameters.merge(from_module: parameters[:source_directory])
-          end
-
-          init_parameters
-        end
-
-        # rubocop:disable Metrics/MethodLength
-        def apply_parameters(parameters)
-          apply_parameters =
-            parameters.merge(
-              chdir: parameters[:configuration_directory],
-              input: false,
-              auto_approve: true
-            )
-
-          if parameters[:state_file]
-            apply_parameters =
-              apply_parameters.merge(state: parameters[:state_file])
-          end
-
-          apply_parameters
-        end
-        # rubocop:enable Metrics/MethodLength
       end
     end
   end

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

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
-require_relative '../configuration/var_captor'
+require_relative './actions'
+require_relative './parameters'
 
 module RSpec
   module Terraform
     module Helpers
       class Base
+        include Parameters
+        include Actions
+
         attr_reader(
           :configuration_provider,
           :binary,
@@ -29,44 +33,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 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

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

@@ -9,8 +9,7 @@ module RSpec
     module Helpers
       class Destroy < Base
         def execute(overrides = {}, &block)
-          parameters = with_configuration_provider_parameters(overrides)
-          parameters = with_resolved_vars(parameters, &block)
+          parameters = resolve_parameters(overrides, &block)
 
           execute_if_required(parameters) do
             validate(parameters)
@@ -22,74 +21,12 @@ module RSpec
 
         private
 
-        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
-
-          block.call if should_execute
-        end
-
         def required_parameters(execution_mode)
           {
             in_place: [:configuration_directory],
             isolated: %i[source_directory configuration_directory]
           }[execution_mode] || []
         end
-
-        def clean(parameters)
-          return unless execution_mode == :isolated
-
-          FileUtils.rm_rf(parameters[:configuration_directory])
-          FileUtils.mkdir_p(parameters[:configuration_directory])
-        end
-
-        def init(parameters)
-          init_command.execute(init_parameters(parameters))
-        end
-
-        def destroy(parameters)
-          destroy_command.execute(destroy_parameters(parameters))
-        end
-
-        def init_command
-          RubyTerraform::Commands::Init.new(command_options)
-        end
-
-        def destroy_command
-          RubyTerraform::Commands::Destroy.new(command_options)
-        end
-
-        def init_parameters(parameters)
-          init_parameters = parameters.merge(
-            chdir: parameters[:configuration_directory],
-            input: false
-          )
-          if execution_mode == :isolated
-            init_parameters =
-              init_parameters.merge(from_module: parameters[:source_directory])
-          end
-
-          init_parameters
-        end
-
-        # rubocop:disable Metrics/MethodLength
-        def destroy_parameters(parameters)
-          destroy_parameters =
-            parameters.merge(
-              chdir: parameters[:configuration_directory],
-              input: false,
-              auto_approve: true
-            )
-
-          if parameters[:state_file]
-            destroy_parameters =
-              destroy_parameters.merge(state: parameters[:state_file])
-          end
-
-          destroy_parameters
-        end
-        # rubocop:enable Metrics/MethodLength
       end
     end
   end

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

@@ -9,23 +9,18 @@ module RSpec
     module Helpers
       class Output < Base
         def execute(overrides = {})
-          parameters = with_configuration_provider_parameters(overrides)
-          parameters = with_mandatory_parameters(parameters)
+          parameters = resolve_parameters(overrides)
 
           validate(parameters)
           clean(parameters)
           init(parameters)
           output_value = output(parameters)
 
-          JSON.parse(output_value, symbolize_names: true)
+          parse(output_value)
         end
 
         private
 
-        def with_mandatory_parameters(parameters)
-          parameters.merge(mandatory_parameters)
-        end
-
         def mandatory_parameters
           {
             json: true
@@ -39,57 +34,8 @@ module RSpec
           }[execution_mode] || []
         end
 
-        def clean(parameters)
-          return unless execution_mode == :isolated
-
-          FileUtils.rm_rf(parameters[:configuration_directory])
-          FileUtils.mkdir_p(parameters[:configuration_directory])
-        end
-
-        def init(parameters)
-          init_command.execute(init_parameters(parameters))
-        end
-
-        def output(parameters)
-          stdout = StringIO.new
-          output_command(stdout: stdout)
-            .execute(output_parameters(parameters))
-          stdout.string
-        end
-
-        def init_command
-          RubyTerraform::Commands::Init.new(command_options)
-        end
-
-        def output_command(opts = {})
-          RubyTerraform::Commands::Output.new(command_options.merge(opts))
-        end
-
-        def init_parameters(parameters)
-          init_parameters = parameters.merge(
-            chdir: parameters[:configuration_directory],
-            input: false
-          )
-          if execution_mode == :isolated
-            init_parameters =
-              init_parameters.merge(from_module: parameters[:source_directory])
-          end
-
-          init_parameters
-        end
-
-        def output_parameters(parameters)
-          output_parameters =
-            parameters.merge(
-              chdir: parameters[:configuration_directory]
-            )
-
-          if parameters[:state_file]
-            output_parameters =
-              output_parameters.merge(state: parameters[:state_file])
-          end
-
-          output_parameters
+        def parse(output_value)
+          JSON.parse(output_value, symbolize_names: true)
         end
       end
     end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../configuration/var_captor'
+
+module RSpec
+  module Terraform
+    module Helpers
+      module Parameters
+        def resolve_parameters(overrides, &block)
+          parameters = with_configuration_provider_parameters(overrides)
+          parameters = with_resolved_vars(parameters, &block)
+          with_mandatory_parameters(parameters)
+        end
+
+        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
+      end
+    end
+  end
+end

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

@@ -11,8 +11,7 @@ module RSpec
     module Helpers
       class Plan < Base
         def execute(overrides = {}, &block)
-          parameters = with_configuration_provider_parameters(overrides)
-          parameters = with_resolved_vars(parameters, &block)
+          parameters = resolve_parameters(overrides, &block)
 
           validate(parameters)
           clean(parameters)
@@ -32,94 +31,11 @@ module RSpec
           }[execution_mode] || []
         end
 
-        def clean(parameters)
-          return unless execution_mode == :isolated
-
-          FileUtils.rm_rf(parameters[:configuration_directory])
-          FileUtils.mkdir_p(parameters[:configuration_directory])
-        end
-
-        def init(parameters)
-          init_command.execute(init_parameters(parameters))
-        end
-
-        def plan(parameters)
-          plan_parameters = plan_parameters(parameters)
-          plan_command.execute(plan_parameters)
-          plan_parameters[:out]
-        end
-
-        def show(parameters, plan_file)
-          stdout = StringIO.new
-          show_command(stdout: stdout)
-            .execute(show_parameters(parameters, plan_file))
-          stdout.string
-        end
-
         def parse(plan_contents)
           RubyTerraform::Models::Plan.new(
             JSON.parse(plan_contents, symbolize_names: true)
           )
         end
-
-        def remove(parameters, plan_file)
-          FileUtils.rm_f(
-            File.join(parameters[:configuration_directory], plan_file)
-          )
-        end
-
-        def init_command
-          RubyTerraform::Commands::Init.new(command_options)
-        end
-
-        def plan_command
-          RubyTerraform::Commands::Plan.new(command_options)
-        end
-
-        def show_command(opts = {})
-          RubyTerraform::Commands::Show.new(command_options.merge(opts))
-        end
-
-        def init_parameters(parameters)
-          init_parameters = parameters.merge(
-            chdir: parameters[:configuration_directory],
-            input: false
-          )
-          if execution_mode == :isolated
-            init_parameters =
-              init_parameters.merge(from_module: parameters[:source_directory])
-          end
-
-          init_parameters
-        end
-
-        # rubocop:disable Metrics/MethodLength
-        def plan_parameters(parameters)
-          plan_parameters =
-            parameters.merge(
-              chdir: parameters[:configuration_directory],
-              out: parameters[:plan_file_name] ||
-                "#{SecureRandom.hex[0, 10]}.tfplan",
-              input: false
-            )
-
-          if parameters[:state_file]
-            plan_parameters =
-              plan_parameters.merge(state: parameters[:state_file])
-          end
-
-          plan_parameters
-        end
-        # rubocop:enable Metrics/MethodLength
-
-        def show_parameters(parameters, plan_file)
-          parameters.merge(
-            chdir: parameters[:configuration_directory],
-            path: plan_file,
-            no_color: true,
-            json: true
-          )
-        end
       end
     end
   end

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

@@ -8,8 +8,7 @@ module RSpec
     module Helpers
       class Var < Base
         def execute(overrides = {}, &block)
-          parameters = with_configuration_provider_parameters(overrides)
-          parameters = with_resolved_vars(parameters, &block)
+          parameters = resolve_parameters(overrides, &block)
 
           parameters[:vars][parameters[:name].to_sym]
         end

data/lib/rspec/terraform/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-terraform
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.45
+  version: 0.1.0.pre.46
 platform: ruby
 authors:
 - InfraBlocks Maintainers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2022-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: confidante
@@ -304,10 +304,12 @@ files:
 - lib/rspec/terraform/configuration/providers/seed.rb
 - lib/rspec/terraform/configuration/var_captor.rb
 - lib/rspec/terraform/helpers.rb
+- lib/rspec/terraform/helpers/actions.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/parameters.rb
 - lib/rspec/terraform/helpers/plan.rb
 - lib/rspec/terraform/helpers/var.rb
 - lib/rspec/terraform/logging.rb