pact 1.54.0 → 1.55.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 668b177b7d244716ded4b592c37be8788ce6d0e1fd4036becdf5025a73e40022
4
- data.tar.gz: 3185c5eeca1d02878e916b1feb6eddc4888a139374548987fc295d90b38d67c6
3
+ metadata.gz: 54f6d8684eb57457977a86f79a9e2aace62f2fe63ef1e3896e8beee31586b0fe
4
+ data.tar.gz: 292f5bdfe8cf126faaaab4a1792b1e68a21484f32a311fc9a5053f9a64f00f04
5
5
  SHA512:
6
- metadata.gz: 217392c245364ea7df2e75851d211760a57cb5ec19285d8a5f7cd1f770ff85211115d4137d8b60a2c6c7b75ccb7a2fceb85c17ba00f4ef727f452f11e09e2d67
7
- data.tar.gz: 111d4ddd772e5367485f716c19d9a8e64f8ce3e3045c273b48535dade001913bb6af2e552f6cc9f7e767b0f14d9111f62d7f114dd7b5318cdfcaade3a1ecab0f
6
+ metadata.gz: 2501e2bb9ea36e185d45816d1944718fca0b0ebab315f7c51557553f85c809c96cb2a20d09096a326be108eafef352e6d41d2cc018369b3422f162bcc8fe7696
7
+ data.tar.gz: d08e959aa8220f31b0fc8e60b82e9dda9f367f04604db7d26bdef16304b8862f45679e9333e49646d157e292ca03ef98fd94cb221723c7aee988539d0cc8540d
@@ -1,3 +1,13 @@
1
+ <a name="v1.55.0"></a>
2
+ ### v1.55.0 (2020-09-26)
3
+
4
+ #### Features
5
+
6
+ * add consumer_version_selectors to pact verification DSL, and convert consumer_version_tags to selectors ([39e6c4a](/../../commit/39e6c4a))
7
+ * allow verification task to set just a pact_helper without a URI ([303077d](/../../commit/303077d))
8
+ * split pending and failed rerun commands into separate sections ([f839391](/../../commit/f839391))
9
+ * update output during verification so the pact info shows before the describe blocks of the pact that is being verified ([15ec231](/../../commit/15ec231))
10
+
1
11
  <a name="v1.54.0"></a>
2
12
  ### v1.54.0 (2020-09-12)
3
13
 
@@ -39,9 +39,11 @@ module Pact
39
39
  log_message
40
40
  pacts_for_verification
41
41
  else
42
+ old_selectors = consumer_version_selectors.collect do | selector |
43
+ { name: selector[:tag], all: !selector[:latest], fallback: selector[:fallbackTag]}
44
+ end
42
45
  # Fall back to old method of fetching pacts
43
- consumer_version_tags = consumer_version_selectors.collect{ | selector | selector[:tag] }
44
- FetchPacts.call(provider, consumer_version_tags, broker_base_url, http_client_options)
46
+ FetchPacts.call(provider, old_selectors, broker_base_url, http_client_options)
45
47
  end
46
48
  end
47
49
 
@@ -7,7 +7,6 @@ module Pact
7
7
  if consumer_version_selectors.any?
8
8
  desc = consumer_version_selectors.collect do |selector|
9
9
  all_or_latest = !selector[:latest] ? "all for tag" : "latest for tag"
10
- # TODO support fallback
11
10
  fallback = selector[:fallback] || selector[:fallbackTag]
12
11
  name = fallback ? "#{selector[:tag]} (or #{fallback} if not found)" : selector[:tag]
13
12
  "#{all_or_latest} #{name}"
@@ -2,6 +2,7 @@ require 'pact/shared/dsl'
2
2
  require 'pact/provider/world'
3
3
  require 'pact/pact_broker/fetch_pact_uris_for_verification'
4
4
  require 'pact/errors'
5
+ require 'pact/utils/string'
5
6
 
6
7
  module Pact
7
8
  module Provider
@@ -14,12 +15,13 @@ module Pact
14
15
  # in parent scope, it will clash with these ones,
15
16
  # so put an underscore in front of the name to be safer.
16
17
 
17
- attr_accessor :_provider_name, :_pact_broker_base_url, :_consumer_version_tags, :_provider_version_tags, :_basic_auth_options, :_enable_pending, :_include_wip_pacts_since, :_verbose
18
+ attr_accessor :_provider_name, :_pact_broker_base_url, :_consumer_version_tags, :_provider_version_tags, :_basic_auth_options, :_enable_pending, :_include_wip_pacts_since, :_verbose, :_consumer_version_selectors
18
19
 
19
20
  def initialize(provider_name, provider_version_tags)
20
21
  @_provider_name = provider_name
21
22
  @_provider_version_tags = provider_version_tags
22
23
  @_consumer_version_tags = []
24
+ @_consumer_version_selectors = []
23
25
  @_enable_pending = false
24
26
  @_include_wip_pacts_since = nil
25
27
  @_verbose = false
@@ -35,6 +37,10 @@ module Pact
35
37
  self._consumer_version_tags = *consumer_version_tags
36
38
  end
37
39
 
40
+ def consumer_version_selectors consumer_version_selectors
41
+ self._consumer_version_selectors = *consumer_version_selectors
42
+ end
43
+
38
44
  def enable_pending enable_pending
39
45
  self._enable_pending = enable_pending
40
46
  end
@@ -73,12 +79,33 @@ module Pact
73
79
  end
74
80
 
75
81
  def consumer_version_selectors
76
- # TODO support "all"
82
+ convert_tags_to_selectors + convert_consumer_version_selectors
83
+ end
84
+
85
+ def convert_tags_to_selectors
77
86
  _consumer_version_tags.collect do | tag |
78
- {
79
- tag: tag,
80
- latest: true
81
- }
87
+ if tag.is_a?(Hash)
88
+ {
89
+ tag: tag.fetch(:name),
90
+ latest: !tag[:all],
91
+ fallbackTag: tag[:fallback]
92
+ }
93
+ elsif tag.is_a?(String)
94
+ {
95
+ tag: tag,
96
+ latest: true
97
+ }
98
+ else
99
+ raise Pact::Error.new("The value supplied for consumer_version_tags must be a String or a Hash. Found #{tag.class}")
100
+ end
101
+ end
102
+ end
103
+
104
+ def convert_consumer_version_selectors
105
+ _consumer_version_selectors.collect do | selector |
106
+ selector.each_with_object({}) do | (key, value), new_selector |
107
+ new_selector[Pact::Utils::String.camelcase(key.to_s).to_sym] = value
108
+ end
82
109
  end
83
110
  end
84
111
 
@@ -24,28 +24,34 @@ module Pact
24
24
  def honour_pactfile pact_source, pact_json, options
25
25
  pact_uri = pact_source.uri
26
26
  Pact.configuration.output_stream.puts "INFO: Reading pact at #{pact_uri}"
27
- if pact_uri.metadata[:notices]
28
- pact_uri.metadata[:notices].before_verification_notices_text.each do | text |
29
- Pact.configuration.output_stream.puts("DEBUG: #{text}")
30
- end
31
- end
32
-
33
- Pact.configuration.output_stream.puts "DEBUG: Filtering interactions by: #{options[:criteria]}" if options[:criteria] && options[:criteria].any?
34
27
  consumer_contract = Pact::ConsumerContract.from_json(pact_json)
35
28
  suffix = pact_uri.metadata[:pending] ? " [PENDING]": ""
29
+
36
30
  ::RSpec.describe "Verifying a pact between #{consumer_contract.consumer.name} and #{consumer_contract.provider.name}#{suffix}", pactfile_uri: pact_uri do
37
- honour_consumer_contract consumer_contract, options.merge(pact_json: pact_json, pact_uri: pact_uri, pact_source: pact_source, consumer_contract: consumer_contract)
31
+ honour_consumer_contract consumer_contract, options.merge(
32
+ pact_json: pact_json,
33
+ pact_uri: pact_uri,
34
+ pact_source: pact_source,
35
+ consumer_contract: consumer_contract,
36
+ criteria: options[:criteria]
37
+ )
38
38
  end
39
39
  end
40
40
 
41
41
  def honour_consumer_contract consumer_contract, options = {}
42
- describe_consumer_contract consumer_contract, options.merge(consumer: consumer_contract.consumer.name)
42
+ describe_consumer_contract consumer_contract, options.merge(consumer: consumer_contract.consumer.name, pact_context: InteractionContext.new)
43
43
  end
44
44
 
45
45
  private
46
46
 
47
47
  def describe_consumer_contract consumer_contract, options
48
- consumer_interactions(consumer_contract, options).each do |interaction|
48
+ consumer_interactions(consumer_contract, options).tap{ |interactions|
49
+ if interactions.empty?
50
+ # If there are no interactions, the documentation formatter never fires to print this out,
51
+ # so print it out here.
52
+ Pact.configuration.output_stream.puts "DEBUG: All interactions for #{options[:pact_uri]} have been filtered out by criteria: #{options[:criteria]}" if options[:criteria] && options[:criteria].any?
53
+ end
54
+ }.each do |interaction|
49
55
  describe_interaction_with_provider_state interaction, options
50
56
  end
51
57
  end
@@ -54,7 +60,7 @@ module Pact
54
60
  if options[:criteria].nil?
55
61
  consumer_contract.interactions
56
62
  else
57
- consumer_contract.find_interactions options[:criteria]
63
+ consumer_contract.find_interactions(options[:criteria])
58
64
  end
59
65
  end
60
66
 
@@ -84,14 +90,19 @@ module Pact
84
90
  pact_uri: options[:pact_uri],
85
91
  pact_source: options[:pact_source],
86
92
  pact_ignore_failures: options[:pact_uri].metadata[:pending] || options[:ignore_failures],
87
- pact_consumer_contract: options[:consumer_contract]
93
+ pact_consumer_contract: options[:consumer_contract],
94
+ pact_criteria: options[:criteria]
88
95
  }
89
96
 
90
97
  describe description_for(interaction), metadata do
91
98
 
92
99
  interaction_context = InteractionContext.new
100
+ pact_context = options[:pact_context]
93
101
 
94
102
  before do | example |
103
+ pact_context.run_once :before do
104
+ ::RSpec.configuration.reporter.message "THIS IS A PACT"
105
+ end
95
106
  interaction_context.run_once :before do
96
107
  Pact.configuration.logger.info "Running example '#{Pact::RSpec.full_description(example)}'"
97
108
  set_up_provider_states interaction.provider_states, options[:consumer]
@@ -24,6 +24,25 @@ module Pact
24
24
 
25
25
  C = ::Term::ANSIColor
26
26
 
27
+ def example_group_started(notification)
28
+ if @group_level == 0
29
+ Pact.configuration.output_stream.puts
30
+ pact_uri = notification.group.metadata[:pactfile_uri]
31
+ ::RSpec.configuration.failure_color = pact_uri.metadata[:pending] ? :yellow : :red
32
+
33
+ if pact_uri.metadata[:notices]
34
+ pact_uri.metadata[:notices].before_verification_notices_text.each do | text |
35
+ Pact.configuration.output_stream.puts("DEBUG: #{text}")
36
+ end
37
+ end
38
+
39
+ criteria = notification.group.metadata[:pact_criteria]
40
+ Pact.configuration.output_stream.puts "DEBUG: Filtering interactions by: #{criteria}" if criteria && criteria.any?
41
+ end
42
+ super
43
+ end
44
+
45
+
27
46
  def dump_summary(summary)
28
47
  output.puts "\n" + colorized_totals_line(summary)
29
48
  return if summary.failure_count == 0
@@ -35,11 +54,15 @@ module Pact
35
54
  private
36
55
 
37
56
  def interactions_count(summary)
38
- summary.examples.collect{ |e| e.metadata[:pact_interaction_example_description] }.uniq.size
57
+ summary.examples.collect{ |e| interaction_unique_key(e) }.uniq.size
39
58
  end
40
59
 
41
60
  def failed_interactions_count(summary)
42
- summary.failed_examples.collect{ |e| e.metadata[:pact_interaction_example_description] }.uniq.size
61
+ failed_interaction_examples(summary).size
62
+ end
63
+
64
+ def pending_interactions_count(summary)
65
+ pending_interaction_examples(summary).size
43
66
  end
44
67
 
45
68
  def ignore_failures?(summary)
@@ -47,16 +70,14 @@ module Pact
47
70
  end
48
71
 
49
72
  def failure_title summary
50
- if ignore_failures?(summary)
51
- "#{failed_interactions_count(summary)} pending"
52
- else
53
- ::RSpec::Core::Formatters::Helpers.pluralize(failed_interactions_count(summary), "failure")
54
- end
73
+ ::RSpec::Core::Formatters::Helpers.pluralize(failed_interactions_count(summary), "failure")
55
74
  end
56
75
 
57
76
  def totals_line summary
58
77
  line = ::RSpec::Core::Formatters::Helpers.pluralize(interactions_count(summary), "interaction")
59
78
  line << ", " << failure_title(summary)
79
+ pending_count = pending_interactions_count(summary)
80
+ line << ", " << "#{pending_count} pending" if pending_count > 0
60
81
  line
61
82
  end
62
83
 
@@ -69,12 +90,17 @@ module Pact
69
90
  end
70
91
 
71
92
  def print_rerun_commands summary
72
- if ignore_failures?(summary)
93
+ if pending_interactions_count(summary) > 0
94
+ set_rspec_failure_color(:yellow)
73
95
  output.puts("\nPending interactions: (Failures listed here are expected and do not affect your suite's status)\n\n")
74
- else
75
- output.puts("\nFailed interactions:\n\n")
96
+ interaction_rerun_commands(pending_interaction_examples(summary)).each do | message |
97
+ output.puts(message)
98
+ end
76
99
  end
77
- interaction_rerun_commands(summary).each do | message |
100
+
101
+ set_rspec_failure_color(:red)
102
+ output.puts("\nFailed interactions:\n\n")
103
+ interaction_rerun_commands(failed_interaction_examples(summary)).each do | message |
78
104
  output.puts(message)
79
105
  end
80
106
  end
@@ -85,10 +111,34 @@ module Pact
85
111
  end
86
112
  end
87
113
 
88
- def interaction_rerun_commands summary
89
- summary.failed_examples.collect do |example|
114
+ def pending_interaction_examples(summary)
115
+ one_failed_example_per_interaction(summary).select do | example |
116
+ example.metadata[:pactfile_uri].metadata[:pending]
117
+ end
118
+ end
119
+
120
+ def failed_interaction_examples(summary)
121
+ one_failed_example_per_interaction(summary).select do | example |
122
+ !example.metadata[:pactfile_uri].metadata[:pending]
123
+ end
124
+ end
125
+
126
+ def one_failed_example_per_interaction(summary)
127
+ summary.failed_examples.group_by{| e| interaction_unique_key(e)}.values.collect(&:first)
128
+ end
129
+
130
+ def interaction_rerun_commands examples
131
+ examples.collect do |example|
90
132
  interaction_rerun_command_for example
91
- end.uniq.compact
133
+ end.compact
134
+ end
135
+
136
+ def interaction_unique_key(example)
137
+ # pending is just to make the counting easier, it isn't required for the unique key
138
+ {
139
+ pactfile_uri: example.metadata[:pactfile_uri],
140
+ index: example.metadata[:pact_interaction].index,
141
+ }
92
142
  end
93
143
 
94
144
  def interaction_rerun_command_for example
@@ -137,6 +187,10 @@ module Pact
137
187
  def executing_with_ruby?
138
188
  ENV['PACT_EXECUTING_LANGUAGE'] == 'ruby'
139
189
  end
190
+
191
+ def set_rspec_failure_color color
192
+ ::RSpec.configuration.failure_color = color
193
+ end
140
194
  end
141
195
  end
142
196
  end
@@ -31,6 +31,7 @@ module Pact
31
31
  attr_reader :pact_spec_configs
32
32
  attr_accessor :rspec_opts
33
33
  attr_accessor :ignore_failures
34
+ attr_accessor :_pact_helper
34
35
 
35
36
  def initialize(name)
36
37
  @rspec_opts = nil
@@ -41,6 +42,10 @@ module Pact
41
42
  rake_task
42
43
  end
43
44
 
45
+ def pact_helper(pact_helper)
46
+ @pact_spec_configs << { pact_helper: pact_helper }
47
+ end
48
+
44
49
  def uri(uri, options = {})
45
50
  @pact_spec_configs << {uri: uri, pact_helper: options[:pact_helper]}
46
51
  end
@@ -82,6 +87,7 @@ module Pact
82
87
  Pact::TaskHelper.handle_verification_failure do
83
88
  exit_statuses.count{ | status | status != 0 }
84
89
  end
90
+
85
91
  end
86
92
  end
87
93
  end
@@ -0,0 +1,35 @@
1
+ # Can't use refinements because of Travelling Ruby
2
+
3
+ module Pact
4
+ module Utils
5
+ module String
6
+
7
+ extend self
8
+
9
+ # ripped from rubyworks/facets, thank you
10
+ def camelcase(string, *separators)
11
+ case separators.first
12
+ when Symbol, TrueClass, FalseClass, NilClass
13
+ first_letter = separators.shift
14
+ end
15
+
16
+ separators = ['_', '\s'] if separators.empty?
17
+
18
+ str = string.dup
19
+
20
+ separators.each do |s|
21
+ str = str.gsub(/(?:#{s}+)([a-z])/){ $1.upcase }
22
+ end
23
+
24
+ case first_letter
25
+ when :upper, true
26
+ str = str.gsub(/(\A|\s)([a-z])/){ $1 + $2.upcase }
27
+ when :lower, false
28
+ str = str.gsub(/(\A|\s)([A-Z])/){ $1 + $2.downcase }
29
+ end
30
+
31
+ str
32
+ end
33
+ end
34
+ end
35
+ end
@@ -1,4 +1,4 @@
1
1
  # Remember to bump pact-provider-proxy when this changes major version
2
2
  module Pact
3
- VERSION = "1.54.0"
3
+ VERSION = "1.55.0"
4
4
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: pact
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.54.0
4
+ version: 1.55.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - James Fraser
@@ -12,7 +12,7 @@ authors:
12
12
  autorequire:
13
13
  bindir: bin
14
14
  cert_chain: []
15
- date: 2020-09-12 00:00:00.000000000 Z
15
+ date: 2020-09-26 00:00:00.000000000 Z
16
16
  dependencies:
17
17
  - !ruby/object:Gem::Dependency
18
18
  name: rspec
@@ -377,6 +377,7 @@ files:
377
377
  - lib/pact/tasks/verification_task.rb
378
378
  - lib/pact/templates/help.erb
379
379
  - lib/pact/templates/provider_state.erb
380
+ - lib/pact/utils/string.rb
380
381
  - lib/pact/version.rb
381
382
  - lib/tasks/pact.rake
382
383
  - pact.gemspec