rancher-shell 0.1.0 → 0.2.1

checksums.yaml

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

data/.gitignore

@@ -2,3 +2,4 @@
 .env
 Gemfile.lock
 *.gem
+.rancher-shell.yml

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+
+
+## [0.2.1] - 2016-03-06
+
+### Added
+
+- Commands: list-projects, list-containers
+- Multi level configuration including root, project and stack level customization
+- Custom command on boot rather than always using /bin/bash
+
+### Changed
+- Input is sent to containers in real-time instead of line by line
+- Commands such as CTRL+C can now be sent to containers without killing the shell session
+
+### Fixed
+- BUG: Commands are no longer duplicated back to client due to local buffer caching
+
+
+
+## [0.1.0] - 2016-02-23
+
+### Added
+- Session can now be created entirely from rancher-shell.yml

data/README.md

@@ -1,5 +1,8 @@
 # RancherShell
 
+[![Gem Version](https://badge.fury.io/rb/rancher-shell.svg)](https://badge.fury.io/rb/rancher-shell)
+[![Build Status](https://travis-ci.org/marcqualie/rancher-shell.svg?branch=master)](https://travis-ci.org/marcqualie/rancher-shell)
+
 A console utility for shelling into [Rancher](http://rancher.com) containers
 
 
@@ -24,27 +27,49 @@ Files are merged using the following schema:
 
 ``` yaml
 ---
-project: 1a234
+# ~/.rancher-shell.yml
 projects:
-  - id: 1a234
-    name: "Production"
-    container: rails_web_1
+  project1:
+    name: "My First Project"
+    options:
+      container: production_web_1
+      command: bundle exec rails console
+    stacks:
+      staging:
+        options:
+          container: staging_web_1
     api:
       host: rancher.yourdomain.com
       key: XXXXX
       secret: XXXXX
 ```
 
+``` yaml
+---
+# /path/to/project1/.rancher-shell.yml
+options:
+  project: project1
+projects:
+  project1:
+    stacks:
+      qa:
+        options:
+          container: qa_web_1
+```
+
+Running `rancher-shell exec` with the above config will run command `bundle exec rails console` on `project1` within container `production_web_1`. Running `rancher-shell exec -s staging` will run the same command but within container `staging_web_1`. Full usage instructions on how to override these configs is at `rancher-shell help exec`.
+
+
 
 ## Usage
 
-After configuring you can shell into your container using a single command:
+After configuring you can shell into your container using the following command:
 
 ``` shell
-rancher-shell
+rancher-shell exec [-p project] [-s stack] [-c container] [command]
 ```
 
-Run `rancher-shell --help` for full usage instructions
+Run `rancher-shell help` for full usage instructions
 
 
 

data/bin/rancher-shell

@@ -2,4 +2,4 @@
 $:.unshift 'lib'
 require 'rancher/shell/cli'
 
-Rancher::Shell::CLI.start
+Rancher::Shell::CLI.start ARGV

data/lib/rancher/shell/cli.rb

@@ -1,118 +1,68 @@
-require 'rancher/shell/api'
-require 'rancher/shell/logger_helper'
-require 'rancher/shell/websocket_client'
-require 'yaml'
+require 'rancher/shell/commands/exec'
+require 'rancher/shell/config'
+require 'rancher/shell/version'
+require 'thor'
 
 module Rancher
   module Shell
-    class CLI
-      include LoggerHelper
+    class CLI < Thor
+      map %w[-v --version] => :version
+      desc 'version', 'display gem version'
+      def version
+        puts "Rancher::Shell #{Rancher::Shell::VERSION}"
+      end
 
-      def self.start
-        instance = self.new
+      desc "exec [COMMAND]", "Execute a command within a docker container"
+      option :project, aliases: '-p'
+      option :container, aliases: '-c'
+      option :stack, aliases: '-s'
+      def exec command = nil
+        Config.load(
+          'project' => options[:project],
+          'container' => options[:container],
+          'stack' => options[:stack],
+          'command' => command,
+        )
+        instance = Rancher::Shell::Commands::Exec.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
+      desc "list-projects", "List all projects available via configuration"
+      def list_projects
+        Config.load
+        projects = Config.get('projects')
+        projects.each do |key, project|
+          print key.ljust 24
+          print project['name'].ljust 32
+          print project['api']['host'].ljust 32
+          print project['stacks'].keys.join(', ') unless project['stacks'].nil?
+          print "\n"
         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",
+      desc "list-containers", "List all containers available within a project"
+      option :project, aliases: '-p'
+      def list_containers
+        Config.load(
+          'project' => options[:project],
         )
-        @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,
+        project = Config.get('project')
+        api = Rancher::Shell::Api.new(
+          host: project['api']['host'],
+          user: project['api']['key'],
+          pass: project['api']['secret'],
         )
-        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
+        containers = api.get('containers?state=running').json['data']
+        containers.each do |container|
+          print container['id'].ljust 12
+          print container['state'].ljust 12
+          print container['name'].ljust 40
+          print container['imageUuid'][7..-1].ljust 48
+          print container['ports'] if container['ports'] && container['ports'] != ''
+          print "\n"
         end
       end
     end

data/lib/rancher/shell/commands/exec.rb

@@ -0,0 +1,101 @@
+require 'rancher/shell/api'
+require 'rancher/shell/logger_helper'
+require 'rancher/shell/websocket_client'
+
+module Rancher
+  module Shell
+    module Commands
+      class Exec
+        include LoggerHelper
+
+        attr_reader :api, :websocket
+
+        def initialize
+          @config = Config.get_all
+          logger.debug "config = #{@config}"
+          exit_with_error "Project not found: #{@config['project']}" unless @config['project']
+          exit_with_error "Command not specified" unless @config['options']['command'] && @config['options']['command'] != ''
+          exit_with_error "Container not specified" unless @config['options']['container'] && @config['options']['container'] != ''
+          exit_with_error "API Host Required" unless @config['project']['api'] && @config['project']['api']['host']
+          exit_with_error "API Key Required" unless @config['project']['api'] && @config['project']['api']['key']
+          exit_with_error "API Secret Required" unless @config['project']['api'] && @config['project']['api']['secret']
+        end
+
+        def listen!
+          begin
+            logger.info "listening"
+            system("stty raw")
+            while input = STDIN.getc
+              @websocket.send Base64.encode64 input
+            end
+          ensure
+            system("stty -raw echo")
+          end
+        end
+
+        def setup_api!
+          @api = Rancher::Shell::Api.new(
+            host: @config['project']['api']['host'],
+            user: @config['project']['api']['key'],
+            pass: @config['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'] === @config['options']['container'] }
+          exit_with_error "could not find container: #{@config['options']['container']}" unless @container
+        end
+
+        def setup_websocket!
+          logger.info "container = #{@container['id']}"
+          # default_bash_command = "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"
+          # @config['options']['command'] = default_bash_command if @config['options']['command'] === 'bash'
+          logger.debug "running command: #{@config['options']['command']}"
+          @response = @api.post(
+            "containers/#{@container['id']}?action=execute",
+            "command" => [
+              "/bin/sh",
+              "-c",
+              @config['options']['command'],
+            ],
+            "attachStdin" => true,
+            "attachStdout" => true,
+            "tty" => true,
+          )
+          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
+            emit :message, chunk
+          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
+end

data/lib/rancher/shell/config.rb

@@ -0,0 +1,53 @@
+require 'yaml'
+require 'active_support'
+
+module Rancher
+  module Shell
+    class Config
+      def self.load options = {}
+        config_file_paths = [
+          "#{ENV['HOME']}/.rancher-shell.yml",
+          "#{Dir.pwd}/.rancher-shell.yml",
+        ]
+        @data = {}
+        @data['options'] ||= options.dup
+        @data['projects'] ||= {}
+        config_file_paths.each do |file_path|
+          next unless File.exists? file_path
+          config = YAML.load_file file_path
+          if config
+            if config['options']
+              config['options'].each do |key, value|
+                @data['options'][key] = value unless options[key]
+              end
+              config.delete('options')
+            end
+            @data.deep_merge! config
+          end
+        end
+        return unless @data['options']['project']
+        @data['project'] = @data['projects'][@data['options']['project']]
+        if @data['project']['options']
+          @data['project']['options'].each do |key, value|
+            @data['options'][key] = value unless options[key]
+          end
+        end
+        if @data['options']['stack'] && @data['project']['stacks'] && @data['project']['stacks'][@data['options']['stack']]
+          if @data['project']['stacks'][@data['options']['stack']]['options']
+            @data['project']['stacks'][@data['options']['stack']]['options'].each do |key, value|
+              @data['options'][key] = value unless options[key]
+            end
+          end
+        end
+      end
+
+      def self.get key
+        @data[key]
+      end
+
+      def self.get_all
+        @data
+      end
+    end
+  end
+end

data/lib/rancher/shell/version.rb

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

data/rancher-shell.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency             "websocket", "~> 1.2"
   spec.add_dependency             "event_emitter", "~> 0.2.5"
+  spec.add_dependency             "thor", "~> 0.19.1"
+  spec.add_dependency             "activesupport", "~> 4.2"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rancher-shell
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Marc Qualie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.5
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +119,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -101,6 +130,8 @@ files:
 - lib/rancher/shell/api.rb
 - lib/rancher/shell/api_response.rb
 - lib/rancher/shell/cli.rb
+- lib/rancher/shell/commands/exec.rb
+- lib/rancher/shell/config.rb
 - lib/rancher/shell/logger.rb
 - lib/rancher/shell/logger_helper.rb
 - lib/rancher/shell/version.rb