pact_broker-client 1.38.0 → 1.40.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +34 -0
  3. data/README.md +18 -0
  4. data/bin/pact-broker +6 -0
  5. data/doc/pacts/markdown/Pact Broker Client - Pact Broker.md +100 -0
  6. data/example/scripts/publish-pact.sh +1 -1
  7. data/lib/pact_broker/client/base_client.rb +1 -1
  8. data/lib/pact_broker/client/cli/broker.rb +25 -8
  9. data/lib/pact_broker/client/cli/record_deployment_long_desc.txt +55 -0
  10. data/lib/pact_broker/client/hal/entity.rb +16 -0
  11. data/lib/pact_broker/client/hal/http_client.rb +37 -1
  12. data/lib/pact_broker/client/hal/link.rb +12 -0
  13. data/lib/pact_broker/client/hal/links.rb +15 -0
  14. data/lib/pact_broker/client/hal_client_methods.rb +8 -0
  15. data/lib/pact_broker/client/pacts.rb +0 -1
  16. data/lib/pact_broker/client/publish_pacts.rb +90 -128
  17. data/lib/pact_broker/client/publish_pacts_the_old_way.rb +194 -0
  18. data/lib/pact_broker/client/tasks/publication_task.rb +3 -3
  19. data/lib/pact_broker/client/version.rb +1 -1
  20. data/lib/pact_broker/client/versions/record_deployment.rb +4 -4
  21. data/lib/pact_broker/client/versions/record_undeployment.rb +45 -68
  22. data/script/publish-pact.sh +32 -4
  23. data/script/record-deployment.sh +1 -3
  24. data/script/record-undeployment.sh +4 -0
  25. data/spec/fixtures/foo-bar.json +31 -0
  26. data/spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb +1 -1
  27. data/spec/lib/pact_broker/client/cli/broker_publish_spec.rb +36 -7
  28. data/spec/lib/pact_broker/client/hal/http_client_spec.rb +64 -7
  29. data/spec/lib/pact_broker/client/pacticipants/create_spec.rb +3 -0
  30. data/spec/lib/pact_broker/client/{publish_pacts_spec.rb → publish_pacts_the_old_way_spec.rb} +10 -9
  31. data/spec/lib/pact_broker/client/tasks/publication_task_spec.rb +18 -12
  32. data/spec/lib/pact_broker/client/versions/record_deployment_spec.rb +4 -4
  33. data/spec/pacts/pact_broker_client-pact_broker.json +106 -0
  34. data/spec/service_providers/pact_broker_client_create_version_spec.rb +4 -4
  35. data/spec/service_providers/publish_pacts_spec.rb +115 -0
  36. data/spec/service_providers/record_deployment_spec.rb +5 -5
  37. data/spec/spec_helper.rb +1 -1
  38. metadata +12 -5
@@ -1,6 +1,6 @@
1
1
  require_relative 'pact_helper'
2
2
  require 'pact_broker/client'
3
- require 'pact_broker/client/publish_pacts'
3
+ require 'pact_broker/client/publish_pacts_the_old_way'
4
4
 
5
5
  describe PactBroker::Client::Versions, pact: true do
6
6
 
@@ -9,7 +9,7 @@ describe PactBroker::Client::Versions, pact: true do
9
9
 
10
10
  describe "creating a pacticipant version" do
11
11
  before do
12
- allow(publish_pacts).to receive(:consumer_names).and_return(["Foo"])
12
+ allow(publish_pacts_the_old_way).to receive(:consumer_names).and_return(["Foo"])
13
13
  allow($stdout).to receive(:puts)
14
14
  end
15
15
  let(:version_path) { "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-{pacticipant}-{version}" }
@@ -18,11 +18,11 @@ describe PactBroker::Client::Versions, pact: true do
18
18
  let(:branch) { "main" }
19
19
  let(:build_url) { "http://my-ci/builds/1" }
20
20
  let(:consumer_version_params) { { number: number, branch: branch, build_url: build_url } }
21
- let(:publish_pacts) { PactBroker::Client::PublishPacts.new(pact_broker.mock_service_base_url, ["some-pact.json"], consumer_version_params, {}) }
21
+ let(:publish_pacts_the_old_way) { PactBroker::Client::PublishPactsTheOldWay.new(pact_broker.mock_service_base_url, ["some-pact.json"], consumer_version_params, {}) }
22
22
  let(:provider_state) { "version #{number} of pacticipant Foo does not exist" }
23
23
  let(:expected_response_status) { 201 }
24
24
 
25
- subject { publish_pacts.send(:create_consumer_versions) }
25
+ subject { publish_pacts_the_old_way.send(:create_consumer_versions) }
26
26
 
27
27
  before do
28
28
  pact_broker
@@ -0,0 +1,115 @@
1
+ require 'pact_broker/client/publish_pacts'
2
+ require 'service_providers/pact_helper'
3
+
4
+ RSpec.describe "publishing contracts", pact: true do
5
+ before do
6
+ allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:sleep)
7
+ allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:default_max_tries).and_return(1)
8
+ end
9
+ include_context "pact broker"
10
+ include PactBrokerPactHelperMethods
11
+
12
+ let(:pacticipant_name) { "Foo" }
13
+ let(:version_number) { "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30" }
14
+ let(:output) { "text" }
15
+ let(:build_url) { "http://build" }
16
+ let(:consumer_version_params) do
17
+ {
18
+ pacticipant_name: pacticipant_name,
19
+ number: version_number,
20
+ tags: ["dev"],
21
+ branch: "main",
22
+ build_url: build_url,
23
+ output: output
24
+ }
25
+ end
26
+ let(:pact_file_path_1) { "spec/fixtures/foo-bar.json" }
27
+ let(:pact_file_paths) { [pact_file_path_1] }
28
+ let(:options) { {} }
29
+ let(:pact_broker_client_options) { {} }
30
+ let(:expected_content) { Base64.strict_encode64(JSON.parse(File.read(pact_file_path_1)).to_json) }
31
+ let(:request_body) do
32
+ {
33
+ pacticipantName: pacticipant_name,
34
+ pacticipantVersionNumber: version_number,
35
+ branch: "main",
36
+ tags: ["dev"],
37
+ buildUrl: "http://build",
38
+ contracts: [
39
+ {
40
+ consumerName: pacticipant_name,
41
+ providerName: "Bar",
42
+ specification: "pact",
43
+ contentType: "application/json",
44
+ content: expected_content,
45
+ writeMode: "overwrite"
46
+ }
47
+ ]
48
+ }
49
+ end
50
+
51
+ subject { PactBroker::Client::PublishPacts.call(broker_base_url, pact_file_paths, consumer_version_params, options, pact_broker_client_options) }
52
+
53
+ def mock_index
54
+ pact_broker
55
+ .given("the pb:publish-contracts relations exists in the index resource")
56
+ .upon_receiving("a request for the index resource")
57
+ .with(
58
+ method: "GET",
59
+ path: '/',
60
+ headers: get_request_headers).
61
+ will_respond_with(
62
+ status: 200,
63
+ headers: pact_broker_response_headers,
64
+ body: {
65
+ _links: {
66
+ :'pb:publish-contracts' => {
67
+ href: placeholder_url_term("pb:publish-contracts")
68
+ }
69
+ }
70
+ }
71
+ )
72
+ end
73
+
74
+ def mock_contract_publication
75
+ pact_broker
76
+ .upon_receiving("a request to publish contracts")
77
+ .with(
78
+ method: "POST",
79
+ path: '/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS',
80
+ headers: post_request_headers,
81
+ body: request_body).
82
+ will_respond_with(
83
+ status: 200,
84
+ headers: pact_broker_response_headers,
85
+ body: {
86
+ _embedded: {
87
+ pacticipant: {
88
+ name: pacticipant_name
89
+ },
90
+ version: {
91
+ number: version_number,
92
+ buildUrl: build_url
93
+ }
94
+ },
95
+ logs: Pact.each_like(level: "info", message: "some message"),
96
+ _links: {
97
+ :'pb:pacticipant-version-tags' => [{ name: "dev"} ],
98
+ :'pb:contracts' => [{ href: Pact.like("http://some-pact") }]
99
+ }
100
+ }
101
+ )
102
+ end
103
+
104
+ context "with valid params" do
105
+ before do
106
+ mock_index
107
+ mock_contract_publication
108
+ end
109
+
110
+ it "returns a success result" do
111
+ expect(subject.success).to be true
112
+ expect(subject.message).to include "some message"
113
+ end
114
+ end
115
+ end
@@ -10,13 +10,13 @@ RSpec.describe "recording a deployment", pact: true do
10
10
  let(:version_number) { "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30" }
11
11
  let(:environment_name) { "test" }
12
12
  let(:output) { "text" }
13
- let(:replaced_previous_deployed_version) { true }
13
+ let(:target) { true }
14
14
  let(:params) do
15
15
  {
16
16
  pacticipant_name: pacticipant_name,
17
17
  version_number: version_number,
18
18
  environment_name: environment_name,
19
- replaced_previous_deployed_version: replaced_previous_deployed_version,
19
+ target: target,
20
20
  output: output
21
21
  }
22
22
  end
@@ -148,14 +148,14 @@ RSpec.describe "recording a deployment", pact: true do
148
148
  path: "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
149
149
  headers: post_request_headers,
150
150
  body: {
151
- replacedPreviousDeployedVersion: replaced_previous_deployed_version
151
+ replacedPreviousDeployedVersion: target
152
152
  }
153
153
  )
154
154
  .will_respond_with(
155
155
  status: 201,
156
156
  headers: pact_broker_response_headers,
157
157
  body: {
158
- replacedPreviousDeployedVersion: replaced_previous_deployed_version
158
+ replacedPreviousDeployedVersion: target
159
159
  }
160
160
  )
161
161
  end
@@ -176,7 +176,7 @@ RSpec.describe "recording a deployment", pact: true do
176
176
  let(:output) { "json" }
177
177
 
178
178
  it "returns the JSON payload" do
179
- expect(JSON.parse(subject.message)).to eq "replacedPreviousDeployedVersion" => replaced_previous_deployed_version
179
+ expect(JSON.parse(subject.message)).to eq "replacedPreviousDeployedVersion" => target
180
180
  end
181
181
  end
182
182
  end
data/spec/spec_helper.rb CHANGED
@@ -1,6 +1,6 @@
1
1
  require 'webmock/rspec'
2
2
 
3
- ENV['PACT_BROKER_FEATURES'] = 'deployments'
3
+ ENV['PACT_BROKER_FEATURES'] = 'deployments publish_contracts'
4
4
 
5
5
  WebMock.disable_net_connect!(allow_localhost: true)
6
6
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: pact_broker-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.38.0
4
+ version: 1.40.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Beth Skurrie
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-03-22 00:00:00.000000000 Z
11
+ date: 2021-04-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: httparty
@@ -212,6 +212,7 @@ files:
212
212
  - lib/pact_broker/client/cli/create_or_update_webhook_long_desc.txt
213
213
  - lib/pact_broker/client/cli/create_webhook_long_desc.txt
214
214
  - lib/pact_broker/client/cli/custom_thor.rb
215
+ - lib/pact_broker/client/cli/record_deployment_long_desc.txt
215
216
  - lib/pact_broker/client/cli/version_selector_options_parser.rb
216
217
  - lib/pact_broker/client/command_result.rb
217
218
  - lib/pact_broker/client/create_tag.rb
@@ -240,6 +241,7 @@ files:
240
241
  - lib/pact_broker/client/pacts.rb
241
242
  - lib/pact_broker/client/pacts/list_latest_versions.rb
242
243
  - lib/pact_broker/client/publish_pacts.rb
244
+ - lib/pact_broker/client/publish_pacts_the_old_way.rb
243
245
  - lib/pact_broker/client/retry.rb
244
246
  - lib/pact_broker/client/tasks.rb
245
247
  - lib/pact_broker/client/tasks/publication_task.rb
@@ -259,8 +261,10 @@ files:
259
261
  - script/generate-cli-usage.sh
260
262
  - script/publish-pact.sh
261
263
  - script/record-deployment.sh
264
+ - script/record-undeployment.sh
262
265
  - script/release.sh
263
266
  - script/trigger-release.sh
267
+ - spec/fixtures/foo-bar.json
264
268
  - spec/integration/can_i_deploy_spec.rb
265
269
  - spec/integration/create_version_tag_spec.rb
266
270
  - spec/lib/pact_broker/client/base_client_spec.rb
@@ -284,7 +288,7 @@ files:
284
288
  - spec/lib/pact_broker/client/pact_broker_client_spec.rb
285
289
  - spec/lib/pact_broker/client/pacticipants/create_spec.rb
286
290
  - spec/lib/pact_broker/client/pacticipants_spec.rb
287
- - spec/lib/pact_broker/client/publish_pacts_spec.rb
291
+ - spec/lib/pact_broker/client/publish_pacts_the_old_way_spec.rb
288
292
  - spec/lib/pact_broker/client/retry_spec.rb
289
293
  - spec/lib/pact_broker/client/tasks/publication_task_spec.rb
290
294
  - spec/lib/pact_broker/client/versions/describe_spec.rb
@@ -305,6 +309,7 @@ files:
305
309
  - spec/service_providers/pact_broker_client_versions_spec.rb
306
310
  - spec/service_providers/pact_helper.rb
307
311
  - spec/service_providers/pacticipants_create_spec.rb
312
+ - spec/service_providers/publish_pacts_spec.rb
308
313
  - spec/service_providers/record_deployment_spec.rb
309
314
  - spec/service_providers/webhooks_create_spec.rb
310
315
  - spec/spec_helper.rb
@@ -339,11 +344,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
339
344
  - !ruby/object:Gem::Version
340
345
  version: '0'
341
346
  requirements: []
342
- rubygems_version: 3.2.15
347
+ rubygems_version: 3.2.16
343
348
  signing_key:
344
349
  specification_version: 4
345
350
  summary: See description
346
351
  test_files:
352
+ - spec/fixtures/foo-bar.json
347
353
  - spec/integration/can_i_deploy_spec.rb
348
354
  - spec/integration/create_version_tag_spec.rb
349
355
  - spec/lib/pact_broker/client/base_client_spec.rb
@@ -367,7 +373,7 @@ test_files:
367
373
  - spec/lib/pact_broker/client/pact_broker_client_spec.rb
368
374
  - spec/lib/pact_broker/client/pacticipants/create_spec.rb
369
375
  - spec/lib/pact_broker/client/pacticipants_spec.rb
370
- - spec/lib/pact_broker/client/publish_pacts_spec.rb
376
+ - spec/lib/pact_broker/client/publish_pacts_the_old_way_spec.rb
371
377
  - spec/lib/pact_broker/client/retry_spec.rb
372
378
  - spec/lib/pact_broker/client/tasks/publication_task_spec.rb
373
379
  - spec/lib/pact_broker/client/versions/describe_spec.rb
@@ -388,6 +394,7 @@ test_files:
388
394
  - spec/service_providers/pact_broker_client_versions_spec.rb
389
395
  - spec/service_providers/pact_helper.rb
390
396
  - spec/service_providers/pacticipants_create_spec.rb
397
+ - spec/service_providers/publish_pacts_spec.rb
391
398
  - spec/service_providers/record_deployment_spec.rb
392
399
  - spec/service_providers/webhooks_create_spec.rb
393
400
  - spec/spec_helper.rb