console-cf-plugin 0.2.0.rc1

data/spec/console_spec.rb

@@ -0,0 +1,190 @@
+require "spec_helper"
+require "console-cf-plugin/plugin"
+
+describe "CFConsole" do
+  before do
+    @app = mock("app")
+    @console = CFConsole.new(nil, @app)
+  end
+
+  it "should return connection info for apps that have a console ip and port" do
+    instance = mock("instance")
+    mock(@app).instances { [instance] }
+    mock(instance).console { {:ip => "192.168.1.1", :port => 3344} }
+
+    @console.get_connection_info(nil).should == {
+      "hostname" => "192.168.1.1",
+      "port" => 3344
+    }
+  end
+
+  it "should raise error when no app instances found" do
+    mock(@app).instances { [] }
+
+    expect {
+      @console.get_connection_info(nil)
+    }.to raise_error("App has no running instances; try starting it.")
+  end
+
+  it "should raise error when app does not have console access" do
+    instance = mock("instance")
+    mock(@app).instances { [instance] }
+    mock(instance).console { nil }
+
+    expect {
+      @console.get_connection_info(nil)
+    }.to raise_error("App does not have console access; try restarting it.")
+  end
+
+  describe "start_console" do
+    before do
+      @creds = {
+        :path => %w(app cf-rails-console .consoleaccess),
+        :yaml => "username: cfuser\npassword: testpw",
+        :telnet => {"Name" => "cfuser", "Password" => "testpw"}
+      }
+    end
+
+    context "when console credentials cannot be obtained" do
+      it "should raise error" do
+        mock(@app).file(*@creds[:path]) { "username: cfuser" }
+
+        expect {
+          @console.start_console
+        }.to raise_error("Unable to verify console credentials.")
+      end
+    end
+
+    context "when console credentials can be obtained" do
+      before do
+        mock(@app).file(*@creds[:path]) { @creds[:yaml] }
+        @telnet = Object.new
+        mock(@console).telnet_client { @telnet }
+      end
+
+      it "should raise error if authentication fails" do
+        mock(@telnet).login(@creds[:telnet]) { "Login failed" }
+        mock(@telnet).close
+
+        expect { @console.start_console }.to raise_error("Login failed")
+      end
+
+      it "should retry authentication on timeout" do
+        mock(@telnet).login(@creds[:telnet]){ raise TimeoutError }
+        mock(@telnet).login(@creds[:telnet]) { "Switch to inspect mode\nirb():001:0> " }
+        verify_console_exit("irb():001:0> ")
+
+        @console.start_console
+      end
+
+      it "should retry authentication on EOF" do
+        mock(@console).telnet_client { @telnet }
+        mock(@telnet).login(@creds[:telnet]) { raise EOFError }
+        mock(@telnet).close
+        mock(@telnet).login(@creds[:telnet]) { "irb():001:0> " }
+        verify_console_exit("irb():001:0> ")
+
+        @console.start_console
+      end
+
+      it "should operate console interactively" do
+        mock(@telnet).login(@creds[:telnet]) { "irb():001:0> " }
+        mock(Readline).readline("irb():001:0> ") { "puts 'hi'" }
+        mock(Readline::HISTORY).push("puts 'hi'")
+        mock(@telnet).cmd("puts 'hi'") { "nil" + "\n" + "irb():002:0> " }
+        mock(@console).puts("nil")
+        verify_console_exit("irb():002:0> ")
+
+        @console.start_console
+      end
+
+      it "should not crash if command times out" do
+        mock(@telnet).login(@creds[:telnet]) { "irb():001:0> " }
+        mock(Readline).readline("irb():001:0> ") { "puts 'hi'" }
+        mock(Readline::HISTORY).push("puts 'hi'")
+        mock(@telnet).cmd("puts 'hi'") { raise TimeoutError }
+        mock(@console).puts("Timed out sending command to server.")
+        verify_console_exit("irb():001:0> ")
+
+        @console.start_console
+      end
+
+      it "should raise error if an EOF is received" do
+        mock(@telnet).login(@creds[:telnet]) { "Switch to inspect mode\nirb():001:0> " }
+        mock(Readline).readline("irb():001:0> ") { "puts 'hi'" }
+        mock(Readline::HISTORY).push("puts 'hi'")
+        mock(@telnet).cmd("puts 'hi'") { raise EOFError }
+
+        expect {
+          @console.start_console
+        }.to raise_error("The console connection has been terminated. Perhaps the app was stopped or deleted?")
+      end
+
+      it "should not keep blank lines in history" do
+        mock(@telnet).login(@creds[:telnet]) { "irb():001:0> " }
+        mock(Readline).readline("irb():001:0> ") { "" }
+        dont_allow(Readline::HISTORY).push("")
+        mock(@telnet).cmd("") { "irb():002:0*> " }
+        verify_console_exit("irb():002:0*> ")
+
+        @console.start_console
+      end
+
+      it "should not keep identical commands in history" do
+        mock(@telnet).login(@creds[:telnet]) { "irb():001:0> " }
+        mock(Readline).readline("irb():001:0> ") { "puts 'hi'" }
+        mock(Readline::HISTORY).to_a { ["puts 'hi'"] }
+        dont_allow(Readline::HISTORY).push("puts 'hi'")
+        mock(@telnet).cmd("puts 'hi'") { "nil" + "\n" + "irb():002:0> " }
+        mock(@console).puts("nil")
+        verify_console_exit("irb():002:0> ")
+
+        @console.start_console
+      end
+
+      it "should return tab completion data" do
+        mock(@telnet).login(@creds[:telnet]) { "Switch to inspect mode\nirb():001:0> " }
+        mock(@telnet).cmd("String" => "app.\t", "Match" => /\S*\n$/, "Timeout" => 10) { "to_s,nil?\n" }
+        verify_console_exit("irb():001:0> ")
+
+        @console.start_console
+        Readline.completion_proc.call("app.").should == ["to_s","nil?"]
+      end
+
+      it "should return tab completion data receiving empty completion string" do
+        mock(@telnet).login(@creds[:telnet]) { "irb():001:0> " }
+        mock(@telnet).cmd("String" => "app.\t", "Match" => /\S*\n$/, "Timeout" => 10) { "\n" }
+        verify_console_exit("irb():001:0> ")
+
+        @console.start_console
+        Readline.completion_proc.call("app.").should == []
+      end
+
+      it "should not crash on timeout of remote tab completion data" do
+        mock(@telnet).login(@creds[:telnet]) { "Switch to inspect mode\nirb():001:0> " }
+        mock(@telnet).cmd("String" => "app.\t", "Match" => /\S*\n$/, "Timeout" => 10) { raise TimeoutError }
+        verify_console_exit("irb():001:0> ")
+
+        @console.start_console
+        Readline.completion_proc.call("app.").should == []
+      end
+
+      it "should properly initialize Readline for tab completion" do
+        mock(@telnet).login(@creds[:telnet]) { "irb():001:0> " }
+        mock(Readline).respond_to?("basic_word_break_characters=") { true }
+        mock(Readline).basic_word_break_characters=(" \t\n`><=;|&{(")
+        mock(Readline).completion_append_character=(nil)
+        mock(Readline).completion_proc=(anything)
+        verify_console_exit("irb():001:0> ")
+
+        @console.start_console
+      end
+    end
+  end
+
+  def verify_console_exit(prompt)
+    mock(Readline).readline(prompt) { "exit" }
+    mock(@telnet).cmd("String" => "exit", "Timeout" => 1) { raise TimeoutError }
+    mock(@telnet).close
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+SPEC_ROOT = File.dirname(__FILE__).freeze
+
+require "rspec"
+require "cf"
+require "cfoundry"
+require "cfoundry/test_support"
+
+RSpec.configure do |c|
+  c.include Fake::FakeMethods
+  c.mock_with :rr
+end

metadata

@@ -0,0 +1,247 @@
+--- !ruby/object:Gem::Specification 
+name: console-cf-plugin
+version: !ruby/object:Gem::Version 
+  hash: 2807675789
+  prerelease: 6
+  segments: 
+  - 0
+  - 2
+  - 0
+  - rc
+  - 1
+  version: 0.2.0.rc1
+platform: ruby
+authors: 
+- Alex Suraci
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-03-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tunnel-cf-plugin
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 11
+        version: "2.11"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 9
+        version: "1.9"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id005
+description: 
+email: 
+- asuraci@vmware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/console-cf-plugin/console.rb
+- lib/console-cf-plugin/plugin.rb
+- lib/console-cf-plugin/version.rb
+- spec/assets/rails328_ruby187_app/app/assets/images/rails.png
+- spec/assets/rails328_ruby187_app/app/assets/javascripts/application.js
+- spec/assets/rails328_ruby187_app/app/assets/stylesheets/application.css
+- spec/assets/rails328_ruby187_app/app/controllers/application_controller.rb
+- spec/assets/rails328_ruby187_app/app/helpers/application_helper.rb
+- spec/assets/rails328_ruby187_app/app/views/layouts/application.html.erb
+- spec/assets/rails328_ruby187_app/config/application.rb
+- spec/assets/rails328_ruby187_app/config/boot.rb
+- spec/assets/rails328_ruby187_app/config/database.yml
+- spec/assets/rails328_ruby187_app/config/environment.rb
+- spec/assets/rails328_ruby187_app/config/environments/development.rb
+- spec/assets/rails328_ruby187_app/config/environments/production.rb
+- spec/assets/rails328_ruby187_app/config/environments/test.rb
+- spec/assets/rails328_ruby187_app/config/initializers/backtrace_silencers.rb
+- spec/assets/rails328_ruby187_app/config/initializers/inflections.rb
+- spec/assets/rails328_ruby187_app/config/initializers/mime_types.rb
+- spec/assets/rails328_ruby187_app/config/initializers/secret_token.rb
+- spec/assets/rails328_ruby187_app/config/initializers/session_store.rb
+- spec/assets/rails328_ruby187_app/config/initializers/wrap_parameters.rb
+- spec/assets/rails328_ruby187_app/config/locales/en.yml
+- spec/assets/rails328_ruby187_app/config/routes.rb
+- spec/assets/rails328_ruby187_app/config.ru
+- spec/assets/rails328_ruby187_app/db/seeds.rb
+- spec/assets/rails328_ruby187_app/doc/README_FOR_APP
+- spec/assets/rails328_ruby187_app/Gemfile
+- spec/assets/rails328_ruby187_app/manifest.yml
+- spec/assets/rails328_ruby187_app/public/404.html
+- spec/assets/rails328_ruby187_app/public/422.html
+- spec/assets/rails328_ruby187_app/public/500.html
+- spec/assets/rails328_ruby187_app/public/assets/application-7270767b2a9e9fff880aa5de378ca791.css
+- spec/assets/rails328_ruby187_app/public/assets/application-7270767b2a9e9fff880aa5de378ca791.css.gz
+- spec/assets/rails328_ruby187_app/public/assets/application-ccab98dc1abdf097c0af693e20aed861.js
+- spec/assets/rails328_ruby187_app/public/assets/application-ccab98dc1abdf097c0af693e20aed861.js.gz
+- spec/assets/rails328_ruby187_app/public/assets/application.css
+- spec/assets/rails328_ruby187_app/public/assets/application.css.gz
+- spec/assets/rails328_ruby187_app/public/assets/application.js
+- spec/assets/rails328_ruby187_app/public/assets/application.js.gz
+- spec/assets/rails328_ruby187_app/public/assets/manifest.yml
+- spec/assets/rails328_ruby187_app/public/assets/rails-be8732dac73d845ac5b142c8fb5f9fb0.png
+- spec/assets/rails328_ruby187_app/public/assets/rails.png
+- spec/assets/rails328_ruby187_app/public/favicon.ico
+- spec/assets/rails328_ruby187_app/public/index.html
+- spec/assets/rails328_ruby187_app/public/robots.txt
+- spec/assets/rails328_ruby187_app/Rakefile
+- spec/assets/rails328_ruby187_app/README.rdoc
+- spec/assets/rails328_ruby187_app/script/rails
+- spec/assets/rails328_ruby187_app/test/performance/browsing_test.rb
+- spec/assets/rails328_ruby187_app/test/test_helper.rb
+- spec/console_spec.rb
+- spec/spec_helper.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: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: console-cf-plugin
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Port of rails-console to cf-ng.
+test_files: 
+- spec/assets/rails328_ruby187_app/app/assets/images/rails.png
+- spec/assets/rails328_ruby187_app/app/assets/javascripts/application.js
+- spec/assets/rails328_ruby187_app/app/assets/stylesheets/application.css
+- spec/assets/rails328_ruby187_app/app/controllers/application_controller.rb
+- spec/assets/rails328_ruby187_app/app/helpers/application_helper.rb
+- spec/assets/rails328_ruby187_app/app/views/layouts/application.html.erb
+- spec/assets/rails328_ruby187_app/config/application.rb
+- spec/assets/rails328_ruby187_app/config/boot.rb
+- spec/assets/rails328_ruby187_app/config/database.yml
+- spec/assets/rails328_ruby187_app/config/environment.rb
+- spec/assets/rails328_ruby187_app/config/environments/development.rb
+- spec/assets/rails328_ruby187_app/config/environments/production.rb
+- spec/assets/rails328_ruby187_app/config/environments/test.rb
+- spec/assets/rails328_ruby187_app/config/initializers/backtrace_silencers.rb
+- spec/assets/rails328_ruby187_app/config/initializers/inflections.rb
+- spec/assets/rails328_ruby187_app/config/initializers/mime_types.rb
+- spec/assets/rails328_ruby187_app/config/initializers/secret_token.rb
+- spec/assets/rails328_ruby187_app/config/initializers/session_store.rb
+- spec/assets/rails328_ruby187_app/config/initializers/wrap_parameters.rb
+- spec/assets/rails328_ruby187_app/config/locales/en.yml
+- spec/assets/rails328_ruby187_app/config/routes.rb
+- spec/assets/rails328_ruby187_app/config.ru
+- spec/assets/rails328_ruby187_app/db/seeds.rb
+- spec/assets/rails328_ruby187_app/doc/README_FOR_APP
+- spec/assets/rails328_ruby187_app/Gemfile
+- spec/assets/rails328_ruby187_app/manifest.yml
+- spec/assets/rails328_ruby187_app/public/404.html
+- spec/assets/rails328_ruby187_app/public/422.html
+- spec/assets/rails328_ruby187_app/public/500.html
+- spec/assets/rails328_ruby187_app/public/assets/application-7270767b2a9e9fff880aa5de378ca791.css
+- spec/assets/rails328_ruby187_app/public/assets/application-7270767b2a9e9fff880aa5de378ca791.css.gz
+- spec/assets/rails328_ruby187_app/public/assets/application-ccab98dc1abdf097c0af693e20aed861.js
+- spec/assets/rails328_ruby187_app/public/assets/application-ccab98dc1abdf097c0af693e20aed861.js.gz
+- spec/assets/rails328_ruby187_app/public/assets/application.css
+- spec/assets/rails328_ruby187_app/public/assets/application.css.gz
+- spec/assets/rails328_ruby187_app/public/assets/application.js
+- spec/assets/rails328_ruby187_app/public/assets/application.js.gz
+- spec/assets/rails328_ruby187_app/public/assets/manifest.yml
+- spec/assets/rails328_ruby187_app/public/assets/rails-be8732dac73d845ac5b142c8fb5f9fb0.png
+- spec/assets/rails328_ruby187_app/public/assets/rails.png
+- spec/assets/rails328_ruby187_app/public/favicon.ico
+- spec/assets/rails328_ruby187_app/public/index.html
+- spec/assets/rails328_ruby187_app/public/robots.txt
+- spec/assets/rails328_ruby187_app/Rakefile
+- spec/assets/rails328_ruby187_app/README.rdoc
+- spec/assets/rails328_ruby187_app/script/rails
+- spec/assets/rails328_ruby187_app/test/performance/browsing_test.rb
+- spec/assets/rails328_ruby187_app/test/test_helper.rb
+- spec/console_spec.rb
+- spec/spec_helper.rb