apollo-tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf47e43e21817b0f44a20841de0ed23d30513bf7
+  data.tar.gz: f2b4cfb6abb1b9923787d5a1d8cd3a0a30bf1ed2
+SHA512:
+  metadata.gz: cfdb188c89f2f0b7de51419707bed1cbe85761f0ca29a1aa7a10ef92003652ddf20cdcf318ddb4ff1000d8821ed9ad6ae83e769ac5b8f56a3d9b1d5512034f44
+  data.tar.gz: e23b5cd5f8bfbb740cad53d9f662e7fc1658d9d79e0ac74047d581550948003c52b44c9183f815b4d6db7fd33760423c3c772bc21c28e1e15978c4c7e9bbebd6

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+apollo.iml
+.bin
+.vendor

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in apollo.gemspec
+gemspec

data/README.md

@@ -0,0 +1,49 @@
+# Apollo
+
+Apollo is a gem for interacting with remote hosts. Its based around the idea of an inventory defining the available
+resources. So for this inventory:
+
+```yaml
+---
+hosts:
+  vagrant:
+    ip: 192.168.100.4
+    user: vagrant
+```
+
+You would be able to run an ssh command by running `cluster.run(:vagrant, '/bin/true')`. This is very much a work in
+progress as I figure out what needs to be in here.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apollo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apollo
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/signalvine/apollo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end

data/Vagrantfile

@@ -0,0 +1,15 @@
+Vagrant.configure(2) do |config|
+  # Using a 32 bit box so that everyone can run the tests
+  config.vm.box = "hashicorp/precise32"
+
+  # Force vagrant to use virtualbox as there is only a virtualbox image for hashicorp/precise32
+  config.vm.provider "virtualbox" do |v|
+    v.memory = 1024
+    v.cpus = 1
+  end
+
+  # Disable the random key generation so that we can connect in the test suite
+  config.ssh.insert_key = false
+
+  config.vm.network "private_network", ip: "192.168.100.4"
+end

data/apollo.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apollo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apollo-tools"
+  spec.version       = Apollo::VERSION
+  spec.authors       = ['Brendan Tobolaski']
+  spec.email         = ['brendan@signalvine.com']
+
+  spec.summary       = 'A gem for interacting with remote hosts in various ways'
+  spec.homepage      = 'https://github.com/signalvine/apollo'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'minitest', '~> 5.5.1'
+
+  spec.add_dependency 'rabbitmq_manager', '~> 0.3.0'
+  spec.add_dependency 'net-ssh', '~> 2.9.2'
+end

data/bin/console

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

data/bin/setup

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

data/lib/apollo.rb

@@ -0,0 +1,152 @@
+require "apollo/version"
+require "yaml"
+require 'net/ssh'
+
+module Apollo
+  class Cluster
+
+    # Creates a new cluster
+    #
+    # @param opts [Hash].
+    # @option opts [String] :filename The complete path to the inventory file ("#{Dir.pwd}/inventory.yml")
+    # @return [Cluster]
+    def initialize(opts = {})
+      filename = opts.fetch(:filename, "#{Dir.pwd}/inventory.yml")
+      inventory = YAML.load_file(filename)
+
+      begin
+        hosts = inventory.fetch('hosts')
+        raise 'host list empty' if hosts.nil?
+        @hosts = process_host_list hosts
+      rescue NoMethodError
+        raise 'host key not defined in inventory file'
+      end
+    end
+
+    # Gets a host
+    #
+    # @param host [Symbol] The host to get
+    # @return [Hash, nil] Either the host or nil if the host doesn't exist
+    def get_host(host)
+      @hosts[host]
+    end
+
+    # Connects to the rabbitmq admin port on the specified host and waits until the specified queue has no messags
+    #
+    # @param host [Symbol] The host that the queue is on
+    # @param queue [String] The name of the queue to wait on
+    #
+    # @param opts [Hash]
+    # @option opts [Float]      :sleep_duration The number of seconds (1) to wait between checking the queue
+    # @option opts [Float, nil] :timeout The number of seconds (nil) to wait before throwing an exception
+    # @option opts [String]     :vhost The vhost ('/') that the queue is in
+    #
+    # @raise [RuntimeError] when the host is not in the inventory or the timeout has been exceeded
+    #
+    # @return [void] Only returns when the queue is empty
+    def wait_for_queue_drain(host, queue, opts = {})
+      raise "host #{host} not configured in the inventory" if @hosts[host].nil?
+
+      sleep_duration = opts.fetch(:sleep_duration, 1)
+      timeout = opts.fetch(:timeout, nil)
+
+      start = Time.now
+      while check_queue_length(host, queue, opts) != 0
+        if not timeout.nil? and (Time.now.to_f - start.to_f) > timeout
+          raise 'wait_for_queue_drain exceeded timeout'
+        end
+        sleep sleep_duration
+      end
+    end
+
+    # Connects to the rabbitmq admin port on the specified host and gets the number of messages waiting in the specified
+    # queue
+    # @param host [Symbol] The host of the rabbitmq server
+    # @param queue [String] The queue to check
+    #
+    # @param opts [Hash]
+    # @option opts [String] :vhost The vhost ('/') that the queue is in
+    #
+    # @return [Integer] The number of messages waiting in the specified queue
+    def check_queue_length(host, queue, opts={})
+      host = @hosts[host]
+      vhost = opts.fetch(:vhost, '/')
+      username = CGI.escape host.fetch('rmq_username', 'guest')
+      password = CGI.escape host.fetch('rmq_password', 'guest')
+      port = host.fetch('rmq_port', 15672)
+
+      manager = RabbitMQManager.new "http://#{username}:#{password}@#{address host}:#{port}"
+      manager.queue(vhost, queue)['messages']
+    end
+
+    # Runs the specified command on the specified host
+    #
+    # @param on [Symbol] The host to run the command on
+    # @param command [String] The command ('/bin/true') to run
+    #
+    # @param opts [Hash] Additional options for the ssh connection. For the complete list, see http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start
+    # @option opts [bool] :forward_agent (true) whether to forward the current user's agent
+    # @option opts [bool] :allow_unsuccessful (false) whether a non-zero exit call raises an exception or not
+    #
+    # @return [String]
+    # @raises [RuntimeError] when the host
+    def run(on, command = '/bin/true', opts= {})
+      host = @hosts[on]
+      raise "#{on} doesn't exist in the inventory" if host.nil?
+      opts[:forward_agent] = opts.fetch(:forward_agent, true)
+
+      output = ""
+      rc = 0
+      Net::SSH.start(address(host), host['user'], opts) do |ssh|
+        chan = ssh.open_channel do |ch|
+          ch.exec command do |ch, success|
+            raise "#{command} didn't complete successfully" if not success and not opts.fetch(:allow_unsuccessful, false)
+          end
+
+          ch.on_data do |c, data|
+            output += data
+          end
+
+          ch.on_extended_data do |c, type, data|
+            output += data
+          end
+
+          ch.on_request "exit-status" do |ch, data|
+            rc = data.read_long
+          end
+        end
+
+        chan.wait
+        raise "#{command} didn't complete successfully" unless rc == 0
+        return output
+      end
+    end
+
+    private
+
+    # Parses the inventory that gets read off of disk. It converts the keys to symbols.
+    # @param host_list [Hash]
+    # @return [Hash]
+    # @raise [RuntimeError] when some required fields aren't specified
+    def process_host_list(host_list)
+      list = {}
+      host_list.each do |key, value|
+        raise "host #{key} is not addressable" if value['ip'].nil? and value['hostname'].nil?
+        raise "host #{key} has an invalid rmq_port #{value['rmq_port']}" unless value['rmq_port'].nil? or value['rmq_port'].is_a? Numeric
+        list[key.to_sym] = value
+      end
+      list
+    end
+
+    # Gets the specified host's proper addressing
+    # @param host [Hash] The host that we want to address
+    # @return [String] The address to connect to the host on
+    def address(host)
+      unless host['ip'].nil?
+        host['ip']
+      else
+        host['hostname']
+      end
+    end
+  end
+end

data/lib/apollo/version.rb

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

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: apollo-tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brendan Tobolaski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+- !ruby/object:Gem::Dependency
+  name: rabbitmq_manager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.2
+description: 
+email:
+- brendan@signalvine.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- Vagrantfile
+- apollo.gemspec
+- bin/console
+- bin/setup
+- lib/apollo.rb
+- lib/apollo/version.rb
+homepage: https://github.com/signalvine/apollo
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A gem for interacting with remote hosts in various ways
+test_files: []