minestrone 0.0.1

data/test/task_definition_test.rb

@@ -0,0 +1,117 @@
+require "utils"
+require 'minestrone/task_definition'
+
+# Silences the wanrnings raised in the two deprecation tests
+$VERBOSE = nil
+
+class TaskDefinitionTest < Test::Unit::TestCase
+  def setup
+    @namespace = namespace
+  end
+
+  def test_fqn_at_top_level_should_be_task_name
+    task = new_task(:testing)
+    assert_equal "testing", task.fully_qualified_name
+  end
+
+  def test_fqn_in_namespace_should_include_namespace_fqn
+    ns = namespace("outer:inner")
+    task = new_task(:testing, ns)
+    assert_equal "outer:inner:testing", task.fully_qualified_name
+  end
+
+  def test_fqn_at_top_level_when_default_should_be_default
+    task = new_task(:default)
+    assert_equal "default", task.fully_qualified_name
+  end
+
+  def test_name_should_change_task_name
+    task = new_task(:foo)
+    task.name = :bar
+
+    assert_equal :bar, task.name
+  end
+
+  def test_raise_an_exception_when_task_names_can_not_be_converted
+    task = new_task('valid task name')
+
+    assert_raises(ArgumentError) { task.name = ['invalid task name'] }
+  end
+
+  def test_fqn_in_namespace_when_default_should_be_namespace_fqn
+    ns = namespace("outer:inner")
+    task = new_task(:default, ns)
+    ns.stubs(:default_task => task)
+    assert_equal "outer:inner", task.fully_qualified_name
+  end
+
+  def test_task_should_require_block
+    assert_raises(ArgumentError) do
+      Minestrone::TaskDefinition.new(:testing, @namespace)
+    end
+  end
+
+  def test_description_should_return_empty_string_if_not_given
+    assert_equal "", new_task(:testing).description
+  end
+
+  def test_description_should_return_desc_attribute
+    assert_equal "something", new_task(:testing, @namespace, :desc => "something").description
+  end
+
+  def test_description_should_strip_leading_and_trailing_whitespace
+    assert_equal "something", new_task(:testing, @namespace, :desc => "   something   ").description
+  end
+
+  def test_description_should_normalize_newlines
+    assert_equal "a\nb\nc", new_task(:testing, @namespace, :desc => "a\nb\r\nc").description
+  end
+
+  def test_description_should_detect_and_remove_indentation
+    desc = <<-DESC
+      Here is some indented text \
+      and I want all of this to \
+      run together on a single line, \
+      without any extraneous spaces.
+
+        additional indentation will
+        be preserved.
+    DESC
+
+    task = new_task(:testing, @namespace, :desc => desc)
+    assert_equal "Here is some indented text and I want all of this to run together on a single line, without any extraneous spaces.\n\n  additional indentation will\n  be preserved.", task.description
+  end
+
+  def test_description_munging_should_be_sensitive_to_code_blocks
+    desc = <<-DESC
+      Here is a line \
+      wrapped      with spacing in it.
+
+        foo         bar
+        baz         bang
+    DESC
+
+    task = new_task(:testing, @namespace, :desc => desc)
+    assert_equal "Here is a line wrapped with spacing in it.\n\n  foo         bar\n  baz         bang", task.description
+  end
+
+  def test_brief_description_should_return_first_sentence_in_description
+    desc = "This is the task. It does all kinds of things."
+    task = new_task(:testing, @namespace, :desc => desc)
+    assert_equal "This is the task.", task.brief_description
+  end
+
+  def test_brief_description_should_truncate_if_length_given
+    desc = "This is the task that does all kinds of things. And then some."
+    task = new_task(:testing, @namespace, :desc => desc)
+    assert_equal "This is the task ...", task.brief_description(20)
+  end
+
+  def test_brief_description_should_not_break_at_period_in_middle_of_sentence
+    task = new_task(:testing, @namespace, :desc => "Take file.txt and copy it.")
+    assert_equal "Take file.txt and copy it.", task.brief_description
+
+    task = new_task(:testing, @namespace, :desc => "Take file.txt and copy it. Then do something else.")
+    assert_equal "Take file.txt and copy it.", task.brief_description
+  end
+end

data/test/transfer_test.rb

@@ -0,0 +1,172 @@
+require 'utils'
+require 'minestrone/transfer'
+
+class TransferTest < Test::Unit::TestCase
+  def test_class_process_should_delegate_to_instance_process
+    s = session('app1')
+    Minestrone::Transfer.expects(:new).with(:up, "from", "to", s, {}).returns(mock('transfer', :process! => nil)).yields
+    yielded = false
+    Minestrone::Transfer.process(:up, "from", "to", s, {}) { yielded = true }
+    assert yielded
+  end
+
+  def test_default_transport_is_sftp
+    transfer = Minestrone::Transfer.new(:up, "from", "to", session('app1', :sftp))
+    assert_equal :sftp, transfer.transport
+  end
+
+  def test_active_is_true_when_sftp_transfer_is_active
+    s = session('app1', :sftp)
+    s.xsftp.expects(:upload).returns(stub('operation', :active? => true))
+    transfer = Minestrone::Transfer.new(:up, "from", "to", s, :via => :sftp)
+    assert_equal true, transfer.active?
+  end
+
+  def test_active_is_false_when_sftp_transfer_is_not_active
+    s = session('app1', :sftp)
+    s.xsftp.expects(:upload).returns(stub('operation', :active? => false))
+    transfer = Minestrone::Transfer.new(:up, "from", "to", s, :via => :sftp)
+    assert_equal false, transfer.active?
+  end
+
+  def test_active_is_true_when_scp_transfer_is_active
+    s = session('app1', :scp)
+    channel = stub('channel', :[]= => nil, :active? => true)
+    s.scp.expects(:upload).returns(channel)
+    transfer = Minestrone::Transfer.new(:up, "from", "to", s, :via => :scp)
+    assert_equal true, transfer.active?
+  end
+
+  def test_active_is_false_when_scp_transfer_is_not_active
+    s = session('app1', :scp)
+    channel = stub('channel', :[]= => nil, :active? => false)
+    s.scp.expects(:upload).returns(channel)
+    transfer = Minestrone::Transfer.new(:up, "from", "to", s, :via => :scp)
+    assert_equal false, transfer.active?
+  end
+
+  [:up, :down].each do |direction|
+    define_method("test_sftp_#{direction}load_from_file_to_file_should_normalize_from_and_to") do
+      s = session('app1', :sftp)
+
+      s.xsftp.expects("#{direction}load".to_sym).with("from-#{s.xserver.host}", "to-#{s.xserver.host}",
+        { :properties => { :server => s.xserver, :host => s.xserver.host } })
+
+      transfer = Minestrone::Transfer.new(direction, "from-$CAPISTRANO:HOST$", "to-$CAPISTRANO:HOST$", s)
+    end
+
+    define_method("test_scp_#{direction}load_from_file_to_file_should_normalize_from_and_to") do
+      s = session('app1', :scp)
+
+      s.scp.expects("#{direction}load".to_sym).returns({}).with("from-#{s.xserver.host}", "to-#{s.xserver.host}", { :via => :scp })
+
+      transfer = Minestrone::Transfer.new(direction, "from-$CAPISTRANO:HOST$", "to-$CAPISTRANO:HOST$", s, :via => :scp)
+    end
+  end
+
+  def test_sftp_upload_from_IO_to_file_should_clone_the_IO_for_the_connection
+    s = session('app1', :sftp)
+    io = StringIO.new("from here")
+
+    s.xsftp.expects(:upload).with do |from, to, opts|
+      from != io && from.is_a?(StringIO) && from.string == io.string &&
+      to == "/to/here-#{s.xserver.host}" &&
+      opts[:properties][:server] == s.xserver &&
+      opts[:properties][:host] == s.xserver.host
+    end
+
+    transfer = Minestrone::Transfer.new(:up, StringIO.new("from here"), "/to/here-$CAPISTRANO:HOST$", s)
+  end
+
+  def test_scp_upload_from_IO_to_file_should_clone_the_IO_for_the_connection
+    s = session('app1', :scp)
+    io = StringIO.new("from here")
+
+    channel = mock('channel')
+    channel.expects(:[]=).with(:server, s.xserver)
+    channel.expects(:[]=).with(:host, s.xserver.host)
+    s.scp.expects(:upload).returns(channel).with do |from, to, opts|
+      from != io && from.is_a?(StringIO) && from.string == io.string &&
+      to == "/to/here-#{s.xserver.host}"
+    end
+
+    transfer = Minestrone::Transfer.new(:up, StringIO.new("from here"), "/to/here-$CAPISTRANO:HOST$", s, :via => :scp)
+  end
+
+  def test_process_should_block_until_transfer_is_no_longer_active
+    transfer = Minestrone::Transfer.new(:up, "from", "to", session('app1', :sftp))
+    transfer.expects(:process_iteration).times(4).yields.returns(true,true,true,false)
+    transfer.expects(:active?).times(4)
+    transfer.process!
+  end
+
+  def test_errors_raised_for_a_sftp_session_should_abort_transfer
+    s = session('app1')
+    error = ExceptionWithSession.new(s)
+    transfer = Minestrone::Transfer.new(:up, "from", "to", session('app1', :sftp))
+    transfer.expects(:process_iteration).raises(error).times(3).returns(true, false)
+    txfr = mock('transfer', :abort! => true)
+    txfr.expects(:[]=).with(:failed, true)
+    txfr.expects(:[]=).with(:error, error)
+    txfr.stubs(:[]).with(:failed).returns(true)
+    txfr.stubs(:[]).with(:server).returns(s.xserver)
+    txfr.stubs(:[]).with(:error).returns(error)
+    transfer.expects(:transfer).returns(txfr).at_least_once
+    assert_raises(Minestrone::TransferError) { transfer.process! }
+  end
+
+  def test_errors_raised_for_a_scp_session_should_abort_transfer
+    s = session('app1')
+    error = ExceptionWithSession.new(s)
+    transfer = Minestrone::Transfer.new(:up, "from", "to", session('app1', :scp), :via => :scp)
+    transfer.expects(:process_iteration).raises(error).times(3).returns(true, false)
+    txfr = mock('channel', :close => true)
+    txfr.expects(:[]=).with(:failed, true)
+    txfr.expects(:[]=).with(:error, error)
+    txfr.stubs(:[]).with(:failed).returns(true)
+    txfr.stubs(:[]).with(:server).returns(s.xserver)
+    txfr.stubs(:[]).with(:error).returns(error)
+    transfer.expects(:transfer).returns(txfr).at_least_once
+    assert_raises(Minestrone::TransferError) { transfer.process! }
+  end
+
+  def test_uploading_a_non_existing_file_should_raise_an_understandable_error
+    s = session('app1')
+    error = Minestrone::Processable::SessionAssociation.on(ArgumentError.new('expected a file to upload'), s)
+    transfer = Minestrone::Transfer.new(:up, "from", "to", session('app1', :scp), :via => :scp)
+    transfer.expects(:process_iteration).raises(error)
+    assert_raise(ArgumentError, 'expected a file to upload') { transfer.process! }
+  end
+
+  private
+
+  class ExceptionWithSession < ::Exception
+    attr_reader :session
+
+    def initialize(session)
+      @session = session
+      super()
+    end
+  end
+
+  def session(host, mode = nil)
+    session = stub('session', :xserver => stub('server', :host => host))
+    case mode
+    when :sftp
+      sftp = stub('sftp')
+      session.expects(:sftp).with(false).returns(sftp)
+      sftp.expects(:connect).yields(sftp).returns(sftp)
+      operation = stub('operation', :active? => false, :[] => nil)
+      sftp.stubs(:upload).returns(operation)
+      sftp.stubs(:download).returns(operation)
+      session.stubs(:xsftp).returns(sftp)
+    when :scp
+      channel = stub('channel', :[]= => nil, :[] => nil, :active? => false, :close => true)
+      scp = stub('scp')
+      scp.stubs(:upload).returns(channel)
+      scp.stubs(:download).returns(channel)
+      session.stubs(:scp).returns(scp)
+    end
+    session
+  end
+end

data/test/utils.rb

@@ -0,0 +1,28 @@
+require 'bundler/setup'
+require 'test/unit'
+require 'mocha/test_unit'
+
+require 'minestrone/server_definition'
+
+module TestExtensions
+  def server(host, options = {})
+    Minestrone::ServerDefinition.new(host, options)
+  end
+
+  def namespace(fqn = nil)
+    space = stub(:fully_qualified_name => fqn, :default_task => nil)
+    yield(space) if block_given?
+    space
+  end
+
+  def new_task(name, namespace = @namespace, options = {}, &block)
+    block ||= Proc.new {}
+    task = Minestrone::TaskDefinition.new(name, namespace, options, &block)
+    assert_equal block, task.body
+    return task
+  end
+end
+
+class Test::Unit::TestCase
+  include TestExtensions
+end

data/test/version_test.rb

@@ -0,0 +1,11 @@
+require 'minestrone/version'
+
+class VersionTest < Test::Unit::TestCase
+  def test_version_constant_is_not_nil
+    assert_not_nil Minestrone::VERSION
+  end
+
+  def test_version_constant_matches_class_method
+    assert_equal Minestrone::VERSION, Minestrone::Version.to_s
+  end
+end

metadata

@@ -0,0 +1,258 @@
+--- !ruby/object:Gem::Specification
+name: minestrone
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jamis Buck
+- Lee Hambley
+- Kuba Suder
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Minestrone is a utility and framework for executing commands on a remote
+  machine, via SSH.
+executables:
+- capify
+- min
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/capify
+- bin/min
+- docs/lib-codebase-map.md
+- docs/lib-dependency-graph.svg
+- lib/minestrone.rb
+- lib/minestrone/callback.rb
+- lib/minestrone/cli.rb
+- lib/minestrone/cli/help.rb
+- lib/minestrone/cli/help.txt
+- lib/minestrone/cli/options.rb
+- lib/minestrone/command.rb
+- lib/minestrone/configuration.rb
+- lib/minestrone/configuration/actions/file_transfer.rb
+- lib/minestrone/configuration/actions/inspect.rb
+- lib/minestrone/configuration/actions/invocation.rb
+- lib/minestrone/configuration/alias_task.rb
+- lib/minestrone/configuration/callbacks.rb
+- lib/minestrone/configuration/connections.rb
+- lib/minestrone/configuration/execution.rb
+- lib/minestrone/configuration/loading.rb
+- lib/minestrone/configuration/log_formatters.rb
+- lib/minestrone/configuration/namespaces.rb
+- lib/minestrone/configuration/servers.rb
+- lib/minestrone/configuration/variables.rb
+- lib/minestrone/errors.rb
+- lib/minestrone/ext/string.rb
+- lib/minestrone/extensions.rb
+- lib/minestrone/logger.rb
+- lib/minestrone/processable.rb
+- lib/minestrone/recipes/deploy.rb
+- lib/minestrone/recipes/deploy/assets.rb
+- lib/minestrone/recipes/deploy/bundler.rb
+- lib/minestrone/recipes/deploy/dependencies.rb
+- lib/minestrone/recipes/deploy/local_dependency.rb
+- lib/minestrone/recipes/deploy/remote_dependency.rb
+- lib/minestrone/recipes/deploy/scm.rb
+- lib/minestrone/recipes/deploy/scm/base.rb
+- lib/minestrone/recipes/deploy/scm/git.rb
+- lib/minestrone/recipes/deploy/scm/none.rb
+- lib/minestrone/recipes/deploy/strategy.rb
+- lib/minestrone/recipes/deploy/strategy/base.rb
+- lib/minestrone/recipes/deploy/strategy/copy.rb
+- lib/minestrone/recipes/deploy/strategy/remote_cache.rb
+- lib/minestrone/recipes/standard.rb
+- lib/minestrone/recipes/templates/maintenance.rhtml
+- lib/minestrone/server_definition.rb
+- lib/minestrone/ssh.rb
+- lib/minestrone/task_definition.rb
+- lib/minestrone/transfer.rb
+- lib/minestrone/version.rb
+- minestrone.gemspec
+- test/cli/execute_test.rb
+- test/cli/help_test.rb
+- test/cli/options_test.rb
+- test/cli/ui_test.rb
+- test/cli_test.rb
+- test/command_test.rb
+- test/configuration/actions/file_transfer_test.rb
+- test/configuration/actions/inspect_test.rb
+- test/configuration/actions/invocation_test.rb
+- test/configuration/alias_task_test.rb
+- test/configuration/callbacks_test.rb
+- test/configuration/connections_test.rb
+- test/configuration/execution_test.rb
+- test/configuration/loading_test.rb
+- test/configuration/namespace_dsl_test.rb
+- test/configuration/servers_test.rb
+- test/configuration/variables_test.rb
+- test/configuration_test.rb
+- test/deploy/local_dependency_test.rb
+- test/deploy/remote_dependency_test.rb
+- test/deploy/scm/base_test.rb
+- test/deploy/scm/git_test.rb
+- test/deploy/scm/none_test.rb
+- test/deploy/strategy/copy_test.rb
+- test/extensions_test.rb
+- test/fixtures/cli_integration.rb
+- test/fixtures/config.rb
+- test/fixtures/custom.rb
+- test/logger_formatting_test.rb
+- test/logger_test.rb
+- test/recipes_test.rb
+- test/server_definition_test.rb
+- test/ssh_test.rb
+- test/task_definition_test.rb
+- test/transfer_test.rb
+- test/utils.rb
+- test/version_test.rb
+homepage: http://github.com/mackuba/minestrone
+licenses: []
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Minestrone - Welcome to easy deployment with Ruby over SSH
+test_files:
+- test/cli/execute_test.rb
+- test/cli/help_test.rb
+- test/cli/options_test.rb
+- test/cli/ui_test.rb
+- test/cli_test.rb
+- test/command_test.rb
+- test/configuration/actions/file_transfer_test.rb
+- test/configuration/actions/inspect_test.rb
+- test/configuration/actions/invocation_test.rb
+- test/configuration/alias_task_test.rb
+- test/configuration/callbacks_test.rb
+- test/configuration/connections_test.rb
+- test/configuration/execution_test.rb
+- test/configuration/loading_test.rb
+- test/configuration/namespace_dsl_test.rb
+- test/configuration/servers_test.rb
+- test/configuration/variables_test.rb
+- test/configuration_test.rb
+- test/deploy/local_dependency_test.rb
+- test/deploy/remote_dependency_test.rb
+- test/deploy/scm/base_test.rb
+- test/deploy/scm/git_test.rb
+- test/deploy/scm/none_test.rb
+- test/deploy/strategy/copy_test.rb
+- test/extensions_test.rb
+- test/fixtures/cli_integration.rb
+- test/fixtures/config.rb
+- test/fixtures/custom.rb
+- test/logger_formatting_test.rb
+- test/logger_test.rb
+- test/recipes_test.rb
+- test/server_definition_test.rb
+- test/ssh_test.rb
+- test/task_definition_test.rb
+- test/transfer_test.rb
+- test/utils.rb
+- test/version_test.rb