pact_broker 2.27.2 → 2.27.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: e67bad7e9a3ecb1e2ecd911350a937615bf9b2f90ac811ad48acf16185ffee41
-  data.tar.gz: e55c77c181b1d2e37e20a6b0a4f6b500ebdba7b0c861597c8f80b580915d9a3c
+SHA1:
+  metadata.gz: 8b120fc3afe15b42e4b97ca8eee39afe2f7f3070
+  data.tar.gz: 00ba1080e2f72e2fe27ed72a4adda5819cc0149a
 SHA512:
-  metadata.gz: 3fcd28aeb22cee45696bee504bb1c6b49cec7faa83185df24c5854e9a22fd2023bee57f62fbea2fad54f5c4f590e1de91febab56f3baa1a15a7656d692a0d816
-  data.tar.gz: 18a6fe1f7dd9c61143ea1fe7bf031576c8d1d615d0a212dc2b8e833ad5fd14de39c606e92ea021f82f8b64015ba3e12a7f8cccc317fd5979c30a965b153cb773
+  metadata.gz: c98ee07fa57d47767ce6a17d4d158082a9dd4b966a38a308836e11347d2909e3782fab0758ab7ffd2e05eb6d8cbe8c4844debfef6d19da73f7ed7d5cd8194aa6
+  data.tar.gz: 3b120a72072e2f5363ba35a3c3467fd41facb6fd26fb2cbe65e4c6d0a8c4448ac7eb8c7f8ea640881f5a32a99af2fe4c6f1b9a08c726188ce3d1492334c8687a

data/.travis.yml

@@ -26,5 +26,5 @@ before_script:
 script:
   - bundle exec rake
   - if [ "$DATABASE_ADAPTER" == "postgres" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT || true; fi
-  - if [ ! -z "$(ruby --version | grep '2\.4\.')" ]; then ./script/db-spec.sh; fi
+  # - if [ ! -z "$(ruby --version | grep '2\.4\.')" ]; then ./script/db-spec.sh; fi
   - bundle exec bundle-audit update && bundle exec bundle-audit

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+<a name="v2.27.3"></a>
+### v2.27.3 (2018-11-01)
+
+
+#### Features
+
+* add LogQuietener to example config.ru	 ([2f014f07](/../../commit/2f014f07))
+* Rename database logger delegate to LogQuietener	 ([34f44bcb](/../../commit/34f44bcb))
+* create delegate for database logger to tone down the 'table does not exist' errors that freak people out at startup	 ([573d204b](/../../commit/573d204b))
+
+* **semantic-logging**
+  * set logger for SuckerPunch and tests	 ([201eb331](/../../commit/201eb331))
+  * allow ruby standard logger to be configured to ensure backwards compatibility	 ([cfbb704c](/../../commit/cfbb704c))
+
+* **tagged-pact-versions**
+  * ensure triggered webhooks are deleted when pact versions are deleted	 ([288475f1](/../../commit/288475f1))
+  * add endpoint to view and delete a collection of pact versions by tag	 ([615025e9](/../../commit/615025e9))
+
+* **logging**
+  * implement structured logging	 ([a9133bd5](/../../commit/a9133bd5))
+
+
+#### Bug Fixes
+
+* correct foreign key between AllPactPublications and PactVersion	 ([59f76c74](/../../commit/59f76c74))
+* ensure bundle install for pact_broker:dev:setup uses correct Gemfile	 ([94f3a5f2](/../../commit/94f3a5f2))
+* Fix some invalid HTML	 ([0c9a08a8](/../../commit/0c9a08a8))
+
+* **openssl**
+  * simplify certificate test for latest LibreSSL/OpenSSL libs	 ([cce79390](/../../commit/cce79390))
+
+
 <a name="v2.27.2"></a>
 ### v2.27.2 (2018-09-14)
 

data/DEVELOPER_SETUP.md

@@ -8,6 +8,7 @@
 * To run the example:
 
       cd dev
+      bundle install
       bundle exec rackup
 
 * The application will be available on `http://localhost:9292`

data/example/config.ru

@@ -27,7 +27,7 @@ app = PactBroker::App.new do | config |
   # change these from their default values if desired
   # config.log_dir = "./log"
   # config.auto_migrate_db = true
-  config.database_connection = Sequel.connect(DATABASE_CREDENTIALS.merge(:logger => config.logger))
+  config.database_connection = Sequel.connect(DATABASE_CREDENTIALS.merge(:logger => PactBroker::DB::LogQuietener.new(config.logger)))
 end
 
 run app

data/lib/pact_broker.rb

@@ -4,6 +4,7 @@ require 'reform/form/dry'
 require 'pact_broker/version'
 require 'pact_broker/logging'
 require 'pact_broker/app'
+require 'pact_broker/db/log_quietener'
 
 module PactBroker
   Reform::Form.class_eval do

data/lib/pact_broker/api.rb

@@ -11,6 +11,7 @@ module PactBroker
 
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'versions'], Api::Resources::PactVersions, {resource_name: "pact_publications"}
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'versions', :consumer_version_number], Api::Resources::Pact, {resource_name: "pact_publication", deprecated: true} # Not the standard URL, but keep for backwards compatibility
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'tag', :tag], Api::Resources::TaggedPactVersions, {resource_name: "tagged_pact_publications"}
 
         # Pacts
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number], Api::Resources::Pact, {resource_name: "pact_publication"}

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

@@ -3,13 +3,9 @@ require_relative 'pact_pacticipant_decorator'
 require 'pact_broker/api/decorators/timestamps'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       class PactVersionDecorator < BaseDecorator
-
         include Timestamps
 
         property :consumer_version, as: :consumerVersion, embedded: true, decorator: EmbeddedVersionDecorator
@@ -20,7 +16,6 @@ module PactBroker
             title: represented.name
           }
         end
-
       end
     end
   end

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

@@ -0,0 +1,46 @@
+require_relative 'base_decorator'
+require_relative 'pact_version_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      class TaggedPactVersionsDecorator < BaseDecorator
+
+        collection :entries, as: :pacts, embedded: true, :extend => PactBroker::Api::Decorators::PactVersionDecorator
+
+        link :self do | context |
+          {
+            href: context[:resource_url],
+            title: "All versions of the pact between #{context[:consumer_name]} and #{context[:provider_name]} with tag #{context[:tag]}"
+          }
+        end
+
+        link :'pb:consumer' do | context |
+          {
+            href: pacticipant_url(context[:base_url], OpenStruct.new(name: context[:consumer_name])),
+            title: "Consumer",
+            name: context[:consumer_name]
+          }
+        end
+
+        link :'pb:provider' do | context |
+          {
+            href: pacticipant_url(context[:base_url], OpenStruct.new(name: context[:provider_name])),
+            title: "Provider",
+            name: context[:provider_name]
+          }
+        end
+
+        links :'pb:pact-versions' do | context |
+          represented.collect do | pact |
+            {
+              :href => pact_url(context[:base_url], pact),
+              :title => "Pact version",
+              :name => pact.version_and_updated_date
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -167,4 +167,4 @@ module PactBroker
       end
     end
   end
-end
+end

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

@@ -7,6 +7,7 @@ module PactBroker
       class ErrorHandler
 
         include PactBroker::Logging
+        include PactBroker::Logging
 
         def self.call e, request, response
           logger.error e

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

@@ -38,6 +38,12 @@ module PactBroker
               title: 'Latest pact versions',
               templated: false
             },
+            'pb:tagged-pact-versions' =>
+            {
+              href: base_url + '/pacts/provider/{provider}/consumer/{consumer}/tag/{tag}',
+              title: 'All versions of a pact for a given consumer, provider and consumer version tag',
+              templated: false
+            },
             'pb:pacticipants' =>
             {
               href: base_url + '/pacticipants',

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

@@ -0,0 +1,38 @@
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/configuration'
+require 'pact_broker/api/decorators/tagged_pact_versions_decorator'
+
+module PactBroker
+  module Api
+    module Resources
+      class TaggedPactVersions < BaseResource
+
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def allowed_methods
+          ["GET", "DELETE", "OPTIONS"]
+        end
+
+        def resource_exists?
+          pacticipant_service.find_pacticipant_by_name(consumer_name) &&
+            pacticipant_service.find_pacticipant_by_name(provider_name)
+        end
+
+        def to_json
+          PactBroker::Api::Decorators::TaggedPactVersionsDecorator.new(pacts).to_json(user_options: decorator_context(identifier_from_path))
+        end
+
+        def delete_resource
+          pact_service.delete_all_pact_versions_between consumer_name, and: provider_name, tag: identifier_from_path[:tag]
+          true
+        end
+
+        def pacts
+          pact_service.find_all_pact_versions_between consumer_name, and: provider_name, tag: identifier_from_path[:tag]
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/app.rb

@@ -1,6 +1,7 @@
 require 'pact_broker/configuration'
 require 'pact_broker/db'
 require 'pact_broker/project_root'
+require 'pact_broker/logging/default_formatter'
 require 'rack-protection'
 require 'rack/hal_browser'
 require 'rack/pact_broker/store_base_url'
@@ -18,6 +19,7 @@ require 'sucker_punch'
 module PactBroker
 
   class App
+    include PactBroker::Logging
 
     attr_accessor :configuration
 
@@ -58,13 +60,9 @@ module PactBroker
 
     private
 
-    def logger
-      PactBroker.logger
-    end
-
     def post_configure
-      PactBroker.logger = configuration.logger
-      SuckerPunch.logger = configuration.logger
+      configure_logger
+      SuckerPunch.logger = configuration.custom_logger || SemanticLogger['SuckerPunch']
       configure_database_connection
       configure_sucker_punch
     end
@@ -166,6 +164,14 @@ module PactBroker
       end
     end
 
+    def configure_logger
+      if SemanticLogger.appenders.empty?
+        path = configuration.log_dir + "/pact_broker.log"
+        FileUtils.mkdir_p(configuration.log_dir)
+        SemanticLogger.add_appender(file_name: path, formatter: PactBroker::Logging::DefaultFormatter.new)
+      end
+    end
+
     def running_app
       @running_app ||= begin
         apps = @cascade_apps

data/lib/pact_broker/certificates/service.rb

@@ -8,6 +8,7 @@ module PactBroker
 
       extend self
       extend PactBroker::Logging
+      include PactBroker::Logging
 
       def cert_store
         cert_store = OpenSSL::X509::Store.new

data/lib/pact_broker/configuration.rb

@@ -1,5 +1,6 @@
 require 'pact_broker/error'
 require 'pact_broker/config/space_delimited_string_list'
+require 'semantic_logger'
 
 module PactBroker
 
@@ -42,7 +43,7 @@ module PactBroker
     attr_accessor :disable_ssl_verification
     attr_accessor :base_equality_only_on_content_that_affects_verification_results
     attr_reader :api_error_reporters
-    attr_writer :logger
+    attr_reader :custom_logger
 
     def initialize
       @before_resource_hook = ->(resource){}
@@ -50,10 +51,7 @@ module PactBroker
       @authenticate_with_basic_auth = nil
       @authorize = nil
       @api_error_reporters = []
-    end
-
-    def logger
-      @logger ||= create_logger log_path
+      @semantic_logger = SemanticLogger["root"]
     end
 
     def self.default_configuration
@@ -85,6 +83,14 @@ module PactBroker
       config
     end
 
+    def logger
+      custom_logger || @semantic_logger
+    end
+
+    def logger= logger
+      @custom_logger = logger
+    end
+
     def self.default_html_pact_render
       lambda { |pact, options|
         require 'pact_broker/api/renderers/html_pact_renderer'
@@ -201,16 +207,5 @@ module PactBroker
         raise ConfigurationError.new("Pact Broker configuration property `#{property_name}` must be a space delimited String or an Array")
       end
     end
-
-    def create_logger path
-      FileUtils::mkdir_p File.dirname(path)
-      logger = Logger.new(path)
-      logger.level = Logger::DEBUG
-      logger
-    end
-
-    def log_path
-      log_dir + "/pact_broker.log"
-    end
   end
 end

data/lib/pact_broker/db/log_quietener.rb

@@ -0,0 +1,38 @@
+# To reduce the noise of the SQL logs, this class changes INFO
+# logs to DEBUG, and changes the ERROR logs that occur when
+# Sequel doesn't know if a table/view exists or not to DEBUG,
+# so that they don't freak newbies out when they start up the
+# broker for the first time.
+
+require 'delegate'
+
+module PactBroker
+  module DB
+    class LogQuietener < SimpleDelegator
+      def info *args
+        __getobj__().debug(*args)
+      end
+
+      def error *args
+        if error_is_about_table_not_existing?(args)
+          __getobj__().debug(*reassure_people_that_this_is_expected(args))
+        else
+          __getobj__().error(*args)
+        end
+      end
+
+      def error_is_about_table_not_existing?(args)
+        args.first.is_a?(String) &&
+          ( args.first.include?("PG::UndefinedTable") ||
+            args.first.include?("no such table") ||
+            args.first.include?("no such view"))
+      end
+
+      def reassure_people_that_this_is_expected(args)
+        message = args.shift
+        message = message + " Don't panic. This happens when Sequel doesn't know if a table/view exists or not."
+        [message] + args
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# Tagged pact versions
+
+Allowed methods: `GET`, `DELETE`
+
+Lists all the pact versions with the specified consumer, provider and consumer version tag.
+
+Send a `DELETE` request to the resource to batch delete all the versions.

data/lib/pact_broker/logging.rb

@@ -1,20 +1,34 @@
-require 'logger'
 require 'pathname'
+require 'semantic_logger'
 
 module PactBroker
-
   module Logging
 
-    # Need to make this configurable based on the calling app!
-    LOG_DIR = Pathname.new(File.join(File.dirname(__FILE__), '..', '..', 'log')).cleanpath
-    LOG_FILE_NAME = "#{ENV['RACK_ENV'] || 'development'}.log"
-
     def self.included(base)
-      base.extend(self)
-    end
-
-    def logger= logger
-      @@logger = logger
+      base.extend self
+      base.extend SemanticLogger::Loggable::ClassMethods
+      base.class_eval do
+        # Returns [SemanticLogger::Logger] class level logger
+        def self.logger
+          require 'pact_broker/configuration'
+          @logger ||= PactBroker.configuration.custom_logger || SemanticLogger[self]
+        end
+
+        # Replace instance class level logger
+        def self.logger=(logger)
+          @logger = logger
+        end
+
+        # Returns [SemanticLogger::Logger] instance level logger
+        def logger
+          @logger ||= self.class.logger
+        end
+
+        # Replace instance level logger
+        def logger=(logger)
+          @logger = logger
+        end
+      end
     end
 
     def log_error e, description = nil
@@ -22,15 +36,6 @@ module PactBroker
       message = "#{description} - #{message}" if description
       logger.error message
     end
-
-    def logger
-      @@logger ||= begin
-        FileUtils.mkdir_p(LOG_DIR)
-        logger = Logger.new(File.join(LOG_DIR, LOG_FILE_NAME))
-        logger.level = Logger::DEBUG
-        logger
-      end
-    end
   end
 
   include Logging