screwcap 0.1

data/screwcap.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+ 
+require 'bundler/version'
+ 
+Gem::Specification.new do |s|
+  s.name        = "screwcap"
+  s.version     = "0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.author     = "Grant Ammons"
+  s.email       = ["grant@pipelinedealsco.com"]
+  s.homepage    = "http://github.com/gammons/screwcap"
+  s.summary     = "Screwcap is a wrapper of Net::SSH and allows for easy configuration, organization, and management of running tasks on remote servers."
+ 
+  s.add_dependency(['net-ssh','>=2.0.23'])
+  s.add_dependency(['net-ssh-gateway','>=1.0.1'])
+  s.rubyforge_project = 'screwcap'
+ 
+  s.files        = Dir.glob("{bin,lib}/**/*") + %w(README.rdoc screwcap.gemspec)
+  s.require_path = 'lib'
+end

data/spec/command_set_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe "Command sets" do
+  before(:all) do
+    @stdout = []
+    Deployer.any_instance.stubs(:log).with() { |msg| @stdout << msg}
+    @deployer = Deployer.new(:recipe_file => "./test/config/command_sets.rb", :silent => false)
+  end
+
+  it "should be able to define a generic list of commands" do
+    task = @deployer.__tasks.find {|t| t.__name == :really_simple_task }
+    task.should have(3).__commands
+    task.__commands.map{|c| c[:command]}.should == %w(1 2 3)
+  end
+
+  it "should be able to use deployment variables" do
+    task = @deployer.__tasks.find {|t| t.__name == :use_command_set_no_override }
+    task.__command_sets.first.instance_eval(&task.__command_sets.first.__block)
+    task.__commands.map {|c| c[:command]}.should == ["tester","run with tester","bongo"]
+  end
+
+  it "should be able to use task variables" do
+    task = @deployer.__tasks.find {|t| t.__name == :task_set_var }
+    task.__command_sets.first.instance_eval(&task.__command_sets.first.__block)
+    task.__commands.map {|c| c[:command]}.should == ["bojangles"]
+  end
+
+  it "should favor variables that were overridden by a task" do
+    task = @deployer.__tasks.find {|t| t.__name == :use_command_set_with_override }
+    task.__command_sets.first.instance_eval(&task.__command_sets.first.__block)
+    task.__commands.map {|c| c[:command]}.should == ["shasta","run with shasta","bongo"]
+  end
+
+  it "should favor variables defined in the command set definition" do
+    task = @deployer.__tasks.find {|t| t.__name == :command_set_override }
+    task.__command_sets.first.instance_eval(&task.__command_sets.first.__block)
+    task.__commands.map {|c| c[:command]}.should == ["dingle"]
+  end
+
+  it "should accept nested command sets" do
+    task = @deployer.__tasks.find {|t| t.__name == :nested_command_set }
+    task.__command_sets.first.instance_eval(&task.__command_sets.first.__block)
+    task.__commands.map {|c| c[:command]}.should == %w(1 2 3 4)
+  end
+
+  it "nested command sets have their own variable scope" do
+    task = @deployer.__tasks.find {|t| t.__name == :nested_scoping }
+    task.__command_sets.first.instance_eval(&task.__command_sets.first.__block)
+    task.__commands.map {|c| c[:command]}.should == %w(birdo nested birdo task)
+  end
+end

data/spec/deployer_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe "Deployers" do
+  before(:all) do
+    Net::SSH.stubs(:start).yields(SSHObject.new(:return_stream => :stdout, :return_data => "hostname = asdf\n"))
+  end
+
+  it "should complain if no server was defined" do
+    lambda { Deployer.new(:recipe_file => "./test/config/no_server.rb", :silent => true)}.should raise_error(Screwcap::ConfigurationError)
+  end
+
+  it "should complain if there is an undefined item in a task" do
+    lambda { Deployer.new(:recipe_file => "./test/config/undefined_item.rb", :silent => true)}.should raise_error(NoMethodError)
+  end
+
+  it "should complain if screwcap cannot find the task to run" do
+    lambda { Deployer.new(:recipe_file => "./test/config/simple_recipe.rb", :silent => true).run! :task }.should raise_error(Screwcap::TaskNotFound)
+  end
+
+  it "should complain if a gateway has more than one address" do
+  end
+
+  it "should be able to define tasks and servers" do
+    deployer = Deployer.new(:recipe_file => "./test/config/simple_recipe.rb", :silent => true)
+
+    deployer.should have(6).__tasks
+    deployer.should have(2).__servers
+  end
+
+  it "should be able to define variables with set" do
+    deployer = Deployer.new(:recipe_file => "./test/config/simple_recipe.rb", :silent => true)
+    deployer.should respond_to(:deploy_var)
+    deployer.should respond_to(:deploy_var_2)
+    deployer.should respond_to(:deploy_var_3)
+
+    deployer.deploy_var.should == "tester" 
+    deployer.deploy_var_2.should == "bongo"
+    deployer.deploy_var_3.should == ["one","two"]
+  end
+
+  it "should be able to define command sets" do
+    deployer = Deployer.new(:recipe_file => "./test/config/command_sets.rb", :silent => true)
+    deployer.should have(8).__command_sets
+  end
+
+  it "should be able to define gateways" do
+    deployer = Deployer.new(:recipe_file => "./test/config/gateway.rb", :silent => true)
+    deployer.should have(3).__servers
+    deployer.__servers.select {|s| s.__options[:is_gateway] == true }.size.should == 1
+  end
+
+  it "should be able to define sequences" do
+    deployer = Deployer.new(:recipe_file => "./test/config/simple_recipe.rb", :silent => true)
+    deployer.should have (1).__sequences
+  end
+
+  it "should be able to run a single task" do
+    deployer = Deployer.new(:recipe_file => "./test/config/simple_recipe.rb", :silent => true)
+    lambda { deployer.run! :task1 }.should_not raise_error
+  end
+
+  it "should be able to run multiple tasks" do
+    deployer = Deployer.new(:recipe_file => "./test/config/simple_recipe.rb", :silent => true)
+    lambda { deployer.run! :task1, :task2 }.should_not raise_error
+  end
+
+  it "should be able to include other task files with the use keyword" do
+    deployer = Deployer.new(:recipe_file => "./test/config/use.rb", :silent => true)
+    deployer.should have(6).__tasks
+    deployer.deploy_var.should == "tester"
+  end
+
+  it "should complain if we attempt to use an unknown file" do
+    lambda {Deployer.new(:recipe_file => "./test/config/unknown_use.rb", :silent => true) }.should raise_error(Screwcap::IncludeFileNotFound)
+  end
+end

data/spec/sequence_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe "Sequences" do
+  before(:all) do
+    Net::SSH.stubs(:start).yields(SSHObject.new(:return_stream => :stdout, :return_data => "hostname = asdf\n"))
+  end
+  before(:each) do
+    @stdout = []
+    Deployer.any_instance.stubs(:log).with() { |msg| @stdout << msg}
+    @deployer = Deployer.new(:recipe_file => "./test/config/simple_recipe.rb", :silent => true)
+  end
+
+  it "should contain a list of tasks to be called" do
+    sequence = @deployer.__sequences.find {|s| s.__name == :deploy}
+    sequence.__task_names.should == [:seq1, :seq2]
+  end
+
+  it "should be callable via Deployer.run!" do
+    lambda { @deployer.run! :deploy }.should_not raise_error
+  end
+end

data/spec/server_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe "Servers" do
+  before(:each) do
+    @stdout = []
+    @stderr = []
+    Task.any_instance.stubs(:log).with() { |msg| @stdout <<  msg }
+    Task.any_instance.stubs(:errorlog).with() { |msg| @stderr <<  msg }
+    Deployer.any_instance.stubs(:log).with() { |msg| @stdout <<  msg }
+    Deployer.any_instance.stubs(:errorlog).with() { |msg| @stderr <<  msg }
+
+    Net::SSH::Gateway.stubs(:new).returns(SSHObject.new)
+  end
+
+  before(:all) do
+    Net::SSH.stubs(:start).yields(SSHObject.new(:return_stream => :stdout, :return_data => "hostname = asdf\n"))
+  end
+
+  it "should complain if you do not provide an address" do
+    lambda { Server.new(:name => :test) }.should raise_error(Screwcap::InvalidServer)
+  end
+
+  it "should complain if you do not provide a username" do
+    lambda { Server.new(:name => :test, :address => "abc.com") }.should raise_error(Screwcap::InvalidServer)
+  end
+
+  it "should complain if a gateway contains more than one address" do
+    lambda { Server.new(:name => :test, :addresses => ["abc.com", "def.com"], :user => "root", :is_gateway => true) }.should raise_error(Screwcap::InvalidServer)
+  end
+
+  it "should provide a connection to the server" do
+    server = Server.new(:name => :test, :user => :root, :address => "abc.com")
+    server.should respond_to(:__with_connection_for)
+  end
+
+  it "should provide a connection to the server with a gateway" do
+    @deployer = Deployer.new(:recipe_file => "./test/config/gateway.rb", :silent => false)
+    server = @deployer.__servers.find {|s| s.__name == :test}
+    gateway = @deployer.__servers.find {|s| s.__name == :gateway1}
+
+    output = []
+    lambda { server.__with_connection {} }.should_not raise_error 
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/screwcap'
+
+require 'rubygems'
+require 'mocha'
+require 'ruby-debug' rescue nil
+require 'net/ssh'
+
+class SSHObject
+  attr_accessor :options
+
+  def initialize(options = {})
+    @options = {:return_stream => :stdout}
+    @options = options
+  end
+
+  def exec!(cmd, &block)
+    yield nil, @options[:return_stream], @options[:return_data]
+  end
+
+  def ssh(address, user, options = {}, &block)
+    yield nil
+  end
+end

data/spec/task_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe "Tasks" do
+  before(:each) do
+    @stdout = []
+    @stderr = []
+    Task.any_instance.stubs(:log).with() { |msg| @stdout <<  msg }
+    Task.any_instance.stubs(:errorlog).with() { |msg| @stderr <<  msg }
+    Deployer.any_instance.stubs(:log).with() { |msg| @stdout <<  msg }
+    Deployer.any_instance.stubs(:errorlog).with() { |msg| @stderr <<  msg }
+    @deployer = Deployer.new(:recipe_file => "./test/config/simple_recipe.rb", :silent => false)
+  end
+
+  before(:all) do
+    Net::SSH.stubs(:start).yields(SSHObject.new(:return_stream => :stdout, :return_data => "hostname = asdf\n"))
+    Net::SCP.stubs(:upload!).returns(nil)
+  end
+
+  #it "should be able to create variables" do
+  #  task = @deployer.__tasks.find {|t| t.name == :task1 }
+  #  task.bango.should == "bongo"
+  #end
+
+  #it "should compile run statements" do
+  #  task = @deployer.__tasks.find {|t| t.name == :task1 }
+  #  task.should have(6).__commands
+  #end
+
+  #it "should be able to execute statements on a remote server" do
+  #  task = @deployer.__tasks.find {|t| t.name == :task1 }
+  #  task.execute!
+  #  @stderr.should == []
+  #  @stdout.size.should == 29
+  #end
+
+  it "should be able to use variables in the run statement" do
+    task = @deployer.__tasks.find {|t| t.name == :task1 }
+    command = task.__commands.map{|c| c[:command] }.find {|c| c.index "deploy dir" }
+    command.should == "deploy dir = tester"
+  end
+
+  #it "should be able to override a globally set variable" do
+  #  @deployer.deploy_var_2.should == "bongo"
+  #  @deployer.deploy_var_3.should == %w(one two)
+
+  #  task = @deployer.__tasks.find {|t| t.name == :task1 }
+  #  task.deploy_var_2.should == "shasta"
+
+  #  task = @deployer.__tasks.find {|t| t.name == :task2 }
+  #  task.deploy_var_2.should == "purple"
+  #  task.deploy_var_3.should == "mountain dew"
+  #end
+
+  #it "should complain if you do not pass the task a server argument" do
+  #  lambda { Deployer.new(:recipe_file => "./test/config/no_server.rb", :silent => false)}.should raise_error(Screwcap::ConfigurationError)
+  #end
+
+  #it "should complain if you pass a server that is not defined" do
+  #  lambda { Deployer.new(:recipe_file => "./test/config/undefined_server.rb", :silent => false)}.should raise_error(Screwcap::ConfigurationError)
+  #end
+
+  #it "should be able to disable parallel running" do
+  #  # this is hard to test.  with threads and stuff
+  #  lambda { @deployer.run! :non_parallel }.should_not raise_error
+  #end
+
+  it "should be able to run local commands" do 
+    lambda { @deployer.run! :task3 }.should_not raise_error
+  end
+
+  it "should be able to upload files using the scp command" do
+    deployer = Deployer.new(:recipe_file => "./test/config/upload.rb", :silent => true)
+    deployer.run! :upload
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/test/config/command_sets.rb

@@ -0,0 +1,87 @@
+set :deploy_var, "tester"
+set :deploy_var_2, "bongo"
+set :deploy_var_3, ["one","two"]
+server :test, :addresses => ["slashdot.org","google.com"], :user => "root", :key => "id_rsa"
+
+command_set :push_to_thang do
+  run :deploy_var
+  run "run with #{deploy_var}"
+  run :deploy_var_2
+end
+
+command_set :task_only_var do
+  run :task_var
+end
+
+command_set :set_var do
+  set :deploy_var, "dingle"
+  run :deploy_var
+end
+
+command_set :nested do
+  run "3"
+  run "4"
+end
+
+command_set :simple1 do
+  run "1"
+  run "2"
+  nested
+end
+
+command_set :really_simple do
+  run "1"
+  run "2"
+  run "3"
+end
+
+command_set :nested_inside_with_var do
+  set :nested_var, "nested"
+  run :nested_var
+end
+
+command_set :nested_outside_with_var do
+  set :nested_var, "birdo"
+  run :nested_var
+  nested_inside_with_var
+  run :nested_var
+end
+
+
+task_for :use_command_set_no_override, :server => :test do
+  push_to_thang
+end
+
+task_for :use_command_set_with_override, :server => :test do
+  set :deploy_var, "shasta"
+  push_to_thang
+end
+
+task_for :use_command_set_complex_override, :server => :test do
+  set :deploy_var, "bango"
+  set_var
+end
+
+task_for :nested_command_set, :server => :test do
+  simple1
+end
+
+task_for :really_simple_task, :server => :test do
+  really_simple
+end
+
+task_for :task_set_var, :server => :test do
+  set :task_var, "bojangles"
+  task_only_var
+end
+
+task_for :command_set_override, :server => :test do
+  set :deploy_var, "bubbles"
+  set_var
+end
+
+task_for :nested_scoping, :server => :test do
+  set :nested_var, "task"
+  nested_outside_with_var
+  run :nested_var
+end

data/test/config/expect.rb

@@ -0,0 +1,23 @@
+server :test, :address => "abc.com", :user => "root"
+set :variable, 1
+
+command_set :revert do
+  run "revert"
+end
+
+task_for :logic, :server => :test do
+  case variable
+  when 1
+    run "1"
+  when 2
+    run "2"
+  else
+    run "none"
+  end
+end
+
+task_for :expect, :server => :test do 
+  run "ls"
+  expect "somecommand", "true", :fail => :revert
+end
+