rspec-terraform 0.1.0.pre.18 → 0.1.0.pre.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bea553c61f70c6bd7bf4bdedca8b618a00539e8bfb1de8234e9771c8462c1ca
-  data.tar.gz: e3ef056ecdf300bb9c9ce9656090a4ac93703d5346ba36e0f2c3f43885f927da
+  metadata.gz: d3a1d7d419c7e13ea95d8cf7b04ffe5183aa1cfce3d48e3027609b061416e640
+  data.tar.gz: 1f33098b03b9cba5294b2894f691d55d26f666185d1d6e9a748345a0fc383080
 SHA512:
-  metadata.gz: d68c9235ad0a528f15f1e0801681210561cecf4070b69276fe2a28436e28b3f5748728220382b3e87950a1959a46ce912be09d6b300f94732bf50ebe3a78cfc9
-  data.tar.gz: 61b756e071fba7355d294552d042b0d855ac1ca18021f1b06c594b3b3e2fad05d5d53668580880911db3e6c103d5b46579f1a8e28f6d2fc54c08a46014772696
+  metadata.gz: f3dedee60ba29285bc292f263791cd117cff0adff0b092042f6774d321a9eba268431d601ce2cf7d39688c50777c342cde6ab4b20f6ac5603ad7eb3bbe665afa
+  data.tar.gz: 52fe2ac848e6e1d0d5e4677731dcd51db1483d2119966157d7d854ab73f1d2acd676f5412c4bb051ab740d77e9927c3d3e5bbf14bd756dc331853e1a93b13e09

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-terraform (0.1.0.pre.18)
+    rspec-terraform (0.1.0.pre.21)
       rspec (>= 3.0)
       ruby-terraform (= 1.7.0.pre.13)
 
@@ -16,6 +16,7 @@ GEM
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    coderay (1.1.3)
     colored2 (3.1.2)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
@@ -27,7 +28,26 @@ GEM
       faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (2.0.3)
+    ffi (1.15.5)
+    formatador (1.1.0)
     gem-release (2.2.2)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.5.0)
+      guard (~> 2.0)
+      rubocop (< 2.0)
     hamster (3.0.0)
       concurrent-ruby (~> 1.0)
     i18n (1.12.0)
@@ -37,7 +57,16 @@ GEM
     lino (3.0.0)
       hamster (~> 3.0)
       open4 (~> 1.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
     minitest (5.16.2)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     octokit (4.25.1)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
@@ -45,6 +74,9 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     public_suffix (4.0.7)
     rainbow (3.1.1)
     rake (13.0.6)
@@ -68,6 +100,9 @@ GEM
       colored2 (~> 3.1)
       rake_factory (~> 0.23)
       sshkey (~> 2.0)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
@@ -109,6 +144,7 @@ GEM
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
+    shellany (0.0.1)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -116,13 +152,14 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
     sshkey (2.0.0)
+    terminal-notifier-guard (1.7.0)
+    thor (1.2.1)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
 
 PLATFORMS
   arm64-darwin-21
-  ruby
   x86_64-darwin-19
   x86_64-linux
 
@@ -130,6 +167,9 @@ DEPENDENCIES
   bundler
   faker
   gem-release
+  guard
+  guard-rspec
+  guard-rubocop
   rake
   rake_circle_ci
   rake_github
@@ -140,6 +180,7 @@ DEPENDENCIES
   rubocop-rake
   rubocop-rspec
   simplecov
+  terminal-notifier-guard
 
 BUNDLED WITH
    2.3.20

data/lib/rspec/terraform/configuration/merger.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Terraform
+    module Configuration
+      class Merger
+        def merge(left, right)
+          merge_top_level(left, right)
+            .merge(merge_accumulating_maps(left, right))
+            .merge(merge_accumulating_lists(left, right))
+        end
+
+        private
+
+        def merge_top_level(left, right)
+          left.merge(right)
+        end
+
+        def merge_accumulating_maps(left, right)
+          left_vars = left[:vars] || {}
+          right_vars = right[:vars] || {}
+          vars = left_vars.merge(right_vars)
+
+          merged = {}
+          unless left_vars == {} && right_vars == {}
+            merged = merged.merge(vars: vars)
+          end
+
+          merged
+        end
+
+        def merge_accumulating_lists(left, right)
+          left_var_files = left[:var_files] || []
+          right_var_files = right[:var_files] || []
+          var_files = left_var_files + right_var_files
+
+          merged = {}
+          unless left_var_files == [] && right_var_files == []
+            merged = merged.merge(var_files: var_files)
+          end
+
+          merged
+        end
+      end
+    end
+  end
+end

data/lib/rspec/terraform/configuration/providers/identity.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'ruby_terraform'
+
+module RSpec
+  module Terraform
+    module Configuration
+      module Providers
+        class Identity
+          def resolve(overrides = {})
+            overrides
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/terraform/configuration/providers/in_memory.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'ruby_terraform'
+require_relative '../merger'
+
+module RSpec
+  module Terraform
+    module Configuration
+      module Providers
+        class InMemory
+          attr_reader(:configuration)
+
+          def initialize(configuration = {})
+            @configuration = configuration
+            @merger = Merger.new
+          end
+
+          def resolve(overrides = {})
+            @merger.merge(configuration, overrides)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/terraform/configuration/providers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'providers/identity'
+require_relative 'providers/in_memory'
+
+module RSpec
+  module Terraform
+    module Configuration
+      module Providers
+      end
+    end
+  end
+end

data/lib/rspec/terraform/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'configuration/providers'
+require_relative 'configuration/merger'
+
+module RSpec
+  module Terraform
+    module Configuration
+      class << self
+        def identity_provider
+          Providers::Identity.new
+        end
+
+        def in_memory_provider(overrides)
+          Providers::InMemory.new(overrides)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'ruby_terraform'
+
+module RSpec
+  module Terraform
+    module Helpers
+      class Apply
+        attr_reader(:overrides, :configuration_provider)
+
+        def initialize(overrides = {}, configuration_provider = nil)
+          @overrides = overrides
+          @configuration_provider =
+            configuration_provider || Configuration.identity_provider
+        end
+
+        def execute
+          parameters = configuration_provider.resolve(overrides)
+          parameters = parameters.merge(
+            input: false,
+            auto_approve: true
+          )
+
+          do_apply(parameters)
+        end
+
+        private
+
+        def do_apply(parameters)
+          RubyTerraform.apply(
+            chdir: parameters[:configuration_directory],
+            state: parameters[:state_file],
+            vars: parameters[:vars],
+            input: parameters[:input],
+            auto_approve: parameters[:auto_approve]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rspec/terraform/helpers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative './helpers/apply'
+
+module RSpec
+  module Terraform
+    module Helpers
+    end
+  end
+end

data/lib/rspec/terraform/matchers/include_output_change.rb

@@ -3,6 +3,7 @@
 module RSpec
   module Terraform
     module Matchers
+      # rubocop:disable Metrics/ClassLength
       class IncludeOutputChange
         attr_reader :definition, :value, :plan
 
@@ -69,8 +70,10 @@ module RSpec
         end
 
         def positive_expected_line
-          maybe_with_definition(
-            positive_plan_line
+          maybe_with_expected_value(
+            maybe_with_definition(
+              positive_plan_line
+            )
           )
         end
 
@@ -79,13 +82,22 @@ module RSpec
         end
 
         def maybe_with_definition(expected_line)
-          unless @definition.empty?
+          unless definition.empty?
             expected_line =
               "#{expected_line} matching definition:\n#{definition_lines}"
           end
           expected_line
         end
 
+        def maybe_with_expected_value(expected_line)
+          unless value.nil?
+            expected_line =
+              "#{expected_line}\n          with value after " \
+              "the output change is applied of:\n#{expected_value_lines}"
+          end
+          expected_line
+        end
+
         def definition_lines
           indent = '            '
           definition
@@ -93,12 +105,21 @@ module RSpec
             .join("\n")
         end
 
+        def expected_value_lines
+          renderable_value = with_matcher_renderable(value)
+          value_object =
+            RubyTerraform::Models::Values.map(value: renderable_value)
+          value_object.render(level: 6, bare: true)
+        end
+
         def positive_got_line
           if plan.output_changes.empty?
             'a plan including no output changes.'
           else
             with_available_output_changes(
-              'a plan including no matching output changes.'
+              maybe_with_relevant_output_changes(
+                'a plan including no matching output changes.'
+              )
             )
           end
         end
@@ -108,6 +129,15 @@ module RSpec
             "\n#{available_output_change_lines}"
         end
 
+        def maybe_with_relevant_output_changes(got_line)
+          unless value.nil?
+            got_line =
+              "#{got_line}\n          relevant output changes are:" \
+              "\n#{relevant_output_change_lines}"
+          end
+          got_line
+        end
+
         def available_output_change_lines
           available_lines = plan.output_changes.collect do |oc|
             name = oc.name
@@ -116,7 +146,32 @@ module RSpec
           end
           available_lines.join("\n")
         end
+
+        def relevant_output_change_lines
+          relevant_lines = definition_matches(plan).collect do |oc|
+            name = oc.name
+            actions = oc.change.actions.join(', ')
+            value = oc.change.after_object
+            value_object =
+              RubyTerraform::Models::Values.map(value: value)
+            value_lines = value_object.render(level: 8, bare: true)
+
+            "            - #{name} (#{actions})\n#{value_lines}"
+          end
+          relevant_lines.join("\n")
+        end
+
+        def with_matcher_renderable(value)
+          return value if value.respond_to?(:render)
+
+          value.define_singleton_method(:render) do |_|
+            "a value satisfying: #{value.description}"
+          end
+
+          value
+        end
       end
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/rspec/terraform/version.rb

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

data/lib/rspec/terraform.rb

@@ -4,7 +4,9 @@ require 'rspec/core'
 require 'ruby_terraform'
 
 require_relative 'terraform/version'
+require_relative 'terraform/configuration'
 require_relative 'terraform/matchers'
+require_relative 'terraform/helpers'
 
 RSpec.configure do |config|
   config.include(RSpec::Terraform::Matchers)

data/rspec-terraform.gemspec

@@ -43,6 +43,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'faker'
   spec.add_development_dependency 'gem-release'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rake_circle_ci'
   spec.add_development_dependency 'rake_github'
@@ -52,6 +55,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'terminal-notifier-guard'
 
   spec.metadata['rubygems_mfa_required'] = 'false'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-terraform
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.18
+  version: 0.1.0.pre.21
 platform: ruby
 authors:
 - InfraBlocks Maintainers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-16 00:00:00.000000000 Z
+date: 2022-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -80,6 +80,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +248,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Helpers, contexts and matchers to support using RSpec to test Terraform
   configurations and modules.
 email:
@@ -223,6 +279,13 @@ files:
 - bin/console
 - bin/setup
 - lib/rspec/terraform.rb
+- lib/rspec/terraform/configuration.rb
+- lib/rspec/terraform/configuration/merger.rb
+- lib/rspec/terraform/configuration/providers.rb
+- lib/rspec/terraform/configuration/providers/identity.rb
+- lib/rspec/terraform/configuration/providers/in_memory.rb
+- lib/rspec/terraform/helpers.rb
+- lib/rspec/terraform/helpers/apply.rb
 - lib/rspec/terraform/matchers.rb
 - lib/rspec/terraform/matchers/include_output_change.rb
 - lib/rspec/terraform/matchers/include_resource_change.rb