pact-retreaty 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Yjk5MTk0NWQ5ZTY2YmUwZWRhYTJmYjVkNTU2NDg5ZjAwOWQ0MmU0ZA==
+  data.tar.gz: !binary |-
+    ODVlOWEzNjQyOGNmYWY0NDMwOTk0OTE0NzgxZjE5NjZhODJiMDZmMw==
+SHA512:
+  metadata.gz: !binary |-
+    ZmFhYjBlMmRiNTBlMGI4NTFhZWEyYjc4MWUzODNlZDUzMThjYTUzZWZiMjQ5
+    NjllMjAxODk0ZjAxNmNhM2U4ZTkxZTIzNjA1MDEyYzQyMzExMzkwNjhjYWM2
+    NTM0ZTFjYTBjOTIyNDlhMjU0MGJhMTAwODQwYzc2OTU0MTk1Y2I=
+  data.tar.gz: !binary |-
+    ZGYzZGEyMDVhMjY2MWNkNjAwNWZiYzVlMGRhMmRhNTRmYzdmYzYxYjEzNjA1
+    ZWZiNTVhNWEzNGM4ZjUxOWI2YTI5NTUxMDQyNzFmNjExMWQ1YjQ0YTcwZTE2
+    YWUyNTc2OTA2YzJhN2U1OGI5MjJmM2U3YTEzNjYxY2ZlYjcwMjU=

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+defaults.yml
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pact-retreaty.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Fairfax Media
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# Pact::Retreaty
+
+[Pact](http://github.com/pact/pact) allows the recording of contracts between services and their consumers, but is agnostic about how those contracts are managed. [Retreaty](http://github.com/fairfacemedia/pact-retreaty) extends on that, to provides a ultra light mechanism for pushing these contracts to S3 from a consumer, and later pulling them down to a provider for verification.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pact-retreaty'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pact-retreaty
+
+## Usage
+
+### Consumer-side
+
+Once you've got Pact installed and working, copy this rake task into your Rakefile:
+
+```ruby
+namespace :pact do
+  desc "Upload pact contracts to S3"
+  task :upload do
+    require_relative 'spec/service_providers/pact_helper'
+    require 'pact/retreaty'
+
+    Pact::Retreaty::Consumer.create do |consumer|
+      consumer.name = 'ds-spockly'
+      consumer.version = Spockly::VERSION
+      consumer.source_glob = "#{Pact.configuration.pact_dir}/*.json"
+      consumer.vcs_id = -> { ENV['CI'] ? ENV['CI_BRANCH'] : current_vcs_id }
+      consumer.s3_bucket = ENV['PACT_S3_BUCKET']
+      consumer.s3_region = ENV['PACT_S3_REGION']
+      consumer.access_key_id = ENV['PACT_S3_KEY_ID']
+      consumer.access_secret = ENV['PACT_S3_SECRET']
+    end.upload_pacts
+  end
+end
+```
+
+Replace the configuration with what makes sense in your consumer - the name and version associated with the current consumer, and an optional lambda to identify the applicable branch from you VCS (Retreaty defaults to Git, and to the branch of the repo it's being run in.)
+
+(It's assumed that this task will usually be running on your CI server, and that you'll set the S3 credentials via environment variables - but you can tweak that behaviour here if you need to.)
+
+When run, the task will load your Pact configuration from your pact_helper file and try to upload all the json files it finds in spec/pacts to the bucket defined. The path inside the bucket will look something like (based on the configuration above, assuming that Spockly::VERSION is '1.0.0' the current branch is 'pact-testing' and the pact is between "Spockly Gem" and "Spock Service"):
+
+```
+/ds-spockly/1.0.0/pact-testing/spockly_gem-spock_service.json
+```
+
+### Provider-side
+
+The configuration on the provider side looks very similar to the consumer side. Once you've got Pact running with a local contract file, change your pact_helper file to look something like this:
+
+```ruby
+require 'pact/retreaty'
+
+Pact.service_provider "Spock Service" do
+  honours_pact_with 'Spockly Gem' do
+    if ENV['CI'] # CI server
+      pact_uri = Pact::Retreaty::Consumer.create do |consumer|
+        consumer.name = 'ds-spockly'
+        consumer.version = '1.0.0'
+        consumer.pactfile = 'spockly_gem-spock_service.json'
+        consumer.vcs_fallbacks = -> { [ENV['CI_BRANCH'], :vcs_id, 'develop'] }
+        consumer.s3_bucket = ENV['PACT_S3_BUCKET']
+        consumer.s3_region = ENV['PACT_S3_REGION']
+        consumer.access_key_id = ENV['PACT_S3_KEY_ID']
+        consumer.access_secret = ENV['PACT_S3_SECRET']
+      end.best_pact_uri
+    else # local
+      pact_uri '../ds-spockly/spec/pacts/spockly_gem-spock_service.json'
+    end
+  end
+end
+```
+
+(In the example above, we're setting the pact_uri based on whether we're running on a CI server - if we're not, we fall back to a local directory as usual.)
+
+The name, version and S3 configurations are identical to the consumer side - the only provider-specific configuration is that we help Retreaty find the right contract by specifying the filename, and we provide a series of options to find the right branch. This deserves some explanation...
+
+###VCS Fallbacks
+
+Over the lifetime of our Pact testing, we'll want to verify various versions of the consumer against a variety of versions of the provider. We have a few mechanisms in place to facilitate this; on the consumer side we track both the 'version' and the 'VCS id' (version control id - usually a branch name) of the current build, and on the provider side we keep a list of options (in order of decreasing specificity) for which of the consumer's VCS ids we'd like to test against. Tracking the branch of the consumer protects us while we're modifying it, so that new versions of the contract don't overwrite the existing stable one - it also frees us from having to change the version for small bug fixes, or during the code review process.
+
+On the consumer side, we can branch in lockstep with the consumer, and then have pact verification before we submit our changes for review - but we can pick a default vcs id ('develop', in the above example) and always fall back to that version of the consumer as a verification target. (Retreaty will try each option in the fallbacks list until it's able to identify and stored contract in S3.)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fairfaxmedia/pact-retreaty.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,26 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'pact/retreaty'
+  require 'pry'
+
+  defaults_path = File.expand_path('../defaults.yml', __FILE__)
+  defaults = File.exists?(defaults_path) ? YAML.load_file(defaults_path) : {}
+
+  Pact::Retreaty.define_singleton_method(:default_consumer) {
+    Pact::Retreaty::Consumer.create do |consumer|
+      defaults.each { |k, v| consumer.send("#{k}=", v) }
+    end #.best_pact_uri
+  }
+
+  ARGV.clear
+  IRB.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pact/retreaty"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pact/retreaty.rb

@@ -0,0 +1,7 @@
+require "pact/retreaty/version"
+require 'pact/retreaty/consumer'
+
+module Pact
+  module Retreaty
+  end
+end

data/lib/pact/retreaty/consumer.rb

@@ -0,0 +1,98 @@
+require 'aws-sdk'
+require 'pact'
+
+module Pact
+  module Retreaty
+    class Consumer
+      COMMON_CONFIG = [:name, :version, :s3_bucket, :s3_region, :access_key_id, :access_secret]
+      UPLOAD_CONFIG = [:vcs_id]
+      DOWNLOAD_CONFIG = [:pactfile, :vcs_fallbacks]
+      attr_accessor *(COMMON_CONFIG + UPLOAD_CONFIG + DOWNLOAD_CONFIG)
+
+      def self.create(options = {})
+        options[:vcs_id] ||= -> { current_vcs_id }
+        new(options).tap { |consumer| yield consumer if block_given? }
+      end
+
+      def upload_pacts
+        verify_config!(:upload)
+
+        spec_files.each do |path|
+          key = upload_key_for_path(path)
+          puts "uploading #{key}"
+          s3_client.put_object(bucket: s3_bucket, key: key, body: File.read(path))
+        end
+      end
+
+      def best_pact_uri
+        verify_config!(:download)
+
+        catch(:uri_found) do
+          realised_vcs_fallbacks.each { |vcs_id| uri_for_pactfile_and_vcs_id(vcs_id) }
+          fail("Retreaty couldn't find a suitable contract for version #{version} of #{name}, under #{realised_vcs_fallbacks.join(' or ')}")
+        end
+      end
+
+      private
+
+      def initialize(options = {})
+        options.each do |k, v|
+          send("#{k}=", v)
+        end
+      end
+
+      def uri_for_pactfile_and_vcs_id(vcs_id)
+        summary = s3_summary_for_vcs_id(vcs_id)
+        throw(:uri_found, summary.presigned_url(:get)) if summary.exists?
+      end
+
+      def s3_summary_for_vcs_id(vcs_id)
+        Aws::S3::ObjectSummary.new(bucket_name: s3_bucket, key: s3_path(pactfile, vcs_id), client: s3_client)
+      end
+
+      def verify_config!(context)
+        required_fields = COMMON_CONFIG + (context == :download ? DOWNLOAD_CONFIG : UPLOAD_CONFIG)
+        unless required_fields.select {|field| send(field).nil? }.empty?
+          fail("Retreaty requires configuration for #{required_fields.join(', ')} to #{context}")
+        end
+      end
+
+      def spec_files
+        Dir.glob(File.join(pact_dir, '*.json'))
+      end
+
+      def upload_key_for_path(path)
+        s3_path(File.basename(path), upload_vcs_id)
+      end
+
+      def upload_vcs_id
+        instance_exec(&vcs_id)
+      end
+
+      def s3_path(filename, vcs_id)
+        [name, version, vcs_id, filename].compact.join('/')
+      end
+
+      def realised_vcs_fallbacks
+        vcs_fallbacks.map {|id| id == :vcs_id ? current_vcs_id : id }
+      end
+
+      # TODO - handle cases where git isn't present - configure with a proc?
+      def current_vcs_id #current_branch
+        `git symbolic-ref -q --short HEAD`.strip
+      end
+
+      def pact_dir
+        Pact.configuration.pact_dir
+      end
+
+      def s3_client
+        @client ||= Aws::S3::Client.new(region: s3_region, credentials: s3_credentials)
+      end
+
+      def s3_credentials
+        Aws::Credentials.new(access_key_id, access_secret)
+      end
+    end
+  end
+end

data/lib/pact/retreaty/version.rb

@@ -0,0 +1,5 @@
+module Pact
+  module Retreaty
+    VERSION = "0.2.0"
+  end
+end

data/pact-retreaty.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pact/retreaty/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pact-retreaty"
+  spec.version       = Pact::Retreaty::VERSION
+  spec.authors       = ["Simon Hildebrandt"]
+  spec.email         = ["simonhildebrandt@fairfaxmedia.com.au"]
+
+  spec.summary       = %q{Easily share pacts via S3.}
+  spec.description   = %q{Easily share pacts via S3.}
+  spec.homepage      = "https://github.com/fairfaxmedia/pact-retreaty"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('aws-sdk', '~> 2')
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: pact-retreaty
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Simon Hildebrandt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily share pacts via S3.
+email:
+- simonhildebrandt@fairfaxmedia.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pact/retreaty.rb
+- lib/pact/retreaty/consumer.rb
+- lib/pact/retreaty/version.rb
+- pact-retreaty.gemspec
+homepage: https://github.com/fairfaxmedia/pact-retreaty
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Easily share pacts via S3.
+test_files: []
+has_rdoc: