tomo 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79cfaa19c379a5d143b07102f521a707495a89446b4c08a9048b11ee212585b6
-  data.tar.gz: 180a8b7e1a7812e7a71b8c9b0dd1c8c9607ac81a5e025de7e685de86dca534d8
+  metadata.gz: fccccb439486dd6a01d1ae1c4fd89a00449847275c4510dae1e8de286c21d875
+  data.tar.gz: 249c53ba5dcbc1592fcf8ba1c45212dd97c2dbb018ca88b5d6d5a12dcd401895
 SHA512:
-  metadata.gz: 737d43b6ab7ca31529ec9c1c3cc7ea98c87af44cc7c7324c36287e536afc0b95313a77ec989295f7f3998ad4eb7acc9b41e2e128d2dceb78c93e4f3c6d529a71
-  data.tar.gz: e704de839bac059e668f0aa43433cddadd46e2bf2978e6f49d135da3c9d9deb5a63e3f5660bdbf286f3b49f7263201d73a8e24c16986f526179bed4574deaef9
+  metadata.gz: a0638893655f98866b04052ca6d512a42d5f56e6cde2a3798b6e5009ac8cff4fe65561159f22aa8791399bd89dc07a12b904a761c921eeba5eb7d5a054545645
+  data.tar.gz: e15be0b3b72f5f50733bda37bf5012e7a16b0c4abfff7a2b3f248c87008437df54f4c920846bf07b03368c3745bfe052e7f85819fd408ab758bd24bb3fb0d21d

data/lib/tomo/cli/common_options.rb

@@ -40,7 +40,7 @@ module Tomo
         begin
           require "concurrent"
           Tomo.logger.debug("concurrent-ruby #{Concurrent::VERSION}")
-        rescue LoadError # rubocop:disable Lint/HandleExceptions
+        rescue LoadError # rubocop:disable Lint/SuppressedException
         end
       end
     end

data/lib/tomo/commands/deploy.rb

@@ -15,7 +15,9 @@ module Tomo
 
           Sequentially run the "deploy" list of tasks specified in #{DEFAULT_CONFIG_PATH} to
           deploy the project to a remote host. Use the #{blue('--dry-run')} option to quickly
-          simulate the entire deploy without actually connecting to the host.
+          simulate the entire deploy without actually connecting to the host. Add the
+          #{blue('--debug')} option to see an in-depth explanation of the settings and execution
+          plan that will be used for the deployment
 
           For a #{DEFAULT_CONFIG_PATH} that specifies distinct environments (e.g. staging,
           production), you must specify the target environment using the #{blue('-e')} option. If

data/lib/tomo/runtime/execution_plan.rb

@@ -11,9 +11,8 @@ module Tomo
 
       def initialize(tasks:, hosts:, task_filter:, task_runner:)
         @hosts = hosts
-        @tasks = tasks
         @task_runner = task_runner
-        @plan = build_plan(task_filter)
+        @plan = build_plan(tasks, task_filter)
         @applicable_hosts = gather_applicable_hosts
         @thread_pool = build_thread_pool
         freeze
@@ -33,6 +32,7 @@ module Tomo
       end
 
       def execute
+        Tomo.logger.debug("Execution plan:\n#{explain}")
         open_connections do |remotes|
           plan.each do |steps|
             steps.each do |step|
@@ -44,9 +44,13 @@ module Tomo
         self
       end
 
+      def explain
+        Explanation.new(applicable_hosts, plan, concurrency).to_s
+      end
+
       private
 
-      attr_reader :tasks, :hosts, :plan, :task_runner, :thread_pool
+      attr_reader :hosts, :plan, :task_runner, :thread_pool
 
       def validate_tasks!
         plan.each do |steps|
@@ -70,7 +74,7 @@ module Tomo
         (remotes || {}).values.each(&:close)
       end
 
-      def build_plan(task_filter)
+      def build_plan(tasks, task_filter)
         tasks.each_with_object([]) do |task, result|
           steps = hosts.map do |host|
             HostExecutionStep.new(

data/lib/tomo/runtime/explanation.rb

@@ -0,0 +1,44 @@
+module Tomo
+  class Runtime
+    class Explanation
+      def initialize(applicable_hosts, plan, concurrency)
+        @applicable_hosts = applicable_hosts
+        @plan = plan
+        @concurrency = concurrency
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def to_s
+        desc = []
+        threads = [applicable_hosts.length, concurrency].min
+        desc << "CONCURRENTLY (#{threads} THREADS):" if threads > 1
+        applicable_hosts.each do |host|
+          indent = threads > 1 ? "  = " : ""
+          desc << "#{indent}CONNECT #{host}"
+        end
+        plan.each do |steps|
+          threads = [steps.length, concurrency].min
+          desc << "CONCURRENTLY (#{threads} THREADS):" if threads > 1
+          steps.each do |step|
+            indent = threads > 1 ? "  = " : ""
+            if threads > 1 && step.applicable_tasks.length > 1
+              desc << "#{indent}IN SEQUENCE:"
+              indent.sub!(/=/, "   ")
+            end
+            desc << step.explain.gsub(/^/, indent)
+          end
+        end
+        desc.join("\n")
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      private
+
+      attr_reader :applicable_hosts, :plan, :concurrency
+    end
+  end
+end

data/lib/tomo/runtime/host_execution_step.rb

@@ -30,6 +30,15 @@ module Tomo
         end
       end
 
+      def explain
+        desc = []
+        applicable_tasks.each do |task|
+          task_host = task.is_a?(PrivilegedTask) ? host.as_privileged : host
+          desc << "RUN #{task} ON #{task_host}"
+        end
+        desc.join("\n")
+      end
+
       private
 
       attr_reader :host, :task_runner

data/lib/tomo/runtime.rb

@@ -8,6 +8,7 @@ module Tomo
     autoload :Context, "tomo/runtime/context"
     autoload :Current, "tomo/runtime/current"
     autoload :ExecutionPlan, "tomo/runtime/execution_plan"
+    autoload :Explanation, "tomo/runtime/explanation"
     autoload :HostExecutionStep, "tomo/runtime/host_execution_step"
     autoload :InlineThreadPool, "tomo/runtime/inline_thread_pool"
     autoload :NoTasksError, "tomo/runtime/no_tasks_error"

data/lib/tomo/ssh/child_process.rb

@@ -49,7 +49,7 @@ module Tomo
               on_data&.call(line)
               buffer << line
             end
-          rescue IOError # rubocop:disable Lint/HandleExceptions
+          rescue IOError # rubocop:disable Lint/SuppressedException
           end
         end
       end

data/lib/tomo/version.rb

@@ -1,3 +1,3 @@
 module Tomo
-  VERSION = "0.13.0".freeze
+  VERSION = "0.14.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tomo
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-21 00:00:00.000000000 Z
+date: 2019-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,28 +114,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.77.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.77.0
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -257,6 +257,7 @@ files:
 - lib/tomo/runtime/context.rb
 - lib/tomo/runtime/current.rb
 - lib/tomo/runtime/execution_plan.rb
+- lib/tomo/runtime/explanation.rb
 - lib/tomo/runtime/host_execution_step.rb
 - lib/tomo/runtime/inline_thread_pool.rb
 - lib/tomo/runtime/no_tasks_error.rb
@@ -329,7 +330,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A friendly CLI for deploying Rails apps ✨