sesh 0.0.8 → 0.1.0

data/README.md

@@ -0,0 +1,17 @@
+# Sesh: remote background sessions powered by tmux and tmuxinator.
+Runs a headless tmuxinator session for remote slave machines to connect to.
+
+## Usage
+
+    sesh command [project]
+
+Leave project blank to use the name of your current directory.
+
+## Commands
+
+    sesh new                           Create a new tmuxinator configuration.
+    sesh start [project]               Start a Sesh session for a project.
+    sesh stop  [project]               Stop a Sesh session for a project.
+    sesh list                          List running Sesh sessions on this machine.
+    sesh enslave [project] [user@host] Connect a slave to a local Sesh session.
+    sesh connect [project]  user@host  Connect as a slave to a Sesh session.

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sesh"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/sesh

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'sesh'
+Sesh::Cli.start

data/lib/sesh/cli.rb

@@ -0,0 +1,244 @@
+require 'sesh'
+require 'tmuxinator'
+require 'optparse'
+require 'yaml'
+require 'colorize'
+require 'open3'
+require 'deep_merge'
+
+module Sesh
+  class Cli
+    def self.start
+      puts "Sesh v#{Sesh::VERSION}".green
+      if ARGV.empty? or ARGV.include? '-h' or ARGV.include? '--help'
+        puts HELP_BANNER.blue; exit end
+
+      parse_options!
+      @tmux_control = TmuxControl.new @options[:project], @options[:tmux]
+      @ssh_control  = SshControl.new @tmux_control, @options[:ssh]
+
+      if @command
+        case @command
+        when 'start'
+          if @tmux_control.already_running?
+            Logger.fatal "Sesh project '#{@options[:project]}' is already running!"
+          else
+            Logger.debug "Starting Sesh project '#{@options[:project]}'..."
+          end
+          @tmux_control.kill_running_processes
+          if @tmux_control.issue_start_command! &&
+             Logger.show_progress_until(-> { @tmux_control.already_running? })
+            sleep 1
+            if @tmux_control.already_running?
+              @tmux_control.store_pids_from_session!
+              Logger.debug 'Sesh started successfully.'
+              puts
+            else Logger.fatal 'Sesh failed to start!' end
+          else Logger.fatal 'Sesh failed to start after ten seconds!' end
+        when 'stop'
+          if @tmux_control.already_running?
+            Logger.debug "Stopping Sesh project '#{@options[:project]}'..."
+          else
+            Logger.fatal "Sesh project '#{@options[:project]}' is not running!"
+          end
+          @tmux_control.kill_running_processes
+          @tmux_control.issue_stop_command!
+          if $? && Logger.show_progress_until(-> { !@tmux_control.already_running? })
+            Logger.debug 'Sesh stopped successfully.'
+            puts
+          else
+            Logger.fatal 'Sesh failed to stop after ten seconds!'
+          end
+        when 'restart'
+          Logger.fatal("Sesh project '#{@options[:project]}' is not running!") unless already_running?
+          puts `sesh stop #{@options[:project]} #{@options if @options.any?}`.strip
+          sleep 0.5
+          puts `sesh start #{@options[:project]} #{@options if @options.any?}`.strip
+        when 'new'
+          config = Tmuxinator::Config.project(@options[:project])
+          unless Tmuxinator::Config.exists?(@options[:project])
+            template = File.join(File.dirname(File.expand_path(__FILE__)),
+                                 "../lib/sesh/assets/sample.yml")
+            erb  = Erubis::Eruby.new(File.read(template)).result(binding)
+            File.open(config, "w") { |f| f.write(erb) }
+          end
+
+          Kernel.system("#{Inferences.infer_default_editor} #{config}") ||
+                           Tmuxinator::Cli.new.doctor
+          puts
+        when 'edit'
+          config = Tmuxinator::Config.project(@options[:project])
+          if Tmuxinator::Config.exists? @options[:project]
+            Kernel.system("#{Inferences.infer_default_editor} #{config}") ||
+                           Tmuxinator::Cli.new.doctor
+            puts
+          else
+            Logger.fatal "Sesh project '#{@options[:project]}' does not exist yet!"
+          end
+        when 'list'
+          output = Sesh.format_and_run_command <<-BASH
+            ps aux | grep tmux | grep "env TMUX='' mux start" \
+                   | grep -v "[g]rep" | sed -e "s/.*mux start \\(.*\\)/\\1/"
+          BASH
+          running_projects = output.split("\n")
+          pcount = running_projects.count
+          if pcount > 0
+            Logger.info "#{pcount} project#{pcount>1 ? 's':''} currently running:"
+            puts running_projects
+            puts
+          else
+            Logger.fatal "There are no Sesh projects currently running."
+          end
+        when 'connect'
+          if @options[:ssh][:local_addr] == @options[:ssh][:remote_addr]
+            unless @tmux_control.already_running?
+              Logger.fatal "Sesh project '#{@options[:project]}' is not running!"
+            end
+          end
+          system @ssh_control.enter_slave_mode_command(@options[:ssh][:local_addr])
+        when 'enslave'
+          Logger.fatal("Sesh project '#{@options[:project]}' is not running!") unless @tmux_control.already_running?
+          Logger.fatal("You must specify a machine to enslave! Eg: user@ip") if @options[:ssh][:remote_addr].nil?
+          Logger.debug "Attempting to connect #{@options[:ssh][:remote_addr]} to Sesh project '#{@options[:project]}'..."
+          if @ssh_control.enslave_peer!
+            Logger.debug "Sesh client connected successfully."
+            puts
+          else
+            Logger.fatal 'Sesh client failed to start.'
+          end
+        when 'run'
+          unless ARGV.any?
+            Logger.fatal 'A second command is required!'
+          end
+          @shell_command = ARGV.join(' ')
+          puts "Subcommand: #{@shell_command}"
+        when 'rspec'
+          unless ARGV.any?
+            Logger.fatal 'A path to a spec is required!'
+          end
+          @shell_command = ARGV.join(' ')
+          puts "Spec: #{@shell_command}"
+        else
+          Logger.fatal "Command not recognized!"
+        end
+        exit 0
+      end
+
+      Logger.fatal 'You must specify a command.'
+    end
+
+    def self.parse_options!
+      @command = ARGV.shift
+
+      # Load config from a YAML file in the project root if available.
+      @config_filepath = nil
+      @config_friendly_filepath = nil
+      POSSIBLE_CONFIG_LOCATIONS.each do |path|
+        fullpath = File.join Dir.pwd, path
+        next unless File.exists? fullpath
+        @config_filepath  = fullpath
+        @config_friendly_filepath = path
+        break
+      end
+      @defaults = DEFAULT_OPTIONS.dup
+      if @config_filepath.nil?
+        @config_friendly_filepath = POSSIBLE_CONFIG_LOCATIONS[0]
+      else
+        loaded_config = deep_symbolize YAML::load_file(@config_filepath)
+        @defaults.deep_merge! loaded_config
+      end
+
+      # Parse options given to the command.
+      parsed_options = @defaults.dup
+      OptionParser.new do |opts|
+        opts.banner = HELP_BANNER
+
+        opts.on("-p", "--project=project", 'Project') {|v|
+          parsed_options[:project] = v }
+
+        opts.on("-L", "--local-ssh-addr=addr", 'Local SSH Address') {|v|
+          parsed_options[:ssh][:local_addr] = v }
+        opts.on("-R", "--remote-ssh-addr=addr", 'Remote SSH Address') {|v|
+          parsed_options[:ssh][:remote_addr] = v }
+
+        opts.on('-S', '--tmux-socket-file=path', 'Path to Tmux Socket File') {|v|
+          # fatal("Socket file #{v} does not exist.") unless File.exist?(v)
+          parsed_options[:tmux][:socket_file] = v }
+        opts.on('-P', '--tmux-pids-file=path', 'Path to Tmux Pids File') {|v|
+          parsed_options[:tmux][:pids_file] = v }
+
+        # # target_opts = DEPLOYMENT_TARGETS.join '|'
+        # opts.on("-T", "--target=target", 'Titanium Deployment Target') do |v|
+        #   if DEPLOYMENT_TARGETS.include? v
+        #     platform = parsed_options[:titanium_command][:platform]
+        #     if v == 'xcode'
+        #       parsed_options[:titanium_command][:run_with_xcode] = true
+        #       v = 'simulator'
+        #     end
+        #     if v == 'emulator' && platform == 'ios' then v = 'simulator'
+        #     elsif v == 'simulator' && platform == 'android' then v = 'emulator' end
+        #     parsed_options[:titanium_command][:target] = v
+        #   else fatal "Target \"#{v}\" not recognized." end
+        # end
+        #
+        # opts.on('-O', '--output-dir=dir', 'Titanium Output Directory') {|v|
+        #   parsed_options[:titanium_command][:output_dir] = v }
+        #
+        # opts.on('-L', '--log-level=level', 'Titanium Log Level') {|v|
+        #   parsed_options[:titanium_command][:log_level] = v }
+        #
+        # opts.on('-V', '--developer-certificate=certificate',
+        #         'iOS Developer Certificate') {|v|
+        #   parsed_options[:ios_credentials][:development][:developer_certificate] = v
+        #   parsed_options[:ios_credentials][:production][:developer_certificate] = v }
+        # opts.on('-P', '--provisioning-profile=profile',
+        #         'iOS Provisioning Profile') {|v|
+        #   parsed_options[:ios_credentials][:development][:provisioning_profile] = v
+        #   parsed_options[:ios_credentials][:production][:provisioning_profile] = v }
+        #
+        # opts.on('-U', '--simulator-udid=udid', 'iOS Simulator UDID') {|v|
+        #   parsed_options[:ios_simulator][:udid] = v }
+        # opts.on('-D', '--devicetypeid=dtid', 'iOS Simulator DeviceTypeID') {|v|
+        #   parsed_options[:ios_simulator][:devicetypeid] = v }
+        #
+        # opts.on('--no-autofocus', 'Disable iOS Simulator Autofocus') {
+        #   parsed_options[:ios_simulator][:autofocus] = false }
+
+        opts.on('--help', 'Prints this help') { puts opts.banner; exit }
+      end.parse!
+      @options = parsed_options
+      if @options[:project].nil?
+        project_required = !%w(new list).include?(@command)
+        ARGV.each {|a|
+          if Tmuxinator::Config.exists? a
+            @options[:project] = ARGV.delete a
+            break end } if project_required && ARGV.any?
+        @options[:project] ||= Inferences.infer_project_from_current_directory
+        if project_required && @options[:project].nil?
+          Logger.warn 'A matching Sesh project could not be found.'
+          Logger.fatal 'Hint: run sesh new or specify an existing project with your commmand.'
+        end
+      end
+      @options[:tmux][:socket_file] ||= "/tmp/#{@options[:project]}.sock"
+      @options[:tmux][:pids_file]   ||= "/tmp/#{@options[:project]}.pids.txt"
+      @options[:ssh][:local_addr]   ||= Sesh::Inferences.infer_local_ssh_addr
+      if @options[:ssh][:remote_addr].nil?
+        if ARGV.any?
+          ARGV.each {|a|
+            if a =~ /\.local$/ || a =~ /[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+/ || a =~ /^(.+)@(.+)$/
+              @options[:ssh][:remote_addr] = a
+              break end }
+          @options[:ssh][:remote_addr] ||= ARGV.shift
+        end
+        if @options[:ssh][:remote_addr].nil?
+          if %w(enslave run rspec).include? @command
+            Logger.warn 'A remote address is required.'
+            Logger.fatal 'Hint: specify a remote ssh address using the -R flag.'
+          elsif %w(connect).include? @command
+            @options[:ssh][:remote_addr] = Inferences.infer_local_ssh_addr
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sesh/inferences.rb

@@ -0,0 +1,36 @@
+require 'sesh'
+require 'tmuxinator'
+
+module Sesh
+  module Inferences
+    def self.infer_project_from_current_directory
+      output = `printf '%q\n' "${PWD##*/}"`.strip
+      return output if Tmuxinator::Config.exists?(output)
+    end
+    def self.infer_local_ssh_addr
+      inferred_user = `echo $USER`.strip
+      inferred_hostname = `scutil --get LocalHostName`.strip.downcase
+      inferred_hostname += '.local' unless inferred_hostname =~ /\.local$/
+      "#{inferred_user}@#{inferred_hostname}"
+    end
+    def self.infer_terminal_app
+      if OS.mac?
+        output = `osascript -e 'try' -e 'get exists application "iTerm"' -e 'end try'`.strip
+        output.length > 0 ? 'iTerm' : fatal("iTerm 2 is not installed.") # 'Terminal'
+        # TODO: support more platforms
+      end
+    end
+    def self.infer_default_editor
+      if OS.windows? then 'notepad.exe'
+      else o = `echo $EDITOR`.strip; o = 'vim' unless o.length > 0; o end
+    end
+
+    module OS
+      def OS.windows?
+        (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil end
+      def OS.mac?; (/darwin/ =~ RUBY_PLATFORM) != nil end
+      def OS.unix?; !OS.windows? end
+      def OS.linux?; OS.unix? and not OS.mac? end
+    end
+  end
+end

data/lib/sesh/logger.rb

@@ -0,0 +1,30 @@
+require 'sesh'
+require 'colorize'
+
+module Sesh
+  class Logger
+    def self.debug(msg) $stderr.puts "> #{msg}" end
+    def self.fatal(msg)
+      $stderr.puts msg.red; $stderr.puts; exit 1 end
+    def self.warn(msg, nest_level=0)
+      $stderr.puts "#{' ' * nest_level * 2}> #{msg}".yellow end
+    def self.info(msg, nest_level=0)
+      $stdout.puts "#{' ' * nest_level * 2}> #{msg}".blue end
+    def self.success(msg, nest_level=0)
+      $stdout.puts "#{' ' * nest_level * 2}> #{msg}".green end
+
+    def self.show_progress_until(condition_lambda, timeout=10)
+      started_progress_at = Time.now
+      return true if condition_lambda[]
+      print '> '
+      until condition_lambda[] or Time.now - started_progress_at > timeout
+        print '.'
+        $stdout.flush
+        sleep 0.5 
+      end
+      puts
+      return condition_lambda[]
+    end
+
+  end
+end

data/lib/sesh/ssh_control.rb

@@ -0,0 +1,46 @@
+require 'sesh'
+
+module Sesh
+  class SshControl
+    def initialize(tmux_control, options={})
+      @tmux_control = tmux_control
+      @project = @tmux_control.project
+      @options = DEFAULT_OPTIONS[:ssh].merge(options)
+    end
+
+    def connection_command(addr=nil)
+      addr ||= @options[:local_addr]
+      tmux_cmd = @tmux_control.connection_command
+      return tmux_cmd if addr == @options[:local_addr]
+      "ssh #{addr} -t '#{tmux_cmd}'"
+    end
+
+    def enter_slave_mode_command(addr=nil)
+      @term_app ||= Inferences.infer_terminal_app
+      case @term_app
+      when 'iTerm'
+        tell_term_app     = 'tell application "' + @term_app + '"'
+        tell_term_process = 'tell application "System Events" to tell process "' + 
+                             @term_app + '"'
+        Sesh.format_command <<-BASH
+          osascript \
+                -e '#{tell_term_app} to activate' \
+                -e '#{tell_term_process} to keystroke \"n\" using command down' \
+                -e 'delay 1' \
+                -e "#{tell_term_app.gsub('"', '\\"')} to tell session -1 of current \
+                    terminal to write text \\"#{connection_command(addr)}\\"" \
+                -e '#{tell_term_process} to keystroke return using command down'
+        BASH
+      when 'Terminal' then Sesh.format_command connection_command(addr)
+      end
+    end
+
+    def enslave_peer!
+      output = Sesh.format_and_run_command <<-BASH
+      ssh #{@options[:remote_addr]} "sesh connect #{@project} #{@options[:local_addr]}" 
+      BASH
+      puts output
+      $?
+    end
+  end
+end

data/lib/sesh/tmux_control.rb

@@ -0,0 +1,51 @@
+require 'sesh'
+
+module Sesh
+  class TmuxControl
+    def initialize(project_name, options={})
+      @project = project || Inferences::infer_project_from_current_directory
+      @options = DEFAULT_OPTIONS[:tmux].merge(options)
+    end
+
+    def already_running?
+      `ps aux | grep "#{project_name_matcher}"`.strip.length > 0 end
+
+    def project_name_matcher
+      pn = @project.gsub '-', '\-'
+      "[t]mux.*[#{pn[0]}]#{pn[1..-1]}" end
+
+    def issue_start_command!
+      cmd = Sesh.format_command <<-BASH
+      tmux -S "#{@options[:socket_file]}" new-session -d "eval \$SHELL -l; env TMUX='' mux start #{@project}" 2>&1
+      BASH
+      output = `#{cmd}`.strip
+      return true if output.length == 0
+      Logger.warn "Tmux failed to start with the following error: #{output}"; false
+    end
+
+    def issue_stop_command!; `pkill -f "#{project_name_matcher}"` end
+
+    def connection_command; "tmux -S #{@options[:socket_file]} a" end
+
+    def obtain_pids_from_session
+      # TODO: grep this to just those pids from the current project
+      `tmux list-panes -s -F "\#{pane_pid} \#{pane_current_command}" | grep -v tmux | awk '{print $1}'`.strip.lines end
+    def store_pids_from_session!
+      File.open(@options[:pids_file], 'w') {|f|
+        obtain_pids_from_session.each{|pid| f.puts pid } }
+    end
+
+    def kill_running_processes
+      if File.exists? @options[:pids_file]
+        File.readlines(@options[:pids_file]).each{|pid| kill_process! pid }
+        File.delete @options[:pids_file]
+      end
+    end
+    def kill_process!(pid); `kill -9 #{pid}` end
+
+    # Getter methods for passthru to SshControl class
+    def project; @project end
+    def options; @options end
+
+  end
+end

data/lib/sesh/version.rb

@@ -1,3 +1,3 @@
 module Sesh
-  VERSION = '0.0.8'
+  VERSION = '0.1.0'
 end

data/lib/sesh.rb

@@ -0,0 +1,46 @@
+require 'sesh/version'
+require 'sesh/logger'
+require 'sesh/inferences'
+require 'sesh/ssh_control'
+require 'sesh/tmux_control'
+require 'sesh/cli'
+
+module Sesh
+  HELP_BANNER = <<-HELP
+  Sesh: remote background sessions powered by tmux and tmuxinator.
+  Runs a headless tmuxinator session for remote slave machines to connect to.
+
+  Usage: #{File.basename $0} command [project]
+
+  Commands:
+
+  sesh new                           Create a new tmuxinator configuration.
+  sesh edit    [project]             Edit an existing tmuxinator configuration.
+  sesh start   [project]             Start a Sesh session for a project.
+  sesh stop    [project]             Stop a Sesh session for a project.
+  sesh list                          List running Sesh sessions on this machine.
+  sesh enslave [project] user@host   Connect a slave to a local Sesh session.
+  sesh connect [project] [user@host] Connect as a slave to a Sesh session.
+  sesh run     [location] [command]  Run a shell command in the specified location.
+  sesh rspec   [location] [spec]     Run a spec in the specified location.
+
+  Leave project blank to use the name of your current directory.
+
+  HELP
+
+  DEFAULT_OPTIONS = {
+    project: nil,
+    ssh: {
+      local_addr: nil,
+      remote_addr: nil
+    },
+    tmux: {
+      socket_file: nil,
+      pids_file: nil
+    }
+  }
+  POSSIBLE_CONFIG_LOCATIONS = %w( sesh_config.yml config/sesh.yml )
+
+  def self.format_command(command) command.gsub(/\ [ ]+/, ' ').strip end
+  def self.format_and_run_command(command) `#{format_command(command)}`.strip end
+end

data/sesh.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sesh/version"
+
+Gem::Specification.new do |s|
+  s.name          = 'sesh'
+  s.version       = Sesh::VERSION
+  s.date          = '2015-03-17'
+  s.summary       = "Sesh"
+  s.description   = "Remote background sessions powered by tmux and tmuxinator."
+  s.authors       = ["MacKinley Smith"]
+  s.email         = 'smithmackinley@gmail.com'
+  # s.files         = Dir["lib/**/*", "spec/**/*", "bin/*"]
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  # s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  s.homepage      = 'http://rubygems.org/gems/sesh'
+  s.license       = 'GNU GPLv3'
+
+  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec"
+
+  s.add_dependency 'tmuxinator', '~> 0.6.9'
+  s.add_dependency 'deep_merge'
+  s.add_dependency 'awesome_print'
+  s.add_dependency 'colorize'
+end