taketo 0.0.1 → 0.0.2

data/Gemfile

@@ -1,9 +1,9 @@
 source :rubygems
 
 group :development do
-  gem 'rspec'
-  gem 'rake'
-  gem 'aruba'
-  gem 'simplecov', :require => false
+  gem "rspec", "~> 2.10"
+  gem "rake",  "~> 0.9"
+  gem "aruba", "~> 0.4"
+  gem 'simplecov', '~> 0.6', :require => false
 end
 

data/Gemfile.lock

@@ -21,14 +21,14 @@ GEM
     json (1.7.3)
     multi_json (1.3.6)
     rake (0.9.2.2)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.1)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
+    rspec-mocks (2.11.1)
     simplecov (0.6.4)
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
@@ -38,7 +38,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba
-  rake
-  rspec
-  simplecov
+  aruba (~> 0.4)
+  rake (~> 0.9)
+  rspec (~> 2.10)
+  simplecov (~> 0.6)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Vladimir
+Copyright (c) 2012 Vladimir Yarotsky
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,6 +2,7 @@ Take Me To
 ==========
 
 [![Build Status](https://secure.travis-ci.org/v-yarotsky/taketo.png)](http://travis-ci.org/v-yarotsky/taketo)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/v-yarotsky/taketo)
 
 A tiny helper utility to make access to servers eaiser for different projects and environments.
 
@@ -13,19 +14,22 @@ puts a config into ```~/.taketo.rc.rb```:
 ```ruby
   project :my_project do
     environment :staging do
-      server :s1 do
+      server :server do
         host "1.2.3.4"
         port 10001
         user "app"
         localtion "/var/app"
+        env :TERM => "xterm-256color"
+        command :console do
+          execute "rails c"
+        end
       end
     end
   end
 ```
 
-Then execute:
-
-```taketo my_project staging s1 [command to execute, bash by default]```
+Then execute ```taketo my_project staging server -c console``` to execute the "rails c" with corresponding environment variables set on desired server
+or just ```taketo my_project staging server``` to open bash
 
 To-Do:
 ------
@@ -36,6 +40,10 @@ To-Do:
 The Changelog:
 --------------
 
+### v0.0.2 (21.07.2012) ###
+* Add ability to define environment variables
+* Add support for server commands
+
 ### v0.0.1 (13.06.2012) ###
 * Initial release
 * Support for simplest configs

data/Rakefile

@@ -11,19 +11,16 @@ rescue Bundler::BundlerError => e
 end
 
 require 'rake'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 require 'cucumber'
 require 'cucumber/rake/task'
 
-Rake::TestTask.new do |t|
-  t.test_files = Dir.glob('spec/**/*_spec.rb')
-  t.verbose = true
-end
+RSpec::Core::RakeTask.new
 
 Cucumber::Rake::Task.new(:features) do |t|
   t.cucumber_opts = "features --tags ~@wip --format pretty -x"
   t.fork = false
 end
 
-task :default => [:test, :features]
+task :default => [:spec, :features]
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/bin/taketo

@@ -6,10 +6,14 @@ begin
   require 'taketo'
   require 'taketo/constructs_factory'
   require 'taketo/commands'
+  require 'taketo/taketo_argv_parser'
   require 'optparse'
 rescue LoadError => e #development
-  $: << File.expand_path('../../lib', __FILE__)
-  require 'bundler/setup'
+  raise if $loaded
+  $:.unshift File.expand_path('../../lib', __FILE__)
+  require 'bundler'
+  Bundler.setup(:default)
+  $loaded = true
   retry
 end
 
@@ -25,48 +29,65 @@ def parse_options
 
   OptionParser.new do |opts|
     opts.banner = <<-DESC
-  A tiny helper utility to make access to servers 
-  eaiser for different projects and environments.
+A tiny helper utility to make access to servers 
+eaiser for different projects and environments.
   DESC
 
-    opts.on("-c CONFIG", "--config") do |c|
+    opts.on("-f CONFIG", "--config") do |c|
       options[:config] = c
     end
 
     opts.on("--dry-run") do |v|
       options[:dry_run] = v
     end
+
+    opts.on("--debug") do |d|
+      options[:debug] = d
+    end
+
+    opts.on("-c COMMAND", "--command") do |c|
+      raise OptionParser::MissingArgument if String(c).strip.empty?
+      options[:command] = c
+    end
   end.parse!
 
   options
 end
 
-def parse_config(options)
-  factory = Taketo::ConstructsFactory.new
-
-  Taketo::DSL.new(factory).configure do
-    config_text = File.read(options[:config])
-    eval config_text, binding, options[:config], 1
+def parse_config(config)
+  DSL.new.configure(config).tap do |config|
+    ConfigValidator.new(config).validate!
   end
 end
- 
-options = parse_options
-config = parse_config(options)
-
-project, environment, server = ARGV.shift(3).map(&:to_sym)
 
-server = begin
-  config.projects.fetch(project).environments.fetch(environment).servers.fetch(server)
-rescue KeyError => e
-  raise ArgumentError, e
+def remote_command(server, options)
+  command_name = options[:command] or return default_command(options)
+  server.command_by_name(command_name.to_sym) { default_command(options) }
 end
 
-remote_command = ARGV.join(" ")
-remote_command = "bash" if remote_command.empty?
-command_to_execute = Commands::SSHCommand.new(server).render(remote_command)
-if options[:dry_run]
-  puts command_to_execute
-else
-  system command_to_execute
+def default_command(options)
+  cmd = Constructs::Command.new(:default)
+  cmd.command = options.fetch(:command) { "bash" }
+  cmd
 end
+ 
+begin
+  options = parse_options
+  config  = parse_config(options[:config])
+
+  server = TaketoArgvParser.new(config, ARGV).parse
 
+  server_command = remote_command(server, options)
+  command_to_execute = Commands::SSHCommand.new(server).render(server_command)
+
+  if options[:dry_run]
+    puts command_to_execute
+  else
+    system command_to_execute
+  end
+rescue SystemExit
+  # Do nothing
+rescue Exception => e
+  STDERR.puts "An error occurred: #{e.message}"
+  raise if options && options[:debug]
+end

data/features/commands.feature

@@ -0,0 +1,45 @@
+Feature: 
+  In order to be able to quickly run commands on my servers
+  As a developer
+  I want to have ability to create command shortcuts via config
+  or specify command directly
+
+  Scenario: Run explicit command
+    When I have the following config in "/tmp/taketo_test_cfg.rb"
+      """
+      project :slots do
+        environment :staging do
+          server :s1 do
+            host "1.2.3.4"
+            location "/var/apps/slots"
+          end
+        end
+      end
+      """
+      And I successfully run `taketo --config=/tmp/taketo_test_cfg.rb --dry-run --command "TERM=xterm-256color bash" slots staging s1`
+    Then the output should contain
+      """
+      ssh -t 1.2.3.4 "cd /var/apps/slots; RAILS_ENV=staging TERM=xterm-256color bash"
+      """
+
+  Scenario: Run command defined in config
+    When I have the following config in "/tmp/taketo_test_cfg.rb"
+      """
+      project :slots do
+        environment :staging do
+          server :s1 do
+            host "1.2.3.4"
+            location "/var/apps/slots"
+            command :console do
+              execute "rails c"
+            end
+          end
+        end
+      end
+      """
+      And I successfully run `taketo --config=/tmp/taketo_test_cfg.rb --dry-run --command console slots staging s1`
+    Then the output should contain
+      """
+      ssh -t 1.2.3.4 "cd /var/apps/slots; RAILS_ENV=staging rails c"
+      """
+

data/features/config_validation.feature

@@ -0,0 +1,18 @@
+Feature:
+  In order to be able to use the piece of software
+  As a user
+  I want to be guided if there are any errors in my configuration
+
+  Scenario Outline: Config validation
+    When I have the following config in "/tmp/taketo_test_cfg.rb"
+    """
+    <config>
+    """
+    And I run `taketo --config=/tmp/taketo_test_cfg.rb`
+    Then the stderr should contain "<error>"
+
+    Examples:
+      | config                                | error                                                                       |
+      |                                       | There are no projects. Add some to your config (~/.taketo.rc.rb by default) |
+      | project(:foo) {}                      | There is no environments for the following projects: foo                    |
+      | project(:foo) { environment(:bar) {}} | There is no servers for the following environments in project foo: bar      |

data/features/connect_to_server.feature

@@ -21,5 +21,47 @@ Feature:
     And I successfully run `taketo --config=/tmp/taketo_test_cfg.rb --dry-run slots staging s1`
     Then the output should contain
       """
-      ssh -t "deployer"@"1.2.3.4" "cd '/var/apps/slots'; RAILS_ENV=staging bash"
+      ssh -t deployer@1.2.3.4 "cd /var/apps/slots; RAILS_ENV=staging bash"
       """
+
+  Scenario: SSH to the only server
+    When I have the following config in "/tmp/taketo_test_cfg.rb"
+      """
+      project :slots do
+        environment :staging do
+          server :s1 do
+            host "1.2.3.4"
+            location "/var/apps/slots"
+          end
+        end
+      end
+      """
+    And I successfully run `taketo --config=/tmp/taketo_test_cfg.rb --dry-run`
+    Then the output should contain
+      """
+      ssh -t 1.2.3.4 "cd /var/apps/slots; RAILS_ENV=staging bash"
+      """
+
+  Scenario: Set environment variables
+    When I have the following config in "/tmp/taketo_test_cfg.rb"
+      """
+      project :slots do
+        environment :staging do
+          server :s1 do
+            host "1.2.3.4"
+            location "/var/apps/slots"
+            env :FOO => "the value"
+          end
+        end
+      end
+      """
+    And I successfully run `taketo --config=/tmp/taketo_test_cfg.rb --dry-run`
+    Then the output should contain
+      """
+      RAILS_ENV=staging
+      """
+    And the output should contain
+      """
+      FOO=the\ value
+      """
+      

data/lib/taketo/commands/ssh_command.rb

@@ -1,26 +1,26 @@
 require 'forwardable'
+require 'shellwords'
 
 module Taketo
   module Commands
     class SSHCommand
       extend Forwardable
-
-      def_delegators :@server, :host, :port, :username, :default_location
+      include Shellwords
 
       def initialize(server, options = {})
         @server = server
         @environment = @server.environment
       end
 
-      def render(command = "bash")
-        %Q[ssh -t #{port} #{username}#{host} "#{[location, environment, command].compact.join(" ")}"].gsub(/ +/, " ")
+      def render(command)
+        %Q[ssh -t #{port} #{username}#{host} "#{command.render(@server)}"].squeeze(" ")
       end
 
       def host
         unless @server.host
           raise ArgumentError, "host for server #{@server.name} in #{@environment.name} is not defined!"
         end
-        %Q["#{@server.host}"]
+        shellescape @server.host
       end
 
       def port
@@ -28,15 +28,7 @@ module Taketo
       end
 
       def username
-        %Q["#{@server.username}"@] if @server.username
-      end
-
-      def location
-        %Q[cd '#{@server.default_location}';] if @server.default_location
-      end
-
-      def environment
-        %Q[RAILS_ENV=#{@environment.name}]
+        %Q[#{shellescape @server.username}@] if @server.username
       end
     end
   end

data/lib/taketo/config_validator.rb

@@ -0,0 +1,43 @@
+module Taketo
+  class ConfigError < StandardError; end
+
+  class ConfigValidator
+    def initialize(config)
+      @config = config
+    end
+
+    def validate!
+      ensure_projects_exist
+      ensure_environments_exist
+      ensure_servers_exist
+    end
+
+    private
+
+    def ensure_projects_exist
+      if @config.projects.empty?
+        raise ConfigError,
+          "There are no projects. Add some to your config (~/.taketo.rc.rb by default)"
+      end
+    end
+
+    def ensure_environments_exist
+      projects_without_environments = @config.projects.select { |project| project.environments.empty? }
+      if projects_without_environments.any?
+        raise ConfigError,
+          "There is no environments for the following projects: #{projects_without_environments.map(&:name).join(", ")}"
+      end
+    end
+
+    def ensure_servers_exist
+      @config.projects.each do |project|
+        environments_without_servers = project.environments.select { |environment| environment.servers.empty? }
+        if environments_without_servers.any?
+          raise ConfigError,
+            "There is no servers for the following environments in project #{project.name}: #{environments_without_servers.map(&:name).join(", ")}"
+        end
+      end
+    end
+  end
+end
+

data/lib/taketo/constructs/command.rb

@@ -0,0 +1,32 @@
+require 'shellwords'
+
+module Taketo
+  module Constructs
+    class Command
+      include Shellwords
+
+      attr_reader :name
+      attr_accessor :command
+      
+      def initialize(name)
+        @name = name
+      end
+
+      def render(server)
+        %Q[#{location(server)} #{environment_variables(server)} #{command}].squeeze(" ")
+      end
+
+      private
+
+      def location(server)
+        %Q[cd #{shellescape server.default_location};] if server.default_location
+      end
+
+      def environment_variables(server)
+        server.environment_variables.map { |k, v| %Q[#{k}=#{shellescape v}] }.join(" ")
+      end
+    end
+  end
+end
+
+

data/lib/taketo/constructs/config.rb

@@ -1,14 +1,16 @@
+require 'taketo/support'
+
 module Taketo
   module Constructs
     class Config
       attr_reader :projects
 
       def initialize
-        @projects = {}
+        @projects = Taketo::Support::NamedNodesCollection.new
       end
 
       def append_project(project)
-        @projects[project.name] = project
+        @projects << project
       end
     end
   end

data/lib/taketo/constructs/environment.rb

@@ -1,3 +1,5 @@
+require 'taketo/support'
+
 module Taketo
   module Constructs
     class Environment
@@ -5,12 +7,12 @@ module Taketo
 
       def initialize(name)
         @name = name
-        @servers = {}
+        @servers = Taketo::Support::NamedNodesCollection.new
       end
 
       def append_server(server)
-        server.environment    = self
-        @servers[server.name] = server
+        server.environment = self
+        @servers << server
       end
     end
   end

data/lib/taketo/constructs/project.rb

@@ -1,3 +1,5 @@
+require 'taketo/support'
+
 module Taketo
   module Constructs
     class Project
@@ -5,11 +7,11 @@ module Taketo
 
       def initialize(name)
         @name = name
-        @environments = {}
+        @environments = Taketo::Support::NamedNodesCollection.new
       end
 
       def append_environment(environment)
-        @environments[environment.name] = environment
+        @environments << environment
       end
     end
   end

data/lib/taketo/constructs/server.rb

@@ -1,12 +1,39 @@
 module Taketo
   module Constructs
     class Server
-      attr_reader :name
+      class CommandNotFoundError < StandardError; end
+
+      attr_reader :name, :environment_variables, :commands
       attr_accessor :host, :port, :username, :default_location, :environment
       
       def initialize(name)
         @name = name
+        @environment_variables = {}
+        @commands = []
+      end
+
+      def env(env_variables)
+        @environment_variables.merge!(env_variables)
+      end
+
+      def append_command(command)
+        @commands << command
       end
+
+      def environment=(environment)
+        env(:RAILS_ENV => environment.name.to_s)
+        @environment = environment
+      end
+
+      def command_by_name(command_name)
+        @commands.detect { |c| c.name == command_name } or 
+          if block_given?
+            yield
+          else
+            raise CommandNotFoundError, "Command #{command_name} not found for server #{name}"
+          end
+      end
+
     end
   end
 end

data/lib/taketo/constructs_factory.rb

@@ -2,6 +2,11 @@ require 'taketo/constructs'
 
 module Taketo
   class ConstructsFactory
+
+    def create(type, *args)
+      send("create_#{type}", *args)
+    end
+
     def create_config
       Constructs::Config.new
     end
@@ -17,6 +22,10 @@ module Taketo
     def create_server(*args)
       Constructs::Server.new(*args)
     end
+
+    def create_command(*args)
+      Constructs::Command.new(*args)
+    end
   end
 end