the_runner 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c174cbb0b588944e2b98a96456888524377408f3
+  data.tar.gz: 4eec30802e33873199b4a9e91ddf9e7adb4c68b9
+SHA512:
+  metadata.gz: 28463bca208e35d65aada635106110c63200e35f58b25c4795fec1ac760cd9b1ffe248b25fca2c63943157483d7a4b30b2c67187d505593597c65eff9548cd08
+  data.tar.gz: b6ad5aed807acae81355452f7f7c65e38ba7ffa113667537ced5d1adbaab375e1c21bb894ac4bc2c18da838f060f81429838bdcf2e1a9aafa2beb7dab147b3d5

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Leszek Stachowski <leszek@stachowski.me>
+
+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,138 @@
+# The Runner
+
+## Disclaimer
+
+This version is just a rough proof of concept. There is basically no error handling, no argument type checking, no docs,
+no tests. I just wanted to have my own solution to run commands across multiple servers (ideally in parallel) and that's how
+this project started. If you somehow come across the library and use it, don't hesitate to open bug / improvement tickets or
+send me a PR.
+
+## Overview
+
+The Runner is a ruby library that provides a solution for running ssh commands across multiple servers. It's supposed to be
+ highly extendable and configurable. It lets you also run commands in parallel.
+
+## Installation
+
+    gem install the_runner
+
+## Usage
+
+### Direct
+
+This direct usage example you can try using `irb` or by embedding it into ruby file.
+
+```ruby
+require 'the_runner'
+
+the_runner = TheRunner.new
+the_runner['default'] = TheRunner::Context.new do |context|
+    context.add_server('host.example.com')
+    context.command = 'echo "Hello World!"'
+end
+the_runner.run('default')
+```
+
+### Therunnerfile
+
+The Runner supports so called `Therunnerfile`. Below you can find contents of `Therunnerfile` which is part of the library for
+demonstration purposes. It contains almost all possible configuration options out there.
+
+```ruby
+
+TheRunner.context("example-ls") do |context|
+  # Adding single server
+  context.add_server('host.example.com')
+  # Command to run on specified server
+  context.command = 'ls -al'
+end
+
+TheRunner.context("example-ls-multiple") do |context|
+  context.add_server('host.example.com')
+  # Adding another server, command will be executed sequentially
+  context.add_server('another.example.com')
+  context.command = 'ls -al'
+end
+
+TheRunner.context("example-ls-multiple-add-servers") do |context|
+  # Instead of calling add_server twice, you can call add_servers once with array of servers
+  context.add_servers(['host.example.com', 'another.example.com'])
+  context.command = 'ls -al'
+end
+
+TheRunner.context("example-server-config") do |context|
+  # Both add_servers and add_server will yield a server config if you provide a block. In this
+  # case both servers will share the same config.
+  context.add_servers(['host.example.com', 'another.example.com']) { |config|
+    config.runner_options = {
+      # Will disable key checks while connecting to server (default: false) by
+      # prepending '-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no'
+      :disable_key_checking => true,
+      # Will use this username while connecting to server (default: nil, no username
+      # would be used)
+      :user => 'root',
+      # Will enable ssh debugging by adding '-vvv' to the command
+      :debug => true,
+    }
+  }
+  context.command = 'ls -al'
+end
+
+TheRunner.context("example-mutiple-configs") do |context|
+  # We specify one host with specific config
+  context.add_server('host.example.com') { |config|
+    config.runner_options = {
+      :user => 'root',
+    }
+  }
+
+  # Another host with different config
+  context.add_server('another.example.com') { |config|
+    config.runner_options = {
+      :debug => true,
+    }
+  }
+
+  # And yet another host without any config (which means: default one)
+  context.add_server('yet-another.example.com')
+  context.command = 'ls -al'
+end
+
+TheRunner.context("example-parallel") do |context|
+  context.add_server('host.example.com') { |config|
+    config.runner_options = {
+      :user => 'root',
+    }
+  }
+  context.add_server('another.example.com') { |config|
+    config.runner_options = {
+      :debug => true,
+    }
+  }
+  context.add_server('yet-another.example.com')
+  context.command = 'ls -al'
+  # Parallel option means that the specified command will be executed in parallel
+  # (in multiple threads) instead of sequentially.
+  context.config.parallel = true
+end
+
+# Default context
+TheRunner.context do |context|
+  context.add_server('host.example.com')
+  context.command = 'uptime'
+end
+```
+
+And run command in following format:
+
+    the_runner <context name>
+
+for example:
+
+    the_runner example-ls
+
+inside directory containing the file to execute The Runner in "example-ls" context from the example `Therunnerfile`.
+
+Things to remember:
+* If you specify only one context, it will be by executed always by default, no matter what you specify on command line.
+* If you don't specify <context name> on command line, "default" will be used if provided.

data/Therunnerfile

@@ -0,0 +1,81 @@
+TheRunner.context("example-ls") do |context|
+  # Adding single server
+  context.add_server('host.example.com')
+  # Command to run on specified server
+  context.command = 'ls -al'
+end
+
+TheRunner.context("example-ls-multiple") do |context|
+  context.add_server('host.example.com')
+  # Adding another server, command will be executed sequentially
+  context.add_server('another.example.com')
+  context.command = 'ls -al'
+end
+
+TheRunner.context("example-ls-multiple-add-servers") do |context|
+  # Instead of calling add_server twice, you can call add_servers once with array of servers
+  context.add_servers(['host.example.com', 'another.example.com'])
+  context.command = 'ls -al'
+end
+
+TheRunner.context("example-server-config") do |context|
+  # Both add_servers and add_server will yield a server config if you provide a block. In this
+  # case both servers will share the same config.
+  context.add_servers(['host.example.com', 'another.example.com']) { |config|
+    config.runner_options = {
+      # Will disable key checks while connecting to server (default: false) by
+      # prepending '-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no'
+      :disable_key_checking => true,
+      # Will use this username while connecting to server (default: nil, no username 
+      # would be used)
+      :user => 'root',      
+      # Will enable ssh debugging by adding '-vvv' to the command
+      :debug => true,      
+    }
+  }
+  context.command = 'ls -al'
+end
+
+TheRunner.context("example-mutiple-configs") do |context|
+  # We specify one host with specific config
+  context.add_server('host.example.com') { |config|
+    config.runner_options = {
+      :user => 'root',
+    }
+  }
+  
+  # Another host with different config
+  context.add_server('another.example.com') { |config|
+    config.runner_options = {
+      :debug => true,
+    }
+  }
+  
+  # And yet another host without any config (which means: default one)
+  context.add_server('yet-another.example.com')
+  context.command = 'ls -al'
+end
+
+TheRunner.context("example-parallel") do |context|
+  context.add_server('host.example.com') { |config|
+    config.runner_options = {
+      :user => 'root',
+    }
+  }
+  context.add_server('another.example.com') { |config|
+    config.runner_options = {
+      :debug => true,
+    }
+  }
+  context.add_server('yet-another.example.com')
+  context.command = 'ls -al'
+  # Parallel option means that the specified command will be executed in parallel
+  # (in multiple threads) instead of sequentially.
+  context.config.parallel = true
+end
+
+# Default context
+TheRunner.context do |context|
+  context.add_server('host.example.com')
+  context.command = 'uptime'
+end

data/bin/the_runner

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+if File.exists?('Therunnerfile')
+  require 'the_runner'
+  require 'the_runner/therunnerfile/handler'
+  load './Therunnerfile'
+  # TODO check if ARGV[0] exists and if not - display usage help
+  TheRunner::Therunnerfile::Handler.new.handle(ARGV[0])
+else
+  # TODO dedicated error
+  raise StandardError.new('No Therunnerfile found.')
+end

data/lib/the_runner.rb

@@ -0,0 +1,51 @@
+require 'the_runner/command'
+require 'the_runner/server'
+require 'the_runner/server/config'
+require 'the_runner/context'
+require 'the_runner/context/config'
+require 'the_runner/runner/base'
+require 'the_runner/runner/ssh'
+
+class TheRunner
+  def initialize
+    @contexts = {}
+  end
+
+  # TODO we don't always need the key, mostly when we want to run a single context
+  def []=(key, context)
+    @contexts[key] = context
+  end
+
+  # TODO make constant for 'default', it's used in multiple places
+  def run(key = 'default')
+    if @contexts.count == 1
+      run_context(@contexts.first[1])
+    else
+      # TODO check if the key exists
+      run_context(@contexts[key])
+    end
+  end
+
+  protected
+  def run_context(context)
+    if context.config.parallel?
+      threads = []
+      context.servers.each { |server|
+        threads << Thread.new {
+          run_command_from_context_on_server(context, server)
+        }
+      }
+      threads.each do |thread|
+        thread.join
+      end
+    else
+      context.servers.each do |server|
+        run_command_from_context_on_server(context, server)
+      end
+    end
+  end
+
+  def run_command_from_context_on_server(context, server)
+    context.get_runner_for(server).run(Command.new(context.command))
+  end
+end

data/lib/the_runner/command.rb

@@ -0,0 +1,11 @@
+class TheRunner
+  class Command
+    def initialize(command)
+      @command = command
+    end
+
+    def to_s
+      @command
+    end
+  end
+end

data/lib/the_runner/context.rb

@@ -0,0 +1,48 @@
+require 'logger'
+
+class TheRunner
+  class Context
+    attr_accessor :command, :config, :servers
+    def initialize(logger = nil)
+      @servers = []
+      @command = ''
+      @server_configs = {}
+      @config = TheRunner::Context::Config.new
+      @logger = Logger.new(STDOUT) if logger.nil?
+
+      yield self if block_given?
+    end
+    def add_server(server)
+      server = Server.new(server) unless server.is_a?(Server)
+      @servers << server
+
+      if block_given?
+        config = Config.new
+        yield config
+
+        @server_configs[server] = config
+      end
+    end
+    def add_servers(servers)
+      servers.each do |server|
+        if block_given?
+          add_server(server) { |config|
+            yield config
+          }
+        else
+          add_server(server)
+        end
+      end
+    end
+    def get_runner_for(server)
+      if has_specific_config_for?(server)
+        @config.runner.new(server, @server_configs[server].runner_options, @logger)
+      else
+        @config.runner.new(server, @config.runner_options, @logger)
+      end
+    end
+    def has_specific_config_for?(server)
+      @server_configs.has_key?(server)
+    end
+  end
+end

data/lib/the_runner/context/config.rb

@@ -0,0 +1,21 @@
+class TheRunner
+  class Context
+    # TODO Not quite sure about that inheritance
+    class Config < TheRunner::Server::Config
+      attr_accessor :parallel
+      attr_reader :runner
+      def initialize
+        super
+        @parallel = false
+        @runner = TheRunner::Runner::SSH
+      end
+      def runner=(runner)
+        # TODO Check if class exists or if it's already a the_runner
+        @runner = runner
+      end
+      def parallel?
+        @parallel
+      end
+    end
+  end
+end

data/lib/the_runner/runner/base.rb

@@ -0,0 +1,17 @@
+class TheRunner
+  class Runner
+    class Base
+      @@default_options = {}
+
+      # TODO Not quite sure about logger injection here.
+      def initialize(server, options = {}, logger = nil)
+        @server, @options = server, @@default_options.merge(options)
+        @logger = logger
+      end
+      def log(message)
+        # TODO Of course there should be more levels of log than just debug.
+        @logger.debug(sprintf('[%s] %s', @server.hostname, message)) unless @logger.nil?
+      end
+    end
+  end
+end

data/lib/the_runner/runner/ssh.rb

@@ -0,0 +1,48 @@
+require 'open3'
+
+class TheRunner
+  class Runner
+    class SSH < Base
+      @@default_options = {
+          debug: false,
+          disable_key_checking: false,
+          user: nil,
+      }
+      def run(command)
+        system_args = build_system_args(command)
+        command = system_args.join(' ')
+        log(sprintf('Running [%s]', command))
+
+        Open3.popen2e(command) { |stdin, output|
+          output.each_line { |line|
+            log(line.chomp)
+          }
+        }
+      end
+      protected
+      def user
+        if @options[:user].nil?
+          args << @server.hostname
+        else
+          args << "#{@options[:user]}@#{@server.hostname}"
+        end
+      end
+      def build_system_args(command)
+        args = []
+        args << 'ssh'
+        if @options[:debug]
+          args << '-vvv'
+        end
+        if @options[:disable_key_checking]
+          args << '-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no'
+        end
+        if @options[:user].nil?
+          args << @server.hostname
+        else
+          args << "#{@options[:user]}@#{@server.hostname}"
+        end
+        args << command.to_s
+      end
+    end
+  end
+end

data/lib/the_runner/server.rb

@@ -0,0 +1,8 @@
+class TheRunner
+  class Server
+    attr_reader :hostname
+    def initialize(hostname)
+      @hostname = hostname
+    end
+  end
+end

data/lib/the_runner/server/config.rb

@@ -0,0 +1,10 @@
+class TheRunner
+  class Server
+    class Config
+      attr_accessor :runner_options
+      def initialize
+        @runner_options = {}
+      end
+    end
+  end
+end

data/lib/the_runner/therunnerfile/handler.rb

@@ -0,0 +1,23 @@
+class TheRunner
+  def self.context(key = 'default')
+    context = TheRunner::Context.new
+    yield context
+    TheRunner::Therunnerfile::Handler.add_context(key, context)
+  end
+  class Therunnerfile
+    class Handler
+      @@contexts = {}
+      def self.add_context(key, context)
+        @@contexts[key] = context
+      end
+      def handle(key)
+        key = 'default' if key.nil?
+        the_runner = TheRunner.new
+        @@contexts.each { |key, value|
+          the_runner[key] = value
+        }
+        the_runner.run(key)
+      end
+    end
+  end
+end

data/the_runner.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |spec|
+  spec.authors = ['Leszek Stachowski']
+  spec.description = %q{Library for running commands on multiple servers.}
+  spec.email = 'leszek@stachowski.me'
+  spec.executables = %w(the_runner)
+  spec.files = %w(LICENSE.md README.md Therunnerfile the_runner.gemspec)
+  spec.files += Dir.glob("bin/**/*")
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.homepage = 'https://github.com/shazarre/the_runner'
+  spec.licenses = ['MIT']
+  spec.name = 'the_runner'
+  spec.require_paths = ['lib']
+  spec.required_rubygems_version = '>= 1.3.6'
+  spec.summary = spec.description
+  spec.version = '0.1'
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: the_runner
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Leszek Stachowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-07 00:00:00.000000000 Z
+dependencies: []
+description: Library for running commands on multiple servers.
+email: leszek@stachowski.me
+executables:
+- the_runner
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Therunnerfile
+- bin/the_runner
+- lib/the_runner.rb
+- lib/the_runner/command.rb
+- lib/the_runner/context.rb
+- lib/the_runner/context/config.rb
+- lib/the_runner/runner/base.rb
+- lib/the_runner/runner/ssh.rb
+- lib/the_runner/server.rb
+- lib/the_runner/server/config.rb
+- lib/the_runner/therunnerfile/handler.rb
+- the_runner.gemspec
+homepage: https://github.com/shazarre/the_runner
+licenses:
+- MIT
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Library for running commands on multiple servers.
+test_files: []