console-websocket-cf-plugin 0.0.1

data/README.md

@@ -0,0 +1,8 @@
+### console-websocket-cf-plugin
+
+This is a [CF](https://github.com/cloudfoundry/cf) plugin for connecting to the STDIN / STDOUT of a remote process (rails console for example) on Cloud Foundry whilst simultaneously running the intended application in the same container.
+It uses a binary written in Go on the server side to provide the websocket connection and also serve the application itself, if you wish to serve that up too.
+
+## TL;DR Rails example
+
+1. Install the Gem

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

@@ -0,0 +1 @@
+require 'console-websocket-cf-plugin/plugin'

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

@@ -0,0 +1,95 @@
+require 'console-websocket-cf-plugin'
+require 'eventmachine'
+require 'termios'
+require 'stringio'
+require 'base64'
+require 'json'
+require 'zlib'
+require 'faye/websocket'
+
+module ConsoleWebsocketCfPlugin
+
+  include EM::Protocols::LineText2
+
+  class KeyboardHandler < EM::Connection
+    
+    include EM::Protocols::LineText2
+
+    def initialize(ws, guid)
+      @ws = ws
+      @guid = guid
+      @buffer = ''
+    end
+
+    def receive_line(data)
+      EM.stop if data == "exit"
+      @ws.lines_in << data
+      @ws.send data.gsub("\n", "")
+    end
+
+    def move_history(direction)
+      puts direction
+    end
+
+  end
+    
+  class Plugin < CF::CLI
+    
+    def precondition
+      # skip all default preconditions
+    end
+
+    desc "Open a console to an application container"
+    group :admin
+    input :app, :desc => "Application to connect to", :argument => true,
+          :from_given => by_name(:app)
+    input :instance, :desc => "Instance (index) to connect", :default => 0
+
+    def console
+
+      app = input[:app]
+
+      app_version = app.manifest[:entity][:version]
+      guid = "#{app_version}/#{input[:instance]}"
+      ws_url = "wss://#{app.url}:4443/#{guid}"
+
+      puts "Starting connection to #{ws_url}"
+
+      start_connection(app, guid, ws_url)
+
+    end
+
+    private
+
+    def start_connection(app, guid, ws_url)
+      
+      EM.run {
+
+        Faye::WebSocket::Client.class_eval <<-BYTES_IN
+          attr_accessor :lines_in
+        BYTES_IN
+
+        ws = Faye::WebSocket::Client.new(ws_url, nil, { :headers => { 'Origin' => "http://#{app.url}:4443" }})
+        ws.lines_in = []
+
+        ws.on :error do |event|
+          p [:error]
+          p ws.status
+        end
+
+        ws.on :message do |event|
+          print event.data unless event.data.strip == ws.lines_in.last
+        end
+
+        ws.on :close do |event|
+          ws = nil
+          EM.stop
+        end
+        
+        EM.open_keyboard(KeyboardHandler, ws, guid)
+      }
+
+    end
+
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: console-websocket-cf-plugin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- GoPivotal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cf
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-termios
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: CF command line extension to allow console access to an app container
+  via a secure WebSocket
+email: support@cloudfoundry.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/console-websocket-cf-plugin.rb
+- lib/console-websocket-cf-plugin/plugin.rb
+- README.md
+homepage: https://github.com/danhigham/console-websocket-cf-plugin
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: CF WebSocket Console
+test_files: []