tmux-cssh 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e98cc319a8b74ce0ef895d7ca295621028ae6e6
+  data.tar.gz: 0dab99e91d4471541ecaa78269acf97ad8d26525
+SHA512:
+  metadata.gz: 70ec48338850dc68cad71debe431be1cfd0ae530f1d57ab10d9cba7d91a5cf21c40b5c64f617c250795f8b37f3369cd7da73c518220b7c3dd3504c9abca3f506
+  data.tar.gz: 03e40a19d8af851efc3bac78a26b05219abf2f2a770a9546a9d263574a70031a9d05741a2c64d154595ba633cdf855adbca35a9c7ad02f95c46fb7ff8c85c883

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/README.md

@@ -0,0 +1,80 @@
+# tmux-cssh-rb
+
+## Requirements
+
+* Ruby 1.9.3 or later
+* tmux
+
+## Installing
+
+### Install from RubyGems repository
+
+coming soon...
+
+### Build gem and install
+
+```sh
+git clone https://github.com/yshh/tmux-cssh-rb.git path/to/tmux-cssh-rb
+cd path/to/tmux-cssh-rb
+gem build tmux-cssh.gemspec
+gem install tmux-cssh-*.gem
+```
+
+### Use Bundler
+
+Write the line below to your Gemfile:
+```ruby
+gem 'tmux-cssh', git: 'https://github.com/yshh/tmux-cssh-rb.git'
+```
+
+## Usage
+
+```
+% tssh -h
+Usage: tssh [options]
+    -l, --login USERNAME
+    -c, --config FILE
+        --ssh SSH_COMMAND
+        --ssh_args SSH_ARGUMENTS
+        --debug DEBUG_LEVEL
+        --panes_per_window NUM
+```
+
+`tssh` should be executed outside of tmux session.
+
+```sh
+tssh user@host1 host2 host3
+```
+
+### Sync mode
+
+When you type to pane, key strokes are copied to all panes in the window.
+Use tmux command `set-window-option synchronize-panes` to disable this mode.
+
+You may want to bind a shortcut key to this command (add the line below to your ~/.tmux.conf)
+
+```
+bind-key g setw synchronize-panes
+```
+
+### How to exit
+
+Panes do not close after the ssh session terminates
+(using `set remain-on-exit`) so that you can see error messages in the case
+ssh session terminated unexpectedly by errors such as connection error and
+authentication failure.
+
+You can close dead panes with tmux commands:
+
+* `kill-pane` (closes selected pane; bound to `C-b x` by default) or
+* `kill-window` (closes all panes in current window; bound to `C-b &` by default)
+
+## OS limits
+
+Opening many tmux panes hits some OS limits.
+
+* num of pty
+* max open files
+
+## Known issues
+

data/README_ja.md

@@ -0,0 +1,99 @@
+# tmux-cssh-rb
+
+## 必要環境
+
+* Ruby 1.9.3 以上
+* tmux
+
+## インストール
+
+### gem コマンド
+
+TODO: RubyGems リポジトリに上げる
+
+GitHub リポジトリから直接インストールする場合は以下を実行してください。
+
+```sh
+gem install specific_install
+gem specific_install https://github.com/yshh/tmux-cssh-rb.git
+```
+
+### ビルド・インストール
+
+```sh
+git clone https://github.com/yshh/tmux-cssh-rb.git path/to/tmux-cssh-rb
+cd path/to/tmux-cssh-rb
+gem build tmux-cssh.gemspec
+gem install tmux-cssh-*.gem
+```
+
+### Bundler を使う
+
+Gemfile に以下を１行追加してください。
+
+```ruby
+gem 'tmux-cssh', git: 'https://github.com/yshh/tmux-cssh-rb.git'
+```
+
+## 使い方
+
+`tssh` は tmux セッションの外で実行する必要があります。
+tmux セッション内での実行は現状サポート(?)外です。
+
+```sh
+tssh user@host1 host2 host3
+```
+
+`-h` オプションをつけて実行するとヘルプが表示されます。
+
+```
+% tssh -h
+Usage: tssh [options]
+    -l, --login USERNAME
+    -c, --config FILE
+        --ssh SSH_COMMAND
+        --ssh_args SSH_ARGUMENTS
+        --debug DEBUG_LEVEL
+        --panes_per_window NUM
+```
+
+### Sync モード
+
+ひとつの pane にタイプした文字は、window 内の全ての pane にコピーされます。
+これは tmux の機能を使っており、
+tmux コマンド `set-window-option synchronize-panes` で無効化できます。
+この tmux コマンドにショートカットキーを割り当てると便利です。
+
+例えば以下の tmux コマンドを ~/.tmux.conf に追加する:
+
+```
+bind-key g setw synchronize-panes
+```
+
+詳細については tmux のマニュアルを参照してください。
+
+### 終了方法
+
+pane は ssh セッションの終了後に自動的には終了しません
+(tmux の `set-window-option remain-on-exit` を設定しています)。
+認証えらーなどでセッションが意図せずエラー終了した際、エラーメッセージが
+消えてしまうのを防ぐためです。
+
+pane は以下の tmux コマンドで閉じることができます。
+
+* `kill-pane` (選択中の pane を閉じる; デフォルト: `C-b x`)
+* `kill-window` (window 上の全ての pane を閉じる; デフォルト: `C-b &`)
+
+## OS の制限
+
+たくさんの tmux pane を開くと、OS の各種上限に当たります。
+
+* pty 数
+* max open files
+
+TODO: 回避方法
+
+## 既知の問題
+
+XXX
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/tssh

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+
+require 'logger'
+require 'inifile'
+require 'optparse'
+require 'tssh'
+
+# default options
+options = {
+  login:               nil,
+  config:              "#{ENV['HOME']}/.tsshrc",
+#  tile_x:              nil,
+#  tile_y:              nil,
+#  ssh:                 '/usr/local/bin/proxychains4 ssh',
+  ssh:                 'ssh',
+  ssh_args:            '',
+#  remote_command:      nil,
+#  hosts:               nil,
+#  session_max:         256,
+#  ping_test:           nil,
+#  ping_timeout:        nil,
+#  sock:                nil,
+#  sorthosts:           false,
+#  slave_settings_set:  nil,
+#  master_settings_set: nil,
+#  interleave:          nil,
+  debug:               0,
+
+  panes_per_window:    128,
+}
+
+args = {}
+
+ARGV.options do |opt|
+  opt.on('-l', '--login USERNAME',
+         "SSH login name (default: #{options[:login]})"
+        ) { |v| args[:login] = v }
+  opt.on('-c', '--config FILE',
+         "Config file path (default: #{options[:config]})"
+        ) { |v|
+    raise "Config file '#{v}' does not exist" unless File.exists?(v)
+    args[:config] = v
+  }
+  opt.on('--ssh SSH_COMMAND',
+         "Custom SSH command (default: #{options[:config]})"
+        ) { |v| args[:ssh] = v }
+  opt.on('--ssh_args SSH_ARGUMENTS') do |v|
+    args[:ssh_args] = v
+  end
+  opt.on('--debug DEBUG_LEVEL',
+         "Debug level [0-2] (default: #{options[:debug]})"
+        ) { |v| args[:debug] = v.to_i }
+  opt.on("--panes_per_window NUM",
+        "Max panes opened on one window (default: #{options[:panes_per_window]})"
+        ) { |v| args[:panes_per_window] = v.to_i }
+  opt.parse!
+end
+
+logger = Logger.new(STDERR)
+
+# args "debug" and "config" are specially concerned
+unless args[:debug].nil?
+  options[:debug] = args[:debug]
+end
+logger.level = case options[:debug]
+               when 0                  then Logger::WARN
+               when 1                  then Logger::INFO
+               when 2                  then Logger::DEBUG
+               else raise "Invalid debug level: '#{options[:debug]}'"
+               end
+
+unless args[:config].nil?
+  options[:config] = args[:config]
+end
+
+if not options[:config].nil? and File.exists?(options[:config])
+  logger.info "Using config file: #{options[:config]}"
+  # config file options overwrite the default options
+  config = IniFile.load(options[:config])
+  config['global'].each do |k, v|
+    # XXX
+    if %w(panes_per_window debug).include? k
+      options[k.to_sym] = v.to_i
+    else
+      options[k.to_sym] = v
+    end
+    logger.debug "option from config file: #{k} => #{v}"
+  end
+else
+  logger.info "Config file #{options[:config]} does not exist"
+end
+
+# command_line args are the most prioritized
+args.each do |k, v|
+  logger.debug "option from args: #{k} => #{v}"
+  options[k] = v
+end
+
+# XXX
+hosts = ARGV
+
+tssh = TmuxClusterSSH.new(options, hosts, logger)
+tssh.run
+

data/lib/tssh.rb

@@ -0,0 +1,72 @@
+class TmuxClusterSSH
+  def initialize options, hosts, logger
+    @options = options
+    @hosts = hosts
+    @logger = logger
+    raise "No hosts specified" if @hosts.count == 0
+  end
+
+  def ssh_command host
+    if @options[:login].nil?
+      "#{@options[:ssh]} #{@options[:ssh_args]} #{host}"
+    else
+      "#{@options[:ssh]} #{@options[:ssh_args]} #{@options[:login]}@#{host}"
+    end
+  end
+
+  def calc_num_panes(num)
+    # XXX should read tmux implementation
+    if num > @options[:panes_per_window]
+      return @options[:panes_per_window] + calc_num_panes(num - @options[:panes_per_window])
+    end
+
+    sqrt_num = Math.sqrt(num)
+    panes = sqrt_num.ceil * sqrt_num.floor
+    panes >= num ? panes : sqrt_num.ceil ** 2
+  end
+
+  def run_command cmd
+    @logger.info cmd
+    res = system cmd
+    case res
+    when nil
+      raise "command `#{cmd}` failed"
+    when false
+      raise "command `#{cmd}` exited with status #{$?}"
+    end
+  end
+
+  def run
+    num_panes = calc_num_panes(@hosts.count)
+    session_name = "tssh-#{$$}"
+    (0..num_panes-1).each do |i|
+      host = @hosts[i]
+      if host.nil?
+        command = "'echo;echo empty'"
+      else
+        command = "'echo #{host};exec #{ssh_command(host)}'"
+      end
+      STDERR.puts command if @options[:debug] > 0
+      if i == 0
+        # create new session
+        run_command "tmux new -d -s #{session_name} #{command}"
+        run_command "tmux setw -t #{session_name} synchronize-panes on > /dev/null"
+        run_command "tmux setw -t #{session_name} remain-on-exit on > /dev/null"
+      elsif i  % @options[:panes_per_window] == 0
+        # create new window on existing session
+        run_command "tmux neww -t #{session_name} #{command}"
+        run_command "tmux setw -t #{session_name} synchronize-panes on > /dev/null"
+        run_command "tmux setw -t #{session_name} remain-on-exit on > /dev/null"
+      else
+        # add pane to active window
+        run_command "tmux splitw -t #{session_name} #{command}"
+        run_command "tmux selectl -t #{session_name} tiled > /dev/null"
+      end
+    end
+    # XXX
+    run_command 'tmux select-pane -t 0'
+
+    # attach to the session
+    exec "tmux attach -t #{session_name}"
+  end
+end

data/tmux-cssh.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name = 'tmux-cssh'
+  s.version = '0.2.1'
+  s.licenses = ['MIT']
+  s.summary = 'Cluster-SSH on tmux'
+  s.homepage = 'https://github.com/yshh/tmux-cssh-rb'
+  s.authors = ['Yusuke Hagihara']
+  s.email = 'yusuke.hagihara@gmail.com'
+  s.files = `git ls-files`.split($/)
+  s.executables = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.add_dependency 'inifile', '~> 2.0'
+  s.required_ruby_version = '>= 1.9.3'
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: tmux-cssh
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Yusuke Hagihara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email: yusuke.hagihara@gmail.com
+executables:
+- tssh
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- README_ja.md
+- Rakefile
+- VERSION
+- bin/tssh
+- lib/tssh.rb
+- tmux-cssh.gemspec
+homepage: https://github.com/yshh/tmux-cssh-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Cluster-SSH on tmux
+test_files: []