rspec-terraform 0.1.0.pre.26 → 0.1.0.pre.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95958411883b88589c0b4ebbf69198bd96d00f545dfc3bfde950029f2c809417
-  data.tar.gz: 4442f9b3b60bc414a736d339578f058505fff7ac545d0e0bbda6648ae2415459
+  metadata.gz: fbe0f55f0b5903a638e780131a1a32b5e0859b0b92c36f431938ffb929568efc
+  data.tar.gz: d052537b7512b50b1b94509b50cbb07b493f2efe18ec34a1326bf0555b7631ed
 SHA512:
-  metadata.gz: d731325a5f7bcc520f50d0d89baaa3d700d533c831088c355d58b1be128393b406b95df513367b69e7423f99e5b1f7d73066f3cdaa14ddbbd234f485388f5d8a
-  data.tar.gz: d5cdaf53682c7b036fd829b72a013318010b45ec39db3a260afda5c9dd9c69d731ebd6b2def20a8b651c2db97f9f74209fa393ecb99bf58c9a0d3731ad171bba
+  metadata.gz: 9cbe733d1fd152518c6d9df00f5c9137ed51f3e7d7e4121b13c5f4b090fce912a965f2de6417b687b77bc1b68c5c9058b3402e4d6b4434f07383d3511364562d
+  data.tar.gz: 0ef10564041a355a71e1cf61bfe4eeaf9b1db740074c24916d3d995b5935a24286571cf2098bef841356beb98359acb5ea883ea40cf0b5524435022f2fd573c9

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    rspec-terraform (0.1.0.pre.26)
+    rspec-terraform (0.1.0.pre.27)
       rspec (>= 3.0)
-      ruby-terraform (= 1.7.0.pre.13)
+      ruby-terraform (= 1.7.0.pre.15)
 
 GEM
   remote: https://rubygems.org/
@@ -13,8 +13,8 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     coderay (1.1.3)
     colored2 (3.1.2)
@@ -24,10 +24,10 @@ GEM
     excon (0.92.4)
     faker (2.22.0)
       i18n (>= 1.8.11, < 2)
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.3)
+    faraday-net_http (3.0.0)
     ffi (1.15.5)
     formatador (1.1.0)
     gem-release (2.2.2)
@@ -62,7 +62,7 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    minitest (5.16.2)
+    minitest (5.16.3)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -77,7 +77,7 @@ GEM
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.7)
+    public_suffix (5.0.0)
     rainbow (3.1.1)
     rake (13.0.6)
     rake_circle_ci (0.9.0)
@@ -118,7 +118,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.35.0)
+    rubocop (1.35.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
@@ -135,7 +135,7 @@ GEM
     rubocop-rspec (2.12.1)
       rubocop (~> 1.31)
     ruby-progressbar (1.11.0)
-    ruby-terraform (1.7.0.pre.13)
+    ruby-terraform (1.7.0.pre.15)
       immutable-struct (~> 2.4)
       lino (~> 3.0)
     ruby2_keywords (0.0.5)

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

@@ -90,27 +90,11 @@ module RSpec
         end
 
         def init(parameters)
-          execution_parameters = {
-            chdir: parameters[:configuration_directory],
-            input: parameters[:input]
-          }
-          if execution_mode == :isolated
-            execution_parameters =
-              execution_parameters
-                .merge(from_module: parameters[:source_directory])
-          end
-
-          init_command.execute(execution_parameters)
+          init_command.execute(init_parameters(parameters))
         end
 
         def apply(parameters)
-          apply_command.execute(
-            chdir: parameters[:configuration_directory],
-            state: parameters[:state_file],
-            vars: parameters[:vars],
-            input: parameters[:input],
-            auto_approve: parameters[:auto_approve]
-          )
+          apply_command.execute(apply_parameters(parameters))
         end
 
         def init_command
@@ -120,6 +104,37 @@ module RSpec
         def apply_command
           RubyTerraform::Commands::Apply.new(binary: binary)
         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/destroy.rb

@@ -23,7 +23,6 @@ module RSpec
         def execute(&block)
           parameters = with_configuration_provider_parameters(overrides)
           parameters = with_resolved_vars(parameters, &block)
-          parameters = with_mandatory_parameters(parameters)
 
           ensure_required_parameters(parameters)
 
@@ -46,13 +45,6 @@ module RSpec
           parameters.merge(vars: var_captor.to_h)
         end
 
-        def with_mandatory_parameters(parameters)
-          parameters.merge(
-            input: false,
-            auto_approve: true
-          )
-        end
-
         def required_parameters(execution_mode)
           {
             in_place: [:configuration_directory],
@@ -90,27 +82,11 @@ module RSpec
         end
 
         def init(parameters)
-          execution_parameters = {
-            chdir: parameters[:configuration_directory],
-            input: parameters[:input]
-          }
-          if execution_mode == :isolated
-            execution_parameters =
-              execution_parameters
-                .merge(from_module: parameters[:source_directory])
-          end
-
-          init_command.execute(execution_parameters)
+          init_command.execute(init_parameters(parameters))
         end
 
         def destroy(parameters)
-          destroy_command.execute(
-            chdir: parameters[:configuration_directory],
-            state: parameters[:state_file],
-            vars: parameters[:vars],
-            input: parameters[:input],
-            auto_approve: parameters[:auto_approve]
-          )
+          destroy_command.execute(destroy_parameters(parameters))
         end
 
         def init_command
@@ -120,6 +96,38 @@ module RSpec
         def destroy_command
           RubyTerraform::Commands::Destroy.new(binary: binary)
         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/plan.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require 'ruby_terraform'
+require 'securerandom'
+require 'stringio'
+
+require_relative '../configuration/var_captor'
+
+module RSpec
+  module Terraform
+    module Helpers
+      # rubocop:disable Metrics/ClassLength
+      class Plan
+        attr_reader(
+          :overrides, :configuration_provider, :binary, :execution_mode
+        )
+
+        def initialize(overrides = {}, configuration_provider = nil)
+          @overrides = overrides
+          @configuration_provider =
+            configuration_provider || Configuration.identity_provider
+          @binary = RSpec.configuration.terraform_binary
+          @execution_mode = RSpec.configuration.terraform_execution_mode
+        end
+
+        def execute(&block)
+          parameters = with_configuration_provider_parameters(overrides)
+          parameters = with_resolved_vars(parameters, &block)
+
+          ensure_required_parameters(parameters)
+
+          clean(parameters)
+          init(parameters)
+          plan_file = plan(parameters)
+          plan_contents = show(parameters, plan_file)
+
+          RubyTerraform::Models::Plan.new(
+            JSON.parse(plan_contents, symbolize_names: true)
+          )
+        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 required_parameters(execution_mode)
+          {
+            in_place: [:configuration_directory],
+            isolated: %i[source_directory configuration_directory]
+          }[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
+
+          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 init_command
+          RubyTerraform::Commands::Init.new(binary: binary)
+        end
+
+        def plan_command
+          RubyTerraform::Commands::Plan.new(binary: binary)
+        end
+
+        def show_command(opts = {})
+          RubyTerraform::Commands::Show.new(opts.merge(binary: binary))
+        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(10),
+              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
+      # rubocop:enable Metrics/ClassLength
+    end
+  end
+end

data/lib/rspec/terraform/helpers.rb

@@ -2,6 +2,7 @@
 
 require_relative './helpers/apply'
 require_relative './helpers/destroy'
+require_relative './helpers/plan'
 
 module RSpec
   module Terraform

data/lib/rspec/terraform/version.rb

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

data/rspec-terraform.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.7'
 
   spec.add_dependency 'rspec', '>= 3.0'
-  spec.add_dependency 'ruby-terraform', '1.7.0.pre.13'
+  spec.add_dependency 'ruby-terraform', '1.7.0.pre.15'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'faker'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-terraform
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.26
+  version: 0.1.0.pre.27
 platform: ruby
 authors:
 - InfraBlocks Maintainers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-21 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.0.pre.13
+        version: 1.7.0.pre.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.0.pre.13
+        version: 1.7.0.pre.15
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -288,6 +288,7 @@ files:
 - lib/rspec/terraform/helpers.rb
 - lib/rspec/terraform/helpers/apply.rb
 - lib/rspec/terraform/helpers/destroy.rb
+- lib/rspec/terraform/helpers/plan.rb
 - lib/rspec/terraform/matchers.rb
 - lib/rspec/terraform/matchers/include_output_change.rb
 - lib/rspec/terraform/matchers/include_resource_change.rb