runbook 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cb2a40c659a212a9fda6d78d1e94b07ba51625896cd6e4f4a4b6668e42bbc4e
-  data.tar.gz: 065708ff0b3bd93dfdcc35b60730138053e64af9e78768176282f5dc59236b66
+  metadata.gz: 9c05a6c35dcd51c2e91eabd838214a00c1bee394f372040c16f89d62d803a352
+  data.tar.gz: 44122acdd87e97bf0baafb59eed9bbea5be8109e5cd31afa6560da358b454a21
 SHA512:
-  metadata.gz: 87559cf0bee8e17052a2639033a96481fba11963e50c596f138e64fc72b54328288202bfbe3576da6417eada36f219123ba54d726ab0cc6b28176f31552d21ae
-  data.tar.gz: a0b414a4f0b8fa499cc46362d03d2dfb814cf65a46decbd796ffc45e7ecbd0f68db7a2a89168a3ace032814893ef649fa3a1d36982315f548688f4ce7e470b3c
+  metadata.gz: 252644365a05249254a5b4917fced2303d7554c136710adb100fcb7403157da5cb34d6a46d9b2ee9434f8fe89800330a16753cab634e35bb867142156903a706
+  data.tar.gz: 8d903da453e97dd258ff3f656f64540aa8674646b3c9a305e21cd9afd7018d41e8cf69aad8c9f43930f51ccce6b4cff5efeb6f3abca13c3216b96d7908108fbb

data/.gitignore

@@ -10,3 +10,7 @@
 
 # rspec failure tracking
 .rspec_status
+
+# recommended:
+# https://github.com/thoughtbot/appraisal#version-control
+gemfiles/*.gemfile.lock

data/.travis.yml

@@ -3,7 +3,22 @@ language: ruby
 rvm:
   - 2.2.3
   - 2.2.10
+  - 2.3.8
   - 2.4.6
   - 2.5.5
   - 2.6.3
+gemfile:
+  - gemfiles/activesupport_5.gemfile
+  - gemfiles/activesupport_6.gemfile
+matrix:
+  exclude:
+    - rvm: 2.2.3
+      gemfile: gemfiles/activesupport_6.gemfile
+    - rvm: 2.2.10
+      gemfile: gemfiles/activesupport_6.gemfile
+    - rvm: 2.3.8
+      gemfile: gemfiles/activesupport_6.gemfile
+    - rvm: 2.4.6
+      gemfile: gemfiles/activesupport_6.gemfile
+
 before_install: gem install bundler -v 1.15.4

data/Appraisals

@@ -0,0 +1,8 @@
+appraise "activesupport-5" do
+  gem "activesupport", "~> 5.0"
+end
+
+appraise "activesupport-6" do
+  gem "activesupport", "~> 6.0"
+end
+

data/CHANGELOG.md

@@ -4,6 +4,21 @@ This log maintains a list of all substantive changes to Runbook. The log include
 
 ## master
 
+## `v0.15.0` (2019-09-29)
+
+### Fixes:
+
+* 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)
+
+### New Features
+
+* Allow books to have steps as children
+* Allow "echo: false" for ask statements
+* Expose "run" as an argument to ruby_commands
+
 ## `v0.14.0` (2019-08-15)
 
 ### Fixes:

data/README.md

@@ -233,7 +233,7 @@ Runbook.book "Unbalance node" do
 end
 ```
 
-Every book requires a title. Books can have description, layout, and section children. Descriptions describe the book and are declared with the `description` keyword.
+Every book requires a title. Books can have description, layout, section, and step children. Descriptions describe the book and are declared with the `description` keyword.
 
 ##### Sections
 
@@ -249,10 +249,10 @@ Statements are the workhorses of runbooks. They comprise all the behavior runboo
 
 ##### Ask
 
-Prompts the user for a string and stores its value on the containing step entity. Once this statement is executed, its value is accessed as an instance variable under the `into` parameter. This value can be referenced in later statements such as the `ruby_command` statement.
+Prompts the user for a string and stores its value on the containing step entity. Once this statement is executed, its value is accessed as an instance variable under the `into` parameter. This value can be referenced in later statements such as the `ruby_command` statement. An optional `default` value can be specified. An optional `echo` parameter can be specified to indicate whether typed input should be echoed to the screen.
 
 ```ruby
-ask "What percentage of requests are failing?", into: :failing_request_percentage, default: "100"
+ask "What percentage of requests are failing?", into: :failing_request_percentage, default: "100", echo: true
 ```
 
 ##### Assert
@@ -267,7 +267,7 @@ assert(
   interval: 3, # seconds
   timeout: 300, # seconds
   attempts: 3,
-  timeout_statement: Runbook::Statements::Command.new(
+  abort_statement: Runbook::Statements::Command.new(
     "echo 'help' | mail -s 'need help' page-me@page-me.com",
     ssh_config: {servers: [:local], parallelization: {strategy: :parallel}},
     raw: false
@@ -355,10 +355,10 @@ notice "There be dragons!"
 
 ##### Ruby Command
 
-Executes its block in the context of the parent step. The block is passed the ruby_command statement and the execution metadata as arguments.
+Executes its block in the context of the parent step. The block is passed the ruby_command statement, the execution metadata, and the run as arguments.
 
 ```ruby
-ruby_command do |rb_cmd, metadata|
+ruby_command do |rb_cmd, metadata, run|
   if (failure_rate = rb_cmd.parent.failing_request_percentage) > 25
     `echo 'Help! failure rate at #{failure_rate}' | mail -s 'High failure rate!' page-me@page-me.com`
   else
@@ -1119,8 +1119,8 @@ To release a new version:
 1. Update the version number in `version.rb`.
 2. Update the changelog in `CHANGELOG.rb`.
 3. Commit changes with commit messsage: "Bump runbook version to X.Y.Z"
-4. Run `bundle exec rake release`, which will create a git tag for the version and push git commits and tags.
-5. Push the `.gem` file in `pkg` to your gem repository
+4. Run `gem signin` to ensure you can push the new version to rubygems.org
+5. Run `bundle exec rake release`, which will create a git tag for the version and push git commits and tags.
 
 ## Contributing
 

data/TODO.md

@@ -1,46 +1,279 @@
-## Desired feature list
-* [X] Revise README.md
-* [X] Create a generator for a runbook? Allow for custom generators?
-  * Generate runbook templates
-  * Generate runbook projects with Runbookfile, Gemfile, etc.
-  * Generate plugins
-* [] capistrano-runbook gem that integrates runbook into capistrano tasks
-* [] Add Appraisal to test against multiple versions of Ruby
-* [] Update output to be more log friendly, including timestamps for operations
-* [] Allow for preventing echo when prompting for input
-* [] Add an ability for skipping mutation commands that will have an affect on the system
-* [] Add a revert section that does not get executed, but can be executed by passing a revert flag
-* [] Specify version in runbook to allow for supporting backwards incompatible runbook DSL format changes
-* [] Add support for sudo interaction handler for raw commands
-* [] Replace Thor with a solution that is more easily extendable (adding new flags, etc.)
-* [] Add goto statements for repeating steps (functionality exists in paranoid mode)
-* [] Add test statement
-* [] Add ruby_assert statement
-* [] Feedback on completion of tmux commands (when they complete, return values, outputs)
-* [] Add shorter aliases for tmux layout keys
-* [] Add host aliases for ssh_config setters
-* [] Allow for step dependencies that get executed before the step
-* [] Add periodic flush for sshkit output
-* [] Update assert attribute nomenclature (timeout_statement)
-* [] Update ssh_kit to count commands separately between steps
-* [] Create a plugin generator
-* [] Create generator for a new run (sshkit, etc.)
-* [] Create generator for a new view (markdown, yaml, html, etc.)
-* Add rake tasks to generators for viewing and executing runbooks
-* Add a way to execute a series of commands in groups
-* Docker testing story for more full-stack integration tests
-  * Test integration with sshkit
-  * Test sshkit-sudo functionality
-* logging solution for alternate output
-* Pattern for conditionally enabling plugins? Conditional plugins should be implemented as separate gems.
-  * Requiring a plugin is the same as enabling it
-  * Configuration can be added to toggle aspects of the plugin
-* Add a setup step that always executes even if start_at is defined
-* Yaml specification format (subset of Ruby)
-  * Will not contain as much flexibility as Ruby format
-  * Can convert from Ruby format to yaml (depending on compatibility) and yaml to Ruby
-* Guard for view updates (How to handle arguments?)
-* Be able to serve up markdown docs (web server) for easy viewing
-* Add interactive executable for all runbooks in a project
-* Could provide a rake task for compiling and nooping runbooks?
-* Can specify input-format, output-format, input (file), and output (file)
+# Runbook TODO
+
+## Description
+
+This document covers a list of ideas for Runbook improvements. Ideas vary wildly in terms of difficulty, desireability, and conceptual completeness. Each idea has a difficulty, desireability, and conceptual completeness rating from 1 to 3. These ideas are roughly ordered in terms of priority. 
+
+Ratings are as follows:
+
+Difficulty:
+
+* 1: Easy
+* 2: Medium
+* 3: Hard
+
+Desireability:
+
+* 1: Must have
+* 2: Nice to have
+* 3: May be nice to have
+
+Conceptual Completeness:
+
+* 1: I know exactly how to implement this
+* 2: I have some idea about how to implement this
+* 3: I have no ideas about how to implement this
+
+## Other Considerations
+
+Runbook is intended to be a light-weight, minimalistic library. This means every feature must be weighed against the usability of work-arounds in order to determine if a feature is worth including in Runbook. Sometimes features are easy and straightforward to implement but not enough demand has been demonstrated to justify including the feature into Runbook.
+
+## Features Outline
+
+* [Sudo Raw Command Support](#sudo-raw-command-support): Add support for sudo interaction handler for raw 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`
+* [Capistrano-runbook Gem](#capistrano-runbook-gem): A gem for integrating runbook directly into capistrano
+* [Blocking Tmux Commands](#blocking-tmux-commands): Don't continue execution until the tmux_command completes
+* [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
+* [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
+* [Test Statement](#test-statement): A statement for executing a remote command and conditioning on its success
+* [RubyAssert Statement](#rubyassert-statement): A statement analogous to assert, but executing a block instead of a command
+* [Docker Testing](#docker-testing): Add tests that execute against docker containers
+* [Tmux Command Results](#tmux-command-results): Capture outputs and status codes for tmux commands
+* [Step Dependencies](#step-dependencies): Like rake, allow a step to invoke another step if it has not been executed
+* [Update Command Counts](#update-command-counts): Use step titles for counting commands executed in a step
+* [Create Plugin Generator](#create-plugin-generator): A generator for creating boilerplate for a new Runbook plugin
+* [Create Run Generator](#create-run-generator): A generator for creating boilerplate for a new run such as sshkit
+* [Create View Generator](#create-view-generator): A generator for creating boilerplate for a new view such as markdown, yaml, html
+* [Outline View Option](#outline-view-option): A command-line option to only execute entity nodes
+* [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
+* [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
+
+### Feature Details
+
+#### Sudo Raw Command Support
+
+**Difficulty: 1**, **Desireability: 1**, **Conceptual Completeness: 1**
+
+Runbook supports a password prompt when executing commands using sudo. The typical way to execute sudo commands is to specify the `user` setter. This will do three things. It will (1) set the interaction handler when performing the initial [sudo check](https://github.com/braintree/runbook/blob/54e90f2a9c93704857bc31b0e03769b6e959d879/lib/hacks/ssh_kit.rb#L40-L49) and the pty for the execution of the command. It will (2) wrap the command to be executed with [a call to sudo](https://github.com/braintree/runbook#command-quoting). And it will (3) set the [interaction handler for commands](https://github.com/braintree/runbook/blob/54e90f2a9c93704857bc31b0e03769b6e959d879/lib/runbook/helpers/ssh_kit_helper.rb#L11-L13) that are executing which are wrapped in sudo.
+
+Raw commands remove all the [command wrapping](https://github.com/braintree/runbook/commit/075d95c214c44db2c2803c211fbd40e1fbc89ae9#diff-a4bf760ce531af31e88293aecd750138https://github.braintreeps.com/braintree/runbook#command-quoting) that is performed when specifying commands. This is nice when you want to avoid the helper functionality when it complicates or obfuscates the command you are trying to execute (for example trying to escape nested quotes).
+
+when raw is specified, number (!) above is not executed. Thus pty is not set to true. (2) can be assumed to manually be performed by the user (they will have to type their own sudo command). (3) Is currently toggled by the user setter and the `enable_sudo_prompt` config.
+
+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.
+
+#### Always-executed Setup Section
+
+**Difficulty: 2**, **Desireability: 1**, **Conceptual Completeness: 2**
+
+It is often a best practice to provide a setup section at the beginning of your runbook which gathers all required info for the runbook so the rest of the runbook can execute with minimal interruption. Under certain circumstances it can be ideal to ensure this section is always run, so that if you want to jump to the middle of a runbook, you can have confidence that any necessary initial configuration is executed.
+
+This can additionally be used if you want to dynamically define your runbook based on some initial input, then you can ensure that this is executed and you can step to the middle of a runbook, but know that the step has been defined by the initial setup. This, however, would not aid in generating a proper view for the runbook.
+
+#### Shortened Tmux Layout Keys
+
+**Difficulty: 1**, **Desireability: 1**, **Conceptual Completeness: 1**
+
+`directory` should become `path` because it is shorter and consistent with the DSL. `runbook_pane` should become `runbook` because it is shorter and just as intuitive. Usage of old values should be marked as deprecated.
+
+#### Add Host Aliases for SSH Config
+
+**Difficulty: 1**, **Desireability: 1**, **Conceptual Completeness: 1**
+
+`server` should become `host` because it is shorter. `servers` should become `hosts` because it is shorter and just as intuitive. Usage of old values should be marked as deprecated.
+
+#### Capistrano-runbook Gem
+
+**Difficulty: 2**, **Desireability: 1**, **Conceptual Completeness: 2**
+
+A number of Ruby and non-Ruby projects use capistrano for deployments and other one-off tasks. Often times an application or organization's server inventory/manifest lives within capistrano. Creating a `capistrano-runbook` gem would (a) Allow you to access server lists programmatically within your runbooks based on role and (b) invoke capistrano tasks within the same Ruby process. 
+
+The implementation for this would be pretty straightforward. It would provide an alternative interface for invoking runbooks (as opposed to invoking via the CLI).
+
+Helpful links:
+
+* https://github.com/braintree/runbook/blob/0c0a028dffe88f0bb45ab2afcffe202ae3baa58b/lib/runbook/cli.rb#L52-L66
+* https://github.com/braintree/runbook/blob/0c0a028dffe88f0bb45ab2afcffe202ae3baa58b/lib/runbook/cli.rb#L22-L28
+* https://github.com/braintree/runbook/blob/master/README.md#from-within-your-project
+
+#### Blocking Tmux Commands
+
+**Difficulty: 2**, **Desireability: 1**, **Conceptual Completeness: 2**
+
+Right now tmux commands are started and then immediately return control to the runbook. It would be ideal if a flag could be passed to not return control to the runbook until the tmux command has completed. Additionally, it may be nice to have a block command that waits for one of multiple tmux commands to finish executing. One potential implementation for this is to use `ps`. Another may be to use the `proc` file system. I am not aware of anything built into tmux for this purpose.
+
+#### Runbook Logger
+
+**Difficulty: 1**, **Desireability: 1**, **Conceptual Completeness: 2**
+
+Include a dedicated logger for Runbook that is incorporated into the execution. This can be off by default, but enabled by setting a log file. Additionally, a log-level can be set. Log output should include what is being executed, and what the result is. The log should be compatible with sshkit's log output. Additionally, this should be implemented in a way that all normal output is suppressed and log output is written to stdout. It would be nice if adding logging did not require additional code for each entity and statement execution.
+
+#### Mutation Command Skipping
+
+**Difficulty: ?**, **Desireability: 2**, **Conceptual Completeness: 3**
+
+It would be nice to be able to skip commands that you know will have an effect on your system. The main use case for this is testing. You can test your runbook more thoroughly and have confidence that it will not make changes to your system. It would be difficult if not impossible to determine what commands will have a mutable affect, so this will likely need to be user-determined.
+
+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.
+
+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.  
+
+#### Revert Section
+
+**Difficulty: ?**, **Desireability: 3**, **Conceptual Completeness: 2**
+
+It is a best practice to have a plan for reverting any system changes you make. It would be nice to have a way to include this revert plan in with your runbook and simply trigger its execution with a flag. The revert plan may not be straight-forward if the rollout plan did not run to completion, so revert plans may need to assume this to be the case. Also, it does not appear possible to infer what rollback steps would be based on the initial runbook.
+
+This functionality could be achieved by adding a new revert entity which responds to a revert flag passed by the user (environment variable, command line config, runner/viewer option). Instead of a separate entity, this could be accomplished with a tagging solution, where a section has a revert tag that designates it should be skipped unless the revert flag is present (and vis-versa for non-revert sections). The skipping logic could be implemented using Runbook hooks.
+
+A workaround for this is to simply have a separate revert runbook to execute in the event a rollbock is needed.
+
+#### Runbook Versioning
+
+**Difficulty: 1**, **Desireability: 3**, **Conceptual Completeness: 1**
+
+Right now if the API for the Runbook DSL changes in a backwards incompatible way, the runbook will break when being executed with the new version of Runbook. If we add a version declaration for the runbook, then we can conditionally execute the backwards incompatibile code based on the version. 
+
+An alternative to including a version declaration would be to only change backwards incompatibilities between major versions of Runbook, and require that users of the new version update all their runbooks to be compatible with the new version. Including a version declaration may make this more explicit and easy to know which versions are an are not compatible. As the version declaration is meant to indicate a DSL backwards incompatibility, this should be detectable by simply compiling the runbooks using the view functionality, or another side-effectless compilation to determine when things break. 
+
+A version flag can always be added at a later date, and Runbooks without the flag can be considered to be the older version. This could be set to be required for new Runbooks.
+
+#### Replace Thor CLI
+
+**Difficulty: 3**, **Desireability: 2**, **Conceptual Completeness: 2**
+
+It would be nice if Runbook's CLI interface could be customized via the use of plugins. Thor commands and options are specified by executing methods in a specific order in a class, so it is not easily extensible if a plugin wants to customize the CLI. One possible solution is to replace Thor with another CLI solution such as Ruby's build int option parser or GLI. I am not sure what other good solutions out there exist.
+
+Another solution could be to extend Thor in a way that additional arguments can "fall through" or perhaps accept variable arguments that get set on runbook config which can be used to modify execution behavior. This solution may be better because it sets a clear boundary between core runbook and plugins.
+
+#### Goto Statement
+
+**Difficulty: 1**, **Desireability: 2**, **Conceptual Completeness: 1**
+
+This statement would provide the same behavior as the jump option at the step menu, allowing you to go to a certain step. Jump may be a better keyword than goto. An existing workaround is to use `ruby_command` and set `start_at` in the metadata. This behavior could be used for repeating steps until a certain criteria is met.
+
+#### Test Statement
+
+**Difficulty: 1**, **Desireability: 2**, **Conceptual Completeness: 1**
+
+This statement would take a command, execute it using SSHKit's test command, and then yield its return value as a boolean that can be conditioned on within a block. The block should have the same context as a ruby_command. A workaround is to use capture combined with echoing `$?` or similar to capture the return value of your command and then condition on the value returned.
+
+#### RubyAssert Statement
+
+**Difficulty: 1**, **Desireability: 2**, **Conceptual Completeness: 1**
+
+This statement would duplicate all of the logic of the current `assert`, but instead of conditioning on whether a command executes successfully, it would condition on whether the block executes successfully. This behavior can currently be accomplished with a `ruby_command`, but it takes a deal of effort to copy the same logic.
+
+#### Docker Testing
+
+**Difficulty: 2**, **Desireability: 1**, **Conceptual Completeness: 2**
+
+Providing integration-level tests that execute features of runbook against docker containers would give us additional test coverage to test features of runbook that use sshkit against remote hosts. Additionally, we could increase our test coverage for our sshkit-sudo functionality.
+
+Additionally, it is worth thinking about if any changes to Runbook can help support testing runbooks created by end-users. What is needed to be able to spin up a test environment, execute a runbook, and ensure that the runbook executed successfully?
+
+#### Tmux Command Results
+
+**Difficulty: 2**, **Desireability: 2**, **Conceptual Completeness: 2**
+
+It would be nice to capture output or status codes from an executed tmux command. This could be accomplished by writing the values to a file and then reading them, but it may be nice to have a more streamlined solution.
+
+#### Step Dependencies
+
+**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.
+
+#### Update Command Counts
+
+**Difficulty: 1**, **Desireability: 3**, **Conceptual Completeness: 1**
+
+SSHKit has an incrementing number for each command that is executed. This incrementing number is for the entire runbook which doesn't provide a lot of value. Providing the count per step would be more informative. Additionally, the logic uses the same number for similar commands. For example if you call `ls` twice, it will use the same number each time. It would be nice if this number was more contextual. Probably the best way to accomplish this involves, creating a PR to Airbrussh to allow a context to be set via config. The context would emulate the RakeContext but have different logic for setting the current task and tracking the history of commands. It would probably make sense to make an Abstract Context that defines the required interface for a context, which is `current_task_name`, `register_new_command`, and `position`. This issue has been opened up to track this work: https://github.com/mattbrictson/airbrussh/issues/130
+
+Helpful links:
+
+* https://github.com/mattbrictson/airbrussh/blob/918c072254c8bf78982bb6a5e384cedc8e361836/lib/airbrussh/configuration.rb#L7
+* https://github.com/mattbrictson/airbrussh/blob/918c072254c8bf78982bb6a5e384cedc8e361836/lib/airbrussh/console_formatter.rb#L19
+* https://github.com/mattbrictson/airbrussh/blob/918c072254c8bf78982bb6a5e384cedc8e361836/lib/airbrussh/rake/context.rb#L47
+* https://github.com/mattbrictson/airbrussh/blob/918c072254c8bf78982bb6a5e384cedc8e361836/lib/airbrussh/command_formatter.rb#L11
+
+#### Create Plugin Generator
+
+**Difficulty: 1**, **Desireability: 2**, **Conceptual Completeness: 2**
+
+Creating a generator for new Runbook plugins would help to make new plugin creation easier. Additionally, it would help to enforce common patterns for new plugins. As no Runbook plugins currently exist, this feature is not a high priority at this point.
+
+Some notes on plugins: (1) The switch for enabling a Runbook plugin should be requiring the plugin. (2) If you want to control how certain parts of the plugin are executed, this should be managed using Runbook's configuration.
+
+#### Create Run Generator
+
+**Difficulty: 1**, **Desireability: 3**, **Conceptual Completeness: 1**
+
+This would make creating new runs easier. As creating new runs is a pretty rare occurrence, this feature seems unnecessary at this point, but may be nice for completeness.
+
+#### Create View Generator
+
+**Difficulty: 1**, **Desireability: 3**, **Conceptual Completeness: 1**
+
+This would make creating new views easier. As creating new views is a pretty rare occurrence, this feature seems unnecessary at this point, but may be nice for completeness.
+
+#### Outline View Option
+
+**Difficulty: 1**, **Desireability: 3**, **Conceptual Completeness: 1**
+
+When this option is supplied only entity nodes (book, section, step) would be rendered. This could be nice if you just want an overview of what a runbook does. I have not seen too much demand for this feature, so have not implemented it. It would add an additional option to the view CLI command.
+
+#### Guard Runbook
+
+**Difficulty: 2**, **Desireability: 2**, **Conceptual Completeness: 2**
+
+It could be nice to automatically update Runbook views when a runbook file is modified. This can help identify syntax errors and keep persisted views up to date. It could be helpful to see how your changes are displayed within a Runbook view. This is the main use case I can think of for guard, but perhaps there are others?
+
+#### Rake Task Interface
+
+**Difficulty: 1**, **Desireability: 3**, **Conceptual Completeness: 1**
+
+Provide a rake task interface to Runbook in addition to the ruby invocation interface and the CLI interface. This could be valuable for working with runbooks in a rake-heavy environment. There has not been specific interest in this feature, so it has not gotten prioritized.
+
+#### Multiple Commands in Groups
+
+**Difficulty: 3**, **Desireability: 2**, **Conceptual Completeness: 3**
+
+When specifying to execute a command against multiple servers in groups using the `parallelization` setter, commands are executed in groups for each command, so a single command runs to completion before the next command is executed in groups. It would be nice if there was a way to group a set of commands such that all commands for the first group were executed before commands for the second group were executed. The current workaround for this is to use Ruby to define multiple steps each of which completes against its full set of servers. 
+
+I do not have an idea of how to cleanly accomplish this.
+
+#### Yaml Specification
+
+**Difficulty: 2**, **Desireability: 2**, **Conceptual Completeness: 1**
+
+Right now the only way to define your Runbook is using Ruby. When the book is evaluated, it gets stored as an intermediate data structure, which happens to be a set of Ruby objects, but the runbook could instead be represented as yaml. The yaml could define your runbook object which is then converted into a Ruby object before executing. I see two main benefits to this. (1) Having a strict data representation of a runbook will help ensure that the representation stays simple and does not get convoluted with complex logic or difficult representations. (2) This could provide an easier method of specification for people uncomfortable writing Ruby.
+
+Actually writing a runbook in Yaml, would likely limit the ease of use and feature set for writing a runbook. Specifically, it would require a separate templating language for the yaml (instead of pure Ruby), and ruby_command blocks would need to be eval'ed, there would be no syntax highlighting or other Ruby compilation errors. It may make stack traces more difficult to read or debugging harder.
+
+Having a yaml representation of your runbook could aid in additional analysis such as more easily detecting compatibility errors, if all required plugins are present, if there is a semantic vs. syntactic change to the runbook.
+
+#### Runbook Web Server
+
+**Difficulty: 3**, **Desireability: 3**, **Conceptual Completeness: 3**
+
+It might be nice to be able to serve up a local copy of Runbook views so they could be referenced within a web browser. For some this may be more valuable than referencing them on the command line. 
+
+#### Interactive Runbook Launcher
+
+**Difficulty: 2**, **Desireability: 3**, **Conceptual Completeness: 3**
+
+It might be nice to provide a cool CLI for listing and navigating the set of runbooks for a project. It could display titles and descriptions and the runbooks could be interactively launched in separate panes. This may be helpful for someone first familiarizing themselves with the runbooks associated with a project. This may depend on a great deal of customization to suite people's workflows so it may not be that valuable. It could be similar to `rake -T` on steroids.

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/activesupport_5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.0"
+
+gemspec path: "../"

data/gemfiles/activesupport_6.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 6.0"
+
+gemspec path: "../"

data/lib/runbook/extensions/steps.rb

@@ -10,5 +10,6 @@ module Runbook::Extensions
     end
   end
 
+  Runbook::Entities::Book::DSL.prepend(Steps::DSL)
   Runbook::Entities::Section::DSL.prepend(Steps::DSL)
 end

data/lib/runbook/generators/project/project.rb

@@ -29,7 +29,11 @@ module Runbook::Generators
 
       inside(parent_options[:root]) do
         test = "--test #{options[:test]}"
-        run("bundle gem #{_name} #{test} --no-coc --no-mit")
+        continue = (
+          run("bundle gem #{_name} #{test} --no-coc --no-mit") ||
+          options[:pretend]
+        )
+        exit 1 unless continue
       end
     end
 

data/lib/runbook/helpers/tmux_helper.rb

@@ -1,5 +1,7 @@
 module Runbook::Helpers
   module TmuxHelper
+    FILE_PERMISSIONS = 0600
+
     def setup_layout(structure, runbook_title:)
       _remove_stale_layouts
       layout_file = _layout_file(_slug(runbook_title))
@@ -11,7 +13,7 @@ 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
@@ -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/run.rb

@@ -66,11 +66,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 +153,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

data/lib/runbook/runs/ssh_kit.rb

@@ -1,13 +1,14 @@
 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__statements__assert(object, metadata)
         cmd_ssh_config = find_ssh_config(object, :cmd_ssh_config)
 
@@ -19,18 +20,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 +40,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 +53,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/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)

data/lib/runbook/util/repo.rb

@@ -1,6 +1,7 @@
 module Runbook::Util
   module Repo
     FILE_ID = "data"
+    FILE_PERMISSIONS = 0600
 
     def self.load(metadata)
       title = metadata[:book_title]
@@ -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/stored_pose.rb

@@ -1,6 +1,7 @@
 module Runbook::Util
   module StoredPose
     FILE_ID = "current_position"
+    FILE_PERMISSIONS = 0600
 
     def self.load(metadata)
       title = metadata[:book_title]
@@ -11,7 +12,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
@@ -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 = "0.15.0"
 end

data/lib/runbook/views/markdown.rb

@@ -31,10 +31,10 @@ 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

data/runbook.gemspec

@@ -31,7 +31,7 @@ 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 "activesupport", ">= 5.0.1.x", "< 7.0"
   spec.add_runtime_dependency "method_source", "~> 0.9"
   spec.add_runtime_dependency "sshkit", "1.16"
   spec.add_runtime_dependency "sshkit-sudo", "~> 0.1"
@@ -40,6 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "tty-progressbar", "~> 0.14"
   spec.add_runtime_dependency "tty-prompt", "~> 0.16"
 
+  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"

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: runbook
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - pblesi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2019-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0.1
+        version: 5.0.1.x
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0.1
+        version: 5.0.1.x
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: method_source
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -227,6 +241,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -237,6 +252,9 @@ files:
 - bin/console
 - bin/setup
 - exe/runbook
+- gemfiles/.bundle/config
+- gemfiles/activesupport_5.gemfile
+- gemfiles/activesupport_6.gemfile
 - images/runbook_anatomy_diagram.png
 - images/runbook_example.gif
 - images/runbook_execution_modes.png
@@ -333,7 +351,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Write beautiful, executable runbooks for conducting system operations.