rspec-terraform 0.1.0.pre.7 → 0.1.0.pre.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9f63f4653acb1c590d94276efb6e9e35e97ac1bdd4d16d89408e936af8ddc64
-  data.tar.gz: d3347bbc47f608ed5cfdf65ae849bb6e0b8795da3d36849217fc56a39e655574
+  metadata.gz: f8c0ef1824e2c32907a06a34ab775ab0004a9ddf57ab22c5b2baeb40812eb4df
+  data.tar.gz: af62f1d916db8ea95f186bb44903bd52641787c270b6c0e1fa7bf6073482204e
 SHA512:
-  metadata.gz: 916e4ad79473d21ceeafe204e769233bb7bf700d2942bec2b3cf49a8855dfc3eb426c489a54b46fcb5a46e65696644eba477835be9032264bb10217e7aeee9b0
-  data.tar.gz: f67e9c7d78cdca98504cf234de4fc3d17dbe7c0d54752b88fd2d6dd4a13ad359ec996a6ec3ef495193b409407513f589f3dcc52dcde63a4f528e23fe7b94d6a5
+  metadata.gz: 3a2638bb48081a61c55f716459873c66e7bb3e730e80561ddff0605bcbbd48e67cc56498ce7a343747d08d80bdccd6536203b53728163562fd272ca0d4debc37
+  data.tar.gz: 26e7621f75e736abc0e0ba5a036513c4f6d32b2ae3cfd16ba357fe3c956b566773b2756963fba41cae6c57e9537b6af4d124db93beb5f6c3f4971d2e213e8fae

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-terraform (0.1.0.pre.7)
+    rspec-terraform (0.1.0.pre.10)
       rspec (>= 3.0)
       ruby-terraform (= 1.7.0.pre.5)
 

data/Rakefile

@@ -66,7 +66,7 @@ namespace :library do
   task check: [:rubocop]
 
   desc 'Attempt to automatically fix issues with the library'
-  task fix: [:'rubocop:autocorrect']
+  task fix: [:'rubocop:autocorrect_all']
 end
 
 namespace :test do

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

@@ -8,10 +8,11 @@ require 'rspec/matchers/built_in/count_expectation'
 module RSpec
   module Terraform
     module Matchers
+      # rubocop:disable Metrics/ClassLength
       class IncludeResourceChange
         include RSpec::Matchers::BuiltIn::CountExpectation
 
-        attr_reader :definition
+        attr_reader :definition, :attributes, :plan
 
         def initialize(definition = {})
           @definition = definition
@@ -19,6 +20,7 @@ module RSpec
         end
 
         def matches?(plan)
+          @plan = plan
           matches = attribute_matches(plan)
 
           match_count = matches.count
@@ -36,6 +38,16 @@ module RSpec
           self
         end
 
+        def failure_message
+          "\nexpected: #{positive_expected_line}" \
+            "\n     got: #{positive_got_line}"
+        end
+
+        def failure_message_when_negated
+          "\nexpected: a plan including no resource changes" \
+            "\n     got: a plan including at least one resource change"
+        end
+
         private
 
         def definition_matches(plan)
@@ -70,55 +82,134 @@ module RSpec
 
           actual
         end
+
+        def positive_expected_line
+          maybe_with_expected_attributes(
+            maybe_with_definition(
+              positive_plan_line
+            )
+          )
+        end
+
+        def positive_plan_line
+          cardinality = cardinality_fragment
+          plurality = expected_count.nil? || expected_count == 1 ? '' : 's'
+
+          "a plan including #{cardinality} resource change#{plurality}"
+        end
+
+        def maybe_with_definition(expected_line)
+          unless @definition.empty?
+            expected_line =
+              "#{expected_line} matching definition:\n#{definition_lines}"
+          end
+          expected_line
+        end
+
+        def maybe_with_expected_attributes(expected_line)
+          unless @attributes.empty?
+            expected_line =
+              "#{expected_line}\n          with attribute values after " \
+              "the resource change is applied of:\n#{expected_attribute_lines}"
+          end
+          expected_line
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def positive_got_line
+          if plan.resource_changes.empty?
+            'a plan including no resource changes.'
+          else
+            count = attribute_matches(plan).count
+            amount = count.zero? ? 'no' : cardinality_amount(count)
+            plurality = count == 1 ? '' : 's'
+            got_line =
+              "a plan including #{amount} matching " \
+              "resource change#{plurality}."
+
+            unless attributes.empty?
+              got_line =
+                "#{got_line}\n          relevant resource changes are:" \
+                "\n#{relevant_resource_change_lines}"
+            end
+
+            "#{got_line}\n          available resource changes are:" \
+              "\n#{available_resource_change_lines}"
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def cardinality_fragment
+          qualifier = cardinality_qualifier
+          amount = cardinality_amount(expected_count)
+          "#{qualifier} #{amount}"
+        end
+
+        def cardinality_qualifier
+          case count_expectation_type
+          when :<= then 'at most'
+          when nil, :>= then 'at least'
+          when :== then 'exactly'
+          when :<=> then 'between'
+          end
+        end
+
+        def cardinality_amount(count)
+          case count
+          when Range then "#{count.first} and #{count.last}"
+          when nil, 1 then 'one'
+          when 2 then 'two'
+          when 3 then 'three'
+          else count.to_s
+          end
+        end
+
+        def definition_lines
+          indent = '            '
+          definition
+            .collect { |k, v| "#{indent}#{k} = #{v.inspect}" }
+            .join("\n")
+        end
+
+        def expected_attribute_lines
+          indent = '            '
+          attribute_fragments = attributes.collect do |a|
+            "#{indent}#{render(a[:path])} = #{a[:value].inspect}"
+          end
+          attribute_fragments.join("\n")
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def relevant_resource_change_lines
+          relevant_lines = definition_matches(plan).collect do |rc|
+            address = rc.address
+            actions = rc.change.actions.join(', ')
+            attributes = rc.change.after_object
+            attribute_lines = attributes.collect do |key, value|
+              "                #{key} = #{value.inspect}"
+            end
+            attribute_lines = attribute_lines.join("\n")
+            "            - #{address} (#{actions})\n#{attribute_lines}"
+          end
+          relevant_lines.join("\n")
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def available_resource_change_lines
+          available_lines = plan.resource_changes.collect do |rc|
+            address = rc.address
+            actions = rc.change.actions.join(', ')
+            "            - #{address} (#{actions})"
+          end
+          available_lines.join("\n")
+        end
+
+        def render(path)
+          path.collect { |elem| elem.to_s }.join(',')
+        end
       end
+
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end
-
-# RSpec::Matchers.define :include_resource_creation do |type|
-#   match do |plan|
-#     resource_changes = plan.resource_changes_with_type(type)
-#     resource_creations = resource_changes.filter(&:create?)
-#
-#     return false if @count && resource_creations.length != @count
-#     return false if resource_creations.empty?
-#
-#     pp plan.to_h
-#
-#     if @arguments
-#       return resource_creations.any? do |resource_creation|
-#         @arguments.all? do |name, value|
-#           resource_creation.change.after[name] == value
-#         end
-#       end
-#     end
-#
-#     return true
-#   end
-#
-#   chain :count do |count|
-#     @count = count
-#   end
-#
-#   chain :with_argument_value do |name, value|
-#     @arguments = (@arguments || {}).merge(name => value)
-#   end
-#
-#   failure_message do |plan|
-#     resource_creations = plan.resource_creations.map do |resource_creation|
-#       "#{resource_creation.type}.#{resource_creation.name}"
-#     end
-#     "\nexpected: a plan with a resource creation for type: #{type}" \
-#       "\n     got: a plan with resource creations:" \
-#       "\n            - #{resource_creations.join("\n            - ")}"
-#   end
-#
-#   failure_message_when_negated do |plan|
-#     resource_creations = plan.resource_creations.map do |resource_creation|
-#       "#{resource_creation.type}.#{resource_creation.name}"
-#     end
-#     "\nexpected: a plan without a resource creation for type: #{type}" \
-#       "\n     got: a plan with resource creations:" \
-#       "\n            - #{resource_creations.join("\n            - ")}"
-#   end
-# end

data/lib/rspec/terraform/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-terraform
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.7
+  version: 0.1.0.pre.10
 platform: ruby
 authors:
 - InfraBlocks Maintainers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-17 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec