alphonse 0.0.1

data/lib/alphonse/operator.rb

@@ -0,0 +1,78 @@
+require 'alphonse/connection'
+require 'alphonse/configs/operation'
+require 'alphonse/configs/bundler'
+
+module Alphonse
+  class Operator
+    include Alphonse::Configs::Tasks
+    include Alphonse::Configs::Bundler
+    attr_reader :config
+
+    def initialize(config = {})
+      @config = config
+    end
+
+    def execute(command)
+      hosts.each do |host_connection|
+        begin
+          Alphonse.logger.info "\e[4mRunning on #{host_connection.connection_string}\e[0m"
+          
+          host_connection.send_and_execute send(command)
+
+          Alphonse.logger.success "Aaaaaay! All Actions Completed"
+        rescue Exception => e
+          Alphonse.logger.error "#{e.class.to_s} : #{e.message}\n\n#{e.backtrace.join("\n")}"
+          break
+        ensure
+          host_connection.close
+        end
+      end
+    end
+
+    private
+
+    # Create and setup folder on remote server
+    def setup
+      Alphonse.logger.operation config[:setup_description]
+      prerequisite.push config[:setup].map { |task| send task }
+    end
+
+    # First time deploy of app to remote server
+    def deploy
+      Alphonse.logger.operation config[:deploy_description]
+      prerequisite.push config[:deploy].map { |task| send(task) }
+    end
+
+    # Issue bundle command on remote server
+    def bundle_update
+      Alphonse.logger.operation config[:bundle_description]
+      prerequisite.push config[:bundle_update].map { |task| send(task) }
+    end
+
+    # Pull latest on remote server
+    def update
+      Alphonse.logger.operation config[:update_description]
+      prerequisite.push config[:update].map { |task| send(task) }
+    end
+
+    # Restart the app
+    def restart
+      Alphonse.logger.operation config[:restart_description]
+      prerequisite.push config[:restart].map { |task| send(task) }
+    end
+
+    def prerequisite
+      [cd_to_path, 'ls -al', 'which ruby']
+    end
+
+    def hosts
+      @hosts ||= begin
+        host_connections, hosts, user = [], (config[:hosts] rescue nil), (config[:user] rescue nil)
+        hosts.each {|host| host_connections << Connection.new(host, user, config) } if hosts && user; 
+        host_connections
+      end
+    end
+
+
+  end
+end

data/lib/alphonse/version.rb

@@ -0,0 +1,9 @@
+module Alphonse
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+    PRE   = nil
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/alphonse.rb

@@ -0,0 +1,46 @@
+require "alphonse/version"
+require "alphonse/logger"
+
+module Alphonse
+  
+  # Base class for all Alphonse exceptions
+  class AlphonseError < StandardError
+  end
+
+  # When a command(s) return a stderr stream
+  class StdError < AlphonseError
+  end
+
+  # When a configuration file is missing
+  class NoFonzfileError < AlphonseError
+  end
+
+  # When a host is not defined
+  class MissingUserError < AlphonseError
+  end
+
+  # When a host is not defined
+  class MissingHostError < AlphonseError
+  end
+
+  # When an operation is not defined
+  class MissingOperationError < AlphonseError
+  end
+
+  # When an operation is not defined
+  class MissingCommandError < AlphonseError
+  end
+
+  # When an operation is invalid
+  class InvalidOperationError < AlphonseError
+  end
+
+  # When a command is not present or formed corrently
+  class CliCommandError < AlphonseError
+  end
+
+  # When an argument is not present or well formed
+  class CliArgumentError < AlphonseError
+  end
+
+end

data/spec/alphonse/cli_spec.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'alphonse/cli'
+
+describe "Cli" do
+
+  describe "with an operation passed" do
+   
+    before do
+      @command = 'deploy'
+      @cli = Alphonse::Cli.new(@command.split(' '))
+    end
+   
+    it "should determine the operation to run" do
+      @cli.command.should == :deploy
+    end
+
+    it "should match the default options" do
+      @cli.options.should == { :environment => :production }
+    end
+  
+  end
+
+  describe "with an operation and environment passed" do
+   
+    before do
+      @command = 'deploy -e staging'
+      @cli = Alphonse::Cli.new(@command.split(' '))
+    end
+   
+    it "should determine the operation to run" do
+      @cli.command.should == :deploy
+    end
+
+    it "should match the passed options" do
+      @cli.options.should == { :environment => :staging }
+    end
+  
+  end
+
+
+  describe "with no arguments" do
+    it 'should raise an error' do
+      lambda { @cli = Alphonse::Cli.new }.should raise_error(Alphonse::CliArgumentError)
+    end
+  end
+  
+end

data/spec/alphonse/config_spec.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'alphonse/config'
+
+describe "Config" do 
+
+  describe "with specified Fonzfile" do
+    before do
+      @config = Alphonse::Config.new(:file_name => 'spec/fonzfiles/default', :test_variable => 1)
+    end
+
+    it 'should load the config file' do
+      @config.config_loaded?.should be_true
+    end
+
+    it 'should have attributes set' do
+      @config[:user].should_not be_nil
+      @config[:hosts].should_not be_nil
+    end
+
+    it 'should be able to access given attributes' do
+      @config[:test_variable].should equal(1)
+    end
+
+    it 'should set new attributes' do
+      @config.set_attr :new_variable => 'new value'
+      @config[:new_variable].should == 'new value'
+    end
+
+    it 'should re set an attribute' do
+      @config.set_attr :test_variable => 2
+      @config[:test_variable].should equal(2)
+    end
+
+    describe 'calling operator' do
+      it 'should initialise and return new operator' do
+        @config.operator.should_not be_nil
+        @config.operator.class.should equal(Alphonse::Operator)
+      end
+    end
+  end
+
+
+  describe 'without specified Fonzfile' do
+    before do
+      @config = Alphonse::Config.new
+    end
+
+    it 'should use default Fonzfile' do
+      @config.config_loaded?.should be_true
+    end
+
+    it 'should have attributes set' do
+      @config[:user].should_not be_nil
+      @config[:hosts].should_not be_nil
+    end
+
+  end
+
+
+end

data/spec/alphonse/configs/bundler_spec.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'alphonse/configs/bundler'
+
+describe "Configs::Bundler" do
+  before do
+
+    @klass = Class.new do
+      include Alphonse::Configs::Bundler
+      attr_reader :config
+
+      def initialize
+        @config = {}
+      end
+
+      def config=(hash)
+        @config = hash
+      end
+
+    end.new
+
+  end
+
+  after do
+    @klass = nil
+  end
+
+  describe "with a Gemfile" do
+    before do
+      @klass.should_receive(:using_bundler?).and_return(true)
+    end
+
+    describe "with ruby_bin_path" do
+      before do
+        @klass.config = {:ruby_bin_path => "path/to/ruby/"}
+      end
+
+      describe "when calling bundle_install" do
+        it "should return command prepended with ruby_bin_path and bundle exec" do
+
+          @klass.bundle_install.should == "path/to/ruby/bundle install --deployment --without development test"
+        end
+      end
+
+      describe "when calling rake command" do
+        it "should return rake command prepended with ruby_bin_path and bundle exec" do
+          @klass.rake("--tasks").should == "path/to/ruby/bundle exec rake --tasks"
+        end
+      end
+
+    end
+
+  end
+
+  describe "without a Gemfile" do
+    before do
+      @klass.should_receive(:using_bundler?).and_return(false)
+    end
+
+    describe "without ruby_bin_path" do
+      before do
+        @klass.config = {}
+      end
+
+      describe "when calling bundle_install" do
+        it "should return command without prepends" do
+          @klass.bundle_install.should be_nil
+        end
+      end
+
+      describe "when calling rake command" do
+        it "should return rake command without prepends" do
+          @klass.rake("--tasks").should == "rake --tasks"
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/alphonse/configs/operation_spec.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'alphonse/configs/operation'
+
+describe "Configs::Operation" do
+  before do
+    @klass = Class.new do
+      include Alphonse::Configs::Operation
+      include Alphonse::Configs::Tasks
+      attr_reader :config
+
+      def initialize
+        @config = {}
+      end
+
+      def config=(hash)
+        @config = hash
+      end
+
+      def set_attr(hash)
+        config.merge! hash
+      end
+
+    end.new
+
+    @test_tasks = [:source_shell_rc, :git_pull]
+  end
+
+  after do
+    @klass = nil
+  end
+
+  describe "Given operation and tasks" do
+    before do
+      @klass.operation :test_operation, "Test Operation Deascription"
+      @klass.tasks(@test_tasks)
+    end
+
+    it "should set given tasks in operation key of config" do
+      @klass.config[:test_operation].should == @test_tasks
+    end
+
+    it "should set given description in config" do
+      @klass.config[:test_operation_description].should_not be_nil
+    end
+
+    describe "Calling tasks" do
+      it "should return commands as strings" do
+        task = @klass.config[:test_operation].first
+        @klass.send(task).should == "source ~/.bashrc"
+
+        task = @klass.config[:test_operation].last
+        @klass.send(task).should == ["git checkout master -q", "git pull origin master -q", "git gc --aggressive"]
+      end
+    end
+  end
+end

data/spec/alphonse/configs/setting_spec.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'alphonse/configs/setting'
+
+describe "Configs::Setting" do
+  before do
+    @klass = Class.new do
+      include Alphonse::Configs::Setting
+      attr_reader :config
+
+      def initialize
+        @config = {}
+      end
+
+      def config=(hash)
+        @config = hash
+      end
+
+      def set_attr(hash)
+        config.merge! hash
+      end
+
+    end.new
+  end
+
+  after do
+    @klass = nil
+  end
+
+  describe "with a single given value for an attribute" do
+    before do
+      @klass.user("user_name")
+    end
+
+    it "should set correct attribute" do
+      @klass.config[:user].should == "user_name"
+    end
+  end
+
+  describe "with an array of values given for an attribute" do
+    before do
+      @klass.hosts(["host.address", "alt_host.address"])
+    end
+
+    it "should set attribute with correct values" do
+      @klass.config[:hosts].should == ["host.address", "alt_host.address"]
+    end
+  end
+
+
+end

data/spec/alphonse/connection_spec.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'alphonse/connection'
+
+describe "Connection" do
+  describe "with host and user" do
+    before do
+      mock_net_ssh_session!
+      @connection = Alphonse::Connection.new("localhost", "username", {})
+    end
+
+    describe "with given commands" do
+      it "should send and excute and return array" do
+        session.should_receive(:run).and_return(@result)
+
+        results = @connection.send_and_execute("date")
+        results.class.should equal(Array)
+      end
+
+      it "should set host and username" do
+        @connection.connection_string.should == "username@localhost"
+      end
+
+      it "should be able to close session" do
+        @connection.close.should equal(true)
+      end
+    end
+
+    describe "without given commands" do
+      it "should return an empty array" do
+        result = @connection.send_and_execute()
+        result.class.should equal(Array)
+        result.empty?.should be_true
+      end
+    end
+
+    describe "given invalid command" do
+      it "shoould raise Alphonse::MalformedCommandError" do
+        lambda { @connection.send_and_execute(12) }.should raise_error(Alphonse::MissingCommandError)
+      end
+    end
+  end
+
+  describe "without" do
+    describe "host" do
+      it "should raise Alphonse::MissingHostError" do
+        lambda { Alphonse::Connection.new(nil, "username", {}) }.should raise_error(Alphonse::MissingHostError)
+      end
+    end
+
+    describe do
+      it "should raise Alphonse::MissingUserError" do
+        lambda { Alphonse::Connection.new("localhost", nil, {}) }.should raise_error(Alphonse::MissingUserError)
+      end
+    end
+  end
+end

data/spec/alphonse/operator_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'alphonse/config'
+require 'alphonse/operator'
+
+describe "Operator" do 
+
+  describe "initialised with config" do
+    before do
+      @config = Alphonse::Config.new(:file_name => 'spec/fonzfiles/default')
+      @operator = Alphonse::Operator.new(@config)
+    end
+
+    it "should have array of Connections" do
+      @operator.send(:hosts).class.should equal(Array)
+      @operator.send(:hosts).first.class.should equal(Alphonse::Connection)
+    end
+
+    describe "with hosts" do
+      before do
+        mock_connection!
+        @operator.stub(:hosts).and_return([@connection])
+      end
+
+      it "should execute setup operation" do
+        @operator.execute(:setup).class.should equal(Array)
+      end
+
+      it "should execute deploy operation" do
+        @operator.execute(:deploy).class.should equal(Array)
+      end
+    end
+
+  end
+end

data/spec/fonzfiles/default

@@ -0,0 +1,21 @@
+user 'remote_user'
+hosts 'stage.example.com'
+path "/fullpath/to/folder"
+git_repo 'git@gitaddress:repository.git'
+branch 'master'
+
+operation :setup, 'Setup server' do
+  tasks :clone_repository
+end
+
+operation :deploy, 'Deploy repository' do
+  tasks :install_gems, :setup_database, :restart_app
+end
+
+operation :update, 'Update the repository on the server' do
+  tasks :update_repository, :install_gems, :update_database, :restart_app
+end
+
+operation :restart, 'Restart application' do
+  tasks :restart_app
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+
+require 'alphonse'
+require 'rspec'
+
+RSpec.configure do |config|
+  # config
+end
+
+def mock_connection!
+  @connection = double('connection')
+  @connection.stub(:send_and_execute).and_return([])
+  @connection.stub(:connection_string).and_return("connection_string")
+  @connection.stub(:close).and_return(true)
+end
+
+def mock_net_ssh_session!
+  @result = double('result')
+  @result.stub(:failure?).and_return(:false)
+  @result.stub(:output).and_return("Output")
+  @result.stub(:duration).and_return(100)
+  @session = double("session")
+  @session.stub(:close).and_return(true)
+  @session.stub(:open).and_return(true)
+  @session.stub(:run).and_return(@result)
+  Net::SSH::Session.stub(:new).and_return(@session)
+end
+
+
+def connection
+  @connection
+end
+
+def session
+  @session
+end