tmux-connector 0.0.4 → 0.8.5

data/README.md

@@ -4,11 +4,14 @@ Manage multiple servers using SSH and [tmux].
 
 
 ## Features:
+* connect to multiple servers at once
+* expressive layouts customizable for different server groups available
+* issue commands to all servers or just a selected (custom) subgroup
 * work on multiple sessions in parallel
+* multiple connections to individual servers possible
 * sessions can be persisted (actually recreated) after computer restarts
     - they are lost only if you delete them explicitly
-* complex layouts customizable for different server groups
-* issuing commands to all servers or just a selected subgroups
+
 
 ## Quick tease
 
@@ -61,8 +64,9 @@ Usage:
   tcon delete (<session-name> | --all)
   tcon list
   tcon send <session-name> (<command> | --command-file=<file>)
-            [--server-filter=<regex>] [--group-filter=<regex>]
-            [--filter=<regex>] [--verbose]
+            [ --server-filter=<regex> | --group-filter=<regex>
+              | --filter=<regex> | --window=<index> ]
+            [--verbose]
   tcon --help
   tcon --version
 
@@ -72,6 +76,7 @@ Options:
   <session-name>             Name that identifies the session. Must be unique.
   <command>                  Command to be executed on remote server[s].
   <regex>                    String that represents valid Ruby regex.
+  <index>                    0-based index.
   -s --ssh-config=file       Path to ssh config file [default: ~/.ssh/config].
   -n --session-name=name     Name of the session to be used in the tcon command.
   -p --purpose=description   Description of session's purpose.
@@ -83,6 +88,7 @@ Options:
   -r --filter=regex          Filter to select a subset of the servers via
                              host names or group membership.
                              Combines --server-filter and --group-filter.
+  -w --window=index          Select a window via (0-based) index.
   -c --command-file=file     File containing the list of commands to be
                              executed on remote server[s].
   -v --verbose               Report how many servers were affected by the send
@@ -99,7 +105,7 @@ that hard and here I provide exhaustive details about configuration files.
 
 (If there is enough interest, in future versions there could be a special
 command to simplify generation of configuration files. To accelerate the
-process, open an issue or drop me an email: << username >>@gmail.com)
+process, open an issue or drop me an email: ivan@<< username >>.com)
 
 Let's get to it.
 
@@ -115,7 +121,7 @@ UserKnownHostsFile=/dev/null
 Host staging.cache-staging-1
   Hostname ec2-111-42-111-42.eu-west-1.compute.amazonaws.com
   Port 4242
-  IdentityFile /Users/ikusalic/.ssh/some-pem-file.pem
+  IdentityFile /Users/some-user/.ssh/some-pem-file.pem
   User ubuntu
 
 Host dev.database-staging-1
@@ -145,12 +151,6 @@ Host dev.node-staging-127
 Host dev.node-staging-129
   << omitted >>
 
-Host dev.node-staging-130
-  << omitted >>
-
-Host dev.node-staging-135
-  << omitted >>
-
 << ... >>
 ~~~
 
@@ -165,7 +165,7 @@ regex-parts-to:
     sort-by: [3]
 ~~~
 
-And here's a 'real world' configuration file that shows of all the available
+And here's a 'real world' configuration file that shows off all the available
 options and could be use with previous ssh config file:
 
 ~~~yaml
@@ -181,6 +181,11 @@ name:
 merge-groups:
     misc: ['cache', 'db', 'mongodb']
     lbs: ['haproxy', 'nginx']
+multiple-hosts:
+    regexes:
+        - !ruby-regexp '(nginx|haproxy)-'
+        - !ruby-regexp '(db)-'
+    counts: [2, 3]
 layout:
     default:
         custom:
@@ -262,6 +267,25 @@ In this example two different kinds of loadbalancers are grouped together.
 Note that the servers from merge groups can later be referenced with both
 original and merge-group name.
 
+* * *
+(optional) field __'multiple-hosts'__ contains __'regexes'__ and __'counts'__
+fields. With those, some hosts can have multiple connections established, not
+just the default one connection per host.
+
+For example:
+~~~yaml
+multiple-hosts:
+    regexes:
+        - !ruby-regexp '(nginx|haproxy)-'
+        - !ruby-regexp '(db)-'
+    counts: [2, 3]
+~~~
+creates 2 connections for each of nginx or haproxy nodes, as well as 3
+connection for db nodes.
+
+Fields __'regexes'__ and __'counts'__ must have the same number of elements.
+Each element in __'regexes'__ must contain valid ruby regex.
+
 * * *
 Finally, what's left is the (optional) __layout__ definition:
 
@@ -284,6 +308,7 @@ The layouts are applied individually to any merge group and to any normal
 a group then layout allows on a single window, next window for that group is
 added. Servers from different groups never share a window.
 
+
 ## Requirements
 To be able to use the gem you should have ruby 1.9+ and tmux installed on a *nix
 (Mac OS X, Linux, ...) machine. (Windows: here be dragons)
@@ -351,7 +376,7 @@ information, check my [dotfiles].
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-Or just mail me, mail: << username >>@gmail.com
+Or just mail me, mail: ivan@<< username >>.com
 
 This is my first real gem, so all your comments are more than welcome.
 I'd really appreciate ruby code improvements/refactoring comments or usability
@@ -363,7 +388,7 @@ comments (all other are welcome too). Just _drop me a line_. :)
 Take a look at `TODO.md` file (in the repository) for ideas about additional
 features in new versions.
 
-<< username >>@gmail.com
+ivan@<< username >>.com
 
 I'd be happy to hear from you.
 

data/lib/tmux-connector/commands/send.rb

@@ -10,6 +10,7 @@ module TmuxConnector
     attr_reader :server_filter
     attr_reader :session
     attr_reader :verbose
+    attr_reader :window
 
     def initialize(args)
       @name = args['<session-name>']
@@ -23,11 +24,13 @@ module TmuxConnector
       @server_filter ||= Regexp.new(args['--filter']) rescue nil
       @group_filter ||= Regexp.new(args['--filter']) rescue nil
 
+      @window = args['--window']
+
       @session = Session.load_by_name args['<session-name>']
     end
 
     def run()
-      session.tmux_session.send_commands(commands, server_filter, group_filter, verbose)
+      session.tmux_session.send_commands(commands, server_filter, group_filter, window, verbose)
     end
 
   private

data/lib/tmux-connector/host.rb

@@ -1,9 +1,10 @@
 module TmuxConnector
   class Host
-    attr_reader :ssh_name
+    attr_reader :count
     attr_reader :display_name
     attr_reader :group_id
     attr_reader :sort_value
+    attr_reader :ssh_name
 
     def initialize(name, config)
       @ssh_name = name
@@ -12,6 +13,8 @@ module TmuxConnector
       @display_name = create_display_name groups, config
       @sort_value = config['regex-parts-to']['sort-by'].map { |i| groups[i] }.join '-'
       @group_id = config['regex-parts-to']['group-by'].map { |i| groups[i] }.join '-'
+
+      @count = get_count config
     end
 
     def to_s()
@@ -20,7 +23,7 @@ module TmuxConnector
 
   private
 
-      def create_display_name groups, config
+      def create_display_name(groups, config)
         if config['name']
           parts = []
           groups.each_with_index do |e, i|
@@ -32,5 +35,16 @@ module TmuxConnector
 
         return @ssh_name
       end
+
+      def get_count(config)
+        multiple = config['multiple-hosts']
+        return 1 if multiple.nil?
+
+        [ multiple['regexes'], multiple['counts'] ].transpose.each do |re, n|
+          return n if ssh_name.match re
+        end
+
+        return 1
+      end
   end
 end

data/lib/tmux-connector/layout.rb

@@ -1,4 +1,18 @@
 module TmuxConnector
+  class Pane
+    attr_reader :host
+    attr_reader :name
+    attr_reader :ordinal
+
+    def initialize(host, ordinal)
+      @host = host
+      @ordinal = ordinal
+
+      @name = host.display_name
+      @name += "##{ ordinal }" if ordinal > 1
+    end
+  end
+
   class Layout
     attr_reader :groups
     attr_reader :merge_rules
@@ -46,7 +60,12 @@ module TmuxConnector
           n = config['tmux']['max-panes']
         end
 
-        hosts.each_slice(n).with_index do |arr, i|
+        panes = hosts.reduce([]) do |acc, h|
+          h.count.times { |i| acc << Pane.new(h, i + 1) }
+          acc
+        end
+
+        panes.each_slice(n).with_index do |arr, i|
           window = {
             name: "#{ group_name }##{ i + 1 }",
             group_name: group_name,

data/lib/tmux-connector/tmux_handler.rb

@@ -36,12 +36,16 @@ module TmuxConnector
       execute
     end
 
-    def send_commands(send_commands, server_regex, group_regex, verbose)
+    def send_commands(send_commands, server_regex, group_regex, window, verbose)
       count = 0
-      each_pane do |window_index, pane_index, host|
-        matches = server_regex.nil? && group_regex.nil?
-        matches ||= !server_regex.nil? && host.ssh_name.match(server_regex)
-        matches ||= !group_regex.nil? && session.merge_rules[host.group_id].match(group_regex)
+      each_pane do |window_index, pane_index, pane|
+        if window
+          matches = window == window_index.to_s
+        else
+          matches = server_regex.nil? && group_regex.nil?
+          matches ||= !server_regex.nil? && pane.host.ssh_name.match(server_regex)
+          matches ||= !group_regex.nil? && session.merge_rules[pane.host.group_id].match(group_regex)
+        end
 
         if matches
           system("tmux send-keys -t #{ name }:#{ window_index }.#{ pane_index } '#{ send_commands }' C-m")
@@ -88,7 +92,7 @@ HERE
               size = (100.0 * (w[:panes].size - pi - 1) / (w[:panes].size - pi)).round
 
               commands << "tmux split-window -p #{ size } -t #{ name }:#{ wi }" unless pi == 0
-              commands << tmux_set_title_cmd(p.display_name, wi, pi)
+              commands << tmux_set_title_cmd(p.name, wi, pi)
             end
 
             commands << "tmux select-layout -t #{ name }:#{ wi } #{ w[:tmux] } &> /dev/null"
@@ -101,7 +105,7 @@ HERE
       end
 
       def clear_panes()
-        each_pane do |window_index, pane_index|
+        each_pane do |window_index, pane_index, _|
           commands << "tmux send-keys -t #{ name }:#{ window_index }.#{ pane_index } clear C-m"
         end
       end
@@ -109,8 +113,8 @@ HERE
       def connect()
         ssh_config_path = File.expand_path session.args['--ssh-config']
 
-        each_pane do |window_index, pane_index, host|
-          ssh_command = "ssh -F #{ ssh_config_path } #{ host.ssh_name }"
+        each_pane do |window_index, pane_index, pane|
+          ssh_command = "ssh -F #{ ssh_config_path } #{ pane.host.ssh_name }"
           commands << "tmux send-keys -t #{ name }:#{ window_index }.#{ pane_index } '#{ ssh_command }' C-m"
         end
       end
@@ -126,14 +130,14 @@ HERE
       def each_pane(&block)
         session.windows.each_with_index do |window, window_index|
           if window[:tmux]
-            window[:panes].each_with_index do |host, pane_index|
-              yield(window_index, pane_index, host)
+            window[:panes].each_with_index do |pane, pane_index|
+              yield(window_index, pane_index, pane)
             end
           else
             pane_index = 0
             window[:panes].each do |g|
-              g.each do |host|
-                yield(window_index, pane_index, host)
+              g.each do |pane|
+                yield(window_index, pane_index, pane)
                 pane_index += 1
               end
             end
@@ -144,25 +148,25 @@ HERE
       def create_custom_layout(window, window_index)
         direction = (window[:flow] == 'horizontal') ? ['-h', '-v'] : ['-v', '-h']
 
-        pane_index = 0
+        in_window_index = 0
         window[:panes].each_with_index do |group, group_index|
-          commands << "tmux select-pane -t #{ name }:#{ window_index }.#{ pane_index }"
+          commands << "tmux select-pane -t #{ name }:#{ window_index }.#{ in_window_index }"
 
-          # create pane in a next row ahead of time so pane indexes match hosts
+          # create tmux-pane in a next row ahead of time so tmux-pane indexes match host-panes
           if group_index < window[:panes].size - 1
             size = (100.0 * (window[:panes].size - group_index - 1) / (window[:panes].size - group_index)).round
             commands << "tmux split-window #{ direction[1] } -p #{ size } -t #{ name }:#{ window_index }"
-            display_name = window[:panes][group_index + 1][0].display_name
-            commands << tmux_set_title_cmd(display_name, window_index, -1)
-            commands << "tmux select-pane -t #{ name }:#{ window_index }.#{ pane_index }"
+            pane_name = window[:panes][group_index + 1][0].name
+            commands << tmux_set_title_cmd(pane_name, window_index, -1)
+            commands << "tmux select-pane -t #{ name }:#{ window_index }.#{ in_window_index }"
           end
 
-          group.each_with_index do |host, host_index|
-            size = (100.0 * (group.size - host_index) / (group.size - host_index + 1)).round
-            commands << "tmux split-window #{ direction[0] } -p #{ size } -t #{ name }:#{ window_index }" unless host_index == 0
-            commands << tmux_set_title_cmd(host.display_name, window_index, pane_index)
+          group.each_with_index do |pane, pane_index|
+            size = (100.0 * (group.size - pane_index) / (group.size - pane_index + 1)).round
+            commands << "tmux split-window #{ direction[0] } -p #{ size } -t #{ name }:#{ window_index }" unless pane_index == 0
+            commands << tmux_set_title_cmd(pane.name, window_index, in_window_index)
 
-            pane_index += 1
+            in_window_index += 1
           end
         end
       end

data/lib/tmux-connector/version.rb

@@ -1,3 +1,3 @@
 module TmuxConnector
-  VERSION = "0.0.4"
+  VERSION = "0.8.5"
 end

data/lib/tmux-connector.rb

@@ -18,8 +18,9 @@ Usage:
   tcon delete (<session-name> | --all)
   tcon list
   tcon send <session-name> (<command> | --command-file=<file>)
-            [--server-filter=<regex>] [--group-filter=<regex>]
-            [--filter=<regex>] [--verbose]
+            [ --server-filter=<regex> | --group-filter=<regex>
+              | --filter=<regex> | --window=<index> ]
+            [--verbose]
   tcon --help
   tcon --version
 
@@ -29,6 +30,7 @@ Options:
   <session-name>             Name that identifies the session. Must be unique.
   <command>                  Command to be executed on remote server[s].
   <regex>                    String that represents valid Ruby regex.
+  <index>                    0-based index.
   -s --ssh-config=file       Path to ssh config file [default: ~/.ssh/config].
   -n --session-name=name     Name of the session to be used in the tcon command.
   -p --purpose=description   Description of session's purpose.
@@ -40,6 +42,7 @@ Options:
   -r --filter=regex          Filter to select a subset of the servers via
                              host names or group membership.
                              Combines --server-filter and --group-filter.
+  -w --window=index          Select a window via (0-based) index.
   -c --command-file=file     File containing the list of commands to be
                              executed on remote server[s].
   -v --verbose               Report how many servers were affected by the send

data/spec/config_spec.rb

@@ -46,5 +46,9 @@ describe "Configuration file" do
       it_should_behave_like "config test", 'layout-group'
       it_should_behave_like "config test", 'layout-both'
     end
+
+    describe "multiple hosts" do
+      it_should_behave_like "config test", 'multiple-hosts'
+    end
   end
 end

data/spec/fixtures/configs.yml

@@ -113,3 +113,19 @@ layout-both:
             max-horizontal: 2
             max-vertical: 2
             panes-flow: vertical
+
+multiple-hosts:
+  input:
+    <<: *input-min
+    multiple-hosts:
+        regexes:
+            - !ruby-regexp '(loadbalancer)-'
+            - !ruby-regexp '(database)-'
+        counts: [2, 3]
+  expected:
+    <<: *expected-min
+    multiple-hosts:
+        regexes:
+            - !ruby-regexp '(loadbalancer)-'
+            - !ruby-regexp '(database)-'
+        counts: [2, 3]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tmux-connector
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.8.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-01 00:00:00.000000000 Z
+date: 2013-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt