roo_on_rails 1.10.0 → 1.11.0

data/.circleci/config.yml.erb

@@ -0,0 +1,86 @@
+# To update the build configuration, edit the "builds" array below and run:
+# erb .circleci/config.yml.erb > .circleci/config.yml
+<%
+  builds = [
+		['2.2.6', 'rails_3'],
+		['2.3.3', 'rails_3'],
+		['2.2.6', 'rails_4'],
+		['2.3.3', 'rails_4'],
+		['2.4.0', 'rails_4'],
+		['2.2.6', 'rails_5'],
+		['2.3.3', 'rails_5'],
+		['2.4.0', 'rails_5'],
+		['2.2.6', 'rails_5_1'],
+		['2.3.3', 'rails_5_1'],
+		['2.4.0', 'rails_5_1'],
+  ]
+%>
+version: 2
+jobs:
+<% builds.each do |ruby,variant| %>
+  build_<%= ruby %>_<%= variant %>:
+    docker:
+      - image: deliveroo/multiruby
+      - image: postgres:9.6-alpine
+        environment:
+          PGDATA: /dev/shm/pgdata
+      - image: redis:3-alpine
+    steps:
+      - checkout
+
+      - run:
+          name: Setup RAM disk
+          command: |
+            rm -rf ~/project/tmp ;
+            mkdir /dev/shm/tmp ;
+            ln -s /dev/shm/tmp ~/project/tmp
+
+      - run:
+          name: Select build variant (Ruby <%= ruby %>, <%= variant %>)
+          command: |
+            rbenv local <%= ruby %> ;
+            gem install bundler ;
+            bundle config --local gemfile $PWD/gemfiles/<%= variant %>.gemfile
+
+      - restore_cache:
+          keys: 
+            - v2-bundle-<%= ruby %>-<%= variant %>-{{ .Branch }}
+            - v2-bundle-<%= ruby %>-<%= variant %>
+            - v2-bundle-<%= ruby %>
+
+      - run: 
+          name: Install dependencies
+          command: |
+            bundle install --jobs=3 --retry=3 --path=$PWD/vendor/bundle
+
+      - run:
+          name: Run test suite
+          command: |
+            unset RACK_ENV &&
+            unset RAILS_ENV &&
+            bundle exec rspec
+
+      - save_cache:
+          key: v2-bundle-<%= ruby %>-<%= variant %>-{{ .Branch }}
+          paths:
+            - ~/project/vendor/bundle
+            - ~/project/vendor/bundle-scaffold
+      - save_cache:
+          key: v2-bundle-<%= ruby %>-<%= variant %>
+          paths:
+            - ~/project/vendor/bundle
+            - ~/project/vendor/bundle-scaffold
+      - save_cache:
+          key: v2-bundle-<%= ruby %>
+          paths:
+            - ~/project/vendor/bundle
+            - ~/project/vendor/bundle-scaffold
+<% end %>
+
+workflows:
+  version: 2
+  test:
+    jobs:
+    <% builds.each do |ruby,variant| %>
+      - build_<%= ruby %>_<%= variant %>
+    <% end %>

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
 /.yardoc
 /Gemfile.lock
+/gemfiles/*.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -8,4 +9,4 @@
 /spec/reports/
 /tmp/
 /vendor/
-/.idea
+/.idea

data/.rspec

@@ -1,2 +1,4 @@
 --format documentation
 --color
+--order rand
+--profile

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+# v1.11.0 (2017-08-11)
+
+Features (library):
+
+- Replaces the Rails logger with a structured logger (#60)
+- Auto-fills the Routemaster `t` timestamp field, where appropriate, from the
+  model's `created_at` and `updated_at` fields if available (#64)
+
+Features (app harness):
+
+- The `roo_on_rails` test harness now defaults to not fixing issues, and has extra
+  `--env` and `--fix` flags (#57)
+- All checks will now run regardless of previous failure to avoid
+  back-and-forthing (#57)
+- Tolerates apps with abbreviated environment names (#55)
+
+Bug fixes:
+
+- Bugfix for supporting non-default publishers after a `reload!` in the rails console (#62)
+- Friendlier error message when facing Heroku permission errors (#58)
+- Support apps without ActiveRecord (#40)
+
+Misc:
+
+- Now using CircleCI for builds (#61, #63)
+- Document Datadog integration (#59)
+
 # v1.10.0 (2017-08-11)
 
 Features:

data/README.md

@@ -1,4 +1,4 @@
-## `roo_on_rails` [![Gem Version](https://badge.fury.io/rb/roo_on_rails.svg)](https://badge.fury.io/rb/roo_on_rails) [![Build Status](https://travis-ci.org/deliveroo/roo_on_rails.svg?branch=master)](https://travis-ci.org/deliveroo/roo_on_rails) [![Code Climate](https://codeclimate.com/repos/58809e664ab8420081007382/badges/3489b7689ab2e0cf5d61/gpa.svg)](https://codeclimate.com/repos/58809e664ab8420081007382/feed)
+## `roo_on_rails` [![Gem Version](https://badge.fury.io/rb/roo_on_rails.svg)](https://badge.fury.io/rb/roo_on_rails) [![Build Status](https://circleci.com/gh/deliveroo/roo_on_rails.svg?style=shield&circle-token=f8ad2021dfc72fd86850fd0b7224759f34a91281)](https://circleci.com/gh/deliveroo/roo_on_rails) [![Code Climate](https://codeclimate.com/repos/58809e664ab8420081007382/badges/3489b7689ab2e0cf5d61/gpa.svg)](https://codeclimate.com/repos/58809e664ab8420081007382/feed)
 
 
 `roo_on_rails` is:
@@ -24,6 +24,7 @@
   - [HireFire (for Sidekiq workers)](#hirefire-for-sidekiq-workers)
   - [Logging](#logging)
   - [Google OAuth authentication](#google-oauth-authentication)
+  - [Datadog Integration](#datadog-integration)
   - [Routemaster Client](#routemaster-client)
 - [Command features](#command-features)
   - [Usage](#usage)
@@ -149,38 +150,47 @@ be used:
 
 ### Logging
 
-For clearer and machine-parseable log output, there in an extension to be able
-to add context to your logs which is output as
-[logfmt](https://brandur.org/logfmt) key/value pairs after the log message.
+For clearer and machine-parseable log output, the Rails logger is replaced by an
+extended logger to add context to your logs, which is output as
+[logfmt](https://brandur.org/logfmt) key/value pairs along with the log message.
+
+You can use the logger as usual:
 
 ```ruby
-# application.rb
+Rails.logger.info { 'hello world' }
+```
 
-require 'roo_on_rails/context_logging'
+From your console, the output will include the timestamp, severity, and message:
 
-class Application < Rails::Application
+```
+[2017-08-25 14:34:54.899]    INFO | hello world
+```
 
-  # add this block somewhere within the application class
-  logger = config.logger
-  if logger.nil?
-    logger = ActiveSupport::Logger.new($stdout)
-    logger.formatter = config.log_formatter
-  end
-  logger = ActiveSupport::TaggedLogging.new(logger) unless logger.respond_to?(:tagged)
-  config.logger = RooOnRails::ContextLogging.new(logger)
+In production (or whenever the output isn't a TTY), the timestamp is stripped
+(as it's provided by the logging pipes) and the output is fully valid `logfmt`:
 
-end
+```
+at=INFO msg="hello world"
 ```
 
-You can then add context using the `with` method:
+One can also add context using the `with` method:
 
 ```ruby
 logger.with(a: 1, b: 2) { logger.info 'Stuff' }
+# => at=INFO msg=Stuff a=1 b=2
+```
+
+```ruby
 logger.with(a: 1) { logger.with(b: 2) { logger.info('Stuff') } }
+# => at=INFO msg=Stuff a=1 b=2
+```
+
+```ruby
 logger.with(a: 1, b: 2).info('Stuff')
+# => at=INFO msg=Stuff a=1 b=2
 ```
 
-See the [class documentation](lib/roo_on_rails/context_logging.rb) for further
+See the [class documentation](lib/roo_on_rails/logger.rb) for further
 details.
 
 ### Google OAuth authentication
@@ -199,6 +209,44 @@ application.
 
 A simple but secure example is detailed in `README.google_oauth2.md`.
 
+### Datadog Integration
+
+#### Heroku metrics
+
+To send system metrics to Datadog (CPU, memory usage, HTTP throughput per
+status, latency, etc), your application need to send their logs to
+[the metrics bridge](https://github.com/deliveroo/heroku-datadog-drain-golang).
+
+This is automatically configured when running `roo_on_rails harness`.
+
+#### Custom application metrics
+
+Sending custom metrics to Datadog through Statsd requires an agent running in
+each dyno.
+You need to add the buildpack
+[`heroku-buildpack-datadog`](https://github.com/deliveroo/heroku-buildpack-datadog).
+
+Once this is done, you can send metrics with e.g.:
+
+```ruby
+RooOnRails.statsd.increment('my.metric', tags: 'tag:value')
+```
+
+Tags `env:{name}`, `source:{dyno}`, and `app:{name}` will automatically be added
+to all your metrics.
+
+The following environment variables are being used.  The default values are fine
+except for `STATSD_ENV` which should be set.
+
+- `STATSD_ENV`
+- `STATSD_HOST`
+- `STATSD_PORT`
+
+These extra required variables are automatically set by Heroku:
+
+- `DYNO`
+- `HEROKU_APP_NAME`
+
 ### Routemaster Client
 
 When `ROUTEMASTER_ENABLED` is set to `true` we attempt to configure [`routemaster-client`](https://github.com/deliveroo/routemaster-client) on your application. In order for this to happen you need to set the following environment variables:
@@ -215,7 +263,7 @@ If you then want to enable the publishing of events onto the event bus, you need
 Run the following from your app's top-level directory:
 
 ```
-bundle exec roo_on_rails
+roo_on_rails harness
 ```
 
 That command will sequentially run a number of checks. For it to run successfully, you will need:
@@ -223,17 +271,18 @@ That command will sequentially run a number of checks. For it to run successfull
 - a GitHub API token that can read your GitHub repository's settings placed in `~/.roo_on_rails/github-token`
 - the Heroku toolbelt installed and logged in
 - admin privileges on the `roo-dd-bridge-production` (this will be addressed eventually)
-- checks are run sequentially for staging and then for production. The process halts at any non-fixable failing check. To process only specific environments, you can set a config variable while running the command, like so:
 
+The command can automatically fix most of the failing checks automatically;
+simply run it with the `--fix` flag:
+
+```
+roo_on_rails harness --fix
 ```
-# the default behaviour:
-ROO_ON_RAILS_ENVIRONMENTS=staging,production bundle exec roo_on_rails
 
-# run checks only on staging:
-ROO_ON_RAILS_ENVIRONMENTS=staging bundle exec roo_on_rails
+To run checks for only one environment, use the `--env` flag:
 
-# run checks only on production:
-ROO_ON_RAILS_ENVIRONMENTS=production bundle exec roo_on_rails
+```
+roo_on_rails harness --env staging
 ```
 
 

data/README.routemaster_client.md

@@ -78,6 +78,8 @@ class RiderPublisher < ApplicationPublisher
 end
 ```
 
+`#publish?`, `#topics`, `#async?`, `#data` and `#timestamp` can be overriden; see [the `Publisher` class](lib/roo_on_rails_routemaster/publisher.rb) for the default implementations.
+
 ### Register the publishers with Routemaster
 
 The final step is to tell Routemaster that these publishers exist, so that it can listen to their events. We're going to do this in an initialiser:

data/exe/roo_on_rails

@@ -3,12 +3,101 @@
 require 'rubygems'
 require 'roo_on_rails/config'
 
-if ARGV.include? 'sidekiq'
-  require 'roo_on_rails/sidekiq/loader'
-  RooOnRails::Sidekiq::Loader.run
-else
-  require 'roo_on_rails/harness'
-  module RooOnRails
-    Harness.new(try_fix: true, context: Config.load).run
+module RooOnRails
+  module CLI
+    class Base
+      attr_reader :argv
+
+      def initialize(argv)
+        @argv = argv
+      end
+
+      def usage
+        raise NotImplementedError
+      end
+
+      protected
+
+      def _log(message)
+        $stderr.puts message
+      end
+
+      def _assert_argv_length(range)
+        return if range.include?(argv.length)
+        _log 'Wrong number of arguments.'
+        _log "Usage: #{usage}"
+        exit 1
+      end
+    end
+
+    class Sidekiq < Base
+      def usage
+        'roo_on_rails sidekiq'
+      end
+
+      def run
+        _assert_argv_length(0..0)
+        require 'roo_on_rails/sidekiq/loader'
+        RooOnRails::Sidekiq::Loader.run
+      end
+    end
+
+    class Harness < Base
+      def usage
+        'roo_on_rails harness [-f|--fix]'
+      end
+
+      def run
+        _parser.parse!(argv)
+        _assert_argv_length(0..0)
+        require 'roo_on_rails/harness'
+        RooOnRails::Harness.new(try_fix: _options[:fix], context: Config.load).run
+      end
+
+      private
+
+      def _options
+        @options ||= { fix: false, env: nil }
+      end
+
+      def _parser
+        require 'optionparser'
+
+        OptionParser.new do |o|
+          o.banner = usage
+
+          o.on('-f', '--fix', 'Attempt to fix failed checks') do
+            _options[:fix] = true
+          end
+
+          o.on('-e', '--env', 'Application environments to check (comma-separated)') do |v|
+            _options[:env] = v
+          end
+        end
+      end
+    end
+
+    class Toplevel < Base
+      def usage
+        'roo_on_rails [sidekiq|harness] [options]'
+      end
+
+      def run
+        case argv.first
+        when 'sidekiq' then
+          argv.shift
+          Sidekiq.new(argv).run
+        when 'harness', nil then
+          argv.shift
+          Harness.new(argv).run
+        else
+          _log 'Incorrect arguments.'
+          _log "Usage: #{usage}"
+          exit 1
+        end
+      end
+    end
   end
 end
+
+RooOnRails::CLI::Toplevel.new(ARGV).run

data/lib/roo_on_rails/checks/base.rb

@@ -24,18 +24,30 @@ module RooOnRails
       end
 
       def run
-        resolve dependencies
-        return true if @dry_run
+        dependency_status = resolve dependencies
+
         say intro
-        call
+        unless dependency_status
+          final_fail! 'Unmet dependencies.'
+          return
+        end
+
+        return true if @dry_run
+
+        begin
+          call
+        rescue Failure
+          return false unless @fix
+          say "\t· attempting to fix", %i[yellow]
+          fix
+          @fix = false
+          say "\t· re-checking", %i[yellow]
+          retry
+        end
+
         true
-      rescue Failure => e
-        raise if e === FinalFailure
-        raise unless @fix
-        say "\t· attempting to fix", %i[yellow]
-        fix
-        say "\t· re-checking", %i[yellow]
-        call
+      rescue FinalFailure
+        false
       end
 
       protected
@@ -44,7 +56,7 @@ module RooOnRails
 
       # Returns prerequisite checks. Can be overriden.
       def dependencies
-        self.class.requires.map { |k|
+        @dependencies ||= self.class.requires.map { |k|
           k.new(fix: @fix, context: @context, shell: @shell, **@options)
         }
       end
@@ -54,11 +66,11 @@ module RooOnRails
       end
 
       def call
-        fail! "this check wasn't implemented"
+        final_fail! "this check wasn't implemented"
       end
 
       def fix
-        fail! "can't fix this on my own"
+        final_fail! "can't fix this on my own"
       end
 
       def pass(msg)
@@ -84,10 +96,15 @@ module RooOnRails
 
       # Run each dependency, then mark them as run.
       def resolve(deps)
-        deps.each do |dep|
-          context.deps ||= {}
-          context.deps[dep.signature.join('/')] ||= dep.run
-        end
+        context.deps ||= {}
+        deps.map { |dep|
+          sig = dep.signature.join('/')
+          if context.deps.key?(sig)
+            context.deps[sig]
+          else
+            context.deps[sig] = dep.run
+          end
+        }.to_a.all?
       end
     end
   end

data/lib/roo_on_rails/checks/documentation/playbook.rb

@@ -13,15 +13,11 @@ module RooOnRails
 
         def call
           fail! "no playbook at #{LOCATION}." if playbook_missing?
-          fail! 'playbook still contains FIXME template sections' if playbook_unfinished?
-          pass  'playbook found, legion on-call engineers thank you.'
+          final_fail! 'playbook still contains FIXME template sections' if playbook_unfinished?
+          pass 'playbook found, legion on-call engineers thank you.'
         end
 
         def fix
-          if !playbook_missing? && playbook_unfinished?
-            fail! 'please add detail to your playbook, removing FIXME sections'
-          end
-
           FileUtils.cp(
             File.join(__dir__, 'playbook_template.md'),
             LOCATION

data/lib/roo_on_rails/checks/environment.rb

@@ -1,5 +1,4 @@
 require 'roo_on_rails/checks/env_specific'
-require 'roo_on_rails/checks/github/branch_protection'
 require 'roo_on_rails/checks/heroku/app_exists'
 require 'roo_on_rails/checks/heroku/preboot_enabled'
 require 'roo_on_rails/checks/heroku/app_exists'
@@ -9,19 +8,18 @@ require 'roo_on_rails/checks/papertrail/all'
 module RooOnRails
   module Checks
     class Environment < EnvSpecific
-      requires GitHub::BranchProtection
       requires Heroku::DrainsMetrics
       requires Heroku::PrebootEnabled
       requires Papertrail::All
 
       def call
-        # nothing to do
+        pass 'all good'
       end
 
       protected
 
       def intro
-        "Validated #{bold @env} environment"
+        "Validating #{bold @env} environment"
       end
     end
   end

data/lib/roo_on_rails/checks/environment_independent.rb

@@ -0,0 +1,22 @@
+require 'roo_on_rails/checks/base'
+require 'roo_on_rails/checks/github/branch_protection'
+require 'roo_on_rails/checks/sidekiq/settings'
+require 'roo_on_rails/checks/documentation/playbook'
+
+module RooOnRails
+  module Checks
+    class EnvironmentIndependent < Base
+      requires GitHub::BranchProtection
+      requires Documentation::Playbook
+      requires Sidekiq::Settings
+
+      def intro
+        'Validating environment-independent setup'
+      end
+
+      def call
+        say 'All good', :green
+      end
+    end
+  end
+end

data/lib/roo_on_rails/checks/heroku/app_exists.rb

@@ -16,6 +16,10 @@ module RooOnRails
       # Output context:
       # - heroku.app.{env}: an app name.
       class AppExists < EnvSpecific
+        ACCEPTABLE_ENV_NAMES = {
+          'production' => %w(prd production),
+          'staging'    => %w(stg staging)
+        }.freeze
         requires Git::Origin, Heroku::Token
 
         def intro
@@ -25,7 +29,6 @@ module RooOnRails
         def call
           all_apps = client.app.list.map { |a| a['name'] }
           matches = all_apps.select { |a| candidates.include?(a) }
-
           if matches.empty?
             fail! "no apps with matching names detected"
           end
@@ -45,11 +48,15 @@ module RooOnRails
           context.app_name_stem || context.git_repo.delete('.')
         end
 
+        def env_suffixes
+          ACCEPTABLE_ENV_NAMES.fetch(env, [env])
+        end
+
         def candidates
           [
             ['deliveroo', 'roo', nil],
             [name_stem],
-            [env],
+            env_suffixes,
           ].tap { |a|
             a.replace a.first.product(*a[1..-1])
           }.map { |c|

data/lib/roo_on_rails/checks/heroku/drains_metrics.rb

@@ -18,7 +18,7 @@ module RooOnRails
         requires Heroku::AppExists, MetricsBridgeConfigured
 
         def intro
-          "Checking for metrics drain on #{bold app_name}"
+          'Checking for metrics drain...'
         end
 
         def call
@@ -28,7 +28,7 @@ module RooOnRails
 
           fail! 'No matching drain found' if url.nil?
           final_fail! 'Misconfigured drain found' if url != drain_uri
-          pass 'Drain is connected'
+          pass "Drain is connected to #{bold app_name}"
         end
 
         private

data/lib/roo_on_rails/checks/heroku/metrics_bridge_configured.rb

@@ -22,7 +22,7 @@ module RooOnRails
         BRIDGE_APP = 'roo-dd-bridge-production'.freeze
 
         def intro
-          "Checking whether metrics bridge is configured for #{bold app_name}"
+          'Checking whether metrics bridge is configured...'
         end
 
         def call
@@ -33,7 +33,7 @@ module RooOnRails
           fail! 'Bridge lacks credentials for this app' unless config[token_var]
           fail! 'Bridge lacks tags for this app'        unless config[tags_var]
 
-          pass 'Bridge is configured'
+          pass "Bridge is configured for #{bold app_name}"
           context.heroku.metric_bridge_token![env] = config[token_var]
         end
 
@@ -48,10 +48,14 @@ module RooOnRails
             token_var    => SecureRandom.hex(16),
             app_list_var => app_list.to_a.join(',')
           )
+        rescue Excon::Error::Forbidden
+          fail! "You are missing 'operate' permissions for #{bold BRIDGE_APP}"
         end
 
         def current_config
           client.config_var.info_for_app(BRIDGE_APP)
+        rescue Excon::Error::Forbidden
+          fail! "You are missing 'deploy' permissions for #{bold BRIDGE_APP}"
         end
 
         def app_list_var

data/lib/roo_on_rails/checks/heroku/preboot_enabled.rb

@@ -12,15 +12,15 @@ module RooOnRails
         requires Git::Origin, Heroku::AppExists
 
         def intro
-          "Checking preboot status on #{bold app_name}"
+          'Checking preboot status...'
         end
 
         def call
           status = client.app_feature.info(app_name, 'preboot')
           if status['enabled']
-            pass 'preboot enabled'
+            pass "preboot enabled on #{bold app_name}"
           else
-            fail! 'preboot disabled'
+            fail! "preboot disabled on #{bold app_name}"
           end
         end