chaos-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38c098285816a10db04fd4ac50388fc2c5a4ab22857820610fa346e8e9335466
+  data.tar.gz: 4a9064721287b1e9f7331054ad7a32fc46d7774634c11aa8c85efc0bc2bdb52d
+SHA512:
+  metadata.gz: 467b1c95a6a449a120628ae47638655b6ec383b4a6c0d57b10c1cace568a23a945ba2acfbb93c7251c4a0f6ff04a7ddffdd6c1f489b4772c35811ee6da8ea726
+  data.tar.gz: 8d35480f7963a13afb05e02e66a62172728ae7b203f6ff4b45bd0e2becbe125409208456b4e4416951128f01e3b8f42b77d3cae1ccbc305ffd16cf1caeac5132

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in chaos-rb.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    chaos-rb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  chaos-rb!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Karol Galanciak
+
+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,98 @@
+# Chaos::Rb
+
+Bring [chaos engineering](https://en.wikipedia.org/wiki/Chaos_engineering) to your Ruby apps - destroy production for fun and profit :).
+
+If you want to introduce some instability to your application in a controlled - way and see what's going to happen (verifying alerts, chekcing what metrics are going to be collected etc.), this is a gem for you.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chaos-rb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install chaos-rb
+
+## Usage
+
+Chaos RB supports the following types of instabilities:
+
+- CPU Usage - simulate 100% of the CPU core load for a specified amount of time
+- Exception - simulate raising exceptions
+- IO Wait - simulate some blocking I/O operation for a specified amount of time
+- Memory Usage - simulate memory usage of a given amount in megabytes for a specified amount of time
+
+The way to use them is to use `Chaos::Injector` that modified the specific class/method. You also need to provide probability of the instability being executed (a number between 0 and 1 - 0 means never, 1 means always, 0.7 means 70% of the change that the instability will be executed etc.).
+
+You can also provide a lambda or an object responding to `call` method taking one argument which is going to be an object that gets the chaos injection if the logic when given instability should be executed is more complex - that way you can take advantage of the state of the object to decide, e.g. if you only want some users to experience problems.
+
+Here are examples how to use `Chaos::Injector`:
+
+
+``` rb
+injector = Chaos::Injector.build(logger: Rails.logger)
+
+injector.inject do |builder|
+  builder.target = ExampleService # required
+  builder.method_name = :call # required
+  builder.instability_type = :cpu_usage # required
+  builder.instability_arguments = { duration_in_seconds: 30.0 } # required
+  builder.probability = 0.9 # required
+end
+
+injector.inject do |builder|
+  builder.target = ExampleService
+  builder.method_name = :call
+  builder.instability_type = :io_wait
+  builder.instability_arguments = { duration_in_seconds: 30.0 }
+  builder.probability = 0.5
+  builder.execute_if = ->(example_service_instance) { example_service_instance.current_user.admin? } # optional
+end
+
+injector.inject do |builder|
+  builder.target = ExampleService
+  builder.method_name = :call
+  builder.instability_type = :memory_usage
+  builder.instability_arguments = { duration_in_seconds: 30.0, memory_limit_in_megabytes: 1000 }
+  builder.probability = 1
+end
+
+injector.inject do |builder|
+  builder.target = ExampleService
+  builder.method_name = :call
+  builder.instability_type = :exception
+  builder.instability_arguments = { exceptions: [Faraday::ClientError.new("HTTP connection error"), ActiveRecord::RecordInvalid] }
+  builder.probability = 0.1
+end
+```
+
+If `Chaos::Injector` looks like too much magic to you, you can use instability classes directly:
+
+``` rb
+instability_type = :io_wait
+instability_arguments = { duration_in_seconds: 30.0 }
+
+Chaos::InstabilityFactory.new.build(instability_type).call(instability_arguments)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/chaos-rb.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chaos/rb"
+
+# 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(__FILE__)

data/bin/setup

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

data/chaos-rb.gemspec

@@ -0,0 +1,29 @@
+require_relative "lib/chaos/rb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chaos-rb"
+  spec.version       = Chaos::Rb::VERSION
+  spec.authors       = ["Karol Galanciak"]
+  spec.email         = ["karol.galanciak@gmail.com"]
+
+  spec.summary       = %q{Chaos RB: Bringing chaos to your Ruby applications}
+  spec.description   = %q{Chaos RB: Bringing chaos to your Ruby applications}
+  spec.homepage      = "https://github.com/BookingSync/chaos-rb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/chaos.rb

@@ -0,0 +1,13 @@
+require "chaos/rb/version"
+require "chaos/instability"
+require "chaos/instability/cpu_usage"
+require "chaos/instability/exception"
+require "chaos/instability/i_o_wait"
+require "chaos/instability/memory_usage"
+require "chaos/injection"
+require "chaos/injector"
+require "chaos/instability_factory"
+require "chaos/modifier_factory"
+
+module Chaos
+end

data/lib/chaos/injection.rb

@@ -0,0 +1,37 @@
+class Chaos::Injection
+  ATTRIBUTES = %i(target method_name instability_type instability_arguments probability execute_if).freeze
+
+  attr_accessor *ATTRIBUTES
+
+  attr_reader :instability_factory
+  private     :instability_factory
+
+  def initialize(instability_factory: Chaos::InstabilityFactory.new)
+    @instability_factory = instability_factory
+  end
+
+  def validate!
+    ATTRIBUTES.each do |attribute|
+      present?(public_send(attribute)) or raise ":#{attribute} is not set!"
+    end
+  end
+
+  def instability
+    instability_factory.build(instability_type)
+  end
+
+  def execute_if
+    @execute_if || ->(_arg) { true }
+  end
+
+  def execute_if=(val)
+    raise "is not a lambda-like object" if !val.respond_to?(:call)
+    @execute_if = val
+  end
+
+  private
+
+  def present?(value)
+    !value.nil?
+  end
+end

data/lib/chaos/injector.rb

@@ -0,0 +1,28 @@
+class Chaos::Injector
+  attr_reader :modifier_factory, :injections
+  private     :modifier_factory
+
+  def self.build(logger:, random_numbers_generator: Kernel)
+    new(Chaos::ModifierFactory.new(logger: logger, random_numbers_generator: random_numbers_generator))
+  end
+
+  def initialize(modifier_factory)
+    @modifier_factory = modifier_factory
+    @injections = []
+  end
+
+  def inject
+    injection = Chaos::Injection.new
+    yield injection
+    injection.validate!
+    injections << injection
+
+    injection.target.prepend(build_module(injection))
+  end
+
+  private
+
+  def build_module(injection)
+    modifier_factory.build_module(injection)
+  end
+end

data/lib/chaos/instability.rb

@@ -0,0 +1,4 @@
+module Chaos
+  module Instability
+  end
+end

data/lib/chaos/instability/cpu_usage.rb

@@ -0,0 +1,22 @@
+class Chaos::Instability::CpuUsage
+  attr_reader :clock
+  private     :clock
+
+  def initialize(clock: Time)
+    @clock = clock
+  end
+
+  def call(duration_in_seconds:)
+    expected_execution_end_time = clock.now + duration_in_seconds
+
+    generate_100_percent_load_on_a_single_cpu_limit(expected_execution_end_time)
+  end
+
+  private
+
+  def generate_100_percent_load_on_a_single_cpu_limit(expected_execution_end_time)
+    while clock.now < expected_execution_end_time
+      true
+    end
+  end
+end

data/lib/chaos/instability/exception.rb

@@ -0,0 +1,5 @@
+class Chaos::Instability::Exception
+  def call(exceptions:)
+    raise exceptions.sample
+  end
+end

data/lib/chaos/instability/i_o_wait.rb

@@ -0,0 +1,12 @@
+class Chaos::Instability::IOWait
+  attr_reader :sleep_provider
+  private     :sleep_provider
+
+  def initialize(sleep_provider: Kernel)
+    @sleep_provider = sleep_provider
+  end
+
+  def call(duration_in_seconds:)
+    sleep_provider.sleep(duration_in_seconds)
+  end
+end

data/lib/chaos/instability/memory_usage.rb

@@ -0,0 +1,35 @@
+class Chaos::Instability::MemoryUsage
+  attr_reader :sleep_provider, :accum, :chunk_size_in_bytes, :single_byte_character, :clock
+  private     :sleep_provider, :accum, :chunk_size_in_bytes, :single_byte_character, :clock
+
+  MEGABYTES_IN_BYTES = 1048576
+  SINGLE_BYE_CHARACTER = "a".freeze
+  private_constant :MEGABYTES_IN_BYTES, :SINGLE_BYE_CHARACTER
+
+  def initialize(sleep_provider: Kernel, accum: [], chunk_size_in_bytes: MEGABYTES_IN_BYTES,
+    single_byte_character: SINGLE_BYE_CHARACTER, clock: Time)
+    @sleep_provider = sleep_provider
+    @accum = accum
+    @chunk_size_in_bytes = chunk_size_in_bytes
+    @single_byte_character = single_byte_character
+    @clock = clock
+  end
+
+  def call(duration_in_seconds:, memory_limit_in_megabytes:)
+    start_time = clock.now
+    memory_limit_in_megabytes.times.with_object(accum) do |_index, memory_leaking_accum|
+      memory_leaking_accum << generate_chunk
+    end
+    current_time = clock.now
+    time_already_spent = current_time - start_time
+    time_left = [duration_in_seconds - time_already_spent , 0].max
+
+    sleep_provider.sleep(time_left)
+  end
+
+  private
+
+  def generate_chunk
+    single_byte_character * chunk_size_in_bytes
+  end
+end

data/lib/chaos/instability_factory.rb

@@ -0,0 +1,12 @@
+class Chaos::InstabilityFactory
+  REGISTRY = {
+    cpu_usage: Chaos::Instability::CpuUsage.new,
+    io_wait: Chaos::Instability::IOWait.new,
+    memory_usage: Chaos::Instability::MemoryUsage.new,
+    exception: Chaos::Instability::Exception.new
+  }
+
+  def build(instability)
+    REGISTRY.fetch(instability.to_sym)
+  end
+end

data/lib/chaos/modifier_factory.rb

@@ -0,0 +1,27 @@
+class Chaos::ModifierFactory
+  def initialize(random_numbers_generator: Kernel, logger:)
+    @random_numbers_generator = random_numbers_generator
+    @logger = logger
+  end
+
+  def build_module(injection)
+    instability_type = injection.instability_type
+    instability = injection.instability
+    target = injection.target
+    method_name = injection.method_name
+    probability = injection.probability
+    execute_if = injection.execute_if
+    random_numbers_generator = @random_numbers_generator
+    logger = @logger
+
+    Module.new do
+      define_method method_name do |*args, &block|
+        if probability >= random_numbers_generator.rand && execute_if.call(self)
+          instability.call(injection.instability_arguments)
+          logger.info "[Chaos] Triggered :#{instability_type} for :#{method_name} on #{target} with probability: #{probability}"
+        end
+        super(*args, &block)
+      end
+    end
+  end
+end

data/lib/chaos/rb.rb

@@ -0,0 +1 @@
+require_relative "../chaos.rb"

data/lib/chaos/rb/version.rb

@@ -0,0 +1,5 @@
+module Chaos
+  module Rb
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: chaos-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karol Galanciak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-09 00:00:00.000000000 Z
+dependencies: []
+description: 'Chaos RB: Bringing chaos to your Ruby applications'
+email:
+- karol.galanciak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chaos-rb.gemspec
+- lib/chaos.rb
+- lib/chaos/injection.rb
+- lib/chaos/injector.rb
+- lib/chaos/instability.rb
+- lib/chaos/instability/cpu_usage.rb
+- lib/chaos/instability/exception.rb
+- lib/chaos/instability/i_o_wait.rb
+- lib/chaos/instability/memory_usage.rb
+- lib/chaos/instability_factory.rb
+- lib/chaos/modifier_factory.rb
+- lib/chaos/rb.rb
+- lib/chaos/rb/version.rb
+homepage: https://github.com/BookingSync/chaos-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BookingSync/chaos-rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: 'Chaos RB: Bringing chaos to your Ruby applications'
+test_files: []