bow 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f786de3bf3a07e01c6e1163fb70958356e0c219
-  data.tar.gz: 1c04ee09cd9e2262f217ac3a21530a6b39ff6546
+  metadata.gz: a81e49b3e892737818ee914200b4ebbf04283c4d
+  data.tar.gz: b4f833f16d08c74f0c336af66ed8f3184c2182e8
 SHA512:
-  metadata.gz: fae7064eb48e541ac88fd12512c99e13b49dc23a964c41f9391cd3b59046342a4ad3713b2951aa4befc33995713d3d360ee32d0ca39ac49b7615f6199be37890
-  data.tar.gz: 40251d5f6b674fee4d5429b67d3ade045867a80f0bb68b62d62ceab2e6b725163ca82517a51ca0d8d2c73902a31d53a6d635a64e9f64c84b0178b8107ef47a18
+  metadata.gz: 03dfe12d59d54390c2d6267d82a0deb9d18c7cb589400a9365f0425c33fb59b0404320016e0dbd8570835771899525a7532a724b158e51f489da7ab3591b3ada
+  data.tar.gz: d4a5c7e31dbbae4bf6d504e869f26ba0ccd688b610bff0564d09245c7cd898d41ce073d30a1d84e35994edb01c5cbdadc4d8b4ea2d1e10bb1a97577ac68175c4

data/README.md

@@ -4,57 +4,54 @@
 
 [![Build Status](https://travis-ci.org/zinovyev/bow.svg?branch=master)](https://travis-ci.org/zinovyev/bow)
 
-## About
+[![Gem Version](https://badge.fury.io/rb/bow.svg)](https://badge.fury.io/rb/bow)
 
-Bow is a system that allows you to write Rake tasks and execute them remotely
-to provision and configure you servers.
 
-## Why?
+## About
 
-Well...
+Bow doesn't bring its own DSL to live, rather it uses regular Rake tasks
+instead.
 
-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.
+It can be handy for you if:
 
-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).
+ * you need to configure a pure system of 2-5 VPSs;
 
-And there's already exists a great tool that can execute tasks and is written
-in Ruby. And it's called Rake.
+ * you don't want to build a complex infrastructure;
 
-So. Bow is simple, agentless and it doesn't bring it's own DSL to life, cause it
-uses Rake instead.
+ * you are already familiar with Rake and don't want to to learn Python;
 
-## 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;
+## Installation
 
-2. Install the `bow` gem with:
+Download and install bow with the following.
 
 ```bash
 
-gem install bow
+  gem install bow
 
-``` 
+```
 
-3. Create an empty folder and init a basic structure there:
 
-```bash
+## Usage
 
-mkdir ~/bow-test
+First of all. If you're not familiar with Rake and Rake tasks, take a look at
+this pages: [Rake docs](https://ruby.github.io/rake/) and [Rake home](https://github.com/ruby/rake). It can be a good place to start from.
 
-cd ~/bow-test
 
-bow init
+### Project structure
 
-```
+The basic bow project consists of two files: `Rakefile` and `targets.json`.
+
+Run `bow init` which will generate an example project structure to give you a
+basic understanding of how to write your own configuration.
+
+Sometimes it can be convinient to put tasks to separate files into the
+[rakelib](https://ruby.github.io/rake/doc/rakefile_rdoc.html#label-Multiple+Rake+Files)
+folder. So Rake will automatically autoload them.
 
-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:
+**targets.json** contains a list of hosts grouped in categories:
+
 
 ```json
 
@@ -71,11 +68,13 @@ The example targets file contains 4 IPs combined in two managed groups:
 
 ```
 
-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.
+
+**Rakefile** is actually an ordinary Rakefile) which contains several tasks
+for provisioning packed in namespaces which 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.
 
 
 ```ruby
@@ -100,7 +99,8 @@ namespace :example_group2 do
   task provision: :print_hello do
   end
 
-  flow enabled: false, revert_task: :print_goodbye
+  # Change enabled value to "false" to run the reverting task (:print_goodbye)
+  flow enabled: true, revert_task: :print_goodbye
   task :print_hello do
     sh 'echo "Hello from example group #2 server!"'
   end
@@ -112,45 +112,64 @@ 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`;
+###Commands
 
-## 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.
+To **check the availability** of all configured hosts run:
 
-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:
+```bash
 
-```ruby
+  bow ping
 
-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
+To **prepare soft on client** needed for bow to run
+(Ruby and 2 gems: rake and bow) execute
+
+```bash
+
+  bow prepare
 
 ```
 
-The 3 options are:
+To **apply configured provision** run:
+
+```bash
+
+  bow apply
+
+```
+
+To explore more options and commands run:
+
+```bash
+
+  bow -h
+
+```
+
+
+### Flow
+
+Command **flow** from the upper example is a little extension added by the bow
+gem which allows you to controll the flow of the task. It consists of 3 options:
+
+* `run: :once` or `run: :always` sets the condition on how many times to run
+the task;
 
-* `run` wich can be either `:once` or `:always`. If set to `once` the task will
-be run only once on remote server;
+* `enabled: true` or `enabled: false` wich takes a boolean value allows you to
+disable the task so it can be ommited or reverted (if a reverting task
+is given);
 
-* `enabled` wich takes a boolean value. If set to false, the task will be
-disabled and won't run at all;
+* `revert: task_name` 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 ActiveRecord;
 
-* `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;
 
+### Run the example
 
+To run the example locally this [Vagrantfile](doc/Vagrantfile) can be used to create a
+testing environment.

data/bow.gemspec

@@ -6,8 +6,9 @@ Gem::Specification.new do |s|
   s.name        = 'bow'
   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.summary     = "Automate your infrastructure provisioning \\
+and configuration with Rake."
+  s.description = s.summary
   s.authors     = ['Zinovyev Ivan']
   s.email       = 'zinovyev.id@gmail.com'
   s.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -16,9 +17,8 @@ Gem::Specification.new do |s|
   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'
+  s.add_runtime_dependency 'rake', '~> 12.1'
+  s.add_development_dependency 'pry', '~> 0.10.3'
+  s.add_development_dependency 'rspec', '~> 3.6'
+  s.add_development_dependency 'rubocop', '~> 0.50.0'
 end

data/lib/bow/command.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'pry'
-
 module Bow
   class Command
     class << self

data/lib/bow/commands/apply.rb

@@ -10,11 +10,11 @@ module Bow
       def run
         ThreadPool.new do |t|
           t.from_enumerable targets do |host|
-            result = app.ssh_helper(host).prepare_provision(PROVISION_PATH)
-            ResponseFormatter.pretty_print(host, result)
+            results = app.ssh_helper(host).prepare_provision
+            ResponseFormatter.multi_print(host, results)
 
-            cmd = "'cd #{PROVISION_PATH} && rake #{host.group}:provision'"
-            result = app.ssh_helper(host).execute(cmd)
+            cmd = "rake #{host.group}:provision"
+            result = app.ssh_helper(host).execute(cmd, true)
             ResponseFormatter.pretty_print(host, result)
           end
         end

data/lib/bow/commands/exec.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'pry'
-require 'pp'
-
 module Bow
   module Commands
     class Exec < Command

data/lib/bow/commands/prepare.rb

@@ -10,10 +10,11 @@ module Bow
       def run
         ThreadPool.new do |t|
           t.from_enumerable targets do |host|
-            result = app.ssh_helper(host).prepare_provision(PROVISION_PATH)
-            ResponseFormatter.pretty_print(host, result)
+            results = app.ssh_helper(host).prepare_provision
+            ResponseFormatter.multi_print(host, results)
 
-            provision_cmd = "bash #{PROVISION_PATH}/preprovision.sh"
+            provision_cmd = "BOW_VERSION=\"#{Bow::VERSION}\" \
+bash #{@app.config.guest_from_host[:pre_script]}"
             result = app.ssh_helper(host).execute(provision_cmd)
             ResponseFormatter.pretty_print(host, result)
           end

data/lib/bow/config.rb

@@ -12,7 +12,7 @@ module Bow
       end
 
       def guest_from_host
-        @guest_from_host ||= Config.new(:guest, '~')
+        @guest_from_host ||= Config.new(:guest, GUEST_FROM_HOST_BASE_DIR)
       end
     end
 

data/lib/bow/inventory_example.rb

@@ -25,6 +25,7 @@ module Bow
         task provision: :print_hello do
         end
 
+        # The task :print_hello from the :example_group1 will run only once
         flow run: :once
         task :print_hello do
           sh 'echo "Hello from example group #1 server!"'
@@ -35,13 +36,16 @@ module Bow
         task provision: :print_hello do
         end
 
-        flow enabled: false, revert_task: :print_goodbye
+        # The task :pring_hello from the example_group2 will run everytime
+        # until it is disabled.
+        # Change enabled value to "false" to run the reverting task (:print_goodbye)
+        flow enabled: true, revert: :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!"'
+          sh 'echo "Goodbye! The task at example group #2 is reverted!"'
         end
       end
     RAKEFILE

data/lib/bow/locker.rb

@@ -30,6 +30,7 @@ module Bow
       @runtime_cache = {}
     end
 
+    # rubocop:disable Style/SafeNavigation
     def applied?(task)
       record = parse(find(task))
       !!(record && record[1])
@@ -39,6 +40,7 @@ module Bow
       record = parse(find(task))
       !!(record && record[2])
     end
+    # rubocop:enable Style/SafeNavigation
 
     def apply(task)
       return if applied?(task)
@@ -101,10 +103,8 @@ module Bow
       file.each_char.with_index do |c, idx|
         if c == LINE_SEP
           current_line =~ /^([^\s]+)#{SEPARATOR}/
-          to_cache(task, record: $1, first_c: first_c, last_c: last_c)
-          if task == $1
-            return { record: current_line, first_c: first_c, last_c: last_c }
-          end
+          to_cache($1, record: current_line, first_c: first_c, last_c: last_c)
+          from_cache(task) if task == $1
           current_line = ''
           first_c = idx + 1
           last_c = first_c

data/lib/bow/memorable.rb

@@ -6,10 +6,6 @@ module Bow
       @task_history ||= Locker.load
     end
 
-    # def update_history(step = {})
-    # task_history.add(name, step) unless step.empty?
-    # end
-
     def flush_history
       task_history.flush
     end

data/lib/bow/options.rb

@@ -24,7 +24,7 @@ module Bow
       [
         '-c',
         '--copy-tool',
-        'Utilit used for files transfer (scp or rsync)',
+        'A tool used for provision files transfer (can be scp or rsync)',
         :option_copy_tool
       ],
       [

data/lib/bow/rake.rb

@@ -55,10 +55,13 @@ module Rake
     alias orig__invoke_with_call_chain invoke_with_call_chain
 
     def invoke_with_call_chain(task_args, invocation_chain) # :nodoc:
-      return apply_revert_task if disabled?
+      if disabled?
+        return unless applied?
+        return apply_revert_task
+      end
       return if run_once? && applied?
       result = orig__invoke_with_call_chain(task_args, invocation_chain)
-      apply if run_once?
+      apply
       flush_history
       result
     end
@@ -101,7 +104,7 @@ module Rake
 
     def find_revert_task
       return unless flow[:revert]
-      application.lookup(flow[:revert])
+      application.lookup(flow[:revert], @scope)
     end
 
     # Add flow to the task.

data/lib/bow/response_formatter.rb

@@ -12,6 +12,12 @@ module Bow
         puts "#{wrap(*args)}\n"
       end
 
+      def multi_print(host, results)
+        results.each do |r|
+          puts "#{wrap(host, r)}\n"
+        end
+      end
+
       def wrap(host, result)
         host_group = colorize("[#{host.group}]", HEADER)
         host_addr = colorize(host.host, HEADER)

data/lib/bow/ssh/rsync.rb

@@ -8,14 +8,14 @@ module Bow
       end
 
       def call(source, target)
-        @ssh_helper.run(cmd_rsync(source, conn, target))
+        @ssh_helper.run(cmd_rsync(source, target))
       end
 
-      def cmd_rsync(source, conn, target)
+      def cmd_rsync(source, target)
         format(
-          'rsync --contimeout=10 --force -r %s %s:%s',
+          'rsync --timeout=10 --force -r %s %s:%s',
           source,
-          conn,
+          @ssh_helper.conn,
           target
         )
       end

data/lib/bow/ssh/scp.rb

@@ -9,12 +9,17 @@ module Bow
 
       def call(source, target)
         @ssh_helper.execute(cmd_rm(target)) if cleanup_needed?
-        @ssh_helper.run(cmd_scp(source, conn, target))
+        @ssh_helper.run(cmd_scp(source, target))
         @ssh_helper.run(cmd)
       end
 
-      def cmd_scp(source, conn, target)
-        format('scp -o ConnectTimeout -r %s %s:%s', source, conn, target)
+      def cmd_scp(source, target)
+        format(
+          'scp -o ConnectTimeout -r %s %s:%s',
+          source,
+          @ssh_helper.conn,
+          target
+        )
       end
 
       def cmd_rm(target)

data/lib/bow/ssh_helper.rb

@@ -19,7 +19,14 @@ module Bow
       @conn = conn
     end
 
-    def execute(cmd, timeout = 10)
+    def execute(cmd, timeout = 10, chdir = false)
+      cmd = if chdir
+              format("'cd %s && %s'",
+                     @app.config.guest_from_host[:rake_dir],
+                     cmd)
+            else
+              format("'%s'", cmd)
+            end
       cmd = "ssh -o ConnectTimeout=#{timeout} #{conn} #{cmd}"
       run(cmd)
     end
@@ -35,11 +42,12 @@ module Bow
       results << ensure_base_dir
       results << copy_preprovision_script
       results << copy_rake_tasks
-      merge_results(*results)
+      results
+      # merge_results(*results)
     end
 
     def ensure_base_dir
-      execute("mkdir -p #{@app.config.guest_from_host[:base_dir]}")
+      execute("mkdir -p #{@app.config.guest_from_host[:rake_dir]}", 10, false)
     end
 
     def copy_preprovision_script
@@ -50,7 +58,7 @@ module Bow
     end
 
     def copy_rake_tasks
-      copy(@app.inventory.location, @app.config.guest_from_host[:rake_dir])
+      copy("#{@app.inventory.location}/*", @app.config.guest_from_host[:rake_dir])
     end
 
     def copy_tool

data/lib/bow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bow
-  VERSION = '0.5.0'
+  VERSION = '0.5.2'
 end

data/src/{preprovision.sh → provision.sh}

@@ -34,9 +34,14 @@ fi
 # Install bow
 which bow &>/dev/null
 if [[ 0 != $? ]]; then
-  echo ">> Installing Bow..."
   gem install bow
-  if [[ $? == 0 ]]; then echo "Bow installed!"; fi
 else
-  echo ">> Bow already installed!"
+  gem_ver=`gem list --local | grep "^rails " | awk -F'[()]' '{ print $2 }'`
+  if [[ $gem_ver < $BOW_VERSION ]]; then
+    echo ">> Installing Bow..."
+    gem update bow
+    if [[ $? == 0 ]]; then echo "Bow installed!"; fi
+  else
+    echo ">> Bow already installed!"
+  fi
 fi

metadata

@@ -1,86 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: bow
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Zinovyev Ivan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-24 00:00:00.000000000 Z
+date: 2017-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Simple provisioning via rake tasks
+        version: 0.50.0
+description: Automate your infrastructure provisioning \ and configuration with Rake.
 email: zinovyev.id@gmail.com
 executables:
 - bow
@@ -116,7 +102,7 @@ files:
 - lib/bow/targets.rb
 - lib/bow/thread_pool.rb
 - lib/bow/version.rb
-- src/preprovision.sh
+- src/provision.sh
 homepage: https://github.com/zinovyev/bow
 licenses:
 - MIT
@@ -140,5 +126,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Simple provisioning via rake tasks
+summary: Automate your infrastructure provisioning \ and configuration with Rake.
 test_files: []