pact_broker 2.8.0.beta.4 → 2.8.0.beta.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da8917d330d81bf413bf0538e48931988f66d3d2
-  data.tar.gz: 3deb4db35fc00e414aa3b093c1cd637a97104a6d
+  metadata.gz: cebfc643458ec866835a2820e3dcbc3f214266ae
+  data.tar.gz: 85ab89a5a77b328efe497d9846110a5291de65c1
 SHA512:
-  metadata.gz: ee960619a012edafc2c74a1bfc3a4567ba950546cf292cd67e723964925681c312524586adae4bdcd9ed1c334b2a2c25203f5efbbcccaec902a9f5fca1782f0c
-  data.tar.gz: 929ce32af34f0e4eb44c6bffc034887aee3d2a58fa5cef634c8b5486fef9935411b01ef07653e41057a528306399260e9eb665ad5dc8b495caed19f491e06d48
+  metadata.gz: 76afaaa40c825514aeeae6e334274caf8d52b850b41126ae68163214810bd0d5bf9244b9e737135f0baf82339f43a48d07d5ce0df2c6372d3705a86dfaa2d71d
+  data.tar.gz: 4f35850adae4e26e3ed41c83e71c0509b05f5ba7af7dacb30ca37bb059abe6c62c2eba346fc0b790ec6ca6f6a0f3e7c19b1e47818b3d93939e796ae1cea2010a

data/CHANGELOG.md

@@ -1,5 +1,21 @@
-<a name="v2.7.0.beta.4"></a>
-### v2.7.0.beta.4 (2017-11-03)
+<a name="v2.8.0.beta.5"></a>
+### v2.8.0.beta.5 (2017-11-06)
+
+#### Features
+
+* **matrix**
+  * fix matrix data types for MySQL	 ([42c5478](/../../commit/42c5478))
+  * improve reason when no results are found	 ([473abbe](/../../commit/473abbe))
+  * change groupby param to latestby	 ([a6a8ba2](/../../commit/a6a8ba2))
+  * ensure correct row is returned when a pact is revised, then verified	 ([7f37644](/../../commit/7f37644))
+  * return most recent rows first	 ([cfa2109](/../../commit/cfa2109))
+  * allow a limit to be specified	 ([2a11334](/../../commit/2a11334))
+  * return most recent rows first	 ([e896b7b](/../../commit/e896b7b))
+  * use views to create matrix query	 ([8488212](/../../commit/8488212))
+  * add matrix view	 ([852324a](/../../commit/852324a))
+
+<a name="v2.8.0.beta.4"></a>
+### v2.8.0.beta.4 (2017-11-03)
 
 #### Bug Fixes
 

data/DEVELOPER_DOCUMENTATION.md

@@ -55,3 +55,7 @@ Domain classes are found in `lib/pact_broker/domain`. Many of these classes are
 * `latest_tagged_pact_publications` - This view has the same columns as `all_pact_publications`, plus a `tag_name` column. It is used to return the pact for the latest tagged version of a consumer.
 
 * `latest_verifications` - The most recent verification for each pact version.
+
+* `matrix` - The matrix of every pact publication and verification. Includes every pact revision (eg. publishing to the same consumer version twice, or using PATCH) and every verification (including 'overwritten' ones. eg. when the same provider build runs twice.)
+
+* `latest_matrix` - This view is a subset of, and has the same columns as, the `matrix`. It removes 'overwritten' pacts and verifications from the matrix (ie. only show latest pact revision for each consumer version and latest verification for each provider version)

data/README.md

@@ -34,7 +34,8 @@ Features:
 #### Step 1. Consumer CI build
 1. The consumer project runs its tests using the [Pact][pact] library to provide a mock service.
 2. While the tests run, the mock service writes the requests and the expected responses to a JSON "pact" file - this is the consumer contract.
-3. The generated pact is then published to the Pact Broker. This is simply a `PUT` to a resource that specifies the consumer name and version, and the provider name. eg `http://my-pact-broker/pacts/provider/Animal%20Service/consumer/Zoo%20App/version/1.0.0`
+3. The generated pact is then published to the Pact Broker. Most Pact libries will make a task available for you to do this easily, however, at its simplest, it is a `PUT` to a resource that specifies the consumer name and application version, and the provider name. eg `http://my-pact-broker/pacts/provider/Animal%20Service/consumer/Zoo%20App/version/1.0.0` 
+(Note that you are specifying the _consumer application version_ in the URL, not the pact version. The broker will take care of versioning the pact behind the scenes when its content changes. It is expected that the consumer application version will increment with every CI build.)
 4. When a pact is published, a webhook in the Pact Broker kicks off a build of the provider project if the pact content has changed since the previous version.
 
 #### Step 2. Provider CI build

data/db/migrations/000048_create_matrix.rb

@@ -0,0 +1,39 @@
+Sequel.migration do
+  up do
+    # Includes every pact revision (eg. publishing to the same consumer version twice,
+    # or using PATCH) and every verification
+    # (including 'overwritten' ones. eg. when the same provider build runs twice.)
+    p = :all_pact_publications
+    create_view(:matrix,
+      from(p)
+        .select(
+          Sequel[p][:consumer_id],
+          Sequel[p][:consumer_name],
+          Sequel[p][:consumer_version_id],
+          Sequel[p][:consumer_version_number],
+          Sequel[p][:consumer_version_order],
+          Sequel[p][:id].as(:pact_publication_id),
+          Sequel[p][:pact_version_id],
+          Sequel[p][:pact_version_sha],
+          Sequel[p][:revision_number].as(:pact_revision_number),
+          Sequel[p][:created_at].as(:pact_created_at),
+          Sequel[p][:provider_id],
+          Sequel[p][:provider_name],
+          Sequel[:versions][:id].as(:provider_version_id),
+          Sequel[:versions][:number].as(:provider_version_number),
+          Sequel[:versions][:order].as(:provider_version_order),
+          Sequel[:verifications][:id].as(:verification_id),
+          Sequel[:verifications][:success],
+          Sequel[:verifications][:number].as(:verification_number),
+          Sequel[:verifications][:execution_date].as(:verification_executed_at),
+          Sequel[:verifications][:build_url].as(:verification_build_url)
+        )
+        .left_outer_join(:verifications, { Sequel[:verifications][:pact_version_id] => Sequel[p][:pact_version_id] })
+        .left_outer_join(:versions, {Sequel[:versions][:id] => Sequel[:verifications][:provider_version_id]})
+    )
+  end
+
+  down do
+    drop_view(:matrix)
+  end
+end

data/db/migrations/000049_create_latest_verifications_for_cv_and_pv.rb

@@ -0,0 +1,17 @@
+Sequel.migration do
+  change do
+    # joining with latest_pact_publication_revision_numbers gets rid of the overwritten
+    # pact revisions, and the max(verification_id) gets rid of the overwritten
+    # verifications
+    create_view(:latest_verification_id_for_consumer_version_and_provider_version,
+      "select consumer_version_id, provider_version_id, max(verification_id) as latest_verification_id
+      from matrix
+      inner join latest_pact_publication_revision_numbers lr
+        on matrix.consumer_id = lr.consumer_id
+        and matrix.provider_id = lr.provider_id
+        and matrix.consumer_version_order = lr.consumer_version_order
+        and matrix.pact_revision_number = lr.latest_revision_number
+        group by consumer_version_id, provider_version_id"
+    )
+  end
+end

data/db/migrations/000050_create_latest_matrix.rb

@@ -0,0 +1,27 @@
+Sequel.migration do
+  change do
+    # Removes 'overwritten' pacts and verifications from the matrix
+    # (ie. only show latest pact revision for each consumer version and
+    # latest verification for each provider version)
+    # Must include lines where verification_id is null so that we don't
+    # lose the unverified pacts.
+    create_view(:latest_matrix,
+      "SELECT matrix.* FROM matrix
+      INNER JOIN latest_verification_id_for_consumer_version_and_provider_version AS lv
+      ON ((matrix.consumer_version_id = lv.consumer_version_id)
+      AND (matrix.provider_version_id = lv.provider_version_id)
+      AND ((matrix.verification_id = lv.latest_verification_id)))
+
+      UNION
+
+      select matrix.* from matrix
+      inner join latest_pact_publication_revision_numbers lr
+      on matrix.consumer_id = lr.consumer_id
+      and matrix.provider_id = lr.provider_id
+      and matrix.consumer_version_order = lr.consumer_version_order
+      and matrix.pact_revision_number = lr.latest_revision_number
+      where verification_id is null
+      "
+    )
+  end
+end

data/lib/pact_broker/api/decorators/matrix_decorator.rb

@@ -25,16 +25,14 @@ module PactBroker
           }
         end
 
-        private
-
-        attr_reader :lines
-
         def deployable
+          return nil if lines.empty?
           return nil if lines.any?{ |line| line[:success].nil? }
           lines.any? && lines.all?{ |line| line[:success] }
         end
 
         def reason
+          return "No results matched the given query" if lines.empty?
           case deployable
           when true then "All verification results are published and successful"
           when false then "One or more verifications have failed"
@@ -43,6 +41,10 @@ module PactBroker
           end
         end
 
+        private
+
+        attr_reader :lines
+
         def matrix(lines, base_url)
           provider = nil
           consumer = nil
@@ -118,7 +120,7 @@ module PactBroker
               verifiedAt: line[:verification_executed_at].to_datetime.xmlschema,
               _links: {
                 self: {
-                  href: verification_url(OpenStruct.new(line), base_url)
+                  href: verification_url(OpenStruct.new(line.merge(number: line[:verification_number])), base_url)
                 }
               }
             }

data/lib/pact_broker/api/decorators/matrix_text_decorator.rb

@@ -1,23 +1,26 @@
 require 'ostruct'
 require 'pact_broker/api/pact_broker_urls'
+require 'pact_broker/api/decorators/matrix_decorator'
+
 require 'table_print'
 
 module PactBroker
   module Api
     module Decorators
       class MatrixTextDecorator
-        Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success)
+        Line = Struct.new(:consumer, :c_version, :revision, :provider, :p_version, :number, :success)
 
         def initialize(lines)
           @lines = lines
         end
 
         def to_text(options)
+          json_decorator = PactBroker::Api::Decorators::MatrixDecorator.new(lines)
           data = lines.collect do | line |
-            Line.new(line[:consumer_name], line[:consumer_version_number], line[:provider_name], line[:provider_version_number], line[:success])
+            Line.new(line[:consumer_name], line[:consumer_version_number], line[:pact_revision_number], line[:provider_name], line[:provider_version_number], line[:verification_number], line[:success])
           end
           printer = TablePrint::Printer.new(data)
-          printer.table_print + "\n"
+          printer.table_print + "\n\nDeployable: #{json_decorator.deployable.inspect}\nReason: #{json_decorator.reason}\n"
         end
 
         private

data/lib/pact_broker/matrix/latest_row.rb

@@ -0,0 +1,24 @@
+require 'pact_broker/matrix/row'
+
+module PactBroker
+  module Matrix
+    # Latest pact revision for each consumer version => latest verification
+    class LatestRow < Row
+      set_dataset(:latest_matrix)
+
+      # For some reason, with MySQL, the success column value
+      # comes back as an integer rather than a boolean
+      # for the latest_matrix view (but not the matrix view!)
+      # Maybe something to do with the union?
+      # Haven't investigated as this is an easy enough fix.
+      def success
+        value = super
+        value.nil? ? nil : value == true || value == 1
+      end
+
+      def values
+        super.merge(success: success)
+      end
+    end
+  end
+end

data/lib/pact_broker/matrix/parse_query.rb

@@ -22,6 +22,15 @@ module PactBroker
         if params.key?('success') && params['success'].is_a?(String)
           options[:success] = [params['success'] == '' ? nil : params['success'] == 'true']
         end
+        if params.key?('scope')
+          options[:scope] = params['scope']
+        end
+        if params.key?('latestby')
+          options[:latestby] = params['latestby']
+        end
+        if params.key?('limit')
+          options[:limit] = params['limit']
+        end
         return selectors, options
       end
     end

data/lib/pact_broker/matrix/repository.rb

@@ -1,4 +1,6 @@
 require 'pact_broker/repositories/helpers'
+require 'pact_broker/matrix/row'
+require 'pact_broker/matrix/latest_row'
 
 module PactBroker
   module Matrix
@@ -6,61 +8,84 @@ module PactBroker
       include PactBroker::Repositories::Helpers
       include PactBroker::Repositories
 
+      # TODO move latest verification logic in to database
+
+      GROUP_BY_PROVIDER_VERSION_NUMBER = [:consumer_name, :consumer_version_number, :provider_name, :provider_version_number]
+      GROUP_BY_PROVIDER = [:consumer_name, :consumer_version_number, :provider_name]
+      GROUP_BY_PACT = [:consumer_name, :provider_name]
+
       # Return the latest matrix row (pact/verification) for each consumer_version_number/provider_version_number
       def find selectors, options = {}
         # The group with the nil provider_version_numbers will be the results of the left outer join
         # that don't have verifications, so we need to include them all.
-        lines = find_all(selectors)
-          .group_by{|line| [line[:consumer_name], line[:consumer_version_number], line[:provider_name], line[:provider_version_number]]}
-          .values
-          .collect{ | lines | lines.first[:provider_version_number].nil? ? lines : lines.last }
-          .flatten
+        lines = find_all(selectors, options)
+        lines = apply_scope(options, selectors, lines)
 
         if options.key?(:success)
-          lines = lines.select{ |l| options[:success].include?(l[:success]) }
+          lines = lines.select{ |l| options[:success].include?(l.success) }
         end
 
-        lines
+        lines.sort.collect(&:values)
+      end
+
+      def all_versions_specified? selectors
+        selectors.all?{ |s| s[:pacticipant_version_number] }
+      end
+
+      def apply_scope options, selectors, lines
+        return lines unless options[:latestby] == 'cvp' || options[:latestby] == 'cp'
+
+        group_by_columns = case options[:latestby]
+        when 'cvp' then GROUP_BY_PROVIDER
+        when 'cp' then GROUP_BY_PACT
+        end
+
+        lines.group_by{|line| group_by_columns.collect{|key| line.send(key) }}
+          .values
+          .collect{ | lines | lines.first.provider_version_number.nil? ? lines : lines.first }
+          .flatten
       end
 
       def find_for_consumer_and_provider pacticipant_1_name, pacticipant_2_name
         selectors = [{ pacticipant_name: pacticipant_1_name }, { pacticipant_name: pacticipant_2_name }]
-        find_all(selectors)
-          .sort{|l1, l2| l2[:consumer_version_order] <=> l1[:consumer_version_order]}
+        find_all(selectors, {latestby: 'cvpv'}).sort.collect(&:values)
       end
 
       def find_compatible_pacticipant_versions selectors
-        find(selectors).select{ |line | line[:success] }
+        find(selectors, latestby: 'cvpv').select{|line| line[:success] }
       end
 
       ##
       # If the version is nil, it means all versions for that pacticipant are to be included
       #
-      def find_all selectors
+      def find_all selectors, options
         selectors = look_up_versions_for_tags(selectors)
-
-        query = PactBroker::Pacts::LatestPactPublicationsByConsumerVersion
-          .select_append(:consumer_version_number, :provider_name, :consumer_name, :provider_version_id, :provider_version_number, :success)
-          .select_append(Sequel[:latest_pact_publications_by_consumer_versions][:created_at].as(:pact_created_at))
-          .select_append(Sequel[:all_verifications][:number])
-          .select_append(Sequel[:all_verifications][:id].as(:verification_id))
-          .select_append(Sequel[:execution_date].as(:verification_executed_at))
-          .left_outer_join(:all_verifications, pact_version_id: :pact_version_id)
+        query = base_table(options).select_all
 
         if selectors.size == 1
           query = where_consumer_or_provider_is(selectors.first, query)
         else
-          query = where_consumer_and_provider_within(selectors, query)
+          query = where_consumer_and_provider_in(selectors, query)
         end
 
-        query.order(:execution_date, :verification_id)
-          .collect(&:values)
+        query = query.limit(options[:limit]) if options[:limit]
+        query.order(
+          Sequel.asc(:consumer_name),
+          Sequel.desc(:consumer_version_order),
+          Sequel.desc(:pact_revision_number),
+          Sequel.asc(:provider_name),
+          Sequel.desc(:provider_version_order),
+          Sequel.desc(:verification_id)).all
+      end
+
+      def base_table(options)
+        return Row unless options[:latestby]
+        return LatestRow
       end
 
       def look_up_versions_for_tags(selectors)
         selectors.collect do | selector |
           # resource validation currently stops tag being specified without latest=true
-
           if selector[:tag] && selector[:latest]
             version = version_repository.find_by_pacticpant_name_and_latest_tag(selector[:pacticipant_name], selector[:tag])
             # validation in resource should ensure we always have a version
@@ -80,7 +105,7 @@ module PactBroker
         end
       end
 
-      def where_consumer_and_provider_within selectors, query
+      def where_consumer_and_provider_in selectors, query
           query.where{
             Sequel.&(
               Sequel.|(

data/lib/pact_broker/matrix/row.rb

@@ -0,0 +1,46 @@
+require 'pact_broker/repositories/helpers'
+
+module PactBroker
+  module Matrix
+    class Row < Sequel::Model(:matrix)
+
+      dataset_module do
+        include PactBroker::Repositories::Helpers
+      end
+
+      def summary
+        "#{consumer_name}#{consumer_version_number} #{provider_name}#{provider_version_number || '?'} (r#{pact_revision_number}n#{verification_number || '?'})"
+      end
+
+      # Add logic for ignoring case
+      def <=> other
+
+        comparisons = [
+          compare_name_asc(consumer_name, other.consumer_name),
+          compare_number_desc(consumer_version_order, other.consumer_version_order),
+          compare_number_desc(pact_revision_number, other.pact_revision_number),
+          compare_name_asc(provider_name, other.provider_name),
+          compare_number_desc(provider_version_order, other.provider_version_order),
+          compare_number_desc(verification_id, other.verification_id)
+        ]
+
+        comparisons.find{|c| c != 0 } || 0
+
+      end
+
+      def compare_name_asc name1, name2
+        name1 <=> name2
+      end
+
+      def compare_number_desc number1, number2
+        if number1 && number2
+          number2 <=> number1
+        elsif number1
+          1
+        else
+          -1
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/ui/controllers/matrix.rb

@@ -11,7 +11,7 @@ module PactBroker
 
         get "/provider/:provider_name/consumer/:consumer_name" do
           selectors = [{ pacticipant_name: params[:consumer_name] }, { pacticipant_name: params[:provider_name] } ]
-          lines = matrix_service.find(selectors)
+          lines = matrix_service.find(selectors, {latestby: 'cvpv', limit: 1000})
           lines = lines.collect{|line| PactBroker::UI::ViewDomain::MatrixLine.new(line) }.sort
           locals = {
             lines: lines,

data/lib/pact_broker/ui/view_models/matrix_line.rb

@@ -71,11 +71,11 @@ module PactBroker
         end
 
         def orderable_fields
-          [consumer_name, provider_name, consumer_version_order, provider_version_order]
+          [consumer_name, consumer_version_order, @line[:pact_revision_number], provider_name, @line[:verification_id]]
         end
 
         def <=> other
-          self.orderable_fields <=> other.orderable_fields
+          (self.orderable_fields <=> other.orderable_fields) * -1
         end
 
         def verification_status