tunnel-vmc-plugin 0.1.3 → 0.1.4

data/Rakefile

@@ -1 +1,47 @@
-require "bundler/gem_tasks"
+require "rake"
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "tunnel-vmc-plugin/version"
+
+task :default => :spec
+
+desc "Run specs"
+task :spec => ["bundler:install", "test:spec"]
+
+desc "Run integration tests"
+task :test => ["bundler:install", "test:integration"]
+
+task :build do
+  sh "gem build tunnel-vmc-plugin.gemspec"
+end
+
+task :install => :build do
+  sh "gem install --local tunnel-vmc-plugin-#{VMCTunnel::VERSION}.gem"
+end
+
+task :uninstall do
+  sh "gem uninstall tunnel-vmc-plugin"
+end
+
+task :reinstall => [:uninstall, :install]
+
+task :release => :build do
+  sh "gem push tunnel-vmc-plugin-#{VMCTunnel::VERSION}.gem"
+end
+
+namespace "bundler" do
+  desc "Install gems"
+  task "install" do
+    sh("bundle install")
+  end
+end
+
+namespace "test" do
+  task "spec" do |t|
+    # nothing
+  end
+
+  task "integration" do |t|
+    sh("cd spec && bundle exec rake spec")
+  end
+end

data/helper-app/Gemfile.lock

@@ -12,7 +12,7 @@ GEM
       em-websocket (= 0.3.1)
       json (= 1.6.1)
       uuidtools (= 2.1.2)
-    daemons (1.1.4)
+    daemons (1.1.8)
     em-http-request (0.3.0)
       addressable (>= 2.0.0)
       escape_utils
@@ -23,11 +23,11 @@ GEM
     escape_utils (0.2.4)
     eventmachine (0.12.10)
     json (1.6.1)
-    rack (1.2.4)
-    sinatra (1.2.7)
+    rack (1.2.5)
+    sinatra (1.2.8)
       rack (~> 1.1)
       tilt (>= 1.2.2, < 2.0)
-    thin (1.2.11)
+    thin (1.4.1)
       daemons (>= 1.0.9)
       eventmachine (>= 0.12.6)
       rack (>= 1.0.0)

data/lib/tunnel-vmc-plugin/plugin.rb

@@ -1,69 +1,178 @@
-require "vmc/plugin"
+require "vmc/cli"
 require "tunnel-vmc-plugin/tunnel"
 
-VMC.Plugin(VMC::Service) do
-  include VMCTunnel
+module VMCTunnel
+  class Tunnel < VMC::CLI
+    CLIENTS_FILE = "#{VMC::CONFIG_DIR}/tunnel-clients.yml"
+    STOCK_CLIENTS = File.expand_path("../../../config/clients.yml", __FILE__)
 
-  desc "tunnel [SERVICE] [CLIENT]", "Create a local tunnel to a service."
-  group :services, :manage
-  flag(:service) { |choices|
-    ask("Which service?", :choices => choices)
-  }
-  flag(:client)
-  flag(:port, :default => 10000)
-  def tunnel(service = nil, client_name = nil)
-    client_name ||= input(:client)
-
-    services = client.services
+    desc "Create a local tunnel to a service."
+    group :services, :manage
+    input(:instance, :argument => :optional,
+          :from_given => find_by_name("service instance"),
+          :desc => "Service instance to tunnel to") { |instances|
+      ask("Which service instance?", :choices => instances,
+          :display => proc(&:name))
+    }
+    input(:client, :argument => :optional,
+          :desc => "Client to automatically launch") { |clients|
+      if clients.empty?
+        "none"
+      else
+        ask("Which client would you like to start?",
+            :choices => clients.keys.unshift("none"))
+      end
+    }
+    input(:port, :default => 10000, :desc => "Port to bind the tunnel to")
+    def tunnel(input)
+      instances = client.service_instances
+      fail "No services available for tunneling." if instances.empty?
 
-    fail "No services available for tunneling." if services.empty?
+      instance = input[:instance, instances.sort_by(&:name)]
+      clients = tunnel_clients[instance.vendor] || {}
+      client_name = input[:client, clients]
 
-    service ||= input(:service, services.collect(&:name).sort)
+      tunnel = CFTunnel.new(client, instance)
+      port = tunnel.pick_port!(input[:port])
 
-    info = services.find { |s| s.name == service }
+      conn_info =
+        with_progress("Opening tunnel on port #{c(port, :name)}") do
+          tunnel.open!
+        end
 
-    fail "Unknown service '#{service}'" unless info
+      if client_name == "none"
+        unless simple_output?
+          line
+          display_tunnel_connection_info(conn_info)
 
-    clients = tunnel_clients[info.vendor] || {}
+          line
+          line "Open another shell to run command-line clients or"
+          line "use a UI tool to connect using the displayed information."
+          line "Press Ctrl-C to exit..."
+        end
 
-    unless client_name
-      if clients.empty?
-        client_name = "none"
+        tunnel.wait_for_end
       else
-        client_name = ask(
-          "Which client would you like to start?",
-          :choices => ["none"] + clients.keys)
+        with_progress("Waiting for local tunnel to become available") do
+          tunnel.wait_for_start
+        end
+
+        unless start_local_prog(clients, client_name, conn_info, port)
+          fail "'#{client_name}' execution failed; is it in your $PATH?"
+        end
       end
     end
 
-    tunnel = CFTunnel.new(client, info)
-    port = tunnel.pick_port!(input(:port))
+    private
+
+    def display_tunnel_connection_info(info)
+      line "Service connection info:"
 
-    conn_info =
-      with_progress("Opening tunnel on port #{c(port, :name)}") do
-        tunnel.open!
+      to_show = [nil, nil, nil] # reserved for user, pass, db name
+      info.keys.each do |k|
+        case k
+        when "host", "hostname", "port", "node_id"
+          # skip
+        when "user", "username"
+          # prefer "username" over "user"
+          to_show[0] = k unless to_show[0] == "username"
+        when "password"
+          to_show[1] = k
+        when "name"
+          to_show[2] = k
+        else
+          to_show << k
+        end
       end
+      to_show.compact!
 
-    if client_name == "none"
-      unless simple_output?
-        puts ""
-        display_tunnel_connection_info(conn_info)
+      align_len = to_show.collect(&:size).max + 1
 
-        puts ""
-        puts "Open another shell to run command-line clients or"
-        puts "use a UI tool to connect using the displayed information."
-        puts "Press Ctrl-C to exit..."
+      indented do
+        to_show.each do |k|
+          # TODO: modify the server services rest call to have explicit knowledge
+          # about the items to return.  It should return all of them if
+          # the service is unknown so that we don't have to do this weird
+          # filtering.
+          line "#{k.ljust align_len}: #{b(info[k])}"
+        end
       end
 
-      tunnel.wait_for_end
-    else
-      with_progress("Waiting for local tunnel to become available") do
-        tunnel.wait_for_start
+      line
+    end
+
+    def start_local_prog(clients, command, info, port)
+      client = clients[File.basename(command)]
+
+      cmdline = "#{command} "
+
+      case client
+      when Hash
+        cmdline << resolve_symbols(client["command"], info, port)
+        client["environment"].each do |e|
+          if e =~ /([^=]+)=(["']?)([^"']*)\2/
+            ENV[$1] = resolve_symbols($3, info, port)
+          else
+            fail "Invalid environment variable: #{e}"
+          end
+        end
+      when String
+        cmdline << resolve_symbols(client, info, port)
+      else
+        raise "Unknown client info: #{client.inspect}."
       end
 
-      unless start_local_prog(clients, client_name, conn_info, port)
-        fail "'#{client_name}' execution failed; is it in your $PATH?"
+      if verbose?
+        line
+        line "Launching '#{cmdline}'"
       end
+
+      system(cmdline)
+    end
+
+    def tunnel_clients
+      return @tunnel_clients if @tunnel_clients
+
+      stock = YAML.load_file(STOCK_CLIENTS)
+      clients = File.expand_path CLIENTS_FILE
+      if File.exists? clients
+        user = YAML.load_file(clients)
+        @tunnel_clients = deep_merge(stock, user)
+      else
+        @tunnel_clients = stock
+      end
+    end
+
+    def resolve_symbols(str, info, local_port)
+      str.gsub(/\$\{\s*([^\}]+)\s*\}/) do
+        sym = $1
+
+        case sym
+        when "host"
+          # TODO: determine proper host
+          "localhost"
+        when "port"
+          local_port
+        when "user", "username"
+          info["username"]
+        when /^ask (.+)/
+          ask($1)
+        else
+          info[sym] || raise("Unknown symbol in config: #{sym}")
+        end
+      end
+    end
+
+    def deep_merge(a, b)
+      merge = proc { |old, new|
+        if old === Hash && new === Hash
+          old.merge(new, &merge)
+        else
+          new
+        end
+      }
+
+      a.merge(b, &merge)
     end
   end
 end

data/lib/tunnel-vmc-plugin/tunnel.rb

@@ -1,4 +1,5 @@
 require "addressable/uri"
+require "restclient"
 
 require "caldecott"
 
@@ -89,12 +90,7 @@ class CFTunnel
   end
 
   def helper_auth
-    helper.env.each do |e|
-      name, val = e.split("=", 2)
-      return val if name == "CALDECOTT_AUTH"
-    end
-
-    nil
+    helper.env["CALDECOTT_AUTH"]
   end
 
   def helper_healthy?(token)
@@ -120,7 +116,7 @@ class CFTunnel
   end
 
   def helper_already_binds?
-    helper.services.include? @service.name
+    helper.binds? @service
   end
 
   def push_helper(token)
@@ -131,8 +127,8 @@ class CFTunnel
     app.url = "#{random_helper_url}.#{target_base}"
     app.total_instances = 1
     app.memory = 64
-    app.env = ["CALDECOTT_AUTH=#{token}"]
-    app.services = [@service.name] if @service
+    app.env = { "CALDECOTT_AUTH" => token }
+    app.services = [@service] if @service
     app.create!
 
     begin
@@ -171,7 +167,7 @@ class CFTunnel
   end
 
   def bind_to_helper
-    helper.bind(@service.name)
+    helper.bind(@service)
     helper.restart!
   end
 
@@ -213,7 +209,6 @@ class CFTunnel
 
         break
       rescue RestClient::Exception => e
-        p [e, e.to_s]
         sleep 1
       end
     end
@@ -288,116 +283,3 @@ class CFTunnel
     socket.close
   end
 end
-
-module VMCTunnel
-  CLIENTS_FILE = "#{VMC::CONFIG_DIR}/tunnel-clients.yml"
-  STOCK_CLIENTS = File.expand_path("../../../config/clients.yml", __FILE__)
-
-  def display_tunnel_connection_info(info)
-    puts "Service connection info:"
-
-    to_show = [nil, nil, nil] # reserved for user, pass, db name
-    info.keys.each do |k|
-      case k
-      when "host", "hostname", "port", "node_id"
-        # skip
-      when "user", "username"
-        # prefer "username" over "user"
-        to_show[0] = k unless to_show[0] == "username"
-      when "password"
-        to_show[1] = k
-      when "name"
-        to_show[2] = k
-      else
-        to_show << k
-      end
-    end
-    to_show.compact!
-
-    align_len = to_show.collect(&:size).max + 1
-
-    to_show.each do |k|
-      # TODO: modify the server services rest call to have explicit knowledge
-      # about the items to return.  It should return all of them if
-      # the service is unknown so that we don't have to do this weird
-      # filtering.
-      print "  #{k.ljust align_len}: #{b(info[k])}"
-    end
-
-    puts ""
-  end
-
-  def start_local_prog(clients, command, info, port)
-    client = clients[File.basename(command)]
-
-    cmdline = "#{command} "
-
-    case client
-    when Hash
-      cmdline << resolve_symbols(client["command"], info, port)
-      client["environment"].each do |e|
-        if e =~ /([^=]+)=(["']?)([^"']*)\2/
-          ENV[$1] = resolve_symbols($3, info, port)
-        else
-          raise "Invalid environment variable: #{e}"
-        end
-      end
-    when String
-      cmdline << resolve_symbols(client, info, port)
-    else
-      raise "Unknown client info: #{client.inspect}."
-    end
-
-    if verbose?
-      puts ""
-      puts "Launching '#{cmdline}'"
-    end
-
-    system(cmdline)
-  end
-
-  def tunnel_clients
-    return @tunnel_clients if @tunnel_clients
-
-    stock = YAML.load_file(STOCK_CLIENTS)
-    clients = File.expand_path CLIENTS_FILE
-    if File.exists? clients
-      user = YAML.load_file(clients)
-      @tunnel_clients = deep_merge(stock, user)
-    else
-      @tunnel_clients = stock
-    end
-  end
-
-  def resolve_symbols(str, info, local_port)
-    str.gsub(/\$\{\s*([^\}]+)\s*\}/) do
-      sym = $1
-
-      case sym
-      when "host"
-        # TODO: determine proper host
-        "localhost"
-      when "port"
-        local_port
-      when "user", "username"
-        info["username"]
-      when /^ask (.+)/
-        ask($1)
-      else
-        info[sym] || raise("Unknown symbol in config: #{sym}")
-      end
-    end
-  end
-
-  def deep_merge(a, b)
-    merge = proc { |old, new|
-      if old === Hash && new === Hash
-        old.merge(new, &merge)
-      else
-        new
-      end
-    }
-
-    a.merge(b, &merge)
-  end
-end

data/lib/tunnel-vmc-plugin/version.rb

@@ -1,3 +1,3 @@
 module VMCTunnel
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,81 +1,87 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tunnel-vmc-plugin
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.1.4
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 3
-  version: 0.1.3
 platform: ruby
-authors: 
+authors:
 - Alex Suraci
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-27 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: addressable
+date: 2012-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cfoundry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.18
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 2
-        - 6
+      - !ruby/object:Gem::Version
+        version: 0.3.18
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 2.2.6
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: eventmachine
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31098193
-        segments: 
-        - 1
-        - 0
-        - 0
-        - beta
+      - !ruby/object:Gem::Version
+        version: 2.2.6
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 1.0.0.beta
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: caldecott
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta
+- !ruby/object:Gem::Dependency
+  name: caldecott
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 0
-        - 0
-        - 5
+      - !ruby/object:Gem::Version
         version: 0.0.5
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
 description: 
-email: 
+email:
 - asuraci@vmware.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - Rakefile
 - lib/tunnel-vmc-plugin/plugin.rb
 - lib/tunnel-vmc-plugin/tunnel.rb
@@ -86,36 +92,26 @@ files:
 - config/clients.yml
 homepage: http://cloudfoundry.com/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: tunnel-vmc-plugin
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: External access to your services on Cloud Foundry via a Caldecott HTTP tunnel.
 test_files: []
-