runbook 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c05a6c35dcd51c2e91eabd838214a00c1bee394f372040c16f89d62d803a352
-  data.tar.gz: 44122acdd87e97bf0baafb59eed9bbea5be8109e5cd31afa6560da358b454a21
+  metadata.gz: d8094ea43f8e96a2c1ccaf981248b84bef276b714460cd0b5c3fa1795f736e3a
+  data.tar.gz: 229c3d600c9bcd985451333027ac639a87e922547fa74e6688cef3db96373931
 SHA512:
-  metadata.gz: 252644365a05249254a5b4917fced2303d7554c136710adb100fcb7403157da5cb34d6a46d9b2ee9434f8fe89800330a16753cab634e35bb867142156903a706
-  data.tar.gz: 8d903da453e97dd258ff3f656f64540aa8674646b3c9a305e21cd9afd7018d41e8cf69aad8c9f43930f51ccce6b4cff5efeb6f3abca13c3216b96d7908108fbb
+  metadata.gz: be0ebd6c86a3ccaf34af851fe20d660a70752d7c4e32bbae9c14f6406e841ff230971e7c95f206da670594528af36ea3a97b4481e9981ca41753ede34b305fb8
+  data.tar.gz: f5b4f2b9d0c043e1eb10242f09892fa5011d1fd36e8325e83f46dccef50db3bd9691677379a82a70cc3697fa41c965c93f924ac8742f20868ce64b097d0aef55

data/.dockerignore

@@ -0,0 +1,17 @@
+**/.git
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# recommended:
+# https://github.com/thoughtbot/appraisal#version-control
+gemfiles/*.gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2.3
+ruby-2.5.5

data/.travis.yml

@@ -1,7 +1,8 @@
-sudo: false
+dist: xenial
 language: ruby
+services:
+  - docker
 rvm:
-  - 2.2.3
   - 2.2.10
   - 2.3.8
   - 2.4.6
@@ -22,3 +23,6 @@ matrix:
       gemfile: gemfiles/activesupport_6.gemfile
 
 before_install: gem install bundler -v 1.15.4
+
+script:
+  - bundle exec rake spec_all

data/CHANGELOG.md

@@ -4,6 +4,20 @@ This log maintains a list of all substantive changes to Runbook. The log include
 
 ## master
 
+## `v0.16.0` (2019-11-22)
+
+### Fixes:
+
+* Add better error messages for runtime values accessed at compile time
+
+### New Features
+
+* Add entity tags and labels
+* Add `setup` entity for initial runbook setup code
+* Add `Runbook.views` method for accessing an array of all defined views
+* Add airbrussh context for better ssh_kit output
+* Backtick "into" targets in markdown view output (Thanks fwolfst!)
+
 ## `v0.15.0` (2019-09-29)
 
 ### Fixes:
@@ -11,7 +25,7 @@ This log maintains a list of all substantive changes to Runbook. The log include
 * Halt the project generator if gem generation fails
 * Replace timeout_statement with abort_statement for assert statements
 * Make runbook state files only readable by the current user
-* Allow / characters in the title of a runbook (Thanks brafales)
+* Allow / characters in the title of a runbook (Thanks brafales!)
 
 ### New Features
 

data/README.md

@@ -118,10 +118,12 @@ Initialize Runbook in your project:
 
 * [1. Runbook Anatomy](#runbook-anatomy)
   * [1.1 Entities, Statements, and Setters](#entities-statements-and-setters)
-    * [1.1.1 Books, Sections, and Steps](#books-sections-and-steps)
+    * [1.1.1 Books, Sections, Steps, and Setup](#books-sections-steps-and-setup)
       * [1.1.1.1 Books](#books)
       * [1.1.1.2 Sections](#sections)
       * [1.1.1.3 Steps](#steps)
+      * [1.1.1.4 Setup](#setup)
+      * [1.1.1.5 Tags and Labels](#tags-and-labels)
     * [1.1.2 Statements](#statements)
       * [1.1.2.1 Ask](#ask)
       * [1.1.2.2 Assert](#assert)
@@ -169,11 +171,12 @@ Initialize Runbook in your project:
   * [6.8 Adding to Runbook's Configuration](#adding-to-runbooks-configuration)
 * [7. Testing](#testing)
 * [8. Known Issues](#known-issues)
-* [9. Development](#development)
-* [10. Contributing](#contributing)
-* [11. Feature Requests](#feature-requests)
-* [12. License](#license)
-* [13. Code of Conduct](#code-of-conduct)
+* [9. FAQ](#faq)
+* [10. Development](#development)
+* [11. Contributing](#contributing)
+* [12. Feature Requests](#feature-requests)
+* [13. License](#license)
+* [14. Code of Conduct](#code-of-conduct)
 
 ## Runbook Anatomy
 
@@ -220,7 +223,7 @@ Hierarchically, a runbook looks like this:
 
 A runbook is composed of entities, statements, and setters. Runbook entities contain either other entities or statements. Examples of entities include Books, Sections, and Steps. They define the structure of the runbook and can be considered the "nodes" of the tree structure. As entities are the nodes of the tree structure, statements are the "leaves" of the structure and comprise the various behaviors or commands of the runbook. Setters, typically referenced from within steps, associate state with the node, which can be accessed by its children.
 
-#### Books, Sections, and Steps
+#### Books, Sections, Steps, and Setup
 
 Entities are composed of a title and a list of items which are their children. Each entity can be rendered with a specific view or executed with a specific run.
 
@@ -243,6 +246,60 @@ A book is broken up into sections. Every section requires a title. Sections can
 
 Steps hold state and group together a set of statements. Steps do not require titles or children. This allows runbooks to be very flexible. You can fill out steps as needed, or be terse when the behavior of the step is self-evident. Steps without titles will not prompt to continue when running in paranoid mode.
 
+##### Setup
+
+Setup is a special entity that is always executed. It is not skipped when starting or resuming execution in the middle of a runbook. A prompt is never presented to determine if you should or should not execute the setup section. The setup section is similar to the step entity in that it shares the same DSL. In other words, any keywords available within steps are also available within the setup section.
+
+The setup section provides two important use cases. First, it allows you ensure any dependent values are defined when executing your runbook. If skipping the initial steps of your runbook and starting in the middle, you can be sure that any initialization steps have been executed. For example, presume you have a runbook that prompts for a list of servers, stops the servers, and then starts them. It would be advantageous to define the prompting server logic in a setup section, so you can start the runbook at the start server step and know that the list of servers is defined.
+
+Second, if you dynamically define the sections and steps in your runbook based on user input, then doing this in the setup section allows you start the runbook in the middle of the dynamically defined steps.
+
+Because the setup section is always executed, it's execution should be idempotent. In other words, the setup section should be able to be executed multiple times in a row and produce the same result.
+
+It may be ideal to ensure user input is only asked for once when executing a setup section.
+
+```ruby
+Runbook.book "Make Pizza" do
+  setup do
+    ruby_command do
+      @toppings ||= ENV["TOPPINGS"]
+      ask "What toppings would you like?", into: :toppings, default: "cheese" unless @toppings
+    end
+  end
+end
+```
+
+The above example will set `@toppings` from a passed-in environment variable if present, otherwise it will ask the user to set `@toppings`. If toppings have already has been defined from a previous execution, it will not prompt the user for the value again. Because this logic references a value that is defined at runtime (`@toppings`), it must be wrapped in a `ruby_command`.
+
+##### Tags and Labels
+
+Any entity can be associated with arbitrary tags or labels. Once tags or labels are assigned, entity behavior can be modified using [hooks](#augmenting-functionality-with-hooks).
+
+```ruby
+Runbook.book "Bounce Nodes", :untested do
+  step "Disable monitoring", :skip do
+    confirm "Have you disabled health monitoring?"
+  end
+
+  step "Restart nodes", :aws_only, :mutator, labels: {rails_env: :production} do
+    confirm "Have you restarted the nodes?"
+  end
+end
+```
+
+```ruby
+Runbook::Runs::SSHKit.register_hook(:warn_for_untested_runbook, :before, Runbook::Entities::Book) do |object, metadata|
+  warning = "This runbook has not yet been tested. Beware of bugs!"
+  metadata[:toolbox].warn(warning) if object.tags.include?(:untested)
+end
+
+Runbook::Runs::SSHKit.register_hook(:skip_skippable_entities, :around, Runbook::Entity) do |object, metadata, block|
+  next if object.tags.include?(:skip)
+  next if object.labels[:rails_env] && object.labels[:rails_env] != ENV["RAILS_ENV"]
+  block.call
+end
+```
+
 #### Statements
 
 Statements are the workhorses of runbooks. They comprise all the behavior runbooks execute. Runbook comes with the following statements:
@@ -253,8 +310,14 @@ Prompts the user for a string and stores its value on the containing step entity
 
 ```ruby
 ask "What percentage of requests are failing?", into: :failing_request_percentage, default: "100", echo: true
+
+ruby_command do
+  note "Failing request percentage: #{@failing_request_percentage}"
+end
 ```
 
+In the above example, the `note` statement must be wrapped in a `ruby_command` statement. Without wrapping `note` in a `ruby_command`, it would be evaluated at compile time but the user will only be asked for input when the runbook is executed (so `@failing_request_percentage` would not have a value). If you find yourself wrapping many or all runbook statements in ruby commands it may make sense to set these values at compile time using environment variables.
+
 ##### Assert
 
 Runs the provided `cmd` repeatedly until it returns true. A timeout and maximum number of attempts can be set. You can specify a command to be run if a timeout occurs or the maximum number of attempts is hit. Commands can optionally be specified as `raw`. This tells SSHKit to not perform auto-wrapping of the commands, but execute the exact string on the remote server. See SSHKit's documentation for more details.
@@ -277,7 +340,7 @@ assert(
 
 ##### Capture
 
-Runs the provided `cmd` and captures its output into `into`. An optional `ssh_config` can be specified to configure how the capture command gets run. Capture commands take an optional `strip` parameter that indicates if the returned output should have leading and trailing whitespace removed. Capture commands also take an optional `raw` parameter that tells SSHKit whether the command should be executed as is, or to include the auto-wrapping of the ssh_config.
+Runs the provided `cmd` and captures its output into `into`. Once captured, this value can be referenced in later statements such as the `ruby_command` statement. An optional `ssh_config` can be specified to configure how the capture command gets run. Capture commands take an optional `strip` parameter that indicates if the returned output should have leading and trailing whitespace removed. Capture commands also take an optional `raw` parameter that tells SSHKit whether the command should be executed as is, or to include the auto-wrapping of the ssh_config.
 
 ```ruby
 capture %Q{wc -l file.txt | cut -d " " -f 1}, into: :num_lines, strip: true, ssh_config: {user: "root"}
@@ -323,7 +386,7 @@ DESC
 Downloads the specified file to `to`. An optional `ssh_config` can be specified to configure how the download command gets run, for example specifying the remote host and remote directory to download from. Optional `options` can be specified that get passed down to the underlying sshkit implementation
 
 ```ruby
-download /home/pblesi/rad_file.txt, to: my_rad_file.txt, ssh_config: {servers: ["host1.prod"]}, options: {log_percent: 10}
+download '/home/pblesi/rad_file.txt', to: my_rad_file.txt, ssh_config: {servers: ["host1.prod"]}, options: {log_percent: 10}
 ```
 
 ##### Layout
@@ -789,7 +852,7 @@ step "Inspect plate" do
     when "carrots"
       add carrots_book
     when "peas"
-      system("runbook exec samples/print_peas.rb")
+      system("runbook exec examples/print_peas.rb")
     else
       metadata[:toolbox].warn("Found #{veggie}!")
     end
@@ -864,7 +927,7 @@ Runbook can be extended to add custom functionality.
 
 ### Adding New Statements
 
-In order to add a new statement to your DSL, create a class under `Runbook::Statements` that inherits from `Runbook::Statement`. This statement will be initialized with all arguments passed to the corresponding keyword in the DSL. Remember to also add a corresponding method to runs and views so your new statement can be interpretted in each context.
+In order to add a new statement to your DSL, create a class under `Runbook::Statements` that inherits from `Runbook::Statement`. This statement will be initialized with all arguments passed to the corresponding keyword in the DSL. Remember to also add a corresponding method to runs and views so your new statement can be interpreted in each context.
 
 ```ruby
 module Runbook::Statements
@@ -969,6 +1032,22 @@ end
 
 When registering a hook, you specify the name of the hook, the type, and the statement or entity to add the hook to. `before` and `after` hooks execute the block before and after executing the entity or statement, respectively. `around` hooks take a block which executes the specified entity or statement. When specifying the class that the hook applies to, you can have the hook apply to all entities by specifying `Runbook::Entity`, all statements by specifying `Runbook::Statement`, or all items by specifying `Object`. Additionally, you can specify any specific entity or statement you would like the hook to apply to.
 
+Hooks are defined on the run or view objects themselves. For example, you would register a hook with `Runbook::Runs::SSHKit` to have the hook be applied to the `SSHKit` run. You would register a hook with the `Runbook::Views::Markdown` view to have hooks apply to this view. If you want to apply a hook to all runs or views, you can use the `Runbook.runs` method or `Runbook.views` method to iterate through the runs or views respectively.
+
+```ruby
+Runbook.runs.each do |run|
+  run.register_hook(
+    :give_words_of_encouragement,
+    :before,
+    Runbook::Entities::Book
+  ) do |object, metadata|
+    metadata[:toolbox].output("You've got this!")
+  end
+end
+```
+
+Hooks can be defined anywhere prior to runbook execution. If defining a hook for only a single runbook, it makes sense to define the hook immediately prior to the runbook definition. If you want a hook to apply to all runbooks in your project, it can be defined in a config file such as the `Runbookfile`. If you want to selectively apply the hook to certain runbooks, it may make sense to define it in a file that can be required by runbooks when it is needed.
+
 When starting at a certain position in the runbook, hooks for any preceding sections and steps will be skipped. After hooks will be run for a parent when starting at a child entity of a parent.
 
 ### Adding New Run Behaviors
@@ -1080,6 +1159,8 @@ command "echo '\\''I love cheese'\\''"
 
 Alternatively, if you wish to avoid issues with SSHKit command wrapping, you can specify that your commands be executed in raw form, passed directly as written to the specified host.
 
+`tmux_command` wraps the input passed to it in single quotes. Therefore any single quotes passed to the `tmux_command` should be escaped using `'\\''`. This issue can manifest itself as part of the command not being echoed to the tmux pane.
+
 ### Specifying env values
 
 When specifying the `env` for running commands, if you place curly braces `{}` around the env values, it is required to enclose the arguments in parenthesis `()`, otherwise the following syntax error will result:
@@ -1106,13 +1187,64 @@ not as
 env {rails_env: :production}
 ```
 
+## FAQ
+
+### Are runbooks compiled?
+
+Yes they are. When you define a runbook, a tree data structure is constructed much like an [abstract syntax tree](https://en.wikipedia.org/wiki/Abstract_syntax_tree). This is important because you do not have to worry about any side-effects such as executing server commands when this data structure is compiled. Once compiled, choosing either the run or view to execute the runbook object determines what behavior is executed at each node.
+
+### Why are runbooks compiled?
+
+Runbook is designed to minimize and mitigate issues that arise when running operations in production enviroments. One way this is accomplished is by compiling all statements in the runbook before execution is started. Validations and assertions can be made to reduce the likelihood that a runbook will encounter an error in the middle of an operation. In other words, Runbook provides some guarantees about proper formatting of a runbook before any commands execute that could affect live systems.
+
+### Why is my variable/method not set?
+
+Because runbooks are compiled, statements that set values such as `ask`, `capture`, and `capture_all` statements (using the `:into` keyword) only expose their values at runtime. This means any references to these methods or variables (specified with `:into`) can only happen within `ruby_command` blocks which are evaluated at runtime. If an argument to a statement references the values set by these statements, then the statement must be wrapped in a `ruby_command` block. See [Passing State](#passing-state) for specific examples.
+
+### How do I define and call methods within a runbook?
+
+When defining and referencing your own functions in a runbook, functions should be wrapped in a module so they can be referenced globally. For example:
+
+```ruby
+module Adder
+  def add(x, y)
+    x + y
+  end
+end
+
+Runbook.book "Add Two Numbers" do
+  step "Add numbers" do
+    ask "X?", into: :x
+    ask "Y?", into: :y
+
+    ruby_command do |rb_cmd, metadata, run|
+      metadata[:toolbox].output("Result: #{Adder.add(x, y)}")
+    end
+  end
+end
+```
+
+### Why does my command work on the command line but not in runbook?
+
+There are a number of reasons why a command may work directly on your command line, but not when executed using the `command` statement. Some possible things to try include:
+
+* Print the command with any variables substituted
+* Ensure the command works outside of runbook
+* Use full paths. The `PATH` environment variable may not be set.
+* Check for aliases. Aliases are usually not set for non-interactive shells.
+* Check for environment variables. Differences between your shell environment variables and those set for the executing shell may modify command behavior.
+* Check for differing behavior between the bourne shell (`sh`) and your shell (usually bash).
+* Check that quotes are properly being escaped.
+* Simplify the command you are executing and then slowly build it back up
+* Check for permissions issues that might cause different execution behavior.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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 execute runbook using this repo, run `bundle exec exe/runbook exec samples/layout_runbook.rb`.
+To execute runbook using this repo, run `bundle exec exe/runbook exec examples/layout_runbook.rb`.
 
 To release a new version:
 

data/Rakefile

@@ -1,6 +1,12 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+spec_all = RSpec::Core::RakeTask.new(:spec_all)
+
+spec_task = RSpec::Core::RakeTask.new(:spec)
+spec_task.exclude_pattern = "spec/fullstack/**{,/*/**}/*_spec.rb"
+
+spec_fullstack = RSpec::Core::RakeTask.new(:spec_fullstack)
+spec_fullstack.pattern = "spec/fullstack/**{,/*/**}/*_spec.rb"
 
 task :default => :spec

data/TODO.md

@@ -31,6 +31,7 @@ Runbook is intended to be a light-weight, minimalistic library. This means every
 ## Features Outline
 
 * [Sudo Raw Command Support](#sudo-raw-command-support): Add support for sudo interaction handler for raw commands
+* [Tmux Command Quote Escaping](#tmux-command-quote-escaping): Eliminate the need to escape single quotes in tmux commands
 * [Always-executed Setup Section](#always-executed-setup-section): Add support for a section that is never skipped
 * [Shortened Tmux Layout Keys](#shortened-tmux-layout-keys): Make tmux layout keys easier
 * [Add Host Aliases for SSH Config](#add-host-aliases-for-ssh-config): Use `host` and `hosts` instead of `server` and `servers`
@@ -39,6 +40,7 @@ Runbook is intended to be a light-weight, minimalistic library. This means every
 * [Runbook Logger](#runbook-logger): A logger for Runbook
 * [Mutation Command Skipping](#mutation-command-skipping): Allow skipping mutation commands
 * [Revert Section](#revert-section): A section that can be triggered which will revert the changes of the runbook
+* [Better Error Formatting](#better-error-formatting): More cleanly format errors to aid in troubleshooting issues
 * [Runbook Versioning](#runbook-versioning): Specify a version in a runbook to allow for supporting backwards incompatible runbook DSL format changes
 * [Replace Thor CLI](#replace-thor-cli): Replace Thor for Runbook's CLI with something that can be more easily extended and customized
 * [Goto Statement](#goto-statement): A statement for jumping to a specific step
@@ -55,6 +57,7 @@ Runbook is intended to be a light-weight, minimalistic library. This means every
 * [Guard Runbook](#guard-runbook): Automatically update Runbook views when a runbook is saved
 * [Rake Task Interface](#rake-task-interface): Execute and view runbooks with rake tasks
 * [Multiple Commands In Groups](#multiple-commands-in-groups): Execute multiple sshkit commands for a group of servers before moving on to a new group of servers
+* [Command Line Variables](#command-line-variables): Pass arbitrary variables via the command line
 * [Yaml Specification](#yaml-specification): Define your runbook using yaml instead of Ruby
 * [Runbook Web Server](#runbook-web-server): Automatically serve up Runbook views via the web
 * [Interactive Runbook Launcher](#interactive-runbook-launcher): A CLI launcher to review and execute runbooks
@@ -73,6 +76,28 @@ when raw is specified, number (!) above is not executed. Thus pty is not set to
 
 An ideal solution for this would allow the user to set pty true for the command to be executed via ssh_config. Additionally, it would be beneficial to set their own interaction handler. It seems safe to assume that if a user specifies that a command be executed with a pty, then we can set the sudo interaction handler by default if `enable_sudo_prompt` is set, but still allow for the interaction_handler to be overridden.
 
+#### Tmux Command Quote Escaping
+
+**Difficulty: 1**, **Desireability: 1**, **Conceptual Completeness: 1**
+
+Using heredocs and command substitution, it is possible to eliminate the need to escape single quotes passed to tmux_commands. This would go a long way to make this command more intuitive and ensure that the string passed by the user gets executed in the desired pane. This can be accomplished by updating the `send_keys` method to the following:
+
+```ruby
+def send_keys(command, target)
+  `
+  command=$(cat <<'MAGIC_WORD'
+  #{command}
+  MAGIC_WORD
+  )
+  tmux send-keys -t #{target} #{_pager_escape_sequence} "$command" C-m
+  `
+end
+```
+
+The two main concerns for this change are (1) is this implementation as widely supported as the current implementation (in terms of shells and their versions) and (2) This would technically be a backwards incompatible change where we would want to provide a deprecation path.
+
+Additionally, is it worth pursuing a similar pattern for SSHKit?
+
 #### Always-executed Setup Section
 
 **Difficulty: 2**, **Desireability: 1**, **Conceptual Completeness: 2**
@@ -127,7 +152,7 @@ It would be nice to be able to skip commands that you know will have an effect o
 
 One way to accomplish this is through a tags implementation where entities and statements have a set of tags, and their behavior is controlled based on these tags. I have implemented a spike of adding tags to entities. One complication of skipping mutation commands is that it is not easy to determine if future commands rely on that command executing. This could reduce the overall benefit of flagging and skipping mutation commands. The skipping logic could be implemented using Runbook's hooks feature.
 
-Skipping mutation commands for the sake of testing may also be accomplished through the use of mocks. This could a testing library or perhapsa mocking solution built out for Runbook. Implementing a mocking pattern could resolve the downstream dependency issue of skipping mutation commands. A mocking solution could also be implemented using Runbook hooks.
+Skipping mutation commands for the sake of testing may also be accomplished through the use of mocks. This could be a testing library or perhaps a mocking solution built out for Runbook. Implementing a mocking pattern could resolve the downstream dependency issue of skipping mutation commands. A mocking solution could also be implemented using Runbook hooks.
 
 The mutation command skipping behavior could be controlled via an environment variable. It may be controlled via config or other flag, but this feels too specific to be included in the more general config or run options.  
 
@@ -141,6 +166,12 @@ This functionality could be achieved by adding a new revert entity which respond
 
 A workaround for this is to simply have a separate revert runbook to execute in the event a rollbock is needed.
 
+#### Better Error Formatting
+
+**Difficulty: 2**, **Desireability: 1**, **Conceptual Completeness: 3**
+
+Right now interpretting errors and stacktraces is difficult for people new to Runbook or Ruby. Rspec does a very good job of presenting cleanly formatted errors and helpful error messages for common problems. See their [exception presenter](https://github.com/rspec/rspec-core/blob/6c5628fc0ea83ecf51f1a4d5e0eb2036819a0dab/lib/rspec/core/formatters/exception_presenter.rb) as an example. It would be helpful to examine Rspec's practices around error formatting and providing more helpful error messages to see what can be emulated for Runbook.
+
 #### Runbook Versioning
 
 **Difficulty: 1**, **Desireability: 3**, **Conceptual Completeness: 1**
@@ -195,7 +226,7 @@ It would be nice to capture output or status codes from an executed tmux command
 
 **Difficulty: 3**, **Desireability: 2**, **Conceptual Completeness: 2**
 
-In some instances a step may require that a previous step be executed before it can safely execute. It would be nice if these dependencies could be codified, so when a step is skipped, you can still ensure it is executed when executing a step that depends on it. Tracking which steps have been executed would probably want to exist for the life of the execution of the runbook, so surving restarts. In an extreme case, executing a runbook may boil down to a rake-like execution. Perhaps it would be possible to make steps independently executable, and then they could be weaved into rake.
+In some instances a step may require that a previous step be executed before it can safely execute. It would be nice if these dependencies could be codified, so when a step is skipped, you can still ensure it is executed when executing a step that depends on it. Tracking which steps have been executed would probably want to exist for the life of the execution of the runbook, so surviving restarts. In an extreme case, executing a runbook may boil down to a rake-like execution. Perhaps it would be possible to make steps independently executable, and then they could be weaved into rake.
 
 #### Update Command Counts
 
@@ -256,6 +287,12 @@ When specifying to execute a command against multiple servers in groups using th
 
 I do not have an idea of how to cleanly accomplish this.
 
+#### Command Line Variables
+
+**Difficulty: 1**, **Desireability: 3**, **Conceptual Completeness: 2**
+
+Add a `vars` command-line option for runtime variables passed through the command line. These arbitrary command-line vars would be stored in the metadata and accessible at runtime (for example in a `ruby_command` block). These can be useful for modifying the runbook's behavior within hooks in conjunction with tags and labels.  This functionality already exists however with the use of environment variables. Environment variables are also available at compile time, where as these command line variables are not. In order to make the command line variables available at compile time, they would have to be set in a global context.  It is not clear if these values would persist between runs. It may be best practice to save them and overwrite them if re-defined on the command line, but it is not clear if this is intuitive.
+
 #### Yaml Specification
 
 **Difficulty: 2**, **Desireability: 2**, **Conceptual Completeness: 1**

data/dockerfiles/Dockerfile-runbook

@@ -0,0 +1,18 @@
+FROM ruby:2.5
+RUN apt-get update -qq && apt-get install -y build-essential tmux
+
+RUN mkdir /runbook
+WORKDIR /runbook
+
+RUN mkdir /runbook/bin
+ADD bin/setup /runbook/bin/setup
+
+ADD runbook.gemspec /runbook/runbook.gemspec
+ADD Gemfile /runbook/Gemfile
+
+RUN mkdir -p /runbook/lib/runbook
+ADD lib/runbook/version.rb /runbook/lib/runbook/version.rb
+
+RUN bin/setup
+
+ADD . /runbook

data/lib/runbook.rb

@@ -12,6 +12,8 @@ require "tty-progressbar"
 require "tty-prompt"
 require "thor/group"
 
+require "runbook/airbrussh_context"
+
 require "runbook/configuration"
 
 require "hacks/ssh_kit"
@@ -30,6 +32,7 @@ require "runbook/node"
 require "runbook/entity"
 require "runbook/entities/book"
 require "runbook/entities/section"
+require "runbook/entities/setup"
 require "runbook/entities/step"
 
 require "runbook/statement"
@@ -74,6 +77,7 @@ require "runbook/extensions/add"
 require "runbook/extensions/description"
 require "runbook/extensions/shared_variables"
 require "runbook/extensions/sections"
+require "runbook/extensions/setup"
 require "runbook/extensions/ssh_config"
 require "runbook/extensions/statements"
 require "runbook/extensions/steps"
@@ -86,24 +90,36 @@ ActiveSupport::Inflector.inflections(:en) do |inflect|
 end
 
 module Runbook
-  def self.book(title, &block)
+  def self.book(title, *tags, labels: {}, &block)
     Configuration.load_config
-    Entities::Book.new(title).tap do |book|
+    Entities::Book.new(title, tags: tags, labels: labels).tap do |book|
       book.dsl.instance_eval(&block)
       register(book)
     end
   end
 
-  def self.section(title, &block)
+  def self.section(title, *tags, labels: {}, &block)
     Configuration.load_config
-    Entities::Section.new(title).tap do |section|
+    Entities::Section.new(title, tags: tags, labels: labels).tap do |section|
       section.dsl.instance_eval(&block)
     end
   end
 
-  def self.step(title=nil, &block)
+  def self.setup(*tags, labels: {}, &block)
     Configuration.load_config
-    Entities::Step.new(title).tap do |step|
+    Entities::Setup.new(tags: tags, labels: labels).tap do |setup|
+      setup.dsl.instance_eval(&block)
+    end
+  end
+
+  def self.step(title=nil, *tags, labels: {}, &block)
+    if title.is_a?(Symbol)
+      tags.unshift(title)
+      title = nil
+    end
+
+    Configuration.load_config
+    Entities::Step.new(title, tags: tags, labels: labels).tap do |step|
       step.dsl.instance_eval(&block) if block
     end
   end
@@ -115,4 +131,8 @@ module Runbook
   def self.books
     @books ||= []
   end
+
+  def self.runtime_methods
+    @runtime_methods ||= []
+  end
 end

data/lib/runbook/airbrussh_context.rb

@@ -0,0 +1,25 @@
+module Runbook
+  class AirbrusshContext
+    attr_reader :history, :current_task_name
+
+    def initialize(config=Airbrussh.configuration)
+      @history = []
+    end
+
+    def register_new_command(command)
+      hist_entry = command.to_s
+      first_execution = history.last != hist_entry
+      history << hist_entry if first_execution
+      first_execution
+    end
+
+    def position(command)
+      history.rindex(command.to_s)
+    end
+
+    def set_current_task_name(task_name)
+      @current_task_name = task_name
+      history.clear
+    end
+  end
+end

data/lib/runbook/cli.rb

@@ -104,8 +104,23 @@ module Runbook
       unless File.exist?(runbook)
         raise Thor::InvocationError, "#{cmd}: cannot access #{runbook}: No such file or directory"
       end
-      load(runbook)
-      Runbook.books.last || eval(File.read(runbook))
+
+      begin
+        load(runbook)
+        Runbook.books.last || eval(File.read(runbook))
+      rescue NameError => e
+        if Runbook.runtime_methods.include?(e.name)
+          message = (
+            "Runtime method `#{e.name}` cannot be referenced at " \
+            "compile time. Wrap statements referencing it in a " \
+            "`ruby_command` block in order to invoke the code at " \
+            "runtime."
+          )
+          raise e, message, e.backtrace
+        end
+
+        raise e
+      end
     end
   end
 end

data/lib/runbook/configuration.rb

@@ -19,6 +19,7 @@ module Runbook
   end
 
   class Configuration
+    attr_accessor :_airbrussh_context
     attr_accessor :ssh_kit
     attr_accessor :enable_sudo_prompt
     attr_reader :use_same_sudo_password
@@ -89,11 +90,16 @@ module Runbook
 
     def initialize
       self.ssh_kit = SSHKit.config
-      ssh_kit.output = Airbrussh::Formatter.new(
+      formatter = Airbrussh::Formatter.new(
         $stdout,
         banner: nil,
         command_output: true,
+        context: AirbrusshContext,
       )
+      ssh_kit.output = formatter
+      self._airbrussh_context = formatter.formatters.find do |fmt|
+        fmt.is_a?(Airbrussh::ConsoleFormatter)
+      end.context
       self.enable_sudo_prompt = true
       self.use_same_sudo_password = true
     end

data/lib/runbook/entities/book.rb

@@ -1,7 +1,7 @@
 module Runbook::Entities
   class Book < Runbook::Entity
-    def initialize(title)
-      super(title)
+    def initialize(title, tags: [], labels: {})
+      super(title, tags: tags, labels: labels)
     end
 
     # Seed data for 'render' tree traversal method

data/lib/runbook/entities/section.rb

@@ -1,7 +1,7 @@
 module Runbook::Entities
   class Section < Runbook::Entity
-    def initialize(title)
-      super(title)
+    def initialize(title, tags: [], labels: {})
+      super(title, tags: tags, labels: labels)
     end
   end
 end

data/lib/runbook/entities/setup.rb

@@ -0,0 +1,7 @@
+module Runbook::Entities
+  class Setup < Runbook::Entity
+    def initialize(tags: [], labels: {})
+      super("Setup", tags: tags, labels: labels)
+    end
+  end
+end

data/lib/runbook/entities/step.rb

@@ -1,7 +1,7 @@
 module Runbook::Entities
   class Step < Runbook::Entity
-    def initialize(title=nil)
-      super(title)
+    def initialize(title=nil, tags: [], labels: {})
+      super(title, tags: tags, labels: labels)
     end
   end
 end

data/lib/runbook/entity.rb

@@ -8,10 +8,12 @@ module Runbook
     end
 
     attr_accessor :parent
-    attr_reader :title, :dsl
+    attr_reader :title, :tags, :labels, :dsl
 
-    def initialize(title, parent: nil)
+    def initialize(title, tags: [], labels: {}, parent: nil)
       @title = title
+      @tags = tags
+      @labels = labels
       @parent = parent
       @dsl = "#{self.class}::DSL".constantize.new(self)
     end
@@ -92,7 +94,8 @@ module Runbook
 
     def _run_metadata(items, item, metadata, index)
       pos_index = items.select do |item|
-        item.is_a?(Entity)
+        item.is_a?(Entity) &&
+          !item.is_a?(Runbook::Entities::Setup)
       end.index(item)
 
       if pos_index

data/lib/runbook/extensions/add.rb

@@ -9,5 +9,6 @@ module Runbook::Extensions
 
   Runbook::Entities::Book::DSL.prepend(Add::DSL)
   Runbook::Entities::Section::DSL.prepend(Add::DSL)
+  Runbook::Entities::Setup::DSL.prepend(Add::DSL)
   Runbook::Entities::Step::DSL.prepend(Add::DSL)
 end

data/lib/runbook/extensions/sections.rb

@@ -1,8 +1,12 @@
 module Runbook::Extensions
   module Sections
     module DSL
-      def section(title, &block)
-        Runbook::Entities::Section.new(title).tap do |section|
+      def section(title, *tags, labels: {}, &block)
+        Runbook::Entities::Section.new(
+          title,
+          tags: tags,
+          labels: labels,
+        ).tap do |section|
           parent.add(section)
           section.dsl.instance_eval(&block)
         end

data/lib/runbook/extensions/setup.rb

@@ -0,0 +1,17 @@
+module Runbook::Extensions
+  module Setup
+    module DSL
+      def setup(*tags, labels: {}, &block)
+        Runbook::Entities::Setup.new(
+          tags: tags,
+          labels: labels,
+        ).tap do |setup|
+          parent.add(setup)
+          setup.dsl.instance_eval(&block) if block
+        end
+      end
+    end
+  end
+
+  Runbook::Entities::Book::DSL.prepend(Setup::DSL)
+end

data/lib/runbook/extensions/ssh_config.rb

@@ -71,6 +71,8 @@ module Runbook::Extensions
   Runbook::Entities::Step::DSL.prepend(SSHConfig::DSL)
   Runbook::Entities::Section.prepend(SSHConfig)
   Runbook::Entities::Section::DSL.prepend(SSHConfig::DSL)
+  Runbook::Entities::Setup.prepend(SSHConfig)
+  Runbook::Entities::Setup::DSL.prepend(SSHConfig::DSL)
   Runbook::Entities::Book.prepend(SSHConfig)
   Runbook::Entities::Book::DSL.prepend(SSHConfig::DSL)
 end

data/lib/runbook/extensions/statements.rb

@@ -5,6 +5,10 @@ module Runbook::Extensions
         if (klass = Statements::DSL._statement_class(name))
           klass.new(*args, &block).tap do |statement|
             parent.add(statement)
+
+            if statement.respond_to?(:into)
+              Runbook.runtime_methods << statement.into
+            end
           end
         else
           super
@@ -22,5 +26,6 @@ module Runbook::Extensions
     end
   end
 
+  Runbook::Entities::Setup::DSL.prepend(Statements::DSL)
   Runbook::Entities::Step::DSL.prepend(Statements::DSL)
 end

data/lib/runbook/extensions/steps.rb

@@ -1,8 +1,17 @@
 module Runbook::Extensions
   module Steps
     module DSL
-      def step(title=nil, &block)
-        Runbook::Entities::Step.new(title).tap do |step|
+      def step(title=nil, *tags, labels: {}, &block)
+        if title.is_a?(Symbol)
+          tags.unshift(title)
+          title = nil
+        end
+
+        Runbook::Entities::Step.new(
+          title,
+          tags: tags,
+          labels: labels,
+        ).tap do |step|
           parent.add(step)
           step.dsl.instance_eval(&block) if block
         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
@@ -274,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/runs/ssh_kit.rb

@@ -9,6 +9,12 @@ module Runbook::Runs
     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)
 

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/version.rb

@@ -1,3 +1,3 @@
 module Runbook
-  VERSION = "0.15.0"
+  VERSION = "0.16.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)
@@ -41,11 +49,11 @@ module Runbook::Views
     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

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "method_source", "~> 0.9"
   spec.add_runtime_dependency "sshkit", "1.16"
   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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runbook
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - pblesi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-29 00:00:00.000000000 Z
+date: 2019-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -236,6 +236,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
@@ -251,6 +252,11 @@ files:
 - TODO.md
 - bin/console
 - bin/setup
+- dockerfiles/Dockerfile-runbook
+- examples/hooks_runbook.rb
+- examples/layout_runbook.rb
+- examples/restart_nginx.rb
+- examples/simple_runbook.rb
 - exe/runbook
 - gemfiles/.bundle/config
 - gemfiles/activesupport_5.gemfile
@@ -260,18 +266,21 @@ files:
 - images/runbook_execution_modes.png
 - lib/hacks/ssh_kit.rb
 - lib/runbook.rb
+- lib/runbook/airbrussh_context.rb
 - lib/runbook/cli.rb
 - lib/runbook/cli_base.rb
 - lib/runbook/configuration.rb
 - lib/runbook/dsl.rb
 - lib/runbook/entities/book.rb
 - lib/runbook/entities/section.rb
+- lib/runbook/entities/setup.rb
 - lib/runbook/entities/step.rb
 - lib/runbook/entity.rb
 - lib/runbook/errors.rb
 - lib/runbook/extensions/add.rb
 - lib/runbook/extensions/description.rb
 - lib/runbook/extensions/sections.rb
+- lib/runbook/extensions/setup.rb
 - lib/runbook/extensions/shared_variables.rb
 - lib/runbook/extensions/ssh_config.rb
 - lib/runbook/extensions/statements.rb
@@ -327,10 +336,6 @@ files:
 - lib/runbook/viewer.rb
 - lib/runbook/views/markdown.rb
 - runbook.gemspec
-- samples/hooks_runbook.rb
-- samples/layout_runbook.rb
-- samples/restart_nginx.rb
-- samples/simple_runbook.rb
 homepage: https://github.com/braintree/runbook/
 licenses:
 - MIT