console-cf-plugin 0.2.0.rc1

data/Rakefile

@@ -0,0 +1,38 @@
+require "rake"
+require "rspec/core/rake_task"
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "console-cf-plugin/version"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+namespace :deploy do
+  def last_staging_sha
+    `git rev-parse latest-staging`.strip
+  end
+
+  def last_release_sha
+    `git rev-parse latest-release`.strip
+  end
+
+  def last_staging_ref_was_released?
+    last_staging_sha == last_release_sha
+  end
+
+  task :staging, :version do |_, args|
+    sh "gem bump --push #{"--version #{args.version}" if args.version}" if last_staging_ref_was_released?
+    sh "git tag -f latest-staging"
+    sh "git push origin :latest-staging"
+    sh "git push origin latest-staging"
+  end
+
+  task :gem do
+    sh "git fetch"
+    sh "git checkout #{last_staging_sha}"
+    sh "gem release --tag"
+    sh "git tag -f latest-release"
+    sh "git push origin :latest-release"
+    sh "git push origin latest-release"
+  end
+end

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

@@ -0,0 +1,188 @@
+require "net/telnet"
+require "readline"
+
+require "tunnel-cf-plugin/tunnel"
+
+
+class CFConsole < CFTunnel
+  def initialize(client, app, port = 10000)
+    @client = client
+    @app = app
+    @port = port
+  end
+
+  def get_connection_info(auth)
+    instances = @app.instances
+    if instances.empty?
+      raise "App has no running instances; try starting it."
+    end
+
+    unless console = 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
+    @telnet.cmd("String" => "exit", "Timeout" => 1)
+  rescue TimeoutError
+    # TimeoutError expected, as exit doesn't return anything
+  ensure
+    close_console
+  end
+
+  def close_console
+    @telnet.close
+  end
+
+  def console_tab_completion_data(cmd)
+    begin
+      results = @telnet.
+          cmd("String" => cmd + "\t", "Match" => /\S*\n$/, "Timeout" => 10)
+      results.chomp.split(",")
+    rescue TimeoutError
+      [] #Just return empty results if timeout occurred on tab completion
+    end
+  end
+
+  def telnet_client
+    Net::Telnet.new(
+      "Port" => @port,
+      "Prompt" => /[$%#>] \z|Login failed/n,
+      "Timeout" => 30,
+      "FailEOF" => true)
+  end
+end

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

@@ -0,0 +1,33 @@
+require "cf/plugin"
+require "console-cf-plugin/console"
+
+module CFConsolePlugin
+  class Console < CF::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 app.framework.name == "rails3" || app.framework.name == "buildpack"
+        app.console = true
+      end
+
+      app
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module CFConsolePlugin
+  VERSION = "0.2.0.rc1".freeze
+end

data/spec/assets/rails328_ruby187_app/Gemfile

@@ -0,0 +1,39 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.8'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+gem 'json'
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer', :platforms => :ruby
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug'

data/spec/assets/rails328_ruby187_app/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.