pact_broker 1.3.2.rc1 → 1.4.0

data/lib/pact_broker/doc/controllers/app.rb

@@ -1,4 +1,4 @@
-require 'padrino'
+require 'padrino-core'
 require 'redcarpet'
 
 Tilt.prefer Tilt::RedcarpetTemplate

data/lib/pact_broker/doc/views/consumer.markdown

@@ -0,0 +1,7 @@
+# Consumer
+
+Allowed methods: GET, PATCH, DELETE
+
+The application that initiates the HTTP request.
+
+See [Pacticipant](/doc/pacticipants) for more information.

data/lib/pact_broker/doc/views/diff-previous-distinct.markdown

@@ -0,0 +1,5 @@
+# Diff with previous distinct version
+
+Allowed methods: GET
+
+This resource displays the difference between the current pact, and the previous "distinct" version. Given that the pact file does not change every time it is published, the previous distinct version is the most recent version published before the current one where the content is actually different.

data/lib/pact_broker/doc/views/latest-pact-version.markdown

@@ -0,0 +1,7 @@
+# Latest pact version
+
+Allowed methods: GET
+
+The latest pact between this consumer and provider.
+
+The "latest" is determined by inspecting the consumer version used when each pact was published.

data/lib/pact_broker/doc/views/latest-pact-versions.markdown

@@ -0,0 +1,5 @@
+# Latest pact versions
+
+Allowed methods: GET
+
+A list of the latest pact versions for each consumer/provider pair. The "latest" is determined by inspecting the consumer version used when each pact was published.

data/lib/pact_broker/doc/views/pact-versions.markdown

@@ -0,0 +1,3 @@
+# Pact Versions
+
+Not implemented yet.

data/lib/pact_broker/doc/views/pact-webhooks.markdown

@@ -0,0 +1,50 @@
+# Webhooks
+
+Allowed methods: GET, POST, DELETE
+
+### Creating
+
+1. To create a webhook, in the HAL Browser, navigate to the pact you want to create the webhook for
+(Click "Go to Entry Point", then select "latest-pacts", then select the pact you want to create the webhook for.)
+2. Click the "NON-GET" button for the "pact-webhooks" relation.
+3. Paste in the webhook JSON (example shown below) in the body section and click "Make Request".
+
+An example webhook to trigger a Bamboo job.
+
+    {
+      "request": {
+        "method": "POST",
+        "url": "http://master.ci.my.domain:8085/rest/api/latest/queue/SOME-PROJECT?os_authType=basic",
+        "username": "username",
+        "password": "password",
+        "headers": {
+          "Accept": "application/json"
+        }
+      }
+    }
+
+A request body can be specified as well.
+
+    {
+      "request": {
+        "method": "POST",
+        "url": "http://example.org/something",
+        "body": {
+          "some" : "json"
+        }
+      }
+    }
+
+**BEWARE** The password can be reverse engineered from the database, so make a separate account for the Pact Broker to use, don't use your personal account!
+
+### Testing
+
+To test a webhook, navigate to the webhook in the HAL browser, then make a POST request to the "execute" relation. The response or error will be shown in the window.
+
+### Deleting
+
+Send a DELETE request to the webhook URL.
+
+### Updating
+
+Currently not implemented. You will need to delete and re-create the webhook.

data/lib/pact_broker/doc/views/pacticipants.markdown

@@ -1,5 +1,7 @@
 # Pacticipants
 
+Allowed methods: GET, PATCH, DELETE
+
 "Pacticipant" - a party that participates in a pact (ie. a Consumer or a Provider).
 
 ### Creating pacticipants

data/lib/pact_broker/doc/views/provider.markdown

@@ -0,0 +1,7 @@
+# Provider
+
+Allowed methods: GET, PATCH, DELETE
+
+The application that initiates the HTTP request.
+
+See [Pacticipant](/doc/pacticipants) for more information.

data/lib/pact_broker/doc/views/tag-prod-version.markdown

@@ -0,0 +1,7 @@
+# Tag Production Version
+
+Allowed methods: PUT
+
+Add the "prod" tag to this version. This allows you to retrieve the latest version production version using the following URL.
+
+    http://pact-broker/pacts/provider/{provider}/consumer/{consumer}/latest/prod

data/lib/pact_broker/doc/views/tag-version.markdown

@@ -0,0 +1,4 @@
+# Add Tag to Version
+
+Allowed methods: PUT
+

data/lib/pact_broker/doc/views/webhooks.markdown

@@ -1,5 +1,7 @@
 # Webhooks
 
+Allowed methods: GET, POST, DELETE
+
 ### Creating
 
 1. To create a webhook, in the HAL Browser, navigate to the pact you want to create the webhook for

data/lib/pact_broker/domain/pact.rb

@@ -1,4 +1,5 @@
 require 'pact_broker/db'
+require 'pact_broker/json'
 
 module PactBroker
 
@@ -18,7 +19,7 @@ module PactBroker
       end
 
       def to_s
-        "Pact: provider_id=#{provider_id} created_at=#{created_at} updated_at=#{updated_at}"
+        "Pact: consumer=#{consumer.name} provider=#{provider.name}"
       end
 
       def to_json options = {}
@@ -32,6 +33,10 @@ module PactBroker
       def version_and_updated_date
         "Version #{consumer_version_number} - #{updated_at.to_time.localtime.strftime("%d/%m/%Y")}"
       end
+
+      def content_hash
+        JSON.parse(json_content, PACT_PARSING_OPTIONS)
+      end
     end
 
   end

data/lib/pact_broker/domain/tag.rb

@@ -9,7 +9,6 @@ module PactBroker
 
       associate(:many_to_one, :version, :class => "PactBroker::Domain::Version", :key => :version_id, :primary_key => :id)
 
-
     end
 
     Tag.plugin :timestamps, :update_on_create=>true

data/lib/pact_broker/locale/en.yml

@@ -34,4 +34,40 @@ en:
       "503":
         title: 503 Service Unavailable
         message: The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
-
+  # Used in distance_of_time_in_words(), distance_of_time_in_words_to_now(), time_ago_in_words()
+  datetime:
+    distance_in_words:
+      half_a_minute: "half a minute"
+      less_than_x_seconds:
+        one:   "less than 1 second"
+        other: "less than %{count} seconds"
+      x_seconds:
+        one:   "1 second"
+        other: "%{count} seconds"
+      less_than_x_minutes:
+        one:   "less than a minute"
+        other: "less than %{count} minutes"
+      x_minutes:
+        one:   "1 minute"
+        other: "%{count} minutes"
+      about_x_hours:
+        one:   "about 1 hour"
+        other: "about %{count} hours"
+      x_days:
+        one:   "1 day"
+        other: "%{count} days"
+      about_x_months:
+        one:   "about 1 month"
+        other: "about %{count} months"
+      x_months:
+        one:   "1 month"
+        other: "%{count} months"
+      about_x_years:
+        one:   "about 1 year"
+        other: "about %{count} years"
+      over_x_years:
+        one:   "over 1 year"
+        other: "over %{count} years"
+      almost_x_years:
+        one:   "almost 1 year"
+        other: "almost %{count} years"

data/lib/pact_broker/pacts/all_pacts.rb

@@ -46,9 +46,17 @@ module PactBroker
           where('consumer_version_order < ?', order)
         end
 
+        def consumer_version_order_after order
+          where('consumer_version_order > ?', order)
+        end
+
         def latest
           reverse_order(:consumer_version_order).limit(1)
         end
+
+        def earliest
+          order(:consumer_version_order).limit(1)
+        end
       end
 
       def to_domain

data/lib/pact_broker/pacts/create_formatted_diff.rb

@@ -0,0 +1,20 @@
+require 'pact/matchers'
+require 'pact_broker/json'
+require 'pact/matchers/unix_diff_formatter'
+
+module PactBroker
+  module Pacts
+    class CreateFormattedDiff
+
+      extend Pact::Matchers
+
+      def self.call pact_json_content, previous_pact_json_content
+        pact_hash = JSON.load(pact_json_content, nil, PactBroker::PACT_PARSING_OPTIONS)
+        previous_pact_hash = JSON.load(previous_pact_json_content, nil, PactBroker::PACT_PARSING_OPTIONS)
+        difference = diff(previous_pact_hash, pact_hash)
+        Pact::Matchers::UnixDiffFormatter.call(difference, colour: false, include_explanation: false)
+      end
+
+    end
+  end
+end

data/lib/pact_broker/pacts/diff.rb

@@ -0,0 +1,105 @@
+require 'trailblazer/operation'
+require 'pact_broker/repositories'
+require 'pact_broker/pacts/create_formatted_diff'
+require 'pact_broker/api/pact_broker_urls'
+require 'yaml'
+require 'pact_broker/date_helper'
+
+
+module PactBroker
+  module Pacts
+
+    class Diff < Trailblazer::Operation
+
+      include PactBroker::Repositories
+      attr_reader :params, :options
+
+      def process params, options
+        pact = pact_repository.find_pact(params.consumer_name, params.consumer_version_number, params.provider_name)
+        previous_distinct_pact = pact_repository.find_previous_distinct_pact pact
+        if previous_distinct_pact
+          next_pact = pact_repository.find_next_pact previous_distinct_pact
+          DiffDecorator.new(pact, previous_distinct_pact, next_pact, options[:base_url]).to_text
+        else
+          no_previous_version_message pact
+        end
+      end
+
+      def no_previous_version_message pact
+        "No previous distinct version was found for #{pact.name}"
+      end
+
+      private
+
+      # The next pact version after the previous distinct version.
+      # Eg. v1 (previous distinct) -> pactContentA
+      #     v2 (next pact)         -> pactContentB
+      #     v3                     -> pactContentB
+      #     v4 (current)           -> pactContentB
+      # If we are at v4, then the previous distinct pact version is
+      # v1, and the next pact after that is v2.
+      # The timestamps on v2 are the ones we want - that's when
+      # the latest distinct version content was first created.
+
+      class DiffDecorator
+
+        attr_reader :pact, :previous_distinct_pact, :next_pact, :base_url
+
+        def initialize pact, previous_distinct_pact, next_pact, base_url
+          @pact = pact
+          @previous_distinct_pact = previous_distinct_pact
+          @next_pact = next_pact
+          @base_url = base_url
+        end
+
+        def to_text
+          header + "\n\n" + diff + "\n\n" + links
+        end
+
+        private
+
+        def change_date_in_words
+          DateHelper.local_date_in_words next_pact.updated_at
+        end
+
+        def now
+          Time.now
+        end
+
+        def header
+          title = "# Diff between versions #{previous_distinct_pact.consumer_version_number} and #{pact.consumer_version_number} of the pact between #{pact.consumer.name} and #{pact.provider.name}"
+          description = "The following changes were made #{change_date_ago_in_words} ago (#{change_date_in_words})"
+          title +  "\n\n" + description
+        end
+
+        def links
+          self_url = PactBroker::Api::PactBrokerUrls.pact_url base_url, pact
+          previous_distinct_url = PactBroker::Api::PactBrokerUrls.pact_url base_url, previous_distinct_pact
+
+          links = {
+            "current-pact-version" => {
+              "title" => "Pact",
+              "name" => pact.name,
+              "href" => self_url
+            },
+            "previous-distinct-pact-version" => {
+              "title" => "Pact",
+              "name" => previous_distinct_pact.name,
+              "href" => previous_distinct_url
+            }
+          }
+          "## Links\n" + YAML.dump(links).gsub(/---/,'')
+        end
+
+        def diff
+          CreateFormattedDiff.(pact.json_content, previous_distinct_pact.json_content)
+        end
+
+        def change_date_ago_in_words
+          DateHelper.distance_of_time_in_words next_pact.updated_at, now
+        end
+      end
+
+    end
+  end
+end

data/lib/pact_broker/pacts/repository.rb

@@ -5,6 +5,7 @@ require 'pact_broker/logging'
 require 'pact_broker/pacts/database_model'
 require 'pact_broker/pacts/all_pacts'
 require 'pact_broker/pacts/latest_pacts'
+require 'pact/shared/json_differ'
 
 module PactBroker
   module Pacts
@@ -49,7 +50,7 @@ module PactBroker
         AllPacts
           .eager(:tags)
           .where(consumer_version_id: version_id, provider_id: provider_id)
-          .limit(1).collect(&:to_domain)[0]
+          .limit(1).collect(&:to_domain_with_content)[0]
       end
 
       def find_latest_pacts
@@ -79,11 +80,51 @@ module PactBroker
           .consumer(pact.consumer.name)
           .provider(pact.provider.name)
           .consumer_version_order_before(pact.consumer_version.order)
-          .latest.collect(&:to_domain)[0]
+          .latest.collect(&:to_domain_with_content)[0]
+      end
+
+      def find_next_pact pact
+        AllPacts
+          .eager(:tags)
+          .consumer(pact.consumer.name)
+          .provider(pact.provider.name)
+          .consumer_version_order_after(pact.consumer_version.order)
+          .earliest.collect(&:to_domain_with_content)[0]
+      end
+
+      def find_previous_distinct_pact pact
+        previous, current = nil, pact
+        loop do
+          previous = find_previous_distinct_pact_by_sha current
+          return previous if previous.nil? || different?(current, previous)
+          current = previous
+        end
       end
 
       private
 
+      def find_previous_distinct_pact_by_sha pact
+        current_pact_content_sha =
+          AllPacts.select(:pact_version_content_sha)
+          .consumer(pact.consumer.name)
+          .provider(pact.provider.name)
+          .consumer_version_number(pact.consumer_version_number)
+          .limit(1)
+
+        AllPacts
+          .eager(:tags)
+          .consumer(pact.consumer.name)
+          .provider(pact.provider.name)
+          .consumer_version_order_before(pact.consumer_version.order)
+          .where('pact_version_content_sha != ?', current_pact_content_sha)
+          .latest
+          .collect(&:to_domain_with_content)[0]
+      end
+
+      def different? pact, other_pact
+        Pact::JsonDiffer.(pact.content_hash, other_pact.content_hash, allow_unexpected_keys: false).any?
+      end
+
       def find_or_create_pact_version_content json_content
         sha = Digest::SHA1.hexdigest(json_content)
         PactVersionContent.find(sha: sha) || create_pact_version_content(sha, json_content)
@@ -96,11 +137,6 @@ module PactBroker
         pact_version_content.save
       end
 
-      def to_domain
-        database_model = yield
-        database_model ? database_model.to_domain : nil
-      end
-
     end
   end
 end

data/lib/pact_broker/repositories/version_repository.rb

@@ -11,6 +11,7 @@ module PactBroker
 
       def find_by_pacticipant_name_and_number pacticipant_name, number
         PactBroker::Domain::Version
+          .select(:versions__id, :versions__number, :versions__pacticipant_id, :versions__order, :versions__created_at, :versions__updated_at)
           .where(number: number)
           .join(:pacticipants, {id: :pacticipant_id})
           .where(name: pacticipant_name)