console-vmc-plugin 0.0.1

data/Rakefile

@@ -0,0 +1,47 @@
+require "rake"
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "console-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 console-vmc-plugin.gemspec"
+end
+
+task :install => :build do
+  sh "gem install --local console-vmc-plugin-#{VMCConsole::VERSION}.gem"
+end
+
+task :uninstall do
+  sh "gem uninstall console-vmc-plugin"
+end
+
+task :reinstall => [:uninstall, :install]
+
+task :release => :build do
+  sh "gem push console-vmc-plugin-#{VMCConsole::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/lib/console-vmc-plugin/console.rb

@@ -0,0 +1,171 @@
+require "net/telnet"
+require "readline"
+
+require "tunnel-vmc-plugin/tunnel"
+
+
+class CFConsole < CFTunnel
+  def initialize(client, app, port = 10000)
+    @client = client
+    @app = app
+    @port = port
+  end
+
+  def get_connection_info(auth)
+    unless console = @app.instances[0].console
+      raise "App does not have console access; try restarting it."
+    end
+
+    { "hostname" => console[:ip],
+      "port" => console[:port]
+    }
+  end
+
+  def get_credentials
+    YAML.load(@app.file("app", "cf-rails-console", ".consoleaccess"))
+  end
+
+  def start_console
+    prompt = login
+
+    init_readline
+
+    run_console prompt
+  end
+
+  def login(auth = get_credentials)
+    if !auth["username"] || !auth["password"]
+      raise "Unable to verify console credentials."
+    end
+
+    @telnet = telnet_client
+
+    prompt = nil
+    err_msg = "Login attempt timed out."
+
+    5.times do
+      begin
+        results = @telnet.login(
+          "Name" => auth["username"],
+          "Password" => auth["password"])
+
+        lines = results.sub("Login: Password: ", "").split("\n")
+
+        last_line = lines.pop
+
+        if last_line =~ /[$%#>] \z/n
+          prompt = last_line
+        elsif last_line =~ /Login failed/
+          err_msg = last_line
+        end
+
+        break
+
+      rescue TimeoutError
+        sleep 1
+
+      rescue EOFError
+        # This may happen if we login right after app starts
+        close_console
+        sleep 5
+        @telnet = telnet_client
+      end
+    end
+
+    unless prompt
+      close_console
+      raise err_msg
+    end
+
+    prompt
+  end
+
+  private
+
+  def init_readline
+    if Readline.respond_to?("basic_word_break_characters=")
+      Readline.basic_word_break_characters= " \t\n`><=;|&{("
+    end
+
+    Readline.completion_append_character = nil
+
+    # Assumes that sending a String ending with tab will return a non-empty
+    # String of comma-separated completion options, terminated by a new line
+    # For example, "app.\t" might result in "to_s,nil?,etc\n"
+    Readline.completion_proc = proc do |s|
+      console_tab_completion_data(s)
+    end
+  end
+
+  def run_console(prompt)
+    prev = trap("INT")  { |x| exit_console; prev.call(x); exit }
+    prev = trap("TERM") { |x| exit_console; prev.call(x); exit }
+
+    loop do
+      cmd = readline_with_history(prompt)
+
+      if cmd == nil
+        exit_console
+        break
+      end
+
+      prompt = send_console_command_display_results(cmd, prompt)
+    end
+  end
+
+  def readline_with_history(prompt)
+    line = Readline::readline(prompt)
+
+    return if line == nil || line == 'quit' || line == 'exit'
+
+    if line !~ /^\s*$/ && Readline::HISTORY.to_a[-1] != line
+      Readline::HISTORY.push(line)
+    end
+
+    line
+  end
+
+  def send_console_command_display_results(cmd, prompt)
+    begin
+      lines = send_console_command cmd
+
+      # Assumes the last line is a prompt
+      prompt = lines.pop
+
+      lines.each do |line|
+        puts line if line != cmd
+      end
+
+    rescue TimeoutError
+      puts "Timed out sending command to server."
+
+    rescue EOFError
+      raise "The console connection has been terminated. Perhaps the app was stopped or deleted?"
+    end
+
+    prompt
+  end
+
+  def send_console_command(cmd)
+    results = @telnet.cmd(cmd)
+    results.split("\n")
+  end
+
+  def exit_console
+    # TimeoutError expected, as exit doesn't return anything
+    @telnet.cmd("String" => "exit", "Timeout" => 1) rescue TimeoutError
+    close_console
+  end
+
+  def close_console
+    @telnet.close
+  end
+
+  def telnet_client
+    Net::Telnet.new(
+      "Port" => @port,
+      "Prompt" => /[$%#>] \z|Login failed/n,
+      "Timeout" => 30,
+      "FailEOF" => true)
+  end
+end

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

@@ -0,0 +1,33 @@
+require "vmc/plugin"
+require "console-vmc-plugin/console"
+
+module VMCConsole
+  class Console < VMC::CLI
+    desc "Open a console connected to your app"
+    group :apps, :manage
+    input :app, :argument => :required, :from_given => by_name("app"),
+      :desc => "App to connect to"
+    input :port, :default => 10000
+    def console
+      app = input[:app]
+
+      console = CFConsole.new(client, app)
+      port = console.pick_port!(input[:port])
+
+      with_progress("Opening console on port #{c(port, :name)}") do
+        console.open!
+        console.wait_for_start
+      end
+
+      console.start_console
+    end
+
+    filter(:start, :start_app) do |app|
+      if !v2? && app.framework.name == "rails3"
+        app.console = true
+      end
+
+      app
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module VMCConsole
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: console-vmc-plugin
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alex Suraci
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tunnel-vmc-plugin
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+- asuraci@vmware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/console-vmc-plugin/console.rb
+- lib/console-vmc-plugin/plugin.rb
+- lib/console-vmc-plugin/version.rb
+homepage: http://cloudfoundry.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: console-vmc-plugin
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Port of rails-console to vmc-ng.
+test_files: []
+