pact_broker 1.8.1 → 1.9.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2285ce5cae5cde5142184e3e74eb8ef40b3d7136
-  data.tar.gz: 07a8eaf72ea92839a00928991f5ae33162a0c6ab
+  metadata.gz: 208bc2c96b00747e6675cc9056e9f4c15436544e
+  data.tar.gz: 9cf1e32591790a46ffe91410fac6ade7bbdfe68b
 SHA512:
-  metadata.gz: cb28c1cd9e6db7f4ca2e0119dd1b227d4e7fb2980f3ac9ea7195504ddd1b8a77c536e7e7824c598afcb35c3004ee1adee2014771c06bd908a4e368b7a7f1877c
-  data.tar.gz: f75108480b94f2aba9929f8c44e7067fa28ca0039fb16553b1e0e6848a65ad10968f7998e91a6d93fa0187f6f376f05c0870e4d30602409ebbf21d4a3c9a1049
+  metadata.gz: 8d51e7194bb7e31f3b8433056d7ac5feaa130366075fb7681f692f174309feb35c08a42941b85cc875daa912857aa89dc2ba28ab51f09e459d35d4f6066322de
+  data.tar.gz: 5adcf997c3020a9b6b144ad025ef960e129b79a401efc8b5533f8d31974c6cb269368916dd82b717f5f964fb285183fb278f637d203cd3f0ec4e07c781019f77

data/CHANGELOG.md

@@ -2,6 +2,14 @@ Do this to generate your change history
 
     $ git log --pretty=format:'  * %h - %s (%an, %ad)' vX.Y.Z..HEAD
 
+#### 1.9.0.rc1 (2015-07-19)
+
+* c855a2c - Support case insensitive resource names (Beth Skurrie, Sun Jul 19 17:28:55 2015 +1000)
+* 7ea3e61 - Update pact_broker.gemspec (Beth Skurrie, Tue Jul 14 09:02:30 2015 +1000)
+* f299cfd - Added logging for publishing and deleting pacts (Beth Skurrie, Wed Jul 8 16:00:58 2015 +1000)
+* 67f0edb - Log error when contract cannot be parsed to a Pact (Beth Skurrie, Wed Jul 8 15:54:29 2015 +1000)
+* 57caf63 - Double ensure that tables are created with UTF-8 encoding https://github.com/bethesque/pact_broker/issues/24 (Beth Skurrie, Fri Jul 3 15:46:46 2015 +1000)
+
 #### 1.8.1 (2015-06-30)
 
 * d0d466d - Avoid making a query for tags for each pact shown on the Pacts page (Beth Skurrie, Tue Jun 30 06:42:09 2015 +1000)

data/README.md

@@ -18,6 +18,7 @@ Features:
 * Dynamically generated network diagrams.
 * Enables a pact version to be tagged (ie. "prod") so a provider can verify itself against a fixed version of a pact to ensure backwards compatibility.
 * Webhooks to trigger a provider build when a consumer publishes a change to a pact.
+* Tracks changes between Pact versions so you can tell when a consumer has changed its expectations.
 * [Docker Pact Broker][docker]
 
 Travis CI Status: [![Build Status](https://travis-ci.org/bethesque/pact_broker.svg?branch=master)](https://travis-ci.org/bethesque/pact_broker)

data/db/migrations/01_create_pacticipant_table.rb

@@ -1,6 +1,6 @@
 Sequel.migration do
   change do
-    create_table(:pacticipants) do
+    create_table(:pacticipants, charset: 'utf8') do
       primary_key :id
       String :name, :unique => true
       String :repository_url

data/db/migrations/02_create_versions_table.rb

@@ -1,7 +1,7 @@
 Sequel.migration do
 
   change do
-    create_table(:versions) do
+    create_table(:versions, charset: 'utf8') do
       primary_key :id
       String :number
       String :repository_ref

data/db/migrations/03_create_pacts_table.rb

@@ -1,6 +1,6 @@
 Sequel.migration do
   change do
-    create_table(:pacts) do
+    create_table(:pacts, charset: 'utf8') do
       primary_key :id
       String :json_content, :text=>true
       foreign_key :version_id, :versions, null: false

data/db/migrations/04_create_tags_table.rb

@@ -1,6 +1,6 @@
 Sequel.migration do
   change do
-    create_table(:tags) do
+    create_table(:tags, charset: 'utf8') do
       String :name
       foreign_key :version_id, :versions
       primary_key [:version_id, :name], :name=>:tags_pk

data/db/migrations/12_create_webhooks_table.rb

@@ -1,6 +1,6 @@
 Sequel.migration do
   change do
-    create_table(:webhooks) do
+    create_table(:webhooks, charset: 'utf8') do
       primary_key :id
       String :uuid, null: false, unique: true, unique_constraint_name: 'uq_webhook_uuid'
       String :method, null: false
@@ -11,7 +11,7 @@ Sequel.migration do
       foreign_key :provider_id, :pacticipants, null: false, foreign_key_constraint_name: 'fk_webhooks_provider'
     end
 
-    create_table(:webhook_headers) do
+    create_table(:webhook_headers, charset: 'utf8') do
       String :name, null: false
       String :value
       foreign_key :webhook_id, :webhooks, null: false, foreign_key_constraint_name: 'fk_webhookheaders_webhooks'

data/db/migrations/15_create_pact_version_content.rb

@@ -3,7 +3,7 @@ require_relative 'migration_helper'
 
 Sequel.migration do
   change do
-    create_table(:pact_version_contents) do
+    create_table(:pact_version_contents, charset: 'utf8') do
       String :sha, primary_key: true, null: false, primary_key_constraint_name: 'pk_pact_version_contents'
       String :content, type: PactBroker::MigrationHelper.large_text_type
       DateTime :created_at, null: false

data/lib/pact_broker/api/renderers/html_pact_renderer.rb

@@ -3,6 +3,7 @@ require 'pact/reification'
 require 'redcarpet'
 require 'pact/doc/markdown/consumer_contract_renderer'
 require 'pact_broker/api/pact_broker_urls'
+require 'pact_broker/logging'
 
 module PactBroker
   module Api
@@ -11,6 +12,8 @@ module PactBroker
 
         class NotAPactError < StandardError; end
 
+        include PactBroker::Logging
+
         def self.call pact
           new(pact).call
         end
@@ -84,7 +87,9 @@ module PactBroker
 
         def consumer_contract
           Pact::ConsumerContract.from_json(@json_content)
-        rescue
+        rescue => e
+          logger.warn "#{e.class} #{e.message} #{e.backtrace.join("\n")}"
+          logger.warn "Could not parse the following content to a Pact, showing raw content instead: #{@json_content}"
           raise NotAPactError
         end
 

data/lib/pact_broker/configuration.rb

@@ -8,6 +8,7 @@ module PactBroker
 
     attr_accessor :log_dir, :database_connection, :auto_migrate_db, :use_hal_browser, :html_pact_renderer
     attr_accessor :validate_database_connection_config, :enable_diagnostic_endpoints, :version_parser
+    attr_accessor :use_case_sensitive_resource_names
     attr_writer :logger
 
     def logger
@@ -20,9 +21,10 @@ module PactBroker
       config.log_dir = File.expand_path("./log")
       config.auto_migrate_db = true
       config.use_hal_browser = true
-      config.html_pact_renderer = default_html_pact_render
       config.validate_database_connection_config = true
       config.enable_diagnostic_endpoints = true
+      config.use_case_sensitive_resource_names = true
+      config.html_pact_renderer = default_html_pact_render
       config.version_parser = PactBroker::Versions::ParseSemanticVersion
       config
     end

data/lib/pact_broker/pacts/all_pacts.rb

@@ -2,13 +2,13 @@ require 'pact_broker/domain/tag'
 require 'pact_broker/domain/pacticipant'
 require 'pact_broker/domain/version'
 require 'pact_broker/pacts/pact_version_content'
+require 'pact_broker/repositories/helpers'
 
 module PactBroker
   module Pacts
 
     class AllPacts < Sequel::Model(:all_pacts)
 
-
       set_primary_key :id
       associate(:one_to_many, :tags, :class => "PactBroker::Domain::Tag", :reciprocal => :version, :key => :version_id, :primary_key => :consumer_version_id)
       associate(:many_to_one, :pact_version_content, :key => :pact_version_content_sha, :primary_key => :sha)
@@ -24,22 +24,23 @@ module PactBroker
       #       {table_alias: :lp}
       #     )
       #   end
+        include PactBroker::Repositories::Helpers
 
         def consumer consumer_name
-          filter(consumer_name: consumer_name)
+          where(name_like(:consumer_name, consumer_name))
         end
 
         def provider provider_name
-          filter(provider_name: provider_name)
+          where(name_like(:provider_name, provider_name))
         end
 
         def tag tag_name
-          join(:tags, {version_id: :consumer_version_id})
-          .where('tags.name = ?', tag_name)
+          filter = name_like(Sequel.qualify(:tags, :name), tag_name)
+          join(:tags, {version_id: :consumer_version_id}).where(filter)
         end
 
         def consumer_version_number number
-          filter(consumer_version_number: number)
+          where(name_like(:consumer_version_number, number))
         end
 
         def consumer_version_order_before order

data/lib/pact_broker/pacts/service.rb

@@ -1,5 +1,6 @@
 require 'pact_broker/repositories'
 require 'pact_broker/services'
+require 'pact_broker/logging'
 
 module PactBroker
   module Pacts
@@ -9,6 +10,7 @@ module PactBroker
 
       extend PactBroker::Repositories
       extend PactBroker::Services
+      include PactBroker::Logging
 
       def find_latest_pact params
         pact_repository.find_latest_pact(params[:consumer_name], params[:provider_name], params[:tag])
@@ -23,6 +25,7 @@ module PactBroker
       end
 
       def delete params
+        logger.info "Deleting pact version with params #{params}"
         pact_repository.delete(params)
       end
 
@@ -77,6 +80,7 @@ module PactBroker
       private
 
       def update_pact params, existing_pact
+        logger.info "Updating existing pact version with params #{params}"
         updated_pact = pact_repository.update existing_pact.id, params
 
         if existing_pact.json_content != updated_pact.json_content
@@ -87,6 +91,7 @@ module PactBroker
       end
 
       def create_pact params, version, provider
+        logger.info "Creating new pact version with params #{params}"
         pact = pact_repository.create json_content: params[:json_content], version_id: version.id, provider_id: provider.id
         trigger_webhooks pact
         pact

data/lib/pact_broker/repositories/helpers.rb

@@ -0,0 +1,16 @@
+module PactBroker
+  module Repositories
+    module Helpers
+
+      extend self
+
+      def name_like column_name, value
+        Sequel.like(column_name, value, case_sensitivity_options)
+      end
+
+      def case_sensitivity_options
+        {case_insensitive: !PactBroker.configuration.use_case_sensitive_resource_names}
+      end
+    end
+  end
+end

data/lib/pact_broker/repositories/pacticipant_repository.rb

@@ -1,12 +1,15 @@
 require 'sequel'
 require 'pact_broker/domain/pacticipant'
+require 'pact_broker/repositories/helpers'
 
 module PactBroker
   module Repositories
     class PacticipantRepository
 
+      include Helpers
+
       def find_by_name name
-        PactBroker::Domain::Pacticipant.where(name: name).single_record
+        PactBroker::Domain::Pacticipant.where(name_like(:name, name)).single_record
       end
 
       def find_by_id id
@@ -36,7 +39,6 @@ module PactBroker
       def find_latest_version name
 
       end
-
     end
   end
 end

data/lib/pact_broker/repositories/tag_repository.rb

@@ -1,9 +1,12 @@
 require 'pact_broker/domain/tag'
+require 'pact_broker/repositories/helpers'
+
 
 module PactBroker
   module Repositories
     class TagRepository
 
+      include Helpers
 
       def create args
         Domain::Tag.new(name: args.fetch(:name), version: args.fetch(:version)).save
@@ -14,12 +17,11 @@ module PactBroker
           .select(:tags__name, :tags__version_id, :tags__created_at, :tags__updated_at)
           .join(:versions, {id: :version_id})
           .join(:pacticipants, {pacticipants__id: :versions__pacticipant_id})
-          .where(:tags__name => args.fetch(:tag_name))
-          .where(:versions__number => args.fetch(:pacticipant_version_number))
-          .where(:pacticipants__name => args.fetch(:pacticipant_name))
+          .where(name_like(:tags__name, args.fetch(:tag_name)))
+          .where(name_like(:versions__number, args.fetch(:pacticipant_version_number)))
+          .where(name_like(:pacticipants__name, args.fetch(:pacticipant_name)))
           .single_record
       end
-
     end
   end
-end
+end

data/lib/pact_broker/repositories/version_repository.rb

@@ -1,10 +1,13 @@
 require 'sequel'
 require 'pact_broker/domain/version'
+require 'pact_broker/repositories/tag_repository'
 
 module PactBroker
   module Repositories
     class VersionRepository
 
+      include Helpers
+
       def find_by_pacticipant_id_and_number pacticipant_id, number
         PactBroker::Domain::Version.where(number: number, pacticipant_id: pacticipant_id).single_record
       end
@@ -12,9 +15,9 @@ 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)
+          .where(name_like(:number, number))
+          .where(name_like(:name, pacticipant_name))
           .single_record
       end
 
@@ -31,7 +34,6 @@ module PactBroker
           create(pacticipant_id: pacticipant_id, number: number)
         end
       end
-
     end
   end
-end
+end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '1.8.1'
+  VERSION = '1.9.0.rc1'
 end

data/pact_broker.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["bskurrie@dius.com.au", "serge.matheson@rea-group.com", "warner@warnergodfrey.com"]
   gem.description   = %q{A server that stores and returns pact files generated by the pact gem. It enables head/prod cross testing of the consumer and provider projects.}
   gem.summary       = %q{See description}
-  gem.homepage      = "https://github.com/DiUS/pact_broker"
+  gem.homepage      = "https://github.com/bethesque/pact_broker"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/features/get_pact_spec.rb

@@ -0,0 +1,66 @@
+describe "retrieving a pact" do
+
+  subject { get path; last_response  }
+
+  context "when differing case is used in the consumer and provider names" do
+
+    let(:path) { "/pacts/provider/a%20provider/consumer/a%20consumer/version/1.2.3A" }
+
+    before do
+      ProviderStateBuilder.new.create_pact_with_hierarchy "A Consumer", "1.2.3a", "A Provider"
+    end
+
+    context "when case sensitivity is turned on" do
+      before do
+        allow(PactBroker.configuration).to receive(:use_case_sensitive_resource_names).and_return(true)
+      end
+
+      it "returns a 404 Not found" do
+        expect(subject.status).to be 404
+      end
+    end
+
+    context "when case sensitivity is turned off" do
+      before do
+        allow(PactBroker.configuration).to receive(:use_case_sensitive_resource_names).and_return(false)
+      end
+
+      it "returns a 200 Success" do
+        expect(subject.status).to be 200
+      end
+    end
+  end
+  context "when differing case is used in the tag name" do
+
+    let(:path) { "/pacts/provider/a%20provider/consumer/a%20consumer/latest/PROD" }
+
+    before do
+      ProviderStateBuilder.new
+        .create_consumer("A Consumer")
+        .create_consumer_version("1.2.3")
+        .create_consumer_version_tag("prod")
+        .create_provider("A Provider")
+        .create_pact
+    end
+
+    context "when case sensitivity is turned on" do
+      before do
+        allow(PactBroker.configuration).to receive(:use_case_sensitive_resource_names).and_return(true)
+      end
+
+      it "returns a 404 Not found" do
+        expect(subject.status).to be 404
+      end
+    end
+
+    context "when case sensitivity is turned off" do
+      before do
+        allow(PactBroker.configuration).to receive(:use_case_sensitive_resource_names).and_return(false)
+      end
+
+      it "returns a 200 Success" do
+        expect(subject.status).to be 200
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/api/renderers/html_pact_renderer_spec.rb

@@ -60,6 +60,12 @@ module PactBroker
             it "renders the JSON in HTML" do
               expect(subject).to match /\[\s+1\s+\]/m
             end
+
+            it "logs a warning" do
+              allow(PactBroker.logger).to receive(:warn).with(/Error/)
+              expect(PactBroker.logger).to receive(:warn).with(/Could not parse/)
+              subject
+            end
           end
         end
 

data/spec/lib/pact_broker/repositories/pacticipant_repository_spec.rb

@@ -6,6 +6,36 @@ module PactBroker
   module Repositories
     describe PacticipantRepository do
 
+      describe "#find_by_name" do
+        before do
+          ProviderStateBuilder.new.create_pacticipant("Foo Bar")
+        end
+
+        subject { PacticipantRepository.new.find_by_name('foo bar') }
+
+        context "when the name is a different case" do
+          context "with case sensitivity turned on" do
+            before do
+              allow(PactBroker.configuration).to receive(:use_case_sensitive_resource_names).and_return(true)
+            end
+
+            it "returns nil" do
+              expect(subject).to be nil
+            end
+          end
+
+          context "with case sensitivity turned off" do
+            before do
+              allow(PactBroker.configuration).to receive(:use_case_sensitive_resource_names).and_return(false)
+            end
+
+            it "returns the pacticipant" do
+              expect(subject).to_not be nil
+              expect(subject.name).to eq "Foo Bar"
+            end
+          end
+        end
+      end
 
       describe "#pacticipant_names" do
 

data/spec/lib/pact_broker/repositories/tag_repository_spec.rb

@@ -8,7 +8,7 @@ module PactBroker
       describe ".find" do
 
         let(:pacticipant_name) { "test_pacticipant" }
-        let(:version_number) { "1.2.3" }
+        let(:version_number) { "1.2.3a" }
         let(:tag_name) { "prod" }
 
         subject { TagRepository.new }
@@ -41,6 +41,18 @@ module PactBroker
             expect(find_tag.updated_at).to be_instance_of(DateTime)
           end
 
+          context "when case sensitivity is turned off and a name with different case is used" do
+            before do
+              allow(PactBroker.configuration).to receive(:use_case_sensitive_resource_names).and_return(false)
+            end
+
+            let(:options) { {pacticipant_name: pacticipant_name.upcase, pacticipant_version_number: version_number.upcase, tag_name: tag_name.upcase} }
+
+            it "returns the tag" do
+              expect(find_tag).to_not be nil
+              expect(find_tag.name).to eq tag_name
+            end
+          end
         end
 
         context "when the tag does not exist" do

data/spec/lib/pact_broker/repositories/version_repository_spec.rb

@@ -26,7 +26,6 @@ module PactBroker
 
       describe "#find_by_pacticipant_name_and_number" do
 
-
         subject { described_class.new.find_by_pacticipant_name_and_number pacticipant_name, version_number }
 
         context "when the version exists" do
@@ -48,6 +47,18 @@ module PactBroker
             expect(subject.tags.first.name).to eq "prod"
             expect(subject.order).to eq 0
           end
+
+          context "when case sensitivity is turned off and names with different cases are used" do
+            before do
+              allow(PactBroker.configuration).to receive(:use_case_sensitive_resource_names).and_return(false)
+            end
+
+            subject { described_class.new.find_by_pacticipant_name_and_number pacticipant_name.upcase, version_number.upcase }
+
+            it "returns the version" do
+              expect(subject).to_not be nil
+            end
+          end
         end
 
         context "when the version doesn't exist" do
@@ -55,10 +66,7 @@ module PactBroker
             expect(subject).to be_nil
           end
         end
-
       end
-
-
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0.rc1
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -502,6 +502,7 @@ files:
 - lib/pact_broker/project_root.rb
 - lib/pact_broker/relationships/groupify.rb
 - lib/pact_broker/repositories.rb
+- lib/pact_broker/repositories/helpers.rb
 - lib/pact_broker/repositories/pacticipant_repository.rb
 - lib/pact_broker/repositories/tag_repository.rb
 - lib/pact_broker/repositories/version_repository.rb
@@ -567,6 +568,7 @@ files:
 - spec/features/create_webhook_spec.rb
 - spec/features/delete_pact_spec.rb
 - spec/features/get_diff.rb
+- spec/features/get_pact_spec.rb
 - spec/features/get_previous_distinct_version.rb
 - spec/features/get_provider_pacts.rb
 - spec/features/get_version.rb
@@ -691,7 +693,7 @@ files:
 - vendor/hal-browser/vendor/js/jquery-1.10.2.min.map
 - vendor/hal-browser/vendor/js/underscore.js
 - vendor/hal-browser/vendor/js/uritemplates.js
-homepage: https://github.com/DiUS/pact_broker
+homepage: https://github.com/bethesque/pact_broker
 licenses:
 - MIT
 metadata: {}
@@ -706,9 +708,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14
@@ -719,6 +721,7 @@ test_files:
 - spec/features/create_webhook_spec.rb
 - spec/features/delete_pact_spec.rb
 - spec/features/get_diff.rb
+- spec/features/get_pact_spec.rb
 - spec/features/get_previous_distinct_version.rb
 - spec/features/get_provider_pacts.rb
 - spec/features/get_version.rb