taketo 0.0.9 → 0.0.10

data/README.md

@@ -138,9 +138,15 @@ Also it's possible to specify default server configuration for any scope (whole
 
 Default configs are merged appropriately.
 
+
+An SSH config file can be generated from taketo config. To do so, run ```taketo --generate-ssh-config```.
+
 The Changelog:
 --------------
 
+### v0.0.10 (17.11.2012) ###
+* Add ability to generate ssh config
+
 ### v0.0.9 (17.11.2012) ###
 * Add default_command server config option
 
@@ -203,8 +209,6 @@ The Changelog:
 TO-DO:
 ------
 
-* Override default commands per server
 * Define servers outside projects and environments
-* Export SSH config (i.e. for scp)
 * Destination completion
 * Command completion

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.0.10

data/bin/taketo

@@ -46,9 +46,15 @@ def parse_options
     end
 
     opts.on("-v", "--view", "Show config contents and exit") do |v|
+      require 'taketo/config_printer_visitor'
       options[:view] = v
     end
 
+    opts.on("--generate-ssh-config", "Generate SSH config from taketo config") do |g|
+      require 'taketo/ssh_config_generator_visitor'
+      options[:generate_ssh_config] = g
+    end
+
     opts.separator "Special options:"
 
     opts.on("--dry-run", "Print out what would be run") do |v|
@@ -100,6 +106,11 @@ begin
     config_printer = ConfigPrinterVisitor.new
     traverser.visit_depth_first(config_printer)
     puts config_printer.result
+  elsif options.delete(:generate_ssh_config)
+    traverser = ConfigTraverser.new(config)
+    ssh_config_generator = SSHConfigGeneratorVisitor.new
+    traverser.visit_depth_first(ssh_config_generator)
+    puts ssh_config_generator.result
   else
     server = resolver.resolve
     server_command = remote_command(server, options)

data/features/generate_ssh_config.feature

@@ -0,0 +1,44 @@
+Feature:
+  In order to eliminate duplication between taketo config and ssh config
+  As a user
+  I want to be able to convert taketo config to ssh config
+
+  Background:
+    When I have the following config
+    """
+    project :foo do
+      environment :bar do
+        server do
+          host "bar.foo.com"
+          port 5678
+          user "pivo"
+          identity_file "~/.ssh/id_rsa"
+        end
+      end
+    end
+
+    project :baz do
+      environment :qux do
+        server :bart do
+          global_alias :bazqux
+          host "2.3.4.5"
+        end
+      end
+    end
+    """
+
+  Scenario: Generate ssh config
+    When I run taketo --generate-ssh-config
+    Then the output should contain exactly:
+      """
+      Host bar.foo.com
+      Hostname bar.foo.com
+      Port 5678
+      User pivo
+      IdentityFile ~/.ssh/id_rsa
+
+      Host bazqux
+      Hostname 2.3.4.5
+
+      """
+

data/lib/taketo/ssh_config_generator_visitor.rb

@@ -0,0 +1,36 @@
+require 'taketo/config_visitor'
+
+module Taketo
+  class SSHConfigGeneratorVisitor < ConfigVisitor
+    def initialize
+      @result = ""
+    end
+
+    visit Server do |server|
+      put "Host #{server.global_alias || server.host}"
+      put "Hostname #{server.host}"
+      put_optional "Port", server.port
+      put_optional "User", server.username
+      put_optional "IdentityFile", server.identity_file
+      put
+    end
+
+    visit Object do |_|
+      # catch all
+    end
+
+    def result
+      @result.chomp
+    end
+
+    private
+
+    def put(str = "")
+      @result += str + "\n"
+    end
+
+    def put_optional(str, value)
+      put "#{str} #{value}" if value
+    end
+  end
+end

data/lib/taketo.rb

@@ -8,5 +8,4 @@ require 'taketo/dsl'
 require 'taketo/commands'
 require 'taketo/config_traverser'
 require 'taketo/config_validator'
-require 'taketo/config_printer_visitor'
 

data/spec/lib/taketo/ssh_config_generator_visitor_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'taketo/ssh_config_generator_visitor'
+
+include Taketo
+
+describe "SSHConfigGeneratorVisitor" do
+  subject(:generator) { SSHConfigGeneratorVisitor.new }
+
+  describe "#visit_server" do
+    let(:server) { stub(:Server, :name => :sponge, :host => "bar.foo.com", :port => nil, :username => nil, :identity_file => nil, :global_alias => nil) }
+
+    it "renders available server info" do
+      server.stub(:port => 8000, :username => "bob", :identity_file => "path_to_identity_file")
+      generator.visit_server(server)
+      expect(generator.result).to include(<<-SSH.chomp)
+Host bar.foo.com
+Hostname bar.foo.com
+Port 8000
+User bob
+IdentityFile path_to_identity_file
+SSH
+    end
+
+    it "skips undefined options" do
+      generator.visit_server(server)
+      expect(generator.result).to include(<<-SSH.chomp)
+Host bar.foo.com
+Hostname bar.foo.com
+SSH
+    end
+
+    it "prefers global alias as Hostname" do
+      server.stub(:global_alias => "bazqux")
+      generator.visit_server(server)
+      expect(generator.result).to include(<<-SSH.chomp)
+Host bazqux
+Hostname bar.foo.com
+SSH
+    end
+  end
+
+  it "ignores non-server nodes" do
+    expect { generator.visit(1) }.not_to raise_error(/visit/)
+  end
+
+end
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taketo
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -102,6 +102,7 @@ files:
 - lib/taketo/constructs_factory.rb
 - lib/taketo/destination_resolver.rb
 - lib/taketo/dsl.rb
+- lib/taketo/ssh_config_generator_visitor.rb
 - lib/taketo/support/key_error.rb
 - lib/taketo/support/named_nodes_collection.rb
 - lib/taketo/support.rb
@@ -122,6 +123,7 @@ files:
 - spec/lib/taketo/constructs_factory_spec.rb
 - spec/lib/taketo/destination_resolver_spec.rb
 - spec/lib/taketo/dsl_spec.rb
+- spec/lib/taketo/ssh_config_generator_visitor_spec.rb
 - spec/lib/taketo/support/named_nodes_collection_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers/construct_spec_helper.rb
@@ -135,6 +137,7 @@ files:
 - features/connect_to_server.feature
 - features/default_server_config.feature
 - features/error_handling.feature
+- features/generate_ssh_config.feature
 - features/help.feature
 - features/step_definitions/main_steps.rb
 - features/support/env.rb