pact_broker 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b84d9a4fa0cfe79efde8f1b39c6e630177b31a1
-  data.tar.gz: d4c280d34723b159cc05b9ac4c5144c9aae1b381
+  metadata.gz: 03e1cb232f71117f88a50df3b9b46001bf5fcc4d
+  data.tar.gz: 72758f12fc4fb67c94bb3f21190ccf7e56e36b80
 SHA512:
-  metadata.gz: 9cd26118f75849b539ae2ef910b107ac7a130fd4b4b6049fb50f4aebdc4e2b9d207c1a302db9108d351a80ce0642bab6f5a7c952cff9cacc3f856a2742bc35d2
-  data.tar.gz: ca50ecbc5d7bca2977dbbd2082fb82408e72a8f8324fa9d2a2ac38cfa349167463a718cbc03b16414d6e95b7be6aa378c7e4e9c6008a9a7ec530f9fd9ea18f25
+  metadata.gz: a455b7e1e44018827ac663ffe87eeb4c118c082865f9cbb926f0cc2fc3ed7d30ba28686c6b58548b7f36550f30ff8a634f0dc4ec26af8238aaae5d27b96cf2f0
+  data.tar.gz: 805d6d8e3d035ae6543d342459f22e21dc05eb0cda99bf96c64b568c937c383678c5ce20582d0a44ffa41f626e9e40bed0fe15f5dcdcf5155fa053e47cad9cc9

data/CHANGELOG.md

@@ -2,6 +2,20 @@ Do this to generate your change history
 
     $ git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+#### 2.3.0 (2017-07-14)
+* 3ac4351 - fix(potential duplicate pacticipant names): Make duplicate logic smarter. Fixes https://github.com/pact-foundation/pact_broker/issues/35 (Beth Skurrie, Tue Jul 11 10:30:11 2017 +1000)
+* 81979b1 - add basic auth example to duplicate pacticipant error/help message (Fitzgerald, Andrew, Mon Jul 10 00:11:25 2017 -0400)
+* bc54321 - feat(badges): Add endpoint to retrieve badge for latest untagged pact (Beth Skurrie, Fri Jul 7 10:15:29 2017 +1000)
+* 5a3b149 - feat(badges): Add endpoint to retrieve badge for latest tagged pact (Beth Skurrie, Fri Jul 7 09:32:24 2017 +1000)
+* 78c888b - feat(badges): Use static images when shields.io base URL is not configured. (Beth Skurrie, Fri Jul 7 08:41:35 2017 +1000)
+* b30c368 - feat(badges): Allow shields.io base URL to be configured (Beth Skurrie, Fri Jul 7 08:31:47 2017 +1000)
+* d8b2cec - feat(badges): Added configuration for turning badge resources on or off (Beth Skurrie, Fri Jul 7 08:25:48 2017 +1000)
+* 2e43b5f - feat(badges): Added read timeout of 1000ms for HTTP call to create badge. (Beth Skurrie, Thu Jul 6 07:48:39 2017 +1000)
+* 6bdae00 - fix(publish verification): Corrected pact finding params when publishing a verification. (Beth Skurrie, Thu Jul 6 07:30:38 2017 +1000)
+* 2508eba - feat(badges): Allow pacticipant initials to be used where names are too long for the badge (Beth Skurrie, Wed Jul 5 14:49:07 2017 +1000)
+* f7a36b7 - feat(badges): Return static badge when there is an error creating a dynamic one (Beth Skurrie, Wed Jul 5 10:14:18 2017 +1000)
+* 24860b3 - feat(badges): Add badge svg endpoint for latest pact (Beth Skurrie, Tue Jul 4 15:28:28 2017 +1000)
+
 #### 2.2.0 (2017-07-04)
 * 788c5d0 - chore(gems): Lock rack and red-carpet gem versions for hakiri (Beth Skurrie, Tue Jul 4 10:28:15 2017 +1000)
 * f1abebe - chore(gems): Upgrade pact gems (Beth Skurrie, Tue Jul 4 10:10:55 2017 +1000)

data/db/migrations/23_create_pact_versions_table.rb

@@ -1,7 +1,7 @@
 require_relative 'migration_helper'
 
 Sequel.migration do
-  up do
+  change do
     create_table(:pact_versions, charset: 'utf8') do
       primary_key :id
       foreign_key :consumer_id, :pacticipants
@@ -12,8 +12,4 @@ Sequel.migration do
       DateTime :created_at, null: false
     end
   end
-
-  down do
-
-  end
 end

data/lib/pact_broker/api.rb

@@ -26,6 +26,7 @@ require 'pact_broker/api/resources/latest_provider_pacts'
 require 'pact_broker/api/resources/verifications'
 require 'pact_broker/api/resources/verification'
 require 'pact_broker/api/resources/latest_verifications_for_consumer_version'
+require 'pact_broker/api/resources/badge'
 
 require 'webmachine/adapters/rack_mapped'
 
@@ -49,6 +50,11 @@ module PactBroker
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'pact-version', :pact_version_sha, 'verification-results', :verification_number], Api::Resources::Verification, {resource_name: "verification_result"}
         add ['verification-results', 'consumer', :consumer_name, 'version', :consumer_version_number,'latest'], Api::Resources::LatestVerificationsForConsumerVersion, {resource_name: "verification_results_for_consumer_version"}
 
+        # Badges
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'latest', 'badge'], Api::Resources::Badge, {resource_name: "latest_pact_badge"}
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'latest', :tag, 'badge'], Api::Resources::Badge, {resource_name: "latest_tagged_pact_badge"}
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'latest-untagged', 'badge'], Api::Resources::Badge, {resource_name: "latest_untagged_pact_badge", tag: :untagged}
+
         # Latest pacts
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'latest'], Api::Resources::LatestPact, {resource_name: "latest_pact_publication"}
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'latest', :tag], Api::Resources::LatestPact, {resource_name: "latest_tagged_pact_publication"}

data/lib/pact_broker/api/resources/badge.rb

@@ -0,0 +1,60 @@
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/verifications/verification_status'
+require 'pact_broker/configuration'
+
+module PactBroker
+  module Api
+    module Resources
+
+      class Badge < BaseResource
+
+        def allowed_methods
+          ['GET']
+        end
+
+        def content_types_provided
+          [['image/svg+xml', :to_svg]]
+        end
+
+        def resource_exists?
+          PactBroker.configuration.enable_badge_resources
+        end
+
+        def is_authorized?(authorization_header)
+          true
+        end
+
+        def forbidden?
+          false
+        end
+
+        private
+
+        def to_svg
+          badges_service.pact_verification_badge pact, label, initials, verification_status
+        end
+
+        def pact
+          @pact ||= pact_service.find_latest_pact(identifier_from_path)
+        end
+
+        def latest_verification
+          return nil unless pact
+          @verification ||= verification_service.find_latest_verification_for(pact.consumer, pact.provider, identifier_from_path[:tag])
+        end
+
+        def verification_status
+          @verification_status ||= PactBroker::Verifications::Status.new(pact, latest_verification).to_sym
+        end
+
+        def label
+          request.query['label']
+        end
+
+        def initials
+          request.query['initials'] == 'true'
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/badges/service.rb

@@ -0,0 +1,107 @@
+require 'net/http'
+require 'uri'
+require 'pact_broker/project_root'
+require 'pact_broker/logging'
+require 'pact_broker/configuration'
+
+module PactBroker
+  module Badges
+    module Service
+
+      extend self
+      include PactBroker::Logging
+
+      SPACE_DASH_UNDERSCORE = /[\s_\-]/
+      LOWER_TO_UPPERCASE = /[a-zA-Z](?=[A-Z])/
+
+      def pact_verification_badge pact, label, initials, verification_status
+        return static_svg(pact, verification_status) unless pact
+
+        title = badge_title pact, label, initials
+        status = badge_status verification_status
+        color = badge_color verification_status
+
+        dynamic_svg(title, status, color) || static_svg(pact, verification_status)
+      end
+
+      private
+
+      def badge_title pact, label, initials
+        title = case (label || '').downcase
+          when 'consumer' then prepare_name(pact.consumer_name, initials)
+          when 'provider' then prepare_name(pact.provider_name, initials)
+          else "#{prepare_name(pact.consumer_name, initials)}%2F#{prepare_name(pact.provider_name, initials)}"
+        end
+        "#{title} pact".downcase
+      end
+
+      def prepare_name name, initials
+        if initials
+          parts = name.split(SPACE_DASH_UNDERSCORE)
+          parts = name.split(LOWER_TO_UPPERCASE) if parts.size == 1
+          return parts.collect{ |p| p[0] }.join.downcase if parts.size > 1
+        end
+        name.downcase
+      end
+
+      def badge_status verification_status
+        case verification_status
+          when :success then "verified"
+          when :failed then "failed"
+          when :stale then "changed"
+          else "unknown"
+        end
+      end
+
+      def badge_color verification_status
+        case verification_status
+          when :success then "brightgreen"
+          when :failed then "red"
+          when :stale then "orange"
+          else "lightgrey"
+        end
+      end
+
+      def dynamic_svg left_text, right_text, color
+        return nil unless PactBroker.configuration.shields_io_base_url
+        uri = build_uri(left_text, right_text, color)
+        begin
+          response = do_request(uri)
+          response.code == '200' ? response.body : nil
+        rescue StandardError => e
+          log_error e, "Error retrieving badge from #{uri}"
+          nil
+        end
+      end
+
+      def build_uri left_text, right_text, color
+        shield_base_url = PactBroker.configuration.shields_io_base_url
+        path = "/badge/#{escape_text(left_text)}-#{escape_text(right_text)}-#{color}.svg"
+        URI.parse(shield_base_url + path)
+      end
+
+      def escape_text text
+        text.gsub(" ", "%20").gsub("-", "--").gsub("_", "__")
+      end
+
+      def do_request(uri)
+        request = Net::HTTP::Get.new(uri)
+        Net::HTTP.start(uri.hostname, uri.port,
+          use_ssl: uri.scheme == 'https', read_timeout: 1000) do |http|
+          http.request request
+        end
+      end
+
+      def static_svg pact, verification_status
+        file_name = case verification_status
+          when :success then "pact-verified-brightgreen.svg"
+          when :failed then "pact-failed-red.svg"
+          when :stale then "pact-changed-orange.svg"
+          else "pact-unknown-lightgrey.svg"
+        end
+        file_name = "pact_not_found-unknown-lightgrey.svg" unless pact
+        File.read(PactBroker.project_root.join("public", "images", file_name))
+      end
+    end
+  end
+end

data/lib/pact_broker/configuration.rb

@@ -17,6 +17,7 @@ module PactBroker
     attr_accessor :validate_database_connection_config, :enable_diagnostic_endpoints, :version_parser
     attr_accessor :use_case_sensitive_resource_names, :order_versions_by_date
     attr_accessor :semver_formats
+    attr_accessor :enable_badge_resources, :shields_io_base_url
     attr_writer :logger
 
     def initialize
@@ -38,6 +39,8 @@ module PactBroker
       config.use_hal_browser = true
       config.validate_database_connection_config = true
       config.enable_diagnostic_endpoints = true
+      config.enable_badge_resources = false # For security
+      config.shields_io_base_url = "https://img.shields.io".freeze
       config.use_case_sensitive_resource_names = true
       config.html_pact_renderer = default_html_pact_render
       config.version_parser = PactBroker::Versions::ParseSemanticVersion
@@ -127,7 +130,5 @@ module PactBroker
     def log_path
       log_dir + "/pact_broker.log"
     end
-
   end
-
 end

data/lib/pact_broker/doc/views/publish-verification-results.markdown

@@ -6,9 +6,9 @@ Use the `pb:publish-verification-results` link in the pact resource to publish t
 
     POST http://broker/pacts/provider/Foo/consumer/Bar/pact-version/1234
     {
-      success: true,
-      providerApplicationVersion: "4.5.6",
-      buildUrl: "http://my-ci.org/build/3456"
+      "success": true,
+      "providerApplicationVersion": "4.5.6",
+      "buildUrl": "http://my-ci.org/build/3456"
     }
 
-Multiple verification results may be published for the same pact resource.
+Multiple verification results may be published for the same pact resource. The most recently published one will be considered to reflect the current status of verification.

data/lib/pact_broker/domain/relationship.rb

@@ -1,3 +1,5 @@
+require 'pact_broker/verifications/verification_status'
+
 module PactBroker
   module Domain
 
@@ -13,7 +15,7 @@ module PactBroker
         @webhooks = webhooks
       end
 
-      def self.create consumer, provider, latest_pact, latest_verification, webhooks
+      def self.create consumer, provider, latest_pact, latest_verification, webhooks = []
         new consumer, provider, latest_pact, latest_verification, webhooks
       end
 
@@ -43,6 +45,10 @@ module PactBroker
         @webhooks.any?
       end
 
+      def verification_status
+        @verification_status ||= PactBroker::Verifications::Status.new(@latest_pact, @latest_verification).to_sym
+      end
+
       def ever_verified?
         !!latest_verification
       end

data/lib/pact_broker/domain/verification.rb

@@ -41,6 +41,18 @@ module PactBroker
           where(Sequel.qualify("verifications", "number") => number)
         end
 
+        def tag tag_name
+          filter = name_like(Sequel.qualify(:tags, :name), tag_name)
+          join(:pact_publications, {pact_version_id: :pact_version_id})
+            .join(:tags, {version_id: :consumer_version_id}).where(filter)
+        end
+
+        def untagged
+          join(:pact_publications, {pact_version_id: :pact_version_id})
+            .left_outer_join(:tags, {version_id: :consumer_version_id})
+            .where(Sequel.qualify(:tags, :name) => nil)
+        end
+
         def latest
           reverse_order(:consumer_version_order, :number).limit(1)
         end

data/lib/pact_broker/locale/en.yml

@@ -28,6 +28,8 @@ en:
         If you meant to specify one of the above names, please correct the pact configuration, and re-publish the pact.
         If the pact is intended to be for a new consumer or provider, please manually create "%{new_name}" using the following command, and then re-publish the pact:
         $ curl -v -XPOST -H "Content-Type: application/json" -d "{\"name\": \"%{new_name}\"}" %{create_pacticipant_url}
+        If the pact broker requires authentication, include the '-u' flag with the proper credentials:
+        $ curl -v -XPOST -u <username>:<password> -H "Content-Type: application/json" -d "{\"name\": \"%{new_name}\"}" %{create_pacticipant_url}
       "400":
         title: 400 Malformed Request
         message: The request was malformed and could not be processed.

data/lib/pact_broker/logging.rb

@@ -17,8 +17,10 @@ module PactBroker
       @@logger = logger
     end
 
-    def log_error e
-      logger.error "#{e.class} #{e.message} #{e.backtrace.join("\n")}"
+    def log_error e, description = nil
+      message = "#{e.class} #{e.message} #{e.backtrace.join("\n")}"
+      message = "#{description} - #{message}" if description
+      logger.error message
     end
 
     def logger

data/lib/pact_broker/pacticipants/find_potential_duplicate_pacticipant_names.rb

@@ -21,16 +21,22 @@ module PactBroker
         return [] if existing_names.include?(new_name)
 
         existing_names.select do | existing_name |
-          similar?(clean(new_name), clean(existing_name))
+          clean(new_name) == clean(existing_name)
         end
       end
 
-      def similar?(new_name, existing_name)
-        existing_name.include?(new_name) || new_name.include?(existing_name)
+      def clean name
+        self.class.split(name).collect{|w| w.chomp('s') } - ["api", "provider", "service"]
       end
 
-      def clean name #TODO uppercase S
-        name.gsub(/s\b/,'').gsub(/s([A-Z])/,'\1').gsub(/[^A-Za-z0-9]/,'').downcase
+      def self.split(string)
+        string.gsub(/\s/, '_')
+              .gsub(/::/, '/')
+              .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+              .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+              .tr('-', '_')
+              .downcase
+              .split("_")
       end
 
     end

data/lib/pact_broker/pacts/service.rb

@@ -22,7 +22,7 @@ module PactBroker
       end
 
       def find_pact params
-        pact_repository.find_pact(params[:consumer_name], params[:consumer_version_number], params[:provider_name], params[:revision_number])
+        pact_repository.find_pact(params[:consumer_name], params[:consumer_version_number], params[:provider_name], params[:pact_version_sha])
       end
 
       def find_by_consumer_version params

data/lib/pact_broker/services.rb

@@ -36,5 +36,10 @@ module PactBroker
       require 'pact_broker/verifications/service'
       Verifications::Service
     end
+
+    def badges_service
+      require 'pact_broker/badges/service'
+      Badges::Service
+    end
   end
 end

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

@@ -57,15 +57,11 @@ module PactBroker
         end
 
         def verification_status
-          return "" unless @relationship.ever_verified?
-          if @relationship.latest_verification_successful?
-            if @relationship.pact_changed_since_last_verification?
-              "warning"
-            else
-              "success"
-            end
-          else
-            "danger"
+          case @relationship.verification_status
+            when :success then "success"
+            when :stale then "warning"
+            when :failed then "danger"
+            else ""
           end
         end
 
@@ -74,13 +70,15 @@ module PactBroker
         end
 
         def verification_tooltip
-          return nil unless @relationship.ever_verified?
-          if warning?
-            "Pact has changed since last successful verification by #{provider_name} (v#{@relationship.latest_verification_provider_version})"
-          elsif @relationship.latest_verification_successful?
+          case @relationship.verification_status
+          when :success
             "Successfully verified by #{provider_name} (v#{@relationship.latest_verification_provider_version})"
-          elsif !@relationship.latest_verification_successful?
+          when :stale
+            "Pact has changed since last successful verification by #{provider_name} (v#{@relationship.latest_verification_provider_version})"
+          when :failed
             "Verification by #{provider_name} (v#{@relationship.latest_verification_provider_version}) failed"
+          else
+            nil
           end
         end