taketo 0.0.6 → 0.0.7

data/Gemfile

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

data/Gemfile.lock

@@ -26,9 +26,9 @@ GEM
       rspec-expectations (~> 2.11.0)
       rspec-mocks (~> 2.11.0)
     rspec-core (2.11.1)
-    rspec-expectations (2.11.1)
+    rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.1)
+    rspec-mocks (2.11.3)
     simplecov (0.6.4)
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
@@ -40,5 +40,5 @@ PLATFORMS
 DEPENDENCIES
   aruba (~> 0.4)
   rake (~> 0.9)
-  rspec (~> 2.10)
+  rspec (~> 2.11)
   simplecov (~> 0.6)

data/README.md

@@ -92,6 +92,10 @@ You can use shared server configs to reduce duplication:
     end
   end
 
+  shared_server_config :some_other_shared_config do |folder|
+    location File.join("/var", folder)
+  end
+
   project :my_project do
     environment :staging do
       server :s1 do
@@ -101,7 +105,7 @@ You can use shared server configs to reduce duplication:
 
       server :s2 do
         host :s2 do
-        include_shared_server_config(:my_staging)
+        include_shared_server_config(:my_staging => [], :some_other_shared_config => "qux")
       end
     end
   end
@@ -109,15 +113,24 @@ You can use shared server configs to reduce duplication:
 
 This will give you ```console``` commands available both on s1 and s2  
 
-To-Do:
-------
-
-* Add support for defaults
-* Add support for generating shortcuts
-
 The Changelog:
 --------------
 
+### v0.0.7 (08.10.2012) ###
+* Add ability to include several shared server config at once
+  Use hash as include_shared_server_config parameter to include
+  multiple shared server configs with arguments, like:
+  ```ruby
+    include_shared_server_config(:foo => :some_arg, :bar => [:arg1, :arg2])
+  ```
+  or just enumerate them if no arguments needed:
+  ```ruby
+    include_shared_server_configs(:baz, :quux)
+  ```
+  
+  NOTE: This change will break your config if you've used parametrized
+        shared server configs before; rewrite them using hash-form
+
 ### v0.0.6 (26.07.2012) ###
 * Add identity_file server config option
 * Add shared server config support

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/bin/taketo

@@ -1,21 +1,16 @@
 #!/usr/bin/env ruby
 
+if ENV["TAKETO_DEV"]
+  $:.unshift(File.expand_path('../../lib', __FILE__))
+end
+
 require 'rubygems'
 
-begin
-  require 'taketo'
-  require 'taketo/constructs_factory'
-  require 'taketo/commands'
-  require 'taketo/destination_resolver'
-  require 'optparse'
-rescue LoadError => e #development
-  raise if $loaded
-  $:.unshift File.expand_path('../../lib', __FILE__)
-  require 'bundler'
-  Bundler.setup(:default)
-  $loaded = true
-  retry
-end
+require 'taketo'
+require 'taketo/constructs_factory'
+require 'taketo/commands'
+require 'taketo/destination_resolver'
+require 'optparse'
 
 Signal.trap("SIGINT") do
   puts "Terminating"
@@ -39,7 +34,7 @@ def parse_options
       options[:config] = c
     end
 
-    opts.on("-c COMMAND", "--command", "Command to execute on destination server", 
+    opts.on("-c COMMAND", "--command", "Command to execute on destination server",
             "  (COMMAND either declared in config or passed as an argument)") do |c|
       raise OptionParser::MissingArgument if String(c).strip.empty?
       options[:command] = c
@@ -71,21 +66,28 @@ end
 
 def parse_config(config)
   DSL.new.configure(config).tap do |config|
-    ConfigValidator.new(config).validate!
+    traverser = ConfigTraverser.new(config)
+    ConfigValidator.new(traverser).validate!
   end
 end
 
 def remote_command(server, options)
-  command_name = options[:command] or return default_command(options)
-  server.find(:command, command_name.to_sym) { default_command(options) }
+  command = options[:command]
+  if String(command).empty?
+    server.default_command
+  else
+    server.find_command(command.to_sym) || Constructs::Command.explicit_command(command)
+  end
 end
 
-def default_command(options)
-  cmd = Constructs::Command.new(:default)
-  cmd.command = options.fetch(:command) { "bash" }
-  cmd
+def execute(shell_command, options)
+  if options[:dry_run]
+    puts shell_command
+  else
+    system shell_command
+  end
 end
- 
+
 begin
   options          = parse_options
   config           = parse_config(options[:config])
@@ -94,18 +96,15 @@ begin
 
   if options.delete(:view)
     node = resolver.get_node
-    puts ConfigPrinter.new.render(node).chomp
+    traverser = ConfigTraverser.new(node)
+    config_printer = ConfigPrinterVisitor.new
+    traverser.visit_depth_first(config_printer)
+    puts config_printer.result
   else
     server = resolver.resolve
-
     server_command = remote_command(server, options)
     command_to_execute = Commands::SSHCommand.new(server).render(server_command.render(server, options))
-
-    if options[:dry_run]
-      puts command_to_execute
-    else
-      system command_to_execute
-    end
+    execute(command_to_execute, options)
   end
 rescue SystemExit
   # Do nothing

data/features/config.feature

@@ -6,20 +6,50 @@ Feature: taketo config
   Scenario: Shared server configs
     When I have the following config in "/tmp/taketo_test_cfg.rb"
       """
-      shared_server_config :shared_config_example do
+      shared_server_config :sc1 do
         port 9999 #can contain any server config options
       end
 
+      shared_server_config :sc2 do
+        location "/var/qux"
+      end
+
+      project :slots do
+        environment :staging do
+          server(:s1) { host "1.2.3.4"; include_shared_server_config(:sc1, :sc2) }
+        end
+      end
+      """
+    And I successfully run `taketo slots:staging:s1 --config=/tmp/taketo_test_cfg.rb --dry-run`
+    Then the output should contain
+      """
+      ssh -t -p 9999 1.2.3.4 "cd /var/qux; RAILS_ENV=staging bash"
+      """
+
+  Scenario: Shared server configs with arguments
+    When I have the following config in "/tmp/taketo_test_cfg.rb"
+      """
+      shared_server_config :sc_args1 do |port_num|
+        port port_num
+      end
+
+      shared_server_config :sc_args2 do |projects_root_folder, project_folder|
+        location File.join(projects_root_folder, project_folder)
+      end
+
       project :slots do
         environment :staging do
-          server(:s1) { host "1.2.3.4"; include_shared_server_config(:shared_config_example) }
+          server(:s1) do
+            host "1.2.3.4"
+            include_shared_server_config(:sc_args1 => 9999, :sc_args2 => ['/var', 'qux'])
+          end
         end
       end
       """
     And I successfully run `taketo slots:staging:s1 --config=/tmp/taketo_test_cfg.rb --dry-run`
     Then the output should contain
       """
-      ssh -t -p 9999 1.2.3.4 "RAILS_ENV=staging bash"
+      ssh -t -p 9999 1.2.3.4 "cd /var/qux; RAILS_ENV=staging bash"
       """
 
   Scenario: Set environment variables

data/features/config_validation.feature

@@ -12,7 +12,32 @@ Feature:
     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      |
+      | config                                           | error                                                                       |
+      |                                                  | There are no projects. Add some to your config (~/.taketo.rc.rb by default) |
+      | project(:foo) {}                                 | Project foo: no environments                                                |
+      | project(:foo) { environment(:bar) {} }           | Environment foo:bar: no servers                                             |
+      | project(:foo) { environment(:bar) { server {} }} | Server foo:bar:default: host is not defined                                 |
+
+  Scenario: Global server alias clash
+    When I have the following config in "/tmp/taketo_test_cfg.rb"
+    """
+    project(:foo) { environment(:bar) {
+      server(:s1) { host '1.2.3.4'; global_alias :a1 }
+      server(:s2) { host '2.3.4.5'; global_alias :a1 }
+    }}
+    """
+    And I run `taketo --config=/tmp/taketo_test_cfg.rb`
+    Then the stderr should contain "Server foo:bar:s2: global alias 'a1' has already been taken by server foo:bar:s1"
+
+  Scenario: Bad command
+    When I have the following config in "/tmp/taketo_test_cfg.rb"
+    """
+    project(:foo) { environment(:bar) {
+      server(:s1) { host '1.2.3.4'
+        command(:foo) {}
+      }
+    }}
+    """
+    And I run `taketo --config=/tmp/taketo_test_cfg.rb`
+    Then the stderr should contain "Don't know what to execute on command foo"
+

data/features/connect_to_server.feature

@@ -1,4 +1,4 @@
-Feature: 
+Feature:
   In order to be able to access my servers quickly
   As a developer
   I want to have a nifty little utility
@@ -53,6 +53,7 @@ Feature:
       project :slots do
         environment :staging do
           server :s1 do
+            host "1.2.3.4"
           end
           server :s2 do
             host "2.3.4.5"

data/features/error_handling.feature

@@ -10,6 +10,7 @@ Feature:
       project :slots do
         environment :staging do
           server :s1 do
+            host "1.2.3.4"
           end
           server :s2 do
             host "2.3.4.5"

data/features/help.feature

@@ -37,6 +37,7 @@ Feature:
     When I run `taketo --config=/tmp/taketo_test_cfg.rb --view`
     Then the output should contain exactly:
       """
+
       Project: foo
         Environment: bar
           Server: default
@@ -45,16 +46,16 @@ Feature:
             User: pivo
             Default location: /var/apps/vodka
             Environment: RAILS_ENV=bar
-      
+              (No commands)
+
       Project: baz
         Environment: qux
           Server: bart
             Host: 2.3.4.5
             Environment: RAILS_ENV=qux
-            Commands:
               console
               killall - Kill ALL humans
-
+      
       """
 
   Scenario: View particular server
@@ -67,5 +68,6 @@ Feature:
         User: pivo
         Default location: /var/apps/vodka
         Environment: RAILS_ENV=bar
+          (No commands)
 
       """

data/features/support/env.rb

@@ -4,6 +4,8 @@ require 'aruba/cucumber'
 require 'fileutils'
 
 ENV['PATH'] = "#{File.expand_path('../../../bin', __FILE__)}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+ENV['RUBYOPT'] = '-Ilib'
+ENV["TAKETO_DEV"] = 'true'
 
 After do
   if defined? @config_path and File.exist?(@config_path)

data/lib/taketo/associated_nodes.rb

@@ -0,0 +1,90 @@
+module Taketo
+  class NodesNotDefinedError < StandardError; end
+
+  module AssociatedNodes
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.send(:include, InstanceMethods)
+    end
+
+    module ClassMethods
+      ##
+      # Adds nodes collections to the construct
+      #
+      # Example:
+      #
+      # class Bar < BaseConstruct
+      #   has_nodes :foos, :foo
+      # end
+      #
+      # bar = Bar.new
+      # bar.foos                                  # => foos collection
+      # bar.append_foo(foo)                       # adds node the collection
+      # bar.find_foo(:foo_name)                   # find foo in foos collection by name
+      #
+      def has_nodes(name_plural, name_singular)
+        self.node_types << name_plural
+        includable = Module.new do
+          define_method "append_#{name_singular}" do |object|
+            nodes(name_plural) << object
+          end
+
+          define_method "find_#{name_singular}" do |name|
+            nodes(name_plural).find_by_name(name)
+          end
+
+          define_method name_plural do
+            nodes(name_plural)
+          end
+
+          define_method "has_#{name_plural}?" do
+            nodes(name_plural).any?
+          end
+        end
+        self.send(:include, includable)
+      end
+
+      def node_types
+        @node_types ||= []
+      end
+    end
+
+    module InstanceMethods
+      def initialize(*args)
+        @nodes = {}
+      end
+
+      def find(singular_node_name, name)
+        send("find_#{singular_node_name}", name) or
+          if block_given?
+            yield
+          else
+            raise KeyError, "#{singular_node_name} #{name} not found for #{qualified_name}"
+          end
+      end
+
+      def nodes(name_plural)
+        unless self.class.node_types.include?(name_plural)
+          raise NodesNotDefinedError, "#{name_plural} not defined for #{qualified_name}"
+        end
+        @nodes[name_plural] ||= Taketo::Support::NamedNodesCollection.new
+      end
+
+      def has_nodes?(name_plural)
+        unless self.class.node_types.include?(name_plural)
+          raise NodesNotDefinedError, "#{name_plural} not defined for #{qualified_name}"
+        end
+        @nodes.fetch(name_plural) { [] }.any?
+      end
+
+      ##
+      # Ovverride for better error messages
+      def qualified_name
+        self.class.name
+      end
+    end
+
+  end
+end
+

data/lib/taketo/commands/ssh_command.rb

@@ -9,7 +9,6 @@ module Taketo
 
       def initialize(server, options = {})
         @server = server
-        @environment = @server.environment
       end
 
       def render(rendered_command)
@@ -17,9 +16,6 @@ module Taketo
       end
 
       def host
-        unless @server.host
-          raise ArgumentError, "host for server #{@server.name} in #{@environment.name} is not defined!"
-        end
         shellescape @server.host
       end
 

data/lib/taketo/config_printer_visitor.rb

@@ -0,0 +1,68 @@
+require 'taketo/config_visitor'
+
+module Taketo
+  class ConfigPrinterVisitor < ConfigVisitor
+    def initialize
+      @indent_level = 0
+      @result = ""
+    end
+
+    visit Config do |config|
+      indent(0) do
+        if config.has_projects?
+          put "Default destination: #{config.default_destination}" if config.default_destination
+        else
+          put "There are no projects yet..."
+        end
+      end
+    end
+
+    visit Project do |project|
+      put
+      indent(0) do
+        put "Project: #{project.name}"
+        indent { put "(No environments)" unless project.has_environments? }
+      end
+    end
+
+    visit Environment do |environment|
+      indent(1) do
+        put "Environment: #{environment.name}"
+        indent { put "(No servers)" unless environment.has_servers? }
+      end
+    end
+
+    visit Server do |server|
+      indent(2) do
+        put "Server: #{server.name}"
+        indent do
+          put "Host: #{server.host}"
+          put "Port: #{server.port}" if server.port
+          put "User: #{server.username}" if server.username
+          put "Default location: #{server.default_location}" if server.default_location
+          put "Environment: " + server.environment_variables.map { |n, v| "#{n}=#{v}" }.join(" ")
+          indent { put "(No commands)" unless server.has_commands? }
+        end
+      end
+    end
+
+    visit Command do |command|
+      indent(4) { put command.name.to_s + (" - " + command.description if command.description).to_s }
+    end
+
+    def result
+      @result.chomp
+    end
+
+    def indent(level = nil)
+      @first_indent ||= level || @indent_level
+      level ? @indent_level = level - @first_indent : @indent_level += 1
+      yield
+    end
+
+    def put(str = nil)
+      @result += ("  " * @indent_level + str.to_s).rstrip.chomp + "\n"
+    end
+  end
+end
+

data/lib/taketo/config_traverser.rb

@@ -0,0 +1,55 @@
+require 'delegate'
+require 'forwardable'
+
+module Taketo
+  class ConfigTraverser
+    LEVELS = { :config => 1, :project => 2, :environment => 3, :server => 4, :command => 5 }.freeze
+    PLURALS = { :config => :configs, :project => :projects, :environment => :environments, :server => :servers, :command => :commands }.freeze
+
+    class NodeWithPath < SimpleDelegator
+      extend Forwardable
+      def_delegators :__getobj__, :class, :ancestors, :== # avoid ancestry tree troubles
+      
+      attr_reader :path
+
+      def initialize(node, path_string)
+        super(node)
+        @path = path_string.freeze
+      end
+    end
+
+    def initialize(root)
+      @root = root
+    end
+
+    def visit_depth_first(visitor)
+      parents = []
+      path_stack = [wrap_node_with_path(parents, @root)]
+
+      while path_stack.any?
+        node = path_stack.pop
+        visitor.visit(node)
+
+        next_level_node_type = LEVELS.respond_to?(:key) ? LEVELS.key(LEVELS[node.node_type] + 1) : LEVELS.index(LEVELS[node.node_type] + 1)
+        if next_level_node_type && node.has_nodes?(PLURALS[next_level_node_type])
+          parents << node
+          node.nodes(PLURALS[next_level_node_type]).reverse_each do |n|
+            n = wrap_node_with_path(parents, n)
+            path_stack.push(n) 
+          end
+        end
+      end
+    end
+
+    private
+
+    def wrap_node_with_path(parents, node)
+      NodeWithPath.new(node, path(parents, node))
+    end
+
+    def path(parents, node)
+      parents.map(&:name).reject(&:nil?).concat([node.name]).join(":")
+    end
+  end
+end
+

data/lib/taketo/config_validator.rb

@@ -1,53 +1,52 @@
+require 'taketo/config_traverser'
+require 'taketo/config_visitor'
+
 module Taketo
   class ConfigError < StandardError; end
 
-  class ConfigValidator
-    def initialize(config)
-      @config = config
+  class ConfigValidatorVisitor < ConfigVisitor
+    def initialize
+      @global_server_aliases = {}
     end
 
-    def validate!
-      ensure_projects_exist
-      ensure_environments_exist
-      ensure_servers_exist
-      ensure_global_server_aliases_unique
+    visit Config do |c|
+      raise ConfigError, "There are no projects. Add some to your config (~/.taketo.rc.rb by default)" unless c.has_projects?
     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
+    visit Project do |p|
+      raise ConfigError, "Project #{p.path}: no environments" unless p.has_environments?
     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
+    visit Environment do |e|
+      raise ConfigError, "Environment #{e.path}: no servers" unless e.has_servers?
     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(", ")}"
+    visit Server do |s|
+      if !String(s.global_alias).empty?
+        if @global_server_aliases.key?(s.global_alias)
+          raise ConfigError, "Server #{s.path}: global alias '#{s.global_alias}' has already been taken by server #{@global_server_aliases[s.global_alias].path}"
+        else
+          @global_server_aliases[s.global_alias] = s
         end
       end
+
+      raise ConfigError, "Server #{s.path}: host is not defined" if String(s.host).empty?
     end
 
-    def ensure_global_server_aliases_unique
-      aliases = @config.projects.map { |p| p.environments.map { |e| e.servers.map(&:global_alias) } }.flatten
-      non_uniq_aliases = aliases.reject(&:nil?).group_by(&:to_sym).reject { |k, v| v.size == 1 }
-      unless non_uniq_aliases.empty?
-        raise ConfigError,
-          "There are duplicates among global server aliases: #{non_uniq_aliases.keys.join(", ")}"
-      end
+    visit Command do |c|
+      raise ConfigError, "Don't know what to execute on command #{c.name}" if String(c.command).empty?
     end
   end
+
+  class ConfigValidator
+    def initialize(traverser)
+      @traverser = traverser
+    end
+
+    def validate!
+      @traverser.visit_depth_first(ConfigValidatorVisitor.new)
+    end
+  end
+
 end