dk 0.0.1 → 0.1.0

data/test/unit/test_runner_tests.rb

@@ -0,0 +1,189 @@
+require 'assert'
+require 'dk/test_runner'
+
+require 'dk/has_the_runs'
+require 'dk/runner'
+require 'dk/task'
+require 'dk/task_run'
+
+class Dk::TestRunner
+
+  class UnitTests < Assert::Context
+    desc "Dk::TestRunner"
+    setup do
+      @runner_class = Dk::TestRunner
+    end
+    subject{ @runner_class }
+
+    should "be a Dk::Runner" do
+      assert_true subject < Dk::Runner
+    end
+
+    should "have the runs" do
+      assert_includes Dk::HasTheRuns, subject
+    end
+
+    should "have the stubs" do
+      assert_includes Dk::HasTheStubs, subject
+    end
+
+  end
+
+  class InitTests < UnitTests
+    desc "when init"
+    setup do
+      @runner = @runner_class.new
+      @runner.task_class = TestTask
+    end
+    subject{ @runner }
+
+    should have_accessors :task_class
+    should have_imeths :task
+
+    should "know how to build a task of its task class" do
+      params = { Factory.string => Factory.string }
+      task = subject.task(params)
+
+      assert_instance_of subject.task_class, task
+      assert_equal params, task.instance_eval{ params }
+    end
+
+  end
+
+  class RunTests < InitTests
+    desc "and run"
+    setup do
+      @params = { Factory.string => Factory.string }
+      @task = @runner.run(@params)
+    end
+    subject{ @task }
+
+    should "run the task with any given params" do
+      assert_true subject.run_called
+      assert_equal @params, subject.run_params
+    end
+
+    should "capture any sub-tasks or local/remote cmd spies that were run" do
+      assert_equal 5, @runner.runs.size
+
+      st, lc, lcb, rc, rcb = @runner.runs
+
+      assert_instance_of Dk::TaskRun,        st
+      assert_instance_of Dk::Local::CmdSpy,  lc
+      assert_instance_of Dk::Local::CmdSpy,  lcb
+      assert_instance_of Dk::Remote::CmdSpy, rc
+      assert_instance_of Dk::Remote::CmdSpy, rcb
+
+      assert_same st, subject.sub_task
+      assert_equal TestTask::SubTask,       st.task_class
+      assert_equal subject.sub_task_params, st.params
+      assert_equal [],                      st.runs
+
+      assert_same lc, subject.local_cmd
+      assert_equal subject.local_cmd_str,   lc.cmd_str
+      assert_equal subject.local_cmd_opts,  lc.cmd_opts
+      assert_equal subject.local_cmd_input, lc.run_input
+      assert_true lc.run_called?
+
+      assert_same lcb, subject.local_cmd_bang
+      assert_equal subject.local_cmd_str,   lcb.cmd_str
+      assert_equal subject.local_cmd_opts,  lcb.cmd_opts
+      assert_equal subject.local_cmd_input, lcb.run_input
+      assert_true lcb.run_called?
+
+      assert_same rc, subject.remote_cmd
+      assert_equal subject.remote_cmd_str,   rc.cmd_str
+      assert_equal subject.remote_cmd_opts,  rc.cmd_opts
+      assert_equal subject.remote_cmd_input, rc.run_input
+      assert_true rc.run_called?
+
+      assert_same rcb, subject.remote_cmd_bang
+      assert_equal subject.remote_cmd_str,   rcb.cmd_str
+      assert_equal subject.remote_cmd_opts,  rcb.cmd_opts
+      assert_equal subject.remote_cmd_input, rcb.run_input
+      assert_true rcb.run_called?
+    end
+
+  end
+
+  module TaskCmdMethods
+
+    def local_cmd_str
+      @local_cmd_str ||= Factory.string
+    end
+
+    def local_cmd_input
+      @local_cmd_input ||= Factory.string
+    end
+
+    def local_cmd_opts
+      @local_cmd_opts ||= { Factory.string => Factory.string }
+    end
+
+    def remote_cmd_str
+      @remote_cmd_str ||= Factory.string
+    end
+
+    def remote_cmd_input
+      @remote_cmd_input ||= Factory.string
+    end
+
+    def remote_cmd_opts
+      @remote_cmd_opts ||= {
+        Factory.string => Factory.string,
+        :hosts         => Factory.hosts,
+        :ssh_args      => Factory.string,
+        :host_ssh_args => { Factory.string => Factory.string }
+      }
+    end
+
+  end
+
+  class TestTask
+    include Dk::Task
+    include TaskCmdMethods
+
+    attr_reader :run_called, :run_params
+    attr_reader :sub_task
+    attr_reader :local_cmd, :local_cmd_bang
+    attr_reader :remote_cmd, :remote_cmd_bang
+    attr_reader :scmd_test_mode_run_value
+
+    def sub_task_params
+      @sub_task_params ||= { Factory.string => Factory.string }
+    end
+
+    def run!
+      @run_called = true
+      @run_params = params
+
+      @sub_task        = run_task(SubTask, self.sub_task_params)
+      @local_cmd       = cmd(self.local_cmd_str, self.local_cmd_input, self.local_cmd_opts)
+      @local_cmd_bang  = cmd!(self.local_cmd_str, self.local_cmd_input, self.local_cmd_opts)
+      @remote_cmd      = ssh(self.remote_cmd_str, self.remote_cmd_input, self.remote_cmd_opts)
+      @remote_cmd_bang = ssh!(self.remote_cmd_str, self.remote_cmd_input, self.remote_cmd_opts)
+    end
+
+    class SubTask
+      include Dk::Task
+
+      attr_reader :run_called, :run_params
+
+      def run!
+        @run_called = true
+        @run_params = params
+        run_task(SubSubTask)
+      end
+    end
+
+    class SubSubTask
+      include Dk::Task
+
+      def run!
+        # no-op
+      end
+    end
+
+  end
+
+end

data/test/unit/tree_runner_tests.rb

@@ -0,0 +1,152 @@
+require 'assert'
+require 'dk/tree_runner'
+
+require 'stringio'
+require 'dk/config'
+require 'dk/dry_runner'
+require 'dk/has_the_runs'
+require 'dk/null_logger'
+require 'dk/task'
+require 'dk/task_run'
+
+class Dk::TreeRunner
+
+  class UnitTests < Assert::Context
+    desc "Dk::TreeRunner"
+    setup do
+      @runner_class = Dk::TreeRunner
+    end
+    subject{ @runner_class }
+
+    should "be a Dk::DryRunner" do
+      assert_true subject < Dk::DryRunner
+    end
+
+    should "have the runs" do
+      assert_includes Dk::HasTheRuns, subject
+    end
+
+    should "know its output level prefix/bullet" do
+      assert_equal '    ', subject::LEVEL_PREFIX
+      assert_equal '|-- ', subject::LEVEL_BULLET
+    end
+
+  end
+
+  class InitTests < UnitTests
+    desc "when init"
+    setup do
+      @kernal_puts_output = ""
+      config = Dk::Config.new
+      @runner = @runner_class.new(config, StringIO.new(@kernal_puts_output))
+    end
+    subject{ @runner }
+
+    should "force a null logger to disable logging" do
+      assert_instance_of Dk::NullLogger, subject.logger
+    end
+
+  end
+
+  class RunTests < InitTests
+    desc "and run"
+    setup do
+      @params = { Factory.string => Factory.string }
+      @task = @runner.run(TestTask, @params)
+    end
+    subject{ @task }
+
+    should "run the task with any given params and run any sub-tasks" do
+      assert_true subject.run_called
+      assert_equal @params, subject.run_params
+
+      sub_task = subject.sub_task
+      assert_instance_of TestTask::SubTask, sub_task
+      assert_true sub_task.run_called
+      assert_equal subject.sub_task_params, sub_task.run_params
+
+      sub_sub_task = sub_task.sub_task
+      assert_instance_of TestTask::SubSubTask, sub_sub_task
+      assert_true sub_sub_task.run_called
+      assert_equal sub_task.sub_task_params, sub_sub_task.run_params
+    end
+
+    should "capture any sub-tasks that were run" do
+      assert_equal 1, @runner.runs.size
+
+      task_run = @runner.runs.first
+      assert_equal TestTask, task_run.task_class
+      assert_equal @params,  task_run.params
+
+      assert_equal 1, task_run.runs.size
+
+      sub_task_run = task_run.runs.first
+      assert_equal TestTask::SubTask,       sub_task_run.task_class
+      assert_equal subject.sub_task_params, sub_task_run.params
+
+      assert_equal 1, sub_task_run.runs.size
+
+      sub_sub_task_run = sub_task_run.runs.first
+      assert_equal TestTask::SubSubTask,             sub_sub_task_run.task_class
+      assert_equal subject.sub_task.sub_task_params, sub_sub_task_run.params
+    end
+
+    should "output some info describing the tree of tasks that were run" do
+      exp = " 1) Dk::TreeRunner::TestTask\n" \
+            "    |-- Dk::TreeRunner::TestTask::SubTask\n" \
+            "        |-- Dk::TreeRunner::TestTask::SubSubTask\n"
+      assert_equal exp, @kernal_puts_output
+
+      @runner.run(TestTask, @params)
+
+      exp += " 2) Dk::TreeRunner::TestTask\n" \
+             "    |-- Dk::TreeRunner::TestTask::SubTask\n" \
+             "        |-- Dk::TreeRunner::TestTask::SubSubTask\n"
+      assert_equal exp, @kernal_puts_output
+    end
+
+  end
+
+  class TestTask
+    include Dk::Task
+
+    attr_reader :run_called, :run_params
+    attr_reader :sub_task_params, :sub_task
+
+    def run!
+      @run_called = true
+      @run_params = params
+
+      @sub_task_params = { Factory.string => Factory.string }
+      @sub_task = run_task(SubTask, @sub_task_params)
+    end
+
+    class SubTask
+      include Dk::Task
+
+      attr_reader :run_called, :run_params
+      attr_reader :sub_task_params, :sub_task
+
+      def run!
+        @run_called = true
+        @run_params = params
+
+        @sub_task_params = { Factory.string => Factory.string }
+        @sub_task = run_task(SubSubTask, @sub_task_params)
+      end
+    end
+
+    class SubSubTask
+      include Dk::Task
+
+      attr_reader :run_called, :run_params
+
+      def run!
+        @run_called = true
+        @run_params = params
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dk
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2016-06-21 00:00:00 Z
+date: 2016-08-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assert
@@ -19,15 +19,45 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.16.1
+        version: 2.16.3
   type: :development
   version_requirements: *id001
-description: "\"Why'd you name this repo DK?\" \"Don't know\" (this is some automated task runner thingy ala cap/rake)"
+- !ruby/object:Gem::Dependency 
+  name: much-plugin
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: scmd
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: logsly
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.3.2
+  type: :runtime
+  version_requirements: *id004
+description: "\"Why'd you name this repo dk?\" \"Don't know\" (this is some automated task runner thingy ala cap/rake)"
 email: 
 - kelly@kellyredding.com
 - collin.redding@me.com
-executables: []
-
+executables: 
+- dk
 extensions: []
 
 extra_rdoc_files: []
@@ -37,12 +67,55 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- bin/dk
 - dk.gemspec
 - lib/dk.rb
+- lib/dk/ansi.rb
+- lib/dk/cli.rb
+- lib/dk/config.rb
+- lib/dk/config_runner.rb
+- lib/dk/dk_runner.rb
+- lib/dk/dry_runner.rb
+- lib/dk/has_set_param.rb
+- lib/dk/has_ssh_opts.rb
+- lib/dk/has_the_runs.rb
+- lib/dk/has_the_stubs.rb
+- lib/dk/local.rb
+- lib/dk/null_logger.rb
+- lib/dk/remote.rb
+- lib/dk/runner.rb
+- lib/dk/task.rb
+- lib/dk/task_run.rb
+- lib/dk/test_runner.rb
+- lib/dk/tree_runner.rb
 - lib/dk/version.rb
 - log/.gitkeep
 - test/helper.rb
+- test/support/config/dk.rb
+- test/support/config/task_defs.rb
 - test/support/factory.rb
+- test/support/log/.gitkeep
+- test/system/has_the_stubs_tests.rb
+- test/system/runner_tests.rb
+- test/unit/ansi_tests.rb
+- test/unit/cli_tests.rb
+- test/unit/config_runner_tests.rb
+- test/unit/config_tests.rb
+- test/unit/dk_runner_tests.rb
+- test/unit/dk_tests.rb
+- test/unit/dry_runner_tests.rb
+- test/unit/has_set_param_tests.rb
+- test/unit/has_ssh_opts_tests.rb
+- test/unit/has_the_runs_tests.rb
+- test/unit/has_the_stubs_tests.rb
+- test/unit/local_tests.rb
+- test/unit/null_logger_tests.rb
+- test/unit/remote_tests.rb
+- test/unit/runner_tests.rb
+- test/unit/task_run_tests.rb
+- test/unit/task_tests.rb
+- test/unit/test_runner_tests.rb
+- test/unit/tree_runner_tests.rb
 - tmp/.gitkeep
 homepage: https://github.com/redding/dk
 licenses: 
@@ -56,20 +129,44 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - &id002 
+  - &id005 
     - ">="
     - !ruby/object:Gem::Version 
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - *id002
+  - *id005
 requirements: []
 
 rubyforge_project: 
 rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
-summary: "\"Why'd you name this repo DK?\" \"Don't know\" (this is some automated task runner thingy ala cap/rake)"
+summary: "\"Why'd you name this repo dk?\" \"Don't know\" (this is some automated task runner thingy ala cap/rake)"
 test_files: 
 - test/helper.rb
+- test/support/config/dk.rb
+- test/support/config/task_defs.rb
 - test/support/factory.rb
+- test/support/log/.gitkeep
+- test/system/has_the_stubs_tests.rb
+- test/system/runner_tests.rb
+- test/unit/ansi_tests.rb
+- test/unit/cli_tests.rb
+- test/unit/config_runner_tests.rb
+- test/unit/config_tests.rb
+- test/unit/dk_runner_tests.rb
+- test/unit/dk_tests.rb
+- test/unit/dry_runner_tests.rb
+- test/unit/has_set_param_tests.rb
+- test/unit/has_ssh_opts_tests.rb
+- test/unit/has_the_runs_tests.rb
+- test/unit/has_the_stubs_tests.rb
+- test/unit/local_tests.rb
+- test/unit/null_logger_tests.rb
+- test/unit/remote_tests.rb
+- test/unit/runner_tests.rb
+- test/unit/task_run_tests.rb
+- test/unit/task_tests.rb
+- test/unit/test_runner_tests.rb
+- test/unit/tree_runner_tests.rb