bow 0.0.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48aeceb9c881c29b019fd6940b0245c65b125bdd
-  data.tar.gz: e3688953ea94b0537e3eb644eec7912941b9e50a
+  metadata.gz: 6f786de3bf3a07e01c6e1163fb70958356e0c219
+  data.tar.gz: 1c04ee09cd9e2262f217ac3a21530a6b39ff6546
 SHA512:
-  metadata.gz: 3d55431cd057ff1f88eb995180e2956374f5b00edce9eab0cd80cb610caeb103d1551f4bcbd66f200f92e8b6cdfb246ace58ec916051388ba0fc975ca3219fbd
-  data.tar.gz: 7928f3029439c1a3a3b883cc284cc4a901c3b1d4428b12dfb6b367ef7ee953e3cc90a9dfbefe280f7f9582d6a935017a01488cdd24b3fafd03df0536b7b71059
+  metadata.gz: fae7064eb48e541ac88fd12512c99e13b49dc23a964c41f9391cd3b59046342a4ad3713b2951aa4befc33995713d3d360ee32d0ca39ac49b7615f6199be37890
+  data.tar.gz: 40251d5f6b674fee4d5429b67d3ade045867a80f0bb68b62d62ceab2e6b725163ca82517a51ca0d8d2c73902a31d53a6d635a64e9f64c84b0178b8107ef47a18

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*gem
+.rspec_status
+test

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Zinovyev Ivan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,156 @@
+# bow
+
+  Automate your infrastructure provisioning and configuration with Rake.
+
+[![Build Status](https://travis-ci.org/zinovyev/bow.svg?branch=master)](https://travis-ci.org/zinovyev/bow)
+
+## About
+
+Bow is a system that allows you to write Rake tasks and execute them remotely
+to provision and configure you servers.
+
+## Why?
+
+Well...
+
+I do know about dozens of [configuration management](https://en.wikipedia.org/wiki/Comparison_of_open-source_configuration_management_software) software. And I've also used to use some of them.
+And I actually like a couple of them too.
+
+But when it comes to a simple goal like configuring 2 or 3 VPS nodes I don't
+really want to create a complex infrastructure (I don't want to create any
+infrastructure to be honest) for it and I like to do it in Ruby (well, maybe
+in Bash and Ruby).
+
+And there's already exists a great tool that can execute tasks and is written
+in Ruby. And it's called Rake.
+
+So. Bow is simple, agentless and it doesn't bring it's own DSL to life, cause it
+uses Rake instead.
+
+## Usage
+
+1. If you're not familiar with Rake [Rake docs](https://ruby.github.io/rake/) and [Rake home](https://github.com/ruby/rake) can be a good place to start from;
+
+2. Install the `bow` gem with:
+
+```bash
+
+gem install bow
+
+``` 
+
+3. Create an empty folder and init a basic structure there:
+
+```bash
+
+mkdir ~/bow-test
+
+cd ~/bow-test
+
+bow init
+
+```
+
+4. The command `bow init` called above created a bare structure wich consits
+of a `Rakefile` and a list of targets (managed servers) in `targets.json` file.
+
+The example targets file contains 4 IPs combined in two managed groups:
+
+```json
+
+{
+  "example_group1": [
+    "192.168.50.27",
+    "192.168.50.37"
+  ],
+  "example_group2": [
+    "192.168.50.47",
+    "192.168.50.57"
+  ]
+}
+
+```
+
+A `Rakefile` contains two tasks for provisioning packed in namespaces wich are
+called by the name of the server groups from the `targets.json` file. The main
+task of the group MUST always be called **provision** and can be bound to any
+number of additional tasks. Sometimes (always) it is convinient to put
+additional tasks them to separate files into the [rakelib](https://ruby.github.io/rake/doc/rakefile_rdoc.html#label-Multiple+Rake+Files) folder.
+
+
+```ruby
+
+require 'bow/rake'
+
+Rake.application.options.trace_rules = true
+
+PROVISION_DIR = '/tmp/rake_provision'.freeze
+
+namespace :web do
+  task provision: :print_hello do
+  end
+
+  flow run: :once
+  task :print_hello do
+    sh 'echo "Hello from example group #1 server!"'
+  end
+end
+
+namespace :example_group2 do
+  task provision: :print_hello do
+  end
+
+  flow enabled: false, revert_task: :print_goodbye
+  task :print_hello do
+    sh 'echo "Hello from example group #2 server!"'
+  end
+
+  task :print_goodbye do
+    sh 'echo "Goodbye! The task at example group #2 is disabled!"'
+  end
+end
+
+```
+
+5. Now run `bow apply` and your provisioning tasks will be executed on servers
+listed in `targets.json` file;
+
+6. To find more about available commands (`ping`, `exec` etc.) type `bow -h`;
+
+## Task flow
+
+While that is not necessary, it can be convinient to install a `bow` gem on the
+client server too. So you will be able to use a little Rake DSL enhancement
+wich bring a better controll of the flow of your tasks.
+
+The only thing you will be needed to do afterwards to enable the feature is to
+require it by putting `require bow/rake` to the top of your `Rakefile`.
+
+Now you'll be able to put this `flow` line before the task definition:
+
+```ruby
+
+flow run: :once, enabled: :true, revert: :revert_simple_task
+task :simple_task do
+  # some code here ...
+end
+
+task :revert_simple_task do
+  # remove evertything that simple task have done >/ 
+end
+
+```
+
+The 3 options are:
+
+* `run` wich can be either `:once` or `:always`. If set to `once` the task will
+be run only once on remote server;
+
+* `enabled` wich takes a boolean value. If set to false, the task will be
+disabled and won't run at all;
+
+* `revert` wich defines a task that can revert changes done by the original
+task when the original task is disabled (by `enabled: false` option). Actually
+it's something similar to the down migration when dealing with databases;
+
+

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'rake/testtask'
+
+task :test do
+  exec('bundle exec rspec && bundle exec rubocop')
+end
+
+desc 'Run tests'
+task default: :test

data/bin/bow

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bow'
+
+Bow::Application.new(ARGV).run

data/bow.gemspec

@@ -1,18 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'lib/bow/version.rb'
+
 Gem::Specification.new do |s|
   s.name        = 'bow'
-  s.version     = '0.0.0'
-  s.date        = '2017-09-09'
-  s.summary     = 'Simple provisioning with rake tasks'
-  s.description = 'Simple provisioning with rake tasks'
+  s.version     = Bow::VERSION
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.summary     = 'Simple provisioning via rake tasks'
+  s.description = 'Simple provisioning via rake tasks'
   s.authors     = ['Zinovyev Ivan']
   s.email       = 'zinovyev.id@gmail.com'
   s.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end - %w[.rubocop.yml .travis.yml appveyor.yml]
+  s.executables << 'bow'
   s.homepage    = 'https://github.com/zinovyev/bow'
   s.license     = 'MIT'
   s.add_runtime_dependency 'rake'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'mocha'
   s.add_development_dependency 'rubocop'
 end

data/lib/bow.rb

@@ -1,2 +1,27 @@
+# frozen_string_literal: true
+
+require 'bow/config'
+require 'bow/memorable'
+require 'bow/rake'
+require 'bow/locker'
+require 'bow/version'
+require 'bow/options'
+require 'bow/targets'
+require 'bow/ssh/scp'
+require 'bow/ssh/rsync'
+require 'bow/ssh_helper'
+require 'bow/application'
+require 'bow/thread_pool'
+require 'bow/inventory'
+require 'bow/inventory_example'
+require 'bow/response_formatter'
+require 'bow/command'
+require 'bow/commands/ping'
+require 'bow/commands/exec'
+require 'bow/commands/init'
+require 'bow/commands/apply'
+require 'bow/commands/prepare'
+
 module Bow
+  BASE_DIR = File.dirname(File.dirname(__FILE__)).freeze
 end

data/lib/bow/application.rb

@@ -0,0 +1,96 @@
+require 'optparse'
+
+module Bow
+  class Application
+    BANNER = 'Usage: bow command arguments [options]'.freeze
+    COLUMN_WIDTH = 32
+    EMPTY_COLUMN = (' ' * COLUMN_WIDTH).freeze
+
+    attr_accessor :argv, :options, :debug
+
+    def initialize(argv)
+      @options = {
+        user: 'root',
+        group: 'all',
+        inventory: 'hosts.json'
+      }
+      @argv = argv.dup
+      @ssh_helpers = {}
+      @debug = false
+    end
+
+    # rubocop:disable Lint/ShadowingOuterLocalVariable
+    def run
+      opts = OptionParser.new do |opts|
+        opts.banner = build_banner
+        options_parser.parse(opts)
+      end
+      opts.parse!(argv)
+      command = parse_arguments(opts)
+      command.run
+    end
+    # rubocop:enable Lint/ShadowingOuterLocalVariable
+
+    def inventory
+      return @inventory if @inventory
+      @inventory ||= Inventory.new
+      @inventory.ensure!
+    end
+
+    def config
+      Config
+    end
+
+    def ssh_helper(host)
+      conn = host.conn
+      @ssh_helpers[conn] ||= SshHelper.new(conn, self)
+    end
+
+    def targets(user)
+      @targets ||= Targets.new(inventory.targetfile, user)
+    end
+
+    def debug?
+      !!@debug
+    end
+
+    private
+
+    def build_banner
+      banner = BANNER.dup.to_s
+      banner << "\n\nCOMMANDS\n\n"
+      Command.all.each do |command|
+        banner << format_command(command)
+      end
+      banner << "OPTIONS\n\n"
+      banner
+    end
+
+    def parse_arguments(opts)
+      if argv.empty?
+        argv << '-h'
+        opts.parse!(argv)
+      end
+      build_command(argv.shift, argv)
+    end
+
+    def build_command(name, argv = {})
+      raise "Unknown command #{name}!" unless command_exists? name
+      Command.find(name).new(self, argv)
+    end
+
+    def command_exists?(name)
+      Command.names.include? name.to_s
+    end
+
+    def format_command(command)
+      tail = ' ' * (32 - command.command_name.length)
+      str = "     #{command.command_name}#{tail}#{command.description}\n"
+      str << "     #{EMPTY_COLUMN}Usage: #{command.usage}\n\n"
+    end
+
+    def options_parser
+      @options_parser ||= Options.new(@options)
+    end
+  end
+end

data/lib/bow/command.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'pry'
+
+module Bow
+  class Command
+    class << self
+      attr_reader :all, :names
+
+      def inherited(command_class)
+        @all ||= []
+        @names ||= []
+        @all << command_class
+        @names << command_class.command_name
+      end
+
+      def command_name
+        @command_name ||= name.to_s
+                              .split('::')
+                              .last
+                              .split(/([A-Z]{1}[^A-Z]*)/)
+                              .reject(&:empty?)
+                              .join('_')
+                              .downcase
+      end
+
+      def find(name)
+        index = @names.index name.to_s
+        @all[index] if index
+      end
+
+      %w[usage description].each { |m| define_method(m) { new.send m } }
+    end
+
+    attr_reader :app
+
+    def initialize(app = nil, argv = [])
+      @app = app
+      @argv = argv
+    end
+
+    def description
+      @description ||= "Command #{command_name} description"
+    end
+
+    def usage
+      @usage ||= "bow #{command_name} [args] [options]"
+    end
+
+    def command_name
+      self.class.command_name
+    end
+
+    def targets
+      user = app.options[:user]
+      group = app.options[:group]
+      app.targets(user).hosts(group)
+    end
+  end
+end