rundock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bae0415498290a96be0d1867e1b8390995a818c
+  data.tar.gz: 72ecb870b1108accdd2c9ea8c38dd5291843379c
+SHA512:
+  metadata.gz: cf8bde9f38284afd6b37c109dd58cdf22258d7bd2bc178ae4c4dae7e1ccb13329453228e85f1068548ce30a5a2440bb38cffd051b9f6edfefad78cfee1f45bbc
+  data.tar.gz: ae60ee17c14eff7a50b2bd0f0557d4e484c4f9d1d67c6076b8d78f6f7471945359fd3d4ca3f551e805fac9b4b1829dda9055c3fae6a3112e836d4df3b0b03aac

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+Gemfile.lock
+.vagrant
+Gemfile.local
+authorized_keys
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,49 @@
+# see https://github.com/bbatsov/ruby-style-guide#percent-q-shorthand
+
+AllCops:
+  Exclude:
+    - "vendor/**/*" # rubocop config/default.yml
+    - "db/schema.rb"
+  DisplayCopNames: true
+
+Metrics/LineLength:
+  Max: 500
+
+Metrics/ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 320
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 50
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 50
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Style/Documentation:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Lint/UnusedMethodArgument:
+  Enabled: false

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0
+
+- The first public version.

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 hiracy
+
+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,74 @@
+# Rundock [![Gem Version](https://badge.fury.io/rb/rundock.svg)](http://badge.fury.io/rb/rundock) [![Circle CI](https://circleci.com/gh/hiracy/rundock.png?style=shield&circle-token=0d8a3836c5e285b7ecb6d076f2d51c5deca52d8b)](https://circleci.com/gh/hiracy/rundock)
+
+Simple and extensible server operation framework based on [specinfra](https://github.com/serverspec/specinfra).
+
+- [CHANGELOG](https://github.com/hiracy/rundock/blob/master/CHANGELOG.md)
+
+## Installation
+
+```
+$ gem install rundock
+```
+
+## Usage
+
+Edit your operation scenario to "[scenario.yml](https://github.com/hiracy/rundock/blob/master/scenario_sample.yml)" like this sample.
+
+```
+# scenario section
+- node: 192.168.1.11
+  command:
+    - "sudo hostname new-host-01"
+    - "sudo sed -i -e 's/HOSTNAME=old-host-01/HOSTNAME=new-host-01/g' /etc/sysconfig/network"
+- node: host-alias-01
+  command:
+    - "sudo yum -y install ruby"
+  task:
+    - update_gem
+    - install_bundler
+---
+# host information section
+host-alias-01:
+  host: 192.168.1.12
+  ssh_opts:
+    port: 2222
+    user: anyuser
+    keys: ["~/.ssh/id_rsa_anyuser"]
+---
+# task information section
+update_gem:
+  - "sudo gem update --system"
+  - "sudo gem update"
+install_bundler:
+  - "sudo gem install bundler --no-ri --no-rdoc"
+```
+
+and do rundock.
+
+    $ rundock do -s /path/to/your-dir/scenario.yml
+
+You can also specify [ssh_options.yml](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html)(Net::SSH options) file contents that you specified "-d" option to the default ssh options.
+
+    $ rundock do -s /path/to/your-dir/scenario.yml -d /path/to/your-dir/ssh_options.yml
+
+For more detail. You can see from `rundock -h` command.
+
+## Documentations
+
+Now on editing...
+
+## Run tests
+
+Requirements: Docker environments
+
+```
+$ bundle exec rake spec
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rundock/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,137 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+run_commands = [
+  'rm -f /var/tmp/hello_rundock;' \
+    'echo \'Hello Rundock.\' > /var/tmp/hello_rundock'
+]
+
+run_scenarios = %w(
+  use_default_ssh_scenario
+  simple_echo_scenario
+)
+
+def execute(command)
+  puts "[EXECUTE:] #{command}"
+  system command
+end
+
+def setup_docker(platform, timeout, interval)
+  Bundler.with_clean_env do
+    execute "./spec/integration/platforms/#{platform}/setup.sh &"
+    found = false
+    (timeout / interval).times do
+      execute 'sudo docker ps | grep rundock'
+      if $?.to_i == 0
+        found = true
+        break
+      end
+      sleep interval
+    end
+    raise 'Docker Error.' unless found
+  end
+end
+
+def do_rundock_ssh(commands, platform)
+  if platform == 'localhost'
+    commands.each do |cmd|
+      execute "bundle exec exe/rundock ssh -c \"#{cmd}\" -h localhost -l debug"
+    end
+  else
+    commands.each do |cmd|
+      execute 'bundle exec exe/rundock' \
+        " ssh -c \"#{cmd}\" -h 127.0.0.1 -p 22222 -u tester" \
+        " -i #{ENV['HOME']}/.ssh/id_rsa_rundock_spec_#{platform}_tmp -l debug"
+    end
+  end
+end
+
+def do_rundock_scenarios(scenarios, platform)
+  if platform == 'localhost'
+    base_dir = './spec/integration/platforms/localhost'
+  else
+    base_dir = "#{ENV['HOME']}/.rundock/#{platform}"
+  end
+
+  scenarios.each do |scenario|
+    default_ssh_opt = ''
+    if scenario =~ /use_default_ssh/ && platform != 'localhost'
+      default_ssh_opt = " -d #{base_dir}/integration_default_ssh.yml"
+    end
+
+    execute 'bundle exec exe/rundock' \
+       " do -s #{base_dir}/scenarios/#{scenario}.yml#{default_ssh_opt} -l debug"
+  end
+end
+
+desc 'Cleaning environments'
+
+task :clean do
+  Bundler.with_clean_env do
+    Dir.glob('./spec/integration/platforms/*').each do |platform|
+      execute "#{platform}/setup.sh --clean"
+    end
+  end
+end
+
+desc 'execute rubocop'
+task :rubocop do
+  Bundler.with_clean_env do
+    execute 'rubocop'
+  end
+end
+
+desc 'Run all tests.'
+task :spec => ['rubocop', 'spec:integration:all']
+
+namespace :spec do
+  desc 'Run all tests for localhost.'
+  task :local => 'integration:localhost:all'
+
+  namespace :integration do
+    targets = ['localhost']
+    Dir.glob('./spec/integration/platforms/*').each do |result|
+      targets << File.basename(result)
+    end
+
+    desc 'Run all tests for all platforms.'
+    task :all => targets.map { |t| "spec:integration:#{t}:all" }
+
+    targets.each do |target|
+      namespace target.to_sym do
+        desc "Run rundock and serverspec tests for #{target}"
+
+        if target != 'localhost'
+          task :all => [:docker, :rundock, :serverspec]
+        else
+          task :all => [:rundock, :serverspec]
+        end
+
+        unless target == 'localhost'
+          desc "Setup Docker for #{target}"
+          task :docker do
+            # timeout 3 minutes and wait interval 10 seconds
+            setup_docker(target, 180, 10)
+          end
+        end
+
+        desc "Run rundock for #{target}"
+
+        task :rundock do
+          Bundler.with_clean_env do
+            do_rundock_ssh(run_commands, target)
+            do_rundock_scenarios(run_scenarios, target)
+          end
+        end
+
+        desc "Run serverspec tests for #{target}"
+
+        RSpec::Core::RakeTask.new(:serverspec) do |t|
+          ENV['TARGET_HOST'] = target
+          t.ruby_opts = '-I ./spec/integration'
+          t.pattern = './spec/integration/recipes/*_spec.rb'
+        end
+      end
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rundock'
+
+# 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/circle.yml

@@ -0,0 +1,11 @@
+machine:
+  services:
+    - docker
+
+dependencies:
+  cache_directories:
+    - "~/docker"
+
+test:
+  override:
+    - bundle exec rake spec

data/default_ssh.yml

@@ -0,0 +1,8 @@
+#
+# Default ssh options are here.
+#
+:port: 22
+:paranoid: false
+#:user: "youre_name"
+#:keys: ["/path/to/private_key"]
+#:passphrase: "yourpassphrase"

data/exe/rundock

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'rundock/cli'
+Rundock::CLI.start

data/lib/rundock/backend.rb

@@ -0,0 +1,130 @@
+require 'rundock'
+require 'singleton'
+require 'specinfra/core'
+require 'io/console'
+require 'net/ssh'
+
+Specinfra::Configuration.error_on_missing_backend_type = true
+
+module Rundock
+  module Backend
+    CommandResultStatusError = Class.new(StandardError)
+
+    class << self
+      def create(type, options = {})
+        self.const_get(type.capitalize).new(options)
+      end
+    end
+
+    class Base
+      attr_reader :options
+      attr_reader :backend
+
+      def initialize(options)
+        @options = parse(options)
+        @backend = create_specinfra_backend
+      end
+
+      def run_commands(cmd, options = {})
+        Array(cmd).each do |c|
+          run_command(c)
+        end
+      end
+
+      private
+
+      def run_command(cmd, options = {})
+        command = cmd.strip
+        command = "cd #{Shellwords.escape(options[:cwd])} && #{command}" if options[:cwd]
+        command = "sudo -H -u #{Shellwords.escape(user)} -- /bin/sh -c #{command}" if options[:user]
+
+        Logger.debug(%(Start executing: "#{command}"))
+
+        result = @backend.run_command(command)
+        exit_status = result.exit_status
+
+        Logger.formatter.indent do
+          Logger.error("#{result.stderr}") unless result.stderr.blank?
+          Logger.info("#{result.stdout.strip}") unless result.stdout.strip.blank?
+          Logger.debug("exit status: #{exit_status}")
+        end
+
+        if options[:no_continue_if_error] && exit_status != 0
+          raise CommandResultStatucError
+        end
+
+        result
+      end
+
+      def parse(options)
+        raise NotImplementedError
+      end
+
+      def create_specinfra_backend
+        raise NotImplementedError
+      end
+    end
+
+    class Local < Base
+      private
+
+      def parse(options)
+        options
+      end
+
+      def create_specinfra_backend
+        Specinfra::Backend::Exec.new
+      end
+    end
+
+    class Ssh < Base
+      private
+
+      def parse(options)
+        if options['ssh_config'] && FileTest.exists?(options['ssh_config'])
+          ssh_opts = Net::SSH::Config.for(options['host'], [options['ssh_config']])
+        else
+          ssh_opts = Net::SSH::Config.for(options['host'])
+        end
+
+        ssh_opts[:host_name] = options['host']
+        ssh_opts[:user] = options['user']
+        ssh_opts[:keys] = options['keys']
+        ssh_opts[:keys] = Array(options['key']) if !ssh_opts[:keys] && options['key']
+        ssh_opts[:port] = options['port']
+        ssh_opts[:password] = parse_password_from_stdin if options['ask_password']
+
+        ssh_opts.merge!(filter_net_ssh_options(options))
+
+        Logger.debug(%(Net::SSH Options: "#{ssh_opts}"))
+
+        ssh_opts
+      end
+
+      def parse_password_from_stdin
+        print 'password: '
+        passwd = STDIN.noecho(&:gets).strip
+        print "\n"
+        passwd
+      end
+
+      def filter_net_ssh_options(options)
+        opts = {}
+        options.each do |k, v|
+          opts[k.to_sym] = v if Net::SSH::VALID_OPTIONS.include?(k.to_sym)
+        end
+
+        opts
+      end
+
+      def create_specinfra_backend
+        Specinfra::Backend::Ssh.new(
+          request_pty: true,
+          host: @options[:host_name],
+          disable_sudo: !@options[:sudo],
+          ssh_options: @options
+        )
+      end
+    end
+  end
+end

data/lib/rundock/cli.rb

@@ -0,0 +1,50 @@
+require 'rundock'
+require 'thor'
+
+module Rundock
+  class CLI < Thor
+    DEFAULT_SCENARIO_FILE_PATH = './scenario.yml'
+    DEFAULT_SSH_OPTIONS_DEFAULT_FILE_PATH = './default_ssh.yml'
+
+    class_option :log_level, type: :string, aliases: ['-l'], default: 'info'
+    class_option :color, type: :boolean, default: true
+
+    def initialize(args, opts, config)
+      super(args, opts, config)
+
+      Rundock::Logger.level = ::Logger.const_get(options[:log_level].upcase)
+      Rundock::Logger.formatter.colored = options[:color]
+    end
+
+    desc 'version', 'Print version'
+    def version
+      puts "#{Rundock::VERSION}"
+    end
+
+    desc 'do [SCENARIO] [options]', 'Run rundock from scenario file'
+    option :sudo, type: :boolean, default: false
+    option :scenario_yaml, type: :string, aliases: ['-s'], default: DEFAULT_SCENARIO_FILE_PATH
+    option :default_ssh_opts_yaml, type: :string, aliases: ['-d'], default: DEFAULT_SSH_OPTIONS_DEFAULT_FILE_PATH
+    def do(*scenario_file_path)
+      scenario_file_path = [DEFAULT_SCENARIO_FILE_PATH] if scenario_file_path.empty?
+      opts = { :scenario_yaml => scenario_file_path[0] }
+
+      Runner.run(opts.merge(options))
+    end
+
+    desc 'ssh [options]', 'Run rundock ssh with various options'
+    option :command, type: :string, aliases: ['-c'], banner: "NOTICE: Scenario's task is ignored."
+    option :default_ssh_opts_yaml, type: :string, aliases: ['-d'], default: DEFAULT_SSH_OPTIONS_DEFAULT_FILE_PATH
+    option :host, type: :string, aliases: ['-h']
+    option :user, type: :string, aliases: ['-u']
+    option :key, type: :string, aliases: ['-i']
+    option :port, type: :numeric, aliases: ['-p']
+    option :ssh_config, type: :string, aliases: ['-F']
+    option :ask_password, type: :boolean, default: false
+    option :sudo, type: :boolean, default: false
+    def ssh
+      opts = {}
+      Runner.run(opts.merge(options))
+    end
+  end
+end

data/lib/rundock/ext/hash.rb

@@ -0,0 +1,23 @@
+class Hash
+  def depth
+    1 + (values.map { |v| v.is_a?(Hash) ? v.depth : 1 }.max)
+  end
+
+  def deep_symbolize_keys
+    self.each_with_object({}) do |(k, v), h|
+      if v.is_a?(Array)
+        v = v.map do |vv|
+          if vv.is_a?(Hash)
+            vv.deep_symbolize_keys
+          else
+            vv
+          end
+        end
+      elsif v.is_a?(Hash)
+        v = v.deep_symbolize_keys
+      end
+
+      h[k.to_s.to_sym] = v
+    end
+  end
+end

data/lib/rundock/ext/object/blank.rb

@@ -0,0 +1,45 @@
+class Object
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+end
+
+class NilClass
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  def blank?
+    false
+  end
+end
+
+class Array
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  alias_method :blank?, :empty?
+end
+
+class String
+  BLANK_RE = /\A[[:space:]]*\z/
+
+  def blank?
+    self =~ BLANK_RE
+  end
+end
+
+class Numeric
+  def blank?
+    false
+  end
+end