rancher-shell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66bb59230b610598db1ad66b8254de106c83b108
+  data.tar.gz: 26954b7fc67e46751fa22b793f54c99382b7d083
+SHA512:
+  metadata.gz: d2e5d5f73dc438e3b6f1a8181189209d0711943c618d263ad3708006729171e5ba2996b6ea9936ea751573a68d96991ab56884c28bf08c6247badfda561a1f19
+  data.tar.gz: 0141f88a60a95ad47c95cbb9123ec1dcef5d54fe98d720a07c4aac46abc5cf2c3295d2ef97c1d2c544e0b04a22f96cf1762759e96df78fea1b7037e9d15cc503

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+.env
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at marc@marcqualie.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marc Qualie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# RancherShell
+
+A console utility for shelling into [Rancher](http://rancher.com) containers
+
+
+
+## Installation
+
+RancherShell runs as a binary on your system and only needs rubygems to be installed:
+
+``` ruby
+gem install rancher-shell
+```
+
+
+## Confguration
+
+Configuration files are loaded in the following order if they exist:
+
+- ~/.rancher-shell.yml
+- ./.rancher-shell.yml
+
+Files are merged using the following schema:
+
+``` yaml
+---
+project: 1a234
+projects:
+  - id: 1a234
+    name: "Production"
+    container: rails_web_1
+    api:
+      host: rancher.yourdomain.com
+      key: XXXXX
+      secret: XXXXX
+```
+
+
+## Usage
+
+After configuring you can shell into your container using a single command:
+
+``` shell
+rancher-shell
+```
+
+Run `rancher-shell --help` for full usage instructions
+
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcqualie/rancher-shell. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/rancher-shell

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.unshift 'lib'
+require 'rancher/shell/cli'
+
+Rancher::Shell::CLI.start

data/lib/rancher/shell/api.rb

@@ -0,0 +1,39 @@
+require 'net/http'
+require 'rancher/shell/api_response'
+
+module Rancher
+  module Shell
+    class Api
+
+      DEFAULT_OPTIONS = {
+        user: nil,
+        pass: nil,
+        host: 'rancher.example.com',
+      }
+
+      def initialize options = {}
+        @options = DEFAULT_OPTIONS.merge options
+      end
+
+      def get resource, data = nil, headers = {}
+        request :get, resource, nil, headers
+      end
+
+      def post resource, data, headers = {}
+        request :post, resource, data, headers
+      end
+
+      def request method_name, resource, data, headers
+        uri = URI "https://#{@options[:host]}/v1/#{resource}"
+        Net::HTTP.start uri.host, uri.port, use_ssl: true do |http|
+          method_class_name = "Net::HTTP::#{method_name.to_s.split('_').map(&:capitalize).join}"
+          method_class = Object.const_get method_class_name
+          request = method_class.new uri
+          request.basic_auth @options[:user], @options[:pass]
+          request.set_form_data data if method_name === :post
+          ApiResponse.new http.request request
+        end
+      end
+    end
+  end
+end

data/lib/rancher/shell/api_response.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+module Rancher
+  module Shell
+    class ApiResponse
+      def initialize http_response
+        @http_response = http_response
+      end
+
+      def body
+        @http_response.body
+      end
+
+      def json
+        JSON.parse body
+      end
+    end
+  end
+end

data/lib/rancher/shell/cli.rb

@@ -0,0 +1,120 @@
+require 'rancher/shell/api'
+require 'rancher/shell/logger_helper'
+require 'rancher/shell/websocket_client'
+require 'yaml'
+
+module Rancher
+  module Shell
+    class CLI
+      include LoggerHelper
+
+      def self.start
+        instance = self.new
+        instance.setup_api!
+        instance.retrieve_containers!
+        instance.setup_websocket!
+        instance.listen!
+      end
+
+      attr_reader :api, :websocket
+
+      def initialize
+        @config_file_paths = [
+          "#{ENV['HOME']}/.rancher-shell.yml",
+          "#{Dir.pwd}/.rancher-shell.yml",
+        ]
+        @config = {}
+        @config_file_paths.each do |file_path|
+          if File.exists? file_path
+            logger.debug "loading config from #{file_path}"
+            config = YAML.load_file(file_path)
+            logger.debug "  #{config}"
+            @config.merge! config
+          end
+        end
+        @projects = @config['projects']
+        @project = @config['projects'].find { |project| project['id'] === @config['project'] } || @config['projects'].first
+        logger.info "environment = #{@project['id']} - #{@project['name']}"
+        logger.debug "  #{@project}"
+        exit_with_error "API Host Required" unless @project['api'] && @project['api']['host']
+        exit_with_error "API Key Required" unless @project['api'] && @project['api']['key']
+        exit_with_error "API Secret Required" unless @project['api'] && @project['api']['secret']
+      end
+
+      def listen!
+        $stdin.each_line do |command|
+          if command.strip === 'exit'
+            logger.info "connection closed"
+            Kernel.exit true
+          end
+          @websocket.send Base64.encode64 command
+        end
+      end
+
+      def setup_api!
+        @api = Rancher::Shell::Api.new(
+          host: @project['api']['host'],
+          user: @project['api']['key'],
+          pass: @project['api']['secret'],
+        )
+      end
+
+      def retrieve_containers!
+        @response = @api.get(
+          "containers",
+        )
+        @containers = @response.json['data'].map do |container|
+          {
+            'id' => container['id'],
+            'name' => container['name'],
+            'state' => container['state'],
+            'ports' => container['ports'],
+          }
+        end
+        @container = @containers.find { |container| container['name'] === @project['container'] }
+        exit_with_error "could not find container: #{@project['container']}" unless @container
+      end
+
+      def setup_websocket!
+        logger.info "container = #{@container['id']}"
+        @response = @api.post(
+          "containers/#{@container['id']}?action=execute",
+          "command" => [
+            "/bin/sh",
+            "-c",
+            "TERM=xterm-256color; export TERM; [ -x /bin/bash ] && ([ -x /usr/bin/script ] && /usr/bin/script -q -c \"/bin/bash\" /dev/null || exec /bin/bash) || exec /bin/sh",
+          ],
+          "attachStdin" => true,
+          "attachStdout" => true,
+          "tty" => false,
+        )
+        websocket_url = "#{@response.json['url']}?token=#{@response.json['token']}"
+        logger.info "connecting to #{@response.json['url']} ..."
+        @websocket = Rancher::Shell::WebsocketClient.new websocket_url, headers: { 'Authorization' => "Bearer #{@response.json['token']}"}
+        @websocket.on :open do |event|
+          logger.info "  connected!"
+        end
+        @websocket.on :chunk do |encoded_chunk|
+          chunk = Base64.decode64 encoded_chunk
+          @buffer ||= ''
+          @buffer << chunk if chunk
+          if chunk.ord === 32
+            emit :message, @buffer
+            @buffer = ''
+          end
+        end
+        @websocket.on :message do |data|
+          $stdout.print data
+        end
+        @websocket.on :error do |event|
+          logger.error "socket error: #{event}"
+          Kernel.exit true
+        end
+        @websocket.on :close do
+          logger.error "closed connection"
+          Kernel.exit true
+        end
+      end
+    end
+  end
+end

data/lib/rancher/shell/logger.rb

@@ -0,0 +1,25 @@
+module Rancher
+  module Shell
+    class Logger
+      def debug message
+        $stdout.puts "[#{DateTime.now.strftime '%Y-%m-%d %H:%M:%S'}] DEBUG -- : #{message}"
+      end
+
+      def info message
+        $stdout.puts "[#{DateTime.now.strftime '%Y-%m-%d %H:%M:%S'}]  INFO -- : #{message}"
+      end
+
+      def error message
+        $stderr.puts "[#{DateTime.now.strftime '%Y-%m-%d %H:%M:%S'}] ERROR -- : #{message}"
+      end
+
+      def warn message
+        $stderr.puts "[#{DateTime.now.strftime '%Y-%m-%d %H:%M:%S'}]  WARN -- : #{message}"
+      end
+
+      def out message
+        $stdout.puts "[#{DateTime.now.strftime '%Y-%m-%d %H:%M:%S'}]       -- : #{message}"
+      end
+    end
+  end
+end

data/lib/rancher/shell/logger_helper.rb

@@ -0,0 +1,16 @@
+require 'rancher/shell/logger'
+
+module Rancher
+  module Shell
+    module LoggerHelper
+      def logger
+        @logger ||= Logger.new
+      end
+
+      def exit_with_error message
+        logger.error message
+        Kernel.exit false
+      end
+    end
+  end
+end

data/lib/rancher/shell/version.rb

@@ -0,0 +1,5 @@
+module Rancher
+  module Shell
+    VERSION = "0.1.0"
+  end
+end

data/lib/rancher/shell/websocket_client.rb

@@ -0,0 +1,100 @@
+require 'event_emitter'
+require 'rancher/shell/logger_helper'
+require 'websocket'
+
+module Rancher
+  module Shell
+    class WebsocketClient
+      include EventEmitter
+      include LoggerHelper
+      attr_reader :url, :handshake, :handshaked, :thread, :socket
+
+      def initialize url, options = {}
+        return if @socket
+        @url = url
+        uri = URI.parse url
+        @socket = TCPSocket.new(uri.host, uri.port || (uri.scheme == 'wss' ? 443 : 80))
+        if ['https', 'wss'].include? uri.scheme
+          ctx = OpenSSL::SSL::SSLContext.new
+          ctx.ssl_version = options[:ssl_version] || 'SSLv23'
+          ctx.verify_mode = options[:verify_mode] || OpenSSL::SSL::VERIFY_NONE #use VERIFY_PEER for verification
+          cert_store = OpenSSL::X509::Store.new
+          cert_store.set_default_paths
+          ctx.cert_store = cert_store
+          @socket = ::OpenSSL::SSL::SSLSocket.new(@socket, ctx)
+          @socket.connect
+        end
+        @handshake = ::WebSocket::Handshake::Client.new :url => url, :headers => options[:headers]
+        @handshaked = false
+        @pipe_broken = false
+        frame = ::WebSocket::Frame::Incoming::Client.new
+        @closed = false
+        once :__close do |err|
+          close
+          emit :close, err
+        end
+
+        @thread = Thread.new do
+          while !@closed do
+            begin
+              unless recv_data = @socket.getc
+                sleep 1
+                next
+              end
+              unless @handshaked
+                @handshake << recv_data
+                if @handshake.finished?
+                  @handshaked = true
+                  emit :open
+                end
+              else
+                frame << recv_data
+                while msg = frame.next
+                  emit :chunk, msg.to_s
+                end
+              end
+            rescue => e
+              puts "EMIT ERROR: #{e.to_yaml}"
+              emit :error, e
+            end
+          end
+          puts "THREAD IS DEAD"
+        end
+
+        @socket.write @handshake.to_s
+      end
+
+      def send(data, opt={:type => :text})
+        if !@handshaked or @closed
+          puts "closed socket.."
+          return
+        end
+        type = opt[:type]
+        frame = ::WebSocket::Frame::Outgoing::Client.new(:data => data, :type => type, :version => @handshake.version)
+        begin
+          @socket.write frame.to_s
+        rescue Errno::EPIPE => e
+          @pipe_broken = true
+          emit :__close, e
+        end
+      end
+
+      def close
+        return if @closed
+        if !@pipe_broken
+          send nil, :type => :close
+        end
+        @closed = true
+        @socket.close if @socket
+        @socket = nil
+        emit :__close
+        Thread.kill @thread if @thread
+      end
+
+      def open?
+        @handshake.finished? and !@closed
+      end
+
+    end
+  end
+end

data/lib/rancher/shell.rb

@@ -0,0 +1,6 @@
+require 'rancher/shell/version'
+
+module Rancher
+  module Shell
+  end
+end

data/rancher-shell.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rancher/shell/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rancher-shell"
+  spec.version       = Rancher::Shell::VERSION
+  spec.authors       = ["Marc Qualie"]
+  spec.email         = ["marc@marcqualie.com"]
+
+  spec.summary       = "A console utility for shelling into Rancher containers"
+  spec.homepage      = "https://github.com/marcqualie/rancher-shell"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             "websocket", "~> 1.2"
+  spec.add_dependency             "event_emitter", "~> 0.2.5"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: rancher-shell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marc Qualie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: event_emitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email:
+- marc@marcqualie.com
+executables:
+- rancher-shell
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rancher-shell
+- lib/rancher/shell.rb
+- lib/rancher/shell/api.rb
+- lib/rancher/shell/api_response.rb
+- lib/rancher/shell/cli.rb
+- lib/rancher/shell/logger.rb
+- lib/rancher/shell/logger_helper.rb
+- lib/rancher/shell/version.rb
+- lib/rancher/shell/websocket_client.rb
+- rancher-shell.gemspec
+homepage: https://github.com/marcqualie/rancher-shell
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A console utility for shelling into Rancher containers
+test_files: []