runbook 0.16.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 327e40dc7d06ef4ea604565750b4a6bd8aa7950453911d1d5331bb12f2dee453
-  data.tar.gz: ccd9929823ffbee857e883baaafc8aed5f1a95dd074b327dd2156fc669bd4aac
+  metadata.gz: 1c6c617aa11aeff1ab914c2f6d4d7b4db2cc5f46e6c70acc67a97eda7ba5b3a6
+  data.tar.gz: 3d68b0e53afbddc94ac0fa7c56eab9a8ac78ad104830c551f79c477314a81c4f
 SHA512:
-  metadata.gz: bce6f3b3bac537977fa9b94281bc3112d129259ae9b6caae1fe2b2eacb7653a192ab25e38aa0bf6b13cc8b3803d26c92d8cf620ba87376f91e5e3da75bb4e9a0
-  data.tar.gz: dfd5d2f7119852045414ab57b1ec16b64154e4b6dcca84526ed832dccfd10171df37ec433e41d47a0dd2af6884415ee2ce2c18fb141564ea7ddae93ee392e351
+  metadata.gz: cd186e2e3d0bde065b1ed0cccecce8c5943ec6ca626dac0cfa38725f4dd4050f5208df8343e770c602f2ec6cf7b38be9b01fee69ac0f304a16a14fe6c610378a
+  data.tar.gz: 4ce8c856c8cbd26cbffdfc1f7c2fe1b1fad5f6d5cdfc511d3be731d8db43db5ddeff1abf1d1ab2738374ac5eac27dbe33151e99f97abd604f3ddebb10394bf8c

data/CHANGELOG.md

@@ -4,6 +4,25 @@ This log maintains a list of all substantive changes to Runbook. The log include
 
 ## master
 
+## `v1.0.0` (2020-07-24)
+
+### Breaking Changes:
+
+* Commands and tmux commands that previously escaped single quotes will now require un-escaped single quotes
+
+### Features:
+
+* Add Node#parent_entity to find the containinng entity for a node
+
+### Fixes:
+
+* Fix bugs requiring escaping single quotes in commands and tmux_commands (BACKWARDS INCOMPATIBLE CHANGE)
+* Fix `File.exists?` deprecation warning (Thanks onk!)
+
+### Documentation:
+
+* Add suppress_capture_output.rb runbook example
+
 ## `v0.16.1` (2019-11-25)
 
 ### Fixes:

data/README.md

@@ -2,6 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/runbook.svg)](https://badge.fury.io/rb/runbook)
 [![Build Status](https://travis-ci.org/braintree/runbook.svg?branch=master)](https://travis-ci.org/braintree/runbook)
+[![Gitter](https://badges.gitter.im/braintree/runbook.svg)](https://gitter.im/braintree/runbook?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
 _See our [blog post](https://medium.com/braintree-product-technology/https-medium-com-braintree-product-technology-runbook-be6f072cfc0d) for the philosophy behind Runbook and an overview of its features._
 
@@ -1141,7 +1142,7 @@ Additionally, runbooks should contain their own assertions, sanity checks, monit
 
 ## Known Issues
 
-### Command Quoting
+### Command Quoting (Prior to v1.0)
 
 Because ssh_config declarations such as `user`, `group`, `path`, `env`, and `umask` are implemented as wrappers around your provided commands, you must be aware that issues can arise if your commands contain characters such as single quotes that are not properly escaped.
 

data/dockerfiles/Dockerfile-sshd

@@ -0,0 +1,4 @@
+FROM panubo/sshd:1.0.3
+
+RUN apk update && \
+    apk add sudo

data/examples/suppress_capture_output.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+require "runbook"
+
+class QuietToolbox < Runbook::Toolbox
+  def output(msg); end
+  def warn(msg); end
+  def error(msg); end
+end
+
+Runbook::Runs::SSHKit.register_hook(
+  :set_suppress_statement_output_hook,
+  :around,
+  Runbook::Statement
+) do |object, metadata, block|
+  parent_entity = object.parent_entity
+  toolbox = metadata[:toolbox]
+  formatter = Runbook.config.ssh_kit.output
+  if parent_entity.tags.include?(:suppress_statement_output) || parent_entity.labels[:suppress_statement_output]
+    Runbook.config.ssh_kit.output = Runbook.config.ssh_kit.use_format(:blackhole)
+    metadata[:toolbox] = QuietToolbox.new
+  end
+	block.call(object, metadata)
+  Runbook.config.ssh_kit.output = formatter
+  metadata[:toolbox] = toolbox
+end
+
+runbook = Runbook.book "Capture Output Suppression" do
+  description <<-DESC
+This is a runbook that suppresses capture output
+  DESC
+
+  section "Demo Output Capture" do
+    step "Capturing output", :suppress_statement_output do
+      capture "echo hi", into: :echo_output
+    end
+
+    step "Printing output" do
+      ruby_command { notice echo_output }
+    end
+  end
+end
+
+if __FILE__ == $0
+  Runbook::Runner.new(runbook).run
+else
+  runbook
+end

data/lib/runbook/entity.rb

@@ -7,7 +7,6 @@ module Runbook
       child_class.const_set(:DSL, Runbook::DSL.class)
     end
 
-    attr_accessor :parent
     attr_reader :title, :tags, :labels, :dsl
 
     def initialize(title, tags: [], labels: {}, parent: nil)

data/lib/runbook/helpers/tmux_helper.rb

@@ -5,7 +5,7 @@ module Runbook::Helpers
     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
@@ -20,7 +20,7 @@ module Runbook::Helpers
     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)

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

@@ -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

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

data/lib/runbook/util/stored_pose.rb

@@ -6,7 +6,7 @@ module Runbook::Util
     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

data/lib/runbook/version.rb

@@ -1,3 +1,3 @@
 module Runbook
-  VERSION = "0.16.1"
+  VERSION = "1.0.0"
 end

data/runbook.gemspec

@@ -33,18 +33,20 @@ Gem::Specification.new do |spec|
 
   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", "1.21.0"
   spec.add_runtime_dependency "sshkit-sudo", "~> 0.1"
   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 "bcrypt_pbkdf", ">= 1.0", "< 2.0"
+  spec.add_development_dependency "ed25519", ">= 1.2", "< 2.0"
   spec.add_development_dependency "pry", "~> 0.11"
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runbook
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 1.0.0
 platform: ruby
 authors:
 - pblesi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2020-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 1.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 1.21.0
 - !ruby/object:Gem::Dependency
   name: sshkit-sudo
   requirement: !ruby/object:Gem::Requirement
@@ -120,14 +120,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +170,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -204,14 +244,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -253,10 +293,12 @@ files:
 - bin/console
 - bin/setup
 - dockerfiles/Dockerfile-runbook
+- dockerfiles/Dockerfile-sshd
 - examples/hooks_runbook.rb
 - examples/layout_runbook.rb
 - examples/restart_nginx.rb
 - examples/simple_runbook.rb
+- examples/suppress_capture_output.rb
 - exe/runbook
 - gemfiles/.bundle/config
 - gemfiles/activesupport_5.gemfile