chore: update developer setup instructions

Author: bethesque

DEVELOPER_SETUP.md

@@ -2,35 +2,48 @@
 
 ## 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.
+
+```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
 

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,24 @@ RUN apk update \
       "mariadb-dev>=10.3" \
     && rm -rf /var/cache/apk/*
 
-WORKDIR /app
+RUN apk add --no-cache openssl
+
+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
+
 CMD []

config.ru

@@ -1,15 +1,36 @@
-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 'pg' # for postgres
+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

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:

docker-compose-test-mysql.yml

@@ -0,0 +1,33 @@
+# This doesn't work yet
+version: "3"
+
+services:
+  tests:
+    build: .
+    command: sh -c "sleep 10 && bundle exec rake db:prepare:test && bundle exec rspec spec/lib/pact_broker/domain/version_spec.rb"
+    depends_on:
+      - mysql
+    environment:
+      RACK_ENV: test
+      DATABASE_ADAPTER: docker_compose_mysql
+      PACT_BROKER_DATABASE_USERNAME: pact_broker
+      PACT_BROKER_DATABASE_PASSWORD: pact_broker
+      PACT_BROKER_DATABASE_HOST: pact_broker
+      PACT_BROKER_DATABASE_NAME: pact_broker
+      PACT_BROKER_BASIC_AUTH_USERNAME: pact_broker
+      PACT_BROKER_BASIC_AUTH_PASSWORD: pact_broker
+      PACT_BROKER_PORT: "9292"
+    volumes:
+        - ${PWD}:/app
+
+  mysql:
+    image: mysql:5.7.28
+    command: --default-authentication-plugin=mysql_native_password
+    # restart: always
+    environment:
+      MYSQL_ROOT_PASSWORD: pact_broker
+      MYSQL_DATABASE: pact_broker
+      MYSQL_USER: pact_broker
+      MYSQL_PASSWORD: pact_broker
+    ports:
+      - "3306:3306"