pact_broker 2.58.0 → 2.58.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9b3ca0a02cb3eb39138704d804ed6a9997aa044cf0729059175d24acf02794f
-  data.tar.gz: 619a828a1ab0f7b1d5677525c5d52b82ec785455a19c0603ce18a3981be81eb7
+  metadata.gz: d2dc3ce078c6b984d9e17ec748d50487434740c1b4cc828ffe93c222bb64709e
+  data.tar.gz: 20b4316a8e3ecc24902b82e5c600c6d2bb9b3e861e6574317c2704ce952d7f26
 SHA512:
-  metadata.gz: 80e5a6272e05b35ff82a5a08fc26cb8acc2729d64b969f3764dbd1bb6be4ed168722d884ca635fe85dc58946c085dc60d65b1d4c95cc0fc8d9437a9f8aaa3356
-  data.tar.gz: d094ef10bf315a635afd6c6ef52148ac25c2e03afafcbb5e53b411c4ff2e676fd01d9db45414be4354054396547ae182b4991beadf6e6f0de63045cb38b2ccde
+  metadata.gz: bed27eae0215a6d2f499bfa99b9717c0085c825cf8e7b721a66c27d91d4d2ecac56aedeba2e42989399d50a5d45a938b1c4ac9cede35ce70956bbb0d3de0d6e3
+  data.tar.gz: f5b82be7ede7645c77182541a99d9c69ff7047bd7d6c7ddb7e01870ed12ae859ee7a08f8b8a8cbbc66c6e407adef34ab136674258c0664c7b2fba0e899509814

data/.github/workflows/release_gem.yml

@@ -0,0 +1,25 @@
+name: Release gem
+
+on:
+  repository_dispatch:
+    types:
+      - release-triggered
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - uses: pact-foundation/release-gem@v0.0.11
+      env:
+        GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_API_KEY }}'
+        GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+        INCREMENT: '${{ github.event.client_payload.increment }}'
+    # - name: Trigger release of pact-cli Docker image
+    #   uses: peter-evans/repository-dispatch@v1
+    #   with:
+    #     token: ${{ secrets.GHTOKENFORPACTCLIRELEASE }}
+    #     repository: pact-foundation/pact-ruby-cli
+    #     event-type: gem-released

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  # Only supporting 2.4 until we upgrade the DiUS pact broker base image
   - 2.4.1
   - 2.5
 services:
@@ -11,11 +12,10 @@ env:
   global:
     - CC_TEST_REPORTER_ID=dc2c30b67c9e2a5309e1aef699c30fdab55ba4f0e4f1beac029ba93e293835db
     - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
-    - INSTALL_MYSQL=true
   matrix:
     - DATABASE_ADAPTER=default RUBYOPT="-W0"
-    - DATABASE_ADAPTER=postgres RUBYOPT="-W0"
-    - DATABASE_ADAPTER=mysql RUBYOPT="-W0"
+    - DATABASE_ADAPTER=postgres RUBYOPT="-W0" INSTALL_PG=true
+    - DATABASE_ADAPTER=mysql RUBYOPT="-W0" INSTALL_MYSQL=true
 before_script:
   - cp config/database.travis.yml config/database.yml
   - psql -U postgres -c "CREATE DATABASE pact_broker;"
@@ -23,6 +23,8 @@ before_script:
   - mysql -e "GRANT ALL ON pact_broker.* TO 'travis'@'%';"
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
+before_install:
+  - bundle config set without 'development'
 script:
   - bundle exec rake
   - if [ "$DATABASE_ADAPTER" == "postgres" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT || true; fi

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+<a name="v2.58.2"></a>
+### v2.58.2 (2020-07-17)
+
+#### Bug Fixes
+
+* update CSP to allow badges to be loaded from shields.io	 ([a87e5274](/../../commit/a87e5274))
+* add missing URL encoding in various URLs	 ([276094bc](/../../commit/276094bc))
+
 <a name="v2.58.0"></a>
 ### v2.58.0 (2020-06-19)
 

data/DEVELOPER_SETUP.md

@@ -2,36 +2,66 @@
 
 ## Preparation
 
-### With virtual battery
+### With Docker Compose
+
+The following command runs the application from the source code and binds it to port 9292 of your host. It mounts the source code as a volume, so changes to the code will be applied if you stop and start the containers (the app code doesn't hot reload however).
+
+```sh
+docker-compose -f docker-compose-dev-postgres.yml up --build
+```
+
+### With Docker
+
+This allows you to open a shell to a development environment where you can run the tests and rake tasts.
 
 * Build an initial local image with Docker
-  ```sh
-  docker build --rm -t pact_broker:dev .
-  ```
+
+    ```sh
+    docker build --rm -t pact_broker:dev .
+    ```
 
 * Spin up a container with mounted volume and open an interactive shell session
-  ```sh
-  docker run --rm -v $(PWD):/app -w /app -it pact_broker:dev bash
-  ```
+
+    ```sh
+    docker run --rm -v $(PWD):/home -w /home -it pact_broker:dev bash
+    ```
+
+Remember to rebuild the image if you change any of the gems or gem versions.
 
 ### With native install
 
 * You will need to install Ruby 2.5, and preferably a ruby version manager. I recommend using [chruby][chruby] and [ruby-install][ruby-install].
 * Install bundler (the Ruby gem dependency manager) `gem install bundler`
 * Check out the pact_broker repository and cd into it.
-* Run `bundle install`. If you have not got mysql or postgres installed locally, comment out the `mysql2` and `pg` development dependency lines in `pact_broker.gemspec`, as these are only really required on Travis.
+* Run `bundle install`. If you have any gem conflict issues, run `bundle update`.
+
+To make the barrier to entry as low as possible, the mysql2 and pg gems are not installed by default, as they require mysql and postgres to be installed on your local machine. If you want to install them, set `INSTALL_MYSQL=true` and/or `INSTALL_PG=true` before running `bundle install`.
 
 ## Running a local application
 
-* Run `bundle exec rake pact_broker:dev:setup`. This will create an example application that you can run locally, that uses the local source code.
-* To run the example:
-  ```sh
-  cd dev
-  bundle install
-  bundle exec rackup
-  ```
-* The application will be available on `http://localhost:9292`
+* Install Ruby and the gems as per the instructions above.
+* Run `bundle exec rackup`.
+* The application will be available on `http://localhost:9292`. It uses a sqlite database that is stored in the `./tmp` directory.
+
+You can set the `PACT_BROKER_DATABASE_URL` environment variable to use a postgres/mysql database using the format `driver://username:password@host:port/database` eg. `postgres://pact_broker:password@localhost/pact_broker`. Ensure you have set `INSTALL_MYSQL=true` or `INSTALL_PG=true` and run `bundle install` to make sure the required gems are present.
+
+## Running the tests with postgres and mysql
+
+```
+docker-compose -f docker-compose-test.yml up --build --remove-orphans
+
+# in separate console window...
+docker-compose -f docker-compose-test.yml run --rm postgres-tests bash
+
+# in separate console window...
+docker-compose -f docker-compose-test.yml run --rm mysql-tests bash
+
+# inside the tests container
+bundle exec rake
 
+# if you don't want to run the whole rake test suite, init the db first
+/home/init-db.sh
+```
 ## Running the tests
 
 * To run everything (specs, pact verifications, vulnerability scan...):

data/Dockerfile

@@ -1,6 +1,9 @@
 FROM ruby:2.5.3-alpine
 
+WORKDIR /home
+
 ENV INSTALL_MYSQL=true
+ENV INSTALL_PG=true
 RUN apk update \
     && apk --no-cache add \
       "build-base>=0.5" \
@@ -14,11 +17,29 @@ RUN apk update \
       "mariadb-dev>=10.3" \
     && rm -rf /var/cache/apk/*
 
-WORKDIR /app
+RUN apk add --no-cache openssl less
+
+ENV DOCKERIZE_VERSION v0.6.1
+RUN wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
+    && tar -C /usr/local/bin -xzvf dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
+    && rm dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz
+
 
-COPY . ./
+COPY Gemfile /home/Gemfile
+COPY pact_broker.gemspec /home/pact_broker.gemspec
+COPY lib/pact_broker/version.rb /home/lib/pact_broker/version.rb
+COPY .gitignore /home/.gitignore
 
 RUN gem install bundler -v '~>2.0.0' \
     && bundle install --jobs 3 --retry 3
 
+RUN echo '#!/bin/sh' >> /home/start.sh
+RUN echo 'bundle exec rackup -o 0.0.0.0 -p 9292' >> /home/start.sh
+RUN chmod +x /home/start.sh
+
+RUN echo '#!/bin/sh' >> /home/init-db.sh
+RUN echo 'bundle exec rake db:prepare:test' >> /home/init-db.sh
+RUN chmod +x /home/init-db.sh
+
+ENTRYPOINT bash
 CMD []

data/Gemfile

@@ -2,8 +2,35 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'simplecov', :require => false, :group => :test
+gem 'rake', '~>12.3.3'
+gem 'sqlite3', '~>1.3'
+gem 'conventional-changelog', '~>1.3'
+gem 'bump', '~> 0.5'
+
+group :development do
+  gem 'pry-byebug'
+  gem 'sequel-annotate', '~>1.3'
+end
+
+group :test do
+  gem 'simplecov', :require => false
+  gem 'pact', '~>1.14'
+  gem 'rspec-pact-matchers', '~>0.1'
+  gem 'bundler-audit', '~>0.4'
+  gem 'fakefs', '~>0.4'
+  gem 'webmock', '~>2.3'
+  gem 'rspec', '~>3.0'
+  gem 'rspec-its', '~>1.2'
+  gem 'database_cleaner', '~>1.8', '>= 1.8.1'
+  gem 'timecop', '~> 0.9'
+  gem 'faraday', '~>0.15'
+  gem 'docker-api', '~>1.34'
+end
 
 if ENV['INSTALL_MYSQL'] == "true"
   gem 'mysql2', '~>0.5'
-end
+end
+
+if ENV['INSTALL_PG'] == 'true'
+  gem 'pg', '~>1.2'
+end

data/config.ru

@@ -1,15 +1,35 @@
-require File.dirname(__FILE__) + '/config/boot'
-require 'db'
-require 'pact_broker/api'
-require 'rack/hal_browser'
-require 'pact_broker/ui/controllers/index'
+require 'fileutils'
+require 'logger'
+require 'sequel'
+require 'pact_broker'
 
+FileUtils.mkdir_p('tmp') unless ENV['PACT_BROKER_DATABASE_URL']
 
-use Rack::Static, :urls => ["/stylesheets", "/css", "/fonts", "/js", "/javascripts", "/images"], :root => "public"
-use Rack::HalBrowser::Redirect, :exclude => ['/diagnostic', '/trace','/index']
+DATABASE_URL = ENV['PACT_BROKER_DATABASE_URL'] || 'sqlite://tmp/pact_broker_database.sqlite3'
+DB_OPTIONS = { encoding: 'utf8', sql_log_level: :debug }
 
-run Rack::URLMap.new(
-  '/ui/relationships' => PactBroker::UI::Controllers::Index,
-  '/network-graph' => Rack::File.new("#{File.dirname(__FILE__)}/public/Network Graph REA.html"),
-  '/' => PactBroker::API,
-)
+ENV['TZ'] = 'Australia/Melbourne'
+
+SemanticLogger.add_appender(io: $stderr)
+SemanticLogger.default_level = :info
+
+app = PactBroker::App.new do | config |
+  # config.logger.level = ::Logger::INFO
+  config.auto_migrate_db = true
+  config.enable_public_badge_access = true
+  config.order_versions_by_date = true
+  config.allow_missing_migration_files = true
+  config.base_equality_only_on_content_that_affects_verification_results = true
+  config.badge_provider_mode = :redirect
+
+  config.webhook_retry_schedule = [3, 3, 3]
+  config.webhook_host_whitelist = [/.*/, "10.0.0.0/8"]
+  config.webhook_scheme_whitelist = ['http', 'https']
+  config.webhook_http_method_whitelist = ['GET', 'POST']
+  #config.base_url = ENV['PACT_BROKER_BASE_URL']
+
+  database_logger = PactBroker::DB::LogQuietener.new(config.logger)
+  config.database_connection = Sequel.connect(DATABASE_URL, DB_OPTIONS.merge(logger: database_logger))
+end
+
+run app

data/config/database.yml

@@ -18,6 +18,13 @@ test:
     password: postgres
     host: localhost
     port: "5433"
+  docker_compose_postgres:
+    adapter: postgres
+    database: postgres
+    username: postgres
+    password: postgres
+    host: postgres
+    port: "5432"
   mysql:
     <<: *default
     adapter: mysql2

data/docker-compose-dev-postgres.yml

@@ -0,0 +1,35 @@
+version: "3"
+
+services:
+  postgres:
+    image: postgres
+    healthcheck:
+      test: psql postgres --command "select 1" -U postgres
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: postgres
+    volumes:
+      - postgres-volume:/var/lib/postgresql/data
+
+  pact-broker:
+    build: .
+    ports:
+      - "9292:9292"
+    depends_on:
+      - postgres
+    environment:
+      DATABASE_URL: postgres://postgres:postgres@postgres/postgres
+      PACT_BROKER_HIDE_PACTFLOW_MESSAGES: 'true'
+    command: dockerize -wait tcp://postgres:5432 /home/start.sh
+    volumes:
+      - ./lib:/home/lib
+      - ./db:/home/db
+      - ./config.ru:/home/config.ru
+      - ./tasks:/home/tasks
+      - ./Rakefile:/home/Rakefile
+
+volumes:
+  postgres-volume:

data/docker-compose-test.yml

@@ -0,0 +1,100 @@
+# This doesn't work yet
+version: "3"
+
+services:
+  postgres:
+    image: postgres
+    healthcheck:
+      test: psql postgres --command "select 1" -U postgres
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: postgres
+
+  init-postgres:
+    build: .
+    depends_on:
+      - postgres
+    environment:
+      DATABASE_ADAPTER: docker_compose_postgres
+      PACT_BROKER_HIDE_PACTFLOW_MESSAGES: 'true'
+      INSTALL_PG: 'true'
+    volumes:
+      - ./lib:/home/lib
+      - ./db:/home/db
+      - ./tasks:/home/tasks
+      - ./Rakefile:/home/Rakefile
+      - ./config:/home/config
+    command: dockerize --wait tcp://postgres:5432 /home/init-db.sh
+
+  postgres-tests:
+    build: .
+    depends_on:
+      - postgres
+    environment:
+      DATABASE_ADAPTER: docker_compose_postgres
+      PACT_BROKER_HIDE_PACTFLOW_MESSAGES: 'true'
+      INSTALL_PG: 'true'
+    volumes:
+      - ./lib:/home/lib
+      - ./spec:/home/spec
+      - ./db:/home/db
+      - ./config.ru:/home/config.ru
+      - ./tasks:/home/tasks
+      - ./Rakefile:/home/Rakefile
+      - ./config:/home/config
+      - ./.rspec:/home/.rspec
+      - ./.rubocop:/home/.rubocop
+      - ./.gitignore:/home/.gitignore
+      - ./public:/home/public
+
+  mysql:
+    image: mysql:5.7.28
+    command: --default-authentication-plugin=mysql_native_password
+    environment:
+      MYSQL_ROOT_PASSWORD: pact_broker
+      MYSQL_DATABASE: pact_broker
+      MYSQL_USER: pact_broker
+      MYSQL_PASSWORD: pact_broker
+    ports:
+      - "3306:3306"
+
+  init-mysql:
+    build: .
+    depends_on:
+      - mysql
+    environment:
+      DATABASE_ADAPTER: docker_compose_mysql
+      PACT_BROKER_HIDE_PACTFLOW_MESSAGES: 'true'
+      INSTALL_MYSQL: 'true'
+    volumes:
+      - ./lib:/home/lib
+      - ./db:/home/db
+      - ./tasks:/home/tasks
+      - ./Rakefile:/home/Rakefile
+      - ./config:/home/config
+    command: dockerize --wait tcp://mysql:3306 /home/init-db.sh
+
+  mysql-tests:
+    build: .
+    depends_on:
+      - mysql
+    environment:
+      DATABASE_ADAPTER: docker_compose_mysql
+      PACT_BROKER_HIDE_PACTFLOW_MESSAGES: 'true'
+      INSTALL_MYSQL: 'true'
+    volumes:
+      - ./lib:/home/lib
+      - ./spec:/home/spec
+      - ./db:/home/db
+      - ./config.ru:/home/config.ru
+      - ./tasks:/home/tasks
+      - ./Rakefile:/home/Rakefile
+      - ./config:/home/config
+      - ./.rspec:/home/.rspec
+      - ./.rubocop:/home/.rubocop
+      - ./.gitignore:/home/.gitignore
+      - ./public:/home/public
+

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

@@ -7,7 +7,7 @@ module PactBroker
 
         def initialize base_url, resource_url, env, options = {}
           @base_url = self[:base_url] = base_url
-          @resource_url = self[:resource_url]= resource_url
+          @resource_url = self[:resource_url] = resource_url
           @resource_title = self[:resource_title] = options[:resource_title]
           @env = self[:env] = env
           merge!(options)