tmux-connector 0.8.6 → 0.9.7

data/README.md

@@ -11,7 +11,7 @@ Manage multiple servers using SSH and [tmux].
 * multiple connections to individual servers possible
 * sessions can be persisted (actually recreated) after computer restarts
     - they are lost only if you delete them explicitly
-* panes not associated with hosts
+* panes not associated with hosts available
 
 
 ## Quick tease
@@ -28,20 +28,24 @@ Manage multiple servers using SSH and [tmux].
 
 - send to all servers (in 'staging' session) `sudo su` command
 
-`tcon send staging 'top' -g 'lbs'`
+`tcon send staging -v -g 'lbs' 'top'`
 
-- send `top` command to all loadbalancing nodes in 'staging' session
+- send `top` command to all loadbalancing nodes in 'staging' session and report
+  the number of affected nodes
 
-`tcon send production 'tail -f /var/log/syslog' -f 'rdb'`
+`tcon send production -f 'worker' 'tail -f /var/log/syslog'`
 
-- send `tail -f /var/log/syslog` command to all database nodes in 'production'
+- send `tail -f /var/log/syslog` command to all worker nodes in 'production'
     session
 
-`tcon send production -f 'rdb' 'C-c'`
+`tcon send production -f 'worker :: <,3]; 7; <9,13>' 'C-c'`
 
-- send `Ctrl-C` to all database nodes in 'production' session (if executed
+- send `Ctrl-C` to some worker nodes in 'production' session, if executed
     after the `tail -f /var/log/syslog` command, it will exit the `tail -f`
     command
+    - if there are worker nodes numbered from 1 to 20 (e.g. staging-worker-1,
+      staging-worker-2, etc.) this command affects worker nodes: 1, 2, 3, 7, 10,
+      11 and 12
 
 `tcon resume s#3`
 
@@ -65,7 +69,7 @@ Usage:
   tcon delete (<session-name> | --all)
   tcon list
   tcon send <session-name> (<command> | --command-file=<file>)
-            [ --server-filter=<regex> | --group-filter=<regex>
+            [ --server-filter=<filter> | --group-filter=<regex>
               | --filter=<regex> | --window=<index> ]
             [--verbose]
   tcon --help
@@ -78,11 +82,14 @@ Options:
   <command>                  Command to be executed on remote server[s].
   <regex>                    String that represents valid Ruby regex.
   <index>                    0-based index.
+  <filter>                   Filter consisting of a valid ruby regex and
+                             optionally of a special predicate.
+                             For more information see README file.
   -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.
   --all                      Delete all existing sessions.
-  -f --server-filter=regex   Filter to select a subset of the servers via
+  -f --server-filter=filter  Filter to select a subset of the servers via
                              host names.
   -g --group-filter=regex    Filter to select a subset of the servers via
                              group membership.
@@ -98,6 +105,62 @@ Options:
   --version                  Show version.
 ~~~
 
+### Send command
+
+Send command sends user specified command(s) to chosen panes.
+
+Once more, here's the command syntax:
+~~~
+tcon send <session-name> (<command> | --command-file=<file>)
+          [ --server-filter=<filter> | --group-filter=<regex>
+            | --filter=<regex> | --window=<index> ]
+          [--verbose]
+~~~
+where long flags can be shortened to: `-c`, `-f`, `-g`, `-r`, `-w` and `-v`.
+
+There are 4 flags used to filter the servers (panes) that are going to receive
+the command(s):
+
+* `-f` filters the servers via host names
+    - accept valid ruby regex and optionally intervals specification
+        - syntax: `<ruby-regex>` or `<ruby-regex> :: <intervals-specification>`
+* `-g` filters the servers via group names
+    - accepts valid ruby regex
+* `-r` filters the servers via host names or group names
+    - accepts valid ruby regex
+* `-w` filters the servers that belong to particular layout window
+    - accepts 0-based index
+
+The `-f` filter can accept optional interval specification:
+* interval specification operates on __'sort-by'__ part of host names (defined in
+  configuration file)
+    - intervals specification consists of one or more elements separated
+    by semicollon (the split regex is: `/;\s*/`)
+    - individual element is either an interval description or white-listed element
+    - interval description consists of 4 parts:
+        + '[' or '<' - include or exclude the first element
+        + first element (can be empty)
+        + ',' (can have trailing whitespace)
+        + second element (can be empty)
+        + ']' or '>' - include or exclude the last element
+        - regex used:
+          `/(?<start>[\[<])(?<first>[^,]*),\s*(?<second>[^\]>]*)(?<end>[\]>])/`
+    - examples:
+        + `2; 4` - 2, 4
+        + `[1,3]` - 1, 2, 3
+        + `[1, 3>` - 1, 2
+        + `<1, 3>` - 2
+        + `<,5>`  - ... 3, 4
+        + `[5, >`  - 5, 6, ...
+
+Hopefully now the following examples make more sense:
+
+~~~bash
+tcon send staging 'sudo su'
+tcon send staging -v -g 'lbs' 'top'
+tcon send production -f 'worker' 'tail -f /var/log/syslog'
+tcon send production -f 'worker :: <,3]; 7; <9,13>' 'C-c'
+~~~
 
 ## Configuration
 

data/lib/tmux-connector.rb

@@ -18,7 +18,7 @@ Usage:
   tcon delete (<session-name> | --all)
   tcon list
   tcon send <session-name> (<command> | --command-file=<file>)
-            [ --server-filter=<regex> | --group-filter=<regex>
+            [ --server-filter=<filter> | --group-filter=<regex>
               | --filter=<regex> | --window=<index> ]
             [--verbose]
   tcon --help
@@ -31,11 +31,14 @@ Options:
   <command>                  Command to be executed on remote server[s].
   <regex>                    String that represents valid Ruby regex.
   <index>                    0-based index.
+  <filter>                   Filter consisting of a valid ruby regex and
+                             optionally of a special predicate.
+                             For more information see README file.
   -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.
   --all                      Delete all existing sessions.
-  -f --server-filter=regex   Filter to select a subset of the servers via
+  -f --server-filter=filter  Filter to select a subset of the servers via
                              host names.
   -g --group-filter=regex    Filter to select a subset of the servers via
                              group membership.

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

@@ -5,6 +5,7 @@ require_relative '../tmux_handler'
 module TmuxConnector
   class Send
     attr_reader :commands
+    attr_reader :filter_predicate
     attr_reader :group_filter
     attr_reader :name
     attr_reader :server_filter
@@ -18,7 +19,8 @@ module TmuxConnector
 
       load_commands args
 
-      @server_filter = Regexp.new(args['--server-filter']) rescue nil
+      process_server_filter args['--server-filter'] rescue raise "error parsing server filter ('#{ args['--server-filter'] }')"
+
       @group_filter = Regexp.new(args['--group-filter']) rescue nil
 
       @server_filter ||= Regexp.new(args['--filter']) rescue nil
@@ -30,11 +32,16 @@ module TmuxConnector
     end
 
     def run()
-      session.tmux_session.send_commands(commands, server_filter, group_filter, window, verbose)
+      opts = {
+        verbose: verbose,
+        filter_predicate: filter_predicate
+      }
+
+      session.tmux_session.send_commands(commands, server_filter, group_filter, window, opts)
     end
 
   private
-      
+
       def load_commands(args)
         if args['<command>']
           @commands = args['<command>']
@@ -44,5 +51,74 @@ module TmuxConnector
           @commands = open(file) { |f| f.read }
         end
       end
+
+      def process_server_filter(raw_filter)
+        return unless raw_filter
+
+        str_filter, str_predicate = raw_filter.split(' :: ')
+
+        @server_filter = (Regexp.new(str_filter) rescue nil)
+
+        return if str_predicate.nil?
+
+        predicate_parts = parse_predicate(str_predicate)
+        @filter_predicate = build_predicate(predicate_parts)
+      end
+
+      def parse_predicate(str_predicate)
+        return nil if str_predicate.nil?
+
+        predicate_delimiter = /;\s*/
+        interval_regex = /(?<start>[\[<])(?<first>[^,]*),\s*(?<second>[^\]>]*)(?<end>[\]>])/
+
+        return str_predicate.split(predicate_delimiter).map do |element|
+            m = element.match(interval_regex)
+            Hash[ m.names.map(&:to_sym).zip(m.captures) ] rescue element
+        end
+      end
+
+      def build_predicate(parts)
+        return lambda do |sort_value|
+          return false if sort_value.nil?
+
+          numeric_comparison = sort_value.instance_of? Fixnum
+
+          intervals, elements = parts.partition { |e| e.instance_of? Hash }
+
+          elements = elements.map(&:to_i) if numeric_comparison
+          return true if elements.include? sort_value
+
+          intervals.each do |interval|
+            first = interval[:first]
+            second = interval[:second]
+
+            matches = true
+
+            unless first.empty?
+              first = Integer(first, 10) if numeric_comparison
+
+              if interval[:start] == '['
+                matches &&= sort_value >= first
+              elsif interval[:start] == '<'
+                matches &&= sort_value > first
+              end
+            end
+
+            unless second.empty?
+              second = Integer(second, 10) if numeric_comparison
+
+              if interval[:end] == ']'
+                matches &&= sort_value <= second
+              elsif interval[:end] == '>'
+                matches &&= sort_value < second
+              end
+            end
+
+            return true if matches
+          end
+
+          return false
+        end
+      end
   end
 end

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

@@ -22,7 +22,6 @@ module TmuxConnector
       end
       raise "no hosts matching given configuration found, check your configuration file" if hosts.empty?
 
-
       generate_groups
       generate_merge_rules
 
@@ -47,7 +46,21 @@ module TmuxConnector
           @groups.merge! Hash[hostless.map { |name, count| [ name, [FakeHost.new(name, count)] ] }]
         end
 
-        sort_groups!
+        update_sort_values!
+
+        groups.each do |_, hosts|
+          hosts.sort_by!(&:sort_value)
+        end
+      end
+
+      def update_sort_values!()
+        groups.each do |_, hosts|
+          numbers_only = hosts.all? { |e| e.sort_value =~ /^[-+]?[0-9]+$/ }
+
+          if numbers_only
+            hosts.each { |h| h.sort_value = Integer(h.sort_value, 10) }
+          end
+        end
       end
 
       def generate_merge_rules()
@@ -59,16 +72,5 @@ module TmuxConnector
         end
         groups.keys.each { |e| @merge_rules[e] ||= e }
       end
-
-      def sort_groups!()
-        groups.each do |k, v|
-          numbers_only = v.all? { |e| e.sort_value =~ /^[-+]?[0-9]+$/ }
-          if numbers_only
-            v.sort! { |a, b| a.sort_value.to_i <=> b.sort_value.to_i }
-          else
-            v.sort_by!(&:sort_value)
-          end
-        end
-      end
   end
 end

data/lib/tmux-connector/host.rb

@@ -1,9 +1,10 @@
 module TmuxConnector
   class Host
+    attr_accessor :sort_value
+
     attr_reader :count
     attr_reader :display_name
     attr_reader :group_id
-    attr_reader :sort_value
     attr_reader :ssh_name
 
     def initialize(name, config)

data/lib/tmux-connector/tmux_handler.rb

@@ -36,16 +36,31 @@ module TmuxConnector
       execute
     end
 
-    def send_commands(send_commands, server_regex, group_regex, window, verbose)
+    def send_commands(send_commands, server_regex, group_regex, window, opts={})
+      predicate = opts[:filter_predicate]
+
       count = 0
       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? && pane.host.group_id.match(group_regex)
           matches ||= !group_regex.nil? && session.merge_rules[pane.host.group_id].match(group_regex)
+
+          unless server_regex.nil?
+            name_match = pane.host.ssh_name.match(server_regex)
+
+            if predicate
+              begin
+                matches ||= name_match && predicate.call(pane.host.sort_value)
+              rescue
+                raise "error while using send predicate for '#{ pane.host.display_name }'; command already sent to #{ count } servers"
+              end
+            else
+              matches ||= name_match
+            end
+          end
         end
 
         if matches
@@ -54,7 +69,7 @@ module TmuxConnector
         end
       end
 
-      puts "command sent to #{ count } server[s]" if verbose
+      puts "command sent to #{ count } server[s]" if opts[:verbose]
     end
 
   private
@@ -115,7 +130,7 @@ HERE
         ssh_config_path = File.expand_path session.args['--ssh-config']
 
         each_pane do |window_index, pane_index, pane|
-          next unless pane.host.instance_of? TmuxConnector::Host
+          next unless pane.host.instance_of? Host
 
           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"

data/lib/tmux-connector/version.rb

@@ -1,3 +1,3 @@
 module TmuxConnector
-  VERSION = "0.8.6"
+  VERSION = "0.9.7"
 end

metadata

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