runbook 0.12.1 → 0.13.0

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

@@ -0,0 +1,278 @@
+module Runbook::Generators
+  class Project < Thor::Group
+    include ::Runbook::Generators::Base
+
+    source_root File.dirname(__FILE__)
+
+    def self.description
+      "Generate a project for your runbooks"
+    end
+
+    def self.long_description
+      <<-LONG_DESC
+      This generator generates a project for your runbooks. It creates a
+      project skeleton to hold your runbooks, runbook extensions, shared
+      code, configuration, tests, and dependencies.
+      LONG_DESC
+    end
+
+    argument :name, desc: "The name of your project, e.x. acme_runbooks"
+
+    class_option :"shared-lib-dir", type: :string,
+      desc: "Target directory for shared runbook code"
+    class_option :test, type: :string, enum: ["rspec", "minitest"],
+      default: "rspec", desc: %Q{Test-suite, "rspec" or "minitest"}
+
+    def init_gem
+      bundle_exists = "which bundle 2>&1 1>/dev/null"
+      raise "Please ensure bundle is installed" unless system(bundle_exists)
+
+      inside(parent_options[:root]) do
+        test = "--test #{options[:test]}"
+        run("bundle gem #{_name} #{test} --no-coc --no-mit")
+      end
+    end
+
+    def remove_unneeded_files
+      dirs = [
+        parent_options[:root],
+        _name,
+      ]
+
+      gemspec_file = File.join(*dirs, "#{_name}.gemspec")
+      if File.exist?(gemspec_file)
+        @gemspec_file_contents = File.readlines(gemspec_file)
+      end
+      remove_file(gemspec_file)
+
+      readme = File.join(*dirs, "README.md")
+      remove_file(readme)
+
+      gemfile = File.join(*dirs, "Gemfile")
+      remove_file(gemfile)
+
+      base_file = File.join(*dirs, "lib", "#{_name}.rb")
+      remove_file(base_file)
+
+      version_file_path = [
+        "lib",
+        _name,
+        "version.rb",
+      ]
+      version_file = File.join(*dirs, *version_file_path)
+      remove_file(version_file)
+    end
+
+    def shared_lib_dir
+      msg = [
+        "Where should shared runbook code live?",
+        "Use `lib/#{_name}` for runbook-only projects",
+        "Use `lib/#{_name}/runbook` for projects used for non-runbook tasks",
+        "Shared runbook code path:",
+      ]
+
+      if options.has_key?("shared-lib-dir")
+        @shared_lib_dir = options["shared-lib-dir"]
+      else
+        @shared_lib_dir = ask(msg.join("\n"))
+      end
+    end
+
+    def create_readme
+      target = File.join(
+        parent_options[:root],
+        _name,
+        "README.md",
+      )
+
+      template("templates/README.md.tt", target)
+    end
+
+    def create_gemfile
+      target = File.join(
+        parent_options[:root],
+        _name,
+        "Gemfile",
+      )
+
+      template("templates/Gemfile.tt", target)
+
+      # Add development dependencies from gemspec
+      return unless @gemspec_file_contents
+      gems = @gemspec_file_contents.select do |line|
+        line =~ /  spec.add_development_dependency/
+      end.map do |line|
+        line.gsub(/  spec.add_development_dependency/, "gem")
+      end.join
+
+      append_to_file(target, "\n#{gems}", verbose: false)
+    end
+
+    def create_base_file
+      target = File.join(
+        parent_options[:root],
+        _name,
+        "lib",
+        "#{_name}.rb",
+      )
+
+      template("templates/base_file.rb.tt", target)
+    end
+
+    def modify_rakefile
+      target = File.join(
+        parent_options[:root],
+        _name,
+        "Rakefile",
+      )
+
+      gsub_file(target, /^require "bundler\/gem_tasks"\n/, "", verbose: false)
+    end
+
+    def create_ruby_version
+      target = File.join(
+        parent_options[:root],
+        _name,
+        ".ruby-version",
+      )
+
+      create_file(target, "ruby-#{RUBY_VERSION}\n")
+    end
+
+    def create_ruby_gemset
+      target = File.join(
+        parent_options[:root],
+        _name,
+        ".ruby-gemset",
+      )
+
+      create_file(target, "#{_name}\n")
+    end
+
+    def create_runbookfile
+      target = File.join(
+        parent_options[:root],
+        _name,
+        "Runbookfile",
+      )
+
+      template("templates/Runbookfile.tt", target)
+    end
+
+    def create_runbooks_directory
+      dirs = [
+        parent_options[:root],
+        _name,
+        "runbooks",
+      ]
+      target = File.join(*dirs)
+
+      empty_directory(target)
+      _keep_dir(target)
+    end
+
+    def create_extensions_directory
+      dirs = [
+        parent_options[:root],
+        _name,
+        "lib",
+        "runbook",
+        "extensions",
+      ]
+      target = File.join(*dirs)
+
+      empty_directory(target)
+      _keep_dir(target)
+    end
+
+    def create_generators_directory
+      dirs = [
+        parent_options[:root],
+        _name,
+        "lib",
+        "runbook",
+        "generators",
+      ]
+      target = File.join(*dirs)
+
+      empty_directory(target)
+      _keep_dir(target)
+    end
+
+    def create_lib_directory
+      dirs = [
+        parent_options[:root],
+        _name,
+        @shared_lib_dir,
+      ]
+      target = File.join(*dirs)
+
+      empty_directory(target)
+      _keep_dir(target)
+    end
+
+    def update_bin_console
+      path = [
+        parent_options[:root],
+        _name,
+        "bin",
+        "console",
+      ]
+      target = File.join(*path)
+
+      old_require = /require "#{_name}"/
+      new_require = %Q(require_relative "../lib/#{_name}")
+      new_require += "\n\nRunbook::Configuration.load_config"
+      gsub_file(target, old_require, new_require, verbose: false)
+
+      old_require = /require "#{_name}"/
+      new_require = %Q(require_relative "../lib/#{_name}")
+      gsub_file(target, old_require, new_require, verbose: false)
+    end
+
+    def remove_bad_test
+      path = [
+        parent_options[:root],
+        _name,
+      ]
+
+      case options["test"]
+      when "rspec"
+        path << "spec"
+        path << "#{_name}_spec.rb"
+      when "minitest"
+        path << "test"
+        path << "#{_name}_test.rb"
+      end
+      target = File.join(*path)
+
+      bad_test = /  .*version.*\n.*\n  end\n\n/m
+      gsub_file(target, bad_test, "", verbose: false)
+    end
+
+    def runbook_project_overview
+      msg = [
+        "",
+        "Your runbook project was successfully created.",
+        "Remember to run `./bin/setup` in your project to install dependencies.",
+        "Add runbooks to the `runbooks` directory.",
+        "Add shared code to `#{@shared_lib_dir}`.",
+        "Execute runbooks using `bundle exec runbook exec <RUNBOOK_PATH>` from your project root.",
+        "See the README.md for more details.",
+        "\n",
+      ]
+
+      say(msg.join("\n"))
+    end
+
+    private
+
+    def _name
+      @name ||= name.underscore
+    end
+
+    def _keep_dir(dir)
+      create_file(File.join(dir, ".keep"), verbose: false)
+    end
+  end
+end

data/lib/runbook/generators/project/templates/Gemfile.tt

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby "<%= RUBY_VERSION %>"
+
+gem "runbook", "~> <%= Runbook::VERSION %>"

data/lib/runbook/generators/project/templates/README.md.tt

@@ -0,0 +1,29 @@
+# <%= name.titleize %>
+
+## Deployment
+
+This code is best deployed by cloning this project using git.
+
+## Usage
+
+Set up this repository by running `bin/setup`. This will install all necessary dependencies for your runbooks.
+
+Execute your runbooks using `bundle exec runbook exec <PATH_TO_YOUR_RUNBOOK>`
+
+Get runbook help executing `bundle exec runbook help` or visiting https://github.com/braintree/runbook
+
+## This Repository
+
+Runbook code should live in the following locations:
+
+`runbooks` - Place your runbooks in this directory
+
+`<%= @shared_lib_dir %>` - Place code shared across your runbooks in this directory
+
+`lib/runbook/extensions` - Place code that extends Runbook's functionality here. For example, adding a new statement to Runbook's DSL would live in this directory. Require these files in your `Runbookfile` so Runbook can load them when it is launched. See https://github.com/braintree/runbook#extending-runbook for more details on extending Runbook.
+
+`lib/runbook/generators` - Place Runbook generators in this directory. Require these files in your `Runbookfile` to expose the generators via Runbook's command line interface.
+
+## Development
+
+Run `bin/setup` to install any necessary dependencies for this project. Run `bin/console` to use your code via an interactive prompt.

data/lib/runbook/generators/project/templates/Runbookfile.tt

@@ -0,0 +1,11 @@
+# Your Runbookfile serves two purposes. Use your Runbookfile to
+# (1) require any runbook plugins, extensions, or generators that
+# you want available to your runbooks and (2) configure Runbook
+# using a `Runbook.configure` block.
+
+# Use this block to configure Runbook. See
+# https://github.com/braintree/runbook#configuration for more
+# details.
+#
+# Runbook.configure do |config|
+# end

data/lib/runbook/generators/project/templates/base_file.rb.tt

@@ -0,0 +1,8 @@
+# Require your runbook shared code here so it can easily be
+# included in your runbooks and accessed from the interactive
+# console using `bin/console`.
+
+require "runbook"
+
+module <%= name.camelize %>
+end

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

@@ -0,0 +1,22 @@
+module Runbook::Generators
+  class Runbook < Thor::Group
+    include ::Runbook::Generators::Base
+
+    source_root File.dirname(__FILE__)
+
+    def self.usage
+      "runbook NAME [options]"
+    end
+
+    def self.description
+      "Generate a runbook named NAME, e.x. deploy_nginx"
+    end
+
+    argument :name, desc: "The name of your runbook, e.x. deploy_nginx"
+
+    def create_runbook
+      target = File.join(options[:root], "#{name.underscore}.rb")
+      template('templates/runbook.tt', target)
+    end
+  end
+end

data/lib/runbook/generators/runbook/templates/runbook.tt

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require "runbook"
+
+runbook = Runbook.book "<%= name.titleize %>" do
+  description <<-DESC
+This is a runbook that...
+  DESC
+
+  section "SECTION" do
+    step "STEP" do
+      # Add statements here
+    end
+  end
+end
+
+if __FILE__ == $0
+  Runbook::Runner.new(runbook).run
+else
+  runbook
+end

data/lib/runbook/generators/statement/statement.rb

@@ -0,0 +1,18 @@
+module Runbook::Generators
+  class Statement < Thor::Group
+    include ::Runbook::Generators::Base
+
+    source_root File.dirname(__FILE__)
+
+    def self.description
+      "Generate a statement named NAME (e.x. ruby_command) that can be used in your runbooks"
+    end
+
+    argument :name, desc: "The name of your statement, e.x. ruby_command"
+
+    def create_statement
+      target = File.join(parent_options[:root], "#{name.underscore}.rb")
+      template('templates/statement.tt', target)
+    end
+  end
+end

data/lib/runbook/generators/statement/templates/statement.tt

@@ -0,0 +1,34 @@
+# Remember to require this file in a runbook config file
+# or in your project so it is available in your runbooks
+module Runbook::Statements
+  class <%= name.classify %> < Runbook::Statement
+    # Add all attributes for your statement
+    attr_reader :attr1, :attr2
+
+    # Define the initialize method signature to
+    # match the method signature of your dsl statement
+    def initialize(attr1, attr2)
+      @attr1 = attr1
+      @attr2 = attr2
+    end
+  end
+end
+
+# scope this module using your project's namespace
+module MyProject::RunbookExtensions
+  module <%= "#{name.underscore}_markdown".classify %>
+    def runbook__statements__<%= name.underscore %>(object, output, metadata)
+      # Format how your statement will be displayed when rendered with markdown
+      output << "#{object.attr1}#{object.attr2}"
+    end
+  end
+  Runbook::Views::Markdown.singleton_class.prepend(<%= "#{name.underscore}_markdown".classify %>)
+
+  module <%= "#{name.underscore}_sshkit".classify %>
+    def runbook__statements__<%= name.underscore %>(object, metadata)
+      # Execute your behavior using object which is your instantiated statement
+      # and the current metadata for this step of the execution
+    end
+  end
+  Runbook::Runs::SSHKit.singleton_class.prepend(<%= "#{name.underscore}_sshkit".classify %>)
+end

data/lib/runbook/installer.rb

@@ -0,0 +1,85 @@
+module Runbook
+  class Installer < Thor::Group
+    include Thor::Actions
+
+    source_root File.join(
+      File.dirname(__FILE__),
+      "generators",
+      "project",
+    )
+
+    add_runtime_options!
+    check_unknown_options!
+
+    def create_runbookfile
+      template(
+        "templates/Runbookfile.tt",
+        "Runbookfile",
+      )
+    end
+
+    def create_runbooks_directory
+      target = "runbooks"
+      empty_directory(target)
+      _keep_dir(target)
+    end
+
+    def create_lib_directory
+      dirs = [
+        "lib",
+        "runbook",
+      ]
+      target = File.join(*dirs)
+
+      empty_directory(target)
+      _keep_dir(target)
+    end
+
+    def create_extensions_directory
+      dirs = [
+        "lib",
+        "runbook",
+        "extensions",
+      ]
+      target = File.join(*dirs)
+
+      empty_directory(target)
+      _keep_dir(target)
+    end
+
+    def create_generators_directory
+      dirs = [
+        "lib",
+        "runbook",
+        "generators",
+      ]
+      target = File.join(*dirs)
+
+      empty_directory(target)
+      _keep_dir(target)
+    end
+
+    def runbook_installation_overview
+      msg = [
+        "",
+        "Runbook was successfully installed",
+        "Add runbooks to the `runbooks` directory.",
+        "Add shared code to `lib/runbook`.",
+        "Execute runbooks using `bundle exec runbook exec <RUNBOOK_PATH>`",
+        "from your project root.",
+        "\n",
+      ]
+
+      say(msg.join("\n"))
+    end
+
+    private
+
+    def _keep_dir(dir)
+      create_file(
+        File.join(dir, ".keep"),
+        verbose: false,
+      )
+    end
+  end
+end

data/lib/runbook/util/runbook.rb

@@ -11,6 +11,10 @@ module Runbook
     _child_modules(Runbook::Runs)
   end
 
+  def self.generators
+    _child_classes(Runbook::Generators)
+  end
+
   def self._child_classes(mod)
     mod.constants.map { |const|
       "#{mod.to_s}::#{const}".constantize

data/lib/runbook/version.rb

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

data/lib/runbook.rb

@@ -10,6 +10,7 @@ require "sshkit/sudo"
 require "airbrussh"
 require "tty-progressbar"
 require "tty-prompt"
+require "thor/group"
 
 require "runbook/configuration"
 
@@ -62,6 +63,13 @@ require "runbook/viewer"
 require "runbook/view"
 require "runbook/views/markdown"
 
+require "runbook/generators/base"
+require "runbook/generators/dsl_extension/dsl_extension"
+require "runbook/generators/generator/generator"
+require "runbook/generators/project/project"
+require "runbook/generators/runbook/runbook"
+require "runbook/generators/statement/statement"
+
 require "runbook/extensions/add"
 require "runbook/extensions/description"
 require "runbook/extensions/shared_variables"

data/runbook.gemspec

@@ -9,10 +9,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["pblesi"]
   spec.email         = ["code@getbraintree.com"]
 
-  spec.summary       = %q{Write beautiful, executable runbooks for conducting production operations.}
-  spec.description   = %q{Runbook provides a DSL for specifying production operations. This DSL is used to generate formatted runbooks as well as interactive runbooks to be executed on the command line.}
+  spec.summary       = %q{Write beautiful, executable runbooks for conducting system operations.}
+  spec.description   = %q{Runbook provides a DSL for specifying system operations. This DSL is used to generate formatted runbooks as well as interactive runbooks to be executed on the command line.}
   spec.homepage      = "https://github.com/braintree/runbook/"
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.2.3'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runbook
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - pblesi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -212,8 +212,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Runbook provides a DSL for specifying production operations. This DSL
-  is used to generate formatted runbooks as well as interactive runbooks to be executed
+description: Runbook provides a DSL for specifying system operations. This DSL is
+  used to generate formatted runbooks as well as interactive runbooks to be executed
   on the command line.
 email:
 - code@getbraintree.com
@@ -243,6 +243,7 @@ files:
 - lib/hacks/ssh_kit.rb
 - lib/runbook.rb
 - lib/runbook/cli.rb
+- lib/runbook/cli_base.rb
 - lib/runbook/configuration.rb
 - lib/runbook/dsl.rb
 - lib/runbook/entities/book.rb
@@ -258,10 +259,26 @@ files:
 - lib/runbook/extensions/statements.rb
 - lib/runbook/extensions/steps.rb
 - lib/runbook/extensions/tmux.rb
+- lib/runbook/generator.rb
+- lib/runbook/generators/base.rb
+- lib/runbook/generators/dsl_extension/dsl_extension.rb
+- lib/runbook/generators/dsl_extension/templates/dsl_extension.tt
+- lib/runbook/generators/generator/generator.rb
+- lib/runbook/generators/generator/templates/generator.tt
+- lib/runbook/generators/project/project.rb
+- lib/runbook/generators/project/templates/Gemfile.tt
+- lib/runbook/generators/project/templates/README.md.tt
+- lib/runbook/generators/project/templates/Runbookfile.tt
+- lib/runbook/generators/project/templates/base_file.rb.tt
+- lib/runbook/generators/runbook/runbook.rb
+- lib/runbook/generators/runbook/templates/runbook.tt
+- lib/runbook/generators/statement/statement.rb
+- lib/runbook/generators/statement/templates/statement.tt
 - lib/runbook/helpers/format_helper.rb
 - lib/runbook/helpers/ssh_kit_helper.rb
 - lib/runbook/helpers/tmux_helper.rb
 - lib/runbook/hooks.rb
+- lib/runbook/installer.rb
 - lib/runbook/node.rb
 - lib/runbook/run.rb
 - lib/runbook/runner.rb
@@ -309,16 +326,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
-summary: Write beautiful, executable runbooks for conducting production operations.
+summary: Write beautiful, executable runbooks for conducting system operations.
 test_files: []