runbook 0.12.1

data/lib/runbook/statements/notice.rb

@@ -0,0 +1,10 @@
+module Runbook::Statements
+  class Notice < Runbook::Statement
+    attr_reader :msg
+
+    def initialize(msg)
+      @msg = msg
+    end
+  end
+end
+

data/lib/runbook/statements/ruby_command.rb

@@ -0,0 +1,9 @@
+module Runbook::Statements
+  class RubyCommand < Runbook::Statement
+    attr_reader :block
+
+    def initialize(&block)
+      @block = block
+    end
+  end
+end

data/lib/runbook/statements/tmux_command.rb

@@ -0,0 +1,11 @@
+module Runbook::Statements
+  class TmuxCommand < Runbook::Statement
+    attr_reader :cmd, :pane
+
+    def initialize(cmd, pane)
+      @cmd = cmd
+      @pane = pane
+    end
+  end
+end
+

data/lib/runbook/statements/upload.rb

@@ -0,0 +1,12 @@
+module Runbook::Statements
+  class Upload < Runbook::Statement
+    attr_reader :from, :to, :options, :ssh_config
+
+    def initialize(from, to:, ssh_config: nil, options: {})
+      @from = from
+      @to = to
+      @ssh_config = ssh_config
+      @options = options
+    end
+  end
+end

data/lib/runbook/statements/wait.rb

@@ -0,0 +1,10 @@
+module Runbook::Statements
+  class Wait < Runbook::Statement
+    attr_reader :time
+
+    def initialize(time)
+      @time = time
+    end
+  end
+end
+

data/lib/runbook/toolbox.rb

@@ -0,0 +1,43 @@
+module Runbook
+  class Toolbox
+    attr_reader :prompt
+
+    def initialize
+      @prompt = TTY::Prompt.new
+    end
+
+    def ask(msg, default: nil)
+      prompt.ask(msg, default: default)
+    end
+
+    def expand(msg, choices)
+      prompt.expand(msg, choices)
+    end
+
+    def yes?(msg)
+      begin
+        prompt.yes?(msg)
+      rescue TTY::Prompt::ConversionError
+        err_msg = "Unknown input: Please type 'y' or 'n'."
+        warn(err_msg)
+        retry
+      end
+    end
+
+    def output(msg)
+      prompt.say(msg)
+    end
+
+    def warn(msg)
+      prompt.warn(msg)
+    end
+
+    def error(msg)
+      prompt.error(msg)
+    end
+
+    def exit(return_value)
+      super(return_value)
+    end
+  end
+end

data/lib/runbook/util/repo.rb

@@ -0,0 +1,56 @@
+module Runbook::Util
+  module Repo
+    FILE_ID = "data"
+
+    def self.load(metadata)
+      title = metadata[:book_title]
+      file = _file(title)
+      if File.exists?(file)
+        msg = "Repo file #{file} detected. Loading previous state..."
+        metadata[:toolbox].output(msg)
+        metadata[:repo] = ::YAML::load_file(file)
+      end
+    end
+
+    def self.save(repo, book_title:)
+      File.open(_file(book_title), 'w') do |f|
+        f.write(repo.to_yaml)
+      end
+    end
+
+    def self.delete(title)
+      FileUtils.rm_f(_file(title))
+    end
+
+    def self._file(book_title)
+      "#{Dir.tmpdir}/runbook_#{FILE_ID}_#{ENV["USER"]}_#{_slug(book_title)}.yml"
+    end
+
+    def self._slug(title)
+      title.titleize.gsub(/\s+/, "").underscore.dasherize
+    end
+
+    def self.register_save_repo_hook(base)
+      base.register_hook(
+        :save_repo_hook,
+        :after,
+        Object,
+      ) do |object, metadata|
+        repo = metadata[:repo]
+        title = metadata[:book_title]
+        Runbook::Util::Repo.save(repo, book_title: title)
+      end
+    end
+
+    def self.register_delete_stored_repo_hook(base)
+      base.register_hook(
+        :delete_stored_repo_hook,
+        :after,
+        Runbook::Entities::Book,
+      ) do |object, metadata|
+        title = metadata[:book_title]
+        Runbook::Util::Repo.delete(title)
+      end
+    end
+  end
+end

data/lib/runbook/util/runbook.rb

@@ -0,0 +1,25 @@
+module Runbook
+  def self.entities
+    _child_classes(Runbook::Entities)
+  end
+
+  def self.statements
+    _child_classes(Runbook::Statements)
+  end
+
+  def self.runs
+    _child_modules(Runbook::Runs)
+  end
+
+  def self._child_classes(mod)
+    mod.constants.map { |const|
+      "#{mod.to_s}::#{const}".constantize
+    }.select { |const| const.is_a?(Class) }
+  end
+
+  def self._child_modules(mod)
+    mod.constants.map { |const|
+      "#{mod.to_s}::#{const}".constantize
+    }.select { |const| const.is_a?(Module) }
+  end
+end

data/lib/runbook/util/sticky_hash.rb

@@ -0,0 +1,26 @@
+module Runbook::Util
+  class StickyHash < Hash
+    def [](key)
+      value = super
+      value.is_a?(Glue) ? value.val : value
+    end
+
+    def []=(key, value)
+      assoc = self.assoc(key)
+      if assoc.nil? || ! assoc[1].is_a?(Glue)
+        super
+      else
+        assoc[1].val = value
+      end
+    end
+  end
+
+  class Glue
+    attr_accessor :val
+
+    def initialize(val)
+      @val = val
+    end
+  end
+end
+

data/lib/runbook/util/stored_pose.rb

@@ -0,0 +1,54 @@
+module Runbook::Util
+  module StoredPose
+    FILE_ID = "current_position"
+
+    def self.load(metadata)
+      title = metadata[:book_title]
+      file = _file(title)
+      if File.exists?(file)
+        ::YAML::load_file(file)
+      end
+    end
+
+    def self.save(repo, book_title:)
+      File.open(_file(book_title), 'w') do |f|
+        f.write(repo.to_yaml)
+      end
+    end
+
+    def self.delete(title)
+      FileUtils.rm_f(_file(title))
+    end
+
+    def self._file(book_title)
+      "#{Dir.tmpdir}/runbook_#{FILE_ID}_#{ENV["USER"]}_#{_slug(book_title)}.yml"
+    end
+
+    def self._slug(title)
+      title.titleize.gsub(/\s+/, "").underscore.dasherize
+    end
+
+    def self.register_save_pose_hook(base)
+      base.register_hook(
+        :save_pose_hook,
+        :before,
+        Object,
+      ) do |object, metadata|
+        position = metadata[:position]
+        title = metadata[:book_title]
+        Runbook::Util::StoredPose.save(position, book_title: title)
+      end
+    end
+
+    def self.register_delete_stored_pose_hook(base)
+      base.register_hook(
+        :delete_stored_pose_hook,
+        :after,
+        Runbook::Entities::Book,
+      ) do |object, metadata|
+        title = metadata[:book_title]
+        Runbook::Util::StoredPose.delete(title)
+      end
+    end
+  end
+end

data/lib/runbook/version.rb

@@ -0,0 +1,3 @@
+module Runbook
+  VERSION = "0.12.1"
+end

data/lib/runbook/view.rb

@@ -0,0 +1,24 @@
+module Runbook
+  module View
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      include Runbook::Hooks
+
+      def render(object, output, metadata)
+        method = _method_name(object)
+        if respond_to?(method)
+          send(method, object, output, metadata)
+        else
+          $stderr.puts("WARNING! No render rule for #{object.class} (#{_method_name(object)}) in #{self.to_s}")
+        end
+      end
+
+      def _method_name(object)
+        object.class.to_s.underscore.gsub("/", "__")
+      end
+    end
+  end
+end

data/lib/runbook/viewer.rb

@@ -0,0 +1,24 @@
+module Runbook
+  class Viewer
+    attr_reader :book
+
+    def initialize(book)
+      @book = book
+    end
+
+    def generate(view: :markdown)
+      view = "Runbook::Views::#{view.to_s.camelize}".constantize
+      metadata = Util::StickyHash.new.
+      merge(Runbook::Entities::Book.initial_render_metadata).
+      merge(additional_metadata)
+
+      StringIO.new.tap do |output|
+        book.render(view, output, metadata)
+      end.string
+    end
+
+    def additional_metadata
+      {}
+    end
+  end
+end

data/lib/runbook/views/markdown.rb

@@ -0,0 +1,109 @@
+module Runbook::Views
+  module Markdown
+    include Runbook::View
+    extend Runbook::Helpers::FormatHelper
+    extend Runbook::Helpers::SSHKitHelper
+
+    def self.runbook__entities__book(object, output, metadata)
+      output << "# #{object.title}\n\n"
+    end
+
+    def self.runbook__entities__section(object, output, metadata)
+      heading = "#"*metadata[:depth]
+      output << "#{heading} #{metadata[:index]+1}. #{object.title}\n\n"
+    end
+
+    def self.runbook__entities__step(object, output, metadata)
+      output << "#{metadata[:index]+1}. [] #{object.title}\n\n"
+
+      ssh_config = find_ssh_config(object)
+      ssh_config_output = render_ssh_config_output(ssh_config)
+      output << "#{ssh_config_output}\n" unless ssh_config_output.empty?
+    end
+
+    def self.runbook__statements__ask(object, output, metadata)
+      default_msg = object.default ?  " (default: #{object.default})" : ""
+      output << "   #{object.prompt} into #{object.into}#{default_msg}\n\n"
+    end
+
+    def self.runbook__statements__assert(object, output, metadata)
+      output << "   run: `#{object.cmd}` every #{object.interval} seconds until it returns 0\n\n"
+      if object.timeout > 0 || object.attempts > 0
+        timeout_msg = object.timeout > 0 ? "#{object.timeout} second(s)" : nil
+        attempts_msg = object.attempts > 0 ? "#{object.attempts} attempts" : nil
+        giveup_msg = "after #{[timeout_msg, attempts_msg].compact.join(" or ")}, give up..."
+        output << "   #{giveup_msg}\n\n"
+        if object.timeout_statement
+          object.timeout_statement.render(self, output, metadata.dup)
+        end
+        output << "   and exit\n\n"
+      end
+    end
+
+    def self.runbook__statements__capture(object, output, metadata)
+      output << "   capture: `#{object.cmd}` into #{object.into}\n\n"
+    end
+
+    def self.runbook__statements__capture_all(object, output, metadata)
+      output << "   capture_all: `#{object.cmd}` into #{object.into}\n\n"
+    end
+
+    def self.runbook__statements__command(object, output, metadata)
+      output << "   run: `#{object.cmd}`\n\n"
+    end
+
+    def self.runbook__statements__confirm(object, output, metadata)
+      output << "   confirm: #{object.prompt}\n\n"
+    end
+
+    def self.runbook__statements__description(object, output, metadata)
+      output << "#{object.msg}\n"
+    end
+
+    def self.runbook__statements__download(object, output, metadata)
+      options = object.options
+      to = " to #{object.to}" if object.to
+      opts = " with options #{options}" unless options == {}
+      output << "   download: #{object.from}#{to}#{opts}\n\n"
+    end
+
+    def self.runbook__statements__layout(object, output, metadata)
+      output << "layout:\n"
+      output << "#{object.structure.inspect}\n\n"
+    end
+
+    def self.runbook__statements__note(object, output, metadata)
+      output << "   #{object.msg}\n\n"
+    end
+
+    def self.runbook__statements__notice(object, output, metadata)
+      output << "   **#{object.msg}**\n\n"
+    end
+
+    def self.runbook__statements__ruby_command(object, output, metadata)
+      output << "   run:\n"
+      output << "   ```ruby\n"
+      begin
+        output << "#{deindent(object.block.source, padding: 3)}\n"
+      rescue ::MethodSource::SourceNotFoundError => e
+        output << "   Unable to retrieve source code\n"
+      end
+      output << "   ```\n\n"
+    end
+
+    def self.runbook__statements__tmux_command(object, output, metadata)
+      output << "   run: `#{object.cmd}` in pane #{object.pane}\n\n"
+    end
+
+    def self.runbook__statements__upload(object, output, metadata)
+      options = object.options
+      to = " to #{object.to}" if object.to
+      opts = " with options #{options}" unless options == {}
+      output << "   upload: #{object.from}#{to}#{opts}\n\n"
+    end
+
+    def self.runbook__statements__wait(object, output, metadata)
+      output << "   wait: #{object.time} seconds\n\n"
+    end
+  end
+end

data/lib/runbook.rb

@@ -0,0 +1,110 @@
+require "tmpdir"
+require "yaml"
+require "thread"
+
+require "active_support/inflector"
+require "method_source"
+require "pastel"
+require "sshkit"
+require "sshkit/sudo"
+require "airbrussh"
+require "tty-progressbar"
+require "tty-prompt"
+
+require "runbook/configuration"
+
+require "hacks/ssh_kit"
+
+require "runbook/dsl"
+require "runbook/errors"
+require "runbook/hooks"
+
+require "runbook/util/repo"
+require "runbook/util/runbook"
+require "runbook/util/sticky_hash"
+require "runbook/util/stored_pose"
+
+require "runbook/node"
+
+require "runbook/entity"
+require "runbook/entities/book"
+require "runbook/entities/section"
+require "runbook/entities/step"
+
+require "runbook/statement"
+require "runbook/statements/ask"
+require "runbook/statements/assert"
+require "runbook/statements/capture"
+require "runbook/statements/capture_all"
+require "runbook/statements/command"
+require "runbook/statements/confirm"
+require "runbook/statements/description"
+require "runbook/statements/download"
+require "runbook/statements/layout"
+require "runbook/statements/note"
+require "runbook/statements/notice"
+require "runbook/statements/ruby_command"
+require "runbook/statements/tmux_command"
+require "runbook/statements/upload"
+require "runbook/statements/wait"
+
+require "runbook/helpers/format_helper"
+require "runbook/helpers/ssh_kit_helper"
+require "runbook/helpers/tmux_helper"
+
+require "runbook/runner"
+require "runbook/run"
+require "runbook/runs/ssh_kit"
+
+require "runbook/toolbox"
+
+require "runbook/viewer"
+require "runbook/view"
+require "runbook/views/markdown"
+
+require "runbook/extensions/add"
+require "runbook/extensions/description"
+require "runbook/extensions/shared_variables"
+require "runbook/extensions/sections"
+require "runbook/extensions/ssh_config"
+require "runbook/extensions/statements"
+require "runbook/extensions/steps"
+require "runbook/extensions/tmux"
+
+require "runbook/version"
+
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.acronym 'SSH'
+end
+
+module Runbook
+  def self.book(title, &block)
+    Configuration.load_config
+    Entities::Book.new(title).tap do |book|
+      book.dsl.instance_eval(&block)
+      register(book)
+    end
+  end
+
+  def self.section(title, &block)
+    Configuration.load_config
+    Entities::Section.new(title).tap do |section|
+      section.dsl.instance_eval(&block)
+    end
+  end
+
+  def self.step(title=nil, &block)
+    Configuration.load_config
+    Entities::Step.new(title).tap do |step|
+      step.dsl.instance_eval(&block) if block
+    end
+  end
+
+  def self.register(book)
+    books << book
+  end
+
+  def self.books
+    @books ||= []
+  end
+end

data/runbook.gemspec

@@ -0,0 +1,48 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "runbook/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "runbook"
+  spec.version       = Runbook::VERSION
+  spec.authors       = ["pblesi"]
+  spec.email         = ["code@getbraintree.com"]
+
+  spec.summary       = %q{Write beautiful, executable runbooks for conducting production operations.}
+  spec.description   = %q{Runbook provides a DSL for specifying production operations. This DSL is used to generate formatted runbooks as well as interactive runbooks to be executed on the command line.}
+  spec.homepage      = "https://github.com/braintree/runbook/"
+  spec.license       = "MIT"
+
+  # 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"] = "https://rubygems.org/"
+  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_runtime_dependency 'activesupport', '~> 5.0', '>= 5.0.0.1'
+  spec.add_runtime_dependency "method_source", "~> 0.9.0"
+  spec.add_runtime_dependency "sshkit", "1.16"
+  spec.add_runtime_dependency "sshkit-sudo", "~> 0.1.0"
+  spec.add_runtime_dependency "airbrussh", "~> 1.3"
+  spec.add_runtime_dependency "thor", "~> 0.20.0"
+  spec.add_runtime_dependency "tty-progressbar", "~> 0.14.0"
+  spec.add_runtime_dependency "tty-prompt", "~> 0.16.0"
+
+  spec.add_development_dependency "aruba", "~> 0.14.5"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "pry", "~> 0.11.3"
+  spec.add_development_dependency "pry-byebug", "~> 3.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/samples/hooks_runbook.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+require "runbook"
+
+Runbook::Runs::SSHKit.register_hook(
+  :output_before_hook,
+  :before,
+  Object
+) do |object, metadata|
+  location = "#{object.class}: #{metadata[:position]}"
+  metadata[:toolbox].output " [Before: #{location}]\n"
+end
+
+Runbook::Runs::SSHKit.register_hook(
+  :output_around_hook,
+  :around,
+  Object
+) do |object, metadata, block|
+  location = "#{object.class}: #{metadata[:position]}"
+  metadata[:toolbox].output "  [Around_before: #{location}]\n"
+  block.call(object, metadata)
+  metadata[:toolbox].output "  [Around_after: #{location}]\n"
+end
+
+Runbook::Runs::SSHKit.register_hook(
+  :output_after_hook,
+  :after,
+  Object
+) do |object, metadata|
+  location = "#{object.class}: #{metadata[:position]}"
+  metadata[:toolbox].output " [After: #{location}]\n"
+end
+
+runbook = Runbook.book "Example Hooks Runbook" do
+  description <<-DESC
+This is a runbook for playing with runbook hooks
+  DESC
+
+  layout [[
+    :runbook,
+    :bottom,
+  ]]
+
+  section "Hook" do
+    step do
+      note "Looky, Looky, I got a hooky"
+    end
+
+    step
+  end
+
+  section "Fishing Hooks" do
+    step do
+      note "Hooked, line, and sinker"
+    end
+
+    step
+  end
+
+  section "Hooked on Phonics" do
+    step do
+      note "Huked on Phoonics reely werx 4 mee"
+    end
+
+    step
+  end
+end
+
+if __FILE__ == $0
+  Runbook::Runner.new(runbook).run
+else
+  runbook
+end

data/samples/layout_runbook.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require "runbook"
+
+runbook = Runbook.book "Example Layout Book" do
+  description <<-DESC
+This is a runbook for playing with the layout statement
+  DESC
+
+  layout [[
+    [:runbook, :deploy],
+    [:monitor_1, :monitor_2, :monitor_3],
+  ]]
+
+  section "Layout Testing" do
+    step do
+      tmux_command "echo 'Layouts Rock!'", :deploy
+      note "Layouts are cool!"
+    end
+  end
+end
+
+if __FILE__ == $0
+  Runbook::Runner.new(runbook).run
+else
+  runbook
+end