svcdeps_tasks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06f106ec4c75f6fae0a5ed460659ee6ba2a75e5b
+  data.tar.gz: 36b89010e65030cd0c648391b4513f2e82c97e4d
+SHA512:
+  metadata.gz: 86b514f2d7ec4b34d78497ff6c5e96c96ee5998c54314e4a8c684b498bfd20891bdd07ed478e7ea09971b41fb7f1f30ea817de50c35a2ba826d51cf4d234983a
+  data.tar.gz: ed20a62f4e464ba8cb71677fde5fcef820882b5b791421c07b6d07b9ff4c7de895628e8ef31b4b25578fe3cb71d61c9cc073b0227e821dd184c0fa983915a2a7

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in svcdeps_tasks.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    svcdeps_tasks (0.1.0)
+      rspec (~> 3.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  svcdeps_tasks!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 
+
+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,56 @@
+# RSpec tests for Service Dependencies
+
+### USAGE 
+
+Add the following to Rakefile: 
+
+```ruby
+require 'svcdeps_tasks'
+
+ENV['SVCDEPS_PATH'] = '/etc/svcdeps'
+```
+
+And save yaml files  describing how to check the  service dependencies, like: 
+
+```yaml
+deps: 
+  - type: tcp
+    host: www.google.com
+    port: 80
+    timeout: 2
+    desc: Should be able to tcp port ping www.google.com:80
+    
+  - type: udp
+    host: 8.8.8.8
+    port: 53
+    timeout: 2
+    desc: Should be able to udp port ping DNS server(8.8.8.8:53)
+
+  - type: http
+    method: get
+    url: https://www.google.com
+    insecure: false
+    timeout: 2
+    desc: Should be able to hit https://www.google.com
+    
+  - type: command
+    run_as: nobody
+    command: ping -c 1 8.8.8.8
+    timeout: 2 
+    desc: Should be able to ping 8.8.8.8
+```
+
+Running: 
+
+```
+# rake spec:svcdeps
+
+Service Dependencies
+  Should be able to tcp port ping www.google.com:80
+  Should be able to udp port ping DNS server(8.8.8.8:53)
+  Should be able to hit https://www.google.com
+  Should be able to ping 8.8.8.8
+
+Finished in 0.16224 seconds (files took 0.28904 seconds to load)
+4 examples, 0 failures
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "svcdeps_tasks"
+
+# 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/lib/probe.rb

@@ -0,0 +1,104 @@
+require 'socket'
+require 'timeout'
+require 'etc'
+require 'yaml'
+require 'net/http'
+require 'openssl'
+
+class Probe
+  def initialize(opts)
+    @type = opts[:type].downcase
+    @timeout = opts[:timeout] || 5
+    @opts = opts
+  end
+
+  def tcp_probe
+    host = @opts[:host]
+    port = @opts[:port] 
+    Timeout::timeout(@timeout) do 
+      TCPSocket.new(host, port).close
+    end 
+  end
+
+  def udp_probe
+    host = @opts[:host]
+    port = @opts[:port]
+    Timeout::timeout(@timeout) do 
+      u = UDPSocket.new
+      u.connect(host,port)
+      u.puts "check"
+    end
+  end
+
+  def command_probe
+    cmd =  @opts[:command]
+    run_as = @opts[:run_as]
+    
+    if run_as.nil? 
+      run_as = 'nobody' if Process.uid.zero?
+    else
+      warn "WARNNG: Option 'run_as' requires root, ignoring it." unless Process.uid.zero? 
+      run_as = nil unless Process.uid.zero? 
+    end 
+
+    Timeout::timeout(@timeout) do 
+      user = Etc.getpwnam('nobody')
+      pid = Process.fork do
+        STDOUT.reopen('/dev/null')
+        STDERR.reopen('/dev/null')
+        unless run_as.nil? 
+          Process.egid = Process.gid = user.gid
+          Process.euid = Process.uid = user.uid
+        end
+        exec cmd
+      end
+      status = Process.wait pid
+      exit_status = $?.exitstatus 
+      raise "Command [#{cmd}] exited with #{exit_status}" if exit_status > 0
+    end
+  end
+
+  def http_probe
+    url = @opts[:url]
+    method = @opts[:method] || 'get'
+    payload = @opts[:payload]  if @opts.key? :payload
+    insecure = @opts[:insecure] || false
+    headers = @opts[:headers] || {}
+
+    Timeout::timeout(@timeout) do 
+      uri = URI(url)
+      is_https = uri.scheme == 'https'
+      
+      uri.path = '/' if uri.path.empty? 
+      req = Object.const_get("Net::HTTP::#{method.capitalize}").new(uri.path)
+      req.body = payload
+       
+      headers.each {|k,v| req[k] = v }
+    
+      opts = {} 
+      opts[:use_ssl] = is_https 
+      opts[:verify_mode] = OpenSSL::SSL::VERIFY_NONE if is_https && insecure 
+    
+      Net::HTTP.start( uri.host, uri.port, opts ) do |http|
+        res = http.request(req)
+        raise "Request to #{url} returned code #{res.code}" unless res.code == '200'
+      end
+    end
+  end
+
+  def run 
+    case @type 
+      when 'tcp'
+        tcp_probe 
+      when 'udp'
+        udp_probe
+      when 'command'
+        command_probe
+      when 'http'
+        http_probe
+      else 
+        raise "Type '#{@type}' not supported"
+    end
+  end
+end
+

data/lib/specfile.rb

@@ -0,0 +1,33 @@
+require 'rspec'
+
+dir = File.dirname(File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__)
+require "#{dir}/probe"
+require 'deep_merge'
+require 'yaml'
+
+deps = {}
+deps_dir = ENV['SVCDEPS_PATH']
+deps_files = []
+
+raise "Environment variable 'SVCDEPS_PATH' must be set" unless deps_dir
+
+Dir.chdir(deps_dir)
+Dir.glob(File.join('**','*.yaml')).each {|f| deps_files << "#{deps_dir}/#{f}" } 
+
+def symbolize_keys(hash)
+   hash.inject({}){|memo,(k,v)| memo[k.to_sym] = v ; memo }
+end
+
+deps_files.each do |f|
+  deps.deep_merge(YAML.load( File.read( f ) ) ) 
+end
+
+describe 'Service Dependencies' do 
+  deps['deps'].each do |dep|
+    dep = symbolize_keys(dep)
+    it "#{dep[:desc]}" do 
+      p = Probe.new( dep ) 
+      expect { p.run }.to_not raise_error
+    end
+  end
+end

data/lib/svcdeps_tasks/version.rb

@@ -0,0 +1,3 @@
+module SvcdepsTasks
+  VERSION = "0.1.0"
+end

data/lib/svcdeps_tasks.rb

@@ -0,0 +1,16 @@
+require 'svcdeps_tasks/version'
+require 'rspec'
+require 'rake'
+
+dir = File.dirname(File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__)
+
+namespace :spec do 
+  desc 'run service dependencies specs '
+  task :svcdeps do
+    RSpec.configure do |c|
+      c.add_formatter(:documentation)
+     end
+   
+    RSpec::Core::Runner.run(["#{dir}/specfile.rb"],STDOUT, STDERR)
+  end
+end

data/svcdeps_tasks.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "svcdeps_tasks/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "svcdeps_tasks"
+  spec.version       = SvcdepsTasks::VERSION
+  spec.authors       = ["Tiago Lopo"]
+  spec.email         = ["tiagolopo@yahoo.com.br"]
+
+  spec.summary       = %q{RSpec tests for service dependencies}
+  spec.description   = %q{RSpec tests for service dependencies}
+  spec.homepage      = "https://github.com/tlopo-ruby/svcdeps_tasks"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: svcdeps_tasks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tiago Lopo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: RSpec tests for service dependencies
+email:
+- tiagolopo@yahoo.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/probe.rb
+- lib/specfile.rb
+- lib/svcdeps_tasks.rb
+- lib/svcdeps_tasks/version.rb
+- svcdeps_tasks.gemspec
+homepage: https://github.com/tlopo-ruby/svcdeps_tasks
+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.6.14
+signing_key: 
+specification_version: 4
+summary: RSpec tests for service dependencies
+test_files: []