pact_broker 2.58.0 → 2.59.2

data/lib/sequel/plugins/upsert.rb

@@ -0,0 +1,103 @@
+
+module Sequel
+  module Plugins
+    module Upsert
+      def self.configure(model, opts=OPTS)
+        model.instance_exec do
+          @upsert_plugin_identifying_columns = opts.fetch(:identifying_columns)
+        end
+      end
+
+      module ClassMethods
+        attr_reader :upsert_plugin_identifying_columns
+      end
+
+      module InstanceMethods
+        # dirty stateful attribute because we can't pass any opts through to the _insert_dataset method
+        attr_reader :upsert_plugin_upserting
+
+        def upsert(opts = {})
+          @upsert_plugin_upserting = true
+          if postgres? || mysql?
+            save(opts)
+          else
+            manual_upsert(opts)
+          end
+          load_values_from_previously_inserted_object unless id
+          self
+        rescue Sequel::NoExistingObject
+          load_values_from_previously_inserted_object
+        ensure
+          @upsert_plugin_upserting = false
+        end
+
+        private
+
+        def load_values_from_previously_inserted_object
+          set_primary_key_columns_from_previously_inserted_object
+          refresh
+        end
+
+        def set_primary_key_columns_from_previously_inserted_object
+          if !primary_key_columns_are_same_as_identifying_columns
+            existing_record = find_previously_inserted_object
+            upsert_primary_key_columns.each do | column |
+              self.send("#{column}=".to_sym, existing_record[column])
+            end
+          end
+        end
+
+        def find_previously_inserted_object
+          query = self.class.upsert_plugin_identifying_columns.each_with_object({}) do | column_name, q |
+            q[column_name] = values[column_name]
+          end
+          model.where(query).single_record
+        end
+
+        def upsert_primary_key_columns
+          @upsert_primary_key_columns ||= [*primary_key].sort
+        end
+
+        def primary_key_columns_are_same_as_identifying_columns
+          upsert_primary_key_columns == self.class.upsert_plugin_identifying_columns.sort
+        end
+
+        def manual_upsert(opts)
+          # Can use slice when we drop support for Ruby 2.4
+          query = values.select{ |k, _| self.class.upsert_plugin_identifying_columns.include?(k) }
+          existing_record = model.where(query).single_record
+          if existing_record
+            existing_record.update(values)
+          else
+            save(opts)
+          end
+        end
+
+        # naughty override of Sequel private method to
+        # avoid having to rewrite the whole save method logic
+        def _insert_dataset
+          if upsert_plugin_upserting
+            if postgres?
+              super.insert_conflict(update: values, target: self.class.upsert_plugin_identifying_columns)
+            elsif mysql?
+              columns_to_update = values.keys - self.class.upsert_plugin_identifying_columns
+              super.on_duplicate_key_update(*columns_to_update)
+            else
+              super
+            end
+          else
+            super
+          end
+        end
+
+        def mysql?
+          model.db.adapter_scheme.to_s =~ /mysql/
+        end
+
+        def postgres?
+          model.db.adapter_scheme.to_s == "postgres"
+        end
+      end
+    end
+  end
+end

data/pact_broker.gemspec

@@ -3,29 +3,9 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pact_broker/version'
 
-def gem_files
-  if Dir.exist?(".git")
-    `git ls-files`.split($/)
-  else
-    root_path      = File.dirname(__FILE__)
-    all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
-    all_files.reject! { |file| [".", ".."].include?(File.basename(file)) || File.directory?(file)}
-    gitignore_path = File.join(root_path, ".gitignore")
-    gitignore      = File.readlines(gitignore_path)
-    gitignore.map!    { |line| line.chomp.strip }
-    gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
-
-    all_files.reject do |file|
-      gitignore.any? do |ignore|
-        file.start_with?(ignore) ||
-          File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
-          File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
-      end
-    end
-  end
-end
 
 Gem::Specification.new do |gem|
+
   gem.name          = "pact_broker"
   gem.version       = PactBroker::VERSION
   gem.authors       = ["Bethany Skurrie", "Sergei Matheson", "Warner Godfrey"]
@@ -36,7 +16,27 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.2.0'
 
-  gem.files         = gem_files
+  gem.files         = begin
+                        if Dir.exist?(".git")
+                          `git ls-files`.split($/)
+                        else
+                          root_path      = File.dirname(__FILE__)
+                          all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
+                          all_files.reject! { |file| [".", ".."].include?(File.basename(file)) || File.directory?(file)}
+                          gitignore_path = File.join(root_path, ".gitignore")
+                          gitignore      = File.readlines(gitignore_path)
+                          gitignore.map!    { |line| line.chomp.strip }
+                          gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+                          all_files.reject do |file|
+                            gitignore.any? do |ignore|
+                              file.start_with?(ignore) ||
+                                File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+                                File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+                            end
+                          end
+                        end
+                      end
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
@@ -64,23 +64,4 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'table_print', '~> 1.5'
   gem.add_runtime_dependency 'semantic_logger', '~> 4.3'
   gem.add_runtime_dependency 'sanitize', '>= 5.2.1', '~> 5.2'
-
-  gem.add_development_dependency 'pact', '~>1.14'
-  gem.add_development_dependency 'rspec-pact-matchers', '~>0.1'
-  gem.add_development_dependency 'bundler-audit', '~>0.4'
-  gem.add_development_dependency 'sqlite3', '~>1.3'
-  gem.add_development_dependency 'pry-byebug'
-  gem.add_development_dependency 'rake', '~>12.3.3'
-  gem.add_development_dependency 'fakefs', '~>0.4'
-  gem.add_development_dependency 'webmock', '~>2.3'
-  gem.add_development_dependency 'rspec', '~>3.0'
-  gem.add_development_dependency 'rspec-its', '~>1.2'
-  gem.add_development_dependency 'database_cleaner', '~>1.8', '>= 1.8.1'
-  gem.add_development_dependency 'pg', '~>1.2'
-  gem.add_development_dependency 'conventional-changelog', '~>1.3'
-  gem.add_development_dependency 'bump', '~> 0.5'
-  gem.add_development_dependency 'timecop', '~> 0.9'
-  gem.add_development_dependency 'sequel-annotate', '~>1.3'
-  gem.add_development_dependency 'faraday', '~>0.15'
-  gem.add_development_dependency 'docker-api', '~>1.34'
 end

data/public/javascripts/pact.js

@@ -39,10 +39,14 @@ $(document).ready(function() {
     });
 });
 
+function h(string) {
+  return jQuery('<div/>').text(string).html();
+}
+
 function createDeletionConfirmationText(data) {
   return `Do you wish to delete the pact for version ${
-    data.consumerVersionNumber
-  } of ${data.consumerName}?`;
+    h(data.consumerVersionNumber)
+  } of ${h(data.consumerName)}?`;
 }
 
 function confirmDeleteResource(

data/script/docker/db-execute-sql-file.sh

@@ -0,0 +1,2 @@
+docker exec -it pact-broker-postgres psql -U postgres -f /data/${1}
+

data/script/issues/consumer-version-selectors-docs/issue-text.txt

@@ -0,0 +1,11 @@
+Please add code examples for consumer version selectors docs in pact.docs.io
+
+As part of the process of making the Pact docs more user friendly, we'd like to start writing feature documentation once, and providing code examples for each of the languages, rather than everyone having to write the same docs over and over again in each language.
+
+The documentation for the consumer version selectors can be our first opportunity to give this approach a try. I have written the behavioural docs, but we need code examples from each of the languages. Can one of the maintainers of this repository (or any other Pact user of this language!) please add (via direct edit/PR as your permissions allow) code samples for the examples found here https://docs.pact.io/pact_broker/advanced_topics/consumer_version_selectors#examples If you press the EDIT button, it will automatically fork and open a page to edit.
+
+To add a new language, just add a comment with the name of the language (eg. <!-- Java -->) and an example surrounded by "```".
+
+If you would like to link to these docs in your own READMEs, please use the short link `https://docs.pact.io/consumer_version_selectors` (rather than the deep link into the broker section).
+
+Thanks all!

data/script/issues/consumer-version-selectors-docs/issues.txt

@@ -0,0 +1,6 @@
+https://github.com/DiUS/pact-jvm/issues/1149
+https://github.com/pact-foundation/pact-net/issues/251
+https://github.com/pact-foundation/pact-python/issues/149
+https://github.com/pact-foundation/pact-go/issues/136
+https://github.com/pact-foundation/pact-js/issues/467
+https://github.com/pact-foundation/pact-ruby/issues/217

data/script/issues/consumer-version-selectors-docs/raise-issue-in-client-repos.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+repos="pact-jvm pact-net pact-python pact-go pact-js pact"
+
+issue_text_file=$(realpath script/dev/consumer-version-selectors-docs/issue-text.txt)
+
+for repo in $repos; do
+  cd "../${repo}"
+  hub issue create --file "${issue_text_file}" --labels "documentation,help wanted,good first issue"
+done

data/script/prod/redact-data.sql

@@ -1,4 +1,5 @@
 UPDATE pacticipants SET name = 'pacticipant-' || id;
+UPDATE versions SET number = 'version-' || id;
 UPDATE pact_versions SET content = '{}';
 UPDATE verifications SET test_results = null;
 DELETE FROM webhook_executions;

data/script/release-via-github-action.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+set +e
+
+git tag -d release
+git push --delete origin release
+git tag -a release -m "chore: releasing"
+git push origin release

data/script/seed.rb

@@ -58,13 +58,11 @@ TestDataBuilder.new
     url: "http://localhost:9292/verification-published-webhook",
     body: webhook_body.to_json)
   .set_now(Date.today - 101)
-  .tap{ | it |
-    2.times do | i |
-      it.create_pact_with_verification("Foo", i.to_s, "Bar", i.to_s)
-      .create_pact_with_verification("Bar", i.to_s, "Foo", i.to_s)
-      .add_day
-    end
-  }.create_pact_with_hierarchy("Foo", "100", "Bar")
+  .create_pact_with_hierarchy("Foo/Foo", "100", "Bar/Bar")
+  .create_pact_with_hierarchy("Foo", "1", "Bar")
+  .create_pact_with_hierarchy("<script>alert('hello')</script>", "<script>alert(\"version\")</script>", "Bar/Bar")
+  .create_consumer_version_tag("prod")
+  .create_verification(provider_version: "1", tag_names: "prod")
 
 
   # .create_certificate(path: 'spec/fixtures/certificates/self-signed.badssl.com.pem')

data/script/trigger-release.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+# Script to trigger release of gem via the pact-foundation/release-gem action
+# Requires a Github API token with repo scope stored in the
+# environment variable GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES
+
+: "${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES:?Please set environment variable GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}"
+
+if [ -n "$1" ]; then
+  increment="\"${1}\""
+else
+  increment="null"
+fi
+
+repository_slug=$(git remote get-url origin | cut -d':' -f2 | sed 's/\.git//')
+
+output=$(curl -v https://api.github.com/repos/${repository_slug}/dispatches \
+      -H 'Accept: application/vnd.github.everest-preview+json' \
+      -H "Authorization: Bearer $GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES" \
+      -d "{\"event_type\": \"release-triggered\", \"client_payload\": {\"increment\": ${increment}}}" 2>&1)
+
+if  ! echo "${output}" | grep "HTTP\/1.1 204" > /dev/null; then
+  echo "$output" | sed  "s/${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}/********/g"
+  echo "Failed to trigger release"
+  exit 1
+else
+  echo "Release workflow triggered"
+fi
+
+echo "See https://github.com/${repository_slug}/actions?query=workflow%3A%22Release+gem%22"

data/spec/features/get_versions_spec.rb

@@ -1,14 +1,12 @@
 require 'spec/support/test_data_builder'
 
 describe "Get versions" do
-
   let(:path) { "/pacticipants/Consumer/versions" }
   let(:last_response_body) { JSON.parse(subject.body, symbolize_names: true) }
 
-  subject { get path; last_response }
+  subject { get(path) }
 
   context "when the pacticipant exists" do
-
     before do
       TestDataBuilder.new
         .create_consumer("Consumer")
@@ -23,14 +21,11 @@ describe "Get versions" do
     it "returns a list of links to the versions" do
       expect(last_response_body[:_links][:"versions"].size).to eq 2
     end
-
   end
 
   context "when the pacticipant does not exist" do
-
     it "returns a 404 response" do
       expect(subject).to be_a_404_response
     end
-
   end
 end

data/spec/lib/pact_broker/api/decorators/version_decorator_spec.rb

@@ -51,6 +51,10 @@ module PactBroker
           expect(subject[:_embedded][:tags].first[:name]).to eq "prod"
         end
 
+        it "includes the timestamps" do
+          expect(subject[:createdAt]).to_not be nil
+        end
+
         it "includes a list of sorted pacts" do
           expect(subject[:_links][:'pb:pact-versions']).to be_instance_of(Array)
           expect(subject[:_links][:'pb:pact-versions'].first[:href]).to include ("1.2.3")

data/spec/lib/pact_broker/api/pact_broker_urls_spec.rb

@@ -30,7 +30,7 @@ module PactBroker
       let(:version) do
         double('version',
           pacticipant: consumer,
-          number: "2")
+          number: "2/4")
       end
 
       matcher :match_route_in_api do |api|
@@ -136,7 +136,7 @@ module PactBroker
       describe "matrix_for_pacticipant_version_url" do
         subject { PactBrokerUrls.matrix_for_pacticipant_version_url(version, base_url) }
 
-        it { is_expected.to eq "http://example.org/matrix?q[][pacticipant]=Foo%2FFoo&q[][version]=2&latestby=cvpv" }
+        it { is_expected.to eq "http://example.org/matrix?q[][pacticipant]=Foo%2FFoo&q[][version]=2%2F4&latestby=cvpv" }
       end
 
       describe "matrix_badge_url" do

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

@@ -23,22 +23,26 @@ module PactBroker
           Timecop.return
         end
 
-        let(:consumer) { double('consumer', name: 'Consumer')}
-        let(:provider) { double('provider', name: 'Provider')}
+        let(:consumer_name) { 'Consumer' }
+        let(:provider_name) { 'Provider' }
+        let(:consumer_version_number) { '1.2.3' }
+        let(:consumer) { double('consumer', name: consumer_name) }
+        let(:provider) { double('provider', name: provider_name) }
         let(:consumer_version) { double('consumer version') }
         let(:created_at) { DateTime.new(2014, 02, 27) }
         let(:json_content) { load_fixture('renderer_pact.json') }
         let(:pact) do
           double('pact',
             json_content: json_content,
-            consumer_version_number: '1.2.3',
+            consumer_version_number: consumer_version_number,
             consumer: consumer,
             provider: provider,
-            consumer_version_tag_names: ['prod', 'master'],
+            consumer_version_tag_names: consumer_version_tag_names,
             created_at: created_at,
             consumer_version: consumer_version
             )
         end
+        let(:consumer_version_tag_names) { ['prod', 'master'] }
         let(:pact_url) { '/pact/url' }
         let(:matrix_url) { '/matrix/url' }
         let(:options) do
@@ -49,7 +53,7 @@ module PactBroker
         end
         let(:logger) { double('logger').as_null_object }
 
-        subject { HtmlPactRenderer.call pact, options }
+        subject { HtmlPactRenderer.call(pact, options) }
 
         describe ".call" do
           it "renders the pact as HTML" do
@@ -69,7 +73,7 @@ module PactBroker
           end
 
           it "renders the badge image" do
-            expect(subject).to include "<img src='http://badge'/>"
+            expect(subject).to include "<img src=\"http://badge\"/>"
           end
 
           it "renders a text area with the badge markdown" do
@@ -81,6 +85,20 @@ module PactBroker
             expect(subject).to include matrix_url
           end
 
+          context "with dodgey data" do
+            let(:consumer_name) { '<script>alert("consumer");</script>' }
+            let(:provider_name) { '<script>alert("provider");</script>' }
+            let(:consumer_version_number) { '<script>alert("version");</script>' }
+            let(:consumer_version_tag_names) { ['<script>alert("tag");</script>'] }
+
+            it "does not contain the literal <script> anywhere except the badge markdown" do
+              expect(subject).to_not include consumer_version_number
+              expect(subject.scan(consumer_name).count).to eq 1
+              expect(subject.scan(provider_name).count).to eq 1
+              expect(subject).to include '[![<script>alert("consumer");</script>/<script>alert("provider");</script> Pact Status](http://badge)]'
+            end
+          end
+
           context "when enable_public_badge_access is false" do
             before do
               PactBroker.configuration.enable_public_badge_access = false

data/spec/lib/pact_broker/api/resources/all_webhooks_spec.rb

@@ -106,7 +106,7 @@ module PactBroker::Api
 
           it "generates the JSON response body" do
             expect(Decorators::WebhookDecorator).to receive(:new).with(saved_webhook).and_return(webhook_decorator)
-            expect(webhook_decorator).to receive(:to_json).with(user_options: { base_url: 'http://example.org' })
+            expect(webhook_decorator).to receive(:to_json).with(user_options: hash_including({ base_url: 'http://example.org' }))
             subject
           end