aranea 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '019581a335c3958a31655effdf3af83cb79aa2987b9d79539a19d355b6643023'
-  data.tar.gz: d96ba0a406b2b69898747da9c6d03a91d9ac954fd948d53d5872109d4e4a9f4f
+  metadata.gz: 2744be4a620f72ecba9af9c7547b2436cccde77d9a96007167e40feba44487eb
+  data.tar.gz: 76a0e97b08d766d2fd3644d63e3e49f6c6019400db2af32f049304f543dd462a
 SHA512:
-  metadata.gz: c5487fd366ef3dd6b4ed5cd0e4af82964e92babae887cb9d9dfdc8f08a200d8a17d7f5fc2e7d39e0b8ec31db7bd06421cb9f739ded22dc784a3de1b48c8a82ea
-  data.tar.gz: 832d65d2819bd27a0fb62256fbdc3eac4a44238a54b8669c184cd48336b362edb767931c780e6677324be2f203851430eea68b9f1cdecc790f54b471370c1ec9
+  metadata.gz: e92d3166f8335b61cce5fa3b634cd1184742c081f7e777b6c1263da831eef9892286bf985fc3d77e156ca4f0aadbfcc6b1753123984c17783527166b08ea292a
+  data.tar.gz: '0598ac41d882147de25488ceadb78694573a84a74df5fd8d40b819327f2506e5defcf1619911d10fc378367eb80d5ead97d0c5fed43ac6af14622fa9ba031d78'

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_gem:
+  rubocop-mdsol: rubocop.yml
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,26 @@
+dist: focal
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
+
+before_install:
+  - gem update --system --force -N > /dev/null && echo "Rubygems version $(gem --version)"
+  - gem install bundler --force -N && bundle --version
+
+install: BUNDLE_JOBS=4 bundle install
+
+script:
+  - bundle exec rubocop
+  - bundle exec rspec
+
+deploy:
+  edge: true # opt in to dpl v2
+  provider: rubygems
+  on:
+    tags: true
+    condition: $TRAVIS_RUBY_VERSION == 3.0

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# 0.1.0
+- Require Ruby 2.5 and up.
+- Require ActiveSupport 4.2 and up.
+- Allow Faraday 1.x.
+- Refresh code/specs and publish to rubygems.org.
+
+# 0.0.3
+- Added ability to specify the response body and response headers.
+
+# 0.0.2
+- Ability to raise Faraday::SSLError.
+
+# 0.0.1
+- Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015-2021 Medidata Solutions Worldwide
+
+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,124 @@
+# Aranea
+
+Aranea is a gem to use in fault-tolerance testing. It simulates a remote dependency failing, so that you can see how your project reacts.
+
+In Dungeons and Dragons, an Aranea is a giant spider that will ambush a group of adventurers using its illusion powers, then immobilize the strongest member, forcing the others to battle without a key ally.
+
+Aranea currently only works with Faraday clients.
+
+## Activating Aranea in a Deployed Rails or Rack Application
+
+If Aranea has already been set up and configured to run in your testing environment, you can switch it on via a POST request to `/disable`. For example, in your shell, you could write
+
+```sh
+curl -d "" https://myapp-sandbox.example.com/disable?dependency=google
+```
+
+Your app should return the message "For the next 5 minutes, all requests to urls containing 'google' will 500". You can then see how your app would behave if google were down, without the bother of having to actually DOS google.
+
+You must specify a dependency. If you want *all* external requests to fail, set `dependency=.`.  Any regular expression syntax will work, so if you want a subset of dependencies to fail, use a pipe-delimited list (`dependency=google|yahoo`).
+
+You can override the duration of the test by specifying `minutes=` with a number from 1 to 60.
+
+You can optionally specify the response body by setting `response=` and also the response header by setting `header=`. The endpoint to create a stubbed response uses query parameters, so your `response` and `header` fields must be URL encoded. For example, to return a response `{ "errors": "test_error" }`, you must send `response=%7B%20%22errors%22%3A%20%22test_error%22%20%7D`.
+
+You can also override the simulated response code, if your app is meant to handle different failures differently. `?dependency=google&failure=404` will simulate a 404 (Not Found) response instead of a 500 (Internal Server Error). `?dependency=google&failure=timeout` will pretend the server never responded at all (although it will raise an error instantly; the illusion is not perfect).
+
+### Sample calls and their effects
+
+```
+https://myapp-sandbox.example.com/disable?dependency=google
+```
+For the next 5 minutes, all requests to urls containing 'google' will 500.
+
+---
+
+```
+https://myapp-sandbox.example.com/disable?dependency=.&failure=403
+```
+For the next 5 minutes, all external requests will 403.
+
+---
+
+```
+https://myapp-sandbox.example.com/disable?dependency=sheep&failure=ssl_error
+```
+For the next 5 minutes, all external requests to urls containing `sheep` will raise a Faraday::SSLError.
+
+---
+
+```
+https://myapp-sandbox.example.com/disable?dependency=google|yahoo&minutes=10
+```
+For the next 10 minutes, all requests to urls containing 'google' and/or 'yahoo' will 500.
+
+---
+
+```
+https://myapp-sandbox.example.com/disable?dependency=google|yahoo&minutes=10&failure=timeout
+```
+For the next 10 minutes, all requests to urls containing 'google' and/or 'yahoo' will raise a Timeout error.
+
+---
+
+```
+https://myapp-sandbox.example.com/disable?dependency=google|yahoo&minutes=10&failure=timeout&response=%7B%20%22errors%22%3A%20%22test_error%22%20%7D
+```
+Similar to the above example, except all external requests that match will now return `{ "errors": "test_error" }`.
+
+---
+
+```
+https://myapp-sandbox.example.com/disable?dependency=google|yahoo&minutes=10&failure=timeout&response=%7B%20%22errors%22%3A%20%22test_error%22%20%7D&headers=%7B%20%22Content-Type%22%3A%20%22application%2Fjson%22%20%7D
+```
+Similar to the above example, except all external requests that match will now return `{ "errors": "test_error" }`, and will return the header `{ "Content-Type": "application/json" }`
+
+## Activating Aranea Programmatically
+
+From inside your application, you can run
+
+```ruby
+Aranea::Failure.create(
+  pattern: /google/,
+  minutes: 5,
+  failure: 503,
+  response_hash: { "errors": "test_error" },
+  response_headers_hash: { "Content-Type": "application/json" }
+)
+```
+
+All parameters are required in this form. They may alternatively be provided as strings ('google','5').
+
+## Adding Aranea To Your Project
+
+In your Gemfile:
+
+```ruby
+gem "aranea", "~> 0.1"
+```
+
+In your Faraday middleware stack (wherever and however you configure it):
+
+```ruby
+use Aranea::Faraday::FailureSimulator
+```
+
+Similarly, in your Rack middleware stack:
+
+```ruby
+if ENV['USE_ARANEA']
+  use Aranea::Rack::FailureCreator
+end
+```
+
+You'll want to ensure that Aranea (or at minimum the Rack middleware) is not active in production!
+
+## Caveats and Limitations
+
+Aranea needs to be included manually into every Faraday stack you have. If you miss one, or if you have a gem that makes http requests without using Faraday, your fault-tolerance test may falsely pass. Pull requests are welcome for compatibility with other http clients (aws-sdk is on the wishlist).
+
+Failures are not necessarily shared between processes. Aranea will use `Rails.cache` if it exists and is available when it starts up, so if `Rails.cache` is shared between processes, a POST that hits one app worker will disable requests from all of them. But if you're not using Rails, your cache is in-memory, your cache is a file cache and your workers can be on different servers, or something else goes wrong, then some requests are likely to get through. In particular, jobs executed in the background may not hit the failure, even if they execute within the specified time frame.
+
+## Owners
+
+Aranea is (c) Medidata Solutions Worldwide and owned by whoever committed to it most recently. Original concept by Matthew Szenher.

data/aranea.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/aranea/version"
+
+Gem::Specification.new do |s|
+  s.name        = "aranea"
+  s.version     = Aranea::VERSION
+  s.authors     = ["Aaron Weiner", "Matthew Szenher"]
+  s.email       = s.authors.map { |name| name.sub(/(.).* (.*)/, '\1\2@mdsol.com') }
+  s.homepage    = "https://github.com/mdsol/aranea"
+  s.summary     = "Middleware for fault tolerance testing"
+  s.description = "Rack and Faraday middleware to temporarily disable connections to external dependencies"
+  s.license     = "MIT"
+
+  s.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  s.metadata["homepage_uri"] = s.homepage
+  s.metadata["source_code_uri"] = s.homepage
+  s.metadata["changelog_uri"] = "#{s.homepage}/blob/master/CHANGELOG.md"
+
+  # 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.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activesupport", ">= 4.2"
+  s.add_dependency "faraday", ">= 0.9", "< 2.0"
+  s.add_dependency "rack"
+
+  s.add_development_dependency "pry-byebug"
+  s.add_development_dependency "rails"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rubocop-mdsol", "~> 0.1"
+end

data/lib/aranea.rb

@@ -1,2 +1,12 @@
-require 'aranea/rack/aranea_middleware'
-require 'aranea/faraday/aranea_middleware'
+# frozen_string_literal: true
+
+require "active_support/cache"
+require "active_support/core_ext/numeric/time"
+require "active_support/notifications"
+require "faraday"
+require "json"
+require "rack"
+
+require "aranea/failure_repository"
+require "aranea/rack/aranea_middleware"
+require "aranea/faraday/aranea_middleware"

data/lib/aranea/failure_repository.rb

@@ -1,33 +1,27 @@
-require 'faraday'
-require 'active_support/core_ext/numeric/time'
-require 'json'
+# frozen_string_literal: true
 
 module Aranea
-  
-  # TODO: Look into moving whitelisting of consumer hostnames to here and allowing it to be configurable via the consuming application
+  # TODO: Look into moving whitelisting of consumer hostnames to here and allowing it to be configurable
+  # via the consuming application
 
   class Failure
-    
     class << self
-
       def current
         retrieve_failure || NullFailure.new
       end
 
       def create(params)
-        if failure = retrieve_failure
-          raise FailureFailure, "A failure is already in progress (#{failure})."
-        else
-          failure = new(params)
-          Repository.store(failure, params[:minutes].minutes)
-          failure
-        end
+        failure = retrieve_failure
+        raise FailureFailure, "A failure is already in progress (#{failure})." if failure
+
+        failure = new(params)
+        Repository.store(failure, params[:minutes].minutes)
+        failure
       end
 
       def retrieve_failure
         Repository.get
       end
-
     end
 
     attr_accessor :expiration_date
@@ -39,15 +33,16 @@ module Aranea
       @response_headers_hash = params[:response_headers_hash] || {}
     end
 
-    def should_fail?(request_env, app)
+    def should_fail?(request_env, _app)
       @pattern.match(request_env[:url].to_s)
     end
 
     def respond!
-      if @response == 'timeout'
-        raise ::Faraday::Error::TimeoutError, 'Fake failure from Aranea'
-      elsif @response == 'ssl_error'
-        raise ::Faraday::SSLError, 'Fake failure from Aranea'
+      case @response
+      when "timeout"
+        raise ::Faraday::TimeoutError, "Fake failure from Aranea"
+      when "ssl_error"
+        raise ::Faraday::SSLError, "Fake failure from Aranea"
       else
         ::Faraday::Response.new(
           status: @response.to_i,
@@ -58,17 +53,15 @@ module Aranea
     end
 
     def to_s
-      "Failure on #{@pattern.inspect} ending at approximately #@expiration_date"
+      "Failure on #{@pattern.inspect} ending at approximately #{@expiration_date}"
     end
 
-    #TODO: Actually implement Repository pattern, dependency injection and all.
+    # TODO: Actually implement Repository pattern, dependency injection and all.
     # As is we only support sharing between multiple instances if Rails.cache exists and does
     class Repository
-      
-      KEY = 'aranea_current_failure'
+      KEY = "aranea_current_failure"
 
       class << self
-
         def store(failure, lifespan)
           failure.expiration_date = Time.now + lifespan
           cache.write(KEY, failure, expires_in: lifespan)
@@ -91,22 +84,16 @@ module Aranea
         end
 
         def memory_store
-          require 'active_support/cache'
+          require "active_support/cache"
           ActiveSupport::Cache::MemoryStore.new
         end
-
       end
-
     end
-
   end
 
   class NullFailure
-
-    def should_fail?(request_env, app)
+    def should_fail?(_request_env, _app)
       false
     end
-
   end
-
 end

data/lib/aranea/faraday/aranea_middleware.rb

@@ -1,30 +1,24 @@
-require 'aranea/failure_repository'
+# frozen_string_literal: true
 
 module Aranea
   module Faraday
-
     class FailureSimulator
-
       def initialize(app, config = {})
         @app = app
         @config = config
       end
 
       def call(request_env)
-
         current_failure = Failure.current
 
         if current_failure.should_fail?(request_env, @app)
-          #TODO: injectable logger
+          # TODO: injectable logger
           puts "Aranea: simulating a failed call on #{request_env}"
           current_failure.respond!
         else
           @app.call(request_env)
         end
-
       end
-
     end
-
   end
 end

data/lib/aranea/rack/aranea_middleware.rb

@@ -1,17 +1,12 @@
-require 'aranea/failure_repository'
-require 'rack'
-require 'json'
+# frozen_string_literal: true
 
 module Aranea
-
   FailureFailure = Class.new(RuntimeError)
 
-  ALLOWED_MINUTES = 1..60
+  ALLOWED_MINUTES = (1..60).freeze
 
   module Rack
-
     class FailureCreator
-
       def initialize(app, config = {})
         @app = app
         @config = config
@@ -20,11 +15,11 @@ module Aranea
       def call(env)
         if failure_creation_request?(env)
           response = begin
-            [create_failure(::Rack::Utils.parse_query(env['QUERY_STRING'])), 201, {}]
+            [create_failure(::Rack::Utils.parse_query(env["QUERY_STRING"])), 201, {}]
           rescue FailureFailure => e
             [e.message, 422, {}]
-          rescue
-            [$!.message, 500, {}]
+          rescue => e
+            [e.message, 500, {}]
           end
           ::Rack::Response.new(*response).finish
         else
@@ -32,18 +27,20 @@ module Aranea
         end
       end
 
-    protected
+      protected
 
       def failure_creation_request?(env)
-        env['REQUEST_METHOD'] == 'POST' && env['PATH_INFO'] == '/disable'
+        env["REQUEST_METHOD"] == "POST" && env["PATH_INFO"] == "/disable"
       end
 
       def create_failure(options)
-        dependency = options.fetch('dependency') { raise FailureFailure, 'Please provide a dependency to simulate failing' }
-        minutes    = options.fetch('minutes')    { 5 }
-        failure    = options.fetch('failure')    { '500' }
-        response   = options.fetch('response')   { '{}' } # Expect URI encoded
-        headers    = options.fetch('headers')    { '{}' }
+        dependency = options.fetch("dependency") do
+          raise FailureFailure, "Please provide a dependency to simulate failing"
+        end
+        minutes    = options.fetch("minutes", 5)
+        failure    = options.fetch("failure", "500")
+        response   = options.fetch("response", "{}") # Expect URI encoded
+        headers    = options.fetch("headers", "{}")
 
         # These will emit a parsing error if the response/headers URI encoded string is malformed.
         response_hash = JSON.parse(CGI.unescape(response)).to_hash
@@ -54,7 +51,8 @@ module Aranea
         end
 
         unless ALLOWED_MINUTES.cover?(minutes.to_i)
-          raise FailureFailure, "minutes should be an integer from #{ALLOWED_MINUTES.begin} to #{ALLOWED_MINUTES.end}, got #{minutes}"
+          raise FailureFailure,
+            "minutes should be an integer from #{ALLOWED_MINUTES.begin} to #{ALLOWED_MINUTES.end}, got #{minutes}"
         end
 
         Failure.create(
@@ -65,16 +63,14 @@ module Aranea
           response_headers_hash: response_headers_hash
         )
 
-        result = "For the next #{minutes} minutes, all requests to urls containing '#{dependency}' will #{failure.downcase}"
+        result = "For the next #{minutes} minutes, all requests to urls containing '#{dependency}' " \
+          "will #{failure.downcase}"
 
-        #TODO: injectable logger
+        # TODO: injectable logger
         puts "Aranea: #{result}"
 
         result
-
       end
-
     end
-
   end
 end

data/lib/aranea/version.rb

@@ -1,5 +1,5 @@
-module Aranea
-
-  VERSION = '0.0.3'
+# frozen_string_literal: true
 
+module Aranea
+  VERSION = "0.1.0"
 end

metadata

@@ -1,46 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: aranea
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Aaron Weiner
 - Matthew Szenher
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +74,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +88,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,19 +102,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rubocop-mdsol
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 description: Rack and Faraday middleware to temporarily disable connections to external
   dependencies
 email:
@@ -118,6 +124,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- aranea.gemspec
 - lib/aranea.rb
 - lib/aranea/failure_repository.rb
 - lib/aranea/faraday/aranea_middleware.rb
@@ -126,8 +141,11 @@ files:
 homepage: https://github.com/mdsol/aranea
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/mdsol/aranea
+  source_code_uri: https://github.com/mdsol/aranea
+  changelog_uri: https://github.com/mdsol/aranea/blob/master/CHANGELOG.md
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -135,15 +153,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.5
+      version: '0'
 requirements: []
-rubygems_version: 3.2.16
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Middleware for fault tolerance testing
 test_files: []