service_downtime_simulator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b251f2b6694651096a5ae0ca961b6011625f7de5fd454760f6806457c745d813
+  data.tar.gz: 1e62307f82e95f9eb3017f06f8a5c89974992625aa9fabde4bd25a4aed2455d3
+SHA512:
+  metadata.gz: df90f8ca05da0c71e34d2eb8427301d128a13f3049f6628039d2a3df08421843073cef6382b2b553e7090bada1f112782e997453a03d9af0b713c302bd9b41e2
+  data.tar.gz: 0eed6fcb9ab37f11ea39270b28ada5ceb772d944b2a5bed7448ddc2748a8ad6b8833c6ff1400979f16590237dfdc4d3cef5efe4de3c6b663cbde5aca30ccce12

data/.circleci/config.yml

@@ -0,0 +1,16 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.5.1
+    steps:
+      - checkout
+      - run:
+          name: Bundle Is Massive
+          command: make install
+      - run:
+          name: Lint
+          command: make lint
+      - run:
+          name: Test
+          command: make test

data/.gitignore

@@ -0,0 +1,58 @@
+# Created by https://www.gitignore.io/api/ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+# End of https://www.gitignore.io/api/ruby
+
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+# 80 char line length is not enough chars. 120 is better. We're not working on 1024x768 CRTs.
+Metrics/LineLength:
+  Max: 120
+
+# Documentation is for nerds.
+Style/Documentation:
+  Enabled: false
+
+# I like my code verbose and spaced out.
+Metrics/MethodLength:
+  Max: 20
+
+# Because RSpec tests are block-centric, this is an insane linter to run on them.
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    service_downtime_simulator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.59.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rspec (~> 3.0)
+  rubocop
+  service_downtime_simulator!
+
+BUNDLED WITH
+   1.16.1

data/Makefile

@@ -0,0 +1,15 @@
+install:
+	bundle install
+
+test:
+	bundle exec rspec
+
+publish:
+	bundle exec gem build *.gemspec
+	-bundle exec gem push *.gem
+	rm *.gem
+
+lint:
+	bundle exec rubocop
+
+.PHONY: install test publish lint

data/README.md

@@ -0,0 +1,89 @@
+# Service Downtime Simulator
+
+[![CircleCI](https://circleci.com/gh/deliveroo/service_downtime_simulator/tree/master.svg?style=svg&circle-token=d66bc2c0246da5cdf4eeaeb6c9f7b10bcd74bb7b)](https://circleci.com/gh/deliveroo/service_downtime_simulator/tree/master)
+
+This is a piece of Rack middleware that simulates failures you would want to tolerate in upstream services.
+
+## Installation
+
+### Rails
+
+Add the following in `application.rb`:
+
+```ruby
+config.middleware.use(
+  ServiceDowntimeSimulator::Middleware,
+  config # See below for info about how to configure this
+)
+```
+
+### Other Rack-based applications
+
+Instructions TBC.
+
+## Configuration
+
+The middleware takes a `config` argument in the form of a hash. Said hash should have the following shape:
+
+```ruby
+{
+  enabled: Boolean,
+  mode: Symbol,
+  excluded_paths: Array<String>,
+  logger: Logger?
+}
+```
+
+Here's what you can supply for each of those options:
+
+- **enabled** (`Boolean`)
+  - `true` will enable simulation of failures (assuming you supply a valid `mode`, see below)
+  - `false` will disable simulation and your application will function as normal
+- **mode** (`Symbol`)
+  - `:hard_down` will cause all requests to return a 500 error
+  - `:intermittently_down` will cause 50% of requests to return a 500 error
+  - `:successful_but_gibberish` will return a 200, but with a response body that is not machine readable
+  - `:timing_out` will wait for 15 seconds on each request, and then return a 503
+- **excluded_paths** (`Array<String>`)
+  - You can supply a list of paths that you don't want to be affected by the simulation here (e.g. `['/foobar']`)
+  - The most common thing you're going to want to include here is your service's health check endpoint, as if it is returning a 5xx thanks to this middleware your application will not deploy
+- **logger** (`Logger?`)
+  - If supplied, useful debug information will be sent here
+
+In order for the middleware to kick in, `enabled` must be explicitly set to `true` and `mode` must be a valid option. Unless both are explicitly supplied, the underlying application will continue to function as normal.
+
+### Examples
+
+Here's a couple of example configurations:
+
+#### Hard-coded Hard Down
+
+This example will always return a 500 for all requests.
+
+```ruby
+config.middleware.use(
+  ServiceDowntimeSimulator::Middleware,
+  {
+    enabled: true,
+    mode: :hard_down,
+    excluded_paths: ['/health'],
+    logger: Rails.logger
+  }
+)
+```
+
+#### Environment-variable Controlled Simulation
+
+This is a more practical example, allowing failure simulation to happen based on environment variables. It requires an environment variable with a specific value to enable the failure simulation, and also requires a mode to be provided. If either are missing, the app continues as normal. You can also use this pattern for feature flagging. Probably.
+
+```ruby
+config.middleware.use(
+  ServiceDowntimeSimulator::Middleware,
+  {
+    enabled: ENV['FAILURE_SIMULATION_ENABLED'] == 'I_UNDERSTAND_THE_CONSEQUENCES_OF_THIS',
+    mode: ENV['FAILURE_SIMULATION_MODE'],
+    excluded_paths: ['/health'],
+    logger: Rails.logger
+  }
+)
+```

data/lib/service_downtime_simulator/config.rb

@@ -0,0 +1,91 @@
+module ServiceDowntimeSimulator
+  class Config
+    WonkyInputError = Class.new(StandardError)
+
+    OPTIONS = %i[
+      enabled
+      mode
+      logger
+      excluded_paths
+    ].freeze
+
+    attr_reader :logger
+
+    def self.for(config)
+      return config if config.is_a?(self)
+
+      new(config)
+    end
+
+    def initialize(config_hash)
+      raise WonkyInputError unless config_hash.is_a?(Hash)
+
+      config_hash.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def activated?
+      enabled == true && !mode.nil?
+    end
+
+    def enabled
+      @enabled == true
+    end
+
+    def mode
+      if @mode.nil?
+        moan(:mode, 'No mode provided')
+        return nil
+      end
+
+      unless @mode.is_a?(Symbol)
+        moan(:mode, 'Mode must be a symbol')
+        return nil
+      end
+
+      unless ServiceDowntimeSimulator::Modes.exists?(@mode)
+        moan(:mode, "Unknown mode #{@mode}")
+        return nil
+      end
+
+      @mode
+    end
+
+    def mode_klass
+      ServiceDowntimeSimulator::Modes.for(mode)
+    end
+
+    def excluded_paths
+      if @excluded_paths.nil?
+        moan(:excluded_paths, 'No excluded paths set. What about your health check endpoint?')
+        return []
+      end
+
+      unless @excluded_paths.is_a?(Array)
+        moan(:excluded_paths, 'Excluded paths must ba an array of paths')
+        return []
+      end
+
+      # Detect if any elements are not a string
+      if @excluded_paths.any? { |el| !el.is_a?(String) }
+        moan(:excluded_paths, 'Excluded paths includes non-string value')
+        return []
+      end
+
+      @excluded_paths
+    end
+
+    def path_excluded?(path)
+      excluded_paths.include?(path)
+    end
+
+    private
+
+    def moan(option, message)
+      return unless logger.respond_to?(:error)
+
+      logger.error("[SDS] Issue with #{option}: #{message}. Will not activate unless fixed.")
+    end
+  end
+end

data/lib/service_downtime_simulator/middleware.rb

@@ -0,0 +1,22 @@
+module ServiceDowntimeSimulator
+  class Middleware
+    def initialize(app, config)
+      @app = app
+      @config = ServiceDowntimeSimulator::Config.for(config)
+    end
+
+    def call(env)
+      return app.call(env) if bypass?(env)
+
+      config.mode_klass.new(app).call(env)
+    end
+
+    private
+
+    attr_reader :app, :config
+
+    def bypass?(env)
+      !config.activated? || config.path_excluded?(env['PATH_INFO'])
+    end
+  end
+end

data/lib/service_downtime_simulator/modes/base.rb

@@ -0,0 +1,37 @@
+module ServiceDowntimeSimulator
+  module Modes
+    class Base
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @env = env
+
+        [status, headers, body]
+      end
+
+      private
+
+      def headers
+        {
+          'X-SDS-Mode' => identifier
+        }
+      end
+
+      def body
+        "Simulated Response (#{identifier})"
+      end
+
+      def status
+        raise NotImplementedError
+      end
+
+      def identifier
+        self.class.name
+      end
+
+      attr_reader :app, :env
+    end
+  end
+end

data/lib/service_downtime_simulator/modes/hard_down.rb

@@ -0,0 +1,11 @@
+module ServiceDowntimeSimulator
+  module Modes
+    class HardDown < Base
+      private
+
+      def status
+        500
+      end
+    end
+  end
+end

data/lib/service_downtime_simulator/modes/intermittently_down.rb

@@ -0,0 +1,21 @@
+module ServiceDowntimeSimulator
+  module Modes
+    class IntermittentlyDown < Base
+      def call(env)
+        return app.call(env) unless knackered?
+
+        super
+      end
+
+      private
+
+      def status
+        500
+      end
+
+      def knackered?
+        [true, false].sample
+      end
+    end
+  end
+end

data/lib/service_downtime_simulator/modes/successful_but_gibberish.rb

@@ -0,0 +1,19 @@
+module ServiceDowntimeSimulator
+  module Modes
+    class SuccessfulButGibberish < Base
+      private
+
+      def status
+        200
+      end
+
+      def body
+        cheeseboard.shuffle.join(' ')
+      end
+
+      def cheeseboard
+        %w[stilton caerphilly cheddar gloucester wensleydale brie] * 10
+      end
+    end
+  end
+end

data/lib/service_downtime_simulator/modes/timing_out.rb

@@ -0,0 +1,20 @@
+module ServiceDowntimeSimulator
+  module Modes
+    class TimingOut < Base
+      def call(*)
+        delay(15)
+        super
+      end
+
+      def delay(duration)
+        sleep(duration)
+      end
+
+      private
+
+      def status
+        503
+      end
+    end
+  end
+end

data/lib/service_downtime_simulator/modes.rb

@@ -0,0 +1,22 @@
+module ServiceDowntimeSimulator
+  module Modes
+    NotFound = Class.new(StandardError)
+
+    AVAILABLE = {
+      hard_down:                ServiceDowntimeSimulator::Modes::HardDown,
+      intermittently_down:      ServiceDowntimeSimulator::Modes::IntermittentlyDown,
+      successful_but_gibberish: ServiceDowntimeSimulator::Modes::SuccessfulButGibberish,
+      timing_out:               ServiceDowntimeSimulator::Modes::TimingOut
+    }.freeze
+
+    def self.for(id)
+      raise NotFound unless exists?(id)
+
+      AVAILABLE[id]
+    end
+
+    def self.exists?(id)
+      AVAILABLE.key?(id)
+    end
+  end
+end

data/lib/service_downtime_simulator.rb

@@ -0,0 +1,12 @@
+module ServiceDowntimeSimulator
+  VERSION = '0.1.0'.freeze
+end
+
+require_relative 'service_downtime_simulator/config'
+require_relative 'service_downtime_simulator/middleware'
+require_relative 'service_downtime_simulator/modes/base'
+require_relative 'service_downtime_simulator/modes/hard_down'
+require_relative 'service_downtime_simulator/modes/intermittently_down'
+require_relative 'service_downtime_simulator/modes/successful_but_gibberish'
+require_relative 'service_downtime_simulator/modes/timing_out'
+require_relative 'service_downtime_simulator/modes'

data/service_downtime_simulator.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'service_downtime_simulator'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'service_downtime_simulator'
+  spec.version       = ServiceDowntimeSimulator::VERSION
+  spec.authors       = ['Josh McMillan']
+  spec.email         = ['joshua.mcmillan@deliveroo.co.uk']
+
+  spec.summary       = "Want to know what it's like to have me in your dev team? This gem is for you!"
+  spec.homepage      = 'https://github.com/deliveroo/service_downtime_simulator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: service_downtime_simulator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh McMillan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: 
+email:
+- joshua.mcmillan@deliveroo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- Makefile
+- README.md
+- lib/service_downtime_simulator.rb
+- lib/service_downtime_simulator/config.rb
+- lib/service_downtime_simulator/middleware.rb
+- lib/service_downtime_simulator/modes.rb
+- lib/service_downtime_simulator/modes/base.rb
+- lib/service_downtime_simulator/modes/hard_down.rb
+- lib/service_downtime_simulator/modes/intermittently_down.rb
+- lib/service_downtime_simulator/modes/successful_but_gibberish.rb
+- lib/service_downtime_simulator/modes/timing_out.rb
+- service_downtime_simulator.gemspec
+homepage: https://github.com/deliveroo/service_downtime_simulator
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Want to know what it's like to have me in your dev team? This gem is for
+  you!
+test_files: []