runbook 0.14.0 → 1.1.0

data/lib/runbook/helpers/tmux_helper.rb

@@ -1,9 +1,11 @@
 module Runbook::Helpers
   module TmuxHelper
+    FILE_PERMISSIONS = 0600
+
     def setup_layout(structure, runbook_title:)
       _remove_stale_layouts
       layout_file = _layout_file(_slug(runbook_title))
-      if File.exists?(layout_file)
+      if File.exist?(layout_file)
         stored_layout = ::YAML::load_file(layout_file)
         if _all_panes_exist?(stored_layout)
           return stored_layout
@@ -11,14 +13,14 @@ module Runbook::Helpers
       end
 
       _setup_layout(structure).tap do |layout_panes|
-        File.open(layout_file, 'w') do |f|
+        File.open(layout_file, 'w', FILE_PERMISSIONS) do |f|
           f.write(layout_panes.to_yaml)
         end
       end
     end
 
     def send_keys(command, target)
-      `tmux send-keys -t #{target} #{_pager_escape_sequence} '#{command}' C-m`
+      `tmux send-keys -t #{target} #{_pager_escape_sequence} #{Shellwords.escape(command)} C-m`
     end
 
     def kill_all_panes(layout_panes)
@@ -41,7 +43,7 @@ module Runbook::Helpers
     end
 
     def _slug(title)
-      title.titleize.gsub(/\s+/, "").underscore.dasherize
+      title.titleize.gsub(/[\/\s]+/, "").underscore.dasherize
     end
 
     def _all_panes_exist?(stored_layout)

data/lib/runbook/node.rb

@@ -1,5 +1,7 @@
 module Runbook
   class Node
+    attr_accessor :parent
+
     def initialize
       raise "Should not be initialized"
     end
@@ -19,5 +21,13 @@ module Runbook
     def visited?
       @visited
     end
+
+    def parent_entity
+      node = self
+      while(node && !node.is_a?(Runbook::Entity))
+        node = node.parent
+      end
+      node
+    end
   end
 end

data/lib/runbook/run.rb

@@ -36,6 +36,10 @@ module Runbook
         metadata[:toolbox].output("Section #{metadata[:position]}: #{object.title}\n\n")
       end
 
+      def runbook__entities__setup(object, metadata)
+        metadata[:toolbox].output("Setup:\n\n")
+      end
+
       def runbook__entities__step(object, metadata)
         toolbox = metadata[:toolbox]
         title = " #{object.title}".rstrip
@@ -66,11 +70,12 @@ module Runbook
 
         if metadata[:noop]
           default_msg = default ? " (default: #{default})" : ""
-          metadata[:toolbox].output("[NOOP] Ask: #{object.prompt} (store in: #{object.into})#{default_msg}")
+          echo_msg = object.echo ? "" : " (echo: false)"
+          metadata[:toolbox].output("[NOOP] Ask: #{object.prompt} (store in: #{object.into})#{default_msg}#{echo_msg}")
           return
         end
 
-        result = metadata[:toolbox].ask(object.prompt, default: default)
+        result = metadata[:toolbox].ask(object.prompt, default: default, echo: object.echo)
 
         target = object.parent.dsl
         target.singleton_class.class_eval { attr_accessor object.into }
@@ -152,7 +157,7 @@ module Runbook
         next_index = metadata[:index] + 1
         parent_items = object.parent.items
         remaining_items = parent_items.slice!(next_index..-1)
-        object.parent.dsl.instance_exec(object, metadata, &object.block)
+        object.parent.dsl.instance_exec(object, metadata, self, &object.block)
         parent_items[next_index..-1].each { |item| item.dynamic! }
         parent_items.push(*remaining_items)
       end
@@ -228,9 +233,9 @@ module Runbook
           return
         when :skip
           position = metadata[:position]
-          current_step = position.split(".")[-1].to_i
-          new_step = current_step + 1
-          start_at = position.gsub(/\.#{current_step}$/, ".#{new_step}")
+          split_position = position.split(".")
+          new_step = (split_position.pop.to_i + 1).to_s
+          start_at = (split_position <<  new_step).join(".")
           metadata[:start_at] = start_at
         when :jump
           result = toolbox.ask("What position would you like to jump to?")
@@ -253,7 +258,7 @@ module Runbook
         :after,
         Runbook::Entities::Book,
       ) do |object, metadata|
-        next if metadata[:noop] || metadata[:layout_panes].none?
+        next if metadata[:noop] || metadata[:layout_panes].none? || metadata[:keep_panes]
         if metadata[:auto]
           metadata[:toolbox].output("Killing all opened tmux panes...")
           kill_all_panes(metadata[:layout_panes])
@@ -273,7 +278,8 @@ module Runbook
         :after,
         Runbook::Statement,
       ) do |object, metadata|
-        if object.parent.is_a?(Runbook::Entities::Step)
+        if object.parent.is_a?(Runbook::Entities::Step) ||
+            object.parent.is_a?(Runbook::Entities::Setup)
           if object.parent.items.last == object
             metadata[:toolbox].output("\n")
           end

data/lib/runbook/runner.rb

@@ -11,6 +11,7 @@ module Runbook
       noop: false,
       auto: false,
       paranoid: true,
+      keep_panes: false,
       start_at: "0"
     )
       run = "Runbook::Runs::#{run.to_s.camelize}".constantize
@@ -21,6 +22,7 @@ module Runbook
         paranoid: Util::Glue.new(paranoid),
         start_at: Util::Glue.new(start_at || "0"),
         toolbox: Util::Glue.new(toolbox),
+        keep_panes: keep_panes,
         book_title: book.title,
       }).
       merge(Runbook::Entities::Book.initial_run_metadata).

data/lib/runbook/runs/ssh_kit.rb

@@ -1,13 +1,20 @@
 module Runbook::Runs
   module SSHKit
     include Runbook::Run
-    extend Runbook::Helpers::SSHKitHelper
 
     def self.included(base)
       base.extend(ClassMethods)
     end
 
     module ClassMethods
+      include Runbook::Helpers::SSHKitHelper
+
+      def runbook__entities__step(object, metadata)
+        airbrussh_context = Runbook.configuration._airbrussh_context
+        airbrussh_context.set_current_task_name(object.title)
+        super
+      end
+
       def runbook__statements__assert(object, metadata)
         cmd_ssh_config = find_ssh_config(object, :cmd_ssh_config)
 
@@ -19,18 +26,18 @@ module Runbook::Runs
           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..."
-            metadata[:toolbox].output(giveup_msg)
-            if object.timeout_statement
-              object.timeout_statement.parent = object.parent
-              object.timeout_statement.run(self, metadata.dup)
+            abort_msg = "after #{[timeout_msg, attempts_msg].compact.join(" or ")}, abort..."
+            metadata[:toolbox].output(abort_msg)
+            if object.abort_statement
+              object.abort_statement.parent = object.parent
+              object.abort_statement.run(self, metadata.dup)
             end
             metadata[:toolbox].output("and exit")
           end
           return
         end
 
-        gave_up = false
+        should_abort = false
         test_args = ssh_kit_command(object.cmd, raw: object.cmd_raw)
         test_options = ssh_kit_command_options(cmd_ssh_config)
 
@@ -39,12 +46,12 @@ module Runbook::Runs
           count = object.attempts
           while !(test(*test_args, test_options))
             if ((count -= 1) == 0)
-              gave_up = true
+              should_abort = true
               break
             end
 
             if (object.timeout > 0 && Time.now - time > object.timeout)
-              gave_up = true
+              should_abort = true
               break
             end
 
@@ -52,12 +59,12 @@ module Runbook::Runs
           end
         end
 
-        if gave_up
+        if should_abort
           error_msg = "Error! Assertion `#{object.cmd}` failed"
           metadata[:toolbox].error(error_msg)
-          if object.timeout_statement
-            object.timeout_statement.parent = object.parent
-            object.timeout_statement.run(self, metadata.dup)
+          if object.abort_statement
+            object.abort_statement.parent = object.parent
+            object.abort_statement.run(self, metadata.dup)
           end
           raise Runbook::Runner::ExecutionError, error_msg
         end

data/lib/runbook/statement.rb

@@ -2,8 +2,6 @@ module Runbook
   class Statement < Node
     include Runbook::Hooks::Invoker
 
-    attr_accessor :parent
-
     def render(view, output, metadata)
       invoke_with_hooks(view, self, output, metadata) do
         view.render(self, output, metadata)

data/lib/runbook/statements/ask.rb

@@ -1,11 +1,12 @@
 module Runbook::Statements
   class Ask < Runbook::Statement
-    attr_reader :prompt, :into, :default
+    attr_reader :prompt, :into, :default, :echo
 
-    def initialize(prompt, into:, default: nil)
+    def initialize(prompt, into:, default: nil, echo: true)
       @prompt = prompt
       @into = into
       @default = default
+      @echo = echo
     end
   end
 end

data/lib/runbook/statements/assert.rb

@@ -2,7 +2,12 @@ module Runbook::Statements
   class Assert < Runbook::Statement
     attr_reader :cmd, :cmd_ssh_config, :cmd_raw
     attr_reader :interval, :timeout, :attempts
-    attr_reader :timeout_statement
+    attr_reader :abort_statement
+
+    def timeout_statement
+      Runbook.deprecator.deprecation_warning(:timeout_statement, :abort_statement)
+      @abort_statement
+    end
 
     def initialize(
       cmd,
@@ -11,6 +16,7 @@ module Runbook::Statements
       interval: 1,
       timeout: 0,
       attempts: 0,
+      abort_statement: nil,
       timeout_statement: nil
     )
       @cmd = cmd
@@ -19,7 +25,10 @@ module Runbook::Statements
       @interval = interval
       @timeout = timeout
       @attempts = attempts
-      @timeout_statement = timeout_statement
+      if timeout_statement
+        Runbook.deprecator.deprecation_warning(:timeout_statement, :abort_statement)
+      end
+      @abort_statement = abort_statement || timeout_statement
     end
   end
 end

data/lib/runbook/toolbox.rb

@@ -6,8 +6,8 @@ module Runbook
       @prompt = TTY::Prompt.new
     end
 
-    def ask(msg, default: nil)
-      prompt.ask(msg, default: default)
+    def ask(msg, default: nil, echo: true)
+      prompt.ask(msg, default: default, echo: echo)
     end
 
     def expand(msg, choices)
@@ -15,13 +15,7 @@ module Runbook
     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
+      prompt.yes?(msg)
     end
 
     def output(msg)

data/lib/runbook/util/repo.rb

@@ -1,11 +1,12 @@
 module Runbook::Util
   module Repo
     FILE_ID = "data"
+    FILE_PERMISSIONS = 0600
 
     def self.load(metadata)
       title = metadata[:book_title]
       file = _file(title)
-      if File.exists?(file)
+      if File.exist?(file)
         msg = "Repo file #{file} detected. Loading previous state..."
         metadata[:toolbox].output(msg)
         metadata[:repo] = ::YAML::load_file(file)
@@ -13,7 +14,7 @@ module Runbook::Util
     end
 
     def self.save(repo, book_title:)
-      File.open(_file(book_title), 'w') do |f|
+      File.open(_file(book_title), 'w', FILE_PERMISSIONS) do |f|
         f.write(repo.to_yaml)
       end
     end
@@ -27,7 +28,7 @@ module Runbook::Util
     end
 
     def self._slug(title)
-      title.titleize.gsub(/\s+/, "").underscore.dasherize
+      title.titleize.gsub(/[\/\s]+/, "").underscore.dasherize
     end
 
     def self.register_save_repo_hook(base)

data/lib/runbook/util/runbook.rb

@@ -11,6 +11,10 @@ module Runbook
     _child_modules(Runbook::Runs)
   end
 
+  def self.views
+    _child_modules(Runbook::Views)
+  end
+
   def self.generators
     _child_classes(Runbook::Generators)
   end

data/lib/runbook/util/stored_pose.rb

@@ -1,17 +1,18 @@
 module Runbook::Util
   module StoredPose
     FILE_ID = "current_position"
+    FILE_PERMISSIONS = 0600
 
     def self.load(metadata)
       title = metadata[:book_title]
       file = _file(title)
-      if File.exists?(file)
+      if File.exist?(file)
         ::YAML::load_file(file)
       end
     end
 
     def self.save(repo, book_title:)
-      File.open(_file(book_title), 'w') do |f|
+      File.open(_file(book_title), 'w', FILE_PERMISSIONS) do |f|
         f.write(repo.to_yaml)
       end
     end
@@ -25,7 +26,7 @@ module Runbook::Util
     end
 
     def self._slug(title)
-      title.titleize.gsub(/\s+/, "").underscore.dasherize
+      title.titleize.gsub(/[\/\s]+/, "").underscore.dasherize
     end
 
     def self.register_save_pose_hook(base)

data/lib/runbook/version.rb

@@ -1,3 +1,3 @@
 module Runbook
-  VERSION = "0.14.0"
+  VERSION = "1.1.0"
 end

data/lib/runbook/views/markdown.rb

@@ -13,6 +13,14 @@ module Runbook::Views
       output << "#{heading} #{metadata[:index]+1}. #{object.title}\n\n"
     end
 
+    def self.runbook__entities__setup(object, output, metadata)
+      output << "[] #{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__entities__step(object, output, metadata)
       output << "#{metadata[:index]+1}. [] #{object.title}\n\n"
 
@@ -23,7 +31,7 @@ module Runbook::Views
 
     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"
+      output << "   #{object.prompt} into `#{object.into}`#{default_msg}\n\n"
     end
 
     def self.runbook__statements__assert(object, output, metadata)
@@ -31,21 +39,21 @@ module Runbook::Views
       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)
+        abort_msg = "after #{[timeout_msg, attempts_msg].compact.join(" or ")}, abort..."
+        output << "   #{abort_msg}\n\n"
+        if object.abort_statement
+          object.abort_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"
+      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"
+      output << "   capture_all: `#{object.cmd}` into `#{object.into}`\n\n"
     end
 
     def self.runbook__statements__command(object, output, metadata)

data/runbook.gemspec

@@ -31,19 +31,23 @@ Gem::Specification.new do |spec|
   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"
-  spec.add_runtime_dependency "sshkit", "1.16"
+  spec.add_runtime_dependency "activesupport", ">= 5.0.1.x", "< 7.0"
+  spec.add_runtime_dependency "method_source", "~> 1.0"
+  spec.add_runtime_dependency "ruby2_keywords", "~> 0.0.4"
+  spec.add_runtime_dependency "sshkit", "1.21.0"
   spec.add_runtime_dependency "sshkit-sudo", "~> 0.1"
-  spec.add_runtime_dependency "airbrussh", "~> 1.3"
+  spec.add_runtime_dependency "airbrussh", "~> 1.4"
   spec.add_runtime_dependency "thor", "~> 0.20"
   spec.add_runtime_dependency "tty-progressbar", "~> 0.14"
-  spec.add_runtime_dependency "tty-prompt", "~> 0.16"
+  spec.add_runtime_dependency "tty-prompt", "~> 0.20"
 
+  spec.add_development_dependency "appraisal", "~> 2.2"
   spec.add_development_dependency "aruba", "~> 0.14"
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "bcrypt_pbkdf", ">= 1.0", "< 2.0"
+  spec.add_development_dependency "ed25519", ">= 1.2", "< 2.0"
+  spec.add_development_dependency "pry", "~> 0.13"
   spec.add_development_dependency "pry-byebug", "~> 3.6"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end