pact_broker 2.52.1 → 2.56.0

data/spec/lib/pact_broker/pacts/content_spec.rb

@@ -227,6 +227,131 @@ module PactBroker
           its(:pact_specification_version) { is_expected.to eq nil }
         end
       end
+
+      describe "with_test_results" do
+        let(:test_results) do
+          {
+            "tests" => [
+              {
+                "interactionProviderState" => "ps1",
+                "interactionDescription" => "desc1"
+              },{
+                "interactionProviderState" => "ps1",
+                "interactionDescription" => "desc1"
+              }
+            ]
+          }
+        end
+
+        let(:pact_content) do
+          {
+            "interactions" => [
+              {
+               "providerState" => "ps1",
+               "description" => "desc1",
+              },
+              {
+               "providerState" => "ps2",
+               "description" => "desc2",
+              }
+            ]
+          }
+        end
+
+        subject { Content.from_hash(pact_content).with_test_results(test_results) }
+
+        let(:merged) do
+          {
+            "interactions" => [
+              {
+               "providerState" => "ps1",
+               "description" => "desc1",
+               "tests" => [
+                {
+                  "interactionProviderState" => "ps1",
+                  "interactionDescription" => "desc1",
+                },{
+                  "interactionProviderState" => "ps1",
+                  "interactionDescription" => "desc1",
+                }
+               ]
+              },{
+               "providerState" => "ps2",
+               "description" => "desc2",
+               "tests" => []
+              }
+            ]
+          }
+        end
+
+        let(:merged_with_empty_tests) do
+          {
+            "interactions" => [
+              {
+               "providerState" => "ps1",
+               "description" => "desc1",
+               "tests" => []
+              },{
+               "providerState" => "ps2",
+               "description" => "desc2",
+               "tests" => []
+              }
+            ]
+          }
+        end
+
+        it "merges the contents with the results" do
+          expect(subject.to_hash).to eq merged
+        end
+
+        it "returns interactions without test results" do
+          expect(subject.interactions_missing_test_results.count).to eq 1
+        end
+
+        context "with nil test results" do
+          let(:test_results) { nil }
+
+          it "does not blow up" do
+            expect(subject.to_hash).to eq merged_with_empty_tests
+          end
+
+          it "returns interactions without test results" do
+            expect(subject.interactions_missing_test_results.count).to eq 2
+          end
+        end
+
+        context "with nil tests" do
+          let(:test_results) { {} }
+
+          it "does not blow up" do
+            expect(subject.to_hash).to eq merged_with_empty_tests
+          end
+        end
+
+        context "with empty tests" do
+          let(:test_results) { { "tests" => [] } }
+
+          it "does not blow up" do
+            expect(subject.to_hash).to eq merged_with_empty_tests
+          end
+        end
+
+        context "with tests not an array" do
+          let(:test_results) { { "tests" => {} } }
+
+          it "does not blow up" do
+            expect(subject.to_hash).to eq merged_with_empty_tests
+          end
+        end
+
+        context "with tests an array of not hashes" do
+          let(:test_results) { { "tests" => [1] } }
+
+          it "does not blow up" do
+            expect(subject.to_hash).to eq merged_with_empty_tests
+          end
+        end
+      end
     end
   end
 end

data/spec/lib/pact_broker/pacts/repository_find_for_verification_spec.rb

@@ -6,7 +6,6 @@ module PactBroker
       let(:td) { TestDataBuilder.new }
 
       describe "#find_for_verification" do
-
         def find_by_consumer_version_number(consumer_version_number)
           subject.find{ |pact| pact.consumer_version_number == consumer_version_number }
         end
@@ -189,6 +188,24 @@ module PactBroker
             expect(find_by_consumer_version_number("foo-latest-dev-version").overall_latest?).to be true
           end
         end
+
+        context "when two consumers have exactly the same json content" do
+          before do
+            td.create_consumer
+              .create_provider("Bar")
+              .create_consumer_version
+              .create_pact(json_content: { interactions: ['foo'] }.to_json )
+              .create_consumer
+              .create_consumer_version
+              .create_pact(json_content: { interactions: ['foo'] }.to_json )
+          end
+
+          let(:consumer_version_selectors) { Selectors.new }
+
+          it "returns a pact for each consumer" do
+            expect(subject.size).to eq 2
+          end
+        end
       end
     end
   end

data/spec/lib/pact_broker/verifications/repository_spec.rb

@@ -295,6 +295,26 @@ module PactBroker
             expect(subject.number).to eq 2
           end
         end
+
+        context "when the consumer does not exist" do
+          subject { Repository.new.find_latest_verification_for_tags("Foo", "Bar", "feat-x", "feat-y") }
+
+          it "raises an error" do
+            expect{ subject }.to raise_error PactBroker::Error, /Foo/
+          end
+        end
+
+        context "when the provider does not exist" do
+          before do
+            td.create_consumer("Foo")
+          end
+
+          subject { Repository.new.find_latest_verification_for_tags("Foo", "Bar", "feat-x", "feat-y") }
+
+          it "raises an error" do
+            expect{ subject }.to raise_error PactBroker::Error, /Bar/
+          end
+        end
       end
 
       describe "delete_by_provider_version_id" do

data/spec/lib/pact_broker/webhooks/webhook_request_logger_spec.rb

@@ -50,7 +50,8 @@ module PactBroker
         }
       end
 
-      let(:webhook_context) { { consumer_version_number: "123" } }
+      let(:base_url) { "http://example.org" }
+      let(:webhook_context) { { consumer_version_number: "123", base_url: base_url } }
 
       let(:webhook_request_logger) { WebhookRequestLogger.new(options) }
 
@@ -117,6 +118,7 @@ module PactBroker
           end
 
           it "logs a message about why the response is hidden" do
+            expect(logs).to include base_url
             expect(logs).to include "security purposes"
           end
         end
@@ -192,6 +194,7 @@ module PactBroker
             end
 
             it "logs a message about why the response is hidden" do
+              expect(logs).to include base_url
               expect(logs).to include "security purposes"
             end
           end

data/spec/migrations/rollback_spec.rb

@@ -0,0 +1,6 @@
+describe "migrate and rollback", migration: true do
+  it "doesn't blow up" do
+    PactBroker::Database.migrate
+    PactBroker::Database.migrate(20190509) # previous migration uses an irreversible migration
+  end
+end

data/spec/service_consumers/provider_states_for_pact_broker_client.rb

@@ -244,4 +244,15 @@ Pact.provider_states_for "Pact Broker Client" do
           .create_webhook(uuid: "696c5f93-1b7f-44bc-8d03-59440fcaa9a0")
     end
   end
+
+  provider_state "the pacticipant relations are present" do
+    no_op
+  end
+
+  provider_state "a pacticipant with name Foo exists" do
+    set_up do
+      TestDataBuilder.new
+        .create_consumer("Foo")
+    end
+  end
 end

data/vendor/hal-browser/README.adoc

@@ -0,0 +1,169 @@
+= HAL-browser
+
+An API browser for the hal+json media type
+
+== Example Usage
+
+Here is an example of a hal+json API using the browser:
+
+http://haltalk.herokuapp.com/explorer/browser.html[http://haltalk.herokuapp.com/explorer/browser.html]
+
+== About HAL
+
+HAL is a format based on json that establishes conventions for
+representing links. For example:
+
+[source,javascript]
+----
+{
+    "_links": {
+        "self": { "href": "/orders" },
+        "next": { "href": "/orders?page=2" }
+    }
+}
+----
+
+More detail about HAL can be found at
+http://stateless.co/hal_specification.html[http://stateless.co/hal_specification.html].
+
+== Customizing the POST form
+
+By default, the HAL Browser can't assume there is any metadata. When you click on the non-GET request button (to create a new resource), the user must enter the JSON document to submit. If your service includes metadata you can access, it's possible to plugin a custom view that makes use of it.
+
+. Define your custom view.
++
+Here is an example that leverages Spring Data REST's JSON Schema metadata found at */{entity}/schema*.
++
+[source,javascript]
+----
+var CustomPostForm = Backbone.View.extend({
+	initialize: function (opts) {
+		this.href = opts.href.split('{')[0];
+		this.vent = opts.vent;
+		_.bindAll(this, 'createNewResource');
+	},
+
+	events: {
+		'submit form': 'createNewResource'
+	},
+
+	className: 'modal fade',
+
+	createNewResource: function (e) {
+		e.preventDefault();
+
+		var self = this;
+
+		var data = {}
+		Object.keys(this.schema.properties).forEach(function(property) {
+			if (!("format" in self.schema.properties[property])) {
+				data[property] = self.$('input[name=' + property + ']').val();
+			}
+		});
+
+		var opts = {
+			url: this.$('.url').val(),
+			headers: HAL.parseHeaders(this.$('.headers').val()),
+			method: this.$('.method').val(),
+			data: JSON.stringify(data)
+		};
+
+		var request = HAL.client.request(opts);
+		request.done(function (response) {
+			self.vent.trigger('response', {resource: response, jqxhr: jqxhr});
+		}).fail(function (response) {
+			self.vent.trigger('fail-response', {jqxhr: jqxhr});
+		}).always(function () {
+			self.vent.trigger('response-headers', {jqxhr: jqxhr});
+			window.location.hash = 'NON-GET:' + opts.url;
+		});
+
+		this.$el.modal('hide');
+	},
+
+	render: function (opts) {
+		var headers = HAL.client.getHeaders();
+		var headersString = '';
+
+		_.each(headers, function (value, name) {
+			headersString += name + ': ' + value + '\n';
+		});
+
+		var request = HAL.client.request({
+			url: this.href + '/schema',
+			method: 'GET'
+		});
+
+		var self = this;
+		request.done(function (schema) {
+			self.schema = schema;
+			self.$el.html(self.template({
+			    href: self.href,
+			    schema: self.schema,
+			    user_defined_headers: headersString}));
+			self.$el.modal();
+		});
+
+		return this;
+	},
+	template: _.template($('#dynamic-request-template').html())
+});
+----
++
+. Register it by assigning to `HAL.customPostForm`
++
+[source,javascript]
+----
+HAL.customPostForm = CustomPostForm;
+----
++
+. Load your custom JavaScript component and define your custom HTML template.
++
+[source,html,indent=0]
+----
+<script id="dynamic-request-template" type="text/template">
+<div class="modal-header">
+  <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
+  <h3>Make a non-GET request</h3>
+</div>
+
+<form class="non-safe" action="<%= href %>">
+  <div class="modal-body">
+    <p>Target URI</p>
+    <input name="url" type="text" class="url" value="<%= href %>" />
+    <p>Method:</p>
+    <input name="method" type="text" class="method" value="POST" />
+    <p>Headers:</p>
+    <textarea name="headers" class="headers" style="height: 100px">
+    Content-Type: application/json
+    <%= user_defined_headers %>
+    </textarea>
+  </div>
+  <% _.each(schema.properties, function(value, name) { %>
+    <% if (!("format" in value)) { %>
+      <input type="text" placeholder="<%= name %>" name="<%= name %>" />
+    <% } %>
+  <% }); %>
+  <div class="modal-footer">
+    <button type="submit" class="btn btn-primary">Make Request</button>
+  </div>
+</form>
+</script>
+----
+
+NOTE: To load a custom JavaScript module AND a custom HTML template, you will probably need to create a customized version of `browser.html`.
+
+NOTE: The HAL Browser uses a global `HAL` object, so there is no need to deal with JavaScript packages.
+
+== Usage Instructions
+
+All you should need to do is copy the files into your webroot.
+It is OK to put it in a subdirectory; it does not need to be in the root.
+
+All the JS and CSS dependencies come included in the vendor directory.
+
+== TODO
+
+* Provide feedback to user when there are issues with response (missing
+self link, wrong media type identifier)
+* Give 'self' and 'curies' links special treatment

data/vendor/hal-browser/browser.html

@@ -26,7 +26,7 @@
             <ul class="nav">
               <li><a href="#/" id="entryPointLink">Go To Entry Point</a></li>
               <li><a href="https://github.com/mikekelly/hal-browser">About The HAL Browser</a></li>
-              <li><a href="/">Pact Broker Home</a></li>
+              <li><a href="/" id="pactBrokerHomeLink">Pact Broker Home</a></li> <!-- pact_broker -->
             </ul>
           </div>
         </div>
@@ -38,7 +38,7 @@
   <script id="location-bar-template" type="text/template">
 <form>
     <div class="input-append span12 location-bar-container">
-      <input class="span11" id="appendedInputButton" type="text" value="<%= url %>">
+      <input class="span11" id="appendedInputButton" type="text" value="<%= _.escape(url) %>">
       <button class="btn" type="submit">Go!</button>
        <span class="ajax-loader"></span>
     </div>
@@ -63,46 +63,47 @@
         <% if ($.isArray(obj)) { %>
           <% _.each(obj, function(link, i) { %>
             <tr>
-              <% tdStyle = i > 0 ? "border-top:none" : "" %>
-              <td style="<%= tdStyle %>"><strong><%= i === 0 ? HAL.truncateIfUrl(rel) : '' %></strong></td>
-              <td><%= link.title || '' %></td>
-              <td><%= link.name ? 'name: ' + link.name : 'index: ' + i %></a></td>
+              <!-- pact_broker escaping -->
+              <td><strong><%= HAL.truncateIfUrl(rel) %></strong></td>
+              <td><%- link.title || '' %></td>
+              <td><%- link.name ? 'name: ' + link.name : 'index: ' + i %></a></td>
               <td>
               <% if (HAL.isUrl(rel)) { %>
-                <a class="dox" href="<%= HAL.buildUrl(rel) %>"><i class="icon-book"></i></a>
+                <a class="dox" href="<%= HAL.normalizeUrl(HAL.buildUrl(rel)) %>"><i class="icon-book"></i></a>
               <% } %>
               </td>
               <td>
                 <% if (link.templated === true) { %>
-                  <a class="query btn btn-success" href="<%= link.href %>" title="Query URI template"><i class="icon-question-sign"></i></a>
+                  <a class="query btn btn-success" href="<%= HAL.normalizeUrl(link.href) %>" title="Query URI template"><i class="icon-question-sign"></i></a>
                 <% } else { %>
-                  <a class="follow btn btn-success" href="<%= link.href %>" title="Follow link"><i class="icon-arrow-right"></i></a>
+                  <a class="follow btn btn-success" href="<%= HAL.normalizeUrl(link.href) %>" title="Follow link"><i class="icon-arrow-right"></i></a>
                 <% } %>
               </td>
               <td>
-                <a class="non-get btn btn-warning" href="<%= link.href %>" title="Perform non-GET request">!</a>
+                <a class="non-get btn btn-warning" href="<%= HAL.normalizeUrl(link.href) %>" title="Perform non-GET request">!</a>
               </td>
             </tr>
           <% }); %>
         <% } else { %>
           <tr>
             <td><strong><%= HAL.truncateIfUrl(rel) %></strong></td>
-            <td><%= obj.title || '' %></td>
-            <td><%= obj.name || '' %></td>
+            <!-- pact_broker escaping -->
+            <td><%- obj.title || '' %></td>
+            <td><%- obj.name || '' %></td>
             <td>
             <% if (HAL.isUrl(rel)) { %>
-              <a class="dox" href="<%= HAL.buildUrl(rel) %>"><i class="icon-book"></i></a>
+              <a class="dox" href="<%= HAL.normalizeUrl(HAL.buildUrl(rel)) %>"><i class="icon-book"></i></a>
             <% } %>
             </td>
             <td>
               <% if (obj.templated === true) { %>
-                <a class="query btn btn-success" href="<%= obj.href %>" title="Query URI template"><i class="icon-question-sign"></i></a>
+                <a class="query btn btn-success" href="<%= HAL.normalizeUrl(obj.href) %>" title="Query URI template"><i class="icon-question-sign"></i></a>
               <% } else { %>
-                <a class="follow btn btn-success" href="<%= obj.href %>" title="Follow link"><i class="icon-arrow-right"></i></a>
+                <a class="follow btn btn-success" href="<%= HAL.normalizeUrl(obj.href) %>" title="Follow link"><i class="icon-arrow-right"></i></a>
               <% } %>
             </td>
             <td>
-              <a class="non-get btn btn-warning" href="<%= obj.href %>" title="Perform non-GET request">!</a>
+              <a class="non-get btn btn-warning" href="<%= HAL.normalizeUrl(obj.href) %>" title="Perform non-GET request">!</a>
             </td>
           </tr>
         <% } %>
@@ -113,7 +114,7 @@
 
   <script id="properties-template" type="text/template">
     <h2>Properties</h2>
-    <pre><%= _.escape(JSON.stringify(properties, null, HAL.jsonIndent)) %></pre>
+    <pre><%= properties %></pre>
   </script>
 
   <script id="request-headers-template" type="text/template">
@@ -125,7 +126,16 @@
     <h2>Response Headers</h2>
     <pre><%= status.code %> <%= status.text %>
 
-<%= _.escape(headers) %></pre>
+<% _.each(headers, function(value, name) {
+      %><%= _.escape(name) %>: <%
+           if(HAL.isFollowableHeader(name)) {
+           %><a href="<%= HAL.normalizeUrl(value) %>" class="follow"><%
+           }
+      %><%= _.escape(value)
+      %><% if(HAL.isFollowableHeader(name)) {
+           %></a><%
+           } %>
+<% }) %></pre>
   </script>
 
   <script id="response-body-template" type="text/template">
@@ -142,7 +152,7 @@
     <form id="query" action="<%= href %>">
       <div class="modal-body">
         <p>URI Template:</p>
-        <pre><%= href %></pre>
+        <pre><%- href %></pre>
         <p>Input (JSON):</p>
         <textarea><%= input %></textarea>
         <p>Expanded URI:</p>
@@ -193,9 +203,10 @@ Content-Type: application/json
 
   <script id="embedded-resource-template" type="text/template">
     <div class="accordion-heading">
+      <!-- pact_broker -->
       <a class="accordion-toggle" href="#"><%= resource.identifier %><% if (resource.name || resource.title) { %>: <span class="embedded-resource-title"><%- resource.name || resource.title %></span><% } %>
       <% if (HAL.isUrl(resource.embed_rel)) { %>
-        <span class="dox pull-right" data-href="<%= HAL.buildUrl(resource.embed_rel) %>">
+        <span class="dox pull-right" data-href="<%= HAL.normalizeUrl(HAL.buildUrl(resource.embed_rel)) %>">
           <i class="icon-book"></i>
         </span>
       <% } %>
@@ -203,11 +214,11 @@ Content-Type: application/json
     </div>
   </script>
 
-
   <script src="vendor/js/jquery-1.10.2.min.js"></script>
   <script src="vendor/js/underscore.js"></script>
   <script src="vendor/js/backbone.js"></script>
   <script src="vendor/js/uritemplates.js"></script>
+  <script src="vendor/js/URI.min.js"></script>
   <script src="vendor/js/bootstrap.js"></script>
 
   <script src="js/hal.js"></script>
@@ -240,10 +251,13 @@ Content-Type: application/json
   <script src="js/hal/views/documentation.js"></script>
 
   <script>
+    var baseUrl = window.location.href.split('/hal-browser/')[0]; //pact_broker
     var browser = new HAL.Browser({
       container: $('#browser'),
-      entryPoint: '/'
+      entryPoint: baseUrl //pact_broker
     });
     Backbone.history.start();
+
+    $('#pactBrokerHomeLink').attr('href', baseUrl); //pact_broker
   </script>
 </body>