health_check_toolbox 1.0.1

data/spec/health_check_toolbox/health_controller_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe HealthCheckToolbox::HealthController, type: :controller do
+  let(:body) { JSON.parse(response.body) }
+
+  describe 'GET' do
+    describe '#service_status' do
+      let(:version) { '1.3.0' }
+
+      before do
+        allow(File).to receive(:read).
+          with('.version').and_return("#{version}\n")
+
+        get :service_status
+      end
+
+      it { expect(body['ok']).to be_truthy }
+      it { expect(body['version']).not_to be_nil }
+      it { expect(body['version']).to eq(version) }
+    end
+
+    describe '#health_check' do
+      let(:status) do
+        {
+          'status_1' => 'redis_service:ok',
+          'status_2' => 'database:ok'
+        }
+      end
+
+      before do
+        allow(HealthCheckToolbox::Config).
+          to receive(:services_status).and_return(status)
+
+        get :health_check
+      end
+
+      it { expect(body).to have_key('timestamp') }
+      it { expect(body['timestamp']).not_to be_nil }
+      it { expect(body).to have_key('health_check') }
+      it { expect(body['health_check']).not_to be_empty }
+      it { expect(body['health_check'].first).to have_key('status_1') }
+      it { expect(body['health_check'].first).to have_key('status_2') }
+    end
+  end
+end

data/spec/health_check_toolbox/services/database_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe HealthCheckToolbox::Services::Database do
+  subject { described_class.new.try_connect }
+
+  describe '#try_connect' do
+    context 'when database is up' do
+      it { is_expected.to eq('ok') }
+    end
+
+    context 'when database is down' do
+      before { allow(ActiveRecord::Base).to receive(:connection) }
+
+      it { is_expected.to eq('erro') }
+    end
+  end
+end

data/spec/health_check_toolbox/services/redis_service_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe HealthCheckToolbox::Services::RedisService do
+  before { allow(Redis).to receive(:new).send(return_method, method_response) }
+
+  subject do
+    described_class.new.try_connect
+  end
+
+  describe '#try_connect' do
+    context 'when redis is up' do
+      let(:method_response) { double(ping: 'PONG') }
+      let(:return_method) { :and_return }
+
+      it { is_expected.to eq('ok') }
+    end
+
+    context 'when redis is down' do
+      let(:method_response) { double(ping: 'BOOM') }
+      let(:return_method) { :and_raise }
+
+      it { is_expected.to eq('erro') }
+    end
+  end
+end

data/spec/health_check_toolbox/services/rest_services_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe HealthCheckToolbox::Services::RestServices do
+  let(:rest_services) { described_class.new(args, block).services }
+  let(:args) { [] }
+  let(:return_method) { :and_return }
+  let(:method_response) { nil }
+  let(:block) do
+    proc do
+      file_storage_service 'http://google.com'
+      asset_classification_service 'http://guide.com.br'
+    end
+  end
+
+  before do
+    allow(Wso2Toolbox::TokenManager).to receive(:generate_token)
+    allow(RestClient).to receive(:get).send(return_method, method_response)
+  end
+
+  subject { rest_services.collect(&:try_connect) }
+
+  describe '#try_connect' do
+    context 'when all services is up' do
+      context 'and returning http code 200' do
+        let(:method_response) { double(code: 200) }
+
+        it { is_expected.to all(eq('ok')) }
+      end
+
+      context 'and returning http code 500' do
+        let(:method_response) { double(code: 500) }
+
+        it { is_expected.to all(eq('erro')) }
+      end
+    end
+
+    context 'when all services is down' do
+      let(:return_method) { :and_raise }
+
+      it { is_expected.to all(eq('erro')) }
+    end
+  end
+end

data/spec/health_check_toolbox/services/wso2_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe HealthCheckToolbox::Services::Wso2 do
+  subject do
+    described_class.new.try_connect
+  end
+
+  describe '#try_connect' do
+    context 'when wso2 is up' do
+      before { allow(Wso2Toolbox::TokenManager).to receive(:generate_token) }
+
+      it { is_expected.to eq('ok') }
+    end
+
+    context 'when wso2 is down' do
+      before do
+        allow(Wso2Toolbox::TokenManager).to receive(:generate_token).
+          and_raise('boom')
+      end
+
+      it { is_expected.to eq('erro') }
+    end
+  end
+end

data/spec/health_check_toolbox/status_manager_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe HealthCheckToolbox::StatusManager do
+  describe '.generate' do
+    let(:default_services) do
+      [
+        HealthCheckToolbox::Services::RedisService.new([redis], nil),
+        HealthCheckToolbox::Services::Database.new([database], nil)
+      ]
+    end
+    let(:database) { true }
+    let(:redis) { true }
+    let(:service_response) { 'ok' }
+
+    before do
+      allow_any_instance_of(HealthCheckToolbox::Services::RedisService).
+        to receive(:try_connect).and_return(service_response)
+      allow_any_instance_of(HealthCheckToolbox::Services::Database).
+        to receive(:try_connect).and_return(service_response)
+    end
+
+    subject(:status) { described_class.generate(default_services) }
+
+    context 'when status are ok' do
+      it do
+        expect(status[:status_1]).to eq("redis_service:#{service_response}")
+      end
+      it { expect(status[:status_2]).to eq("database:#{service_response}") }
+    end
+
+    context 'when status has error' do
+      let(:service_response) { 'erro' }
+
+      it do
+        expect(status[:status_1]).to eq("redis_service:#{service_response}")
+      end
+      it { expect(status[:status_2]).to eq("database:#{service_response}") }
+    end
+
+    context 'with rest_services block', test: true do
+      let(:services) { [default_services, @rest_services].flatten }
+      let(:block) do
+        proc do
+          file_storage_service 'http://google.com'
+          asset_classification_service 'http://guide.com.br'
+        end
+      end
+
+      before do
+        @rest_services = HealthCheckToolbox::Services::RestServices.new(
+          [], block
+        )
+
+        allow_any_instance_of(
+          HealthCheckToolbox::Services::FileStorageService
+        ).to receive(:try_connect).and_return(service_response)
+
+        allow_any_instance_of(
+          HealthCheckToolbox::Services::AssetClassificationService
+        ).to receive(:try_connect).and_return(service_response)
+      end
+
+      subject(:status) { described_class.generate(services) }
+
+      it do
+        expect(status[:status_3]).
+          to eq("file_storage_service:#{service_response}")
+      end
+
+      it do
+        expect(status[:status_4]).
+          to eq("asset_classification_service:#{service_response}")
+      end
+    end
+  end
+end

data/spec/health_check_toolbox_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe HealthCheckToolbox do
+  it 'has a version number' do
+    expect(HealthCheckToolbox::VERSION).not_to be nil
+  end
+
+  describe '.setup' do
+    let(:config) { double(instance_eval: true) }
+    let(:block) { proc { redis_service true } }
+
+    before do
+      allow(HealthCheckToolbox::Config).to receive(:new).and_return(config)
+    end
+
+    subject { described_class.setup(&block) }
+
+    it { is_expected.to be_truthy }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require File.expand_path('dummy/config/environment.rb', __dir__)
+require 'bundler/setup'
+require 'rspec/rails'
+require 'health_check_toolbox'
+require 'pry-byebug'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = '.rspec_status'
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,263 @@
+--- !ruby/object:Gem::Specification
+name: health_check_toolbox
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Tatiane Guedes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wso2_toolbox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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:
+- t.coleto@prestserv.guide.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- config/locales/en.yml
+- config/routes.rb
+- lib/health_check_toolbox.rb
+- lib/health_check_toolbox/config.rb
+- lib/health_check_toolbox/engine.rb
+- lib/health_check_toolbox/health_check_routes.rb
+- lib/health_check_toolbox/health_controller.rb
+- lib/health_check_toolbox/services/base_health_check.rb
+- lib/health_check_toolbox/services/database.rb
+- lib/health_check_toolbox/services/redis_service.rb
+- lib/health_check_toolbox/services/rest_services.rb
+- lib/health_check_toolbox/services/wso2.rb
+- lib/health_check_toolbox/status_manager.rb
+- lib/health_check_toolbox/version.rb
+- spec/dummy/Rakefile
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/update
+- spec/dummy/bin/yarn
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/content_security_policy.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/spring.rb
+- spec/dummy/config/storage.yml
+- spec/dummy/package.json
+- spec/health_check_toolbox/config_spec.rb
+- spec/health_check_toolbox/health_controller_spec.rb
+- spec/health_check_toolbox/services/database_spec.rb
+- spec/health_check_toolbox/services/redis_service_spec.rb
+- spec/health_check_toolbox/services/rest_services_spec.rb
+- spec/health_check_toolbox/services/wso2_spec.rb
+- spec/health_check_toolbox/status_manager_spec.rb
+- spec/health_check_toolbox_spec.rb
+- spec/spec_helper.rb
+homepage: http://bitbucket.org/guideinvestimentos/health_check_toolbox
+licenses: []
+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.7
+signing_key: 
+specification_version: 4
+summary: Tools to provide service status routes and health check
+test_files:
+- spec/dummy/bin/rake
+- spec/dummy/bin/yarn
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/update
+- spec/dummy/bin/setup
+- spec/dummy/package.json
+- spec/dummy/config.ru
+- spec/dummy/config/cable.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/content_security_policy.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/puma.rb
+- spec/dummy/config/application.rb
+- spec/dummy/config/spring.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/storage.yml
+- spec/dummy/Rakefile
+- spec/health_check_toolbox/health_controller_spec.rb
+- spec/health_check_toolbox/config_spec.rb
+- spec/health_check_toolbox/services/database_spec.rb
+- spec/health_check_toolbox/services/wso2_spec.rb
+- spec/health_check_toolbox/services/rest_services_spec.rb
+- spec/health_check_toolbox/services/redis_service_spec.rb
+- spec/health_check_toolbox/status_manager_spec.rb
+- spec/health_check_toolbox_spec.rb
+- spec/spec_helper.rb